views.module 54.8 KB
Newer Older
merlinofchaos's avatar
merlinofchaos committed
1 2 3 4 5 6 7 8 9 10 11
<?php

/**
 * @file
 * Primarily Drupal hooks and global API functions to manipulate views.
 *
 * This is the main module file for Views. The main entry points into
 * this module are views_page() and views_block(), where it handles
 * incoming page and block requests.
 */

12
use Drupal\Core\Cache\Cache;
13
use Drupal\Core\Database\Query\AlterableInterface;
14
use Drupal\Core\Language\Language;
15
use Drupal\views\ViewExecutable;
16
use Drupal\Component\Plugin\Exception\PluginException;
17
use Drupal\views\Plugin\Core\Entity\View;
18
use Drupal\views\Views;
19
use Drupal\field\FieldInstanceInterface;
20

merlinofchaos's avatar
merlinofchaos committed
21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44
/**
 * Implements hook_forms().
 *
 * To provide distinct form IDs for Views forms, the View name and
 * specific display name are appended to the base ID,
 * views_form_views_form. When such a form is built or submitted, this
 * function will return the proper callback function to use for the given form.
 */
function views_forms($form_id, $args) {
  if (strpos($form_id, 'views_form_') === 0) {
    return array(
      $form_id => array(
        'callback' => 'views_form',
      ),
    );
  }
}

/**
 * Returns a form ID for a Views form using the name and display of the View.
 */
function views_form_id($view) {
  $parts = array(
    'views_form',
45
    $view->storage->id(),
merlinofchaos's avatar
merlinofchaos committed
46 47 48 49 50 51
    $view->current_display,
  );

  return implode('_', $parts);
}

52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73
/**
 * Implements hook_element_info().
 */
function views_element_info() {
  $types['view'] = array(
    '#theme_wrappers' => array('container'),
    '#pre_render' => array('views_pre_render_view_element'),
    '#name' => NULL,
    '#display_id' => 'default',
    '#arguments' => array(),
  );
  return $types;
}

/**
 * View element pre render callback.
 */
function views_pre_render_view_element($element) {
  $element['#attributes']['class'][] = 'views-element-container';

  $view = views_get_view($element['#name']);
  if ($view && $view->access($element['#display_id'])) {
74
    $element['view'] = $view->preview($element['#display_id'], $element['#arguments']);
75 76 77 78 79
  }

  return $element;
}

merlinofchaos's avatar
merlinofchaos committed
80 81 82 83
/**
 * Implement hook_theme(). Register views theming functions.
 */
function views_theme($existing, $type, $theme, $path) {
84
  Drupal::moduleHandler()->loadInclude('views', 'inc', 'views.theme');
merlinofchaos's avatar
merlinofchaos committed
85 86 87

  // Some quasi clever array merging here.
  $base = array(
88
    'file' => 'views.theme.inc',
merlinofchaos's avatar
merlinofchaos committed
89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117
  );

  // Our extra version of pager from pager.inc
  $hooks['views_mini_pager'] = $base + array(
    'variables' => array('tags' => array(), 'quantity' => 10, 'element' => 0, 'parameters' => array()),
    'pattern' => 'views_mini_pager__',
  );

  $variables = array(
    // For displays, we pass in a dummy array as the first parameter, since
    // $view is an object but the core contextual_preprocess() function only
    // attaches contextual links when the primary theme argument is an array.
    'display' => array('view_array' => array(), 'view' => NULL),
    'style' => array('view' => NULL, 'options' => NULL, 'rows' => NULL, 'title' => NULL),
    'row' => array('view' => NULL, 'options' => NULL, 'row' => NULL, 'field_alias' => NULL),
    'exposed_form' => array('view' => NULL, 'options' => NULL),
    'pager' => array(
      'view' => NULL, 'options' => NULL,
      'tags' => array(), 'quantity' => 10, 'element' => 0, 'parameters' => array()
    ),
  );

  // Default view themes
  $hooks['views_view_field'] = $base + array(
    'pattern' => 'views_view_field__',
    'variables' => array('view' => NULL, 'field' => NULL, 'row' => NULL),
  );
  $hooks['views_view_grouping'] = $base + array(
    'variables' => array('view' => NULL, 'grouping' => NULL, 'grouping_level' => NULL, 'rows' => NULL, 'title' => NULL),
118
    'template' => 'views-view-grouping',
merlinofchaos's avatar
merlinofchaos committed
119 120
  );

121
  $plugins = views_get_plugin_definitions();
merlinofchaos's avatar
merlinofchaos committed
122 123 124 125

  // Register theme functions for all style plugins
  foreach ($plugins as $type => $info) {
    foreach ($info as $plugin => $def) {
126 127 128 129 130
      // Not all plugins have theme functions, and they can also explicitly
      // prevent a theme function from being registered automatically.
      if (!isset($def['theme']) || empty($def['register_theme'])) {
        continue;
      }
merlinofchaos's avatar
merlinofchaos committed
131

132 133 134 135
      $hooks[$def['theme']] = array(
        'pattern' => $def['theme'] . '__',
        'variables' => $variables[$type],
      );
merlinofchaos's avatar
merlinofchaos committed
136

137 138 139 140 141
      if ($def['module'] == 'views') {
        $def['theme_file'] = 'views.theme.inc';
      }
      elseif (isset($def['theme_file'])) {
        $def['theme_path'] = drupal_get_path('module', $def['module']);
merlinofchaos's avatar
merlinofchaos committed
142 143
      }

144 145 146 147 148 149 150 151 152 153
      if (isset($def['theme_path'])) {
        $hooks[$def['theme']]['path'] = $def['theme_path'];
      }
      if (isset($def['theme_file'])) {
        $hooks[$def['theme']]['file'] = $def['theme_file'];
      }
      if (isset($def['theme_path']) && isset($def['theme_file'])) {
        $include = DRUPAL_ROOT . '/' . $def['theme_path'] . '/' . $def['theme_file'];
        if (is_file($include)) {
          require_once $include;
merlinofchaos's avatar
merlinofchaos committed
154 155
        }
      }
156 157 158
      if (!function_exists('theme_' . $def['theme'])) {
        $hooks[$def['theme']]['template'] = drupal_clean_css_identifier($def['theme']);
      }
merlinofchaos's avatar
merlinofchaos committed
159 160 161 162 163 164 165 166 167 168 169 170 171 172 173
    }
  }

  $hooks['views_form_views_form'] = $base + array(
    'render element' => 'form',
  );

  $hooks['views_exposed_form'] = $base + array(
    'template' => 'views-exposed-form',
    'pattern' => 'views_exposed_form__',
    'render element' => 'form',
  );

  $hooks['views_more'] = $base + array(
    'variables' => array('more_url' => NULL, 'link_text' => 'more', 'view' => NULL),
174
    'template' => 'views-more',
merlinofchaos's avatar
merlinofchaos committed
175 176 177 178 179
  );

  return $hooks;
}

180 181 182 183 184 185 186 187 188 189 190 191 192
/**
 * Returns a list of plugins and metadata about them.
 *
 * @return array
 *   An array keyed by PLUGIN_TYPE:PLUGIN_NAME, like 'display:page' or
 *   'pager:full', containing an array with the following keys:
 *   - title: The plugin's title.
 *   - type: The plugin type.
 *   - module: The module providing the plugin.
 *   - views: An array of enabled Views that are currently using this plugin,
 *     keyed by machine name.
 */
