views.module 56 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\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 84
 * Implements hook_theme().
 *
 * Register views theming functions and those that are defined via views plugin
 * definitions.
merlinofchaos's avatar
merlinofchaos committed
85 86
 */
function views_theme($existing, $type, $theme, $path) {
87
  \Drupal::moduleHandler()->loadInclude('views', 'inc', 'views.theme');
merlinofchaos's avatar
merlinofchaos committed
88 89 90

  // Some quasi clever array merging here.
  $base = array(
91
    'file' => 'views.theme.inc',
merlinofchaos's avatar
merlinofchaos committed
92 93 94 95 96
  );

  // Our extra version of pager from pager.inc
  $hooks['views_mini_pager'] = $base + array(
    'variables' => array('tags' => array(), 'quantity' => 10, 'element' => 0, 'parameters' => array()),
97
    'template' => 'views-mini-pager',
merlinofchaos's avatar
merlinofchaos committed
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119
  );

  $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(
    '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),
120
    'template' => 'views-view-grouping',
merlinofchaos's avatar
merlinofchaos committed
121 122
  );

123
  $plugins = views_get_plugin_definitions();
124
  $module_handler = \Drupal::moduleHandler();
merlinofchaos's avatar
merlinofchaos committed
125

126 127 128 129
  // Register theme functions for all style plugins. It provides a basic auto
  // implementation of theme functions or template files by using the plugin
  // definitions (theme, theme_file, module, register_theme). Template files are
  // assumed to be located in the templates folder.
merlinofchaos's avatar
merlinofchaos committed
130
  foreach ($plugins as $type => $info) {
131
    foreach ($info as $def) {
132 133 134 135 136
      // 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;
      }
137 138 139 140
      // For each theme registration we a base directory to look for the
      // templates folder. This will be in any case the root of the given module
      // so we always need a module definition.
      // @todo: watchdog or exception?
141
      if (!isset($def['provider']) || !$module_handler->moduleExists($def['provider'])) {
142 143
        continue;
      }
merlinofchaos's avatar
merlinofchaos committed
144

145 146 147
      $hooks[$def['theme']] = array(
        'variables' => $variables[$type],
      );
merlinofchaos's avatar
merlinofchaos committed
148

149 150
      // For the views module we ensure views.theme.inc is included.
      if ($def['provider'] == 'views') {
151 152
        $def['theme_file'] = 'views.theme.inc';
      }
153 154
      // We always use the module directory as base dir.
      $module_dir = drupal_get_path('module', $def['provider']);
merlinofchaos's avatar
merlinofchaos committed
155

156
      // The theme_file definition is always relative to the modules directory.
157
      if (isset($def['theme_file'])) {
158
        $hooks[$def['theme']]['path'] = $module_dir;
159 160
        $hooks[$def['theme']]['file'] = $def['theme_file'];
      }
161 162 163 164
      // Whenever we got a theme file, we include it directly so we can
      // auto-detect the theme function.
      if (isset($def['theme_file'])) {
        $include = DRUPAL_ROOT . '/' . $module_dir. '/' . $def['theme_file'];
165 166
        if (is_file($include)) {
          require_once $include;
merlinofchaos's avatar
merlinofchaos committed
167 168
        }
      }
169 170 171 172 173 174
     // If there is no theme function for the given theme definition, we assume
     // a template file shall be used. By default this file is located in the
     // /templates directory of the module's folder.
     // If a module wants to define its own location it has to set
     // register_theme of the plugin to FALSE and implement hook_theme() by
     // itself.
175
      if (!function_exists('theme_' . $def['theme'])) {
176 177
        $hooks[$def['theme']]['path'] = $module_dir;
        $hooks[$def['theme']]['template'] = 'templates/' . drupal_clean_css_identifier($def['theme']);
178
      }
merlinofchaos's avatar
merlinofchaos committed
179 180 181 182 183 184 185 186 187 188 189 190 191 192
    }
  }

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

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

  $hooks['views_more'] = $base + array(
    'variables' => array('more_url' => NULL, 'link_text' => 'more', 'view' => NULL),
193
    'template' => 'views-more',
merlinofchaos's avatar
merlinofchaos committed
194 195 196 197 198
  );

  return $hooks;
}

