-
Notifications
You must be signed in to change notification settings - Fork 5
/
fast_token_browser.module
380 lines (332 loc) · 9.97 KB
/
fast_token_browser.module
1
2
3
4
5
6
7
8
9
10
11
12
13
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
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
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
151
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
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
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
286
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
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
<?php
/**
* @file
* Token Browser Module
*/
/**
* Implements hook_library().
*/
function fast_token_browser_library_info() {
$libraries['fast-token-browser'] = array(
'title' => 'Fast Token Browser',
'version' => '1.0',
'css' => array(
backdrop_get_path('module', 'fast_token_browser') . '/css/fast-token-browser.css' => array(),
),
'js' => array(
backdrop_get_path('module', 'fast_token_browser') . '/js/fast-token-browser.js' => array(),
array(
'type' => 'setting',
'data' => array('fastTokenBrowser' => array('token' => backdrop_get_token('token-browser-endpoint'))),
),
),
);
return $libraries;
}
/**
* Implements hook_menu().
*/
function fast_token_browser_menu() {
// AJAX endpoint for the assembled tree.
$items['token-browser/tree'] = array(
'page callback' => 'fast_token_browser_tree',
'access callback' => 'fast_token_browser_tree_access',
'theme callback' => 'ajax_base_page_theme',
'type' => MENU_CALLBACK,
);
// AJAX endpoint for retrieving a token.
$items['token-browser/token/%'] = array(
'page callback' => 'fast_token_browser_endpoint',
'page arguments' => array(2),
'delivery callback' => 'fast_token_browser_endpoint_output',
'access callback' => 'fast_token_browser_endpoint_access',
'type' => MENU_CALLBACK,
);
return $items;
}
/**
* Implements hook_theme().
*/
function fast_token_browser_theme() {
$themes['fast_token_browser_link'] = array(
'variables' => array(
'text' => t('Browse available tokens.'),
'token_types' => array(),
'global_types' => TRUE,
'dialog' => TRUE,
'show_restricted' => FALSE,
'click_insert' => TRUE,
),
'file' => 'fast_token_browser.theme.inc',
);
$themes['fast_token_browser'] = array(
'variables' => array(
'text' => t('Browse available tokens.'),
'token_types' => array(),
'global_types' => TRUE,
'dialog' => FALSE,
'show_restricted' => FALSE,
'click_insert' => TRUE,
),
'file' => 'fast_token_browser.theme.inc',
);
return $themes;
}
/**
* Implements hook_menu_alter().
*/
function fast_token_browser_menu_alter(&$items) {
$items['token/tree'] = $items['token-browser/tree'];
}
/**
* Implements hook_theme_registory_alter().
*/
function fast_token_browser_theme_registry_alter(&$theme_registry) {
$theme_registry['token_tree_link'] = $theme_registry['fast_token_browser_link'];
$theme_registry['token_tree'] = $theme_registry['fast_token_browser'];
}
/**
* Token browser tree page callback.
*/
function fast_token_browser_tree() {
$types = isset($_GET['token_types']) ? backdrop_json_decode($_GET['token_types']) : array();
$globals = isset($_GET['global_types']) ? backdrop_json_decode($_GET['global_types']) : TRUE;
$query = backdrop_get_query_parameters();
$show_restricted = $query['show_restricted'];
$out = fast_token_browser_tree_build_content($types, $globals, $show_restricted);
$out = fast_token_browser_render($out);
if (backdrop_is_ajax()) {
$dialog_options = array(
'dialogClass' => 'token-browser-dialog',
'width' => 900,
'modal' => FALSE,
'draggable' => TRUE,
'resizable' => TRUE,
'autoResize' => FALSE,
);
$commands = array(
ajax_command_open_dialog('#token-dialog', t('Token Browser'), $out, $dialog_options),
);
$return = array(
'#type' => 'ajax',
'#commands' => $commands,
);
return $return;
}
else {
return $out;
}
}
/**
* Token browser tree access callback.
*/
function fast_token_browser_tree_access() {
return isset($_GET['token']) && backdrop_valid_token($_GET['token'], 'token-browser');
}
/**
* Token browser JSON endpoint callback.
*
* @param string $type
* The token type.
*/
function fast_token_browser_endpoint($type) {
$definition = array(
'ancestors' => array(
'filter' => FILTER_CALLBACK,
'options' => 'filter_xss',
),
);
$input = filter_input_array(INPUT_GET, $definition);
$ancestors = isset($input['ancestors']) ? backdrop_json_decode($input['ancestors']) : array();
$show_restricted = (isset($_GET['show_restricted']) && $_GET['show_restricted'] == 'true') ? TRUE : FALSE;
return fast_token_browser_build_level($type, $ancestors, $show_restricted);
}
/**
* Token browser JSON endpoint access callback.
*/
function fast_token_browser_endpoint_access() {
return isset($_GET['token']) && backdrop_valid_token($_GET['token'], 'token-browser-endpoint');
}
/**
* Token browser JSON endpoint output callback.
*/
function fast_token_browser_endpoint_output($page_callback_result) {
if (is_int($page_callback_result)) {
backdrop_deliver_html_page($page_callback_result);
}
elseif (isset($page_callback_result)) {
backdrop_json_output($page_callback_result);
}
else {
backdrop_page_header();
backdrop_page_footer();
}
}
/**
* Genereate a render array of token types.
*
* @param array|string $types
* An array of token types to display in the tree or the string 'all'.
* @param bool $global_types
* Whether or not to include global types in the tree.
* @return array
* The constructed array of types keyed by type.
*/
function fast_token_browser_tree_build_content($types = array(), $global_types = TRUE, $show_restricted = FALSE) {
global $language;
$info = token_get_info();
$rows = array();
$posinset = 1;
if ($types === 'all') {
$types = array_keys($info['types']);
}
elseif ($global_types) {
$types = array_merge($types, token_get_global_token_types());
}
$hash = hash('sha256', serialize(array(
'token_types' => $types,
'global_types' => $global_types,
'language' => $language->langcode,
'show_restricted' => $show_restricted,
)));
$cid = 'token-browser-build:' . $hash;
if ($cache = cache_get($cid, 'cache_token')) {
return $cache->data;
}
foreach ($info['types'] as $type => $type_info) {
if (!in_array($type, $types) || substr($type, 0, 4) === 'list') {
continue;
}
$rows[] = array(
'data' => array(
array(
'data' => '<button aria-label="Expand">Expand</button>' . $type_info['name'],
'data-type' => $type,
'role' => 'gridcell',
'class' => array('token-name'),
),
array(
'data' => $type,
'role' => 'gridcell',
'class' => array('token-raw'),
),
array(
'data' => isset($type_info['description']) ? $type_info['description'] : '',
'role' => 'gridcell',
'class' => array('token-description'),
),
),
'role' => 'row',
'aria-level' => '1',
'aria-posinset' => $posinset++,
'aria-expanded' => 'false',
'aria-busy' => 'false',
'class' => array('tree-grid-parent'),
'no_striping' => TRUE,
);
}
$build = array(
'#theme' => 'table',
'#header' => array(
t('Name'),
t('Token'),
t('Description'),
),
'#rows' => $rows,
'#attributes' => array(
'role' => 'treetable',
'aria-label' => 'Token Browser',
'class' => array(
'tree-grid',
),
),
'#attached' => array(
'library' => array(
array('fast_token_browser', 'fast-token-browser'),
),
),
'#cache' => array(
'cid' => 'token-browser-render:' . $hash,
'bin' => 'cache_token',
),
);
cache_set($cid, $build, 'cache_token');
return $build;
}
/**
* Build a level of the token hierarchy.
*
* @param string $type
* The type to build a level for.
* @param array $ancestors
* The ancestors of the given type. This allows the complete token to be
* constructed.
* @param bool $show_restricted
* A flag to indicate if restricted tokens should be shown.
* @return array
* The constructed level of tokens as an array keyed by token.
*/
function fast_token_browser_build_level($type, array $ancestors, $show_restricted) {
global $language;
$level = array();
$info = token_get_info();
if (!isset($info['types'][$type]) || !isset($info['tokens'][$type])) {
return $level;
}
if ($entity_token = entity_get_info($type)) {
$type = $entity_token['token type'];
}
$cid = 'token-browser-level:' . hash('sha256', serialize(array(
'type' => $type,
'ancestors' => $ancestors,
'language' => $language->langcode,
'show_restricted' => $show_restricted,
)));
if ($cache = cache_get($cid, 'cache_token')) {
return $cache->data;
}
foreach ($info['tokens'][$type] as $child => $child_info) {
$raw_token_parts = $ancestors;
if (in_array($child, array_slice($raw_token_parts, 1), TRUE)) {
continue;
}
if (!$show_restricted && !empty($child_info['restricted'])) {
continue;
}
$raw_token_parts[] = $child;
if (!empty($child_info['dynamic'])) {
$raw_token_parts[] = '?';
}
$raw_token = '[' . implode(':', $raw_token_parts) . ']';
$level[$child]['name'] = $child_info['name'];
$level[$child]['description'] = $child_info['description'];
$level[$child]['token'] = $child;
if (isset($child_info['type']) && isset($info['types'][$child_info['type']])) {
$level[$child]['type'] = $child_info['type'];
}
$level[$child]['raw'] = $raw_token;
$level[$child]['ancestors'] = $ancestors;
}
cache_set($cid, $level, 'cache_token');
return $level;
}
/**
* Sets the request method to GET before calling backdrop_render().
*
* Fools backdrop_render_cache_set() and backdrop_render_cache_get() into
* working even when the request method is other than GET or HEAD. This is
* necessary because the jQuery.load() method requests data via POST, which
* would normally prevent render caching.
*
* @param array $elements
* The structured array describing the data to be rendered.
* @return string
* The result of backdrop_render().
*/
function fast_token_browser_render(array &$elements) {
$method = $_SERVER['REQUEST_METHOD'];
$_SERVER['REQUEST_METHOD'] = 'GET';
$output = backdrop_render($elements);
$_SERVER['REQUEST_METHOD'] = $method;
return $output;
}