views.module 71.4 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\Database\Query\AlterableInterface;
13
use Drupal\views\ViewExecutable;
14
use Drupal\Component\Plugin\Exception\PluginException;
15
use Drupal\views\ViewStorage;
16

17
18
19
20
21
/**
 * Views API version string.
 */
const VIEWS_API_VERSION = '3.0';

22
/**
23
 * Implements hook_entity_info().
24
 */
25
26
function views_entity_info() {
  $return = array(
27
    'view' => array(
28
      'label' => t('View'),
29
      'entity class' => 'Drupal\views\ViewStorage',
30
      'controller class' => 'Drupal\views\ViewStorageController',
31
      'list controller class' => 'Drupal\views_ui\ViewListController',
32
      'list path' => 'admin/structure/views',
33
34
35
36
37
38
39
40
41
      'form controller class' => array(
        'default' => 'Drupal\node\NodeFormController',
      ),
      'config prefix' => 'views.view',
      'fieldable' => FALSE,
      'entity keys' => array(
        'id' => 'name',
        'label' => 'human_name',
        'uuid' => 'uuid',
42
43
44
      ),
    ),
  );
45
46

  return $return;
47
48
}

merlinofchaos's avatar
merlinofchaos committed
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
/**
 * 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',
73
    $view->storage->get('name'),
merlinofchaos's avatar
merlinofchaos committed
74
75
76
77
78
79
    $view->current_display,
  );

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

80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
/**
 * 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'])) {
    $element['view']['#markup'] = $view->preview($element['#display_id'], $element['#arguments']);
  }

  return $element;
}

merlinofchaos's avatar
merlinofchaos committed
108
109
110
111
112
/**
 * Implement hook_theme(). Register views theming functions.
 */
function views_theme($existing, $type, $theme, $path) {
  $path = drupal_get_path('module', 'views');
113
  module_load_include('inc', 'views', 'theme/theme');
merlinofchaos's avatar
merlinofchaos committed
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150

  // Some quasi clever array merging here.
  $base = array(
    'file' => 'theme.inc',
    'path' => $path . '/theme',
  );

  // 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(
    'pattern' => 'views_view_grouping__',
    'variables' => array('view' => NULL, 'grouping' => NULL, 'grouping_level' => NULL, 'rows' => NULL, 'title' => NULL),
  );

151
  $plugins = views_get_plugin_definitions();
merlinofchaos's avatar
merlinofchaos committed
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227

  // Register theme functions for all style plugins
  foreach ($plugins as $type => $info) {
    foreach ($info as $plugin => $def) {
      if (isset($def['theme']) && (!isset($def['register theme']) || !empty($def['register theme']))) {
        $hooks[$def['theme']] = array(
          'pattern' => $def['theme'] . '__',
          'file' => $def['theme file'],
          'path' => $def['theme path'],
          'variables' => $variables[$type],
        );

        $include = DRUPAL_ROOT . '/' . $def['theme path'] . '/' . $def['theme file'];
        if (file_exists($include)) {
          require_once $include;
        }

        if (!function_exists('theme_' . $def['theme'])) {
          $hooks[$def['theme']]['template'] = drupal_clean_css_identifier($def['theme']);
        }
      }
      if (isset($def['additional themes'])) {
        foreach ($def['additional themes'] as $theme => $theme_type) {
          if (empty($theme_type)) {
            $theme = $theme_type;
            $theme_type = $type;
          }

          $hooks[$theme] = array(
            'pattern' => $theme . '__',
            'file' => $def['theme file'],
            'path' => $def['theme path'],
            'variables' => $variables[$theme_type],
          );

          if (!function_exists('theme_' . $theme)) {
            $hooks[$theme]['template'] = drupal_clean_css_identifier($theme);
          }
        }
      }
    }
  }

  $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(
    'template' => 'views-more',
    'pattern' => 'views_more__',
    'variables' => array('more_url' => NULL, 'link_text' => 'more', 'view' => NULL),
  );

  return $hooks;
}

/**
 * Scans a directory of a module for template files.
 *
 * @param $cache
 *   The existing cache of theme hooks to test against.
 * @param $path
 *   The path to search.
 *
 * @see drupal_find_theme_templates()
 */
function _views_find_module_templates($cache, $path) {
  $templates = array();
  $regex = '/' . '\.tpl\.php' . '$' . '/';

228
  // @todo Remove this once #1626580 is committed. For now, We need to remove
dawehner's avatar
dawehner committed
229
  //   the sites/* part of the path because drupal_system_listing() is already
230
231
  //   adding that.
  $path = preg_replace('/^sites\/all\//', '', $path);
dawehner's avatar
dawehner committed
232
233
  $config = str_replace('/', '\/', conf_path());
  $path = preg_replace('/^' . $config . '\//', '', $path);
234

merlinofchaos's avatar
merlinofchaos committed
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
  // Because drupal_system_listing works the way it does, we check for real
  // templates separately from checking for patterns.
  $files = drupal_system_listing($regex, $path, 'name', 0);
  foreach ($files as $template => $file) {
    // Chop off the remaining extensions if there are any. $template already
    // has the rightmost extension removed, but there might still be more,
    // such as with .tpl.php, which still has .tpl in $template at this point.
    if (($pos = strpos($template, '.')) !== FALSE) {
      $template = substr($template, 0, $pos);
    }
    // Transform - in filenames to _ to match function naming scheme
    // for the purposes of searching.
    $hook = strtr($template, '-', '_');
    if (isset($cache[$hook])) {
      $templates[$hook] = array(
        'template' => $template,
        'path' => dirname($file->filename),
        'includes' => isset($cache[$hook]['includes']) ? $cache[$hook]['includes'] : NULL,
      );
    }
    // Ensure that the pattern is maintained from base themes to its sub-themes.
    // Each sub-theme will have their templates scanned so the pattern must be
    // held for subsequent runs.
    if (isset($cache[$hook]['pattern'])) {
      $templates[$hook]['pattern'] = $cache[$hook]['pattern'];
    }
  }

  $patterns = array_keys($files);

  foreach ($cache as $hook => $info) {
    if (!empty($info['pattern'])) {
      // Transform _ in pattern to - to match file naming scheme
      // for the purposes of searching.
      $pattern = strtr($info['pattern'], '_', '-');

      $matches = preg_grep('/^'. $pattern .'/', $patterns);
      if ($matches) {
        foreach ($matches as $match) {
          $file = substr($match, 0, strpos($match, '.'));
          // Put the underscores back in for the hook name and register this pattern.
          $templates[strtr($file, '-', '_')] = array(
            'template' => $file,
            'path' => dirname($files[$match]->uri),
            'variables' => isset($info['variables']) ? $info['variables'] : NULL,
            'render element' => isset($info['render element']) ? $info['render element'] : NULL,
            'base hook' => $hook,
            'includes' => isset($info['includes']) ? $info['includes'] : NULL,
          );
        }
      }
    }
  }

  return $templates;
}