199 200 201 202 203 204 205 206 207 208 209 210 211
/**
 * 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() {
212
  $plugin_data = views_get_plugin_definitions();
213 214
  $plugins = array();
  foreach (views_get_enabled_views() as $view) {
215
    foreach ($view->get('display') as $display) {
216
      foreach ($plugin_data as $type => $info) {
217 218
        if ($type == 'display' && isset($display['display_plugin'])) {
          $name = $display['display_plugin'];
219
        }
220 221
        elseif (isset($display['display_options']["{$type}_plugin"])) {
          $name = $display['display_options']["{$type}_plugin"];
222
        }
223 224
        elseif (isset($display['display_options'][$type]['type'])) {
          $name = $display['display_options'][$type]['type'];
225 226 227 228 229 230 231 232 233 234 235 236
        }
        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']),
237
            'provider' => check_plain($info[$name]['provider']),
238 239 240 241 242
            'views' => array(),
          );
        }

        // Add this view to the list for this plugin.
243
        $plugins[$key]['views'][$view->id()] = $view->id();
244 245 246 247 248 249
      }
    }
  }
  return $plugins;
}

merlinofchaos's avatar
merlinofchaos committed
250 251 252 253 254 255 256 257
/**
 * 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.
 */
258
function views_preprocess_node(&$variables) {
259
  \Drupal::moduleHandler()->loadInclude('node', 'views.inc');
260 261
  // The 'view' attribute of the node is added in
  // \Drupal\views\Plugin\views\row\EntityRow::preRender().
262 263
  if (!empty($variables['node']->view) && $variables['node']->view->storage->id()) {
    $variables['view'] = $variables['node']->view;
264 265 266 267 268 269 270
    // 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:
    if (!empty($variables['view']->current_display)
        && $variables['page']
        && $variables['view_mode'] == 'full'
        && !$variables['view']->display_handler->hasPath()) {
      $variables['page'] = FALSE;
merlinofchaos's avatar
merlinofchaos committed
271 272 273 274
    }
  }

  // Allow to alter comments and links based on the settings in the row plugin.
275 276
  if (!empty($variables['view']->rowPlugin) && $variables['view']->rowPlugin->getPluginId() == 'entity:node') {
    node_row_node_view_preprocess_node($variables);
merlinofchaos's avatar
merlinofchaos committed
277 278 279
  }
}

280 281 282 283 284 285 286 287 288 289 290 291 292
/**
 * Implements hook_theme_suggestions_HOOK_alter().
 */
function views_theme_suggestions_node_alter(array &$suggestions, array $variables) {
  $node = $variables['elements']['#node'];
  if (!empty($node->view) && $node->view->storage->id()) {
    $suggestions[] = 'node__view__' . $node->view->storage->id();
    if (!empty($node->view->current_display)) {
      $suggestions[] = 'node__view__' . $node->view->storage->id() . '__' . $node->view->current_display;
    }
  }
}

merlinofchaos's avatar
merlinofchaos committed
293 294 295 296
/**
 * A theme preprocess function to automatically allow view-based node
 * templates if called from a view.
 */
297
function views_preprocess_comment(&$variables) {
298 299
  // The view data is added to the comment in
  // \Drupal\views\Plugin\views\row\EntityRow::preRender().
300 301
  if (!empty($variables['comment']->view) && $variables['comment']->view->storage->id()) {
    $variables['view'] = &$variables['comment']->view;
302 303 304 305 306 307 308 309 310 311 312 313
  }
}

/**
 * Implements hook_theme_suggestions_HOOK_alter().
 */