function views_plugin_list() {
193
  $plugin_data = views_get_plugin_definitions();
194 195
  $plugins = array();
  foreach (views_get_enabled_views() as $view) {
196
    foreach ($view->get('display') as $display_id => $display) {
197
      foreach ($plugin_data as $type => $info) {
198 199
        if ($type == 'display' && isset($display['display_plugin'])) {
          $name = $display['display_plugin'];
200
        }
201 202
        elseif (isset($display['display_options']["{$type}_plugin"])) {
          $name = $display['display_options']["{$type}_plugin"];
203
        }
204 205
        elseif (isset($display['display_options'][$type]['type'])) {
          $name = $display['display_options'][$type]['type'];
206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223
        }
        else {
          continue;
        }

        // Key first by the plugin type, then the name.
        $key = $type . ':' . $name;
        // Add info for this plugin.
        if (!isset($plugins[$key])) {
          $plugins[$key] = array(
            'type' => $type,
            'title' => check_plain($info[$name]['title']),
            'module' => check_plain($info[$name]['module']),
            'views' => array(),
          );
        }

        // Add this view to the list for this plugin.
224
        $plugins[$key]['views'][$view->id()] = $view->id();
225 226 227 228 229 230
      }
    }
  }
  return $plugins;
}

merlinofchaos's avatar
merlinofchaos committed
231 232 233 234 235 236 237 238
/**
 * A theme preprocess function to automatically allow view-based node
 * templates if called from a view.
 *
 * The 'modules/node.views.inc' file is a better place for this, but
 * we haven't got a chance to load that file before Drupal builds the
 * node portion of the theme registry.
 */
239
function views_preprocess_node(&$variables) {
240
  Drupal::moduleHandler()->loadInclude('node', 'views.inc');
merlinofchaos's avatar
merlinofchaos committed
241
  // The 'view' attribute of the node is added in views_preprocess_node()
242 243 244 245 246
  if (!empty($variables['node']->view) && $variables['node']->view->storage->id()) {
    $variables['view'] = $variables['node']->view;
    $variables['theme_hook_suggestions'][] = 'node__view__' . $variables['node']->view->storage->id();
    if (!empty($variables['node']->view->current_display)) {
      $variables['theme_hook_suggestions'][] = 'node__view__' . $variables['node']->view->storage->id() . '__' . $variables['node']->view->current_display;
merlinofchaos's avatar
merlinofchaos committed
247 248 249

      // If a node is being rendered in a view, and the view does not have a path,
      // prevent drupal from accidentally setting the $page variable:
250 251
      if ($variables['page'] && $variables['view_mode'] == 'full' && !$variables['view']->display_handler->hasPath()) {
        $variables['page'] = FALSE;
merlinofchaos's avatar
merlinofchaos committed
252 253 254 255 256
      }
    }
  }

  // Allow to alter comments and links based on the settings in the row plugin.
257 258
  if (!empty($variables['view']->rowPlugin) && $variables['view']->rowPlugin->getPluginId() == 'entity:node') {
    node_row_node_view_preprocess_node($variables);
merlinofchaos's avatar
merlinofchaos committed
259 260 261 262 263 264 265
  }
}

/**
 * A theme preprocess function to automatically allow view-based node
 * templates if called from a view.
 */
266
function views_preprocess_comment(&$variables) {
merlinofchaos's avatar
merlinofchaos committed
267
  // The 'view' attribute of the node is added in template_preprocess_views_view_row_comment()
268 269 270 271 272
  if (!empty($variables['comment']->view) && $variables['comment']->view->storage->id()) {
    $variables['view'] = &$variables['comment']->view;
    $variables['theme_hook_suggestions'][] = 'comment__view__' . $variables['comment']->view->storage->id();
    if (!empty($variables['node']->view->current_display)) {
      $variables['theme_hook_suggestions'][] = 'comment__view__' . $variables['comment']->view->storage->id() . '__' . $variables['comment']->view->current_display;
merlinofchaos's avatar
merlinofchaos committed
273 274 275 276 277
    }
  }
}

/**
278
 * Implements hook_permission().
merlinofchaos's avatar
merlinofchaos committed
279 280 281 282 283 284
 */
function views_permission() {
  return array(
    'access all views' => array(
      'title' => t('Bypass views access control'),
      'description' => t('Bypass access control when accessing views.'),
285
      'restrict access' => TRUE,
merlinofchaos's avatar
merlinofchaos committed
286 287 288 289 290 291 292 293
    ),
  );
}

/**
 * Implement hook_menu().
 */
function views_menu() {
294
  // Any event which causes a menu rebuild could potentially mean that the
merlinofchaos's avatar
merlinofchaos committed
295 296 297 298 299 300
  // Views data is updated -- module changes, profile changes, etc.
  views_invalidate_cache();
  $items = array();
  $items['views/ajax'] = array(
    'title' => 'Views',
    'theme callback' => 'ajax_base_page_theme',
301
    'route_name' => 'views_ajax',
merlinofchaos's avatar
merlinofchaos committed
302 303 304 305
    'type' => MENU_CALLBACK,
  );
  // Define another taxonomy autocomplete because the default one of drupal
  // does not support a vid a argument anymore
306
  $items['admin/views/ajax/autocomplete/taxonomy/%'] = array(
merlinofchaos's avatar
merlinofchaos committed
307
    'page callback' => 'views_ajax_autocomplete_taxonomy',
308
    'page arguments' => array(5),
merlinofchaos's avatar
merlinofchaos committed
309 310 311 312 313 314 315 316 317 318 319 320 321 322
    'theme callback' => 'ajax_base_page_theme',
    'access callback' => 'user_access',
    'access arguments' => array('access content'),
    'type' => MENU_CALLBACK,
    'file' => 'includes/ajax.inc',
  );
  return $items;
}

/**
 * Implement hook_menu_alter().
 */
function views_menu_alter(&$callbacks) {
  $our_paths = array();
323
  $views = views_get_applicable_views('uses_hook_menu');
merlinofchaos's avatar
merlinofchaos committed
324 325
  foreach ($views as $data) {
    list($view, $display_id) = $data;
326
    $result = $view->executeHookMenu($display_id, $callbacks);
merlinofchaos's avatar
merlinofchaos committed
327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388
    if (is_array($result)) {
      // The menu system doesn't support having two otherwise
      // identical paths with different placeholders.  So we
      // want to remove the existing items from the menu whose
      // paths would conflict with ours.

      // First, we must find any existing menu items that may
      // conflict.  We use a regular expression because we don't
      // know what placeholders they might use.  Note that we
      // first construct the regex itself by replacing %views_arg
      // in the display path, then we use this constructed regex
      // (which will be something like '#^(foo/%[^/]*/bar)$#') to
      // search through the existing paths.
      $regex = '#^(' . preg_replace('#%views_arg#', '%[^/]*', implode('|', array_keys($result))) . ')$#';
      $matches = preg_grep($regex, array_keys($callbacks));

      // Remove any conflicting items that were found.
      foreach ($matches as $path) {
        // Don't remove the paths we just added!
        if (!isset($our_paths[$path])) {
          unset($callbacks[$path]);
        }
      }
      foreach ($result as $path => $item) {
        if (!isset($callbacks[$path])) {
          // Add a new item, possibly replacing (and thus effectively
          // overriding) one that we removed above.
          $callbacks[$path] = $item;
        }
        $our_paths[$path] = TRUE;
      }
    }
    $view->destroy();
  }
}

/**
 * Helper function for menu loading. This will automatically be
 * called in order to 'load' a views argument; primarily it
 * will be used to perform validation.
 *
 * @param $value
 *   The actual value passed.
 * @param $name
 *   The name of the view. This needs to be specified in the 'load function'
 *   of the menu entry.
 * @param $display_id
 *   The display id that will be loaded for this menu item.
 * @param $index
 *   The menu argument index. This counts from 1.
 */