292
293
294
295
296
297
298
299
300
301
302
303
304
/**
 * 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() {
305
  $plugin_data = views_get_plugin_definitions();
306
307
308
309
  $plugins = array();
  foreach (views_get_enabled_views() as $view) {
    foreach ($view->display as $display_id => $display) {
      foreach ($plugin_data as $type => $info) {
310
311
        if ($type == 'display' && isset($display['display_plugin'])) {
          $name = $display['display_plugin'];
312
        }
313
314
        elseif (isset($display['display_options']["{$type}_plugin"])) {
          $name = $display['display_options']["{$type}_plugin"];
315
        }
316
317
        elseif (isset($display['display_options'][$type]['type'])) {
          $name = $display['display_options'][$type]['type'];
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
        }
        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.
336
        $plugins[$key]['views'][$view->storage->get('name')] = $view->storage->get('name');
337
338
339
340
341
342
      }
    }
  }
  return $plugins;
}

merlinofchaos's avatar
merlinofchaos committed
343
344
345
346
347
348
349
350
351
352
/**
 * 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.
 */
function views_preprocess_node(&$vars) {
  // The 'view' attribute of the node is added in views_preprocess_node()
353
  if (!empty($vars['node']->view) && $vars['node']->view->storage->get('name')) {
merlinofchaos's avatar
merlinofchaos committed
354
    $vars['view'] = $vars['node']->view;
355
    $vars['theme_hook_suggestions'][] = 'node__view__' . $vars['node']->view->storage->get('name');
merlinofchaos's avatar
merlinofchaos committed
356
    if (!empty($vars['node']->view->current_display)) {
357
      $vars['theme_hook_suggestions'][] = 'node__view__' . $vars['node']->view->storage->get('name') . '__' . $vars['node']->view->current_display;
merlinofchaos's avatar
merlinofchaos committed
358
359
360

      // 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:
361
      if ($vars['page'] && $vars['view_mode'] == 'full' && !$vars['view']->display_handler->hasPath()) {
merlinofchaos's avatar
merlinofchaos committed
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
        $vars['page'] = FALSE;
      }
    }
  }

  // Allow to alter comments and links based on the settings in the row plugin.
  if (!empty($vars['view']->style_plugin->row_plugin) && get_class($vars['view']->style_plugin->row_plugin) == 'views_plugin_row_node_view') {
    node_row_node_view_preprocess_node($vars);
  }
}

/**
 * A theme preprocess function to automatically allow view-based node
 * templates if called from a view.
 */
function views_preprocess_comment(&$vars) {
  // The 'view' attribute of the node is added in template_preprocess_views_view_row_comment()
379
  if (!empty($vars['comment']->view) && $vars['comment']->view->storage->get('name')) {
380
    $vars['view'] = &$vars['comment']->view;
381
    $vars['theme_hook_suggestions'][] = 'comment__view__' . $vars['comment']->view->storage->get('name');
merlinofchaos's avatar
merlinofchaos committed
382
    if (!empty($vars['node']->view->current_display)) {
383
      $vars['theme_hook_suggestions'][] = 'comment__view__' . $vars['comment']->view->storage->get('name') . '__' . $vars['comment']->view->current_display;
merlinofchaos's avatar
merlinofchaos committed
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
    }
  }
}

/**
 * Implement hook_permission().
 */
function views_permission() {
  return array(
    'administer views' => array(
      'title' => t('Administer views'),
      'description' => t('Access the views administration pages.'),
    ),
    'access all views' => array(
      'title' => t('Bypass views access control'),
      'description' => t('Bypass access control when accessing views.'),
    ),
  );
}

/**
 * Implement hook_menu().
 */
