token.inc 9.61 KB
Newer Older
1 2 3 4 5 6
<?php

/**
 * @file
 * Drupal placeholder/token replacement system.
 *
7
 * API functions for replacing placeholders in text with meaningful values.
8
 *
9 10 11 12 13 14 15 16
 * For example: When configuring automated emails, an administrator enters
 * standard text for the email. Variables like the title of a node and the date
 * the email was sent can be entered as placeholders like [node:title] and
 * [date:short]. When a Drupal module prepares to send the email, it can call
 * the token_replace() function, passing in the text. The token system will
 * scan the text for placeholder tokens, give other modules an opportunity to
 * replace them with meaningful text, then return the final product to the
 * original module.
17 18 19
 *
 * Tokens follow the form: [$type:$name], where $type is a general class of
 * tokens like 'node', 'user', or 'comment' and $name is the name of a given
20
 * placeholder. For example, [node:title] or [node:created:since].
21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39
 *
 * In addition to raw text containing placeholders, modules may pass in an array
 * of objects to be used when performing the replacement. The objects should be
 * keyed by the token type they correspond to. For example:
 *
 * @code
 * // Load a node and a user, then replace tokens in the text.
 * $text = 'On [date:short], [user:name] read [node:title].';
 * $node = node_load(1);
 * $user = user_load(1);
 *
 * // [date:...] tokens use the current date automatically.
 * $data = array('node' => $node, 'user' => $user);
 * return token_replace($text, $data);
 * @endcode
 *
 * Some tokens may be chained in the form of [$type:$pointer:$name], where $type
 * is a normal token type, $pointer is a reference to another token type, and
 * $name is the name of a given placeholder. For example, [node:author:mail]. In
40 41
 * that example, 'author' is a pointer to the 'user' account that created the
 * node, and 'mail' is a placeholder available for any 'user'.
42 43 44 45 46 47 48
 *
 * @see token_replace()
 * @see hook_tokens()
 * @see hook_token_info()
 */

/**
49
 * Replaces all tokens in a given string with appropriate values.
50 51
 *
 * @param $text
52
 *   A string potentially containing replaceable tokens.
53 54 55 56
 * @param $data
 *   (optional) An array of keyed objects. For simple replacement scenarios
 *   'node', 'user', and others are common keys, with an accompanying node or
 *   user object being the value. Some token types, like 'site', do not require
57 58
 *   any explicit information from $data and can be replaced even if it is
 *   empty.
59 60 61
 * @param $options
 *   (optional) A keyed array of settings and flags to control the token
 *   replacement process. Supported options are:
62
 *   - langcode: A language code to be used when generating locale-sensitive
63
 *     tokens.
64 65 66 67 68
 *   - callback: A callback function that will be used to post-process the
 *     array of token replacements after they are generated. For example, a
 *     module using tokens in a text-only email might provide a callback to
 *     strip HTML entities from token values before they are inserted into the
 *     final text.
69 70 71
 *   - clear: A boolean flag indicating that tokens should be removed from the
 *     final text if no replacement value can be generated.
 *   - sanitize: A boolean flag indicating that tokens should be sanitized for
72 73 74 75 76
 *     display to a web browser. Defaults to TRUE. Developers who set this
 *     option to FALSE assume responsibility for running filter_xss(),
 *     check_plain() or other appropriate scrubbing functions before displaying
 *     data to users.
 *
77 78 79 80
 * @return
 *   Text with tokens replaced.
 */
function token_replace($text, array $data = array(), array $options = array()) {
81 82 83 84 85
  $text_tokens = token_scan($text);
  if (empty($text_tokens)) {
    return $text;
  }

86
  $replacements = array();
87
  foreach ($text_tokens as $type => $tokens) {
88
    $replacements += token_generate($type, $tokens, $data, $options);
89 90 91
    if (!empty($options['clear'])) {
      $replacements += array_fill_keys($tokens, '');
    }
92 93 94
  }

  // Optionally alter the list of replacement values.
95
  if (!empty($options['callback'])) {
96 97 98 99 100 101
    $function = $options['callback'];
    $function($replacements, $data, $options);
  }

  $tokens = array_keys($replacements);
  $values = array_values($replacements);
102

103 104 105 106
  return str_replace($tokens, $values, $text);
}

/**
107
 * Builds a list of all token-like patterns that appear in the text.
108 109 110
 *
 * @param $text
 *   The text to be scanned for possible tokens.
111
 *
112 113 114 115
 * @return
 *   An associative array of discovered tokens, grouped by type.
 */
