danielebarchiesi@0: <?php
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * @file
danielebarchiesi@0:  *
danielebarchiesi@0:  * Plugin to provide a node context. A node context is a node wrapped in a
danielebarchiesi@0:  * context object that can be utilized by anything that accepts contexts.
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("Entity"),
danielebarchiesi@0:   'description' => t('Entity object.'),
danielebarchiesi@0:   'context' => 'ctools_context_create_entity',
danielebarchiesi@0:   'edit form' => 'ctools_context_entity_settings_form',
danielebarchiesi@0:   'defaults' => array('entity_id' => ''),
danielebarchiesi@0:   'convert list' => 'ctools_context_entity_convert_list',
danielebarchiesi@0:   'convert' => 'ctools_context_entity_convert',
danielebarchiesi@0:   'placeholder form' => array(
danielebarchiesi@0:     '#type' => 'textfield',
danielebarchiesi@0:     '#description' => t('Enter the ID of an entity for this context.'),
danielebarchiesi@0:   ),
danielebarchiesi@0:   'get child' => 'ctools_context_entity_get_child',
danielebarchiesi@0:   'get children' => 'ctools_context_entity_get_children',
danielebarchiesi@0: );
danielebarchiesi@0: 
danielebarchiesi@0: function ctools_context_entity_get_child($plugin, $parent, $child) {
danielebarchiesi@0:   $plugins = ctools_context_entity_get_children($plugin, $parent);
danielebarchiesi@0:   return $plugins[$parent . ':' . $child];
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: function ctools_context_entity_get_children($plugin, $parent) {
danielebarchiesi@0:   $entities = entity_get_info();
danielebarchiesi@0:   $plugins = array();
danielebarchiesi@0:   foreach ($entities as $entity_type => $entity) {
danielebarchiesi@0:     $child_plugin = $plugin;
danielebarchiesi@0:     $child_plugin['title'] = $entity['label'];
danielebarchiesi@0:     $child_plugin['keyword'] = $entity_type;
danielebarchiesi@0:     $child_plugin['context name'] = $entity_type;
danielebarchiesi@0:     $child_plugin['name'] = $parent . ':' . $entity_type;
danielebarchiesi@0:     $child_plugin['description'] = t('Creates @entity context from an entity ID.', array('@entity' => $entity_type));
danielebarchiesi@0:     $child_plugin_id = $parent . ':' . $entity_type;
danielebarchiesi@0:     drupal_alter('ctools_entity_context', $child_plugin, $entity, $child_plugin_id);
danielebarchiesi@0:     $plugins[$child_plugin_id] = $child_plugin;
danielebarchiesi@0:   }
danielebarchiesi@0:   drupal_alter('ctools_entity_contexts', $plugins);
danielebarchiesi@0:   return $plugins;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * It's important to remember that $conf is optional here, because contexts
danielebarchiesi@0:  * are not always created from the UI.
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_context_create_entity($empty, $data = NULL, $conf = FALSE, $plugin) {
danielebarchiesi@0:   $entity_type = $plugin['keyword'];
danielebarchiesi@0:   $entity = entity_get_info($entity_type);
danielebarchiesi@0:   $context = new ctools_context(array('entity:' . $entity_type, 'entity', $entity_type));
danielebarchiesi@0:   $context->plugin = $plugin['name'];
danielebarchiesi@0:   $context->keyword = $entity_type;
danielebarchiesi@0: 
danielebarchiesi@0:   if ($empty) {
danielebarchiesi@0:     return $context;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   // Attempt to retain compatibility with broken id:
danielebarchiesi@0:   if (is_array($data) && !isset($data['entity_id']) && isset($data['id'])) {
danielebarchiesi@0:     $id = $data['id'];
danielebarchiesi@0:   }
danielebarchiesi@0:   elseif (is_array($data) && isset($data['entity_id'])) {
danielebarchiesi@0:     $id = $data['entity_id'];
danielebarchiesi@0:   }
danielebarchiesi@0:   elseif (is_object($data)) {
danielebarchiesi@0:     $ids = entity_extract_ids($entity_type, $data);
danielebarchiesi@0:     $id = $ids[0];
danielebarchiesi@0:   }
danielebarchiesi@0:   elseif (is_numeric($data)) {
danielebarchiesi@0:     $id = $data;
danielebarchiesi@0:     $data = entity_load($entity_type, array($id));
danielebarchiesi@0:     $data = !empty($data[$id]) ? $data[$id] : FALSE;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   if (is_array($data)) {
danielebarchiesi@0:     $data = entity_load($entity_type, array($id));
danielebarchiesi@0:     $data = !empty($data[$id]) ? $data[$id] : FALSE;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   if (!empty($data)) {
danielebarchiesi@0:     $context->data     = $data;
danielebarchiesi@0:     if (!empty($entity['entity keys']['label'])) {
danielebarchiesi@0:       $context->title    = $data->{$entity['entity keys']['label']};
danielebarchiesi@0:     }
danielebarchiesi@0:     $context->argument = $id;
danielebarchiesi@0: 
danielebarchiesi@0:     if ($entity['entity keys']['bundle']) {
danielebarchiesi@0:       $context->restrictions['type'] = array($data->{$entity['entity keys']['bundle']});
danielebarchiesi@0:     }
danielebarchiesi@0:     return $context;
danielebarchiesi@0:   }
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: function ctools_context_entity_settings_form($form, &$form_state) {
danielebarchiesi@0:   $conf = &$form_state['conf'];
danielebarchiesi@0:   $plugin = &$form_state['plugin'];
danielebarchiesi@0: 
danielebarchiesi@0:   $form['entity'] = array(
danielebarchiesi@0:     '#title' => t('Enter the title or ID of a @entity entity', array('@entity' => $plugin['keyword'])),
danielebarchiesi@0:     '#type' => 'textfield',
danielebarchiesi@0:     '#maxlength' => 512,
danielebarchiesi@0:     '#autocomplete_path' => 'ctools/autocomplete/' . $plugin['keyword'],
danielebarchiesi@0:     '#weight' => -10,
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   if (!empty($conf['entity_id'])) {
danielebarchiesi@0:     $info = entity_load($plugin['keyword'], array($conf['entity_id']));
danielebarchiesi@0:     $info = $info[$conf['entity_id']];
danielebarchiesi@0:     if ($info) {
danielebarchiesi@0:       $entity = entity_get_info($plugin['keyword']);
danielebarchiesi@0:       $uri = entity_uri($plugin['keyword'], $info);
danielebarchiesi@0:       if (is_array($uri) && $entity['entity keys']['label']) {
danielebarchiesi@0:         $link = l(t("'%title' [%type id %id]", array('%title' => $info->{$entity['entity keys']['label']}, '%type' => $plugin['keyword'], '%id' => $conf['entity_id'])), $uri['path'], array('attributes' => array('target' => '_blank', 'title' => t('Open in new window')), 'html' => TRUE));
danielebarchiesi@0:       }
danielebarchiesi@0:       elseif (is_array($uri)) {
danielebarchiesi@0:         $link = l(t("[%type id %id]", array('%type' => $plugin['keyword'], '%id' => $conf['entity_id'])), $uri['path'], array('attributes' => array('target' => '_blank', 'title' => t('Open in new window')), 'html' => TRUE));
danielebarchiesi@0:       }
danielebarchiesi@0:       elseif ($entity['entity keys']['label']) {
danielebarchiesi@0:         $link = l(t("'%title' [%type id %id]", array('%title' => $info->{$entity['entity keys']['label']}, '%type' => $plugin['keyword'], '%id' => $conf['entity_id'])), file_create_url($uri), array('attributes' => array('target' => '_blank', 'title' => t('Open in new window')), 'html' => TRUE));
danielebarchiesi@0:       }
danielebarchiesi@0:       else {
danielebarchiesi@0:         $link = t("[%type id %id]", array('%type' => $plugin['keyword'], '%id' => $conf['entity_id']));
danielebarchiesi@0:       }
danielebarchiesi@0:       $form['entity']['#description'] = t('Currently set to !link', array('!link' => $link));
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   $form['entity_id'] = array(
danielebarchiesi@0:     '#type' => 'value',
danielebarchiesi@0:     '#value' => $conf['entity_id'],
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   $form['entity_type'] = array(
danielebarchiesi@0:     '#type' => 'value',
danielebarchiesi@0:     '#value' => $plugin['keyword'],
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   $form['set_identifier'] = array(
danielebarchiesi@0:     '#type' => 'checkbox',
danielebarchiesi@0:     '#default_value' => FALSE,
danielebarchiesi@0:     '#title' => t('Reset identifier to entity label'),
danielebarchiesi@0:     '#description' => t('If checked, the identifier will be reset to the entity label of the selected entity.'),
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   return $form;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Validate a node.
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_context_entity_settings_form_validate($form, &$form_state) {
danielebarchiesi@0:   // Validate the autocomplete
danielebarchiesi@0:   if (empty($form_state['values']['entity_id']) && empty($form_state['values']['entity'])) {
danielebarchiesi@0:     form_error($form['entity'], t('You must select an entity.'));
danielebarchiesi@0:     return;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   if (empty($form_state['values']['entity'])) {
danielebarchiesi@0:     return;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   $id          = $form_state['values']['entity'];
danielebarchiesi@0:   $preg_matches = array();
danielebarchiesi@0:   $match        = preg_match('/\[id: (\d+)\]/', $id, $preg_matches);
danielebarchiesi@0:   if (!$match) {
danielebarchiesi@0:     $match = preg_match('/^id: (\d+)/', $id, $preg_matches);
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   if ($match) {
danielebarchiesi@0:     $id = $preg_matches[1];
danielebarchiesi@0:   }
danielebarchiesi@0:   if (is_numeric($id)) {
danielebarchiesi@0:     $entity = entity_load($form_state['values']['entity_type'], array($id));
danielebarchiesi@0:     $entity = $entity[$id];
danielebarchiesi@0:   }
danielebarchiesi@0:   else {
danielebarchiesi@0:     $entity_info = entity_get_info($form_state['values']['entity_type']);
danielebarchiesi@0:     $field = $entity_info['entity keys']['label'];
danielebarchiesi@0:     $entity = entity_load($form_state['values']['entity_type'], FALSE, array($field => $id));
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   // Do not allow unpublished nodes to be selected by unprivileged users
danielebarchiesi@0:   // || (empty($node->status) && !(user_access('administer nodes'))) need a new sanity check at some point.
danielebarchiesi@0:   if (!$entity) {
danielebarchiesi@0:     form_error($form['entity'], t('Invalid entity selected.'));
danielebarchiesi@0:   }
danielebarchiesi@0:   else {
danielebarchiesi@0:     $entity_id = entity_extract_ids($form_state['values']['entity_type'], $entity);
danielebarchiesi@0:     form_set_value($form['entity_id'], $entity_id[0], $form_state);
danielebarchiesi@0:   }
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: function ctools_context_entity_settings_form_submit($form, &$form_state) {
danielebarchiesi@0:   if ($form_state['values']['set_identifier']) {
danielebarchiesi@0:     $entity_info = entity_get_info($form_state['values']['entity_type']);
danielebarchiesi@0:     $entity = entity_load($form_state['values']['entity_type'], array($form_state['values']['entity_id']));
danielebarchiesi@0:     $entity = $entity[$form_state['values']['entity_id']];
danielebarchiesi@0:     $form_state['values']['identifier'] = $entity->{$entity_info['entity keys']['label']};
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   // This will either be the value set previously or a value set by the
danielebarchiesi@0:   // validator.
danielebarchiesi@0:   $form_state['conf']['entity_id'] = $form_state['values']['entity_id'];
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Provide a list of ways that this context can be converted to a string.
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_context_entity_convert_list($plugin) {
danielebarchiesi@0:   $list = array();
danielebarchiesi@0: 
danielebarchiesi@0:   $entity = entity_get_info($plugin['context name']);
danielebarchiesi@0:   if (isset($entity['token type'])) {
danielebarchiesi@0:     $token = $entity['token type'];
danielebarchiesi@0:   }
danielebarchiesi@0:   else {
danielebarchiesi@0:     $token = $plugin['context name'];
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   // Hack: we need either token.module or a core fix for this to work right,
danielebarchiesi@0:   // until then, we just muscle it.
danielebarchiesi@0:   if ($token == 'taxonomy_term') {
danielebarchiesi@0:     $token = 'term';
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   $tokens = token_info();
danielebarchiesi@0:   if (isset($tokens['tokens'][$token])) {
danielebarchiesi@0:     foreach ($tokens['tokens'][$token] as $id => $info) {
danielebarchiesi@0:       if (!isset($list[$id])) {
danielebarchiesi@0:         $list[$id] = $info['name'];
danielebarchiesi@0:       }
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0:   return $list;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Convert a context into a string.
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_context_entity_convert($context, $type, $options = array()) {
danielebarchiesi@0:   $entity_type = $context->type[2];
danielebarchiesi@0:   $entity = entity_get_info($entity_type);
danielebarchiesi@0: 
danielebarchiesi@0:   if (isset($entity['token type'])) {
danielebarchiesi@0:     $token = $entity['token type'];
danielebarchiesi@0:   }
danielebarchiesi@0:   else {
danielebarchiesi@0:     $token = $entity_type;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   // Hack: we need either token.module or a core fix for this to work right,
danielebarchiesi@0:   // until then, we just muscle it.
danielebarchiesi@0:   if ($token == 'taxonomy_term') {
danielebarchiesi@0:     $token = 'term';
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   $tokens = token_info();
danielebarchiesi@0: 
danielebarchiesi@0:   $values = token_generate($token, array($type => $type), array($token => $context->data), $options);
danielebarchiesi@0:   if (isset($values[$type])) {
danielebarchiesi@0:     return $values[$type];
danielebarchiesi@0:   }
danielebarchiesi@0: }