function views_menu() {
408
  // Any event which causes a menu rebuild could potentially mean that the
merlinofchaos's avatar
merlinofchaos committed
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
436
437
438
439
440
441
442
443
444
445
446
447
448
449
  // Views data is updated -- module changes, profile changes, etc.
  views_invalidate_cache();
  $items = array();
  $items['views/ajax'] = array(
    'title' => 'Views',
    'page callback' => 'views_ajax',
    'theme callback' => 'ajax_base_page_theme',
    'delivery callback' => 'ajax_deliver',
    'access callback' => TRUE,
    'description' => 'Ajax callback for view loading.',
    'type' => MENU_CALLBACK,
    'file' => 'includes/ajax.inc',
  );
  // Path is not admin/structure/views due to menu complications with the wildcards from
  // the generic ajax callback.
  $items['admin/views/ajax/autocomplete/user'] = array(
    'page callback' => 'views_ajax_autocomplete_user',
    'theme callback' => 'ajax_base_page_theme',
    'access callback' => 'user_access',
    'access arguments' => array('access content'),
    'type' => MENU_CALLBACK,
    'file' => 'includes/ajax.inc',
  );
  // Define another taxonomy autocomplete because the default one of drupal
  // does not support a vid a argument anymore
  $items['admin/views/ajax/autocomplete/taxonomy'] = array(
    'page callback' => 'views_ajax_autocomplete_taxonomy',
    '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();
450
  $views = views_get_applicable_views('uses_hook_menu');
merlinofchaos's avatar
merlinofchaos committed
451
452
  foreach ($views as $data) {
    list($view, $display_id) = $data;
453
    $result = $view->executeHookMenu($display_id, $callbacks);
merlinofchaos's avatar
merlinofchaos committed
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
    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;
        }
        else {
          // This item already exists, so it must be one that we added.
          // We change the various callback arguments to pass an array
          // of possible display IDs instead of a single ID.
          $callbacks[$path]['page arguments'][1] = (array)$callbacks[$path]['page arguments'][1];
          $callbacks[$path]['page arguments'][1][] = $display_id;
          $callbacks[$path]['access arguments'][] = $item['access arguments'][0];
          $callbacks[$path]['load arguments'][1] = (array)$callbacks[$path]['load arguments'][1];
          $callbacks[$path]['load arguments'][1][] = $display_id;
        }
        $our_paths[$path] = TRUE;
      }
    }
  }

  // Save memory: Destroy those views.
  foreach ($views as $data) {
    list($view, $display_id) = $data;
    $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)) {
531
532
    $view->setDisplay($display_id);
    $view->initHandlers();
merlinofchaos's avatar
merlinofchaos committed
533
534
535
536

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

    $indexes = array();
537
    $path = explode('/', $view->getPath());
merlinofchaos's avatar
merlinofchaos committed
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
567
568
569
570
571
572
573
574
575
576
577

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

    if (isset($indexes[$index])) {
      if (isset($view->argument[$indexes[$index]])) {
        $arg = $view->argument[$indexes[$index]]->validate_argument($value) ? $value : FALSE;
        $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)) {
578
    return $view->executeDisplay($display_id, $args);
merlinofchaos's avatar
merlinofchaos committed
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
  }

  // Fallback; if we get here no view was found or handler was not valid.
  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.
  $view = views_get_page_view();
  if (!empty($view)) {
    // If a module is still putting in the display like we used to, catch that.
    if (is_subclass_of($view, 'views_plugin_display')) {
      $view = $view->view;
    }

    views_add_contextual_links($page, 'page', $view, $view->current_display);
  }
}

/**
 * Implements MODULE_preprocess_HOOK().
 */
function views_preprocess_html(&$variables) {
  // 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
617
  // the "contextual-region" class from the <body> tag here and add
merlinofchaos's avatar
merlinofchaos committed
618
619
  // JavaScript that will insert it back in the correct place.
  if (!empty($variables['page']['#views_contextual_links_info'])) {
620
    $key = array_search('contextual-region', $variables['attributes']['class']->value());
merlinofchaos's avatar
merlinofchaos committed
621
    if ($key !== FALSE) {
622
      unset($variables['attributes']['class'][$key]);
merlinofchaos's avatar
merlinofchaos committed
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
      // Add the JavaScript, with a group and weight such that it will run
      // before modules/contextual/contextual.js.
      drupal_add_js(drupal_get_path('module', 'views') . '/js/views-contextual.js', array('group' => JS_LIBRARY, 'weight' => -1));
    }
  }
}

/**
 * Implements hook_contextual_links_view_alter().
 */
function views_contextual_links_view_alter(&$element, $items) {
  // If we are rendering views-related contextual links attached to the overall
  // page array, add a class to the list of contextual links. This will be used
  // by the JavaScript added in views_preprocess_html().
  if (!empty($element['#element']['#views_contextual_links_info']) && !empty($element['#element']['#type']) && $element['#element']['#type'] == 'page') {
    $element['#attributes']['class'][] = 'views-contextual-links-page';
  }
}

/**
 * Implement hook_block_info().
 */
function views_block_info() {
  // Try to avoid instantiating all the views just to get the blocks info.
  views_include('cache');
  $cache = views_cache_get('views_block_items', TRUE);
  if ($cache && is_array($cache->data)) {
    return $cache->data;
  }

  $items = array();
  $views = views_get_all_views();
  foreach ($views as $view) {
    // disabled views get nothing.
657
    if (!$view->isEnabled()) {
merlinofchaos's avatar
merlinofchaos committed
658
659
660
      continue;
    }

661
    $view->initDisplay();
662
    foreach ($view->getExecutable()->displayHandlers as $display) {
merlinofchaos's avatar
merlinofchaos committed
663

664
665
      if (isset($display) && !empty($display->definition['uses_hook_block'])) {
        $result = $display->executeHookBlockList();
merlinofchaos's avatar
merlinofchaos committed
666
667
668
669
670
        if (is_array($result)) {
          $items = array_merge($items, $result);
        }
      }

671
672
      if (isset($display) && $display->getOption('exposed_block')) {
        $result = $display->getSpecialBlocks();
merlinofchaos's avatar
merlinofchaos committed
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
        if (is_array($result)) {
          $items = array_merge($items, $result);
        }
      }
    }
  }

  // block.module has a delta length limit of 32, but our deltas can
  // unfortunately be longer because view names can be 32 and display IDs
  // can also be 32. So for very long deltas, change to md5 hashes.
  $hashes = array();

  // get the keys because we're modifying the array and we don't want to
  // confuse PHP too much.
  $keys = array_keys($items);
  foreach ($keys as $delta) {
    if (strlen($delta) >= 32) {
      $hash = md5($delta);
      $hashes[$hash] = $delta;
      $items[$hash] = $items[$delta];
      unset($items[$delta]);
    }
  }

  // Only save hashes if they have changed.
  $old_hashes = variable_get('views_block_hashes', array());
  if ($hashes != $old_hashes) {
    variable_set('views_block_hashes', $hashes);
  }

  views_cache_set('views_block_items', $items, TRUE);

  return $items;
}