function views_theme_suggestions_comment_alter(array &$suggestions, array $variables) {
  $comment = $variables['elements']['#comment'];
  if (!empty($comment->view) && $comment->view->storage->id()) {
    $suggestions[] = 'comment__view__' . $comment->view->storage->id();
    if (!empty($comment->view->current_display)) {
      $suggestions[] = 'comment__view__' . $comment->view->storage->id() . '__' . $comment->view->current_display;
merlinofchaos's avatar
merlinofchaos committed
314 315 316 317 318
    }
  }
}

/**
319
 * Implements hook_permission().
merlinofchaos's avatar
merlinofchaos committed
320 321 322 323 324 325
 */
function views_permission() {
  return array(
    'access all views' => array(
      'title' => t('Bypass views access control'),
      'description' => t('Bypass access control when accessing views.'),
326
      'restrict access' => TRUE,
merlinofchaos's avatar
merlinofchaos committed
327 328 329 330 331 332 333 334 335 336 337 338
    ),
  );
}

/**
 * Implement hook_menu().
 */
function views_menu() {
  $items = array();
  $items['views/ajax'] = array(
    'title' => 'Views',
    'theme callback' => 'ajax_base_page_theme',
339
    'route_name' => 'views.ajax',
merlinofchaos's avatar
merlinofchaos committed
340 341 342 343 344 345 346 347 348 349
    'type' => MENU_CALLBACK,
  );
  return $items;
}

/**
 * Implement hook_menu_alter().
 */
function views_menu_alter(&$callbacks) {
  $our_paths = array();
350
  $views = views_get_applicable_views('uses_hook_menu');
merlinofchaos's avatar
merlinofchaos committed
351 352
  foreach ($views as $data) {
    list($view, $display_id) = $data;
353
    $result = $view->executeHookMenu($display_id, $callbacks);
merlinofchaos's avatar
merlinofchaos committed
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 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415
    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)) {
416 417
    $view->setDisplay($display_id);
    $view->initHandlers();
merlinofchaos's avatar
merlinofchaos committed
418 419 420 421

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

    $indexes = array();
422
    $path = explode('/', $view->getPath());
merlinofchaos's avatar
merlinofchaos committed
423 424 425 426 427 428 429 430 431

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

    if (isset($indexes[$index])) {
      if (isset($view->argument[$indexes[$index]])) {
432
        $arg = $view->argument[$indexes[$index]]->validateMenuArgument($value) ? $value : FALSE;
merlinofchaos's avatar
merlinofchaos committed
433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462
        $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)) {
463 464 465 466 467 468
    if ($output = $view->executeDisplay($display_id, $args)) {
      return $output;
    }
    else {
      return array();
    }
merlinofchaos's avatar
merlinofchaos committed
469 470
  }

471
  // Fallback if we get here no view was found.
merlinofchaos's avatar
merlinofchaos committed
472 473 474 475 476 477 478 479 480 481
  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.
482
  if ($view = views_get_page_view()) {
merlinofchaos's avatar
merlinofchaos committed
483 484 485 486 487 488 489 490
    views_add_contextual_links($page, 'page', $view, $view->current_display);
  }
}

/**
 * Implements MODULE_preprocess_HOOK().
 */
function views_preprocess_html(&$variables) {
491 492 493 494 495
  // Early-return to prevent adding unnecessary JavaScript.
  if (!user_access('access contextual links')) {
    return;
  }

merlinofchaos's avatar
merlinofchaos committed
496 497 498 499 500 501 502 503 504
  // 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
505 506
  // page.html.twig, so we can only find it using JavaScript. We therefore
  // remove the "contextual-region" class from the <body> tag here and add
merlinofchaos's avatar
merlinofchaos committed
507
  // JavaScript that will insert it back in the correct place.
508
  if (!empty($variables['page']['#views_contextual_links'])) {
509
    $key = array_search('contextual-region', $variables['attributes']['class']);
merlinofchaos's avatar
merlinofchaos committed
510
    if ($key !== FALSE) {
511
      unset($variables['attributes']['class'][$key]);
512
      $variables['attributes']['data-views-page-contextual-id'] = $variables['title_suffix']['contextual_links']['#id'];
513
      drupal_add_library('views', 'views.contextual-links');
merlinofchaos's avatar
merlinofchaos committed
514 515 516 517 518 519 520 521 522 523 524 525 526 527 528
    }
  }
}

