Newer
Older
Dries Buytaert
committed
<?php
// $Id$
/**
* @file
* Builds placeholder replacement tokens system-wide data.
*
* This file handles tokens for the global 'site' token type, as well as
* 'date' and 'file' tokens.
*/
/**
Dries Buytaert
committed
* Implements hook_token_info().
Dries Buytaert
committed
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
*/
function system_token_info() {
$types['site'] = array(
'name' => t("Site information"),
'description' => t("Tokens for site-wide settings and other global information."),
);
$types['date'] = array(
'name' => t("Dates"),
'description' => t("Tokens related to times and dates."),
);
$types['file'] = array(
'name' => t("Files"),
'description' => t("Tokens related to uploaded files."),
'needs-data' => 'file',
);
// Site-wide global tokens.
$site['name'] = array(
'name' => t("Name"),
'description' => t("The name of the site."),
);
$site['slogan'] = array(
'name' => t("Slogan"),
'description' => t("The slogan of the site."),
);
$site['mission'] = array(
'name' => t("Mission"),
'description' => t("The optional 'mission' of the site."),
);
$site['mail'] = array(
'name' => t("Email"),
'description' => t("The administrative email address for the site."),
);
$site['url'] = array(
'name' => t("URL"),
'description' => t("The URL of the site's front page."),
);
Dries Buytaert
committed
$site['url-brief'] = array(
'name' => t("URL (brief)"),
'description' => t("The URL of the site's front page without the protocol."),
);
Dries Buytaert
committed
$site['login-url'] = array(
'name' => t("Login page"),
'description' => t("The URL of the site's login page."),
);
// Date related tokens.
Dries Buytaert
committed
$date['short'] = array(
'name' => t("Short format"),
'description' => t("A date in 'short' format. (%date)", array('%date' => format_date(REQUEST_TIME, 'short'))),
Dries Buytaert
committed
);
$date['medium'] = array(
'name' => t("Medium format"),
'description' => t("A date in 'medium' format. (%date)", array('%date' => format_date(REQUEST_TIME, 'medium'))),
);
Dries Buytaert
committed
$date['long'] = array(
'name' => t("Long format"),
'description' => t("A date in 'long' format. (%date)", array('%date' => format_date(REQUEST_TIME, 'long'))),
Dries Buytaert
committed
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
);
$date['custom'] = array(
'name' => t("Custom format"),
'description' => t("A date in a custom format. See !php-date for details.", array('!php-date' => l(t('the PHP documentation'), 'http://php.net/manual/en/function.date.php'))),
);
$date['since'] = array(
'name' => t("Time-since"),
'description' => t("A data in 'time-since' format. (%date)", array('%date' => format_interval(REQUEST_TIME - 360, 2))),
);
$date['raw'] = array(
'name' => t("Raw timestamp"),
'description' => t("A date in UNIX timestamp format (%date)", array('%date' => REQUEST_TIME)),
);
// File related tokens.
$file['fid'] = array(
'name' => t("File ID"),
'description' => t("The unique ID of the uploaded file."),
);
$file['uid'] = array(
'name' => t("User ID"),
'description' => t("The unique ID of the user who owns the file."),
);
$file['nid'] = array(
'name' => t("Node ID"),
'description' => t("The unique ID of the node the file is attached to."),
);
$file['name'] = array(
'name' => t("File name"),
'description' => t("The name of the file on disk."),
);
$file['description'] = array(
'name' => t("Description"),
'description' => t("An optional human-readable description of the file."),
);
$file['path'] = array(
'name' => t("Path"),
'description' => t("The location of the file on disk."),
);
$file['mime'] = array(
'name' => t("MIME type"),
'description' => t("The MIME type of the file."),
);
$file['size'] = array(
'name' => t("File size"),
'description' => t("The size of the file, in kilobytes."),
);
$file['path'] = array(
'name' => t("URL"),
'description' => t("The web-accessible URL for the file."),
);
$file['timestamp'] = array(
'name' => t("Timestamp"),
'description' => t("The date the file was most recently changed."),
'type' => 'date',
);
$file['node'] = array(
'name' => t("Node"),
'description' => t("The node the file is attached to."),
'type' => 'date',
);
$file['owner'] = array(
'name' => t("Owner"),
'description' => t("The user who originally uploaded the file."),
'type' => 'user',
);
return array(
'types' => $types,
'tokens' => array(
'site' => $site,
'date' => $date,
'file' => $file,
),
);
}
/**
Dries Buytaert
committed
* Implements hook_tokens().
Dries Buytaert
committed
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
*/
function system_tokens($type, $tokens, array $data = array(), array $options = array()) {
$url_options = array('absolute' => TRUE);
if (isset($language)) {
$url_options['language'] = $language;
}
$sanitize = !empty($options['sanitize']);
$replacements = array();
if ($type == 'site') {
foreach ($tokens as $name => $original) {
switch ($name) {
case 'name':
$site_name = variable_get('site_name', 'Drupal');
$replacements[$original] = $sanitize ? check_plain($site_name) : $site_name;
break;
case 'slogan':
$slogan = variable_get('site_slogan', '');
$replacements[$original] = $sanitize ? check_plain($slogan) : $slogan;
break;
case 'mission':
$mission = variable_get('site_mission', '');
$replacements[$original] = $sanitize ? filter_xss($mission) : $mission;
break;
case 'mail':
$replacements[$original] = variable_get('site_mail', '');
break;
case 'url':
$replacements[$original] = url('<front>', $url_options);
break;
Dries Buytaert
committed
case 'url-brief':
$replacements[$original] = preg_replace('!^https?://!', '', url('<front>', $url_options));
break;
Dries Buytaert
committed
case 'login-url':
$replacements[$original] = url('user', $url_options);
break;
}
}
}
elseif ($type == 'date') {
if (empty($data['date'])) {
$date = REQUEST_TIME;
}
else {
$date = $data['date'];
}
$langcode = (isset($language) ? $language->language : NULL);
foreach ($tokens as $name => $original) {
switch ($name) {
case 'raw':
$replacements[$original] = filter_xss($date);
break;
Dries Buytaert
committed
case 'short':
$replacements[$original] = format_date($date, 'short', '', NULL, $langcode);
Dries Buytaert
committed
break;
case 'medium':
$replacements[$original] = format_date($date, 'medium', '', NULL, $langcode);
break;
Dries Buytaert
committed
case 'long':
$replacements[$original] = format_date($date, 'long', '', NULL, $langcode);
Dries Buytaert
committed
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
break;
case 'since':
$replacements[$original] = format_interval((REQUEST_TIME - $date), 2, $langcode);
break;
}
}
if ($created_tokens = token_find_with_prefix($tokens, 'custom')) {
foreach ($created_tokens as $name => $original) {
$replacements[$original] = format_date($date, 'custom', $name, NULL, $langcode);
}
}
}
elseif ($type == 'file' && !empty($data['file'])) {
$file = $data['file'];
foreach ($tokens as $name => $original) {
switch ($name) {
// Basic keys and values.
case 'fid':
$replacements[$original] = $file->fid;
break;
case 'uid':
$replacements[$original] = $file->uid;
break;
case 'nid':
$replacements[$original] = $file->nid;
break;
// Essential file data
case 'name':
$replacements[$original] = $sanitize ? check_plain($file->filename) : $file->filename;
break;
case 'description':
$replacements[$original] = $sanitize ? filter_xss($file->description) : $file->description;
break;
case 'path':
$replacements[$original] = $sanitize ? filter_xss($file->filepath) : $file->filepath;
break;
case 'mime':
$replacements[$original] = $sanitize ? filter_xss($file->filemime) : $file->filemime;
break;
case 'size':
$replacements[$original] = format_size($file->filesize);
break;
case 'url':
$replacements[$original] = url(file_create_url($file->filepath), $url_options);
break;
// These tokens are default variations on the chained tokens handled below.
case 'node':
if ($nid = $file->nid) {
$node = node_load($file->nid);
$replacements[$original] = $sanitize ? filter_xss($node->title[LANGUAGE_NONE][0]['value']) : $node->title[LANGUAGE_NONE][0]['value'];
Dries Buytaert
committed
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
}
break;
case 'timestamp':
$replacements[$original] = format_date($file->timestamp, 'medium', '', NULL, (isset($language) ? $language->language : NULL));
break;
case 'owner':
$account = user_load($file->uid);
$replacements[$original] = $sanitize ? filter_xss($user->name) : $user->name;
break;
}
}
if ($node_tokens = token_find_with_prefix($tokens, 'node')) {
$node = node_load($file->nid);
$replacements += token_generate('node', $node_tokens, array('node' => $node), $language, $sanitize);
}
if ($date_tokens = token_find_with_prefix($tokens, 'timestamp')) {
$replacements += token_generate('date', $date_tokens, array('date' => $file->timestamp), $language, $sanitize);
}
if (($owner_tokens = token_find_with_prefix($tokens, 'owner')) && $account = user_load($file->uid)) {
$replacements += token_generate('user', $owner_tokens, array('user' => $account), $language, $sanitize);
}
}
return $replacements;
}