function views_arg_load($value, $name, $display_id, $index) {
  static $views = array();

  // Make sure we haven't already loaded this views argument for a similar menu
  // item elsewhere.
  $key = $name . ':' . $display_id . ':' . $value . ':' . $index;
  if (isset($views[$key])) {
    return $views[$key];
  }

  if ($view = views_get_view($name)) {
389 390
    $view->setDisplay($display_id);
    $view->initHandlers();
merlinofchaos's avatar
merlinofchaos committed
391 392 393 394

    $ids = array_keys($view->argument);

    $indexes = array();
395
    $path = explode('/', $view->getPath());
merlinofchaos's avatar
merlinofchaos committed
396 397 398 399 400 401 402 403 404

    foreach ($path as $id => $piece) {
      if ($piece == '%' && !empty($ids)) {
        $indexes[$id] = array_shift($ids);
      }
    }

    if (isset($indexes[$index])) {
      if (isset($view->argument[$indexes[$index]])) {
405
        $arg = $view->argument[$indexes[$index]]->validateMenuArgument($value) ? $value : FALSE;
merlinofchaos's avatar
merlinofchaos committed
406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435
        $view->destroy();

        // Store the output in case we load this same menu item again.
        $views[$key] = $arg;
        return $arg;
      }
    }
    $view->destroy();
  }
}

/**
 * Page callback: Displays a page view, given a name and display id.
 *
 * @param $name
 *   The name of a view.
 * @param $display_id
 *   The display id of a view.
 *
 * @return
 *   Either the HTML of a fully-executed view, or MENU_NOT_FOUND.
 */
function views_page($name, $display_id) {
  $args = func_get_args();
  // Remove $name and $display_id from the arguments.
  array_shift($args);
  array_shift($args);

  // Load the view and render it.
  if ($view = views_get_view($name)) {
436 437 438 439 440 441
    if ($output = $view->executeDisplay($display_id, $args)) {
      return $output;
    }
    else {
      return array();
    }
merlinofchaos's avatar
merlinofchaos committed
442 443
  }

444
  // Fallback if we get here no view was found.
merlinofchaos's avatar
merlinofchaos committed
445 446 447 448 449 450 451 452 453 454
  return MENU_NOT_FOUND;
}

/**
 * Implements hook_page_alter().
 */
function views_page_alter(&$page) {
  // If the main content of this page contains a view, attach its contextual
  // links to the overall page array. This allows them to be rendered directly
  // next to the page title.
455
  if ($view = views_get_page_view()) {
merlinofchaos's avatar
merlinofchaos committed
456 457 458 459 460 461 462 463
    views_add_contextual_links($page, 'page', $view, $view->current_display);
  }
}

/**
 * Implements MODULE_preprocess_HOOK().
 */
function views_preprocess_html(&$variables) {
464 465 466 467 468
  // Early-return to prevent adding unnecessary JavaScript.
  if (!user_access('access contextual links')) {
    return;
  }

merlinofchaos's avatar
merlinofchaos committed
469 470 471 472 473 474 475 476 477 478
  // If the page contains a view as its main content, contextual links may have
  // been attached to the page as a whole; for example, by views_page_alter().
  // This allows them to be associated with the page and rendered by default
  // next to the page title (which we want). However, it also causes the
  // Contextual Links module to treat the wrapper for the entire page (i.e.,
  // the <body> tag) as the HTML element that these contextual links are
  // associated with. This we don't want; for better visual highlighting, we
  // prefer a smaller region to be chosen. The region we prefer differs from
  // theme to theme and depends on the details of the theme's markup in
  // page.tpl.php, so we can only find it using JavaScript. We therefore remove
479
  // the "contextual-region" class from the <body> tag here and add
merlinofchaos's avatar
merlinofchaos committed
480
  // JavaScript that will insert it back in the correct place.
481
  if (!empty($variables['page']['#views_contextual_links'])) {
482
    $key = array_search('contextual-region', $variables['attributes']['class']);
merlinofchaos's avatar
merlinofchaos committed
483
    if ($key !== FALSE) {
484
      unset($variables['attributes']['class'][$key]);
485
      $variables['attributes']['data-views-page-contextual-id'] = $variables['title_suffix']['contextual_links']['#id'];
merlinofchaos's avatar
merlinofchaos committed
486 487
      // Add the JavaScript, with a group and weight such that it will run
      // before modules/contextual/contextual.js.
488
      drupal_add_library('views', 'views.contextual-links');
merlinofchaos's avatar
merlinofchaos committed
489 490 491 492 493 494 495 496 497 498 499 500 501 502 503
    }
  }
}

/**
 * Adds contextual links associated with a view display to a renderable array.
 *
 * This function should be called when a view is being rendered in a particular
 * location and you want to attach the appropriate contextual links (e.g.,
 * links for editing the view) to it.
 *
 * The function operates by checking the view's display plugin to see if it has
 * defined any contextual links that are intended to be displayed in the
 * requested location; if so, it attaches them. The contextual links intended
 * for a particular location are defined by the 'contextual links' and
504 505 506
 * 'contextual_links_locations' properties in the plugin annotation; as a
 * result, these hook implementations have full control over where and how
 * contextual links are rendered for each display.
merlinofchaos's avatar
merlinofchaos committed
507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541
 *
 * In addition to attaching the contextual links to the passed-in array (via
 * the standard #contextual_links property), this function also attaches
 * additional information via the #views_contextual_links_info property. This
 * stores an array whose keys are the names of each module that provided
 * views-related contextual links (same as the keys of the #contextual_links
 * array itself) and whose values are themselves arrays whose keys ('location',
 * 'view_name', and 'view_display_id') store the location, name of the view,
 * and display ID that were passed in to this function. This allows you to
 * access information about the contextual links and how they were generated in
 * a variety of contexts where you might be manipulating the renderable array
 * later on (for example, alter hooks which run later during the same page
 * request).
 *
 * @param $render_element
 *   The renderable array to which contextual links will be added. This array
 *   should be suitable for passing in to drupal_render() and will normally
 *   contain a representation of the view display whose contextual links are
 *   being requested.
 * @param $location
 *   The location in which the calling function intends to render the view and
 *   its contextual links. The core system supports three options for this
 *   parameter:
 *   - 'block': Used when rendering a block which contains a view. This
 *     retrieves any contextual links intended to be attached to the block
 *     itself.
 *   - 'page': Used when rendering the main content of a page which contains a
 *     view. This retrieves any contextual links intended to be attached to the
 *     page itself (for example, links which are displayed directly next to the
 *     page title).
 *   - 'view': Used when rendering the view itself, in any context. This
 *     retrieves any contextual links intended to be attached directly to the
 *     view.
 *   If you are rendering a view and its contextual links in another location,
 *   you can pass in a different value for this parameter. However, you will
542 543 544
 *   also need to set 'contextual_links_locations' in your plugin annotation to
 *   indicate which view displays support having their contextual links
 *   rendered in the location you have defined.
merlinofchaos's avatar
merlinofchaos committed
545 546 547 548 549
 * @param $view
 *   The view whose contextual links will be added.
 * @param $display_id
 *   The ID of the display within $view whose contextual links will be added.
 *
550
 * @see \Drupal\views\Plugin\block\block\ViewsBlock::addContextualLinks()
merlinofchaos's avatar
merlinofchaos committed
551 552 553
 * @see views_page_alter()
 * @see template_preprocess_views_view()
 */