/**
 * 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
529 530 531
 * '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
532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566
 *
 * 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
567 568 569
 *   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
570 571 572 573 574
 * @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.
 *
575
 * @see \Drupal\views\Plugin\block\block\ViewsBlock::addContextualLinks()
merlinofchaos's avatar
merlinofchaos committed
576 577 578
 * @see views_page_alter()
 * @see template_preprocess_views_view()
 */
579
function views_add_contextual_links(&$render_element, $location, ViewExecutable $view, $display_id) {
merlinofchaos's avatar
merlinofchaos committed
580 581
  // Do not do anything if the view is configured to hide its administrative
  // links.
582
  if ($view->getShowAdminLinks()) {
merlinofchaos's avatar
merlinofchaos committed
583 584 585
    // 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.
586
    $plugin_id = $view->displayHandlers->get($display_id)->getPluginId();
587
    $plugin = Views::pluginManager('display')->getDefinition($plugin_id);
588
    // If contextual_links_locations are not set, provide a sane default. (To
merlinofchaos's avatar
merlinofchaos committed
589
    // avoid displaying any contextual links at all, a display plugin can still
590
    // set 'contextual_links_locations' to, e.g., {""}.)
591 592 593

    if (!isset($plugin['contextual_links_locations'])) {
      $plugin['contextual_links_locations'] = array('view');
594
    }
595
    elseif ($plugin['contextual_links_locations'] == array() || $plugin['contextual_links_locations'] == array('')) {
596 597
      $plugin['contextual_links_locations'] = array();
    }
598 599 600 601
    else {
      $plugin += array('contextual_links_locations' => array('view'));
    }

merlinofchaos's avatar
merlinofchaos committed
602
    // On exposed_forms blocks contextual links should always be visible.
603
    $plugin['contextual_links_locations'][] = 'exposed_filter';
604 605
    $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
606 607 608 609 610 611
      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
612 613 614 615
            // (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
616 617 618 619
              $valid = FALSE;
              break;
            }
            else {
620
              $args[] = $view->storage->{$property};
merlinofchaos's avatar
merlinofchaos committed
621 622 623 624 625 626
            }
          }
        }
        // If the link was valid, attach information about it to the renderable
        // array.
        if ($valid) {
627 628 629 630 631 632 633 634 635
          $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
636 637 638 639 640 641 642 643
          );
        }
      }
    }
  }
}

/**
644
 * Prepares a list of language names.
merlinofchaos's avatar
merlinofchaos committed
645
 *
646
 * This is a wrapper around language_list to return a plain key value array.
merlinofchaos's avatar
merlinofchaos committed
647
 *
648 649 650 651 652
 * @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.
653 654
 *   It can be: Language::STATE_CONFIGURABLE, Language::STATE_LOCKED,
 *   Language::STATE_ALL.
655 656 657
 *
 * @return array
 *   An array of language names (or $field) keyed by the langcode.
merlinofchaos's avatar
merlinofchaos committed
658 659 660
 *
 * @see locale_language_list()
 */
661
function views_language_list($field = 'name', $flags = Language::STATE_ALL) {
662
  $languages = language_list($flags);
merlinofchaos's avatar
merlinofchaos committed
663 664
  $list = array();
  foreach ($languages as $language) {
665
    $list[$language->id] = ($field == 'name') ? t($language->name) : $language->$field;
merlinofchaos's avatar
merlinofchaos committed
666 667 668 669 670
  }
  return $list;
}

/**
671
 * Implements hook_ENTITY_TYPE_create() for 'field_instance'.
merlinofchaos's avatar
merlinofchaos committed
672
 */
673
function views_field_instance_create(FieldInstanceInterface $field_instance) {
674 675
  cache('views_info')->deleteAll();
  cache('views_results')->deleteAll();
merlinofchaos's avatar
merlinofchaos committed
676
}
677

