12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094 |
- <?php
- /**
- * @file
- * CTools primary module file.
- *
- * Most of the CTools tools are in their own .inc files. This contains
- * nothing more than a few convenience functions and some hooks that
- * must be implemented in the module file.
- */
- define('CTOOLS_API_VERSION', '2.0.9');
- /**
- * The current working ctools version.
- *
- * In a release, it should be 7.x-1.x, which should match what drush make will
- * create. In a dev format, it should be 7.x-1.(x+1)-dev, which will allow
- * modules depending on new features in ctools to depend on ctools > 7.x-1.x.
- *
- * To define a specific version of CTools as a dependency for another module,
- * simply include a dependency line in that module's info file, e.g.:
- * ; Requires CTools v7.x-1.4 or newer.
- * dependencies[] = ctools (>=1.4)
- */
- define('CTOOLS_MODULE_VERSION', '7.x-1.11');
- /**
- * Test the CTools API version.
- *
- * This function can always be used to safely test if CTools has the minimum
- * API version that your module can use. It can also try to protect you from
- * running if the CTools API version is too new, but if you do that you need
- * to be very quick about watching CTools API releases and release new versions
- * of your software as soon as the new release is made, or people might end up
- * updating CTools and having your module shut down without any recourse.
- *
- * It is recommended that every hook of your module that might use CTools or
- * might lead to a use of CTools be guarded like this:
- *
- * @code
- * if (!module_invoke('ctools', 'api_version', '1.0')) {
- * return;
- * }
- * @endcode
- *
- * Note that some hooks such as _menu() or _theme() must return an array().
- *
- * You can use it in your hook_requirements to report this error condition
- * like this:
- *
- * @code
- * define('MODULENAME_MINIMUM_CTOOLS_API_VERSION', '1.0');
- * define('MODULENAME_MAXIMUM_CTOOLS_API_VERSION', '1.1');
- *
- * function MODULENAME_requirements($phase) {
- * $requirements = array();
- * if (!module_invoke('ctools', 'api_version', MODULENAME_MINIMUM_CTOOLS_API_VERSION, MODULENAME_MAXIMUM_CTOOLS_API_VERSION)) {
- * $requirements['MODULENAME_ctools'] = array(
- * 'title' => $t('MODULENAME required Chaos Tool Suite (CTools) API Version'),
- * 'value' => t('Between @a and @b', array('@a' => MODULENAME_MINIMUM_CTOOLS_API_VERSION, '@b' => MODULENAME_MAXIMUM_CTOOLS_API_VERSION)),
- * 'severity' => REQUIREMENT_ERROR,
- * );
- * }
- * return $requirements;
- * }
- * @endcode
- *
- * Please note that the version is a string, not an floating point number.
- * This will matter once CTools reaches version 1.10.
- *
- * A CTools API changes history will be kept in API.txt. Not every new
- * version of CTools will necessarily update the API version.
- * @param $minimum
- * The minimum version of CTools necessary for your software to run with it.
- * @param $maximum
- * The maximum version of CTools allowed for your software to run with it.
- */
- function ctools_api_version($minimum, $maximum = NULL) {
- if (version_compare(CTOOLS_API_VERSION, $minimum, '<')) {
- return FALSE;
- }
- if (isset($maximum) && version_compare(CTOOLS_API_VERSION, $maximum, '>')) {
- return FALSE;
- }
- return TRUE;
- }
- // -----------------------------------------------------------------------
- // General utility functions
- /**
- * Include .inc files as necessary.
- *
- * This fuction is helpful for including .inc files for your module. The
- * general case is including ctools funcitonality like this:
- *
- * @code
- * ctools_include('plugins');
- * @endcode
- *
- * Similar funcitonality can be used for other modules by providing the $module
- * and $dir arguments like this:
- *
- * @code
- * // include mymodule/includes/import.inc
- * ctools_include('import', 'mymodule');
- * // include mymodule/plugins/foobar.inc
- * ctools_include('foobar', 'mymodule', 'plugins');
- * @endcode
- *
- * @param $file
- * The base file name to be included.
- * @param $module
- * Optional module containing the include.
- * @param $dir
- * Optional subdirectory containing the include file.
- */
- function ctools_include($file, $module = 'ctools', $dir = 'includes') {
- static $used = array();
- $dir = '/' . ($dir ? $dir . '/' : '');
- if (!isset($used[$module][$dir][$file])) {
- require_once DRUPAL_ROOT . '/' . drupal_get_path('module', $module) . "$dir$file.inc";
- $used[$module][$dir][$file] = TRUE;
- }
- }
- /**
- * Include .inc files in a form context.
- *
- * This is a variant of ctools_include that will save information in the
- * the form_state so that cached forms will properly include things.
- */
- function ctools_form_include(&$form_state, $file, $module = 'ctools', $dir = 'includes') {
- if (!isset($form_state['build_info']['args'])) {
- $form_state['build_info']['args'] = array();
- }
- $dir = '/' . ($dir ? $dir . '/' : '');
- form_load_include($form_state, 'inc', $module, $dir . $file);
- }
- /**
- * Add an arbitrary path to the $form_state so it can work with form cache.
- *
- * module_load_include uses an unfortunately annoying syntax to work, making it
- * difficult to translate the more simple $path + $file syntax.
- */
- function ctools_form_include_file(&$form_state, $filename) {
- if (!isset($form_state['build_info']['args'])) {
- $form_state['build_info']['args'] = array();
- }
- // Now add this to the build info files so that AJAX requests will know to load it.
- $form_state['build_info']['files']["$filename"] = $filename;
- require_once DRUPAL_ROOT . '/' . $filename;
- }
- /**
- * Provide the proper path to an image as necessary.
- *
- * This helper function is used by ctools but can also be used in other
- * modules in the same way as explained in the comments of ctools_include.
- *
- * @param $image
- * The base file name (with extension) of the image to be included.
- * @param $module
- * Optional module containing the include.
- * @param $dir
- * Optional subdirectory containing the include file.
- */
- function ctools_image_path($image, $module = 'ctools', $dir = 'images') {
- return drupal_get_path('module', $module) . "/$dir/" . $image;
- }
- /**
- * Include css files as necessary.
- *
- * This helper function is used by ctools but can also be used in other
- * modules in the same way as explained in the comments of ctools_include.
- *
- * @param $file
- * The base file name to be included.
- * @param $module
- * Optional module containing the include.
- * @param $dir
- * Optional subdirectory containing the include file.
- */
- function ctools_add_css($file, $module = 'ctools', $dir = 'css') {
- drupal_add_css(drupal_get_path('module', $module) . "/$dir/$file.css");
- }
- /**
- * Format a css file name for use with $form['#attached']['css'].
- *
- * This helper function is used by ctools but can also be used in other
- * modules in the same way as explained in the comments of ctools_include.
- *
- * @code
- * $form['#attached']['css'] = array(ctools_attach_css('collapsible-div'));
- * $form['#attached']['css'][ctools_attach_css('collapsible-div')] = array('preprocess' => FALSE);
- * @endcode
- *
- * @param $file
- * The base file name to be included.
- * @param $module
- * Optional module containing the include.
- * @param $dir
- * Optional subdirectory containing the include file.
- */
- function ctools_attach_css($file, $module = 'ctools', $dir = 'css') {
- return drupal_get_path('module', $module) . "/$dir/$file.css";
- }
- /**
- * Include js files as necessary.
- *
- * This helper function is used by ctools but can also be used in other
- * modules in the same way as explained in the comments of ctools_include.
- *
- * @param $file
- * The base file name to be included.
- * @param $module
- * Optional module containing the include.
- * @param $dir
- * Optional subdirectory containing the include file.
- */
- function ctools_add_js($file, $module = 'ctools', $dir = 'js') {
- drupal_add_js(drupal_get_path('module', $module) . "/$dir/$file.js");
- }
- /**
- * Format a javascript file name for use with $form['#attached']['js'].
- *
- * This helper function is used by ctools but can also be used in other
- * modules in the same way as explained in the comments of ctools_include.
- *
- * @code
- * $form['#attached']['js'] = array(ctools_attach_js('auto-submit'));
- * @endcode
- *
- * @param $file
- * The base file name to be included.
- * @param $module
- * Optional module containing the include.
- * @param $dir
- * Optional subdirectory containing the include file.
- */
- function ctools_attach_js($file, $module = 'ctools', $dir = 'js') {
- return drupal_get_path('module', $module) . "/$dir/$file.js";
- }
- /**
- * Get a list of roles in the system.
- *
- * @return
- * An array of role names keyed by role ID.
- *
- * @deprecated
- * user_roles() should be used instead.
- */
- function ctools_get_roles() {
- return user_roles();
- }
- /*
- * Break x,y,z and x+y+z into an array. Numeric only.
- *
- * @param $str
- * The string to parse.
- *
- * @return $object
- * An object containing
- * - operator: Either 'and' or 'or'
- * - value: An array of numeric values.
- */
- function ctools_break_phrase($str) {
- $object = new stdClass();
- if (preg_match('/^([0-9]+[+ ])+[0-9]+$/', $str)) {
- // The '+' character in a query string may be parsed as ' '.
- $object->operator = 'or';
- $object->value = preg_split('/[+ ]/', $str);
- }
- else if (preg_match('/^([0-9]+,)*[0-9]+$/', $str)) {
- $object->operator = 'and';
- $object->value = explode(',', $str);
- }
- // Keep an 'error' value if invalid strings were given.
- if (!empty($str) && (empty($object->value) || !is_array($object->value))) {
- $object->value = array(-1);
- $object->invalid_input = TRUE;
- return $object;
- }
- if (empty($object->value)) {
- $object->value = array();
- }
- // Doubly ensure that all values are numeric only.
- foreach ($object->value as $id => $value) {
- $object->value[$id] = intval($value);
- }
- return $object;
- }
- /**
- * Set a token/value pair to be replaced later in the request, specifically in
- * ctools_page_token_processing().
- *
- * @param $token
- * The token to be replaced later, during page rendering. This should
- * ideally be a string inside of an HTML comment, so that if there is
- * no replacement, the token will not render on the page.
- * @param $type
- * The type of the token. Can be either 'variable', which will pull data
- * directly from the page variables
- * @param $argument
- * If $type == 'variable' then argument should be the key to fetch from
- * the $variables. If $type == 'callback' then it should either be the
- * callback, or an array that will be sent to call_user_func_array().
- *
- * @return
- * A array of token/variable names to be replaced.
- */
- function ctools_set_page_token($token = NULL, $type = NULL, $argument = NULL) {
- static $tokens = array();
- if (isset($token)) {
- $tokens[$token] = array($type, $argument);
- }
- return $tokens;
- }
- /**
- * Easily set a token from the page variables.
- *
- * This function can be used like this:
- * $token = ctools_set_variable_token('tabs');
- *
- * $token will then be a simple replacement for the 'tabs' about of the
- * variables available in the page template.
- */
- function ctools_set_variable_token($token) {
- $string = '<!-- ctools-page-' . $token . ' -->';
- ctools_set_page_token($string, 'variable', $token);
- return $string;
- }
- /**
- * Easily set a token from the page variables.
- *
- * This function can be used like this:
- * $token = ctools_set_variable_token('id', 'mymodule_myfunction');
- */
- function ctools_set_callback_token($token, $callback) {
- // If the callback uses arguments they are considered in the token.
- if (is_array($callback)) {
- $token .= '-' . md5(serialize($callback));
- }
- $string = '<!-- ctools-page-' . $token . ' -->';
- ctools_set_page_token($string, 'callback', $callback);
- return $string;
- }
- /**
- * Tell CTools that sidebar blocks should not be rendered.
- *
- * It is often desirable to not display sidebars when rendering a page,
- * particularly when using Panels. This informs CTools to alter out any
- * sidebar regions during block render.
- */
- function ctools_set_no_blocks($blocks = FALSE) {
- $status = &drupal_static(__FUNCTION__, TRUE);
- $status = $blocks;
- }
- /**
- * Wrapper function to create UUIDs via ctools, falls back on UUID module
- * if it is enabled. This code is a copy of uuid.inc from the uuid module.
- * @see http://php.net/uniqid#65879
- */
- function ctools_uuid_generate() {
- if (!module_exists('uuid')) {
- ctools_include('uuid');
- $callback = drupal_static(__FUNCTION__);
- if (empty($callback)) {
- if (function_exists('uuid_create') && !function_exists('uuid_make')) {
- $callback = '_ctools_uuid_generate_pecl';
- }
- elseif (function_exists('com_create_guid')) {
- $callback = '_ctools_uuid_generate_com';
- }
- else {
- $callback = '_ctools_uuid_generate_php';
- }
- }
- return $callback();
- }
- else {
- return uuid_generate();
- }
- }
- /**
- * Check that a string appears to be in the format of a UUID.
- * @see http://drupal.org/project/uuid
- *
- * @param $uuid
- * The string to test.
- *
- * @return
- * TRUE if the string is well formed.
- */
- function ctools_uuid_is_valid($uuid = '') {
- if (empty($uuid)) {
- return FALSE;
- }
- if (function_exists('uuid_is_valid') || module_exists('uuid')) {
- return uuid_is_valid($uuid);
- }
- else {
- ctools_include('uuid');
- return uuid_is_valid($uuid);
- }
- }
- /**
- * Add an array of classes to the body.
- *
- * @param mixed $classes
- * A string or an array of class strings to add.
- * @param string $hook
- * The theme hook to add the class to. The default is 'html' which will
- * affect the body tag.
- */
- function ctools_class_add($classes, $hook = 'html') {
- if (!is_array($classes)) {
- $classes = array($classes);
- }
- $static = &drupal_static('ctools_process_classes', array());
- if (!isset($static[$hook]['add'])) {
- $static[$hook]['add'] = array();
- }
- foreach ($classes as $class) {
- $static[$hook]['add'][] = $class;
- }
- }
- /**
- * Remove an array of classes from the body.
- *
- * @param mixed $classes
- * A string or an array of class strings to remove.
- * @param string $hook
- * The theme hook to remove the class from. The default is 'html' which will
- * affect the body tag.
- */
- function ctools_class_remove($classes, $hook = 'html') {
- if (!is_array($classes)) {
- $classes = array($classes);
- }
- $static = &drupal_static('ctools_process_classes', array());
- if (!isset($static[$hook]['remove'])) {
- $static[$hook]['remove'] = array();
- }
- foreach ($classes as $class) {
- $static[$hook]['remove'][] = $class;
- }
- }
- // -----------------------------------------------------------------------
- // Drupal core hooks
- /**
- * Implement hook_init to keep our global CSS at the ready.
- */
- function ctools_init() {
- ctools_add_css('ctools');
- // If we are sure that CTools' AJAX is in use, change the error handling.
- if (!empty($_REQUEST['ctools_ajax'])) {
- ini_set('display_errors', 0);
- register_shutdown_function('ctools_shutdown_handler');
- }
- // Clear plugin cache on the module page submit.
- if ($_GET['q'] == 'admin/modules/list/confirm' && !empty($_POST)) {
- cache_clear_all('ctools_plugin_files:', 'cache', TRUE);
- }
- }
- /**
- * Shutdown handler used during ajax operations to help catch fatal errors.
- */
- function ctools_shutdown_handler() {
- if (function_exists('error_get_last') AND ($error = error_get_last())) {
- switch ($error['type']) {
- case E_ERROR:
- case E_CORE_ERROR:
- case E_COMPILE_ERROR:
- case E_USER_ERROR:
- // Do this manually because including files here is dangerous.
- $commands = array(
- array(
- 'command' => 'alert',
- 'title' => t('Error'),
- 'text' => t('Unable to complete operation. Fatal error in @file on line @line: @message', array(
- '@file' => $error['file'],
- '@line' => $error['line'],
- '@message' => $error['message'],
- )),
- ),
- );
- // Change the status code so that the client will read the AJAX returned.
- header('HTTP/1.1 200 OK');
- drupal_json($commands);
- }
- }
- }
- /**
- * Implements hook_theme().
- */
- function ctools_theme() {
- ctools_include('utility');
- $items = array();
- ctools_passthrough('ctools', 'theme', $items);
- return $items;
- }
- /**
- * Implements hook_menu().
- */
- function ctools_menu() {
- ctools_include('utility');
- $items = array();
- ctools_passthrough('ctools', 'menu', $items);
- return $items;
- }
- /**
- * Implements hook_permission().
- */
- function ctools_permission() {
- return array(
- 'use ctools import' => array(
- 'title' => t('Use CTools importer'),
- 'description' => t('The import functionality allows users to execute arbitrary PHP code, so extreme caution must be taken.'),
- 'restrict access' => TRUE,
- ),
- );
- }
- /**
- * Implementation of hook_cron. Clean up old caches.
- */
- function ctools_cron() {
- ctools_include('utility');
- $items = array();
- ctools_passthrough('ctools', 'cron', $items);
- }
- /**
- * Implements hook_flush_caches().
- */
- function ctools_flush_caches() {
- // Only return the CSS cache bin if it has been activated, to avoid
- // drupal_flush_all_caches() from trying to truncate a non-existing table.
- return variable_get('cache_class_cache_ctools_css', FALSE) ? array('cache_ctools_css') : array();
- }
- /**
- * Implements hook_element_info_alter().
- *
- */
- function ctools_element_info_alter(&$type) {
- ctools_include('dependent');
- ctools_dependent_element_info_alter($type);
- }
- /**
- * Implementation of hook_file_download()
- *
- * When using the private file system, we have to let Drupal know it's ok to
- * download CSS and image files from our temporary directory.
- */
- function ctools_file_download($filepath) {
- if (strpos($filepath, 'ctools') === 0) {
- $mime = file_get_mimetype($filepath);
- // For safety's sake, we allow only text and images.
- if (strpos($mime, 'text') === 0 || strpos($mime, 'image') === 0) {
- return array('Content-type:' . $mime);
- }
- }
- }
- /**
- * Implements hook_registry_files_alter().
- *
- * Alter the registry of files to automagically include all classes in
- * class-based plugins.
- */
- function ctools_registry_files_alter(&$files, $indexed_modules) {
- ctools_include('registry');
- return _ctools_registry_files_alter($files, $indexed_modules);
- }
- // -----------------------------------------------------------------------
- // FAPI hooks that must be in the .module file.
- /**
- * Alter the comment form to get a little more control over it.
- */
- function ctools_form_comment_form_alter(&$form, &$form_state) {
- if (!empty($form_state['ctools comment alter'])) {
- // Force the form to post back to wherever we are.
- $form['#action'] = url($_GET['q'], array('fragment' => 'comment-form'));
- if (empty($form['#submit'])) {
- $form['#submit'] = array('comment_form_submit');
- }
- $form['#submit'][] = 'ctools_node_comment_form_submit';
- }
- }
- function ctools_node_comment_form_submit(&$form, &$form_state) {
- $form_state['redirect'][0] = $_GET['q'];
- }
- // -----------------------------------------------------------------------
- // CTools hook implementations.
- /**
- * Implementation of hook_ctools_plugin_directory() to let the system know
- * where all our own plugins are.
- */
- function ctools_ctools_plugin_directory($owner, $plugin_type) {
- if ($owner == 'ctools') {
- return 'plugins/' . $plugin_type;
- }
- }
- /**
- * Implements hook_ctools_plugin_type().
- */
- function ctools_ctools_plugin_type() {
- ctools_include('utility');
- $items = array();
- // Add all the plugins that have their own declaration space elsewhere.
- ctools_passthrough('ctools', 'plugin-type', $items);
- return $items;
- }
- // -----------------------------------------------------------------------
- // Drupal theme preprocess hooks that must be in the .module file.
- /**
- * A theme preprocess function to automatically allow panels-based node
- * templates based upon input when the panel was configured.
- */
- function ctools_preprocess_node(&$vars) {
- // The 'ctools_template_identifier' attribute of the node is added when the pane is
- // rendered.
- if (!empty($vars['node']->ctools_template_identifier)) {
- $vars['ctools_template_identifier'] = check_plain($vars['node']->ctools_template_identifier);
- $vars['theme_hook_suggestions'][] = 'node__panel__' . check_plain($vars['node']->ctools_template_identifier);
- }
- }
- /**
- * Implements hook_page_alter().
- *
- * Last ditch attempt to remove sidebar regions if the "no blocks"
- * functionality has been activated.
- *
- * @see ctools_block_list_alter().
- */
- function ctools_page_alter(&$page) {
- $check = drupal_static('ctools_set_no_blocks', TRUE);
- if (!$check) {
- foreach ($page as $region_id => $region) {
- // @todo -- possibly we can set configuration for this so that users can
- // specify which blocks will not get rendered.
- if (strpos($region_id, 'sidebar') !== FALSE) {
- unset($page[$region_id]);
- }
- }
- }
- $page['#post_render'][] = 'ctools_page_token_processing';
- }
- /**
- * A theme post_render callback to allow content type plugins to use page
- * template variables which are not yet available when the content type is
- * rendered.
- */
- function ctools_page_token_processing($children, $elements) {
- $tokens = ctools_set_page_token();
- if (!empty($tokens)) {
- foreach ($tokens as $token => $key) {
- list($type, $argument) = $key;
- switch ($type) {
- case 'variable':
- $tokens[$token] = isset($elements[$argument]) ? $elements[$argument] : '';
- break;
- case 'callback':
- if (is_string($argument) && function_exists($argument)) {
- $tokens[$token] = $argument($elements);
- }
- if (is_array($argument) && function_exists($argument[0])) {
- $function = array_shift($argument);
- $argument = array_merge(array(&$elements), $argument);
- $tokens[$token] = call_user_func_array($function, $argument);
- }
- break;
- }
- }
- $children = strtr($children, $tokens);
- }
- return $children;
- }
- /**
- * Implements hook_process().
- *
- * Add and remove CSS classes from the variables array. We use process so that
- * we alter anything added in the preprocess hooks.
- */
- function ctools_process(&$variables, $hook) {
- if (!isset($variables['classes'])) {
- return;
- }
- $classes = drupal_static('ctools_process_classes', array());
- // Process the classses to add.
- if (!empty($classes[$hook]['add'])) {
- $add_classes = array_map('drupal_clean_css_identifier', $classes[$hook]['add']);
- $variables['classes_array'] = array_unique(array_merge($variables['classes_array'], $add_classes));
- }
- // Process the classes to remove.
- if (!empty($classes[$hook]['remove'])) {
- $remove_classes = array_map('drupal_clean_css_identifier', $classes[$hook]['remove']);
- $variables['classes_array'] = array_diff($variables['classes_array'], $remove_classes);
- }
- // Update the classes within the attributes array to match the classes array
- if (isset($variables['attributes_array']['class'])) {
- $variables['attributes_array']['class'] = array_unique(array_merge($variables['classes_array'], $variables['attributes_array']['class']));
- $variables['attributes'] = $variables['attributes_array'] ? drupal_attributes($variables['attributes_array']) : '';
- }
- // Since this runs after template_process(), we need to re-implode the
- // classes array.
- $variables['classes'] = implode(' ', $variables['classes_array']);
- }
- // -----------------------------------------------------------------------
- // Menu callbacks that must be in the .module file.
- /**
- * Determine if the current user has access via a plugin.
- *
- * This function is meant to be embedded in the Drupal menu system, and
- * therefore is in the .module file since sub files can't be loaded, and
- * takes arguments a little bit more haphazardly than ctools_access().
- *
- * @param $access
- * An access control array which contains the following information:
- * - 'logic': and or or. Whether all tests must pass or one must pass.
- * - 'plugins': An array of access plugins. Each contains:
- * - - 'name': The name of the plugin
- * - - 'settings': The settings from the plugin UI.
- * - - 'context': Which context to use.
- * @param ...
- * zero or more context arguments generated from argument plugins. These
- * contexts must have an 'id' attached to them so that they can be
- * properly associated. The argument plugin system should set this, but
- * if the context is coming from elsewhere it will need to be set manually.
- *
- * @return
- * TRUE if access is granted, false if otherwise.
- */
- function ctools_access_menu($access) {
- // Short circuit everything if there are no access tests.
- if (empty($access['plugins'])) {
- return TRUE;
- }
- $contexts = array();
- foreach (func_get_args() as $arg) {
- if (is_object($arg) && get_class($arg) == 'ctools_context') {
- $contexts[$arg->id] = $arg;
- }
- }
- ctools_include('context');
- return ctools_access($access, $contexts);
- }
- /**
- * Determine if the current user has access via checks to multiple different
- * permissions.
- *
- * This function is a thin wrapper around user_access that allows multiple
- * permissions to be easily designated for use on, for example, a menu callback.
- *
- * @param ...
- * An indexed array of zero or more permission strings to be checked by
- * user_access().
- *
- * @return
- * Iff all checks pass will this function return TRUE. If an invalid argument
- * is passed (e.g., not a string), this function errs on the safe said and
- * returns FALSE.
- */
- function ctools_access_multiperm() {
- foreach (func_get_args() as $arg) {
- if (!is_string($arg) || !user_access($arg)) {
- return FALSE;
- }
- }
- return TRUE;
- }
- /**
- * Check to see if the incoming menu item is js capable or not.
- *
- * This can be used as %ctools_js as part of a path in hook menu. CTools
- * ajax functions will automatically change the phrase 'nojs' to 'ajax'
- * when it attaches ajax to a link. This can be used to autodetect if
- * that happened.
- */
- function ctools_js_load($js) {
- if ($js == 'ajax') {
- return TRUE;
- }
- return 0;
- }
- /**
- * Provides the default value for %ctools_js.
- *
- * This allows drupal_valid_path() to work with %ctools_js.
- */
- function ctools_js_to_arg($arg) {
- return empty($arg) || $arg == '%' ? 'nojs' : $arg;
- }
- /**
- * Menu _load hook.
- *
- * This function will be called to load an object as a replacement for
- * %ctools_export_ui in menu paths.
- */
- function ctools_export_ui_load($item_name, $plugin_name) {
- $return = &drupal_static(__FUNCTION__, FALSE);
- if (!$return) {
- ctools_include('export-ui');
- $plugin = ctools_get_export_ui($plugin_name);
- $handler = ctools_export_ui_get_handler($plugin);
- if ($handler) {
- return $handler->load_item($item_name);
- }
- }
- return $return;
- }
- // -----------------------------------------------------------------------
- // Caching callbacks on behalf of export-ui.
- /**
- * Menu access callback for various tasks of export-ui.
- */
- function ctools_export_ui_task_access($plugin_name, $op, $item = NULL) {
- ctools_include('export-ui');
- $plugin = ctools_get_export_ui($plugin_name);
- $handler = ctools_export_ui_get_handler($plugin);
- if ($handler) {
- return $handler->access($op, $item);
- }
- // Deny access if the handler cannot be found.
- return FALSE;
- }
- /**
- * Callback for access control ajax form on behalf of export ui.
- *
- * Returns the cached access config and contexts used.
- * Note that this is assuming that access will be in $item->access -- if it
- * is not, an export UI plugin will have to make its own callbacks.
- */
- function ctools_export_ui_ctools_access_get($argument) {
- ctools_include('export-ui');
- list($plugin_name, $key) = explode(':', $argument, 2);
- $plugin = ctools_get_export_ui($plugin_name);
- $handler = ctools_export_ui_get_handler($plugin);
- if ($handler) {
- ctools_include('context');
- $item = $handler->edit_cache_get($key);
- if (!$item) {
- $item = ctools_export_crud_load($handler->plugin['schema'], $key);
- }
- $contexts = ctools_context_load_contexts($item);
- return array($item->access, $contexts);
- }
- }
- /**
- * Callback for access control ajax form on behalf of export ui
- *
- * Returns the cached access config and contexts used.
- * Note that this is assuming that access will be in $item->access -- if it
- * is not, an export UI plugin will have to make its own callbacks.
- */
- function ctools_export_ui_ctools_access_set($argument, $access) {
- ctools_include('export-ui');
- list($plugin_name, $key) = explode(':', $argument, 2);
- $plugin = ctools_get_export_ui($plugin_name);
- $handler = ctools_export_ui_get_handler($plugin);
- if ($handler) {
- ctools_include('context');
- $item = $handler->edit_cache_get($key);
- if (!$item) {
- $item = ctools_export_crud_load($handler->plugin['schema'], $key);
- }
- $item->access = $access;
- return $handler->edit_cache_set_key($item, $key);
- }
- }
- /**
- * Implements hook_menu_local_tasks_alter().
- */
- function ctools_menu_local_tasks_alter(&$data, $router_item, $root_path) {
- ctools_include('menu');
- _ctools_menu_add_dynamic_items($data, $router_item, $root_path);
- }
- /**
- * Implement hook_block_list_alter() to potentially remove blocks.
- *
- * This exists in order to replicate Drupal 6's "no blocks" functionality.
- */
- function ctools_block_list_alter(&$blocks) {
- $check = drupal_static('ctools_set_no_blocks', TRUE);
- if (!$check) {
- foreach ($blocks as $block_id => $block) {
- // @todo -- possibly we can set configuration for this so that users can
- // specify which blocks will not get rendered.
- if (strpos($block->region, 'sidebar') !== FALSE) {
- unset($blocks[$block_id]);
- }
- }
- }
- }
- /**
- * Implements hook_modules_enabled().
- *
- * Clear caches for detecting new plugins.
- */
- function ctools_modules_enabled($modules) {
- ctools_include('plugins');
- ctools_get_plugins_reset();
- cache_clear_all('ctools_plugin_files:', 'cache', TRUE);
- }
- /**
- * Implements hook_modules_disabled().
- *
- * Clear caches for removing disabled plugins.
- */
- function ctools_modules_disabled($modules) {
- ctools_include('plugins');
- ctools_get_plugins_reset();
- cache_clear_all('ctools_plugin_files:', 'cache', TRUE);
- }
- /**
- * Menu theme callback.
- *
- * This simply ensures that Panels ajax calls are rendered in the same
- * theme as the original page to prevent .css file confusion.
- *
- * To use this, set this as the theme callback on AJAX related menu
- * items. Since the ajax page state won't be sent during ajax requests,
- * it should be safe to use even if ajax isn't invoked.
- */
- function ctools_ajax_theme_callback() {
- if (!empty($_POST['ajax_page_state']['theme'])) {
- return $_POST['ajax_page_state']['theme'];
- }
- }
- /**
- * Implements hook_ctools_entity_context_alter().
- */
- function ctools_ctools_entity_context_alter(&$plugin, &$entity, $plugin_id) {
- ctools_include('context');
- switch ($plugin_id) {
- case 'entity_id:taxonomy_term':
- $plugin['no ui'] = TRUE;
- break;
- case 'entity:user':
- $plugin = ctools_get_context('user');
- unset($plugin['no ui']);
- unset($plugin['no required context ui']);
- break;
- }
- // Apply restrictions on taxonomy term reverse relationships whose
- // restrictions are in the settings on the field.
- if (!empty($plugin['parent']) &&
- $plugin['parent'] == 'entity_from_field' &&
- !empty($plugin['reverse']) &&
- $plugin['to entity'] == 'taxonomy_term') {
- $field = field_info_field($plugin['field name']);
- if (isset($field['settings']['allowed_values'][0]['vocabulary'])) {
- $plugin['required context']->restrictions = array('vocabulary' => array($field['settings']['allowed_values'][0]['vocabulary']));
- }
- }
- }
- /**
- * Implements hook_field_create_field().
- */
- function ctools_field_create_field($field) {
- ctools_flush_field_caches();
- }
- /**
- * Implements hook_field_create_instance().
- */
- function ctools_field_create_instance($instance) {
- ctools_flush_field_caches();
- }
- /**
- * Implements hook_field_delete_field().
- */
- function ctools_field_delete_field($field) {
- ctools_flush_field_caches();
- }
- /**
- * Implements hook_field_delete_instance().
- */
- function ctools_field_delete_instance($instance) {
- ctools_flush_field_caches();
- }
- /**
- * Implements hook_field_update_field().
- */
- function ctools_field_update_field($field, $prior_field, $has_data) {
- ctools_flush_field_caches();
- }
- /**
- * Implements hook_field_update_instance().
- */
- function ctools_field_update_instance($instance, $prior_instance) {
- ctools_flush_field_caches();
- }
- /**
- * Clear field related caches.
- */
- function ctools_flush_field_caches() {
- // Clear caches of 'Entity field' content type plugin.
- cache_clear_all('ctools_entity_field_content_type_content_types', 'cache');
- }
|