/**
 * Implement hook_block_view().
 */
function views_block_view($delta) {
  $start = microtime(TRUE);
  // if this is 32, this should be an md5 hash.
  if (strlen($delta) == 32) {
    $hashes = variable_get('views_block_hashes', array());
    if (!empty($hashes[$delta])) {
      $delta = $hashes[$delta];
    }
  }

  // This indicates it's a special one.
  if (substr($delta, 0, 1) == '-') {
    list($nothing, $type, $name, $display_id) = explode('-', $delta);
    // Put the - back on.
    $type = '-' . $type;
    if ($view = views_get_view($name)) {
      if ($view->access($display_id)) {
728
        $view->setDisplay($display_id);
merlinofchaos's avatar
merlinofchaos committed
729
        if (isset($view->display_handler)) {
730
          $output = $view->display_handler->viewSpecialBlocks($type);
merlinofchaos's avatar
merlinofchaos committed
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
          // Before returning the block output, convert it to a renderable
          // array with contextual links.
          views_add_block_contextual_links($output, $view, $display_id, 'special_block_' . $type);
          $view->destroy();
          return $output;
        }
      }
      $view->destroy();
    }
  }

  // If the delta doesn't contain valid data return nothing.
  $explode = explode('-', $delta);
  if (count($explode) != 2) {
    return;
  }
  list($name, $display_id) = $explode;
  // Load the view
  if ($view = views_get_view($name)) {
    if ($view->access($display_id)) {
751
      $output = $view->executeDisplay($display_id);
merlinofchaos's avatar
merlinofchaos committed
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
      // Before returning the block output, convert it to a renderable array
      // with contextual links.
      views_add_block_contextual_links($output, $view, $display_id);
      $view->destroy();
      return $output;
    }
    $view->destroy();
  }
}

/**
 * Converts Views block content to a renderable array with contextual links.
 *
 * @param $block
 *   An array representing the block, with the same structure as the return
 *   value of hook_block_view(). This will be modified so as to force
 *   $block['content'] to be a renderable array, containing the optional
 *   '#contextual_links' property (if there are any contextual links associated
 *   with the block).
 * @param $view
 *   The view that was used to generate the block content.
 * @param $display_id
 *   The ID of the display within the view that was used to generate the block
 *   content.
 * @param $block_type
 *   The type of the block. If it's block it's a regular views display,
 *   but 'special_block_-exp' exist as well.
 */
780
function views_add_block_contextual_links(&$block, ViewExecutable $view, $display_id, $block_type = 'block') {
merlinofchaos's avatar
merlinofchaos committed
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
  // Do not add contextual links to an empty block.
  if (!empty($block['content'])) {
    // Contextual links only work on blocks whose content is a renderable
    // array, so if the block contains a string of already-rendered markup,
    // convert it to an array.
    if (is_string($block['content'])) {
      $block['content'] = array('#markup' => $block['content']);
    }
    // Add the contextual links.
    views_add_contextual_links($block['content'], $block_type, $view, $display_id);
  }
}

/**
 * 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
805
806
807
 * '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
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
 *
 * 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
843
844
845
 *   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
846
847
848
849
850
851
852
853
854
 * @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.
 *
 * @see views_block_view()
 * @see views_page_alter()
 * @see template_preprocess_views_view()
 */
855
function views_add_contextual_links(&$render_element, $location, ViewExecutable $view, $display_id) {
merlinofchaos's avatar
merlinofchaos committed
856
857
858
859
860
861
  // Do not do anything if the view is configured to hide its administrative
  // links.
  if (empty($view->hide_admin_links)) {
    // 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.
862
    $plugin = views_get_plugin_definition('display', $view->displayHandlers[$display_id]->display['display_plugin']);
863
    // If contextual_links_locations are not set, provide a sane default. (To
merlinofchaos's avatar
merlinofchaos committed
864
    // avoid displaying any contextual links at all, a display plugin can still
865
    // set 'contextual_links_locations' to, e.g., {""}.)
866
867
868

    if (!isset($plugin['contextual_links_locations'])) {
      $plugin['contextual_links_locations'] = array('view');
869
    }
870
    elseif ($plugin['contextual_links_locations'] == array() || $plugin['contextual_links_locations'] == array('')) {
871
872
      $plugin['contextual_links_locations'] = array();
    }
873
874
875
876
    else {
      $plugin += array('contextual_links_locations' => array('view'));
    }

merlinofchaos's avatar
merlinofchaos committed
877
    // On exposed_forms blocks contextual links should always be visible.
878
879
880
    $plugin['contextual_links_locations'][] = 'special_block_-exp';
    $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
881
882
883
884
885
886
      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
887
888
889
890
            // (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
891
892
893
894
              $valid = FALSE;
              break;
            }
            else {
895
              $args[] = $view->storage->{$property};
merlinofchaos's avatar
merlinofchaos committed
896
897
898
899
900
901
902
903
904
905
            }
          }
        }
        // If the link was valid, attach information about it to the renderable
        // array.
        if ($valid) {
          $render_element['#contextual_links'][$module] = array($link['parent path'], $args);
          $render_element['#views_contextual_links_info'][$module] = array(
            'location' => $location,
            'view' => $view,
906
            'view_name' => $view->storage->get('name'),
merlinofchaos's avatar
merlinofchaos committed
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
            'view_display_id' => $display_id,
          );
        }
      }
    }
  }
}

