-
Notifications
You must be signed in to change notification settings - Fork 0
/
realname.module
518 lines (457 loc) · 14.5 KB
/
realname.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
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
<?php
/**
* @file
* Provides token-based name displays for users.
*
* @todo Add a 'view realname' permission enabled by default
* @todo Allow users to login with their real name
* @todo Disable the username field
*/
/**
* @defgroup realname Real name API
*/
/**
* Implements hook_autoload_info().
*/
function realname_autoload_info() {
return array(
'RealnameBasicTest' => 'tests/realname.test',
'RealnameEntityTest' => 'tests/realname_entity.test',
);
}
/**
* Implements hook_config_info().
*/
function realname_config_info() {
$prefixes['realname.settings'] = array(
'label' => t('Real Name Settings'),
'group' => t('Configuration'),
);
return $prefixes;
}
/**
* Implements hook_permission().
*/
function realname_permission() {
return array(
'administer realname' => array(
'title' => t('Administer Real Name'),
'description' => t('Allows users to administer realname settings.'),
),
);
}
/**
* Implements hook_menu().
*/
function realname_menu() {
$items['admin/config/people/realname'] = array(
'title' => 'Real name',
'description' => 'Use tokens to configure how user names are displayed.',
'page callback' => 'drupal_get_form',
'page arguments' => array('realname_settings_form'),
'access arguments' => array('administer realname'),
'file' => 'realname.admin.inc',
);
$items['realname/autocomplete'] = array(
'page callback' => 'realname_autocomplete',
'page arguments' => array('', '', 2),
'access arguments' => array('access user profiles'),
'type' => MENU_CALLBACK,
);
$items['realname/autocomplete/%/%/%'] = array(
'page callback' => 'realname_autocomplete',
'page arguments' => array(2, 3, 4),
'access callback' => 'realname_autocomplete_access_callback',
'access arguments' => array(2, 3, 4),
'type' => MENU_CALLBACK,
);
return $items;
}
/**
* Implements hook_menu_alter().
*
* Replace user autocomplete with realname autocomplete.
*/
function realname_menu_alter(&$items) {
// Implement realname autocomplete.
$items['user/autocomplete']['page callback'] = 'realname_autocomplete';
$items['user/autocomplete']['page arguments'] = array('', '', 2);
}
/**
* Implements hook_field_extra_fields().
*/
function realname_field_extra_fields() {
$fields['user']['user']['display']['realname'] = array(
'label' => t('Real name'),
'description' => t('Real name'),
'weight' => -1,
);
return $fields;
}
/**
* Implements hook_user_format_name_alter().
*/
function realname_user_format_name_alter(&$name, $account) {
static $in_username_alter = FALSE;
if (empty($account->uid)) {
// Don't alter anonymous users or objects that do not have any user ID.
return;
}
// Real name was loaded/generated via hook_user_load(), so re-use it.
if (isset($account->realname)) {
if (backdrop_strlen($account->realname)) {
// Only if the real name is a non-empty string is $name actually altered.
$name = $account->realname;
}
return;
}
// Real name was not yet available for the account so we need to generate it.
// Because tokens may call format_username() we need to prevent recursion.
if (!$in_username_alter) {
$in_username_alter = TRUE;
// If $account->realname was undefined, then the user account object was
// not properly loaded. We must enforce calling user_load().
if ($realname_account = user_load($account->uid)) {
realname_user_format_name_alter($name, $realname_account);
}
$in_username_alter = FALSE;
}
}
/**
* Implements hook_user_load().
*/
function realname_user_load($accounts) {
$realnames = realname_load_multiple($accounts);
foreach ($realnames as $uid => $realname) {
$accounts[$uid]->realname = $realname;
}
}
/**
* Implements hook_user_update().
*/
function realname_user_update(&$edit, $account, $category) {
// Since user data may have changed, update the realname and its cache.
$realnames = &backdrop_static('realname_load_multiple', array());
$realnames[$account->uid] = realname_update($account);
}
/**
* Implements hook_profile2_update().
*/
function realname_profile2_update($profile) {
$account = user_load($profile->uid);
if (is_object($account)) {
realname_update($account);
}
}
/**
* Implements hook_user_delete().
*/
function realname_user_delete($account) {
realname_delete($account->uid);
}
/**
* Implements hook_user_view().
*/
function realname_user_view($account, $view_mode, $langcode) {
if (user_view_access($account)) {
$markup = l($account->realname, 'user/' . $account->uid);
}
else {
$markup = check_plain($account->realname);
}
$account->content['realname'] = array(
'#entity_type' => 'custom',
'#bundle' => 'custom',
'#field_type' => 'text',
'#theme' => 'field',
'#field_name' => 'realname',
'#title' => t('Real name'),
'#label_display' => 'inline',
'#items' => array(TRUE),
0 => array('#markup' => $markup),
);
}
/**
* Implements hook_user_operations().
*/
function realname_user_operations() {
$operations['realname_update'] = array(
'label' => t('Update real name'),
'callback' => 'realname_user_operations_realname_update',
);
return $operations;
}
/**
* Callback function for admin mass generating user real names.
*
* @param array $uids
* An array of user IDs.
*/
function realname_user_operations_realname_update(array $uids) {
$accounts = user_load_multiple($uids);
foreach ($accounts as $account) {
realname_update($account);
}
}
/**
* Implements hook_action_info().
*/
function realname_action_info() {
$info['realname_action_realname_update'] = array(
'type' => 'user',
'label' => t('Update real name'),
'configurable' => FALSE,
);
return $info;
}
/**
* Implements hook_rules_action_info().
*/
function realname_rules_action_info() {
$items['user_realname_update'] = array(
'label' => t('Update real name'),
'base' => 'realname_action_realname_update',
'parameter' => array(
'account' => array(
'type' => 'user',
'label' => t('User'),
'save' => FALSE,
),
),
'group' => t('User'),
'access callback' => 'rules_user_integration_access',
);
return $items;
}
/**
* Action callback to update a user's realname.
*/
function realname_action_realname_update($account, $context = array()) {
realname_update($account);
}
/**
* Implements hook_views_api().
*/
function realname_views_api() {
return array('api' => 3);
}
/**
* @addtogroup realname
* @{
*/
/**
* Loads a real name.
*
* @param object $account
* A user account object.
*
* @return mixed
* The user's generated real name.
*/
function realname_load($account) {
$realnames = realname_load_multiple(array($account->uid => $account));
return reset($realnames);
}
/**
* Loads multiple real names.
*
* @param array $accounts
* An array of user account objects keyed by user ID.
*
* @return array
* An array of real names keyed by user ID.
*/
function realname_load_multiple(array $accounts) {
$realnames = &backdrop_static(__FUNCTION__, array());
if ($new_accounts = array_diff_key($accounts, $realnames)) {
// Attempt to fetch realnames from the database first.
$realnames += db_query("SELECT uid, realname FROM {realname} WHERE uid IN (:uids)", array(':uids' => array_keys($new_accounts)))->fetchAllKeyed();
// For each account that was not present in the database, generate its
// real name.
foreach ($new_accounts as $uid => $account) {
if (!isset($realnames[$uid])) {
$realnames[$uid] = realname_update($account);
}
}
}
return array_intersect_key($realnames, $accounts);
}
/**
* Update the realname for a user account.
*
* @param object $account
* A user account object.
*
* @return string
* A string with the real name.
*
* @see hook_realname_pattern_alter()
* @see hook_realname_alter()
* @see hook_realname_update()
*/
function realname_update($account) {
// Get the default pattern and allow other modules to alter it.
$pattern = config_get('realname.settings','realname_pattern');
backdrop_alter('realname_pattern', $pattern, $account);
// Perform token replacement on the real name pattern.
$realname = token_replace($pattern, array('user' => $account), array('clear' => TRUE, 'sanitize' => FALSE));
// Remove any HTML tags.
$realname = strip_tags(decode_entities($realname));
// Remove double spaces (if a token had no value).
$realname = preg_replace('/ {2,}/', ' ', $realname);
// The name must be trimmed to 255 characters before inserting into the
// database.
$realname = truncate_utf8(trim($realname), 255);
// Allow other modules to alter the generated realname.
backdrop_alter('realname', $realname, $account);
// Save to the database and the static cache.
db_merge('realname')
->key(array('uid' => $account->uid))
->fields(array(
'realname' => $realname,
'created' => REQUEST_TIME,
))
->execute();
// Allow modules to react to the realname being updated.
module_invoke_all('realname_update', $realname, $account);
$account->realname = $realname;
return $realname;
}
/**
* Delete a real name.
*
* @param int $uid
* A user ID.
*/
function realname_delete($uid) {
return realname_delete_multiple(array($uid));
}
/**
* Delete multiple real names.
*
* @param array $uids
* An array of user IDs.
*/
function realname_delete_multiple(array $uids) {
db_delete('realname')->condition('uid', $uids, 'IN')->execute();
backdrop_static_reset('realname_load_multiple');
entity_get_controller('user')->resetCache($uids);
}
/**
* Delete all real names.
*/
function realname_delete_all() {
db_truncate('realname')->execute();
backdrop_static_reset('realname_load_multiple');
entity_get_controller('user')->resetCache();
}
/**
* @} End of "addtogroup realname".
*/
/**
* Menu callback.
*
* Retrieve a JSON object containing autocomplete suggestions
* for existing users based on their generated real names.
*/
function realname_autocomplete($field_name, $entity_type, $bundle_name, $string = '') {
$instance = field_info_instance($entity_type, $field_name, $bundle_name);
$matches = array();
// User entityreference autocomplete fields.
if ($instance['widget']['type'] == 'entityreference_autocomplete' && !empty($string)) {
$query = db_select('users', 'u');
$query->leftJoin('realname', 'rn', 'u.uid = rn.uid');
$query->fields('u', array('uid', 'name'));
if ($instance['widget']['settings']['match_operator'] == 'CONTAINS') {
$query->condition(db_or()
->condition('rn.realname', '%' . db_like($string) . '%', 'LIKE')
->condition('u.name', '%' . db_like($string) . '%', 'LIKE')
);
}
else {
$query->condition(db_or()
->condition('rn.realname', db_like($string) . '%', 'LIKE')
->condition('u.name', db_like($string) . '%', 'LIKE')
);
}
$query->range(0, 10);
$uids = $query->execute()->fetchCol();
$accounts = user_load_multiple($uids);
foreach ($accounts as $account) {
$matches[t('!account (@uid)', array('!account' => user_format_name($account), '@uid' => $account->uid))] = t('!realname (@username)', array('!realname' => user_format_name($account), '@username' => $account->name));
}
}
// User autocomplete fields.
elseif (!empty($string)) {
$query = db_select('users', 'u');
$query->leftJoin('realname', 'rn', 'u.uid = rn.uid');
$query->fields('u', array('uid', 'name'));
$query->condition(db_or()
->condition('rn.realname', db_like($string) . '%', 'LIKE')
->condition('u.name', db_like($string) . '%', 'LIKE')
);
$query->range(0, 10);
$uids = $query->execute()->fetchCol();
$accounts = user_load_multiple($uids);
foreach ($accounts as $account) {
$matches[$account->name] = t('!realname (@username)', array('!realname' => user_format_name($account), '@username' => $account->name));
}
}
backdrop_json_output($matches);
}
/**
* Menu Access callback for the autocomplete widget.
*
* @param string $field_name
* The name of the entity-reference field.
* @param string $entity_type
* The entity type.
* @param string $bundle_name
* The bundle name.
*
* @return bool
* True if user can access this menu item.
*/
function realname_autocomplete_access_callback($field_name, $entity_type, $bundle_name) {
$field = field_info_field($field_name);
$instance = field_info_instance($entity_type, $field_name, $bundle_name);
if (!$field || !$instance || $field['type'] != 'entityreference' || !field_access('edit', $field, $entity_type)) {
return FALSE;
}
return TRUE;
}
/**
* Implements hook_widget_form_alter().
*
* Overrides entityreference autocomplete fields that point to an entity
* of type 'user'.
*/
function realname_field_widget_form_alter(&$element, &$form_state, $context) {
if ($context['field']['type'] == 'entityreference') {
if ($context['field']['settings']['target_type'] == 'user') {
$element['target_id']['#autocomplete_path'] = 'realname/autocomplete/' . $context['field']['field_name'] . '/' . $context['instance']['entity_type'] . '/' . $context['instance']['bundle'];
}
}
}
/**
* Implements hook_form_FORM_ID_alter().
*/
function realname_form_user_admin_settings_alter(&$form, &$form_state, $form_id) {
$form['email_admin_created']['user_mail_register_admin_created_body']['#element_validate'][] = 'realname_username_raw_token_validate';
$form['email_no_approval_required']['user_mail_register_no_approval_required_body']['#element_validate'][] = 'realname_username_raw_token_validate';
$form['email_activated']['settings']['user_mail_status_activated_body']['#element_validate'][] = 'realname_username_raw_token_validate';
}
/**
* E-mail settings form validation callback.
*/
function realname_username_raw_token_validate(&$element, &$form_state) {
$value = isset($element['#value']) ? $element['#value'] : $element['#default_value'];
// Warns the site administrator that [user:name-raw], required to log in, is
// missing. You can force the deactivation of this message by setting the
// variable `realname_suppress_user_name_mail_validation` to TRUE (or any
// value that converts to TRUE, like '1').
if (!config_get('realname.settings','realname_suppress_user_name_mail_validation') && strpos($value, '[user:name-raw]') === FALSE) {
backdrop_set_message(t('The %element-title does not contain the <code>[user:name-raw]</code> token, which is necessary when using username for login.', array('%element-title' => $element['#title'])), 'warning');
}
return $element;
}