merlinofchaos's avatar
merlinofchaos committed
678
/**
679
 * Implements hook_ENTITY_TYPE_update() for 'field_instance'.
merlinofchaos's avatar
merlinofchaos committed
680
 */
681
function views_field_instance_update(FieldInstanceInterface $field_instance) {
682 683
  cache('views_info')->deleteAll();
  cache('views_results')->deleteAll();
merlinofchaos's avatar
merlinofchaos committed
684 685 686
}

/**
687
 * Implements hook_ENTITY_TYPE_delete() for 'field_instance'.
merlinofchaos's avatar
merlinofchaos committed
688
 */
689
function views_field_instance_delete(FieldInstanceInterface $field_instance) {
690 691
  cache('views_info')->deleteAll();
  cache('views_results')->deleteAll();
merlinofchaos's avatar
merlinofchaos committed
692 693 694 695 696 697
}

/**
 * Invalidate the views cache, forcing a rebuild on the next grab of table data.
 */
function views_invalidate_cache() {
698
  // Clear the views cache.
699
  cache('views_info')->deleteAll();
700 701

  // Clear the page and block cache.
702
  Cache::deleteTags(array('content' => TRUE));
703 704

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

707
  $module_handler = \Drupal::moduleHandler();
708

709 710 711
  // Reset the RouteSubscriber from views.
  \Drupal::getContainer()->get('views.route_subscriber')->reset();

712 713 714 715
  // 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')) {
716
    \Drupal::service('router.builder')->rebuild();
717 718
  }

719
  // Invalidate the block cache to update views block derivatives.
720
  if ($module_handler->moduleExists('block')) {
721
    \Drupal::service('plugin.manager.block')->clearCachedDefinitions();
722 723
  }

724
  // Allow modules to respond to the Views cache being cleared.
725
  $module_handler->invokeAll('views_invalidate_cache');
merlinofchaos's avatar
merlinofchaos committed
726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741
}

/**
 * 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;
}

/**
742
 * Find out what, if any, page 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
merlinofchaos's avatar
merlinofchaos committed
748 749 750 751 752 753 754 755 756 757
 *   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
 *
758
 * @return \Drupal\views\ViewExecutable
merlinofchaos's avatar
merlinofchaos committed
759 760 761 762 763 764 765 766 767 768 769
 */
function &views_set_current_view($view = NULL) {
  static $cache = NULL;
  if (isset($view)) {
    $cache = $view;
  }

  return $cache;
}

/**
770
 * Find out what, if any, current view is currently in use.
merlinofchaos's avatar
merlinofchaos committed
771
 *
772 773 774 775
 * 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
776
 *   The current view object.
merlinofchaos's avatar
merlinofchaos committed
777 778 779 780 781
 */
function &views_get_current_view() {
  return views_set_current_view();
}

782 783 784 785
/**
 * Implements hook_hook_info().
 */
function views_hook_info() {
786 787 788 789 790 791 792 793 794
  $hooks = array();

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

795 796 797 798 799 800 801
  // Register a views_plugins alter hook for all plugin types.
  foreach (ViewExecutable::getPluginTypes() as $type) {
    $hooks['views_plugins_' . $type . '_alter'] = array(
      'group' => 'views',
    );
  }

802 803 804 805 806 807 808 809 810 811 812 813
  $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'));
814 815

  return $hooks;
merlinofchaos's avatar
merlinofchaos committed
816 817 818
}

/**
819 820 821
 * Implements hook_library_info().
 */