554
function views_add_contextual_links(&$render_element, $location, ViewExecutable $view, $display_id) {
merlinofchaos's avatar
merlinofchaos committed
555 556
  // Do not do anything if the view is configured to hide its administrative
  // links.
557
  if ($view->getShowAdminLinks()) {
merlinofchaos's avatar
merlinofchaos committed
558 559 560
    // Also do not do anything if the display plugin has not defined any
    // contextual links that are intended to be displayed in the requested
    // location.
561
    $plugin_id = $view->displayHandlers->get($display_id)->getPluginId();
562
    $plugin = Views::pluginManager('display')->getDefinition($plugin_id);
563
    // If contextual_links_locations are not set, provide a sane default. (To
merlinofchaos's avatar
merlinofchaos committed
564
    // avoid displaying any contextual links at all, a display plugin can still
565
    // set 'contextual_links_locations' to, e.g., {""}.)
566 567 568

    if (!isset($plugin['contextual_links_locations'])) {
      $plugin['contextual_links_locations'] = array('view');
569
    }
570
    elseif ($plugin['contextual_links_locations'] == array() || $plugin['contextual_links_locations'] == array('')) {
571 572
      $plugin['contextual_links_locations'] = array();
    }
573 574 575 576
    else {
      $plugin += array('contextual_links_locations' => array('view'));
    }

merlinofchaos's avatar
merlinofchaos committed
577
    // On exposed_forms blocks contextual links should always be visible.
578
    $plugin['contextual_links_locations'][] = 'exposed_filter';
579 580
    $has_links = !empty($plugin['contextual links']) && !empty($plugin['contextual_links_locations']);
    if ($has_links && in_array($location, $plugin['contextual_links_locations'])) {
merlinofchaos's avatar
merlinofchaos committed
581 582 583 584 585 586
      foreach ($plugin['contextual links'] as $module => $link) {
        $args = array();
        $valid = TRUE;
        if (!empty($link['argument properties'])) {
          foreach ($link['argument properties'] as $property) {
            // If the plugin is trying to create an invalid contextual link
587 588 589 590
            // (for example, "path/to/{$view->storage->property}", where
            // $view->storage->{property} does not exist), we cannot construct
            // the link, so we skip it.
            if (!property_exists($view->storage, $property)) {
merlinofchaos's avatar
merlinofchaos committed
591 592 593 594
              $valid = FALSE;
              break;
            }
            else {
595
              $args[] = $view->storage->{$property};
merlinofchaos's avatar
merlinofchaos committed
596 597 598 599 600 601
            }
          }
        }
        // If the link was valid, attach information about it to the renderable
        // array.
        if ($valid) {
602 603 604 605 606 607 608 609 610
          $render_element['#views_contextual_links'] = TRUE;
          $render_element['#contextual_links'][$module] = array(
            $link['parent path'],
            $args,
            array(
              'location' => $location,
              'name' => $view->storage->id(),
              'display_id' => $display_id,
            )
merlinofchaos's avatar
merlinofchaos committed
611 612 613 614 615 616 617 618
          );
        }
      }
    }
  }
}

/**
619
 * Prepares a list of language names.
merlinofchaos's avatar
merlinofchaos committed
620
 *
621
 * This is a wrapper around language_list to return a plain key value array.
merlinofchaos's avatar
merlinofchaos committed
622
 *
623 624 625 626 627
 * @param string $field
 *   The field of the language object which should be used as the value of the
 *   array.
 * @param int $flags
 *   (optional) Specifies the state of the languages that have to be returned.
628 629
 *   It can be: Language::STATE_CONFIGURABLE, Language::STATE_LOCKED,
 *   Language::STATE_ALL.
630 631 632
 *
 * @return array
 *   An array of language names (or $field) keyed by the langcode.
merlinofchaos's avatar
merlinofchaos committed
633 634 635
 *
 * @see locale_language_list()
 */
636
function views_language_list($field = 'name', $flags = Language::STATE_ALL) {
637
  $languages = language_list($flags);
merlinofchaos's avatar
merlinofchaos committed
638 639
  $list = array();
  foreach ($languages as $language) {
640
    $list[$language->id] = ($field == 'name') ? t($language->name) : $language->$field;
merlinofchaos's avatar
merlinofchaos committed
641 642 643 644 645
  }
  return $list;
}

/**
646
 * Implements hook_ENTITY_TYPE_create() for 'field_instance'.
merlinofchaos's avatar
merlinofchaos committed
647
 */
648
function views_field_instance_create(FieldInstanceInterface $field_instance) {
649 650
  cache('views_info')->deleteAll();
  cache('views_results')->deleteAll();
merlinofchaos's avatar
merlinofchaos committed
651
}
652

merlinofchaos's avatar
merlinofchaos committed
653
/**
654
 * Implements hook_ENTITY_TYPE_update() for 'field_instance'.
merlinofchaos's avatar
merlinofchaos committed
655
 */
656
function views_field_instance_update(FieldInstanceInterface $field_instance) {
657 658
  cache('views_info')->deleteAll();
  cache('views_results')->deleteAll();
merlinofchaos's avatar
merlinofchaos committed
659 660 661
}

/**
662
 * Implements hook_ENTITY_TYPE_delete() for 'field_instance'.
merlinofchaos's avatar
merlinofchaos committed
663
 */
664
function views_field_instance_delete(FieldInstanceInterface $field_instance) {
665 666
  cache('views_info')->deleteAll();
  cache('views_results')->deleteAll();
merlinofchaos's avatar
merlinofchaos committed
667 668 669 670 671 672
}

/**
 * Invalidate the views cache, forcing a rebuild on the next grab of table data.
 */
function views_invalidate_cache() {
673
  // Clear the views cache.
674
  cache('views_info')->deleteAll();
675 676

  // Clear the page and block cache.
677
  Cache::deleteTags(array('content' => TRUE));
678 679

  // Set the menu as needed to be rebuilt.
680
  Drupal::state()->set('menu_rebuild_needed', TRUE);
681

682 683
  $module_handler = Drupal::moduleHandler();

684 685 686 687 688 689 690
  // Set the router to be rebuild.
  // @todo Figure out why the cache rebuild is trigged but the route table
  //   does not exist yet.
  if (db_table_exists('router')) {
    Drupal::service('router.builder')->rebuild();
  }

691
  // Invalidate the block cache to update views block derivatives.
692 693
  if ($module_handler->moduleExists('block')) {
    Drupal::service('plugin.manager.block')->clearCachedDefinitions();
694 695
  }

696
  // Allow modules to respond to the Views cache being cleared.
697
  $module_handler->invokeAll('views_invalidate_cache');
merlinofchaos's avatar
merlinofchaos committed
698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713
}

/**
 * Set the current 'page view' that is being displayed so that it is easy
 * for other modules or the theme to identify.
 */
function &views_set_page_view($view = NULL) {
  static $cache = NULL;
  if (isset($view)) {
    $cache = $view;
  }

  return $cache;
}

/**
714
 * Find out what, if any, page view is currently in use.
merlinofchaos's avatar
merlinofchaos committed
715
 *
716 717 718 719
 * Note that this returns a reference, so be careful! You can unintentionally
 * modify the $view object.
 *
 * @return \Drupal\views\ViewExecutable
merlinofchaos's avatar
merlinofchaos committed
720 721 722 723 724 725 726 727 728 729
 *   A fully formed, empty $view object.
 */
function &views_get_page_view() {
  return views_set_page_view();
}

/**
 * Set the current 'current view' that is being built/rendered so that it is
 * easy for other modules or items in drupal_eval to identify
 *
730
 * @return Drupal\views\ViewExecutable
merlinofchaos's avatar
merlinofchaos committed
731 732 733 734 735 736 737 738 739 740 741
 */
function &views_set_current_view($view = NULL) {
  static $cache = NULL;
  if (isset($view)) {
    $cache = $view;
  }

  return $cache;
}

/**
742
 * Find out what, if any, current view is currently in use.
merlinofchaos's avatar
merlinofchaos committed
743
 *
744 745 746 747
 * Note that this returns a reference, so be careful! You can unintentionally
 * modify the $view object.
 *
 * @return \Drupal\views\ViewExecutable
jhodgdon's avatar
jhodgdon committed
748
 *   The current view object.
merlinofchaos's avatar
merlinofchaos committed
749 750 751 752 753
 */
