danielebarchiesi@0: <?php
danielebarchiesi@0: /**
danielebarchiesi@0:  * @file
danielebarchiesi@0:  * Plugin to provide access control based upon a parent term.
danielebarchiesi@0:  */
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Plugins are described by creating a $plugin array which will be used
danielebarchiesi@0:  * by the system that includes this file.
danielebarchiesi@0:  */
danielebarchiesi@0: $plugin = array(
danielebarchiesi@0:   'title' => t("Taxonomy: term has parent(s)"),
danielebarchiesi@0:   'description' => t('Control access if a term belongs to a specific parent term.'),
danielebarchiesi@0:   'callback' => 'ctools_term_has_parent_ctools_access_check',
danielebarchiesi@0:   'default' => array('vid' => array(), 'negate' => 0),
danielebarchiesi@0:   'settings form' => 'ctools_term_has_parent_ctools_access_settings',
danielebarchiesi@0:   'settings form submit' => 'ctools_term_has_parent_ctools_access_settings_submit',
danielebarchiesi@0:   'summary' => 'ctools_term_has_parent_ctools_access_summary',
danielebarchiesi@0:   'required context' => new ctools_context_required(t('Term'), array('taxonomy_term', 'terms')),
danielebarchiesi@0: );
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Settings form for the 'by parent term' access plugin
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_term_has_parent_ctools_access_settings($form, &$form_state, $conf) {
danielebarchiesi@0:   // If no configuration was saved before, set some defaults.
danielebarchiesi@0:   if (empty($conf)) {
danielebarchiesi@0:     $conf = array(
danielebarchiesi@0:       'vid' => 0,
danielebarchiesi@0:     );
danielebarchiesi@0:   }
danielebarchiesi@0:   if (!isset($conf['vid'])) {
danielebarchiesi@0:     $conf['vid'] = 0;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   $form['settings']['vid'] = array(
danielebarchiesi@0:     '#title' => t('Vocabulary'),
danielebarchiesi@0:     '#type' => 'select',
danielebarchiesi@0:     '#options' => array(),
danielebarchiesi@0:     '#description' => t('Select the vocabulary for this form.'),
danielebarchiesi@0:     '#id' => 'ctools-select-vid',
danielebarchiesi@0:     '#default_value' => $conf['vid'],
danielebarchiesi@0:     '#required' => TRUE,
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   ctools_include('dependent');
danielebarchiesi@0:   $options = array();
danielebarchiesi@0: 
danielebarchiesi@0:   // A note: Dependency works strangely on these forms as they have never been
danielebarchiesi@0:   // updated to a more modern system so they are not individual forms of their
danielebarchiesi@0:   // own like the content types.
danielebarchiesi@0: 
danielebarchiesi@0:   $form['settings']['#tree'] = TRUE;
danielebarchiesi@0: 
danielebarchiesi@0:   // Loop over each of the configured vocabularies.
danielebarchiesi@0:   foreach (taxonomy_get_vocabularies() as $vid => $vocabulary) {
danielebarchiesi@0:     $options[$vid] = $vocabulary->name;
danielebarchiesi@0:     $form['settings']['vid_' . $vid] = array(
danielebarchiesi@0:       '#title' => t('Terms'),
danielebarchiesi@0:       '#description' => t('Select a term or terms from @vocabulary.', array('@vocabulary' => $vocabulary->name)),
danielebarchiesi@0:       '#dependency' => array('ctools-select-vid' => array($vocabulary->vid)),
danielebarchiesi@0:       '#default_value' => !empty($conf['vid_' . $vid]) ? $conf['vid_' . $vid] : '',
danielebarchiesi@0:       '#size' => 10,
danielebarchiesi@0:       '#multiple' => TRUE,
danielebarchiesi@0:       //@todo: Remove the following workaround when the following patch is in core. {@see:http://drupal.org/node/1117526}
danielebarchiesi@0:       '#name' => sprintf("settings[%u][]", $vid),
danielebarchiesi@0:       '#attributes' => array('multiple' => 'multiple'),
danielebarchiesi@0:     );
danielebarchiesi@0: 
danielebarchiesi@0:     $terms = array();
danielebarchiesi@0:     foreach (taxonomy_get_tree($vocabulary->vid) as $term) {
danielebarchiesi@0:       $terms[$term->tid] = str_repeat('-', $term->depth) . ($term->depth ? ' ' : '') . $term->name;
danielebarchiesi@0:     }
danielebarchiesi@0:     //$form['settings']['vid_' . $vid]['#type'] = 'select';
danielebarchiesi@0:     $form['settings']['vid_' . $vid]['#type'] = 'checkboxes';
danielebarchiesi@0:     $form['settings']['vid_' . $vid]['#options'] = $terms;
danielebarchiesi@0:     unset($terms);
danielebarchiesi@0:   }
danielebarchiesi@0:   $form['settings']['vid']['#options'] = $options;
danielebarchiesi@0:   $form['settings']['include_self'] = array(
danielebarchiesi@0:     '#title' => t('Include these term(s) as candidates?'),
danielebarchiesi@0:     '#description' => t('When this rule is evaluated, should the term(s) you select be included as candidates for access?'),
danielebarchiesi@0:     '#default_value' => !empty($conf['include_self']) ? $conf['include_self'] : FALSE,
danielebarchiesi@0:     '#type' => 'checkbox',
danielebarchiesi@0:   );
danielebarchiesi@0:   return $form;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Filters values to store less.
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_term_has_parent_ctools_access_settings_submit($form, &$form_state) {
danielebarchiesi@0:   foreach ($form_state['values']['settings'] as $key => $value) {
danielebarchiesi@0:     if (strpos($key, 'vid_') === 0) {
danielebarchiesi@0:       $form_state['values']['settings'][$key] = array_filter($form_state['values']['settings'][$key]);
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Check for access.
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_term_has_parent_ctools_access_check($conf, $context) {
danielebarchiesi@0:   // As far as I know there should always be a context at this point, but this
danielebarchiesi@0:   // is safe.
danielebarchiesi@0:   if (empty($context) || empty($context->data) || empty($context->data->vid) || empty($context->data->tid)) {
danielebarchiesi@0:     return FALSE;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   // Get the $vid.
danielebarchiesi@0:   if (!isset($conf['vid'])) {
danielebarchiesi@0:     return FALSE;
danielebarchiesi@0:   }
danielebarchiesi@0:   $vid = $conf['vid'];
danielebarchiesi@0: 
danielebarchiesi@0:   // we'll start looking up the hierarchy from our context term id.
danielebarchiesi@0:   $current_term = $context->data->tid;
danielebarchiesi@0: 
danielebarchiesi@0:   $term='';
danielebarchiesi@0: 
danielebarchiesi@0:   // scan up the tree.
danielebarchiesi@0:   while (true) {
danielebarchiesi@0:     // select parent as term_parent to avoid PHP5 complications with the parent keyword
danielebarchiesi@0:     //@todo: Find a way to reduce the number of queries required for really deep hierarchies.
danielebarchiesi@0:     $term = db_query("SELECT parent AS term_parent, tid AS tid FROM {taxonomy_term_hierarchy} th WHERE th.tid = :tid", array(':tid'=>$current_term))->fetchObject();
danielebarchiesi@0: 
danielebarchiesi@0:     // if no term is found, get out of the loop
danielebarchiesi@0:     if (!$term || empty($term->tid)) {
danielebarchiesi@0:       break;
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     // check the term selected, if the user asked it to.
danielebarchiesi@0:     if (!empty($conf['include_self']) && isset($conf['vid_' . $vid][$term->tid])) {
danielebarchiesi@0:       return TRUE;
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     // did we find the parent TID we were looking for?
danielebarchiesi@0:     if (isset($conf['vid_' . $vid][$term->tid])) {
danielebarchiesi@0:       // YES, we're done!
danielebarchiesi@0:       return TRUE;
danielebarchiesi@0:     }
danielebarchiesi@0:     // Nope, we didn't find it.
danielebarchiesi@0: 
danielebarchiesi@0:     // If this is the top of the hierarchy, stop scanning.
danielebarchiesi@0:     if ($term->term_parent==0) {
danielebarchiesi@0:       break;
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     // update the parent, and keep scanning.
danielebarchiesi@0:     $current_term = $term->term_parent;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   return FALSE;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Provide a summary description based upon the checked terms.
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_term_has_parent_ctools_access_summary($conf, $context) {
danielebarchiesi@0:   $vid = (int)$conf['vid'];
danielebarchiesi@0:   $terms = array();
danielebarchiesi@0:   foreach ($conf['vid_' . $vid] as $tid) {
danielebarchiesi@0:     $term = taxonomy_term_load($tid);
danielebarchiesi@0:     $terms[] = $term->name;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   return format_plural(count($terms),
danielebarchiesi@0:     '@term can have the parent "@terms"',
danielebarchiesi@0:     '@term can have one of these parents: @terms',
danielebarchiesi@0:     array('@terms' => implode(', ', $terms),
danielebarchiesi@0:       '@term' => $context->identifier));
danielebarchiesi@0: }