/**
 * Returns an array of language names.
 *
 * This is a one to one copy of locale_language_list because we can't rely on enabled locale module.
 *
 * @param $field
 *   'name' => names in current language, localized
 *   'native' => native names
 * @param $all
 *   Boolean to return all languages or only enabled ones
 *
 * @see locale_language_list()
927
 * @todo Figure out whether we need this with language module.
merlinofchaos's avatar
merlinofchaos committed
928
929
930
931
932
933
 */
function views_language_list($field = 'name', $all = FALSE) {
  if ($all) {
    $languages = language_list();
  }
  else {
934
    $languages = language_list();
merlinofchaos's avatar
merlinofchaos committed
935
936
937
  }
  $list = array();
  foreach ($languages as $language) {
938
    $list[$language->langcode] = ($field == 'name') ? t($language->name) : $language->$field;
merlinofchaos's avatar
merlinofchaos committed
939
940
941
942
943
  }
  return $list;
}

/**
944
 * Implements hook_cache_flush().
merlinofchaos's avatar
merlinofchaos committed
945
 */
946
function views_cache_flush() {
947
  return array('views_info', 'views_results');
merlinofchaos's avatar
merlinofchaos committed
948
949
950
951
952
953
}

/**
 * Implements hook_field_create_instance.
 */
function views_field_create_instance($instance) {
954
955
  cache('views_info')->flush();
  cache('views_results')->flush();
merlinofchaos's avatar
merlinofchaos committed
956
957
958
959
960
961
}

/**
 * Implements hook_field_update_instance.
 */
function views_field_update_instance($instance, $prior_instance) {
962
963
  cache('views_info')->flush();
  cache('views_results')->flush();
merlinofchaos's avatar
merlinofchaos committed
964
965
966
967
968
969
}

/**
 * Implements hook_field_delete_instance.
 */
function views_field_delete_instance($instance) {
970
971
  cache('views_info')->flush();
  cache('views_results')->flush();
merlinofchaos's avatar
merlinofchaos committed
972
973
974
975
976
977
}

/**
 * Invalidate the views cache, forcing a rebuild on the next grab of table data.
 */
function views_invalidate_cache() {
978
  // Clear the views cache.
979
  cache('views_info')->flush();
980
981
982
983
984

  // Clear the page and block cache.
  cache_invalidate(array('content' => TRUE));

  // Set the menu as needed to be rebuilt.
985
  state()->set('menu_rebuild_needed', TRUE);
986
987
988

  // Allow modules to respond to the Views cache being cleared.
  module_invoke_all('views_invalidate_cache');
merlinofchaos's avatar
merlinofchaos committed
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
}

/**
 * Access callback to determine if the user can import Views.
 *
 * View imports require an additional access check because they are PHP
 * code and PHP is more locked down than administer views.
 */
function views_import_access() {
  return user_access('administer views') && user_access('use PHP for settings');
}

/**
 * Determine if the logged in user has access to a view.
 *
 * This function should only be called from a menu hook or some other
 * embedded source. Each argument is the result of a call to
 * views_plugin_access::get_access_callback() which is then used
 * to determine if that display is accessible. If *any* argument
 * is accessible, then the view is accessible.
 */
function views_access() {
  $args = func_get_args();
  foreach ($args as $arg) {
    if ($arg === TRUE) {
      return TRUE;
    }

    if (!is_array($arg)) {
      continue;
    }

    list($callback, $arguments) = $arg;
    $arguments = $arguments ? $arguments : array();
    // Bring dynamic arguments to the access callback.
    foreach ($arguments as $key => $value) {
      if (is_int($value) && isset($args[$value])) {
        $arguments[$key] = $args[$value];
      }
    }
    if (function_exists($callback) && call_user_func_array($callback, $arguments)) {
      return TRUE;
    }
  }

  return FALSE;
}

/**
 * Access callback for the views_plugin_access_perm access plugin.
 *
 * Determine if the specified user has access to a view on the basis of
 * permissions. If the $account argument is omitted, the current user
 * is used.
 */
function views_check_perm($perm, $account = NULL) {
  return user_access($perm, $account) || user_access('access all views', $account);
}

/**
 * Access callback for the views_plugin_access_role access plugin.

 * Determine if the specified user has access to a view on the basis of any of
 * the requested roles. If the $account argument is omitted, the current user
 * is used.
 */
function views_check_roles($rids, $account = NULL) {
  global $user;
  $account = isset($account) ? $account : $user;
  $roles = array_keys($account->roles);
  $roles[] = $account->uid ? DRUPAL_AUTHENTICATED_RID : DRUPAL_ANONYMOUS_RID;
  return user_access('access all views', $account) || array_intersect(array_filter($rids), $roles);
}

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

/**
 * Find out what, if any, page view is currently in use. Please note that
 * this returns a reference, so be careful! You can unintentionally modify the
 * $view object.
 *
1081
 * @return Drupal\views\ViewExecutable
merlinofchaos's avatar
merlinofchaos committed
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
 *   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
 *
1092
 * @return Drupal\views\ViewExecutable
merlinofchaos's avatar
merlinofchaos committed
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
 */
function &views_set_current_view($view = NULL) {
  static $cache = NULL;
  if (isset($view)) {
    $cache = $view;
  }

  return $cache;
}

/**
 * Find out what, if any, current view is currently in use. Please note that
 * this returns a reference, so be careful! You can unintentionally modify the
 * $view object.
 *
1108
 * @return Drupal\views\ViewExecutable
merlinofchaos's avatar
merlinofchaos committed
1109
1110
1111
1112
1113
1114
1115
1116
1117
 */
function &views_get_current_view() {
  return views_set_current_view();
}

/**
 * Include views .inc files as necessary.
 */
function views_include($file) {
1118
  module_load_include('inc', 'views', 'includes/' . $file);
merlinofchaos's avatar
merlinofchaos committed
1119
1120
}

1121
1122
1123
1124
1125
1126
1127
1128
1129
/**
 * Implements hook_hook_info().
 */