function &views_get_current_view() {
  return views_set_current_view();
}

754 755 756 757
/**
 * Implements hook_hook_info().
 */
function views_hook_info() {
758 759 760 761 762 763 764 765 766
  $hooks = array();

  $hooks += array_fill_keys(array(
    'views_data',
    'views_data_alter',
    'views_analyze',
    'views_invalidate_cache',
  ), array('group' => 'views'));

767 768 769 770 771 772 773
  // Register a views_plugins alter hook for all plugin types.
  foreach (ViewExecutable::getPluginTypes() as $type) {
    $hooks['views_plugins_' . $type . '_alter'] = array(
      'group' => 'views',
    );
  }

774 775 776 777 778 779 780 781 782 783 784 785
  $hooks += array_fill_keys(array(
    'views_query_substitutions',
    'views_form_substitutions',
    'views_pre_view',
    'views_pre_build',
    'views_post_build',
    'views_pre_execute',
    'views_post_execute',
    'views_pre_render',
    'views_post_render',
    'views_query_alter',
  ), array('group' => 'views_execution'));
786 787

  return $hooks;
merlinofchaos's avatar
merlinofchaos committed
788 789 790
}

/**
791 792 793
 * Implements hook_library_info().
 */
function views_library_info() {
794 795 796 797 798 799 800 801
  $path = drupal_get_path('module', 'views');
  $libraries['views.module'] = array(
    'title' => 'Views base',
    'version' => VERSION,
    'css' => array(
      "$path/css/views.module.css"
    ),
  );
802 803 804 805
  $libraries['views.ajax'] = array(
    'title' => 'Views AJAX',
    'version' => VERSION,
    'js' => array(
806 807
      "$path/js/base.js" => array('group' => JS_DEFAULT),
      "$path/js/ajax_view.js" => array('group' => JS_DEFAULT),
808 809 810 811 812 813 814 815 816 817
    ),
    'dependencies' => array(
      array('system', 'jquery'),
      array('system', 'drupal'),
      array('system', 'drupalSettings'),
      array('system', 'jquery.once'),
      array('system', 'jquery.form'),
      array('system', 'drupal.ajax'),
    ),
  );
818 819 820 821
  $libraries['views.contextual-links'] = array(
    'title' => 'Views Contextual links',
    'version' => VERSION,
    'js' => array(
822
      "$path/js/views-contextual.js" => array('group' => JS_LIBRARY, 'weight' => -10),
823 824 825 826 827 828
    ),
    'dependencies' => array(
      array('system', 'jquery'),
      array('system', 'drupal'),
    ),
  );
829 830 831 832 833 834 835
  $libraries['views.exposed-form'] = array(
    'title' => 'Views exposed form',
    'version' => VERSION,
    'css' => array(
      "$path/css/views.exposed_form.css",
    ),
  );
merlinofchaos's avatar
merlinofchaos committed
836

837
  return $libraries;
merlinofchaos's avatar
merlinofchaos committed
838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854
}

/**
 * Fetch a list of all base tables available
 *
 * @param $type
 *   Either 'display', 'style' or 'row'
 * @param $key
 *   For style plugins, this is an optional type to restrict to. May be 'normal',
 *   'summary', 'feed' or others based on the neds of the display.
 * @param $base
 *   An array of possible base tables.
 *
 * @return
 *   A keyed array of in the form of 'base_table' => 'Description'.
 */
function views_fetch_plugin_names($type, $key = NULL, $base = array()) {
855
  $definitions = Views::pluginManager($type)->getDefinitions();
856
  $plugins = array();
merlinofchaos's avatar
merlinofchaos committed
857

aspilicious's avatar
aspilicious committed
858
  foreach ($definitions as $id => $plugin) {
859 860
    // Skip plugins that don't conform to our key, if they have one.
    if ($key && isset($plugin['display_types']) && !in_array($key, $plugin['display_types'])) {
861 862
      continue;
    }
863

864
    if (empty($plugin['no_ui']) && (empty($base) || empty($plugin['base']) || array_intersect($base, $plugin['base']))) {
aspilicious's avatar
aspilicious committed
865
      $plugins[$id] = $plugin['title'];
merlinofchaos's avatar
merlinofchaos committed
866 867 868
    }
  }

869 870 871
  if (!empty($plugins)) {
    asort($plugins);
    return $plugins;
merlinofchaos's avatar
merlinofchaos committed
872
  }
873

874
  return $plugins;
merlinofchaos's avatar
merlinofchaos committed
875 876
}

877
/**
878 879 880
 * Gets all the views plugin definitions.
 *
 * @return array
881
 *   An array of plugin definitions for all types.
882
 */
883 884 885
function views_get_plugin_definitions() {
  $plugins = array();
  foreach (ViewExecutable::getPluginTypes() as $plugin_type) {
886
    $plugins[$plugin_type] = Views::pluginManager($plugin_type)->getDefinitions();
887 888
  }

889
  return $plugins;
890 891
}

892 893 894 895
/**
 * Get enabled display extenders.
 */
function views_get_enabled_display_extenders() {
896
  $enabled = array_filter((array) config('views.settings')->get('display_extenders'));
897

898
  return drupal_map_assoc($enabled);
899 900
}

merlinofchaos's avatar
merlinofchaos committed
901 902 903 904
/**
 * Return a list of all views and display IDs that have a particular
 * setting in their display's plugin settings.
 *
905 906 907 908 909
 * @param string $type
 *   A flag from the display plugin definitions (e.g, 'uses_hook_menu').
 *
 * @return array
 *   A list of arrays containing the $view and $display_id.
merlinofchaos's avatar
merlinofchaos committed
910 911 912 913 914 915 916 917
 * @code
 * array(
 *   array($view, $display_id),
 *   array($view, $display_id),
 * );
 * @endcode
 */
function views_get_applicable_views($type) {
918
  // Get all display plugins which provides the type.
919
  $display_plugins = Views::pluginManager('display')->getDefinitions();
920 921 922 923
  $ids = array();
  foreach ($display_plugins as $id => $definition) {
    if (!empty($definition[$type])) {
      $ids[$id] = $id;
merlinofchaos's avatar
merlinofchaos committed
924
    }
925
  }
merlinofchaos's avatar
merlinofchaos committed
926

927
  $entity_ids = Drupal::service('entity.query')->get('view')
928
    ->condition('status', TRUE)
929 930
    ->condition("display.*.display_plugin", $ids, 'IN')
    ->execute();
merlinofchaos's avatar
merlinofchaos committed
931

932
  $result = array();
933
  foreach (Drupal::entityManager()->getStorageController('view')->loadMultiple($entity_ids) as $view) {
934
    // Check each display to see if it meets the criteria and is enabled.
935
    $executable = $view->getExecutable();
936
    $executable->initDisplay();
937 938 939
    foreach ($executable->displayHandlers as $id => $handler) {
      if (!empty($handler->definition[$type]) && $handler->isEnabled()) {
        $result[] = array($executable, $id);
merlinofchaos's avatar
merlinofchaos committed
940 941 942
      }
    }
  }
943

merlinofchaos's avatar
merlinofchaos committed
944 945 946 947
  return $result;
}

/**
948
 * Returns an array of all views as fully loaded $view objects.
merlinofchaos's avatar
merlinofchaos committed
949
 */
950
function views_get_all_views() {
951
  return Drupal::entityManager()->getStorageController('view')->loadMultiple();
952 953
}

merlinofchaos's avatar
merlinofchaos committed
954 955 956 957
/**
 * Returns an array of all enabled views, as fully loaded $view objects.
 */