function views_library_info() {
822 823 824
  $path = drupal_get_path('module', 'views');
  $libraries['views.module'] = array(
    'title' => 'Views base',
825
    'version' => \Drupal::VERSION,
826 827 828 829
    'css' => array(
      "$path/css/views.module.css"
    ),
  );
830 831
  $libraries['views.ajax'] = array(
    'title' => 'Views AJAX',
832
    'version' => \Drupal::VERSION,
833
    'js' => array(
834 835
      "$path/js/base.js" => array('group' => JS_DEFAULT),
      "$path/js/ajax_view.js" => array('group' => JS_DEFAULT),
836 837 838 839 840 841 842 843 844 845
    ),
    'dependencies' => array(
      array('system', 'jquery'),
      array('system', 'drupal'),
      array('system', 'drupalSettings'),
      array('system', 'jquery.once'),
      array('system', 'jquery.form'),
      array('system', 'drupal.ajax'),
    ),
  );
846 847
  $libraries['views.contextual-links'] = array(
    'title' => 'Views Contextual links',
848
    'version' => \Drupal::VERSION,
849
    'js' => array(
850
      // Set to -10 to move it before the contextual links javascript file.
851
      "$path/js/views-contextual.js" => array('group' => JS_LIBRARY, 'weight' => -10),
852 853 854 855 856 857
    ),
    'dependencies' => array(
      array('system', 'jquery'),
      array('system', 'drupal'),
    ),
  );
858 859
  $libraries['views.exposed-form'] = array(
    'title' => 'Views exposed form',
860
    'version' => \Drupal::VERSION,
861 862 863 864
    'css' => array(
      "$path/css/views.exposed_form.css",
    ),
  );
merlinofchaos's avatar
merlinofchaos committed
865

866
  return $libraries;
merlinofchaos's avatar
merlinofchaos committed
867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883
}

/**
 * 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()) {
884
  $definitions = Views::pluginManager($type)->getDefinitions();
885
  $plugins = array();
merlinofchaos's avatar
merlinofchaos committed
886

aspilicious's avatar
aspilicious committed
887
  foreach ($definitions as $id => $plugin) {
888 889
    // 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'])) {
890 891
      continue;
    }
892

893
    if (empty($plugin['no_ui']) && (empty($base) || empty($plugin['base']) || array_intersect($base, $plugin['base']))) {
aspilicious's avatar
aspilicious committed
894
      $plugins[$id] = $plugin['title'];
merlinofchaos's avatar
merlinofchaos committed
895 896 897
    }
  }

898 899 900
  if (!empty($plugins)) {
    asort($plugins);
    return $plugins;
merlinofchaos's avatar
merlinofchaos committed
901
  }
902

903
  return $plugins;
merlinofchaos's avatar
merlinofchaos committed
904 905
}

906
/**
907 908 909
 * Gets all the views plugin definitions.
 *
 * @return array
910
 *   An array of plugin definitions for all types.
911
 */
912 913 914
function views_get_plugin_definitions() {
  $plugins = array();
  foreach (ViewExecutable::getPluginTypes() as $plugin_type) {
915
    $plugins[$plugin_type] = Views::pluginManager($plugin_type)->getDefinitions();
916 917
  }

918
  return $plugins;
919 920
}

921 922 923 924
/**
 * Get enabled display extenders.
 */
function views_get_enabled_display_extenders() {
925
  $enabled = array_filter((array) \Drupal::config('views.settings')->get('display_extenders'));
926

927
  return drupal_map_assoc($enabled);
928 929
}

merlinofchaos's avatar
merlinofchaos committed
930 931 932 933
/**
 * Return a list of all views and display IDs that have a particular
 * setting in their display's plugin settings.
 *
934 935 936 937 938
 * @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
939 940 941 942 943 944 945 946
 * @code
 * array(
 *   array($view, $display_id),
 *   array($view, $display_id),
 * );
 * @endcode
 */