function views_hook_info() {
  $hooks['views_data'] = array(
    'group' => 'views',
  );

  return $hooks;
merlinofchaos's avatar
merlinofchaos committed
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
}

/**
 * Include views .css files.
 */
function views_add_css($file) {
  // We set preprocess to FALSE because we are adding the files conditionally,
  // and we don't want to generate duplicate cache files.
  // TODO: at some point investigate adding some files unconditionally and
  // allowing preprocess.
  drupal_add_css(drupal_get_path('module', 'views') . "/css/$file.css", array('preprocess' => FALSE));
}

/**
 * Include views .js files.
 */
function views_add_js($file) {
  // If javascript has been disabled by the user, never add js files.
1148
  if (config('views.settings')->get('no_javascript')) {
merlinofchaos's avatar
merlinofchaos committed
1149
1150
    return;
  }
1151
  $path = drupal_get_path('module', 'views');
merlinofchaos's avatar
merlinofchaos committed
1152
1153
  static $base = TRUE, $ajax = TRUE;
  if ($base) {
1154
    drupal_add_js($path . "/js/base.js");
merlinofchaos's avatar
merlinofchaos committed
1155
1156
1157
1158
1159
1160
1161
    $base = FALSE;
  }
  if ($ajax && in_array($file, array('ajax', 'ajax_view'))) {
    drupal_add_library('system', 'drupal.ajax');
    drupal_add_library('system', 'jquery.form');
    $ajax = FALSE;
  }
1162
  drupal_add_js($path . "/js/$file.js");
merlinofchaos's avatar
merlinofchaos committed
1163
1164
1165
1166
1167
1168
1169
1170
1171
}

/**
 * Fetch a handler from the data cache.
 *
 * @param $table
 *   The name of the table this handler is from.
 * @param $field
 *   The name of the field this handler is from.
1172
 * @param $type
merlinofchaos's avatar
merlinofchaos committed
1173
1174
1175
1176
1177
1178
1179
1180
1181
 *   The type of handler. i.e, sort, field, argument, filter, relationship
 * @param $override
 *   Override the actual handler object with this class. Used for
 *   aggregation when the handler is redirected to the aggregation
 *   handler.
 *
 * @return views_handler
 *   An instance of a handler object. May be views_handler_broken.
 */
1182
function views_get_handler($table, $field, $type, $override = NULL) {
1183
1184
  // Get the plugin manager for this type.
  $manager = drupal_container()->get("plugin.manager.views.$type");
merlinofchaos's avatar
merlinofchaos committed
1185

1186
  $data = views_fetch_data($table);
1187
  if (isset($data[$field][$type])) {
1188
    $definition = $data[$field][$type];
1189
    foreach (array('group', 'title', 'title short', 'help', 'real field', 'real table') as $key) {
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
      if (!isset($definition[$key])) {
        // First check the field level
        if (!empty($data[$field][$key])) {
          $definition[$key] = $data[$field][$key];
        }
        // Then if that doesn't work, check the table level
        elseif (!empty($data['table'][$key])) {
          $definition[$key] = $data['table'][$key];
        }
      }
    }

    // @todo This is crazy. Find a way to remove the override functionality.
1203
    $plugin_id = $override ?: $definition['id'];
1204
    // Try to use the overridden handler.
1205
    try {
1206
      return $manager->createInstance($plugin_id, $definition);
1207
1208
    }
    catch (PluginException $e) {
1209
1210
1211
1212
1213
1214
1215
      // If that fails, use the original handler.
      try {
        return $manager->createInstance($definition['id'], $definition);
      }
      catch (PluginException $e) {
        // Deliberately empty, this case is handled generically below.
      }
1216
    }
merlinofchaos's avatar
merlinofchaos committed
1217
1218
  }

1219
1220
  // Finally, use the 'broken' handler.
  debug(t("Missing handler: @table @field @type", array('@table' => $table, '@field' => $field, '@type' => $type)));
1221
  return $manager->createInstance('broken');
merlinofchaos's avatar
merlinofchaos committed
1222
1223
1224
1225
}

/**
 * Fetch Views' data from the cache
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
 *
 * $param string|null $table
 *   (optional) The name of the table for which to fetch Views' data. If
 *   NULL, data for all tables will be retrieved
 * @param bool $reset
 *   (optional) Whether to rebuild the cache. Defaults to FALSE.
 *
 * @return array
 *   An associative array of views data for the given table. If $table is
 *   NULL, the array will be keyed by table name, with each key corresponding
 *   to the data array for that table.
 *
 * @see hook_views_data()
merlinofchaos's avatar
merlinofchaos committed
1239
 */
1240
function views_fetch_data($table = NULL, $reset = FALSE) {
merlinofchaos's avatar
merlinofchaos committed
1241
  views_include('cache');
1242
  return _views_fetch_data($table, $reset);
merlinofchaos's avatar
merlinofchaos committed
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
}

/**
 * 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()) {
1260
  $definitions = views_get_plugin_definitions($type);
1261
  $plugins = array();
merlinofchaos's avatar
merlinofchaos committed
1262

aspilicious's avatar
aspilicious committed
1263
  foreach ($definitions as $id => $plugin) {
1264
1265
1266
1267
    // Skip plugins that don't conform to our key.
    if ($key && (empty($plugin['type']) || $plugin['type'] != $key)) {
      continue;
    }
1268
1269
1270
1271
1272
    // @todo While Views is providing on behalf of core modules, check to see
    //   if they are enabled or not.
    if (isset($plugin['module']) && !module_exists($plugin['module'])) {
      continue;
    }
1273

1274
    if (empty($plugin['no_ui']) && (empty($base) || empty($plugin['base']) || array_intersect($base, $plugin['base']))) {
aspilicious's avatar
aspilicious committed
1275
      $plugins[$id] = $plugin['title'];
merlinofchaos's avatar
merlinofchaos committed
1276
1277
1278
    }
  }

1279
1280
1281
  if (!empty($plugins)) {
    asort($plugins);
    return $plugins;
merlinofchaos's avatar
merlinofchaos committed
1282
  }
1283

merlinofchaos's avatar
merlinofchaos committed
1284
1285
1286
1287
1288
  // fall-through
  return array();
}

/**
1289
 * Get an instance of a plugin.
merlinofchaos's avatar
merlinofchaos committed
1290
 *
1291
 * @param string $type
1292
1293
1294
 *   The plugin type, e.g., 'access' or 'display'.
 * @param string $plugin_id
 *   The name of the plugin, e.g., 'standard'.
merlinofchaos's avatar
merlinofchaos committed
1295
 *
1296
1297
 * @return Drupal\views\Plugin\view\PluginBase
 *   The created plugin instance.
merlinofchaos's avatar
merlinofchaos committed
1298
 */