function views_get_enabled_views() {
958
  $query = Drupal::entityQuery('view')
959 960 961 962
    ->condition('status', TRUE)
    ->execute();

  return entity_load_multiple('view', $query);
merlinofchaos's avatar
merlinofchaos committed
963 964 965 966 967 968
}

/**
 * Returns an array of all disabled views, as fully loaded $view objects.
 */
function views_get_disabled_views() {
969
  $query = Drupal::entityQuery('view')
970 971 972 973
    ->condition('status', FALSE)
    ->execute();

  return entity_load_multiple('view', $query);
merlinofchaos's avatar
merlinofchaos committed
974 975 976 977 978 979 980 981 982 983 984 985 986 987
}

/**
 * Return an array of view as options array, that can be used by select,
 * checkboxes and radios as #options.
 *
 * @param bool $views_only
 *  If TRUE, only return views, not displays.
 * @param string $filter
 *  Filters the views on status. Can either be 'all' (default), 'enabled' or
 *  'disabled'
 * @param  mixed $exclude_view
 *  view or current display to exclude
 *  either a
988
 *  - views object (containing $exclude_view->storage->name and $exclude_view->current_display)
merlinofchaos's avatar
merlinofchaos committed
989 990 991 992 993
 *  - views name as string:  e.g. my_view
 *  - views name and display id (separated by ':'): e.g. my_view:default
 * @param bool $optgroup
 *  If TRUE, returns an array with optgroups for each view (will be ignored for
 *  $views_only = TRUE). Can be used by select
994 995
 * @param bool $sort
 *  If TRUE, the list of views is sorted ascending.
merlinofchaos's avatar
merlinofchaos committed
996 997 998 999 1000
 *
 * @return array
 *  an associative array for use in select.
 *  - key: view name and display id separated by ':', or the view name only
 */
1001
function views_get_views_as_options($views_only = FALSE, $filter = 'all', $exclude_view = NULL, $optgroup = FALSE, $sort = FALSE) {
merlinofchaos's avatar
merlinofchaos committed
1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020

  // Filter the big views array.
  switch ($filter) {
    case 'all':
    case 'disabled':
    case 'enabled':
      $func = "views_get_{$filter}_views";
      $views = $func();
      break;
    default:
      return array();
  }

  // Prepare exclude view strings for comparison.
  if (empty($exclude_view)) {
    $exclude_view_name = '';
    $exclude_view_display = '';
  }
  elseif (is_object($exclude_view)) {
1021
    $exclude_view_name = $exclude_view->storage->id();
merlinofchaos's avatar
merlinofchaos committed
1022 1023 1024
    $exclude_view_display = $exclude_view->current_display;
  }
  else {
1025 1026 1027
    // Append a ':' to the $exclude_view string so we always have more than one
    // item to explode.
    list($exclude_view_name, $exclude_view_display) = explode(':', "$exclude_view:");
merlinofchaos's avatar
merlinofchaos committed
1028 1029 1030 1031
  }

  $options = array();
  foreach ($views as $view) {
1032
    $id = $view->id();
merlinofchaos's avatar
merlinofchaos committed
1033
    // Return only views.
1034
    if ($views_only && $id != $exclude_view_name) {
1035
      $options[$id] = $view->label();
merlinofchaos's avatar
merlinofchaos committed
1036 1037 1038
    }
    // Return views with display ids.
    else {
1039
      foreach ($view->get('display') as $display_id => $display) {
1040
        if (!($id == $exclude_view_name && $display_id == $exclude_view_display)) {
merlinofchaos's avatar
merlinofchaos committed
1041
          if ($optgroup) {
1042
            $options[$id][$id . ':' . $display['id']] = t('@view : @display', array('@view' => $id, '@display' => $display['id']));
merlinofchaos's avatar
merlinofchaos committed
1043 1044
          }
          else {
1045
            $options[$id . ':' . $display['id']] = t('View: @view - Display: @display', array('@view' => $id, '@display' => $display['id']));
merlinofchaos's avatar
merlinofchaos committed
1046 1047 1048 1049 1050
          }
        }
      }
    }
  }
1051 1052 1053
  if ($sort) {
    ksort($options);
  }
merlinofchaos's avatar
merlinofchaos committed
1054 1055 1056 1057
  return $options;
}

/**
dawehner's avatar
dawehner committed
1058 1059
 * Returns whether the view is enabled.
 *
1060
 * @param Drupal\views\Plugin\Core\Entity\View $view
xjm's avatar
xjm committed
1061
 *   The view object to check.
dawehner's avatar
dawehner committed
1062 1063 1064
 *
 * @return bool
 *   Returns TRUE if a view is enabled, FALSE otherwise.
merlinofchaos's avatar
merlinofchaos committed
1065
 */
1066
function views_view_is_enabled(View $view) {
1067
  return $view->status();
merlinofchaos's avatar
merlinofchaos committed
1068 1069 1070
}

/**
dawehner's avatar
dawehner committed
1071 1072
 * Returns whether the view is disabled.
 *
1073
 * @param Drupal\views\Plugin\Core\Entity\View $view
xjm's avatar
xjm committed
1074
 *   The view object to check.
dawehner's avatar
dawehner committed
1075 1076 1077
 *
 * @return bool
 *   Returns TRUE if a view is disabled, FALSE otherwise.
merlinofchaos's avatar
merlinofchaos committed
1078
 */
1079
function views_view_is_disabled(View $view) {
1080
  return !$view->status();
merlinofchaos's avatar
merlinofchaos committed
1081 1082
}

1083
/**
1084
 * Enables and saves a view.
1085
 *
1086 1087
 * @param Drupal\views\Plugin\Core\Entity\View $view
 *   The View object to disable.
1088
 */
1089
function views_enable_view(View $view) {
1090
  $view->enable()->save();
1091 1092 1093
}

/**
1094
 * Disables and saves a view.
1095
 *
1096 1097
 * @param Drupal\views\Plugin\Core\Entity\View $view
 *   The View object to disable.
1098
 */
1099
function views_disable_view(View $view) {
1100
  $view->disable()->save();
1101 1102
}

merlinofchaos's avatar
merlinofchaos committed
1103
/**
xjm's avatar
xjm committed
1104
 * Loads a view from configuration.
merlinofchaos's avatar
merlinofchaos committed
1105
 *
xjm's avatar
xjm committed
1106
 * @param string $name
merlinofchaos's avatar
merlinofchaos committed
1107
 *   The name of the view.
xjm's avatar
xjm committed
1108
 *
1109
 * @return Drupal\views\ViewExecutable
dawehner's avatar
dawehner committed
1110
 *   A reference to the $view object.
1111 1112 1113
 *
 * @deprecated as of Drupal 8.0. Use \Drupal\views\Views::getView().
 *
merlinofchaos's avatar
merlinofchaos committed
1114
 */
1115
function views_get_view($name) {
1116
  return Views::getView($name);
merlinofchaos's avatar
merlinofchaos committed
1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144
}

/**
 * Returns TRUE if the passed-in view contains handlers with views form
 * implementations, FALSE otherwise.
 */
function views_view_has_form_elements($view) {
  foreach ($view->field as $field) {
    if (property_exists($field, 'views_form_callback') || method_exists($field, 'views_form')) {
      return TRUE;
    }
  }
  $area_handlers = array_merge(array_values($view->header), array_values($view->footer));
  $empty = empty($view->result);
  foreach ($area_handlers as $area) {
    if (method_exists($area, 'views_form') && !$area->views_form_empty($empty)) {
      return TRUE;
    }
  }
  return FALSE;
}

/**
 * This is the entry function. Just gets the form for the current step.
 * The form is always assumed to be multistep, even if it has only one
 * step (the default 'views_form_views_form' step). That way it is actually
 * possible for modules to have a multistep form if they need to.
 */
