danielebarchiesi@0: <?php
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * @file
danielebarchiesi@0:  *
danielebarchiesi@0:  * Contains code related to the ctools system of 'context'.
danielebarchiesi@0:  *
danielebarchiesi@0:  * Context, originally from Panels, is a method of packaging objects into
danielebarchiesi@0:  * a more generic bundle and providing a plugin system so that a UI can
danielebarchiesi@0:  * take advantage of them. The idea is that the context objects
danielebarchiesi@0:  * represent 'the context' that a given operation (usually a page view)
danielebarchiesi@0:  * is operating in or on.
danielebarchiesi@0:  *
danielebarchiesi@0:  * For example, when viewing a page, the 'context' is a node object. When
danielebarchiesi@0:  * viewing a user, the 'context' is a user object. Contexts can also
danielebarchiesi@0:  * have related contexts. For example, when viewing a 'node' you may need
danielebarchiesi@0:  * to know something about the node author. Therefore, the node author
danielebarchiesi@0:  * is a related context.
danielebarchiesi@0:  */
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * The context object is largely a wrapper around some other object, with
danielebarchiesi@0:  * an interface to finding out what is contained and getting to both
danielebarchiesi@0:  * the object and information about the object.
danielebarchiesi@0:  *
danielebarchiesi@0:  * Each context object has its own information, but some things are very
danielebarchiesi@0:  * common, such as titles, data, keywords, etc. In particulare, the 'type'
danielebarchiesi@0:  * of the context is important.
danielebarchiesi@0:  */
danielebarchiesi@0: class ctools_context {
danielebarchiesi@0:   var $type = NULL;
danielebarchiesi@0:   var $data = NULL;
danielebarchiesi@0:   // The title of this object.
danielebarchiesi@0:   var $title = '';
danielebarchiesi@0:   // The title of the page if this object exists
danielebarchiesi@0:   var $page_title = '';
danielebarchiesi@0:   // The identifier (in the UI) of this object
danielebarchiesi@0:   var $identifier = '';
danielebarchiesi@0:   var $argument = NULL;
danielebarchiesi@0:   var $keyword = '';
danielebarchiesi@0:   var $original_argument = NULL;
danielebarchiesi@0:   var $restrictions = array();
danielebarchiesi@0:   var $empty = FALSE;
danielebarchiesi@0: 
danielebarchiesi@0:   function ctools_context($type = 'none', $data = NULL) {
danielebarchiesi@0:     $this->type  = $type;
danielebarchiesi@0:     $this->data  = $data;
danielebarchiesi@0:     $this->title = t('Unknown context');
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   function is_type($type) {
danielebarchiesi@0:     if ($type == 'any' || $this->type == 'any') {
danielebarchiesi@0:       return TRUE;
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     $a = is_array($type) ? $type : array($type);
danielebarchiesi@0:     $b = is_array($this->type) ? $this->type : array($this->type);
danielebarchiesi@0:     return (bool) array_intersect($a, $b);
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   function get_argument() {
danielebarchiesi@0:     return $this->argument;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   function get_original_argument() {
danielebarchiesi@0:     if (!is_null($this->original_argument)) {
danielebarchiesi@0:       return $this->original_argument;
danielebarchiesi@0:     }
danielebarchiesi@0:     return $this->argument;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   function get_keyword() {
danielebarchiesi@0:     return $this->keyword;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   function get_identifier() {
danielebarchiesi@0:     return $this->identifier;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   function get_title() {
danielebarchiesi@0:     return $this->title;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   function get_page_title() {
danielebarchiesi@0:     return $this->page_title;
danielebarchiesi@0:   }
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Used to create a method of comparing if a list of contexts
danielebarchiesi@0:  * match a required context type.
danielebarchiesi@0:  */
danielebarchiesi@0: class ctools_context_required {
danielebarchiesi@0:   var $keywords = '';
danielebarchiesi@0: 
danielebarchiesi@0:   /**
danielebarchiesi@0:    * If set, the title will be used in the selector to identify
danielebarchiesi@0:    * the context. This is very useful when multiple contexts
danielebarchiesi@0:    * are required to inform the user will be used for what.
danielebarchiesi@0:    */
danielebarchiesi@0:   var $title = NULL;
danielebarchiesi@0: 
danielebarchiesi@0:   /**
danielebarchiesi@0:    * Test to see if this context is required.
danielebarchiesi@0:    */
danielebarchiesi@0:   var $required = TRUE;
danielebarchiesi@0: 
danielebarchiesi@0:   /**
danielebarchiesi@0:    * If TRUE, skip the check in ctools_context_required::select()
danielebarchiesi@0:    * for contexts whose names may have changed.
danielebarchiesi@0:    */
danielebarchiesi@0:   var $skip_name_check = FALSE;
danielebarchiesi@0: 
danielebarchiesi@0:   /**
danielebarchiesi@0:    *
danielebarchiesi@0:    * @param $title
danielebarchiesi@0:    *   The first parameter should be the 'title' of the context for use
danielebarchiesi@0:    *   in UYI selectors when multiple contexts qualify.
danielebarchiesi@0:    * @param ...
danielebarchiesi@0:    *   One or more keywords to use for matching which contexts are allowed.
danielebarchiesi@0:    */
danielebarchiesi@0:   function ctools_context_required($title) {
danielebarchiesi@0:     $args = func_get_args();
danielebarchiesi@0:     $this->title = array_shift($args);
danielebarchiesi@0: 
danielebarchiesi@0:     // If we have a boolean value at the end for $skip_name_check, store it
danielebarchiesi@0:     if (is_bool(end($args))) {
danielebarchiesi@0:       $this->skip_name_check = array_pop($args);
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     // If we were given restrictions at the end, store them.
danielebarchiesi@0:     if (count($args) > 1 && is_array(end($args))) {
danielebarchiesi@0:       $this->restrictions = array_pop($args);
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     if (count($args) == 1) {
danielebarchiesi@0:       $args = array_shift($args);
danielebarchiesi@0:     }
danielebarchiesi@0:     $this->keywords = $args;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   function filter($contexts) {
danielebarchiesi@0:     $result = array();
danielebarchiesi@0: 
danielebarchiesi@0:     // See which of these contexts are valid
danielebarchiesi@0:     foreach ((array) $contexts as $cid => $context) {
danielebarchiesi@0:       if ($context->is_type($this->keywords)) {
danielebarchiesi@0:         // Compare to see if our contexts were met.
danielebarchiesi@0:         if (!empty($this->restrictions) && !empty($context->restrictions)) {
danielebarchiesi@0:           foreach ($this->restrictions as $key => $values) {
danielebarchiesi@0:             // If we have a restriction, the context must either not have that
danielebarchiesi@0:             // restriction listed, which means we simply don't know what it is,
danielebarchiesi@0:             // or there must be an intersection of the restricted values on
danielebarchiesi@0:             // both sides.
danielebarchiesi@0:             if (!is_array($values)) {
danielebarchiesi@0:               $values = array($values);
danielebarchiesi@0:             }
danielebarchiesi@0:             if (!empty($context->restrictions[$key]) && !array_intersect($values, $context->restrictions[$key])) {
danielebarchiesi@0:               continue 2;
danielebarchiesi@0:             }
danielebarchiesi@0:           }
danielebarchiesi@0:         }
danielebarchiesi@0:         $result[$cid] = $context;
danielebarchiesi@0:       }
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     return $result;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   function select($contexts, $context) {
danielebarchiesi@0:     if (!is_array($contexts)) {
danielebarchiesi@0:       $contexts = array($contexts);
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     // If we had requested a $context but that $context doesn't exist
danielebarchiesi@0:     // in our context list, there is a good chance that what happened
danielebarchiesi@0:     // is our context IDs changed. See if there's another context
danielebarchiesi@0:     // that satisfies our requirements.
danielebarchiesi@0:     if (!$this->skip_name_check && !empty($context) && !isset($contexts[$context])) {
danielebarchiesi@0:       $choices = $this->filter($contexts);
danielebarchiesi@0: 
danielebarchiesi@0:       // If we got a hit, take the first one that matches.
danielebarchiesi@0:       if ($choices) {
danielebarchiesi@0:         $keys = array_keys($choices);
danielebarchiesi@0:         $context = reset($keys);
danielebarchiesi@0:       }
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     if (empty($context) || empty($contexts[$context])) {
danielebarchiesi@0:       return FALSE;
danielebarchiesi@0:     }
danielebarchiesi@0:     return $contexts[$context];
danielebarchiesi@0:   }
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Used to compare to see if a list of contexts match an optional context. This
danielebarchiesi@0:  * can produce empty contexts to use as placeholders.
danielebarchiesi@0:  */
danielebarchiesi@0: class ctools_context_optional extends ctools_context_required {
danielebarchiesi@0:   var $required = FALSE;
danielebarchiesi@0:   function ctools_context_optional() {
danielebarchiesi@0:     $args = func_get_args();
danielebarchiesi@0:     call_user_func_array(array($this, 'ctools_context_required'), $args);
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   /**
danielebarchiesi@0:    * Add the 'empty' context which is possible for optional
danielebarchiesi@0:    */
danielebarchiesi@0:   function add_empty(&$contexts) {
danielebarchiesi@0:     $context = new ctools_context('any');
danielebarchiesi@0:     $context->title      = t('No context');
danielebarchiesi@0:     $context->identifier = t('No context');
danielebarchiesi@0:     $contexts = array_merge(array('empty' => $context), $contexts);
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   function filter($contexts) {
danielebarchiesi@0:     $this->add_empty($contexts);
danielebarchiesi@0:     return parent::filter($contexts);
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   function select($contexts, $context) {
danielebarchiesi@0:     $this->add_empty($contexts);
danielebarchiesi@0:     if (empty($context)) {
danielebarchiesi@0:       return $contexts['empty'];
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     $result = parent::select($contexts, $context);
danielebarchiesi@0: 
danielebarchiesi@0:     // Don't flip out if it can't find the context; this is optional, put
danielebarchiesi@0:     // in an empty.
danielebarchiesi@0:     if ($result == FALSE) {
danielebarchiesi@0:       $result = $contexts['empty'];
danielebarchiesi@0:     }
danielebarchiesi@0:     return $result;
danielebarchiesi@0:   }
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Return a keyed array of context that match the given 'required context'
danielebarchiesi@0:  * filters.
danielebarchiesi@0:  *
danielebarchiesi@0:  * Functions or systems that require contexts of a particular type provide a
danielebarchiesi@0:  * ctools_context_required or ctools_context_optional object. This function
danielebarchiesi@0:  * examines that object and an array of contexts to determine which contexts
danielebarchiesi@0:  * match the filter.
danielebarchiesi@0:  *
danielebarchiesi@0:  * Since multiple contexts can be required, this function will accept either
danielebarchiesi@0:  * an array of all required contexts, or just a single required context object.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @param $contexts
danielebarchiesi@0:  *   A keyed array of all available contexts.
danielebarchiesi@0:  * @param $required
danielebarchiesi@0:  *   A ctools_context_required or ctools_context_optional object, or an array
danielebarchiesi@0:  *   of such objects.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @return
danielebarchiesi@0:  *   A keyed array of contexts that match the filter.
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_context_filter($contexts, $required) {
danielebarchiesi@0:   if (is_array($required)) {
danielebarchiesi@0:     $result = array();
danielebarchiesi@0:     foreach ($required as $r) {
danielebarchiesi@0:       $result = array_merge($result, _ctools_context_filter($contexts, $r));
danielebarchiesi@0:     }
danielebarchiesi@0:     return $result;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   return _ctools_context_filter($contexts, $required);
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: function _ctools_context_filter($contexts, $required) {
danielebarchiesi@0:   $result = array();
danielebarchiesi@0: 
danielebarchiesi@0:   if (is_object($required)) {
danielebarchiesi@0:     $result = $required->filter($contexts);
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   return $result;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Create a select box to choose possible contexts.
danielebarchiesi@0:  *
danielebarchiesi@0:  * This only creates a selector if there is actually a choice; if there
danielebarchiesi@0:  * is only one possible context, that one is silently assigned.
danielebarchiesi@0:  *
danielebarchiesi@0:  * If an array of required contexts is provided, one selector will be
danielebarchiesi@0:  * provided for each context.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @param $contexts
danielebarchiesi@0:  *   A keyed array of all available contexts.
danielebarchiesi@0:  * @param $required
danielebarchiesi@0:  *   The required context object or array of objects.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @return
danielebarchiesi@0:  *   A form element, or NULL if there are no contexts that satisfy the
danielebarchiesi@0:  *   requirements.
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_context_selector($contexts, $required, $default) {
danielebarchiesi@0:   if (is_array($required)) {
danielebarchiesi@0:     $result = array('#tree' => TRUE);
danielebarchiesi@0:     $count = 1;
danielebarchiesi@0:     foreach ($required as $id => $r) {
danielebarchiesi@0:       $result[] = _ctools_context_selector($contexts, $r, isset($default[$id]) ? $default[$id] : '', $count++);
danielebarchiesi@0:     }
danielebarchiesi@0:     return $result;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   return _ctools_context_selector($contexts, $required, $default);
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: function _ctools_context_selector($contexts, $required, $default, $num = 0) {
danielebarchiesi@0:   $filtered = ctools_context_filter($contexts, $required);
danielebarchiesi@0:   $count = count($filtered);
danielebarchiesi@0: 
danielebarchiesi@0:   $form = array();
danielebarchiesi@0: 
danielebarchiesi@0:   if ($count >= 1) {
danielebarchiesi@0:     // If there's more than one to choose from, create a select widget.
danielebarchiesi@0:     foreach ($filtered as $cid => $context) {
danielebarchiesi@0:       $options[$cid] = $context->get_identifier();
danielebarchiesi@0:     }
danielebarchiesi@0:     if (!empty($required->title)) {
danielebarchiesi@0:       $title = $required->title;
danielebarchiesi@0:     }
danielebarchiesi@0:     else {
danielebarchiesi@0:       $title = $num ? t('Context %count', array('%count' => $num)) : t('Context');
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     return array(
danielebarchiesi@0:       '#type' => 'select',
danielebarchiesi@0:       '#options' => $options,
danielebarchiesi@0:       '#title' => $title,
danielebarchiesi@0:       '#default_value' => $default,
danielebarchiesi@0:     );
danielebarchiesi@0:   }
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Are there enough contexts for a plugin?
danielebarchiesi@0:  *
danielebarchiesi@0:  * Some plugins can have a 'required contexts' item which can either
danielebarchiesi@0:  * be a context requirement object or an array of them. When contexts
danielebarchiesi@0:  * are required, items that do not have enough contexts should not
danielebarchiesi@0:  * appear. This tests an item to see if it has enough contexts
danielebarchiesi@0:  * to actually appear.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @param $contexts
danielebarchiesi@0:  *   A keyed array of all available contexts.
danielebarchiesi@0:  * @param $required
danielebarchiesi@0:  *   The required context object or array of objects.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @return
danielebarchiesi@0:  *   TRUE if there are enough contexts, FALSE if there are not.
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_context_match_requirements($contexts, $required) {
danielebarchiesi@0:   if (!is_array($required)) {
danielebarchiesi@0:     $required = array($required);
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   // Get the keys to avoid bugs in PHP 5.0.8 with keys and loops.
danielebarchiesi@0:   // And use it to remove optional contexts.
danielebarchiesi@0:   $keys = array_keys($required);
danielebarchiesi@0:   foreach ($keys as $key) {
danielebarchiesi@0:     if (empty($required[$key]->required)) {
danielebarchiesi@0:       unset($required[$key]);
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   $count = count($required);
danielebarchiesi@0:   return (count(ctools_context_filter($contexts, $required)) >= $count);
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Create a select box to choose possible contexts.
danielebarchiesi@0:  *
danielebarchiesi@0:  * This only creates a selector if there is actually a choice; if there
danielebarchiesi@0:  * is only one possible context, that one is silently assigned.
danielebarchiesi@0:  *
danielebarchiesi@0:  * If an array of required contexts is provided, one selector will be
danielebarchiesi@0:  * provided for each context.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @param $contexts
danielebarchiesi@0:  *   A keyed array of all available contexts.
danielebarchiesi@0:  * @param $required
danielebarchiesi@0:  *   The required context object or array of objects.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @return
danielebarchiesi@0:  *   A form element, or NULL if there are no contexts that satisfy the
danielebarchiesi@0:  *   requirements.
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_context_converter_selector($contexts, $required, $default) {
danielebarchiesi@0:   if (is_array($required)) {
danielebarchiesi@0:     $result = array('#tree' => TRUE);
danielebarchiesi@0:     $count = 1;
danielebarchiesi@0:     foreach ($required as $id => $r) {
danielebarchiesi@0:       $result[] = _ctools_context_converter_selector($contexts, $r, isset($default[$id]) ? $default[$id] : '', $count++);
danielebarchiesi@0:     }
danielebarchiesi@0:     return $result;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   return _ctools_context_converter_selector($contexts, $required, $default);
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: function _ctools_context_converter_selector($contexts, $required, $default, $num = 0) {
danielebarchiesi@0:   $filtered = ctools_context_filter($contexts, $required);
danielebarchiesi@0:   $count = count($filtered);
danielebarchiesi@0: 
danielebarchiesi@0:   $form = array();
danielebarchiesi@0: 
danielebarchiesi@0:   if ($count > 1) {
danielebarchiesi@0:     // If there's more than one to choose from, create a select widget.
danielebarchiesi@0:     $options = array();
danielebarchiesi@0:     foreach ($filtered as $cid => $context) {
danielebarchiesi@0:       if ($context->type == 'any') {
danielebarchiesi@0:         $options[''] = t('No context');
danielebarchiesi@0:         continue;
danielebarchiesi@0:       }
danielebarchiesi@0:       $key = $context->get_identifier();
danielebarchiesi@0:       if ($converters = ctools_context_get_converters($cid . '.', $context)) {
danielebarchiesi@0:         $options[$key] = $converters;
danielebarchiesi@0:       }
danielebarchiesi@0:     }
danielebarchiesi@0:     if (empty($options)) {
danielebarchiesi@0:       return array(
danielebarchiesi@0:         '#type' => 'value',
danielebarchiesi@0:         '#value' => 'any',
danielebarchiesi@0:       );
danielebarchiesi@0:     }
danielebarchiesi@0:     if (!empty($required->title)) {
danielebarchiesi@0:       $title = $required->title;
danielebarchiesi@0:     }
danielebarchiesi@0:     else {
danielebarchiesi@0:       $title = $num ? t('Context %count', array('%count' => $num)) : t('Context');
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     return array(
danielebarchiesi@0:       '#type' => 'select',
danielebarchiesi@0:       '#options' => $options,
danielebarchiesi@0:       '#title' => $title,
danielebarchiesi@0:       '#description' => t('Please choose which context and how you would like it converted.'),
danielebarchiesi@0:       '#default_value' => $default,
danielebarchiesi@0:     );
danielebarchiesi@0:   }
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Get a list of converters available for a given context.
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_context_get_converters($cid, $context) {
danielebarchiesi@0:   if (empty($context->plugin)) {
danielebarchiesi@0:     return array();
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   return _ctools_context_get_converters($cid, $context->plugin);
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Get a list of converters available for a given context.
danielebarchiesi@0:  */
danielebarchiesi@0: function _ctools_context_get_converters($id, $plugin_name) {
danielebarchiesi@0:   $plugin = ctools_get_context($plugin_name);
danielebarchiesi@0:   if (empty($plugin['convert list'])) {
danielebarchiesi@0:     return array();
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   $converters = array();
danielebarchiesi@0:   if (is_array($plugin['convert list'])) {
danielebarchiesi@0:     $converters = $plugin['convert list'];
danielebarchiesi@0:   }
danielebarchiesi@0:   else if ($function = ctools_plugin_get_function($plugin, 'convert list')) {
danielebarchiesi@0:     $converters = (array) $function($plugin);
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   foreach (module_implements('ctools_context_convert_list_alter') as $module) {
danielebarchiesi@0:     $function = $module . '_ctools_context_convert_list_alter';
danielebarchiesi@0:     $function($plugin, $converters);
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   // Now, change them all to include the plugin:
danielebarchiesi@0:   $return = array();
danielebarchiesi@0:   foreach ($converters as $key => $title) {
danielebarchiesi@0:     $return[$id . $key] = $title;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   natcasesort($return);
danielebarchiesi@0:   return $return;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Get a list of all contexts + converters available.
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_context_get_all_converters() {
danielebarchiesi@0:   $contexts = ctools_get_contexts();
danielebarchiesi@0:   $converters = array();
danielebarchiesi@0:   foreach ($contexts as $name => $context) {
danielebarchiesi@0:     if (empty($context['no required context ui'])) {
danielebarchiesi@0:       $context_converters = _ctools_context_get_converters($name . '.', $name);
danielebarchiesi@0:       if ($context_converters) {
danielebarchiesi@0:         $converters[$context['title']] = $context_converters;
danielebarchiesi@0:       }
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   return $converters;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Let the context convert an argument based upon the converter that was given.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @param $context
danielebarchiesi@0:  *   The context object
danielebarchiesi@0:  * @param $converter
danielebarchiesi@0:  *   The converter to use, which should be a string provided by the converter list.
danielebarchiesi@0:  * @param $converter_options
danielebarchiesi@0:  *   A n array of options to pass on to the generation function. For contexts
danielebarchiesi@0:  *   that use token module, of particular use is 'sanitize' => FALSE which can
danielebarchiesi@0:  *   get raw tokens. This should ONLY be used in values that will later be
danielebarchiesi@0:  *   treated as unsafe user input since these values are by themselves unsafe.
danielebarchiesi@0:  *   It is particularly useful to get raw values from Field API.
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_context_convert_context($context, $converter, $converter_options = array()) {
danielebarchiesi@0:   // Contexts without plugins might be optional placeholders.
danielebarchiesi@0:   if (empty($context->plugin)) {
danielebarchiesi@0:     return;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   $value = $context->argument;
danielebarchiesi@0:   $plugin = ctools_get_context($context->plugin);
danielebarchiesi@0:   if ($function = ctools_plugin_get_function($plugin, 'convert')) {
danielebarchiesi@0:     $value = $function($context, $converter, $converter_options);
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   foreach (module_implements('ctools_context_converter_alter') as $module) {
danielebarchiesi@0:     $function = $module . '_ctools_context_converter_alter';
danielebarchiesi@0:     $function($context, $converter, $value, $converter_options);
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   return $value;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Choose a context or contexts based upon the selection made via
danielebarchiesi@0:  * ctools_context_filter.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @param $contexts
danielebarchiesi@0:  *   A keyed array of all available contexts
danielebarchiesi@0:  * @param $required
danielebarchiesi@0:  *   The required context object provided by the plugin
danielebarchiesi@0:  * @param $context
danielebarchiesi@0:  *   The selection made using ctools_context_selector
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_context_select($contexts, $required, $context) {
danielebarchiesi@0:   if (is_array($required)) {
danielebarchiesi@0:     $result = array();
danielebarchiesi@0:     foreach ($required as $id => $r) {
danielebarchiesi@0:       if (empty($required[$id])) {
danielebarchiesi@0:         continue;
danielebarchiesi@0:       }
danielebarchiesi@0: 
danielebarchiesi@0:       if (($result[] = _ctools_context_select($contexts, $r, $context[$id])) === FALSE) {
danielebarchiesi@0:         return FALSE;
danielebarchiesi@0:       }
danielebarchiesi@0:     }
danielebarchiesi@0:     return $result;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   return _ctools_context_select($contexts, $required, $context);
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: function _ctools_context_select($contexts, $required, $context) {
danielebarchiesi@0:   if (!is_object($required)) {
danielebarchiesi@0:     return FALSE;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   return $required->select($contexts, $context);
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Create a new context object.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @param $type
danielebarchiesi@0:  *   The type of context to create; this loads a plugin.
danielebarchiesi@0:  * @param $data
danielebarchiesi@0:  *   The data to put into the context.
danielebarchiesi@0:  * @param $empty
danielebarchiesi@0:  *   Whether or not this context is specifically empty.
danielebarchiesi@0:  * @param $conf
danielebarchiesi@0:  *   A configuration structure if this context was created via UI.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @return
danielebarchiesi@0:  *   A $context or NULL if one could not be created.
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_context_create($type, $data = NULL, $conf = FALSE) {
danielebarchiesi@0:   ctools_include('plugins');
danielebarchiesi@0:   $plugin = ctools_get_context($type);
danielebarchiesi@0: 
danielebarchiesi@0:   if ($function = ctools_plugin_get_function($plugin, 'context')) {
danielebarchiesi@0:     return $function(FALSE, $data, $conf, $plugin);
danielebarchiesi@0:   }
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Create an empty context object.
danielebarchiesi@0:  *
danielebarchiesi@0:  * Empty context objects are primarily used as placeholders in the UI where
danielebarchiesi@0:  * the actual contents of a context object may not be known. It may have
danielebarchiesi@0:  * additional text embedded to give the user clues as to how the context
danielebarchiesi@0:  * is used.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @param $type
danielebarchiesi@0:  *   The type of context to create; this loads a plugin.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @return
danielebarchiesi@0:  *   A $context or NULL if one could not be created.
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_context_create_empty($type) {
danielebarchiesi@0:   $plugin = ctools_get_context($type);
danielebarchiesi@0:   if ($function = ctools_plugin_get_function($plugin, 'context')) {
danielebarchiesi@0:     $context = $function(TRUE, NULL, FALSE, $plugin);
danielebarchiesi@0:     if (is_object($context)) {
danielebarchiesi@0:       $context->empty = TRUE;
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     return $context;
danielebarchiesi@0:   }
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Perform keyword and context substitutions.
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_context_keyword_substitute($string, $keywords, $contexts, $converter_options = array()) {
danielebarchiesi@0:   // Ensure a default keyword exists:
danielebarchiesi@0:   $keywords['%%'] = '%';
danielebarchiesi@0: 
danielebarchiesi@0:   // Match contexts to the base keywords:
danielebarchiesi@0:   $context_keywords = array();
danielebarchiesi@0:   foreach ($contexts as $context) {
danielebarchiesi@0:     if (isset($context->keyword)) {
danielebarchiesi@0:       $context_keywords[$context->keyword] = $context;
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   // Look for context matches we we only have to convert known matches.
danielebarchiesi@0:   $matches = array();
danielebarchiesi@0:   if (preg_match_all('/%(%|[a-zA-Z0-9_-]+(?:\:[a-zA-Z0-9_-]+)*)/us', $string, $matches)) {
danielebarchiesi@0:     foreach ($matches[1] as $keyword) {
danielebarchiesi@0:       // Ignore anything it finds with %%.
danielebarchiesi@0:       if ($keyword[0] == '%') {
danielebarchiesi@0:         continue;
danielebarchiesi@0:       }
danielebarchiesi@0: 
danielebarchiesi@0:       // If the keyword is already set by something passed in, don't try to
danielebarchiesi@0:       // overwrite it.
danielebarchiesi@0:       if (!empty($keywords['%' . $keyword])) {
danielebarchiesi@0:         continue;
danielebarchiesi@0:       }
danielebarchiesi@0: 
danielebarchiesi@0:       // Figure out our keyword and converter, if specified.
danielebarchiesi@0:       if (strpos($keyword, ':')) {
danielebarchiesi@0:         list($context, $converter) = explode(':', $keyword, 2);
danielebarchiesi@0:       }
danielebarchiesi@0:       else {
danielebarchiesi@0:         $context = $keyword;
danielebarchiesi@0:         if (isset($context_keywords[$keyword])) {
danielebarchiesi@0:           $plugin = ctools_get_context($context_keywords[$context]->plugin);
danielebarchiesi@0: 
danielebarchiesi@0:           // Fall back to a default converter, if specified.
danielebarchiesi@0:           if ($plugin && !empty($plugin['convert default'])) {
danielebarchiesi@0:             $converter = $plugin['convert default'];
danielebarchiesi@0:           }
danielebarchiesi@0:         }
danielebarchiesi@0:       }
danielebarchiesi@0: 
danielebarchiesi@0:       if (empty($context_keywords[$context]) || !empty($context_keywords[$context]->empty)) {
danielebarchiesi@0:         $keywords['%' . $keyword] = '';
danielebarchiesi@0:       }
danielebarchiesi@0:       else if (!empty($converter)) {
danielebarchiesi@0:         $keywords['%' . $keyword] = ctools_context_convert_context($context_keywords[$context], $converter, $converter_options);
danielebarchiesi@0:       }
danielebarchiesi@0:       else {
danielebarchiesi@0:         $keywords['%' . $keyword] = $context_keywords[$keyword]->title;
danielebarchiesi@0:       }
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0:   return strtr($string, $keywords);
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Determine a unique context ID for a context
danielebarchiesi@0:  *
danielebarchiesi@0:  * Often contexts of many different types will be placed into a list. This
danielebarchiesi@0:  * ensures that even though contexts of multiple types may share IDs, they
danielebarchiesi@0:  * are unique in the final list.
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_context_id($context, $type = 'context') {
danielebarchiesi@0:   if (!$context['id']) {
danielebarchiesi@0:     $context['id'] = 1;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   return $type . '_' . $context['name'] . '_' . $context['id'];
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Get the next id available given a list of already existing objects.
danielebarchiesi@0:  *
danielebarchiesi@0:  * This finds the next id available for the named object.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @param $objects
danielebarchiesi@0:  *   A list of context descriptor objects, i.e, arguments, relationships, contexts, etc.
danielebarchiesi@0:  * @param $name
danielebarchiesi@0:  *   The name being used.
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_context_next_id($objects, $name) {
danielebarchiesi@0:   $id = 0;
danielebarchiesi@0:   // Figure out which instance of this argument we're creating
danielebarchiesi@0:   if (!$objects) {
danielebarchiesi@0:     return $id + 1;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   foreach ($objects as $object) {
danielebarchiesi@0:     if (isset($object['name']) && $object['name'] == $name) {
danielebarchiesi@0:       if ($object['id'] > $id) {
danielebarchiesi@0:         $id = $object['id'];
danielebarchiesi@0:       }
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   return $id + 1;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: 
danielebarchiesi@0: // ---------------------------------------------------------------------------
danielebarchiesi@0: // Functions related to contexts from arguments.
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Fetch metadata on a specific argument plugin.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @param $argument
danielebarchiesi@0:  *   Name of an argument plugin.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @return
danielebarchiesi@0:  *   An array with information about the requested argument plugin.
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_get_argument($argument) {
danielebarchiesi@0:   ctools_include('plugins');
danielebarchiesi@0:   return ctools_get_plugins('ctools', 'arguments', $argument);
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Fetch metadata for all argument plugins.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @return
danielebarchiesi@0:  *   An array of arrays with information about all available argument plugins.
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_get_arguments() {
danielebarchiesi@0:   ctools_include('plugins');
danielebarchiesi@0:   return ctools_get_plugins('ctools', 'arguments');
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Get a context from an argument.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @param $argument
danielebarchiesi@0:  *   The configuration of an argument. It must contain the following data:
danielebarchiesi@0:  *   - name: The name of the argument plugin being used.
danielebarchiesi@0:  *   - argument_settings: The configuration based upon the plugin forms.
danielebarchiesi@0:  *   - identifier: The human readable identifier for this argument, usually
danielebarchiesi@0:  *     defined by the UI.
danielebarchiesi@0:  *   - keyword: The keyword used for this argument for substitutions.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @param $arg
danielebarchiesi@0:  *   The actual argument received. This is expected to be a string from a URL but
danielebarchiesi@0:  *   this does not have to be the only source of arguments.
danielebarchiesi@0:  * @param $empty
danielebarchiesi@0:  *   If true, the $arg will not be used to load the context. Instead, an empty
danielebarchiesi@0:  *   placeholder context will be loaded.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @return
danielebarchiesi@0:  *   A context object if one can be loaded.
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_context_get_context_from_argument($argument, $arg, $empty = FALSE) {
danielebarchiesi@0:   ctools_include('plugins');
danielebarchiesi@0:   if (empty($argument['name'])) {
danielebarchiesi@0:     return;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   if ($function = ctools_plugin_load_function('ctools', 'arguments', $argument['name'], 'context')) {
danielebarchiesi@0:     // Backward compatibility: Merge old style settings into new style:
danielebarchiesi@0:     if (!empty($argument['settings'])) {
danielebarchiesi@0:       $argument += $argument['settings'];
danielebarchiesi@0:       unset($argument['settings']);
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     $context = $function($arg, $argument, $empty);
danielebarchiesi@0: 
danielebarchiesi@0:     if (is_object($context)) {
danielebarchiesi@0:       $context->identifier = $argument['identifier'];
danielebarchiesi@0:       $context->page_title = isset($argument['title']) ? $argument['title'] : '';
danielebarchiesi@0:       $context->keyword    = $argument['keyword'];
danielebarchiesi@0:       $context->id         = ctools_context_id($argument, 'argument');
danielebarchiesi@0:       $context->original_argument = $arg;
danielebarchiesi@0: 
danielebarchiesi@0:       if (!empty($context->empty)) {
danielebarchiesi@0:         $context->placeholder = array(
danielebarchiesi@0:           'type' => 'argument',
danielebarchiesi@0:           'conf' => $argument,
danielebarchiesi@0:         );
danielebarchiesi@0:       }
danielebarchiesi@0:     }
danielebarchiesi@0:     return $context;
danielebarchiesi@0:   }
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Retrieve a list of empty contexts for all arguments.
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_context_get_placeholders_from_argument($arguments) {
danielebarchiesi@0:   $contexts = array();
danielebarchiesi@0:   foreach ($arguments as $argument) {
danielebarchiesi@0:     $context = ctools_context_get_context_from_argument($argument, NULL, TRUE);
danielebarchiesi@0:     if ($context) {
danielebarchiesi@0:       $contexts[ctools_context_id($argument, 'argument')] = $context;
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0:   return $contexts;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Load the contexts for a given list of arguments.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @param $arguments
danielebarchiesi@0:  *   The array of argument definitions.
danielebarchiesi@0:  * @param &$contexts
danielebarchiesi@0:  *   The array of existing contexts. New contexts will be added to this array.
danielebarchiesi@0:  * @param $args
danielebarchiesi@0:  *   The arguments to load.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @return
danielebarchiesi@0:  *   FALSE if an argument wants to 404.
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_context_get_context_from_arguments($arguments, &$contexts, $args) {
danielebarchiesi@0:   foreach ($arguments as $argument) {
danielebarchiesi@0:     // pull the argument off the list.
danielebarchiesi@0:     $arg = array_shift($args);
danielebarchiesi@0:     $id = ctools_context_id($argument, 'argument');
danielebarchiesi@0: 
danielebarchiesi@0:     // For % arguments embedded in the URL, our context is already loaded.
danielebarchiesi@0:     // There is no need to go and load it again.
danielebarchiesi@0:     if (empty($contexts[$id])) {
danielebarchiesi@0:       if ($context = ctools_context_get_context_from_argument($argument, $arg)) {
danielebarchiesi@0:         $contexts[$id] = $context;
danielebarchiesi@0:       }
danielebarchiesi@0:     }
danielebarchiesi@0:     else {
danielebarchiesi@0:       $context = $contexts[$id];
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     if ((empty($context) || empty($context->data)) && !empty($argument['default']) && $argument['default'] == '404') {
danielebarchiesi@0:       return FALSE;
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0:   return TRUE;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: // ---------------------------------------------------------------------------
danielebarchiesi@0: // Functions related to contexts from relationships.
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Fetch metadata on a specific relationship plugin.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @param $content type
danielebarchiesi@0:  *   Name of a panel content type.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @return
danielebarchiesi@0:  *   An array with information about the requested relationship.
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_get_relationship($relationship) {
danielebarchiesi@0:   ctools_include('plugins');
danielebarchiesi@0:   return ctools_get_plugins('ctools', 'relationships', $relationship);
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Fetch metadata for all relationship plugins.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @return
danielebarchiesi@0:  *   An array of arrays with information about all available relationships.
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_get_relationships() {
danielebarchiesi@0:   ctools_include('plugins');
danielebarchiesi@0:   return ctools_get_plugins('ctools', 'relationships');
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  *
danielebarchiesi@0:  * @param $relationship
danielebarchiesi@0:  *   The configuration of a relationship. It must contain the following data:
danielebarchiesi@0:  *   - name: The name of the relationship plugin being used.
danielebarchiesi@0:  *   - relationship_settings: The configuration based upon the plugin forms.
danielebarchiesi@0:  *   - identifier: The human readable identifier for this relationship, usually
danielebarchiesi@0:  *     defined by the UI.
danielebarchiesi@0:  *   - keyword: The keyword used for this relationship for substitutions.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @param $source_context
danielebarchiesi@0:  *   The context this relationship is based upon.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @param $placeholders
danielebarchiesi@0:  *   If TRUE, placeholders are acceptable.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @return
danielebarchiesi@0:  *   A context object if one can be loaded.
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_context_get_context_from_relationship($relationship, $source_context, $placeholders = FALSE) {
danielebarchiesi@0:   ctools_include('plugins');
danielebarchiesi@0:   if ($function = ctools_plugin_load_function('ctools', 'relationships', $relationship['name'], 'context')) {
danielebarchiesi@0:     // Backward compatibility: Merge old style settings into new style:
danielebarchiesi@0:     if (!empty($relationship['relationship_settings'])) {
danielebarchiesi@0:       $relationship += $relationship['relationship_settings'];
danielebarchiesi@0:       unset($relationship['relationship_settings']);
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     $context = $function($source_context, $relationship, $placeholders);
danielebarchiesi@0:     if ($context) {
danielebarchiesi@0:       $context->identifier = $relationship['identifier'];
danielebarchiesi@0:       $context->page_title = isset($relationship['title']) ? $relationship['title'] : '';
danielebarchiesi@0:       $context->keyword    = $relationship['keyword'];
danielebarchiesi@0:       if (!empty($context->empty)) {
danielebarchiesi@0:         $context->placeholder = array(
danielebarchiesi@0:           'type' => 'relationship',
danielebarchiesi@0:           'conf' => $relationship,
danielebarchiesi@0:         );
danielebarchiesi@0:       }
danielebarchiesi@0:       return $context;
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Fetch all relevant relationships.
danielebarchiesi@0:  *
danielebarchiesi@0:  * Relevant relationships are any relationship that can be created based upon
danielebarchiesi@0:  * the list of existing contexts. For example, the 'node author' relationship
danielebarchiesi@0:  * is relevant if there is a 'node' context, but makes no sense if there is
danielebarchiesi@0:  * not one.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @param $contexts
danielebarchiesi@0:  *   An array of contexts used to figure out which relationships are relevant.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @return
danielebarchiesi@0:  *   An array of relationship keys that are relevant for the given set of
danielebarchiesi@0:  *   contexts.
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_context_get_relevant_relationships($contexts) {
danielebarchiesi@0:   $relevant = array();
danielebarchiesi@0:   $relationships = ctools_get_relationships();
danielebarchiesi@0: 
danielebarchiesi@0:   // Go through each relationship
danielebarchiesi@0:   foreach ($relationships as $rid => $relationship) {
danielebarchiesi@0:     // For each relationship, see if there is a context that satisfies it.
danielebarchiesi@0:     if (empty($relationship['no ui']) && ctools_context_filter($contexts, $relationship['required context'])) {
danielebarchiesi@0:       $relevant[$rid] = $relationship['title'];
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   return $relevant;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Fetch all active relationships
danielebarchiesi@0:  *
danielebarchiesi@0:  * @param $relationships
danielebarchiesi@0:  *   An keyed array of relationship data including:
danielebarchiesi@0:  *   - name: name of relationship
danielebarchiesi@0:  *   - context: context id relationship belongs to. This will be used to
danielebarchiesi@0:  *     identify which context in the $contexts array to use to create the
danielebarchiesi@0:  *     relationship context.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @param $contexts
danielebarchiesi@0:  *   A keyed array of contexts used to figure out which relationships
danielebarchiesi@0:  *   are relevant. New contexts will be added to this.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @param $placeholders
danielebarchiesi@0:  *   If TRUE, placeholders are acceptable.
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_context_get_context_from_relationships($relationships, &$contexts, $placeholders = FALSE) {
danielebarchiesi@0:   $return = array();
danielebarchiesi@0: 
danielebarchiesi@0:   foreach ($relationships as $rdata) {
danielebarchiesi@0:     if (!isset($rdata['context'])) {
danielebarchiesi@0:       continue;
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     if (is_array($rdata['context'])) {
danielebarchiesi@0:       $rcontexts = array();
danielebarchiesi@0:       foreach ($rdata['context'] as $cid) {
danielebarchiesi@0:         if (empty($contexts[$cid])) {
danielebarchiesi@0:           continue 2;
danielebarchiesi@0:         }
danielebarchiesi@0:         $rcontexts[] = $contexts[$cid];
danielebarchiesi@0:       }
danielebarchiesi@0:     }
danielebarchiesi@0:     else {
danielebarchiesi@0:       if (empty($contexts[$rdata['context']])) {
danielebarchiesi@0:         continue;
danielebarchiesi@0:       }
danielebarchiesi@0:       $rcontexts = $contexts[$rdata['context']];
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     $cid = ctools_context_id($rdata, 'relationship');
danielebarchiesi@0:     if ($context = ctools_context_get_context_from_relationship($rdata, $rcontexts)) {
danielebarchiesi@0:       $contexts[$cid] = $context;
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: // ---------------------------------------------------------------------------
danielebarchiesi@0: // Functions related to loading contexts from simple context definitions.
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Fetch metadata on a specific context plugin.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @param $context
danielebarchiesi@0:  *   Name of a context.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @return
danielebarchiesi@0:  *   An array with information about the requested panel context.
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_get_context($context) {
danielebarchiesi@0:   static $gate = array();
danielebarchiesi@0:   ctools_include('plugins');
danielebarchiesi@0:   $plugin = ctools_get_plugins('ctools', 'contexts', $context);
danielebarchiesi@0:   if (empty($gate['context']) && !empty($plugin['superceded by'])) {
danielebarchiesi@0:     // This gate prevents infinite loops.
danielebarchiesi@0:     $gate[$context] = TRUE;
danielebarchiesi@0:     $new_plugin = ctools_get_plugins('ctools', 'contexts', $plugin['superceded by']);
danielebarchiesi@0:     $gate[$context] = FALSE;
danielebarchiesi@0: 
danielebarchiesi@0:     // If a new plugin was returned, return it. Otherwise fall through and
danielebarchiesi@0:     // return the original we fetched.
danielebarchiesi@0:     if ($new_plugin) {
danielebarchiesi@0:       return $new_plugin;
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   return $plugin;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Fetch metadata for all context plugins.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @return
danielebarchiesi@0:  *   An array of arrays with information about all available panel contexts.
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_get_contexts() {
danielebarchiesi@0:   ctools_include('plugins');
danielebarchiesi@0:   return ctools_get_plugins('ctools', 'contexts');
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  *
danielebarchiesi@0:  * @param $context
danielebarchiesi@0:  *   The configuration of a context. It must contain the following data:
danielebarchiesi@0:  *   - name: The name of the context plugin being used.
danielebarchiesi@0:  *   - context_settings: The configuration based upon the plugin forms.
danielebarchiesi@0:  *   - identifier: The human readable identifier for this context, usually
danielebarchiesi@0:  *     defined by the UI.
danielebarchiesi@0:  *   - keyword: The keyword used for this context for substitutions.
danielebarchiesi@0:  * @param $type
danielebarchiesi@0:  *   This is either 'context' which indicates the context will be loaded
danielebarchiesi@0:  *   from data in the settings, or 'required_context' which means the
danielebarchiesi@0:  *   context must be acquired from an external source. This is the method
danielebarchiesi@0:  *   used to pass pure contexts from one system to another.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @return
danielebarchiesi@0:  *   A context object if one can be loaded.
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_context_get_context_from_context($context, $type = 'context', $argument = NULL) {
danielebarchiesi@0:   ctools_include('plugins');
danielebarchiesi@0:   $plugin = ctools_get_context($context['name']);
danielebarchiesi@0:   if ($function = ctools_plugin_get_function($plugin, 'context')) {
danielebarchiesi@0:     // Backward compatibility: Merge old style settings into new style:
danielebarchiesi@0:     if (!empty($context['context_settings'])) {
danielebarchiesi@0:       $context += $context['context_settings'];
danielebarchiesi@0:       unset($context['context_settings']);
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     if (isset($argument) && isset($plugin['placeholder name'])) {
danielebarchiesi@0:       $context[$plugin['placeholder name']] = $argument;
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     $return = $function($type == 'requiredcontext', $context, TRUE, $plugin);
danielebarchiesi@0:     if ($return) {
danielebarchiesi@0:       $return->identifier = $context['identifier'];
danielebarchiesi@0:       $return->page_title = isset($context['title']) ? $context['title'] : '';
danielebarchiesi@0:       $return->keyword    = $context['keyword'];
danielebarchiesi@0: 
danielebarchiesi@0:       if (!empty($context->empty)) {
danielebarchiesi@0:         $context->placeholder = array(
danielebarchiesi@0:           'type' => 'context',
danielebarchiesi@0:           'conf' => $context,
danielebarchiesi@0:         );
danielebarchiesi@0:       }
danielebarchiesi@0: 
danielebarchiesi@0:       return $return;
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Retrieve a list of base contexts based upon a simple 'contexts' definition.
danielebarchiesi@0:  *
danielebarchiesi@0:  * For required contexts this will always retrieve placeholders.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @param $contexts
danielebarchiesi@0:  *   The list of contexts defined in the UI.
danielebarchiesi@0:  * @param $type
danielebarchiesi@0:  *   Either 'context' or 'requiredcontext', which indicates whether the contexts
danielebarchiesi@0:  *   are loaded from internal data or copied from an external source.
danielebarchiesi@0:  * @param $placeholders
danielebarchiesi@0:  *   If true, placeholders are acceptable.
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_context_get_context_from_contexts($contexts, $type = 'context', $placeholders = FALSE) {
danielebarchiesi@0:   $return = array();
danielebarchiesi@0:   foreach ($contexts as $context) {
danielebarchiesi@0:     $ctext = ctools_context_get_context_from_context($context, $type);
danielebarchiesi@0:     if ($ctext) {
danielebarchiesi@0:       if ($placeholders) {
danielebarchiesi@0:         $ctext->placeholder = TRUE;
danielebarchiesi@0:       }
danielebarchiesi@0:       $return[ctools_context_id($context, $type)] = $ctext;
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0:   return $return;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Match up external contexts to our required contexts.
danielebarchiesi@0:  *
danielebarchiesi@0:  * This function is used to create a list of contexts with proper
danielebarchiesi@0:  * IDs based upon a list of required contexts.
danielebarchiesi@0:  *
danielebarchiesi@0:  * These contexts passed in should match the numeric positions of the
danielebarchiesi@0:  * required contexts. The caller must ensure this has already happened
danielebarchiesi@0:  * correctly as this function will not detect errors here.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @param $required
danielebarchiesi@0:  *   A list of required contexts as defined by the UI.
danielebarchiesi@0:  * @param $contexts
danielebarchiesi@0:  *   A list of matching contexts as passed in from the calling system.
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_context_match_required_contexts($required, $contexts) {
danielebarchiesi@0:   $return = array();
danielebarchiesi@0:   if (!is_array($required)) {
danielebarchiesi@0:     return $return;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   foreach ($required as $r) {
danielebarchiesi@0:     $context = clone(array_shift($contexts));
danielebarchiesi@0:     $context->identifier = $r['identifier'];
danielebarchiesi@0:     $context->page_title = isset($r['title']) ? $r['title'] : '';
danielebarchiesi@0:     $context->keyword    = $r['keyword'];
danielebarchiesi@0:     $return[ctools_context_id($r, 'requiredcontext')] = $context;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   return $return;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Load a full array of contexts for an object.
danielebarchiesi@0:  *
danielebarchiesi@0:  * Not all of the types need to be supported by this object.
danielebarchiesi@0:  *
danielebarchiesi@0:  * This function is not used to load contexts from external data, but may
danielebarchiesi@0:  * be used to load internal contexts and relationships. Otherwise it can also
danielebarchiesi@0:  * be used to generate a full set of placeholders for UI purposes.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @param $object
danielebarchiesi@0:  *   An object that contains some or all of the following variables:
danielebarchiesi@0:  *
danielebarchiesi@0:  * - requiredcontexts: A list of UI configured contexts that are required
danielebarchiesi@0:  *   from an external source. Since these require external data, they will
danielebarchiesi@0:  *   only be added if $placeholders is set to TRUE, and empty contexts will
danielebarchiesi@0:  *   be created.
danielebarchiesi@0:  * - arguments: A list of UI configured arguments that will create contexts.
danielebarchiesi@0:  *   Since these require external data, they will only be added if $placeholders
danielebarchiesi@0:  *   is set to TRUE.
danielebarchiesi@0:  * - contexts: A list of UI configured contexts that have no external source,
danielebarchiesi@0:  *   and are essentially hardcoded. For example, these might configure a
danielebarchiesi@0:  *   particular node or a particular taxonomy term.
danielebarchiesi@0:  * - relationships: A list of UI configured contexts to be derived from other
danielebarchiesi@0:  *   contexts that already exist from other sources. For example, these might
danielebarchiesi@0:  *   be used to get a user object from a node via the node author relationship.
danielebarchiesi@0:  * @param $placeholders
danielebarchiesi@0:  *   If TRUE, this will generate placeholder objects for types this function
danielebarchiesi@0:  *   cannot load.
danielebarchiesi@0:  * @param $contexts
danielebarchiesi@0:  *   An array of pre-existing contexts that will be part of the return value.
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_context_load_contexts($object, $placeholders = TRUE, $contexts = array()) {
danielebarchiesi@0:   if (!empty($object->base_contexts)) {
danielebarchiesi@0:     $contexts += $object->base_contexts;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   if ($placeholders) {
danielebarchiesi@0:     // This will load empty contexts as placeholders for arguments that come
danielebarchiesi@0:     // from external sources. If this isn't set, it's assumed these context
danielebarchiesi@0:     // will already have been matched up and loaded.
danielebarchiesi@0:     if (!empty($object->requiredcontexts) && is_array($object->requiredcontexts)) {
danielebarchiesi@0:       $contexts += ctools_context_get_context_from_contexts($object->requiredcontexts, 'requiredcontext', $placeholders);
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     if (!empty($object->arguments) && is_array($object->arguments)) {
danielebarchiesi@0:       $contexts += ctools_context_get_placeholders_from_argument($object->arguments);
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   if (!empty($object->contexts) && is_array($object->contexts)) {
danielebarchiesi@0:     $contexts += ctools_context_get_context_from_contexts($object->contexts, 'context', $placeholders);
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   // add contexts from relationships
danielebarchiesi@0:   if (!empty($object->relationships) && is_array($object->relationships)) {
danielebarchiesi@0:     ctools_context_get_context_from_relationships($object->relationships, $contexts, $placeholders);
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   return $contexts;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Return the first context with a form id from a list of contexts.
danielebarchiesi@0:  *
danielebarchiesi@0:  * This function is used to figure out which contexts represents 'the form'
danielebarchiesi@0:  * from a list of contexts. Only one contexts can actually be 'the form' for
danielebarchiesi@0:  * a given page, since the @code{<form>} tag can not be embedded within
danielebarchiesi@0:  * itself.
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_context_get_form($contexts) {
danielebarchiesi@0:   if (!empty($contexts)) {
danielebarchiesi@0:     foreach ($contexts as $id => $context) {
danielebarchiesi@0:       // if a form shows its id as being a 'required context' that means the
danielebarchiesi@0:       // the context is external to this display and does not count.
danielebarchiesi@0:       if (!empty($context->form_id) && substr($id, 0, 15) != 'requiredcontext') {
danielebarchiesi@0:         return $context;
danielebarchiesi@0:       }
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Replace placeholders with real contexts using data extracted from a form
danielebarchiesi@0:  * for the purposes of previews.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @param $contexts
danielebarchiesi@0:  *   All of the contexts, including the placeholders.
danielebarchiesi@0:  * @param $arguments
danielebarchiesi@0:  *   The arguments. These will be acquired from $form_state['values'] and the
danielebarchiesi@0:  *   keys must match the context IDs.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @return
danielebarchiesi@0:  *   A new $contexts array containing the replaced contexts. Not all contexts
danielebarchiesi@0:  *   may be replaced if, for example, an argument was unable to be converted
danielebarchiesi@0:  *   into a context.
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_context_replace_placeholders($contexts, $arguments) {
danielebarchiesi@0:   foreach ($contexts as $cid => $context) {
danielebarchiesi@0:     if (empty($context->empty)) {
danielebarchiesi@0:       continue;
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     $new_context = NULL;
danielebarchiesi@0:     switch ($context->placeholder['type']) {
danielebarchiesi@0:       case 'relationship':
danielebarchiesi@0:         $relationship = $context->placeholder['conf'];
danielebarchiesi@0:         if (isset($contexts[$relationship['context']])) {
danielebarchiesi@0:           $new_context = ctools_context_get_context_from_relationship($relationship, $contexts[$relationship['context']]);
danielebarchiesi@0:         }
danielebarchiesi@0:         break;
danielebarchiesi@0:       case 'argument':
danielebarchiesi@0:         if (isset($arguments[$cid]) && $arguments[$cid] !== '') {
danielebarchiesi@0:           $argument = $context->placeholder['conf'];
danielebarchiesi@0:           $new_context = ctools_context_get_context_from_argument($argument, $arguments[$cid]);
danielebarchiesi@0:         }
danielebarchiesi@0:         break;
danielebarchiesi@0:       case 'context':
danielebarchiesi@0:         if (!empty($arguments[$cid])) {
danielebarchiesi@0:           $context_info = $context->placeholder['conf'];
danielebarchiesi@0:           $new_context = ctools_context_get_context_from_context($context_info, 'requiredcontext', $arguments[$cid]);
danielebarchiesi@0:         }
danielebarchiesi@0:         break;
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     if ($new_context && empty($new_context->empty)) {
danielebarchiesi@0:       $contexts[$cid] = $new_context;
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   return $contexts;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Provide a form array for getting data to replace placeholder contexts
danielebarchiesi@0:  * with real data.
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_context_replace_form(&$form, $contexts) {
danielebarchiesi@0:   foreach ($contexts as $cid => $context) {
danielebarchiesi@0:     if (empty($context->empty)) {
danielebarchiesi@0:       continue;
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     // Get plugin info from the context which should have been set when the
danielebarchiesi@0:     // empty context was created.
danielebarchiesi@0:     $info = NULL;
danielebarchiesi@0:     $plugin = NULL;
danielebarchiesi@0:     $settings = NULL;
danielebarchiesi@0:     switch ($context->placeholder['type']) {
danielebarchiesi@0:       case 'argument':
danielebarchiesi@0:         $info = $context->placeholder['conf'];
danielebarchiesi@0:         $plugin = ctools_get_argument($info['name']);
danielebarchiesi@0:         break;
danielebarchiesi@0: 
danielebarchiesi@0:       case 'context':
danielebarchiesi@0:         $info = $context->placeholder['conf'];
danielebarchiesi@0:         $plugin = ctools_get_context($info['name']);
danielebarchiesi@0:         break;
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     // Ask the plugin where the form is.
danielebarchiesi@0:     if ($plugin && isset($plugin['placeholder form'])) {
danielebarchiesi@0:       if (is_array($plugin['placeholder form'])) {
danielebarchiesi@0:         $form[$cid] = $plugin['placeholder form'];
danielebarchiesi@0:       }
danielebarchiesi@0:       else if (function_exists($plugin['placeholder form'])) {
danielebarchiesi@0:         $widget = $plugin['placeholder form']($info);
danielebarchiesi@0:         if ($widget) {
danielebarchiesi@0:           $form[$cid] = $widget;
danielebarchiesi@0:         }
danielebarchiesi@0:       }
danielebarchiesi@0: 
danielebarchiesi@0:       if (!empty($form[$cid])) {
danielebarchiesi@0:         $form[$cid]['#title'] = t('@identifier (@keyword)', array('@keyword' => '%' . $context->keyword, '@identifier' => $context->identifier));
danielebarchiesi@0:       }
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: // ---------------------------------------------------------------------------
danielebarchiesi@0: // Functions related to loading access control plugins
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Fetch metadata on a specific access control plugin.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @param $name
danielebarchiesi@0:  *   Name of a plugin.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @return
danielebarchiesi@0:  *   An array with information about the requested access control plugin.
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_get_access_plugin($name) {
danielebarchiesi@0:   ctools_include('plugins');
danielebarchiesi@0:   return ctools_get_plugins('ctools', 'access', $name);
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Fetch metadata for all access control plugins.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @return
danielebarchiesi@0:  *   An array of arrays with information about all available access control plugins.
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_get_access_plugins() {
danielebarchiesi@0:   ctools_include('plugins');
danielebarchiesi@0:   return ctools_get_plugins('ctools', 'access');
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Fetch a list of access plugins that are available for a given list of
danielebarchiesi@0:  * contexts.
danielebarchiesi@0:  *
danielebarchiesi@0:  * if 'logged-in-user' is not in the list of contexts, it will be added as
danielebarchiesi@0:  * this is required.
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_get_relevant_access_plugins($contexts) {
danielebarchiesi@0:   if (!isset($contexts['logged-in-user'])) {
danielebarchiesi@0:     $contexts['logged-in-user'] = ctools_access_get_loggedin_context();
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   $all_plugins = ctools_get_access_plugins();
danielebarchiesi@0:   $plugins = array();
danielebarchiesi@0:   foreach ($all_plugins as $id => $plugin) {
danielebarchiesi@0:     if (!empty($plugin['required context']) && !ctools_context_match_requirements($contexts, $plugin['required context'])) {
danielebarchiesi@0:       continue;
danielebarchiesi@0:     }
danielebarchiesi@0:     $plugins[$id] = $plugin;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   return $plugins;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Create a context for the logged in user.
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_access_get_loggedin_context() {
danielebarchiesi@0:   global $user;
danielebarchiesi@0:   $context = ctools_context_create('entity:user', $user);
danielebarchiesi@0:   $context->identifier = t('Logged in user');
danielebarchiesi@0:   $context->keyword    = 'viewer';
danielebarchiesi@0:   $context->id         = 0;
danielebarchiesi@0: 
danielebarchiesi@0:   return $context;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Get a summary of an access plugin's settings.
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_access_summary($plugin, $contexts, $test) {
danielebarchiesi@0:   if (!isset($contexts['logged-in-user'])) {
danielebarchiesi@0:     $contexts['logged-in-user'] = ctools_access_get_loggedin_context();
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   $description = '';
danielebarchiesi@0:   if ($function = ctools_plugin_get_function($plugin, 'summary')) {
danielebarchiesi@0:     $required_context = isset($plugin['required context']) ? $plugin['required context'] : array();
danielebarchiesi@0:     $context          = isset($test['context']) ? $test['context'] : array();
danielebarchiesi@0:     $description      = $function($test['settings'], ctools_context_select($contexts, $required_context, $context), $plugin);
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   if (!empty($test['not'])) {
danielebarchiesi@0:     $description = "NOT ($description)";
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   return $description;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Get a summary of a group of access plugin's settings.
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_access_group_summary($access, $contexts) {
danielebarchiesi@0:   if (empty($access['plugins'])) {
danielebarchiesi@0:     return;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   $descriptions = array();
danielebarchiesi@0:   foreach ($access['plugins'] as $id => $test) {
danielebarchiesi@0:     $plugin = ctools_get_access_plugin($test['name']);
danielebarchiesi@0:     $descriptions[] = ctools_access_summary($plugin, $contexts, $test);
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   $separator = (isset($access['logic']) && $access['logic'] == 'and') ? t(', and ') : t(', or ');
danielebarchiesi@0:   return implode($separator, $descriptions);
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Determine if the current user has access via  plugin.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @param $settings
danielebarchiesi@0:  *   An array of settings theoretically set by the user.
danielebarchiesi@0:  * @param $contexts
danielebarchiesi@0:  *   An array of zero or more contexts that may be used to determine if
danielebarchiesi@0:  *   the user has access.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @return
danielebarchiesi@0:  *   TRUE if access is granted, false if otherwise.
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_access($settings, $contexts = array()) {
danielebarchiesi@0:   if (empty($settings['plugins'])) {
danielebarchiesi@0:     return TRUE;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   if (!isset($settings['logic'])) {
danielebarchiesi@0:     $settings['logic'] = 'and';
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   if (!isset($contexts['logged-in-user'])) {
danielebarchiesi@0:     $contexts['logged-in-user'] = ctools_access_get_loggedin_context();
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   foreach ($settings['plugins'] as $test) {
danielebarchiesi@0:     $pass = FALSE;
danielebarchiesi@0:     $plugin = ctools_get_access_plugin($test['name']);
danielebarchiesi@0:     if ($plugin && $function = ctools_plugin_get_function($plugin, 'callback')) {
danielebarchiesi@0:       // Do we need just some contexts or all of them?
danielebarchiesi@0:       if (!empty($plugin['all contexts'])) {
danielebarchiesi@0:         $test_contexts = $contexts;
danielebarchiesi@0:       }
danielebarchiesi@0:       else {
danielebarchiesi@0:         $required_context = isset($plugin['required context']) ? $plugin['required context'] : array();
danielebarchiesi@0:         $context = isset($test['context']) ? $test['context'] : array();
danielebarchiesi@0:         $test_contexts = ctools_context_select($contexts, $required_context, $context);
danielebarchiesi@0:       }
danielebarchiesi@0: 
danielebarchiesi@0:       $pass = $function($test['settings'], $test_contexts, $plugin);
danielebarchiesi@0:       if (!empty($test['not'])) {
danielebarchiesi@0:         $pass = !$pass;
danielebarchiesi@0:       }
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     if ($pass && $settings['logic'] == 'or') {
danielebarchiesi@0:       // Pass if 'or' and this rule passed.
danielebarchiesi@0:       return TRUE;
danielebarchiesi@0:     }
danielebarchiesi@0:     else if (!$pass && $settings['logic'] == 'and') {
danielebarchiesi@0:       // Fail if 'and' and htis rule failed.
danielebarchiesi@0:       return FALSE;
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   // Return TRUE if logic was and, meaning all rules passed.
danielebarchiesi@0:   // Return FALSE if logic was or, meaning no rule passed.
danielebarchiesi@0:   return $settings['logic'] == 'and';
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Create default settings for a new access plugin.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @param $plugin
danielebarchiesi@0:  *   The access plugin being used.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @return
danielebarchiesi@0:  *   A default configured test that should be placed in $access['plugins'];
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_access_new_test($plugin) {
danielebarchiesi@0:   $test = array(
danielebarchiesi@0:     'name' => $plugin['name'],
danielebarchiesi@0:     'settings' => array(),
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   // Set up required context defaults.
danielebarchiesi@0:   if (isset($plugin['required context'])) {
danielebarchiesi@0:     if (is_object($plugin['required context'])) {
danielebarchiesi@0:       $test['context'] = '';
danielebarchiesi@0:     }
danielebarchiesi@0:     else {
danielebarchiesi@0:       $test['context'] = array();
danielebarchiesi@0:       foreach ($plugin['required context'] as $required) {
danielebarchiesi@0:         $test['context'][] = '';
danielebarchiesi@0:       }
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0: 
danielebarchiesi@0:   $default = NULL;
danielebarchiesi@0:   if (isset($plugin['default'])) {
danielebarchiesi@0:     $default = $plugin['default'];
danielebarchiesi@0:   }
danielebarchiesi@0:   elseif (isset($plugin['defaults'])) {
danielebarchiesi@0:     $default = $plugin['defaults'];
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   // Setup plugin defaults.
danielebarchiesi@0:   if (isset($default)) {
danielebarchiesi@0:     if (is_array($default)) {
danielebarchiesi@0:       $test['settings'] = $default;
danielebarchiesi@0:     }
danielebarchiesi@0:     else if (function_exists($default)) {
danielebarchiesi@0:       $test['settings'] = $default();
danielebarchiesi@0:     }
danielebarchiesi@0:     else {
danielebarchiesi@0:       $test['settings'] = array();
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   return $test;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Apply restrictions to contexts based upon the access control configured.
danielebarchiesi@0:  *
danielebarchiesi@0:  * These restrictions allow the UI to not show content that may not
danielebarchiesi@0:  * be relevant to all types of a particular context.
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_access_add_restrictions($settings, $contexts) {
danielebarchiesi@0:   if (empty($settings['plugins'])) {
danielebarchiesi@0:     return;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   if (!isset($settings['logic'])) {
danielebarchiesi@0:     $settings['logic'] = 'and';
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   // We're not going to try to figure out restrictions on the or.
danielebarchiesi@0:   if ($settings['logic'] == 'or' && count($settings['plugins']) > 1) {
danielebarchiesi@0:     return;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   foreach ($settings['plugins'] as $test) {
danielebarchiesi@0:     $plugin = ctools_get_access_plugin($test['name']);
danielebarchiesi@0:     if ($plugin && $function = ctools_plugin_get_function($plugin, 'restrictions')) {
danielebarchiesi@0:       $required_context = isset($plugin['required context']) ? $plugin['required context'] : array();
danielebarchiesi@0:       $context = isset($test['context']) ? $test['context'] : array();
danielebarchiesi@0:       $contexts = ctools_context_select($contexts, $required_context, $context);
danielebarchiesi@0:       $function($test['settings'], $contexts);
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: }