function views_get_applicable_views($type) {
947
  // Get all display plugins which provides the type.
948
  $display_plugins = Views::pluginManager('display')->getDefinitions();
949 950 951 952
  $ids = array();
  foreach ($display_plugins as $id => $definition) {
    if (!empty($definition[$type])) {
      $ids[$id] = $id;
merlinofchaos's avatar
merlinofchaos committed
953
    }
954
  }
merlinofchaos's avatar
merlinofchaos committed
955

956
  $entity_ids = \Drupal::service('entity.query')->get('view')
957
    ->condition('status', TRUE)
958 959
    ->condition("display.*.display_plugin", $ids, 'IN')
    ->execute();
merlinofchaos's avatar
merlinofchaos committed
960

961
  $result = array();
962
  foreach (\Drupal::entityManager()->getStorageController('view')->loadMultiple($entity_ids) as $view) {
963
    // Check each display to see if it meets the criteria and is enabled.
964
    $executable = $view->getExecutable();
965
    $executable->initDisplay();
966 967 968
    foreach ($executable->displayHandlers as $id => $handler) {
      if (!empty($handler->definition[$type]) && $handler->isEnabled()) {
        $result[] = array($executable, $id);
merlinofchaos's avatar
merlinofchaos committed
969 970 971
      }
    }
  }
972

merlinofchaos's avatar
merlinofchaos committed
973 974 975 976
  return $result;
}

/**
977
 * Returns an array of all views as fully loaded $view objects.
merlinofchaos's avatar
merlinofchaos committed
978
 */
979
function views_get_all_views() {
980
  return \Drupal::entityManager()->getStorageController('view')->loadMultiple();
981 982
}

merlinofchaos's avatar
merlinofchaos committed
983 984 985 986
/**
 * Returns an array of all enabled views, as fully loaded $view objects.
 */
function views_get_enabled_views() {
987
  $query = \Drupal::entityQuery('view')
988 989 990 991
    ->condition('status', TRUE)
    ->execute();

  return entity_load_multiple('view', $query);
merlinofchaos's avatar
merlinofchaos committed
992 993 994 995 996 997
}

/**
 * Returns an array of all disabled views, as fully loaded $view objects.
 */
function views_get_disabled_views() {
998
  $query = \Drupal::entityQuery('view')
999 1000 1001 1002
    ->condition('status', FALSE)
    ->execute();

  return entity_load_multiple('view', $query);
merlinofchaos's avatar
merlinofchaos committed
1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016
}

/**
 * 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
1017
 *  - views object (containing $exclude_view->storage->name and $exclude_view->current_display)
merlinofchaos's avatar
merlinofchaos committed
1018 1019 1020 1021 1022
 *  - 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
1023 1024
 * @param bool $sort
 *  If TRUE, the list of views is sorted ascending.
merlinofchaos's avatar
merlinofchaos committed
1025 1026 1027 1028 1029
 *
 * @return array
 *  an associative array for use in select.
 *  - key: view name and display id separated by ':', or the view name only
 */
1030
function views_get_views_as_options($views_only = FALSE, $filter = 'all', $exclude_view = NULL, $optgroup = FALSE, $sort = FALSE) {
merlinofchaos's avatar
merlinofchaos committed
1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049

  // 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)) {
1050
    $exclude_view_name = $exclude_view->storage->id();
merlinofchaos's avatar
merlinofchaos committed
1051 1052 1053
    $exclude_view_display = $exclude_view->current_display;
  }
  else {
1054 1055 1056
    // 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
1057 1058 1059 1060
  }

  $options = array();
  foreach ($views as $view) {
1061
    $id = $view->id();
merlinofchaos's avatar
merlinofchaos committed
1062
    // Return only views.
1063
    if ($views_only && $id != $exclude_view_name) {
1064
      $options[$id] = $view->label();
merlinofchaos's avatar
merlinofchaos committed
1065 1066 1067
    }
    // Return views with display ids.
    else {
1068
      foreach ($view->get('display') as $display_id => $display) {
1069
        if (!($id == $exclude_view_name && $display_id == $exclude_view_display)) {
merlinofchaos's avatar
merlinofchaos committed
1070
          if ($optgroup) {
1071
            $options[$id][$id . ':' . $display['id']] = t('@view : @display', array('@view' => $id, '@display' => $display['id']));
merlinofchaos's avatar
merlinofchaos committed
1072 1073
          }
          else {
1074
            $options[$id . ':' . $display['id']] = t('View: @view - Display: @display', array('@view' => $id, '@display' => $display['id']));
merlinofchaos's avatar
merlinofchaos committed
1075 1076 1077 1078 1079
          }
        }
      }
    }
  }
