danielebarchiesi@0: <?php
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * @file
danielebarchiesi@0:  * Enhances the token API in core: adds a browseable UI, missing tokens, etc.
danielebarchiesi@0:  */
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * The maximum depth for token tree recursion.
danielebarchiesi@0:  */
danielebarchiesi@0: define('TOKEN_MAX_DEPTH', 9);
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Implements hook_help().
danielebarchiesi@0:  */
danielebarchiesi@0: function token_help($path, $arg) {
danielebarchiesi@0:   if ($path == 'admin/help#token') {
danielebarchiesi@0:     if (current_path() != 'admin/help/token') {
danielebarchiesi@0:       // Because system_modules() executes hook_help() for each module to 'test'
danielebarchiesi@0:       // if they will return anything, but not actually display it, we want to
danielebarchiesi@0:       // return a TRUE value if this is not actually the help page.
danielebarchiesi@0:       return TRUE;
danielebarchiesi@0:     }
danielebarchiesi@0:     $output = '<dl>';
danielebarchiesi@0:     $output .= '<dt>' . t('List of the currently available tokens on this site') . '</dt>';
danielebarchiesi@0:     $output .= '<dd>' . theme('token_tree', array('token_types' => 'all', 'click_insert' => FALSE, 'show_restricted' => TRUE)) . '</dd>';
danielebarchiesi@0:     $output .= '</dl>';
danielebarchiesi@0:     return $output;
danielebarchiesi@0:   }
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Implements hook_system_info_alter().
danielebarchiesi@0:  *
danielebarchiesi@0:  * Prevent the token_actions module from being enabled since updates may have
danielebarchiesi@0:  * left the old module files still in the directory.
danielebarchiesi@0:  */
danielebarchiesi@0: function token_system_info_alter(&$info, $file, $type) {
danielebarchiesi@0:   if ($type == 'module' && $file->name == 'token_actions') {
danielebarchiesi@0:     $info['hidden'] = TRUE;
danielebarchiesi@0:   }
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Return an array of the core modules supported by token.module.
danielebarchiesi@0:  */
danielebarchiesi@0: function _token_core_supported_modules() {
danielebarchiesi@0:   return array('book', 'field', 'menu', 'profile');
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Implements hook_menu().
danielebarchiesi@0:  */
danielebarchiesi@0: function token_menu() {
danielebarchiesi@0:   /*$items['token/autocomplete/all/%menu_tail'] = array(
danielebarchiesi@0:     'page callback' => 'token_autocomplete',
danielebarchiesi@0:     'access callback' => TRUE,
danielebarchiesi@0:     'type' => MENU_CALLBACK,
danielebarchiesi@0:     'file' => 'token.pages.inc',
danielebarchiesi@0:   );*/
danielebarchiesi@0:   $items['token/autocomplete/%token_type'] = array(
danielebarchiesi@0:     'page callback' => 'token_autocomplete_token',
danielebarchiesi@0:     'page arguments' => array(2),
danielebarchiesi@0:     'access callback' => TRUE,
danielebarchiesi@0:     'type' => MENU_CALLBACK,
danielebarchiesi@0:     'file' => 'token.pages.inc',
danielebarchiesi@0:   );
danielebarchiesi@0:   /*$items['token/autocomplete/%token_type/%menu_tail'] = array(
danielebarchiesi@0:     'page callback' => 'token_autocomplete_token',
danielebarchiesi@0:     'page arguments' => array(2, 3),
danielebarchiesi@0:     'access callback' => TRUE,
danielebarchiesi@0:     'type' => MENU_CALLBACK,
danielebarchiesi@0:     'file' => 'token.pages.inc',
danielebarchiesi@0:   );*/
danielebarchiesi@0: 
danielebarchiesi@0:   $items['token/tree'] = array(
danielebarchiesi@0:     'page callback' => 'token_page_output_tree',
danielebarchiesi@0:     'access callback' => TRUE,
danielebarchiesi@0:     'type' => MENU_CALLBACK,
danielebarchiesi@0:     'file' => 'token.pages.inc',
danielebarchiesi@0:     'theme callback' => 'ajax_base_page_theme',
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   // Devel token pages.
danielebarchiesi@0:   if (module_exists('devel')) {
danielebarchiesi@0:     $items['node/%node/devel/token'] = array(
danielebarchiesi@0:       'title' => 'Tokens',
danielebarchiesi@0:       'page callback' => 'token_devel_token_object',
danielebarchiesi@0:       'page arguments' => array('node', 1),
danielebarchiesi@0:       'access arguments' => array('access devel information'),
danielebarchiesi@0:       'type' => MENU_LOCAL_TASK,
danielebarchiesi@0:       'file' => 'token.pages.inc',
danielebarchiesi@0:       'weight' => 5,
danielebarchiesi@0:     );
danielebarchiesi@0:     $items['comment/%comment/devel/token'] = array(
danielebarchiesi@0:       'title' => 'Tokens',
danielebarchiesi@0:       'page callback' => 'token_devel_token_object',
danielebarchiesi@0:       'page arguments' => array('comment', 1),
danielebarchiesi@0:       'access arguments' => array('access devel information'),
danielebarchiesi@0:       'type' => MENU_LOCAL_TASK,
danielebarchiesi@0:       'file' => 'token.pages.inc',
danielebarchiesi@0:       'weight' => 5,
danielebarchiesi@0:     );
danielebarchiesi@0:     $items['taxonomy/term/%taxonomy_term/devel/token'] = array(
danielebarchiesi@0:       'title' => 'Tokens',
danielebarchiesi@0:       'page callback' => 'token_devel_token_object',
danielebarchiesi@0:       'page arguments' => array('taxonomy_term', 2),
danielebarchiesi@0:       'access arguments' => array('access devel information'),
danielebarchiesi@0:       'type' => MENU_LOCAL_TASK,
danielebarchiesi@0:       'file' => 'token.pages.inc',
danielebarchiesi@0:       'weight' => 5,
danielebarchiesi@0:     );
danielebarchiesi@0:     $items['user/%user/devel/token'] = array(
danielebarchiesi@0:       'title' => 'Tokens',
danielebarchiesi@0:       'page callback' => 'token_devel_token_object',
danielebarchiesi@0:       'page arguments' => array('user', 1),
danielebarchiesi@0:       'access arguments' => array('access devel information'),
danielebarchiesi@0:       'type' => MENU_LOCAL_TASK,
danielebarchiesi@0:       'file' => 'token.pages.inc',
danielebarchiesi@0:       'weight' => 5,
danielebarchiesi@0:     );
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   // Admin menu callback to clear token caches.
danielebarchiesi@0:   $items['token/flush-cache'] = array(
danielebarchiesi@0:     'page callback' => 'token_flush_cache_callback',
danielebarchiesi@0:     'access arguments' => array('flush caches'),
danielebarchiesi@0:     'type' => MENU_CALLBACK,
danielebarchiesi@0:     'file' => 'token.pages.inc',
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   return $items;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Implements hook_admin_menu_output_alter().
danielebarchiesi@0:  */
danielebarchiesi@0: function token_admin_menu_output_alter(&$content) {
danielebarchiesi@0:   $content['icon']['icon']['flush-cache']['token'] = array(
danielebarchiesi@0:     '#title' => t('Token registry'),
danielebarchiesi@0:     '#href' => 'token/flush-cache',
danielebarchiesi@0:     '#options' => array(
danielebarchiesi@0:       'query' => drupal_get_destination() + array('token' => drupal_get_token('token/flush-cache')),
danielebarchiesi@0:     ),
danielebarchiesi@0:   );
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: function token_type_load($token_type) {
danielebarchiesi@0:   $info = token_get_info();
danielebarchiesi@0:   return isset($info['types'][$token_type]) ? $info['types'][$token_type] : FALSE;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Implements hook_theme().
danielebarchiesi@0:  */
danielebarchiesi@0: function token_theme() {
danielebarchiesi@0:   $info['tree_table'] = array(
danielebarchiesi@0:     'variables' => array(
danielebarchiesi@0:       'header' => array(),
danielebarchiesi@0:       'rows' => array(),
danielebarchiesi@0:       'attributes' => array(),
danielebarchiesi@0:       'empty' => '',
danielebarchiesi@0:       'caption' => '',
danielebarchiesi@0:     ),
danielebarchiesi@0:     'file' => 'token.pages.inc',
danielebarchiesi@0:   );
danielebarchiesi@0:   $info['token_tree'] = array(
danielebarchiesi@0:     'variables' => array(
danielebarchiesi@0:       'token_types' => array(),
danielebarchiesi@0:       'global_types' => TRUE,
danielebarchiesi@0:       'click_insert' => TRUE,
danielebarchiesi@0:       'show_restricted' => FALSE,
danielebarchiesi@0:       'recursion_limit' => 3,
danielebarchiesi@0:       'dialog' => FALSE,
danielebarchiesi@0:     ),
danielebarchiesi@0:     'file' => 'token.pages.inc',
danielebarchiesi@0:   );
danielebarchiesi@0:   $info['token_tree_link'] = array(
danielebarchiesi@0:     'variables' => array(
danielebarchiesi@0:       'text' => NULL,
danielebarchiesi@0:       'options' => array(),
danielebarchiesi@0:       'dialog' => TRUE,
danielebarchiesi@0:     ),
danielebarchiesi@0:     'file' => 'token.pages.inc',
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   return $info;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Implements hook_library().
danielebarchiesi@0:  */
danielebarchiesi@0: function token_library() {
danielebarchiesi@0:   // jQuery treeTable plugin.
danielebarchiesi@0:   $libraries['treeTable'] = array(
danielebarchiesi@0:     'title' => 'jQuery treeTable',
danielebarchiesi@0:     'website' => 'http://plugins.jquery.com/project/treetable',
danielebarchiesi@0:     'version' => '2.3.0',
danielebarchiesi@0:     'js' => array(
danielebarchiesi@0:       drupal_get_path('module', 'token') . '/jquery.treeTable.js' => array(),
danielebarchiesi@0:     ),
danielebarchiesi@0:     'css' => array(
danielebarchiesi@0:       drupal_get_path('module', 'token') . '/jquery.treeTable.css' => array(),
danielebarchiesi@0:     ),
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   $libraries['dialog'] = array(
danielebarchiesi@0:     'title' => 'Token dialog',
danielebarchiesi@0:     'version' => '1.0',
danielebarchiesi@0:     'js' => array(
danielebarchiesi@0:       drupal_get_path('module', 'token') . '/token.js' => array(),
danielebarchiesi@0:     ),
danielebarchiesi@0:     'dependencies' => array(
danielebarchiesi@0:       array('system', 'ui.dialog'),
danielebarchiesi@0:     ),
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   return $libraries;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Implements hook_form_alter().
danielebarchiesi@0:  *
danielebarchiesi@0:  * Adds a submit handler to forms which could affect the tokens available on
danielebarchiesi@0:  * the site.
danielebarchiesi@0:  */
danielebarchiesi@0: function token_form_alter(&$form, $form_state, $form_id) {
danielebarchiesi@0:   switch ($form_id) {
danielebarchiesi@0:     // Profile field forms.
danielebarchiesi@0:     case 'profile_field_form':
danielebarchiesi@0:     case 'profile_field_delete':
danielebarchiesi@0:     // User picture form.
danielebarchiesi@0:     case 'user_admin_settings':
danielebarchiesi@0:     // System date type form.
danielebarchiesi@0:     // @todo Remove when http://drupal.org/node/1173706 is fixed.
danielebarchiesi@0:     case 'system_add_date_format_type_form':
danielebarchiesi@0:     case 'system_delete_date_format_type_form':
danielebarchiesi@0:       $form += array('#submit' => array());
danielebarchiesi@0:       array_unshift($form['#submit'], 'token_clear_cache');
danielebarchiesi@0:       break;
danielebarchiesi@0:   }
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Implements hook_block_view_alter().
danielebarchiesi@0:  */
danielebarchiesi@0: function token_block_view_alter(&$data, $block) {
danielebarchiesi@0:   if (!empty($block->title) && $block->title != '<none>') {
danielebarchiesi@0:     // Perform unsanitized token replacement since _block_render_blocks() will
danielebarchiesi@0:     // call check_plain() on $block->title.
danielebarchiesi@0:     $block->title = token_replace($block->title, array(), array('sanitize' => FALSE));
danielebarchiesi@0:   }
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Implements hook_form_FORM_ID_alter().
danielebarchiesi@0:  */
danielebarchiesi@0: function token_form_block_add_block_form_alter(&$form, $form_state) {
danielebarchiesi@0:   token_form_block_admin_configure_alter($form, $form_state);
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Implements hook_form_FORM_ID_alter().
danielebarchiesi@0:  */
danielebarchiesi@0: function token_form_block_admin_configure_alter(&$form, $form_state) {
danielebarchiesi@0:   $form['settings']['title']['#description'] .= ' ' . t('This field supports tokens.');
danielebarchiesi@0:   // @todo Figure out why this token validation does not seem to be working here.
danielebarchiesi@0:   $form['settings']['title']['#element_validate'][] = 'token_element_validate';
danielebarchiesi@0:   $form['settings']['title'] += array('#token_types' => array());
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Implements hook_widget_form_alter().
danielebarchiesi@0:  */
danielebarchiesi@0: function token_field_widget_form_alter(&$element, &$form_state, $context) {
danielebarchiesi@0:   if (!empty($element['#description']) && is_string($element['#description'])) {
danielebarchiesi@0:     $element['#description'] = filter_xss_admin(token_replace($element['#description']));
danielebarchiesi@0:   }
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Implements hook_field_info_alter().
danielebarchiesi@0:  */
danielebarchiesi@0: function token_field_info_alter(&$info) {
danielebarchiesi@0:   $defaults = array(
danielebarchiesi@0:     'taxonomy_term_reference' => 'taxonomy_term_reference_plain',
danielebarchiesi@0:     'number_integer' => 'number_unformatted',
danielebarchiesi@0:     'number_decimal' => 'number_unformatted',
danielebarchiesi@0:     'number_float' => 'number_unformatted',
danielebarchiesi@0:     'file' => 'file_url_plain',
danielebarchiesi@0:     'image' => 'file_url_plain',
danielebarchiesi@0:     'text' => 'text_default',
danielebarchiesi@0:     'text_long' => 'text_default',
danielebarchiesi@0:     'text_with_summary' => 'text_default',
danielebarchiesi@0:     'list_integer' => 'list_default',
danielebarchiesi@0:     'list_float' => 'list_default',
danielebarchiesi@0:     'list_text' => 'list_default',
danielebarchiesi@0:     'list_boolean' => 'list_default',
danielebarchiesi@0:   );
danielebarchiesi@0:   foreach ($defaults as $field_type => $default_token_formatter) {
danielebarchiesi@0:     if (isset($info[$field_type])) {
danielebarchiesi@0:       $info[$field_type] += array('default_token_formatter' => $default_token_formatter);
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Implements hook_field_display_alter().
danielebarchiesi@0:  */
danielebarchiesi@0: function token_field_display_alter(&$display, $context) {
danielebarchiesi@0:   if ($context['view_mode'] == 'token') {
danielebarchiesi@0:     $view_mode_settings = field_view_mode_settings($context['instance']['entity_type'], $context['instance']['bundle']);
danielebarchiesi@0:     // If the token view mode fell back to the 'default' view mode, then
danielebarchiesi@0:     // use the default token formatter.
danielebarchiesi@0:     if (empty($view_mode_settings[$context['view_mode']]['custom_settings'])) {
danielebarchiesi@0:       $field_type_info = field_info_field_types($context['field']['type']);
danielebarchiesi@0: 
danielebarchiesi@0:       // If the field has specified a specific formatter to be used by default
danielebarchiesi@0:       // with tokens, use that, otherwise use the default formatter.
danielebarchiesi@0:       $formatter = !empty($field_type_info['default_token_formatter']) ? $field_type_info['default_token_formatter'] : $field_type_info['default_formatter'];
danielebarchiesi@0: 
danielebarchiesi@0:       // Now that we have a formatter, fill in all the settings.
danielebarchiesi@0:       $display['type'] = $formatter;
danielebarchiesi@0:       $formatter_info = field_info_formatter_types($formatter);
danielebarchiesi@0:       $display['settings'] = isset($formatter_info['settings']) ? $formatter_info['settings'] : array();
danielebarchiesi@0:       $display['settings']['label'] = 'hidden';
danielebarchiesi@0:       $display['module'] = $formatter_info['module'];
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Implements hook_field_create_instance().
danielebarchiesi@0:  */
danielebarchiesi@0: function token_field_create_instance($instance) {
danielebarchiesi@0:   token_clear_cache();
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Implements hook_field_update_instance().
danielebarchiesi@0:  */
danielebarchiesi@0: function token_field_update_instance($instance) {
danielebarchiesi@0:   token_clear_cache();
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Implements hook_field_delete_instance().
danielebarchiesi@0:  */
danielebarchiesi@0: function token_field_delete_instance($instance) {
danielebarchiesi@0:   token_clear_cache();
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Clear token caches and static variables.
danielebarchiesi@0:  */
danielebarchiesi@0: function token_clear_cache() {
danielebarchiesi@0:   if (db_table_exists('cache_token')) {
danielebarchiesi@0:     cache_clear_all('*', 'cache_token', TRUE);
danielebarchiesi@0:   }
danielebarchiesi@0:   drupal_static_reset('token_get_info');
danielebarchiesi@0:   drupal_static_reset('token_get_global_token_types');
danielebarchiesi@0:   drupal_static_reset('token_get_entity_mapping');
danielebarchiesi@0:   drupal_static_reset('token_build_tree');
danielebarchiesi@0:   drupal_static_reset('_token_profile_fields');
danielebarchiesi@0:   drupal_static_reset('token_menu_link_load');
danielebarchiesi@0:   drupal_static_reset('token_book_link_load');
danielebarchiesi@0:   drupal_static_reset('token_node_menu_link_load');
danielebarchiesi@0:   drupal_static_reset('_token_field_info');
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Return an array of entity type to token type mappings.
danielebarchiesi@0:  *
danielebarchiesi@0:  * Why do we need this? Because when the token API was moved to core we did not
danielebarchiesi@0:  * re-use the entity type as the base name for taxonomy terms and vocabulary
danielebarchiesi@0:  * tokens.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @see token_entity_info_alter()
danielebarchiesi@0:  * @see http://drupal.org/node/737726
danielebarchiesi@0:  */
danielebarchiesi@0: function token_get_entity_mapping($value_type = 'token', $value = NULL, $fallback = FALSE) {
danielebarchiesi@0:   $mapping = &drupal_static(__FUNCTION__, array());
danielebarchiesi@0: 
danielebarchiesi@0:   if (empty($mapping)) {
danielebarchiesi@0:     foreach (entity_get_info() as $entity_type => $info) {
danielebarchiesi@0:       $mapping[$entity_type] = !empty($info['token type']) ? $info['token type'] : $entity_type;
danielebarchiesi@0:     }
danielebarchiesi@0:     // Allow modules to alter the mapping array.
danielebarchiesi@0:     drupal_alter('token_entity_mapping', $mapping);
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   if (!isset($value)) {
danielebarchiesi@0:     return $value_type == 'token' ? array_flip($mapping) : $mapping;
danielebarchiesi@0:   }
danielebarchiesi@0:   elseif ($value_type == 'token') {
danielebarchiesi@0:     $return = array_search($value, $mapping);
danielebarchiesi@0:     return $return !== FALSE ? $return : ($fallback ? $value : FALSE);
danielebarchiesi@0:   }
danielebarchiesi@0:   elseif ($value_type == 'entity') {
danielebarchiesi@0:     return isset($mapping[$value]) ? $mapping[$value] : ($fallback ? $value : FALSE);
danielebarchiesi@0:   }
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Implements hook_entity_info_alter().
danielebarchiesi@0:  *
danielebarchiesi@0:  * Because some token types to do not match their entity type names, we have to
danielebarchiesi@0:  * map them to the proper type. This is purely for other modules' benefit.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @see token_get_entity_mapping()
danielebarchiesi@0:  * @see http://drupal.org/node/737726
danielebarchiesi@0:  */
danielebarchiesi@0: function token_entity_info_alter(&$info) {
danielebarchiesi@0:   foreach (array_keys($info) as $entity_type) {
danielebarchiesi@0:     // Add a token view mode if it does not already exist.
danielebarchiesi@0:     if (!empty($info[$entity_type]['view modes']) && !isset($info[$entity_type]['view modes']['token'])) {
danielebarchiesi@0:       $info[$entity_type]['view modes']['token'] = array(
danielebarchiesi@0:         'label' => t('Tokens'),
danielebarchiesi@0:         'custom settings' => FALSE,
danielebarchiesi@0:       );
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     if (!empty($info[$entity_type]['token type'])) {
danielebarchiesi@0:       // If the entity's token type is already defined, great!
danielebarchiesi@0:       continue;
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     // Fill in default token types for entities.
danielebarchiesi@0:     switch ($entity_type) {
danielebarchiesi@0:       case 'taxonomy_term':
danielebarchiesi@0:       case 'taxonomy_vocabulary':
danielebarchiesi@0:         // Stupid taxonomy token types...
danielebarchiesi@0:         $info[$entity_type]['token type'] = str_replace('taxonomy_', '', $entity_type);
danielebarchiesi@0:         break;
danielebarchiesi@0:       default:
danielebarchiesi@0:         // By default the token type is the same as the entity type.
danielebarchiesi@0:         $info[$entity_type]['token type'] = $entity_type;
danielebarchiesi@0:         break;
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Implements hook_module_implements_alter().
danielebarchiesi@0:  *
danielebarchiesi@0:  * Adds missing token support for core modules.
danielebarchiesi@0:  */
danielebarchiesi@0: function token_module_implements_alter(&$implementations, $hook) {
danielebarchiesi@0:   module_load_include('inc', 'token', 'token.tokens');
danielebarchiesi@0: 
danielebarchiesi@0:   if ($hook == 'tokens' || $hook == 'token_info' || $hook == 'token_info_alter' || $hook == 'tokens_alter') {
danielebarchiesi@0:     foreach (_token_core_supported_modules() as $module) {
danielebarchiesi@0:       if (module_exists($module) && function_exists($module . '_' . $hook)) {
danielebarchiesi@0:         $implementations[$module] = FALSE;
danielebarchiesi@0:       }
danielebarchiesi@0:     }
danielebarchiesi@0:     // Move token.module to get included first since it is responsible for
danielebarchiesi@0:     // other modules.
danielebarchiesi@0:     unset($implementations['token']);
danielebarchiesi@0:     $implementations = array_merge(array('token' => 'tokens'), $implementations);
danielebarchiesi@0:   }
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Implements hook_flush_caches().
danielebarchiesi@0:  */
danielebarchiesi@0: function token_flush_caches() {
danielebarchiesi@0:   if (db_table_exists('cache_token')) {
danielebarchiesi@0:     return array('cache_token');
danielebarchiesi@0:   }
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Retrieve, sort, store token info from the cache.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @param $token_type
danielebarchiesi@0:  *   The optional token type that if specified will return
danielebarchiesi@0:  *   $info['types'][$token_type].
danielebarchiesi@0:  * @param $token
danielebarchiesi@0:  *   The optional token name if specified will return
danielebarchiesi@0:  *   $info['tokens'][$token_type][$token].
danielebarchiesi@0:  *
danielebarchiesi@0:  * @return
danielebarchiesi@0:  *   An array of all token information from hook_token_info(), or the array
danielebarchiesi@0:  *   of a token type or specific token.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @see hook_token_info()
danielebarchiesi@0:  * @see hook_token_info_alter()
danielebarchiesi@0:  */
danielebarchiesi@0: function token_get_info($token_type = NULL, $token = NULL) {
danielebarchiesi@0:   global $language;
danielebarchiesi@0: 
danielebarchiesi@0:   // Use the advanced drupal_static() pattern, since this is called very often.
danielebarchiesi@0:   static $drupal_static_fast;
danielebarchiesi@0:   if (!isset($drupal_static_fast)) {
danielebarchiesi@0:     $drupal_static_fast['token_info'] = &drupal_static(__FUNCTION__);
danielebarchiesi@0:   }
danielebarchiesi@0:   $token_info = &$drupal_static_fast['token_info'];
danielebarchiesi@0: 
danielebarchiesi@0:   if (empty($token_info)) {
danielebarchiesi@0:     $cid = "info:{$language->language}";
danielebarchiesi@0: 
danielebarchiesi@0:     if ($cache = cache_get($cid, 'cache_token')) {
danielebarchiesi@0:       $token_info = $cache->data;
danielebarchiesi@0:     }
danielebarchiesi@0:     else {
danielebarchiesi@0:       $token_info = token_info();
danielebarchiesi@0: 
danielebarchiesi@0:       foreach (array_keys($token_info['types']) as $type_key) {
danielebarchiesi@0:         if (isset($token_info['types'][$type_key]['type'])) {
danielebarchiesi@0:           $base_type = $token_info['types'][$type_key]['type'];
danielebarchiesi@0:           // If this token type extends another token type, then merge in
danielebarchiesi@0:           // the base token type's tokens.
danielebarchiesi@0:           if (isset($token_info['tokens'][$base_type])) {
danielebarchiesi@0:             $token_info['tokens'] += array($type_key => array());
danielebarchiesi@0:             $token_info['tokens'][$type_key] += $token_info['tokens'][$base_type];
danielebarchiesi@0:           }
danielebarchiesi@0:         }
danielebarchiesi@0:         else {
danielebarchiesi@0:           // Add a 'type' value to each token type so we can properly use
danielebarchiesi@0:           // token_type_load().
danielebarchiesi@0:           $token_info['types'][$type_key]['type'] = $type_key;
danielebarchiesi@0:         }
danielebarchiesi@0:       }
danielebarchiesi@0: 
danielebarchiesi@0:       // Pre-sort tokens.
danielebarchiesi@0:       uasort($token_info['types'], 'token_asort_tokens');
danielebarchiesi@0:       foreach (array_keys($token_info['tokens']) as $type) {
danielebarchiesi@0:         uasort($token_info['tokens'][$type], 'token_asort_tokens');
danielebarchiesi@0:       }
danielebarchiesi@0: 
danielebarchiesi@0:       // Store info in cache for future use.
danielebarchiesi@0:       cache_set($cid, $token_info, 'cache_token');
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   if (isset($token_type) && isset($token)) {
danielebarchiesi@0:     return isset($token_info['tokens'][$token_type][$token]) ? $token_info['tokens'][$token_type][$token] : NULL;
danielebarchiesi@0:   }
danielebarchiesi@0:   elseif (isset($token_type)) {
danielebarchiesi@0:     return isset($token_info['types'][$token_type]) ? $token_info['types'][$token_type] : NULL;
danielebarchiesi@0:   }
danielebarchiesi@0:   else {
danielebarchiesi@0:     return $token_info;
danielebarchiesi@0:   }
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Return the module responsible for a token.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @param string $type
danielebarchiesi@0:  *   The token type.
danielebarchiesi@0:  * @param string $name
danielebarchiesi@0:  *   The token name.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @return mixed
danielebarchiesi@0:  *   The value of $info['tokens'][$type][$name]['module'] from token_get_info(),
danielebarchiesi@0:  *   or NULL if the value does not exist.
danielebarchiesi@0:  */
danielebarchiesi@0: function _token_module($type, $name) {
danielebarchiesi@0:   $token_info = token_get_info($type, $name);
danielebarchiesi@0:   return isset($token_info['module']) ? $token_info['module'] : NULL;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * uasort() callback to sort tokens by the 'name' property.
danielebarchiesi@0:  */
danielebarchiesi@0: function token_asort_tokens($token_a, $token_b) {
danielebarchiesi@0:   return strnatcmp($token_a['name'], $token_b['name']);
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Get a list of token types that can be used without any context (global).
danielebarchiesi@0:  *
danielebarchiesi@0:  * @return
danielebarchiesi@0:  *   An array of global token types.
danielebarchiesi@0:  */
danielebarchiesi@0: function token_get_global_token_types() {
danielebarchiesi@0:   $global_types = &drupal_static(__FUNCTION__, array());
danielebarchiesi@0: 
danielebarchiesi@0:   if (empty($global_types)) {
danielebarchiesi@0:     $token_info = token_get_info();
danielebarchiesi@0:     foreach ($token_info['types'] as $type => $type_info) {
danielebarchiesi@0:       // If the token types has not specified that 'needs-data' => TRUE, then
danielebarchiesi@0:       // it is a global token type that will always be replaced in any context.
danielebarchiesi@0:       if (empty($type_info['needs-data'])) {
danielebarchiesi@0:         $global_types[] = $type;
danielebarchiesi@0:       }
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   return $global_types;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Validate an tokens in raw text based on possible contexts.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @param $value
danielebarchiesi@0:  *   A string with the raw text containing the raw tokens, or an array of
danielebarchiesi@0:  *   tokens from token_scan().
danielebarchiesi@0:  * @param $tokens
danielebarchiesi@0:  *   An array of token types that will be used when token replacement is
danielebarchiesi@0:  *   performed.
danielebarchiesi@0:  * @return
danielebarchiesi@0:  *   An array with the invalid tokens in their original raw forms.
danielebarchiesi@0:  */
danielebarchiesi@0: function token_get_invalid_tokens_by_context($value, $valid_types = array()) {
danielebarchiesi@0:   if (in_array('all', $valid_types)) {
danielebarchiesi@0:     $info = token_get_info();
danielebarchiesi@0:     $valid_types = array_keys($info['types']);
danielebarchiesi@0:   }
danielebarchiesi@0:   else {
danielebarchiesi@0:     // Add the token types that are always valid in global context.
danielebarchiesi@0:     $valid_types = array_merge($valid_types, token_get_global_token_types());
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   $invalid_tokens = array();
danielebarchiesi@0:   $value_tokens = is_string($value) ? token_scan($value) : $value;
danielebarchiesi@0: 
danielebarchiesi@0:   foreach ($value_tokens as $type => $tokens) {
danielebarchiesi@0:     if (!in_array($type, $valid_types)) {
danielebarchiesi@0:       // If the token type is not a valid context, its tokens are invalid.
danielebarchiesi@0:       $invalid_tokens = array_merge($invalid_tokens, array_values($tokens));
danielebarchiesi@0:     }
danielebarchiesi@0:     else {
danielebarchiesi@0:       // Check each individual token for validity.
danielebarchiesi@0:       $invalid_tokens = array_merge($invalid_tokens, token_get_invalid_tokens($type, $tokens));
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   array_unique($invalid_tokens);
danielebarchiesi@0:   return $invalid_tokens;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Validate an array of tokens based on their token type.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @param $type
danielebarchiesi@0:  *   The type of tokens to validate (e.g. 'node', etc.)
danielebarchiesi@0:  * @param $tokens
danielebarchiesi@0:  *   A keyed array of tokens, and their original raw form in the source text.
danielebarchiesi@0:  * @return
danielebarchiesi@0:  *   An array with the invalid tokens in their original raw forms.
danielebarchiesi@0:  */
danielebarchiesi@0: function token_get_invalid_tokens($type, $tokens) {
danielebarchiesi@0:   $token_info = token_get_info();
danielebarchiesi@0:   $invalid_tokens = array();
danielebarchiesi@0: 
danielebarchiesi@0:   foreach ($tokens as $token => $full_token) {
danielebarchiesi@0:     // Split token up if it has chains.
danielebarchiesi@0:     $parts = explode(':', $token, 2);
danielebarchiesi@0: 
danielebarchiesi@0:     if (!isset($token_info['tokens'][$type][$parts[0]])) {
danielebarchiesi@0:       // This is an invalid token (not defined).
danielebarchiesi@0:       $invalid_tokens[] = $full_token;
danielebarchiesi@0:     }
danielebarchiesi@0:     elseif (count($parts) == 2) {
danielebarchiesi@0:       $sub_token_info = $token_info['tokens'][$type][$parts[0]];
danielebarchiesi@0:       if (!empty($sub_token_info['dynamic'])) {
danielebarchiesi@0:         // If this token has been flagged as a dynamic token, skip it.
danielebarchiesi@0:         continue;
danielebarchiesi@0:       }
danielebarchiesi@0:       elseif (empty($sub_token_info['type'])) {
danielebarchiesi@0:         // If the token has chains, but does not support it, it is invalid.
danielebarchiesi@0:         $invalid_tokens[] = $full_token;
danielebarchiesi@0:       }
danielebarchiesi@0:       else {
danielebarchiesi@0:         // Resursively check the chained tokens.
danielebarchiesi@0:         $sub_tokens = token_find_with_prefix(array($token => $full_token), $parts[0]);
danielebarchiesi@0:         $invalid_tokens = array_merge($invalid_tokens, token_get_invalid_tokens($sub_token_info['type'], $sub_tokens));
danielebarchiesi@0:       }
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   return $invalid_tokens;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Validate a form element that should have tokens in it.
danielebarchiesi@0:  *
danielebarchiesi@0:  * Form elements that want to add this validation should have the #token_types
danielebarchiesi@0:  * parameter defined.
danielebarchiesi@0:  *
danielebarchiesi@0:  * For example:
danielebarchiesi@0:  * @code
danielebarchiesi@0:  * $form['my_node_text_element'] = array(
danielebarchiesi@0:  *   '#type' => 'textfield',
danielebarchiesi@0:  *   '#title' => t('Some text to token-ize that has a node context.'),
danielebarchiesi@0:  *   '#default_value' => 'The title of this node is [node:title].',
danielebarchiesi@0:  *   '#element_validate' => array('token_element_validate'),
danielebarchiesi@0:  *   '#token_types' => array('node'),
danielebarchiesi@0:  *   '#min_tokens' => 1,
danielebarchiesi@0:  *   '#max_tokens' => 10,
danielebarchiesi@0:  * );
danielebarchiesi@0:  * @endcode
danielebarchiesi@0:  */
danielebarchiesi@0: function token_element_validate(&$element, &$form_state) {
danielebarchiesi@0:   $value = isset($element['#value']) ? $element['#value'] : $element['#default_value'];
danielebarchiesi@0: 
danielebarchiesi@0:   if (!drupal_strlen($value)) {
danielebarchiesi@0:     // Empty value needs no further validation since the element should depend
danielebarchiesi@0:     // on using the '#required' FAPI property.
danielebarchiesi@0:     return $element;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   $tokens = token_scan($value);
danielebarchiesi@0:   $title = empty($element['#title']) ? $element['#parents'][0] : $element['#title'];
danielebarchiesi@0:   // @todo Find old Drupal 6 style tokens and add them to invalid tokens.
danielebarchiesi@0: 
danielebarchiesi@0:   // Validate if an element must have a minimum number of tokens.
danielebarchiesi@0:   if (isset($element['#min_tokens']) && count($tokens) < $element['#min_tokens']) {
danielebarchiesi@0:     // @todo Change this error message to include the minimum number.
danielebarchiesi@0:     $error = format_plural($element['#min_tokens'], 'The %element-title cannot contain fewer than one token.', 'The %element-title must contain at least @count tokens.', array('%element-title' => $title));
danielebarchiesi@0:     form_error($element, $error);
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   // Validate if an element must have a maximum number of tokens.
danielebarchiesi@0:   if (isset($element['#max_tokens']) && count($tokens) > $element['#max_tokens']) {
danielebarchiesi@0:     // @todo Change this error message to include the maximum number.
danielebarchiesi@0:     $error = format_plural($element['#max_tokens'], 'The %element-title must contain as most one token.', 'The %element-title must contain at most @count tokens.', array('%element-title' => $title));
danielebarchiesi@0:     form_error($element, $error);
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   // Check if the field defines specific token types.
danielebarchiesi@0:   if (isset($element['#token_types'])) {
danielebarchiesi@0:     $invalid_tokens = token_get_invalid_tokens_by_context($tokens, $element['#token_types']);
danielebarchiesi@0:     if ($invalid_tokens) {
danielebarchiesi@0:       form_error($element, t('The %element-title is using the following invalid tokens: @invalid-tokens.', array('%element-title' => $title, '@invalid-tokens' => implode(', ', $invalid_tokens))));
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   return $element;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Deprecated. Use token_element_validate() instead.
danielebarchiesi@0:  */
danielebarchiesi@0: function token_element_validate_token_context(&$element, &$form_state) {
danielebarchiesi@0:   return token_element_validate($element, $form_state);
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Implements hook_form_FORM_ID_alter().
danielebarchiesi@0:  */
danielebarchiesi@0: function token_form_field_ui_field_edit_form_alter(&$form, $form_state) {
danielebarchiesi@0:   if (!isset($form['instance']) || !empty($form['#field']['locked'])) {
danielebarchiesi@0:     return;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   if (($form['#field']['type'] == 'file' || $form['#field']['type'] == 'image') && isset($form['instance']['settings']['file_directory']) && !module_exists('filefield_paths')) {
danielebarchiesi@0:     // GAH! We can only support global tokens in the upload file directory path.
danielebarchiesi@0:     $form['instance']['settings']['file_directory']['#element_validate'][] = 'token_element_validate';
danielebarchiesi@0:     $form['instance']['settings']['file_directory'] += array('#token_types' => array());
danielebarchiesi@0:     $form['instance']['settings']['file_directory']['#description'] .= ' ' . t('This field supports tokens.');
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   // Note that the description is tokenized via token_field_widget_form_alter().
danielebarchiesi@0:   $form['instance']['description']['#description'] .= '<br />' . t('This field supports tokens.');
danielebarchiesi@0:   $form['instance']['description']['#element_validate'][] = 'token_element_validate';
danielebarchiesi@0:   $form['instance']['description'] += array('#token_types' => array());
danielebarchiesi@0: 
danielebarchiesi@0:   $form['instance']['settings']['token_tree'] = array(
danielebarchiesi@0:     '#theme' => 'token_tree',
danielebarchiesi@0:     '#token_types' => array(),
danielebarchiesi@0:     '#dialog' => TRUE,
danielebarchiesi@0:     '#weight' => $form['instance']['description']['#weight'] + 0.5,
danielebarchiesi@0:   );
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Implements hook_form_FORM_ID_alter().
danielebarchiesi@0:  *
danielebarchiesi@0:  * Alters the configure action form to add token context validation and
danielebarchiesi@0:  * adds the token tree for a better token UI and selection.
danielebarchiesi@0:  */
danielebarchiesi@0: function token_form_system_actions_configure_alter(&$form, $form_state) {
danielebarchiesi@0:   $action = actions_function_lookup($form['actions_action']['#value']);
danielebarchiesi@0: 
danielebarchiesi@0:   switch ($action) {
danielebarchiesi@0:     case 'system_message_action':
danielebarchiesi@0:     case 'system_send_email_action':
danielebarchiesi@0:     case 'system_goto_action':
danielebarchiesi@0:       $form['token_tree'] = array(
danielebarchiesi@0:         '#theme' => 'token_tree',
danielebarchiesi@0:         '#token_types' => 'all',
danielebarchiesi@0:         '#dialog' => TRUE,
danielebarchiesi@0:         '#weight' => 100,
danielebarchiesi@0:       );
danielebarchiesi@0:       // @todo Add token validation to the action fields that can use tokens.
danielebarchiesi@0:       break;
danielebarchiesi@0:   }
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Implements hook_form_FORM_ID_alter().
danielebarchiesi@0:  *
danielebarchiesi@0:  * Alters the user e-mail fields to add token context validation and
danielebarchiesi@0:  * adds the token tree for a better token UI and selection.
danielebarchiesi@0:  */
danielebarchiesi@0: function token_form_user_admin_settings_alter(&$form, &$form_state) {
danielebarchiesi@0:   $email_token_help = t('Available variables are: [site:name], [site:url], [user:name], [user:mail], [site:login-url], [site:url-brief], [user:edit-url], [user:one-time-login-url], [user:cancel-url].');
danielebarchiesi@0: 
danielebarchiesi@0:   foreach (element_children($form) as $key) {
danielebarchiesi@0:     $element = &$form[$key];
danielebarchiesi@0: 
danielebarchiesi@0:     // Remove the crummy default token help text.
danielebarchiesi@0:     if (!empty($element['#description'])) {
danielebarchiesi@0:       $element['#description'] = trim(str_replace($email_token_help, t('The list of available tokens that can be used in e-mails is provided below.'), $element['#description']));
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     switch ($key) {
danielebarchiesi@0:       case 'email_admin_created':
danielebarchiesi@0:       case 'email_pending_approval':
danielebarchiesi@0:       case 'email_no_approval_required':
danielebarchiesi@0:       case 'email_password_reset':
danielebarchiesi@0:       case 'email_cancel_confirm':
danielebarchiesi@0:         // Do nothing, but allow execution to continue.
danielebarchiesi@0:         break;
danielebarchiesi@0:       case 'email_activated':
danielebarchiesi@0:       case 'email_blocked':
danielebarchiesi@0:       case 'email_canceled':
danielebarchiesi@0:         // These fieldsets have their e-mail elements inside a 'settings'
danielebarchiesi@0:         // sub-element, so switch to that element instead.
danielebarchiesi@0:         $element = &$form[$key]['settings'];
danielebarchiesi@0:         break;
danielebarchiesi@0:       default:
danielebarchiesi@0:         continue 2;
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     foreach (element_children($element) as $sub_key) {
danielebarchiesi@0:       if (!isset($element[$sub_key]['#type'])) {
danielebarchiesi@0:         continue;
danielebarchiesi@0:       }
danielebarchiesi@0:       elseif ($element[$sub_key]['#type'] == 'textfield' && substr($sub_key, -8) === '_subject') {
danielebarchiesi@0:         // Add validation to subject textfields.
danielebarchiesi@0:         $element[$sub_key]['#element_validate'][] = 'token_element_validate';
danielebarchiesi@0:         $element[$sub_key] += array('#token_types' => array('user'));
danielebarchiesi@0:       }
danielebarchiesi@0:       elseif ($element[$sub_key]['#type'] == 'textarea' && substr($sub_key, -5) === '_body') {
danielebarchiesi@0:         // Add validation to body textareas.
danielebarchiesi@0:         $element[$sub_key]['#element_validate'][] = 'token_element_validate';
danielebarchiesi@0:         $element[$sub_key] += array('#token_types' => array('user'));
danielebarchiesi@0:       }
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   // Add the token tree UI.
danielebarchiesi@0:   $form['email']['token_tree'] = array(
danielebarchiesi@0:     '#theme' => 'token_tree',
danielebarchiesi@0:     '#token_types' => array('user'),
danielebarchiesi@0:     '#show_restricted' => TRUE,
danielebarchiesi@0:     '#dialog' => TRUE,
danielebarchiesi@0:     '#weight' => 90,
danielebarchiesi@0:   );
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Build a tree array of tokens used for themeing or information.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @param $token_type
danielebarchiesi@0:  *   The token type.
danielebarchiesi@0:  * @param $flat_tree
danielebarchiesi@0:  *   A boolean if TRUE will only make a flat array of tokens, otherwise
danielebarchiesi@0:  *   child tokens will be inside the 'children' parameter of a token.
danielebarchiesi@0:  * @param $show_restricted
danielebarchiesi@0:  *   A boolean if TRUE will show restricted tokens. Otherwise they will be
danielebarchiesi@0:  *   hidden. Default is FALSE.
danielebarchiesi@0:  * @param $recursion_limit
danielebarchiesi@0:  *   An integer with the maximum number of token levels to recurse.
danielebarchiesi@0:  * @param $parents
danielebarchiesi@0:  *   An optional array with the current parents of the tokens.
danielebarchiesi@0:  */
danielebarchiesi@0: function token_build_tree($token_type, array $options = array()) {
danielebarchiesi@0:   global $language;
danielebarchiesi@0: 
danielebarchiesi@0:   // Static cache of already built token trees.
danielebarchiesi@0:   $trees = &drupal_static(__FUNCTION__, array());
danielebarchiesi@0: 
danielebarchiesi@0:   $options += array(
danielebarchiesi@0:     'restricted' => FALSE,
danielebarchiesi@0:     'depth' => 4,
danielebarchiesi@0:     'data' => array(),
danielebarchiesi@0:     'values' => FALSE,
danielebarchiesi@0:     'flat' => FALSE,
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   // Do not allow past the maximum token information depth.
danielebarchiesi@0:   $options['depth'] = min($options['depth'], TOKEN_MAX_DEPTH);
danielebarchiesi@0: 
danielebarchiesi@0:   // If $token_type is an entity, make sure we are using the actual token type.
danielebarchiesi@0:   if ($entity_token_type = token_get_entity_mapping('entity', $token_type)) {
danielebarchiesi@0:     $token_type = $entity_token_type;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   $tree_cid = "tree:{$token_type}:{$language->language}:{$options['depth']}";
danielebarchiesi@0: 
danielebarchiesi@0:   // If we do not have this base tree in the static cache, check {cache_token}
danielebarchiesi@0:   // otherwise generate and store it in the cache.
danielebarchiesi@0:   if (!isset($trees[$tree_cid])) {
danielebarchiesi@0:     if ($cache = cache_get($tree_cid, 'cache_token')) {
danielebarchiesi@0:       $trees[$tree_cid] = $cache->data;
danielebarchiesi@0:     }
danielebarchiesi@0:     else {
danielebarchiesi@0:       $options['parents'] = array();
danielebarchiesi@0:       $trees[$tree_cid] = _token_build_tree($token_type, $options);
danielebarchiesi@0:       cache_set($tree_cid, $trees[$tree_cid], 'cache_token');
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   $tree = $trees[$tree_cid];
danielebarchiesi@0: 
danielebarchiesi@0:   // If the user has requested a flat tree, convert it.
danielebarchiesi@0:   if (!empty($options['flat'])) {
danielebarchiesi@0:     $tree = token_flatten_tree($tree);
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   // Fill in token values.
danielebarchiesi@0:   if (!empty($options['values'])) {
danielebarchiesi@0:     $token_values = array();
danielebarchiesi@0:     foreach ($tree as $token => $token_info) {
danielebarchiesi@0:       if (!empty($token_info['dynamic']) || !empty($token_info['restricted'])) {
danielebarchiesi@0:         continue;
danielebarchiesi@0:       }
danielebarchiesi@0:       elseif (!isset($token_info['value'])) {
danielebarchiesi@0:         $token_values[$token_info['token']] = $token;
danielebarchiesi@0:       }
danielebarchiesi@0:     }
danielebarchiesi@0:     if (!empty($token_values)) {
danielebarchiesi@0:       $token_values = token_generate($token_type, $token_values, $options['data']);
danielebarchiesi@0:       foreach ($token_values as $token => $replacement) {
danielebarchiesi@0:         $tree[$token]['value'] = $replacement;
danielebarchiesi@0:       }
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   return $tree;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Flatten a token tree.
danielebarchiesi@0:  */
danielebarchiesi@0: function token_flatten_tree($tree) {
danielebarchiesi@0:   $result = array();
danielebarchiesi@0:   foreach ($tree as $token => $token_info) {
danielebarchiesi@0:     $result[$token] = $token_info;
danielebarchiesi@0:     if (isset($token_info['children']) && is_array($token_info['children'])) {
danielebarchiesi@0:       $result += token_flatten_tree($token_info['children']);
danielebarchiesi@0:       // unset($result[$token]['children']);
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0:   return $result;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Generate a token tree.
danielebarchiesi@0:  */
danielebarchiesi@0: function _token_build_tree($token_type, array $options) {
danielebarchiesi@0:   $options += array(
danielebarchiesi@0:     'parents' => array(),
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   $info = token_get_info();
danielebarchiesi@0:   if ($options['depth'] <= 0 || !isset($info['types'][$token_type]) || !isset($info['tokens'][$token_type])) {
danielebarchiesi@0:     return array();
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   $tree = array();
danielebarchiesi@0:   foreach ($info['tokens'][$token_type] as $token => $token_info) {
danielebarchiesi@0:     // Build the raw token string.
danielebarchiesi@0:     $token_parents = $options['parents'];
danielebarchiesi@0:     if (empty($token_parents)) {
danielebarchiesi@0:       // If the parents array is currently empty, assume the token type is its
danielebarchiesi@0:       // parent.
danielebarchiesi@0:       $token_parents[] = $token_type;
danielebarchiesi@0:     }
danielebarchiesi@0:     elseif (in_array($token, array_slice($token_parents, 1))) {
danielebarchiesi@0:       // Prevent duplicate recursive tokens. For example, this will prevent
danielebarchiesi@0:       // the tree from generating the following tokens or deeper:
danielebarchiesi@0:       // [comment:parent:parent]
danielebarchiesi@0:       // [comment:parent:root:parent]
danielebarchiesi@0:       continue;
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     $token_parents[] = $token;
danielebarchiesi@0:     if (!empty($token_info['dynamic'])) {
danielebarchiesi@0:       $token_parents[] = '?';
danielebarchiesi@0:     }
danielebarchiesi@0:     $raw_token = '[' . implode(':', $token_parents) . ']';
danielebarchiesi@0:     $tree[$raw_token] = $token_info;
danielebarchiesi@0:     $tree[$raw_token]['raw token'] = $raw_token;
danielebarchiesi@0: 
danielebarchiesi@0:     // Add the token's real name (leave out the base token type).
danielebarchiesi@0:     $tree[$raw_token]['token'] = implode(':', array_slice($token_parents, 1));
danielebarchiesi@0: 
danielebarchiesi@0:     // Add the token's parent as its raw token value.
danielebarchiesi@0:     if (!empty($options['parents'])) {
danielebarchiesi@0:       $tree[$raw_token]['parent'] = '[' . implode(':', $options['parents']) . ']';
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     // Fetch the child tokens.
danielebarchiesi@0:     if (!empty($token_info['type'])) {
danielebarchiesi@0:       $child_options = $options;
danielebarchiesi@0:       $child_options['depth']--;
danielebarchiesi@0:       $child_options['parents'] = $token_parents;
danielebarchiesi@0:       $tree[$raw_token]['children'] = _token_build_tree($token_info['type'], $child_options);
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   return $tree;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Get a translated menu link by its mlid, without access checking.
danielebarchiesi@0:  *
danielebarchiesi@0:  * This function is a copy of menu_link_load() but with its own cache and a
danielebarchiesi@0:  * simpler query to load the link. This also skips normal menu link access
danielebarchiesi@0:  * checking by using _token_menu_link_translate().
danielebarchiesi@0:  *
danielebarchiesi@0:  * @param $mlid
danielebarchiesi@0:  *   The mlid of the menu item.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @return
danielebarchiesi@0:  *   A menu link translated for rendering.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @see menu_link_load()
danielebarchiesi@0:  * @see _token_menu_link_translate()
danielebarchiesi@0:  */
danielebarchiesi@0: function token_menu_link_load($mlid) {
danielebarchiesi@0:   $cache = &drupal_static(__FUNCTION__, array());
danielebarchiesi@0: 
danielebarchiesi@0:   if (!is_numeric($mlid)) {
danielebarchiesi@0:     return FALSE;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   if (!isset($cache[$mlid])) {
danielebarchiesi@0:     $item = db_query("SELECT * FROM {menu_links} ml LEFT JOIN {menu_router} m ON m.path = ml.router_path WHERE ml.mlid = :mlid", array(':mlid' => $mlid))->fetchAssoc();
danielebarchiesi@0:     if (!empty($item)) {
danielebarchiesi@0:       _token_menu_link_translate($item);
danielebarchiesi@0:     }
danielebarchiesi@0:     $cache[$mlid] = $item;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   return $cache[$mlid];
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Get a translated book menu link by its mlid, without access checking.
danielebarchiesi@0:  *
danielebarchiesi@0:  * This function is a copy of book_link_load() but with its own cache and a
danielebarchiesi@0:  * simpler query to load the link. This also skips normal menu link access
danielebarchiesi@0:  * checking by using _token_menu_link_translate().
danielebarchiesi@0:  *
danielebarchiesi@0:  * @param $mlid
danielebarchiesi@0:  *   The mlid of the book menu item.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @return
danielebarchiesi@0:  *   A book menu link translated for rendering.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @see book_link_load()
danielebarchiesi@0:  * @see _token_menu_link_translate()
danielebarchiesi@0:  */
danielebarchiesi@0: function token_book_link_load($mlid) {
danielebarchiesi@0:   $cache = &drupal_static(__FUNCTION__, array());
danielebarchiesi@0: 
danielebarchiesi@0:   if (!is_numeric($mlid)) {
danielebarchiesi@0:     return FALSE;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   if (!isset($cache[$mlid])) {
danielebarchiesi@0:     $item = db_query("SELECT * FROM {menu_links} ml INNER JOIN {book} b ON b.mlid = ml.mlid LEFT JOIN {menu_router} m ON m.path = ml.router_path WHERE ml.mlid = :mlid", array(':mlid' => $mlid))->fetchAssoc();
danielebarchiesi@0:     if (!empty($item)) {
danielebarchiesi@0:       _token_menu_link_translate($item);
danielebarchiesi@0:     }
danielebarchiesi@0:     $cache[$mlid] = $item;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   return $cache[$mlid];
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: function _token_menu_link_translate(&$item) {
danielebarchiesi@0:   $map = array();
danielebarchiesi@0: 
danielebarchiesi@0:   if (!is_array($item['options'])) {
danielebarchiesi@0:     $item['options'] = unserialize($item['options']);
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   if ($item['external']) {
danielebarchiesi@0:     $item['access'] = 1;
danielebarchiesi@0:     $item['href'] = $item['link_path'];
danielebarchiesi@0:     $item['title'] = $item['link_title'];
danielebarchiesi@0:     $item['localized_options'] = $item['options'];
danielebarchiesi@0:   }
danielebarchiesi@0:   else {
danielebarchiesi@0:     // Complete the path of the menu link with elements from the current path,
danielebarchiesi@0:     // if it contains dynamic placeholders (%).
danielebarchiesi@0:     $map = explode('/', $item['link_path']);
danielebarchiesi@0:     if (strpos($item['link_path'], '%') !== FALSE) {
danielebarchiesi@0:       // Invoke registered to_arg callbacks.
danielebarchiesi@0:       if (!empty($item['to_arg_functions'])) {
danielebarchiesi@0:         _menu_link_map_translate($map, $item['to_arg_functions']);
danielebarchiesi@0:       }
danielebarchiesi@0:     }
danielebarchiesi@0:     $item['href'] = implode('/', $map);
danielebarchiesi@0: 
danielebarchiesi@0:     // Skip links containing untranslated arguments.
danielebarchiesi@0:     if (strpos($item['href'], '%') !== FALSE) {
danielebarchiesi@0:       $item['access'] = FALSE;
danielebarchiesi@0:       return FALSE;
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     $item['access'] = TRUE;
danielebarchiesi@0:     _menu_item_localize($item, $map, TRUE);
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   // Allow other customizations - e.g. adding a page-specific query string to the
danielebarchiesi@0:   // options array. For performance reasons we only invoke this hook if the link
danielebarchiesi@0:   // has the 'alter' flag set in the options array.
danielebarchiesi@0:   if (!empty($item['options']['alter'])) {
danielebarchiesi@0:     drupal_alter('translated_menu_link', $item, $map);
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   return $map;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Prepare a string for use as a valid token name.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @param $name
danielebarchiesi@0:  *   The token name to clean.
danielebarchiesi@0:  * @return
danielebarchiesi@0:  *   The cleaned token name.
danielebarchiesi@0:  */
danielebarchiesi@0: function token_clean_token_name($name) {
danielebarchiesi@0:   static $names = array();
danielebarchiesi@0: 
danielebarchiesi@0:   if (!isset($names[$name])) {
danielebarchiesi@0:     $cleaned_name = strtr($name, array(' ' => '-', '_' => '-', '/' => '-', '[' => '-', ']' => ''));
danielebarchiesi@0:     $cleaned_name = preg_replace('/[^\w\-]/i', '', $cleaned_name);
danielebarchiesi@0:     $cleaned_name = trim($cleaned_name, '-');
danielebarchiesi@0:     $names[$name] = $cleaned_name;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   return $names[$name];
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Do not use this function yet. Its API has not been finalized.
danielebarchiesi@0:  */
danielebarchiesi@0: function token_render_array(array $array, array $options = array()) {
danielebarchiesi@0:   $rendered = array();
danielebarchiesi@0:   foreach (element_children($array) as $key) {
danielebarchiesi@0:     $value = $array[$key];
danielebarchiesi@0:     $rendered[] = is_array($value) ? render($value) : (string) $value;
danielebarchiesi@0:   }
danielebarchiesi@0:   if (!empty($options['sanitize'])) {
danielebarchiesi@0:     $rendered = array_map('check_plain', $rendered);
danielebarchiesi@0:   }
danielebarchiesi@0:   $join = isset($options['join']) ? $options['join'] : ', ';
danielebarchiesi@0:   return implode($join, $rendered);
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Do not use this function yet. Its API has not been finalized.
danielebarchiesi@0:  */
danielebarchiesi@0: function token_render_array_value($value, array $options = array()) {
danielebarchiesi@0:   $rendered = is_array($value) ? render($value) : (string) $value;
danielebarchiesi@0:   if (!empty($options['sanitize'])) {
danielebarchiesi@0:     $rendered = check_plain($rendered);
danielebarchiesi@0:   }
danielebarchiesi@0:   return $rendered;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Copy of drupal_render_cache_get() that does not care about request method.
danielebarchiesi@0:  */
danielebarchiesi@0: function token_render_cache_get($elements) {
danielebarchiesi@0:   if (!$cid = drupal_render_cid_create($elements)) {
danielebarchiesi@0:     return FALSE;
danielebarchiesi@0:   }
danielebarchiesi@0:   $bin = isset($elements['#cache']['bin']) ? $elements['#cache']['bin'] : 'cache';
danielebarchiesi@0: 
danielebarchiesi@0:   if (!empty($cid) && $cache = cache_get($cid, $bin)) {
danielebarchiesi@0:     // Add additional libraries, JavaScript, CSS and other data attached
danielebarchiesi@0:     // to this element.
danielebarchiesi@0:     if (isset($cache->data['#attached'])) {
danielebarchiesi@0:       drupal_process_attached($cache->data);
danielebarchiesi@0:     }
danielebarchiesi@0:     // Return the rendered output.
danielebarchiesi@0:     return $cache->data['#markup'];
danielebarchiesi@0:   }
danielebarchiesi@0:   return FALSE;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Coyp of drupal_render_cache_set() that does not care about request method.
danielebarchiesi@0:  */
danielebarchiesi@0: function token_render_cache_set(&$markup, $elements) {
danielebarchiesi@0:   // This should only run of drupal_render_cache_set() did not.
danielebarchiesi@0:   if (in_array($_SERVER['REQUEST_METHOD'], array('GET', 'HEAD'))) {
danielebarchiesi@0:     return FALSE;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   $original_method = $_SERVER['REQUEST_METHOD'];
danielebarchiesi@0:   $_SERVER['REQUEST_METHOD'] = 'GET';
danielebarchiesi@0:   drupal_render_cache_set($markup, $elements);
danielebarchiesi@0:   $_SERVER['REQUEST_METHOD'] = $original_method;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: function token_menu_link_load_all_parents($mlid) {
danielebarchiesi@0:   $cache = &drupal_static(__FUNCTION__, array());
danielebarchiesi@0: 
danielebarchiesi@0:   if (!is_numeric($mlid)) {
danielebarchiesi@0:     return array();
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   if (!isset($cache[$mlid])) {
danielebarchiesi@0:     $cache[$mlid] = array();
danielebarchiesi@0:     $plid = db_query("SELECT plid FROM {menu_links} WHERE mlid = :mlid", array(':mlid' => $mlid))->fetchField();
danielebarchiesi@0:     while ($plid && $parent = token_menu_link_load($plid)) {
danielebarchiesi@0:       $cache[$mlid] = array($plid => $parent['title']) + $cache[$mlid];
danielebarchiesi@0:       $plid = $parent['plid'];
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   return $cache[$mlid];
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: function token_taxonomy_term_load_all_parents($tid) {
danielebarchiesi@0:   $cache = &drupal_static(__FUNCTION__, array());
danielebarchiesi@0: 
danielebarchiesi@0:   if (!is_numeric($tid)) {
danielebarchiesi@0:     return array();
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   if (!isset($cache[$tid])) {
danielebarchiesi@0:     $cache[$tid] = array();
danielebarchiesi@0:     $parents = taxonomy_get_parents_all($tid);
danielebarchiesi@0:     array_shift($parents); // Remove this term from the array.
danielebarchiesi@0:     $parents = array_reverse($parents);
danielebarchiesi@0:     foreach ($parents as $term) {
danielebarchiesi@0:       $cache[$tid][$term->tid] = entity_label('taxonomy_term', $term);
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   return $cache[$tid];
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Load the preferred menu link associated with a node.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @param $node
danielebarchiesi@0:  *   A node object.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @return
danielebarchiesi@0:  *   A menu link array from token_menu_link_load() or FALSE if a menu link was
danielebarchiesi@0:  *   not found.
danielebarchiesi@0:  *
danielebarchiesi@0:  * @see menu_node_prepare()
danielebarchiesi@0:  * @see token_menu_link_load()
danielebarchiesi@0:  */
danielebarchiesi@0: function token_node_menu_link_load($node) {
danielebarchiesi@0:   $cache = &drupal_static(__FUNCTIon__, array());
danielebarchiesi@0: 
danielebarchiesi@0:   if (!isset($cache[$node->nid])) {
danielebarchiesi@0:     $mlid = FALSE;
danielebarchiesi@0: 
danielebarchiesi@0:     // Nodes do not have their menu links loaded via menu_node_load().
danielebarchiesi@0:     if (!isset($node->menu)) {
danielebarchiesi@0:       // We need to clone the node as menu_node_prepare() may cause data loss.
danielebarchiesi@0:       // @see http://drupal.org/node/1317926
danielebarchiesi@0:       $menu_node = clone $node;
danielebarchiesi@0:       menu_node_prepare($menu_node);
danielebarchiesi@0:       $mlid = !empty($menu_node->menu['mlid']) ? $menu_node->menu['mlid'] : FALSE;
danielebarchiesi@0:     }
danielebarchiesi@0:     else {
danielebarchiesi@0:       $mlid = !empty($node->menu['mlid']) ? $node->menu['mlid'] : FALSE;
danielebarchiesi@0:     }
danielebarchiesi@0: 
danielebarchiesi@0:     $cache[$node->nid] = $mlid;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   return $cache[$node->nid] ? token_menu_link_load($cache[$node->nid]) : FALSE;
danielebarchiesi@0: }