function token_scan($text) {
116 117 118 119 120 121 122 123 124 125
  // Matches tokens with the following pattern: [$type:$name]
  // $type and $name may not contain [ ] or whitespace characters.
  // $type may not contain : characters, but $name may.
  preg_match_all('/
    \[             # [ - pattern start
    ([^\s\[\]:]*)  # match $type not containing whitespace : [ or ]
    :              # : - separator
    ([^\s\[\]]*)   # match $name not containing whitespace [ or ]
    \]             # ] - pattern end
    /x', $text, $matches);
126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141

  $types = $matches[1];
  $tokens = $matches[2];

  // Iterate through the matches, building an associative array containing
  // $tokens grouped by $types, pointing to the version of the token found in
  // the source text. For example, $results['node']['title'] = '[node:title]';
  $results = array();
  for ($i = 0; $i < count($tokens); $i++) {
    $results[$types[$i]][$tokens[$i]] = $matches[0][$i];
  }

  return $results;
}

/**
142
 * Generates replacement values for a list of tokens.
143 144 145 146 147 148 149 150 151 152
 *
 * @param $type
 *   The type of token being replaced. 'node', 'user', and 'date' are common.
 * @param $tokens
 *   An array of tokens to be replaced, keyed by the literal text of the token
 *   as it appeared in the source text.
 * @param $data
 *   (optional) An array of keyed objects. For simple replacement scenarios
 *   'node', 'user', and others are common keys, with an accompanying node or
 *   user object being the value. Some token types, like 'site', do not require
153 154
 *   any explicit information from $data and can be replaced even if it is
 *   empty.
155 156 157
 * @param $options
 *   (optional) A keyed array of settings and flags to control the token
 *   replacement process. Supported options are:
158
 *   - langcode: A language code to be used when generating locale-sensitive
159
 *     tokens.
160 161 162 163 164
 *   - callback: A callback function that will be used to post-process the
 *     array of token replacements after they are generated. Can be used when
 *     modules require special formatting of token text, for example URL
 *     encoding or truncation to a specific length.
 *   - sanitize: A boolean flag indicating that tokens should be sanitized for
165 166 167
 *     display to a web browser. Developers who set this option to FALSE assume
 *     responsibility for running filter_xss(), check_plain() or other
 *     appropriate scrubbing functions before displaying data to users.
168
 *
169 170 171 172
 * @return
 *   An associative array of replacement values, keyed by the original 'raw'
 *   tokens that were found in the source text. For example:
 *   $results['[node:title]'] = 'My new node';
173 174 175
 *
 * @see hook_tokens()
 * @see hook_tokens_alter()
176 177 178
 */
function token_generate($type, array $tokens, array $data = array(), array $options = array()) {
  $options += array('sanitize' => TRUE);
179
  $replacements = module_invoke_all('tokens', $type, $tokens, $data, $options);
180

181 182 183 184 185 186 187 188
  // Allow other modules to alter the replacements.
  $context = array(
    'type' => $type,
    'tokens' => $tokens,
    'data' => $data,
    'options' => $options,
  );
  drupal_alter('tokens', $replacements, $context);
189

190
  return $replacements;
191 192 193
}

/**
194
 * Returns a list of tokens that begin with a specific prefix.
195
 *
196 197
 * Used to extract a group of 'chained' tokens (such as [node:author:name])
 * from the full list of tokens found in text. For example:
198 199 200 201
 * @code
 *   $data = array(
 *     'author:name' => '[node:author:name]',
 *     'title'       => '[node:title]',
202
 *     'created'     => '[node:created]',
203 204 205 206 207 208 209 210 211 212 213 214
 *   );
 *   $results = token_find_with_prefix($data, 'author');
 *   $results == array('name' => '[node:author:name]');
 * @endcode
 *
 * @param $tokens
 *   A keyed array of tokens, and their original raw form in the source text.
 * @param $prefix
 *   A textual string to be matched at the beginning of the token.
 * @param $delimiter
 *   An optional string containing the character that separates the prefix from
 *   the rest of the token. Defaults to ':'.
215
 *
216 217 218 219 220 221 222
 * @return
 *   An associative array of discovered tokens, with the prefix and delimiter
 *   stripped from the key.
 */
function token_find_with_prefix(array $tokens, $prefix, $delimiter = ':') {
  $results = array();
  foreach ($tokens as $token => $raw) {
223
    $parts = explode($delimiter, $token, 2);
224 225 226 227 228 229 230 231 232 233
    if (count($parts) == 2 && $parts[0] == $prefix) {
      $results[$parts[1]] = $raw;
    }
  }
  return $results;
}

/**
 * Returns metadata describing supported tokens.
 *
234 235 236 237
 * The metadata array contains token type, name, and description data as well
 * as an optional pointer indicating that the token chains to another set of
 * tokens.
 *
238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253
 * For example:
 * @code
 *   $data['types']['node'] = array(
 *     'name' => t('Nodes'),
 *     'description' => t('Tokens related to node objects.'),
 *   );
 *   $data['tokens']['node']['title'] = array(
 *     'name' => t('Title'),
 *     'description' => t('The title of the current node.'),
 *   );
 *   $data['tokens']['node']['author'] = array(
 *     'name' => t('Author'),
 *     'description' => t('The author of the current node.'),
 *     'type' => 'user',
 *   );
 * @endcode
254
 *
255 256 257 258 259 260 261 262 263 264 265
 * @return
 *   An associative array of token information, grouped by token type.
 */
function token_info() {
  $data = &drupal_static(__FUNCTION__);
  if (!isset($data)) {
    $data = module_invoke_all('token_info');
    drupal_alter('token_info', $data);
  }
  return $data;
}