1299
function views_get_plugin($type, $plugin_id) {
1300
  return drupal_container()->get("plugin.manager.views.$type")->createInstance($plugin_id);
1301
1302
1303
}

/**
1304
1305
1306
1307
1308
1309
1310
1311
 * Gets all the views plugin definitions.
 *
 * @param string|false $type
 *   Either the plugin type, or FALSE to load all definitions.
 *
 * @return array
 *   An array of plugin definitions for a single type, or an associative array
 *   of plugin definitions keyed by plugin type.
1312
1313
1314
 */
function views_get_plugin_definitions($type = FALSE) {
  $plugins = array();
1315
  $plugin_types = $type ? array($type) : ViewExecutable::getPluginTypes();
1316
  $container = drupal_container();
1317
  foreach ($plugin_types as $plugin_type) {
1318
    $plugins[$plugin_type] = $container->get("plugin.manager.views.$plugin_type")->getDefinitions();
1319
1320
1321
  }
  if ($type) {
    return $plugins[$type];
merlinofchaos's avatar
merlinofchaos committed
1322
  }
1323
1324
1325
1326
  return $plugins;
}

/**
1327
 * Gets the plugin definition from a plugin type with a specific ID.
1328
 *
1329
1330
 * @param string $type
 *   The plugin type, e.g., 'access' or 'display'.
1331
 * @param string $plugin_id
1332
 *   The name of the plugin, e.g., 'standard'.
1333
 *
1334
1335
 * @return array
 *   A plugin definition.
1336
 */
1337
function views_get_plugin_definition($type, $plugin_id) {
1338
  return drupal_container()->get("plugin.manager.views.$type")->getDefinition($plugin_id);
1339
1340
}

1341
1342
1343
1344
/**
 * Get enabled display extenders.
 */
function views_get_enabled_display_extenders() {
1345
  $enabled = array_filter((array) config('views.settings')->get('display_extenders'));
1346

1347
  return drupal_map_assoc($enabled);
1348
1349
}

merlinofchaos's avatar
merlinofchaos committed
1350
1351
1352
/**
 * Create an empty view to work with.
 *
1353
 * @return Drupal\views\ViewStorage
merlinofchaos's avatar
merlinofchaos committed
1354
1355
1356
1357
 *   A fully formed, empty $view object. This object must be populated before
 *   it can be successfully saved.
 */
function views_new_view() {
1358
  return entity_create('view', array());
merlinofchaos's avatar
merlinofchaos committed
1359
1360
}

1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
/**
 * Creates a view from an array of values.
 *
 * @return Drupal\views\ViewStorage
 *   A fully formed $view object with properties from the values passed in.
 */
function views_create_view(array $values = array()) {
  return entity_create('view', $values);
}

merlinofchaos's avatar
merlinofchaos committed
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
/**
 * Return a list of all views and display IDs that have a particular
 * setting in their display's plugin settings.
 *
 * @return
 * @code
 * array(
 *   array($view, $display_id),
 *   array($view, $display_id),
 * );
 * @endcode
 */
function views_get_applicable_views($type) {
  // @todo: Use a smarter flagging system so that we don't have to
  // load every view for this.
  $result = array();
  $views = views_get_all_views();

  foreach ($views as $view) {
    // Skip disabled views.
1391
    if (!$view->isEnabled()) {
merlinofchaos's avatar
merlinofchaos committed
1392
1393
1394
      continue;
    }

1395
    if (empty($view->display)) {
merlinofchaos's avatar
merlinofchaos committed
1396
1397
1398
1399
1400
1401
1402
      // Skip this view as it is broken.
      continue;
    }

    // Loop on array keys because something seems to muck with $view->display
    // a bit in PHP4.
    foreach (array_keys($view->display) as $id) {
1403
      $plugin = views_get_plugin_definition('display', $view->display[$id]['display_plugin']);
merlinofchaos's avatar
merlinofchaos committed
1404
      if (!empty($plugin[$type])) {
1405
        $executable = $view->getExecutable();
1406
        // This view uses_hook_menu. Clone it so that different handlers
merlinofchaos's avatar
merlinofchaos committed
1407
        // don't trip over each other, and add it to the list.
1408
        $v = $executable->cloneView();
1409
        if ($v->setDisplay($id) && $v->display_handler->isEnabled()) {
merlinofchaos's avatar
merlinofchaos committed
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
          $result[] = array($v, $id);
        }
        // In PHP 4.4.7 and presumably earlier, if we do not unset $v
        // here, we will find that it actually overwrites references
        // possibly due to shallow copying issues.
        unset($v);
      }
    }
  }
  return $result;
}

/**
1423
 * Returns an array of all views as fully loaded $view objects.
merlinofchaos's avatar
merlinofchaos committed
1424
 */
1425
function views_get_all_views() {
1426
  return entity_get_controller('view')->load();
1427
1428
}

merlinofchaos's avatar
merlinofchaos committed
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
/**
 * Returns an array of all enabled views, as fully loaded $view objects.
 */