1145
function views_form($form, &$form_state, ViewExecutable $view, $output) {
merlinofchaos's avatar
merlinofchaos committed
1146 1147 1148 1149 1150 1151 1152 1153
  $form_state['step'] = isset($form_state['step']) ? $form_state['step'] : 'views_form_views_form';
  // Cache the built form to prevent it from being rebuilt prior to validation
  // and submission, which could lead to data being processed incorrectly,
  // because the views rows (and thus, the form elements as well) have changed
  // in the meantime.
  $form_state['cache'] = TRUE;

  $form = array();
1154
  $query = drupal_get_query_parameters();
1155
  $form['#action'] = url($view->getUrl(), array('query' => $query));
merlinofchaos's avatar
merlinofchaos committed
1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169
  // Tell the preprocessor whether it should hide the header, footer, pager...
  $form['show_view_elements'] = array(
    '#type' => 'value',
    '#value' => ($form_state['step'] == 'views_form_views_form') ? TRUE : FALSE,
  );

  $form = $form_state['step']($form, $form_state, $view, $output);
  return $form;
}

/**
 * Callback for the main step of a Views form.
 * Invoked by views_form().
 */
1170
function views_form_views_form($form, &$form_state, ViewExecutable $view, $output) {
merlinofchaos's avatar
merlinofchaos committed
1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185
  $form['#prefix'] = '<div class="views-form">';
  $form['#suffix'] = '</div>';
  $form['#theme'] = 'views_form_views_form';
  $form['#validate'][] = 'views_form_views_form_validate';
  $form['#submit'][] = 'views_form_views_form_submit';

  // Add the output markup to the form array so that it's included when the form
  // array is passed to the theme function.
  $form['output'] = array(
    '#markup' => $output,
    // This way any additional form elements will go before the view
    // (below the exposed widgets).
    '#weight' => 50,
  );

1186 1187 1188 1189 1190 1191 1192 1193
  $form['actions'] = array(
    '#type' => 'actions',
  );
  $form['actions']['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Save'),
  );

merlinofchaos's avatar
merlinofchaos committed
1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322
  $substitutions = array();
  foreach ($view->field as $field_name => $field) {
    $form_element_name = $field_name;
    if (method_exists($field, 'form_element_name')) {
      $form_element_name = $field->form_element_name();
    }
    $method_form_element_row_id_exists = FALSE;
    if (method_exists($field, 'form_element_row_id')) {
      $method_form_element_row_id_exists = TRUE;
    }

    // If the field provides a views form, allow it to modify the $form array.
    $has_form = FALSE;
    if (property_exists($field, 'views_form_callback')) {
      $callback = $field->views_form_callback;
      $callback($view, $field, $form, $form_state);
      $has_form = TRUE;
    }
    elseif (method_exists($field, 'views_form')) {
      $field->views_form($form, $form_state);
      $has_form = TRUE;
    }

    // Build the substitutions array for use in the theme function.
    if ($has_form) {
      foreach ($view->result as $row_id => $row) {
        if ($method_form_element_row_id_exists) {
          $form_element_row_id = $field->form_element_row_id($row_id);
        }
        else {
          $form_element_row_id = $row_id;
        }

        $substitutions[] = array(
          'placeholder' => '<!--form-item-' . $form_element_name . '--' . $form_element_row_id . '-->',
          'field_name' => $form_element_name,
          'row_id' => $form_element_row_id,
        );
      }
    }
  }

  // Give the area handlers a chance to extend the form.
  $area_handlers = array_merge(array_values($view->header), array_values($view->footer));
  $empty = empty($view->result);
  foreach ($area_handlers as $area) {
    if (method_exists($area, 'views_form') && !$area->views_form_empty($empty)) {
      $area->views_form($form, $form_state);
    }
  }

  $form['#substitutions'] = array(
    '#type' => 'value',
    '#value' => $substitutions,
  );

  return $form;
}

/**
 * Validate handler for the first step of the views form.
 * Calls any existing views_form_validate functions located
 * on the views fields.
 */
function views_form_views_form_validate($form, &$form_state) {
  $view = $form_state['build_info']['args'][0];

  // Call the validation method on every field handler that has it.
  foreach ($view->field as $field_name => $field) {
    if (method_exists($field, 'views_form_validate')) {
      $field->views_form_validate($form, $form_state);
    }
  }

  // Call the validate method on every area handler that has it.
  foreach (array('header', 'footer') as $area) {
    foreach ($view->{$area} as $area_name => $area_handler) {
      if (method_exists($area_handler, 'views_form_validate')) {
        $area_handler->views_form_validate($form, $form_state);
      }
    }
  }
}

/**
 * Submit handler for the first step of the views form.
 * Calls any existing views_form_submit functions located
 * on the views fields.
 */
function views_form_views_form_submit($form, &$form_state) {
  $view = $form_state['build_info']['args'][0];

  // Call the submit method on every field handler that has it.
  foreach ($view->field as $field_name => $field) {
    if (method_exists($field, 'views_form_submit')) {
      $field->views_form_submit($form, $form_state);
    }
  }

  // Call the submit method on every area handler that has it.
  foreach (array('header', 'footer') as $area) {
    foreach ($view->{$area} as $area_name => $area_handler) {
      if (method_exists($area_handler, 'views_form_submit')) {
        $area_handler->views_form_submit($form, $form_state);
      }
    }
  }
}

/**
 * Form builder for the exposed widgets form.
 *
 * Be sure that $view and $display are references.
 */
function views_exposed_form($form, &$form_state) {
  // Don't show the form when batch operations are in progress.
  if ($batch = batch_get() && isset($batch['current_set'])) {
    return array(
      // Set the theme callback to be nothing to avoid errors in template_preprocess_views_exposed_form().
      '#theme' => '',
    );
  }

  // Make sure that we validate because this form might be submitted
  // multiple times per page.
  $form_state['must_validate'] = TRUE;
  $view = &$form_state['view'];
  $display = &$form_state['display'];

1323
  $form_state['input'] = $view->getExposedInput();
merlinofchaos's avatar
merlinofchaos committed
1324 1325 1326 1327

  // Let form plugins know this is for exposed widgets.
  $form_state['exposed'] = TRUE;
  // Check if the form was already created
1328
  if ($cache = views_exposed_form_cache($view->storage->id(), $view->current_display)) {
merlinofchaos's avatar
merlinofchaos committed
1329 1330 1331 1332 1333 1334 1335 1336
    return $cache;
  }

  $form['#info'] = array();

  // Go through each handler and let it generate its exposed widget.
  foreach ($view->display_handler->handlers as $type => $value) {
    foreach ($view->$type as $id => $handler) {
1337
      if ($handler->canExpose() && $handler->isExposed()) {
1338 1339 1340 1341 1342
        // Grouped exposed filters have their own forms.
        // Instead of render the standard exposed form, a new Select or
        // Radio form field is rendered with the available groups.
        // When an user choose an option the selected value is split
        // into the operator and value that the item represents.
1343
        if ($handler->isAGroup()) {
1344
          $handler->groupForm($form, $form_state);
1345 1346 1347
          $id = $handler->options['group_info']['identifier'];
        }
        else {
1348
          $handler->buildExposedForm($form, $form_state);
1349
        }
1350
        if ($info = $handler->exposedInfo()) {
merlinofchaos's avatar
merlinofchaos committed
1351 1352 1353 1354 1355 1356
          $form['#info']["$type-$id"] = $info;
        }
      }
    }
  }

1357 1358
  $form['actions'] = array('#type' => 'actions');
  $form['actions']['submit'] = array(
1359 1360
    // Prevent from showing up in $_GET.
    '#name' => '',
merlinofchaos's avatar
merlinofchaos committed
1361 1362
    '#type' => 'submit',
    '#value' => t('Apply'),
1363
    '#id' => drupal_html_id('edit-submit-' . $view->storage->id()),
merlinofchaos's avatar
merlinofchaos committed
1364 1365
  );

1366
  $form['#action'] = url($view->display_handler->getUrl());
1367
  $form['#theme'] = $view->buildThemeFunctions('views_exposed_form');
1368
  $form['#id'] = drupal_clean_css_identifier('views_exposed_form-' . check_plain($view->storage->id()) . '-' . check_plain($display['id']));
merlinofchaos's avatar
merlinofchaos committed
1369 1370 1371
//  $form['#attributes']['class'] = array('views-exposed-form');

  $exposed_form_plugin = $form_state['exposed_form_plugin'];
1372
  $exposed_form_plugin->exposedFormAlter($form, $form_state);
merlinofchaos's avatar
merlinofchaos committed
1373 1374

  // Save the form
1375
  views_exposed_form_cache($view->storage->id(), $view->current_display, $form);
merlinofchaos's avatar
merlinofchaos committed
1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398

  return $form;
}