1080 1081 1082
  if ($sort) {
    ksort($options);
  }
merlinofchaos's avatar
merlinofchaos committed
1083 1084 1085 1086
  return $options;
}

/**
dawehner's avatar
dawehner committed
1087 1088
 * Returns whether the view is enabled.
 *
1089
 * @param \Drupal\views\Entity\View $view
xjm's avatar
xjm committed
1090
 *   The view object to check.
dawehner's avatar
dawehner committed
1091 1092 1093
 *
 * @return bool
 *   Returns TRUE if a view is enabled, FALSE otherwise.
merlinofchaos's avatar
merlinofchaos committed
1094
 */
1095
function views_view_is_enabled(View $view) {
1096
  return $view->status();
merlinofchaos's avatar
merlinofchaos committed
1097 1098 1099
}

/**
dawehner's avatar
dawehner committed
1100 1101
 * Returns whether the view is disabled.
 *
1102
 * @param \Drupal\views\Entity\View $view
xjm's avatar
xjm committed
1103
 *   The view object to check.
dawehner's avatar
dawehner committed
1104 1105 1106
 *
 * @return bool
 *   Returns TRUE if a view is disabled, FALSE otherwise.
merlinofchaos's avatar
merlinofchaos committed
1107
 */
1108
function views_view_is_disabled(View $view) {
1109
  return !$view->status();
merlinofchaos's avatar
merlinofchaos committed
1110 1111
}

1112
/**
1113
 * Enables and saves a view.
1114
 *
1115
 * @param \Drupal\views\Entity\View $view
1116
 *   The View object to disable.
1117
 */
1118
function views_enable_view(View $view) {
1119
  $view->enable()->save();
1120 1121 1122
}

/**
1123
 * Disables and saves a view.
1124
 *
1125
 * @param \Drupal\views\Entity\View $view
1126
 *   The View object to disable.
1127
 */
1128
function views_disable_view(View $view) {
1129
  $view->disable()->save();
1130 1131
}

merlinofchaos's avatar
merlinofchaos committed
1132
/**
xjm's avatar
xjm committed
1133
 * Loads a view from configuration.
merlinofchaos's avatar
merlinofchaos committed
1134
 *
xjm's avatar
xjm committed
1135
 * @param string $name
merlinofchaos's avatar
merlinofchaos committed
1136
 *   The name of the view.
xjm's avatar
xjm committed
1137
 *
1138
 * @return \Drupal\views\ViewExecutable
dawehner's avatar
dawehner committed
1139
 *   A reference to the $view object.
1140 1141 1142
 *
 * @deprecated as of Drupal 8.0. Use \Drupal\views\Views::getView().
 *
merlinofchaos's avatar
merlinofchaos committed
1143
 */
1144
function views_get_view($name) {
1145
  return Views::getView($name);
merlinofchaos's avatar
merlinofchaos committed
1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173
}

/**
 * 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.
 */
1174
function views_form($form, &$form_state, ViewExecutable $view, $output) {
merlinofchaos's avatar
merlinofchaos committed
1175 1176 1177 1178 1179 1180 1181 1182
  $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();
1183
  $query = drupal_get_query_parameters();
1184
  $form['#action'] = url($view->getUrl(), array('query' => $query));
merlinofchaos's avatar
merlinofchaos committed
1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198
  // 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().
 */
1199
function views_form_views_form($form, &$form_state, ViewExecutable $view, $output) {
merlinofchaos's avatar
merlinofchaos committed
1200 1201
  $form['#prefix'] = '<div class="views-form">';
  $form['#suffix'] = '</div>';
1202 1203
  $form['#theme'] = 'form';
  $form['#pre_render'][] = 'views_pre_render_views_form_views_form';
merlinofchaos's avatar
merlinofchaos committed