function views_get_enabled_views() {
  $views = views_get_all_views();
  return array_filter($views, 'views_view_is_enabled');
}

/**
 * Returns an array of all disabled views, as fully loaded $view objects.
 */
function views_get_disabled_views() {
  $views = views_get_all_views();
  return array_filter($views, 'views_view_is_disabled');
}

/**
 * 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
1457
 *  - views object (containing $exclude_view->storage->name and $exclude_view->current_display)
merlinofchaos's avatar
merlinofchaos committed
1458
1459
1460
1461
1462
 *  - 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
1463
1464
 * @param bool $sort
 *  If TRUE, the list of views is sorted ascending.
merlinofchaos's avatar
merlinofchaos committed
1465
1466
1467
1468
1469
 *
 * @return array
 *  an associative array for use in select.
 *  - key: view name and display id separated by ':', or the view name only
 */
1470
function views_get_views_as_options($views_only = FALSE, $filter = 'all', $exclude_view = NULL, $optgroup = FALSE, $sort = FALSE) {
merlinofchaos's avatar
merlinofchaos committed
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489

  // 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)) {
1490
    $exclude_view_name = $exclude_view->storage->id();
merlinofchaos's avatar
merlinofchaos committed
1491
1492
1493
    $exclude_view_display = $exclude_view->current_display;
  }
  else {
1494
1495
1496
    // 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
1497
1498
1499
1500
  }

  $options = array();
  foreach ($views as $view) {
1501
    $id = $view->id();
merlinofchaos's avatar
merlinofchaos committed
1502
    // Return only views.
1503
1504
    if ($views_only && $id != $exclude_view_name) {
      $options[$id] = $view->getHumanName();
merlinofchaos's avatar
merlinofchaos committed
1505
1506
1507
1508
    }
    // Return views with display ids.
    else {
      foreach ($view->display as $display_id => $display) {
1509
        if (!($id == $exclude_view_name && $display_id == $exclude_view_display)) {
merlinofchaos's avatar
merlinofchaos committed
1510
          if ($optgroup) {
1511
            $options[$id][$id . ':' . $display['id']] = t('@view : @display', array('@view' => $id, '@display' => $display['id']));
merlinofchaos's avatar
merlinofchaos committed
1512
1513
          }
          else {
1514
            $options[$id . ':' . $display['id']] = t('View: @view - Display: @display', array('@view' => $id, '@display' => $display['id']));
merlinofchaos's avatar
merlinofchaos committed
1515
1516
1517
1518
1519
          }
        }
      }
    }
  }
1520
1521
1522
  if ($sort) {
    ksort($options);
  }
merlinofchaos's avatar
merlinofchaos committed
1523
1524
1525
1526
  return $options;
}

/**
dawehner's avatar
dawehner committed
1527
1528
 * Returns whether the view is enabled.
 *
1529
 * @param Drupal\views\ViewStorage $view
xjm's avatar
xjm committed
1530
 *   The view object to check.
dawehner's avatar
dawehner committed
1531
1532
1533
 *
 * @return bool
 *   Returns TRUE if a view is enabled, FALSE otherwise.
merlinofchaos's avatar
merlinofchaos committed
1534
 */
1535
function views_view_is_enabled(ViewStorage $view) {
dawehner's avatar
dawehner committed
1536
  return $view->isEnabled();
merlinofchaos's avatar
merlinofchaos committed
1537
1538
1539
}

/**
dawehner's avatar
dawehner committed
1540
1541
 * Returns whether the view is disabled.
 *
1542
 * @param Drupal\views\ViewStorage $view
xjm's avatar
xjm committed
1543
 *   The view object to check.
dawehner's avatar
dawehner committed
1544
1545
1546
 *
 * @return bool
 *   Returns TRUE if a view is disabled, FALSE otherwise.
merlinofchaos's avatar
merlinofchaos committed
1547
 */
1548
function views_view_is_disabled(ViewStorage $view) {
dawehner's avatar
dawehner committed
1549
  return !$view->isEnabled();
merlinofchaos's avatar
merlinofchaos committed
1550
1551
}

1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
/**
 * Enables a view.
 *
 * @param Drupal\views\ViewStorage $view
 *   The ViewStorage object to disable.
 */
function views_enable_view(ViewStorage $view) {
  $view->enable();
}

/**
 * Disables a view.
 *
 * @param Drupal\views\ViewStorage $view
 *   The ViewStorage object to disable.
 */
function views_disable_view(ViewStorage $view) {
  $view->disable();
}

merlinofchaos's avatar
merlinofchaos committed
1572
/**
xjm's avatar
xjm committed
1573
 * Loads a view from configuration.
merlinofchaos's avatar
merlinofchaos committed
1574
 *
xjm's avatar
xjm committed
1575
 * @param string $name
merlinofchaos's avatar
merlinofchaos committed
1576
 *   The name of the view.
xjm's avatar
xjm committed
1577
 *
1578
 * @return Drupal\views\ViewExecutable
dawehner's avatar
dawehner committed
1579
 *   A reference to the $view object.
merlinofchaos's avatar
merlinofchaos committed
1580
 */
1581
1582
function views_get_view($name) {
  $view = entity_load('view', $name);
merlinofchaos's avatar
merlinofchaos committed
1583
  if ($view) {
1584
    return $view->getExecutable();
merlinofchaos's avatar
merlinofchaos committed
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
  }
}

/**
 * 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.
 */
1614
function views_form($form, &$form_state, ViewExecutable $view, $output) {
merlinofchaos's avatar
merlinofchaos committed
1615
1616
1617
1618
1619
1620
1621
1622
  $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();
1623
  $query = drupal_get_query_parameters();
1624
  $form['#action'] = url($view->getUrl(), array('query' => $query));
merlinofchaos's avatar
merlinofchaos committed
1625
1626