/**
 * Implement hook_form_alter for the exposed form.
 *
 * Since the exposed form is a GET form, we don't want it to send a wide
 * variety of information.
 */
function views_form_views_exposed_form_alter(&$form, &$form_state) {
  $form['form_build_id']['#access'] = FALSE;
  $form['form_token']['#access'] = FALSE;
  $form['form_id']['#access'] = FALSE;
}

/**
 * Validate handler for exposed filters
 */
function views_exposed_form_validate(&$form, &$form_state) {
  foreach (array('field', 'filter') as $type) {
    $handlers = &$form_state['view']->$type;
    foreach ($handlers as $key => $handler) {
1399
      $handlers[$key]->validateExposed($form, $form_state);
merlinofchaos's avatar
merlinofchaos committed
1400 1401 1402
    }
  }
  $exposed_form_plugin = $form_state['exposed_form_plugin'];
1403
  $exposed_form_plugin->exposedFormValidate($form, $form_state);
merlinofchaos's avatar
merlinofchaos committed
1404 1405 1406 1407 1408 1409 1410 1411 1412
}

/**
 * Submit handler for exposed filters
 */
function views_exposed_form_submit(&$form, &$form_state) {
  foreach (array('field', 'filter') as $type) {
    $handlers = &$form_state['view']->$type;
    foreach ($handlers as $key => $info) {
1413
      $handlers[$key]->submitExposed($form, $form_state);
merlinofchaos's avatar
merlinofchaos committed
1414 1415 1416 1417 1418
    }
  }
  $form_state['view']->exposed_data = $form_state['values'];
  $form_state['view']->exposed_raw_input = array();

1419
  $exclude = array('submit', 'form_build_id', 'form_id', 'form_token', 'exposed_form_plugin', '', 'reset');
merlinofchaos's avatar
merlinofchaos committed
1420
  $exposed_form_plugin = $form_state['exposed_form_plugin'];
1421
  $exposed_form_plugin->exposedFormSubmit($form, $form_state, $exclude);
merlinofchaos's avatar
merlinofchaos committed
1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442

  foreach ($form_state['values'] as $key => $value) {
    if (!in_array($key, $exclude)) {
      $form_state['view']->exposed_raw_input[$key] = $value;
    }
  }
}

/**
 * Save the Views exposed form for later use.
 *
 * @param $views_name
 *   String. The views name.
 * @param $display_name
 *   String. The current view display name.
 * @param $form_output
 *   Array (optional). The form structure. Only needed when inserting the value.
 * @return
 *   Array. The form structure, if any. Otherwise, return FALSE.
 */
function views_exposed_form_cache($views_name, $display_name, $form_output = NULL) {
1443 1444 1445
  // When running tests for exposed filters, this cache should
  // be cleared between each test.
  $views_exposed = &drupal_static(__FUNCTION__);
merlinofchaos's avatar
merlinofchaos committed
1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462

  // Save the form output
  if (!empty($form_output)) {
    $views_exposed[$views_name][$display_name] = $form_output;
    return;
  }

  // Return the form output, if any
  return empty($views_exposed[$views_name][$display_name]) ? FALSE : $views_exposed[$views_name][$display_name];
}

/**
 * Implements hook_query_TAG_alter().
 *
 * This is the hook_query_alter() for queries tagged by Views and is used to
 * add in substitutions from hook_views_query_substitutions().
 */
1463
function views_query_views_alter(AlterableInterface $query) {
merlinofchaos's avatar
merlinofchaos committed
1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483
  $substitutions = $query->getMetaData('views_substitutions');
  $tables =& $query->getTables();
  $where =& $query->conditions();

  // Replaces substitions in tables.
  foreach ($tables as $table_name => $table_metadata) {
    foreach ($table_metadata['arguments'] as $replacement_key => $value) {
      if (isset($substitutions[$value])) {
        $tables[$table_name]['arguments'][$replacement_key] = $substitutions[$value];
      }
    }
  }

  // Replaces substitions in filter criterias.
  _views_query_tag_alter_condition($query, $where, $substitutions);
}

/**
 * Replaces the substitutions recursive foreach condition.
 */
1484
function _views_query_tag_alter_condition(AlterableInterface $query, &$conditions, $substitutions) {
merlinofchaos's avatar
merlinofchaos committed
1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517
  foreach ($conditions as $condition_id => &$condition) {
    if (is_numeric($condition_id)) {
      if (is_string($condition['field'])) {
        $condition['field'] = str_replace(array_keys($substitutions), array_values($substitutions), $condition['field']);
      }
      elseif (is_object($condition['field'])) {
        $sub_conditions =& $condition['field']->conditions();
        _views_query_tag_alter_condition($query, $sub_conditions, $substitutions);
      }
      // $condition['value'] is a subquery so alter the subquery recursive.
      // Therefore take sure to get the metadata of the main query.
      if (is_object($condition['value'])) {
        $subquery = $condition['value'];
        $subquery->addMetaData('views_substitutions', $query->getMetaData('views_substitutions'));
        views_query_views_alter($condition['value']);
      }
      elseif (isset($condition['value'])) {
        $condition['value'] = str_replace(array_keys($substitutions), array_values($substitutions), $condition['value']);
      }
    }
  }
}

/**
 * Embed a view using a PHP snippet.
 *
 * This function is meant to be called from PHP snippets, should one wish to
 * embed a view in a node or something. It's meant to provide the simplest
 * solution and doesn't really offer a lot of options, but breaking the function
 * apart is pretty easy, and this provides a worthwhile guide to doing so.
 *
 * Note that this function does NOT display the title of the view. If you want
 * to do that, you will need to do what this function does manually, by
1518
 * loading the view, getting the preview and then getting $view->getTitle().
merlinofchaos's avatar
merlinofchaos committed
1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569
 *
 * @param $name
 *   The name of the view to embed.
 * @param $display_id
 *   The display id to embed. If unsure, use 'default', as it will always be
 *   valid. But things like 'page' or 'block' should work here.
 * @param ...
 *   Any additional parameters will be passed as arguments.
 */
function views_embed_view($name, $display_id = 'default') {
  $args = func_get_args();
  array_shift($args); // remove $name
  if (count($args)) {
    array_shift($args); // remove $display_id
  }

  $view = views_get_view($name);
  if (!$view || !$view->access($display_id)) {
    return;
  }

  return $view->preview($display_id, $args);
}

/**
 * Get the result of a view.
 *
 * @param string $name
 *   The name of the view to retrieve the data from.
 * @param string $display_id
 *   The display id. On the edit page for the view in question, you'll find
 *   a list of displays at the left side of the control area. "Master"
 *   will be at the top of that list. Hover your cursor over the name of the
 *   display you want to use. An URL will appear in the status ba