profile.module 30.9 KB
Newer Older
Dries's avatar
   
Dries committed
1
<?php
Dries's avatar
Dries committed
2
// $Id$
Dries's avatar
   
Dries committed
3

Dries's avatar
   
Dries committed
4
5
6
7
8
/**
 * @file
 * Support for configurable user profiles.
 */

9
10
11
12
13
14
/**
 * Flags to define the visibility of a profile field.
 */
define('PROFILE_PRIVATE', 1);
define('PROFILE_PUBLIC', 2);
define('PROFILE_PUBLIC_LISTINGS', 3);
15
define('PROFILE_HIDDEN', 4);
16

Dries's avatar
   
Dries committed
17
18
19
/**
 * Implementation of hook_help().
 */
Dries's avatar
   
Dries committed
20
function profile_help($section) {
Dries's avatar
   
Dries committed
21
  switch ($section) {
22
    case 'admin/help#profile':
23
      $output = '<p>'. t('The profile module allows you to define custom fields (such as country, real name, age, ...) in the user profile. This permits users of a site to share more information about themselves, and can help community-based sites to organize users around profile fields.') .'</p>';
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
      $output .= t('<p>The following types of fields can be added to the user profile:</p>
<ul>
<li>single-line textfield</li>
<li>multi-line textfield</li>
<li>checkbox</li>
<li>list selection</li>
<li>freeform list</li>
<li>URL</li>
<li>date</li>
</ul>
');
      $output .= t('<p>You can</p>
<ul>
<li>view user <a href="%profile">profiles</a>.</li>
<li>administer profile settings: <a href="%admin-settings-profile">administer &gt;&gt; settings &gt;&gt; profiles</a>.</li>
</ul>
', array('%profile' => url('profile'), '%admin-settings-profile' => url('admin/settings/profile')));
41
      $output .= '<p>'. t('For more information please read the configuration and customization handbook <a href="%profile">Profile page</a>.', array('%profile' => 'http://drupal.org/handbook/modules/profile/')) .'</p>';
42
      return $output;
Dries's avatar
   
Dries committed
43
    case 'admin/modules#description':
44
      return t('Supports configurable user profiles.');
45
    case 'admin/settings/profile':
46
      return t('<p>Here you can define custom fields that users can fill in in their user profile (such as <em>country</em>, <em>real name</em>, <em>age</em>, ...).</p>');
Dries's avatar
   
Dries committed
47
48
49
  }
}

50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
/**
 * Implementation of hook_menu().
 */
function profile_menu($may_cache) {
  $items = array();

  if ($may_cache) {
    $items[] = array('path' => 'profile',
      'title' => t('user list'),
      'callback' => 'profile_browse',
      'access' => user_access('access user profiles'),
      'type' => MENU_SUGGESTED_ITEM);
    $items[] = array('path' => 'admin/settings/profile',
      'title' => t('profiles'),
      'callback' => 'profile_admin_overview');
    $items[] = array('path' => 'admin/settings/profile/add',
      'title' => t('add field'),
67
      'callback' => 'profile_field_form',
68
69
70
      'type' => MENU_CALLBACK);
    $items[] = array('path' => 'admin/settings/profile/edit',
      'title' => t('edit field'),
71
      'callback' => 'profile_field_form',
72
73
74
      'type' => MENU_CALLBACK);
    $items[] = array('path' => 'admin/settings/profile/delete',
      'title' => t('delete field'),
75
      'callback' => 'profile_field_delete',
76
77
78
79
80
81
      'type' => MENU_CALLBACK);
  }

  return $items;
}

82
83
84
85
86
87
88
89
90
91
92
93
94
/**
 * Implementation of hook_block().
 */
function profile_block($op = 'list', $delta = 0, $edit = array()) {

  if ($op == 'list') {
     $blocks[0]['info'] = t('Author information');

     return $blocks;
  }
  else if ($op == 'configure' && $delta == 0) {
    // Compile a list of fields to show
    $fields = array();
95
    $result = db_query('SELECT name, title, weight, visibility FROM {profile_fields} WHERE visibility IN (%d, %d) ORDER BY weight', PROFILE_PUBLIC, PROFILE_PUBLIC_LISTINGS);
96
97
98
99
    while ($record = db_fetch_object($result)) {
      $fields[$record->name] = $record->title;
    }
    $fields['user_profile'] = t('Link to full user profile');
100
101
102
103
104
105
    $form['profile_block_author_fields'] = array('#type' => 'checkboxes',
      '#title' => t('Profile fields to display'),
      '#default_value' => variable_get('profile_block_author_fields', NULL),
      '#options' => $fields,
      '#description' => t('Select which profile fields you wish to display in the block. Only fields designated as public in the <a href="%profile-admin">profile field configuration</a> are available.', array('%profile-admin' => url('admin/settings/profile'))),
    );
106
    return $form;
107
108
109
110
111
112
113
  }
  else if ($op == 'save' && $delta == 0) {
    variable_set('profile_block_author_fields', $edit['profile_block_author_fields']);
  }
  else if ($op == 'view') {
    if (user_access('access user profiles')) {
      if ((arg(0) == 'node') && is_numeric(arg(1)) && (arg(2) == NULL)) {
114
        $node = node_load(arg(1));
115
116
117
        $account = user_load(array('uid' => $node->uid));

        if ($use_fields = variable_get('profile_block_author_fields', array())) {
118
          // Compile a list of fields to show.
119
          $fields = array();
120
121
122
          $result = db_query('SELECT name, title, type, visibility, weight FROM {profile_fields} WHERE visibility IN (%d, %d) ORDER BY weight', PROFILE_PUBLIC, PROFILE_PUBLIC_LISTINGS);
          while ($record = db_fetch_object($result)) {
            // Ensure that field is displayed only if it is among the defined block fields and, if it is private, the user has appropriate permissions.
123
            if (isset($use_fields[$record->name]) && $use_fields[$record->name]) {
124
125
126
127
128
129
              $fields[] = $record;
            }
          }
        }

        if ($fields) {
130
          $fields = _profile_update_user_fields($fields, $account);
131
132
133
          $output .= theme('profile_block', $account, $fields, true);
        }

134
        if (isset($use_fields['user_profile']) && $use_fields['user_profile']) {
135
136
137
138
139
140
141
142
143
144
145
146
147
          $output .= '<div>' . l(t('View full user profile'), 'user/' . $account->uid) . '</div>';
        }
      }

      if ($output) {
         $block['subject'] = t('About %name', array('%name' => $account->name));
         $block['content'] = $output;
         return $block;
      }
    }
  }
}

Dries's avatar
   
Dries committed
148
/**
149
 * Implementation of hook_user().
Dries's avatar
   
Dries committed
150
 */
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
function profile_user($type, &$edit, &$user, $category = NULL) {
  switch ($type) {
    case 'load':
      return profile_load_profile($user);
    case 'register':
      return profile_form_profile($edit, $user, $category);
    case 'update':
    case 'insert':
      return profile_save_profile($edit, $user, $category);
    case 'view':
      return profile_view_profile($user);
    case 'form':
      return profile_form_profile($edit, $user, $category);
    case 'validate':
      return profile_validate_profile($edit, $category);
    case 'categories':
      return profile_categories();
168
169
    case 'delete':
      db_query('DELETE FROM {profile_values} WHERE uid = %d', $user->uid);
170
171
  }
}
Dries's avatar
   
Dries committed
172

173
/**
174
 * Menu callback: Generate a form to add/edit a user profile field.
175
 */
176
177
178
179
function profile_field_form($arg = NULL) {
  if (arg(3) == 'edit') {
    if (is_numeric($arg)) {
      $fid = $arg;
180

181
      $edit = db_fetch_array(db_query('SELECT * FROM {profile_fields} WHERE fid = %d', $fid));
182

183
184
185
186
187
188
189
190
      if (!$edit) {
        drupal_not_found();
        return;
      }
      drupal_set_title(t('edit %title', array('%title' => $edit['title'])));
      $form['fid'] = array('#type' => 'value',
        '#value' => $fid,
      );
191
      $type = $edit['type'];
192
    }
193
194
195
    else {
      drupal_not_found();
      return;
196
197
198
    }
  }
  else {
199
200
201
202
    $types = _profile_field_types();
    if (!isset($types[$arg])) {
      drupal_not_found();
      return;
203
    }
204
205
206
207
    $type = $arg;
    drupal_set_title(t('add new %type', array('%type' => $types[$type])));
    $edit = array('name' => 'profile_');
    $form['type'] = array('#type' => 'value', '#value' => $type);
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
  }
  $form['fields'] = array('#type' => 'fieldset',
    '#title' => t('Field settings'),
  );
  $form['fields']['category'] = array('#type' => 'textfield',
    '#title' => t('Category'),
    '#default_value' => $edit['category'],
    '#description' => t('The category the new field should be part of. Categories are used to group fields logically. An example category is "Personal information".'),
    '#required' => TRUE,
  );
  $form['fields']['title'] = array('#type' => 'textfield',
    '#title' => t('Title'),
    '#default_value' => $edit['title'],
    '#description' => t('The title of the new field. The title will be shown to the user. An example title is "Favorite color".'),
    '#required' => TRUE,
  );
  $form['fields']['name'] = array('#type' => 'textfield',
    '#title' => t('Form name'),
    '#default_value' => $edit['name'],
    '#description' => t('The name of the field. The form name is not shown to the user but used internally in the HTML code and URLs.
Unless you know what you are doing, it is highly recommended that you prefix the form name with <code>profile_</code> to avoid name clashes with other fields. Spaces or any other special characters except dash (-) and underscore (_) are not allowed. An example name is "profile_favorite_color" or perhaps just "profile_color".'),
    '#required' => TRUE,
  );
  $form['fields']['explanation'] = array('#type' => 'textarea',
    '#title' => t('Explanation'),
    '#default_value' => $edit['explanation'],
    '#description' => t('An optional explanation to go with the new field. The explanation will be shown to the user.'),
  );
  if ($type == 'selection') {
    $form['fields']['options'] = array('#type' => 'textarea',
      '#title' => t('Selection options'),
      '#default_value' => $edit['options'],
      '#description' => t('A list of all options. Put each option on a separate line. Example options are "red", "blue", "green", etc.'),
    );
  }
  $form['fields']['weight'] = array('#type' => 'weight',
    '#title' => t('Weight'),
    '#default_value' => $edit['weight'],
    '#delta' => 5,
    '#description' => t('The weights define the order in which the form fields are shown. Lighter fields "float up" towards the top of the category.'),
  );
  $form['fields']['visibility'] = array('#type' => 'radios',
    '#title' => t('Visibility'),
    '#default_value' => isset($edit['visibility']) ? $edit['visibility'] : PROFILE_PUBLIC,
    '#options' => array(PROFILE_HIDDEN => t('Hidden profile field, only accessible by administrators, modules and themes.'), PROFILE_PRIVATE => t('Private field, content only available to privileged users.'), PROFILE_PUBLIC => t('Public field, content shown on profile page but not used on member list pages.'), PROFILE_PUBLIC_LISTINGS => t('Public field, content shown on profile page and on member list pages.')),
  );
  if ($type == 'selection' || $type == 'list') {
    $form['fields']['page'] = array('#type' => 'textfield',
      '#title' => t('Page title'),
      '#default_value' => $edit['page'],
      '#description' => t('The title of the page showing all users with the specified field. The word <code>%value</code> will be substituted with the corresponding value. An example page title is "People whose favorite color is %value". This is only applicable for a public field.'),
    );
  }
  else {
    $form['fields']['page'] = array('#type' => 'textfield',
      '#title' => t('Page title'),
      '#default_value' => $edit['page'],
      '#description' => t('The title of the page showing all users with the specified field. Only applicable if the field is configured to be shown on member listings.'),
    );
  }
  $form['fields']['required'] = array('#type' => 'checkbox',
    '#title' => t('The user must enter a value.'),
    '#default_value' => $edit['required'],
  );
  $form['fields']['register'] = array('#type' => 'checkbox',
    '#title' => t('Visible in user registration form.'),
    '#default_value' => $edit['register'],
  );
  $form['submit'] = array('#type' => 'submit',
    '#value' => t('Save field'),
  );
279
  return drupal_get_form('profile_field_form', $form);
280
281
}

282
283
284
285
286
287
/**
 * Validate profile_field_form submissions.
 */
function profile_field_form_validate($form_id, $form_values) {
  // Validate the 'field name':
  if (eregi('[^a-z0-9_-]', $form_values['name'])) {
288
289
290
    form_set_error('name', t('The specified form name contains one or more illegal characters. Spaces or any other special characters expect dash (-) and underscore (_) are not allowed.'));
  }

291
  if (in_array($form_values['name'], user_fields())) {
292
293
294
    form_set_error('name', t('The specified form name is reserved for use by Drupal.'));
  }
  // Validate the category:
295
  if (!$form_values['category']) {
296
297
    form_set_error('category', t('You must enter a category.'));
  }
298
  if ($form_values['category'] == 'account') {
299
300
    form_set_error('category', t('The specified category name is reserved for use by Drupal.'));
  }
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
  $args1 = array($form_values['title'], $form_values['category']);
  $args2 = array($form_values['name']);
  $query_suffix = '';
  
  if (isset($form_values['fid'])) {
    $args1[] = $args2[] = $form_values['fid'];
    $query_suffix = ' AND fid != %d';
  }

  if (db_result(db_query("SELECT fid FROM {profile_fields} WHERE title = '%s' AND category = '%s'". $query_suffix, $args1))) {
    form_set_error('title', t('The specified title is already in use.'));
  }
  if (db_result(db_query("SELECT fid FROM {profile_fields} WHERE name = '%s'". $query_suffix, $args2))) {
    form_set_error('name', t('The specified name is already in use.'));
  }
316
317
318
}

/**
319
 * Process profile_field_form submissions.
320
 */
321
322
323
324
325
326
function profile_field_form_submit($form_id, $form_values) {
  if (!isset($form_values['fid'])) {
    db_query("INSERT INTO {profile_fields} (title, name, explanation, category, type, weight, required, register, visibility, options, page) VALUES ('%s', '%s', '%s', '%s', '%s', %d, %d, %d, %d, '%s', '%s')", $form_values['title'], $form_values['name'], $form_values['explanation'], $form_values['category'], $form_values['type'], $form_values['weight'], $form_values['required'], $form_values['register'], $form_values['visibility'], $form_values['options'], $form_values['page']);
    
    drupal_set_message(t('The field has been created.'));
    watchdog('profile', t('Profile field %field added under category %category.', array('%field' => theme('placeholder', $form_values['title']), '%category' => theme('placeholder', $form_values['category']))), WATCHDOG_NOTICE, l(t('view'), 'admin/settings/profile'));
327
328
  }
  else {
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
    db_query("UPDATE {profile_fields} SET title = '%s', name = '%s', explanation = '%s', category = '%s', weight = %d, required = %d, register = %d, visibility = %d, options = '%s', page = '%s' WHERE fid = %d", $form_values['title'], $form_values['name'], $form_values['explanation'], $form_values['category'], $form_values['weight'], $form_values['required'], $form_values['register'], $form_values['visibility'], $form_values['options'], $form_values['page'], $form_values['fid']);

    drupal_set_message(t('The field has been updated.'));
  }
  cache_clear_all();
  
  return 'admin/settings/profile';
}

/**
 * Menu callback; deletes a field from all user profiles.
 */
function profile_field_delete($fid) {
  $field = db_fetch_object(db_query("SELECT title FROM {profile_fields} WHERE fid = %d", $fid));
  if (!$field) {
    drupal_not_found();
    return;
346
  }
347
348
349
  $form['fid'] = array('#type' => 'value', '#value' => $fid);
  $form['title'] = array('#type' => 'value', '#value' => $field->title);
  
350
  return confirm_form('profile_field_delete', $form, t('Are you sure you want to delete the field %field?', array('%field' => theme('placeholder', $field->title))), 'admin/settings/profile', t('This action cannot be undone. If users have entered values into this field in their profile, these entries will also be deleted. If you want to keep the user-entered data, instead of deleting the field you may wish to <a href="%edit-field">edit this field</a> and change it to a %hidden-field so that it may only be accessed by administrators.', array('%edit-field' => url('admin/settings/profile/edit/' . $fid), '%hidden-field' => theme('placeholder', t('hidden profile field'))), t('Delete'), t('Cancel')));
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
}

/**
 * Process a field delete form submission.
 */
function profile_field_delete_submit($form_id, $form_values) {
  db_query('DELETE FROM {profile_fields} WHERE fid = %d', $form_values['fid']);
  db_query('DELETE FROM {profile_values} WHERE fid = %d', $form_values['fid']);
  
  cache_clear_all();
  
  drupal_set_message(t('The field %field has been deleted.', array('%field' => theme('placeholder', $form_values['title']))));
  watchdog('profile', t('Profile field %field deleted.', array('%field' => theme('placeholder', $form_values['title']))), WATCHDOG_NOTICE, l(t('view'), 'admin/settings/profile'));
  
  return 'admin/settings/profile';
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
}

/**
 * Menu callback; display a listing of all editable profile fields.
 */
function profile_admin_overview() {

  $result = db_query('SELECT * FROM {profile_fields} ORDER BY category, weight');
  $rows = array();
  while ($field = db_fetch_object($result)) {
    $rows[] = array(check_plain($field->title), $field->name, _profile_field_types($field->type), $field->category, l(t('edit'), "admin/settings/profile/edit/$field->fid"), l(t('delete'), "admin/settings/profile/delete/$field->fid"));
  }
  if (count($rows) == 0) {
    $rows[] = array(array('data' => t('No fields defined.'), 'colspan' => '6'));
  }

  $header = array(t('Title'), t('Name'), t('Type'), t('Category'), array('data' => t('Operations'), 'colspan' => '2'));

  $output  = theme('table', $header, $rows);
  $output .= '<h2>'. t('Add new field') .'</h2>';
  $output .= '<ul>';
  foreach (_profile_field_types() as $key => $value) {
    $output .= '<li>'. l($value, "admin/settings/profile/add/$key") .'</li>';
  }
  $output .= '</ul>';

  return $output;
Dries's avatar
   
Dries committed
393
}
Dries's avatar
   
Dries committed
394

Dries's avatar
   
Dries committed
395
396
397
/**
 * Menu callback; display a list of user information.
 */
Dries's avatar
   
Dries committed
398
function profile_browse() {
Dries's avatar
   
Dries committed
399

Steven Wittens's avatar
Steven Wittens committed
400
  $name = arg(1);
401
  list(,,$value) = explode('/', $_GET['q'], 3);
Dries's avatar
   
Dries committed
402

Steven Wittens's avatar
Steven Wittens committed
403
  $field = db_fetch_object(db_query("SELECT DISTINCT(fid), type, title, page, visibility FROM {profile_fields} WHERE name = '%s'", $name));
Dries's avatar
   
Dries committed
404

Dries's avatar
   
Dries committed
405
  if ($name && $field->fid) {
406
    // Do not allow browsing of private fields by non-admins.
Steven Wittens's avatar
Steven Wittens committed
407
408
409
410
411
    if (!user_access('administer users') && $field->visibility == PROFILE_PRIVATE) {
       drupal_access_denied();
       return;
    }

412
    // Compile a list of fields to show.
Dries's avatar
   
Dries committed
413
    $fields = array();
414
    $result = db_query('SELECT name, title, type, weight FROM {profile_fields} WHERE fid != %d AND visibility = %d ORDER BY weight', $field->fid, PROFILE_PUBLIC_LISTINGS);
Dries's avatar
   
Dries committed
415
416
417
    while ($record = db_fetch_object($result)) {
      $fields[] = $record;
    }
Dries's avatar
   
Dries committed
418

Dries's avatar
Dries committed
419
    // Determine what query to use:
420
    $arguments = array($field->fid);
Dries's avatar
Dries committed
421
422
423
424
425
    switch ($field->type) {
      case 'checkbox':
        $query = 'v.value = 1';
        break;
      case 'selection':
426
427
        $query = "v.value = '%s'";
        $arguments[] = $value;
Dries's avatar
Dries committed
428
429
        break;
      case 'list':
430
431
        $query = "v.value LIKE '%%%s%%'";
        $arguments[] = $value;
Dries's avatar
Dries committed
432
        break;
Steven Wittens's avatar
Steven Wittens committed
433
434
435
      default:
        drupal_not_found();
        return;
Dries's avatar
Dries committed
436
437
    }

Dries's avatar
   
Dries committed
438
    // Extract the affected users:
439
    $result = pager_query("SELECT u.uid, u.access FROM {users} u INNER JOIN {profile_values} v ON u.uid = v.uid WHERE v.fid = %d AND $query ORDER BY u.access DESC", 20, 0, NULL, $arguments);
Dries's avatar
   
Dries committed
440

Dries's avatar
   
Dries committed
441
    $output = '<div id="profile">';
Dries's avatar
   
Dries committed
442
    while ($account = db_fetch_object($result)) {
443
      $account = user_load(array('uid' => $account->uid));
444
      $fields = _profile_update_user_fields($fields, $account);
445
      $output .= theme('profile_listing', $account, $fields);
Dries's avatar
   
Dries committed
446
447
448
    }
    $output .= theme('pager', NULL, 20);

Dries's avatar
Dries committed
449
    if ($field->type == 'selection' || $field->type == 'list') {
450
      $title = strtr($field->page, array('%value' => theme('placeholder', $value)));
Dries's avatar
   
Dries committed
451
452
    }
    else {
Dries's avatar
   
Dries committed
453
      $title = $field->page;
Dries's avatar
   
Dries committed
454
    }
Dries's avatar
   
Dries committed
455
    $output .= '</div>';
Dries's avatar
   
Dries committed
456

457
    drupal_set_title($title);
Dries's avatar
   
Dries committed
458
    return $output;
Dries's avatar
   
Dries committed
459
  }
460
  else if ($name && !$field->fid) {
Dries's avatar
   
Dries committed
461
    drupal_not_found();
Dries's avatar
   
Dries committed
462
  }
Dries's avatar
   
Dries committed
463
  else {
464
    // Compile a list of fields to show.
Dries's avatar
   
Dries committed
465
    $fields = array();
466
    $result = db_query('SELECT name, title, type, weight FROM {profile_fields} WHERE visibility = %d ORDER BY category, weight', PROFILE_PUBLIC_LISTINGS);
Dries's avatar
   
Dries committed
467
468
469
470
471
    while ($record = db_fetch_object($result)) {
      $fields[] = $record;
    }

    // Extract the affected users:
472
    $result = pager_query("SELECT uid, access FROM {users} WHERE uid > 0 AND status != 0 ORDER BY access DESC", 20, 0, NULL);
Dries's avatar
   
Dries committed
473
474
475

    $output = '<div id="profile">';
    while ($account = db_fetch_object($result)) {
476
      $account = user_load(array('uid' => $account->uid));
477
478
      $profile = _profile_update_user_fields($fields, $account);
      $output .= theme('profile_listing', $account, $profile);
Dries's avatar
   
Dries committed
479
480
481
482
    }
    $output .= '</div>';
    $output .= theme('pager', NULL, 20);

483
    drupal_set_title(t('user list'));
Dries's avatar
   
Dries committed
484
    return $output;
Dries's avatar
   
Dries committed
485
  }
Dries's avatar
   
Dries committed
486
}
Dries's avatar
   
Dries committed
487

Dries's avatar
   
Dries committed
488
function profile_load_profile(&$user) {
Steven Wittens's avatar
Steven Wittens committed
489
  $result = db_query('SELECT f.name, f.type, v.value FROM {profile_fields} f INNER JOIN {profile_values} v ON f.fid = v.fid WHERE uid = %d', $user->uid);
Dries's avatar
   
Dries committed
490
491
  while ($field = db_fetch_object($result)) {
    if (empty($user->{$field->name})) {
Steven Wittens's avatar
Steven Wittens committed
492
      $user->{$field->name} = _profile_field_serialize($field->type) ? unserialize($field->value) : $field->value;
Dries's avatar
   
Dries committed
493
    }
Dries's avatar
   
Dries committed
494
  }
Dries's avatar
   
Dries committed
495
496
}

497
function profile_save_profile(&$edit, &$user, $category) {
498
  if ((arg(0) == 'user' && arg(1) == 'register') || (arg(0) == 'admin' && arg(1) == 'user' && arg(2) == 'create')) {
499
    $result = db_query('SELECT fid, name, type FROM {profile_fields} WHERE register = 1 AND visibility != %d ORDER BY category, weight', PROFILE_HIDDEN);
Dries's avatar
   
Dries committed
500
501
  }
  else {
502
    $result = db_query("SELECT fid, name, type FROM {profile_fields} WHERE LOWER(category) = LOWER('%s') AND visibility != %d", $category, PROFILE_HIDDEN);
503
    // Use LOWER('%s') instead of PHP's strtolower() to avoid UTF-8 conversion issues.
Dries's avatar
   
Dries committed
504
  }
Dries's avatar
   
Dries committed
505
  while ($field = db_fetch_object($result)) {
Steven Wittens's avatar
Steven Wittens committed
506
507
508
    if (_profile_field_serialize($field->type)) {
       $edit[$field->name] = serialize($edit[$field->name]);
    }
509
510
    db_query("DELETE FROM {profile_values} WHERE fid = %d AND uid = %d", $field->fid, $user->uid);
    db_query("INSERT INTO {profile_values} (fid, uid, value) VALUES (%d, %d, '%s')", $field->fid, $user->uid, $edit[$field->name]);
511
    // Mark field as handled (prevents saving to user->data).
512
    $edit[$field->name] = NULL;
Dries's avatar
   
Dries committed
513
  }
Dries's avatar
   
Dries committed
514
515
}

516
function profile_view_field($user, $field) {
517
  // Only allow browsing of private fields for admins.
Steven Wittens's avatar
Steven Wittens committed
518
519
  $browse = user_access('administer users') || $field->visibility != PROFILE_PRIVATE;

520
521
522
  if ($value = $user->{$field->name}) {
    switch ($field->type) {
      case 'textfield':
523
        return check_plain($value);
524
      case 'textarea':
525
        return check_markup($value);
526
      case 'selection':
527
        return $browse ? l($value, 'profile/'. $field->name .'/'. $value) : check_plain($value);
528
      case 'checkbox':
529
        return $browse ? l($field->title, 'profile/'. $field->name) : check_plain($field->title);
530
      case 'url':
531
        return '<a href="'. check_url($value) .'">'. check_plain($value) .'</a>';
Steven Wittens's avatar
Steven Wittens committed
532
      case 'date':
533
        $format = substr(variable_get('date_format_short', 'm/d/Y - H:i'), 0, 5);
534
        // Note: Avoid PHP's date() because it does not handle dates before
Steven Wittens's avatar
Steven Wittens committed
535
536
537
538
539
        // 1970 on Windows. This would make the date field useless for e.g.
        // birthdays.
        $replace = array('d' => sprintf('%02d', $value['day']),
                         'j' => $value['day'],
                         'm' => sprintf('%02d', $value['month']),
540
                         'M' => map_month($value['month']),
541
542
543
                         'Y' => $value['year'],
                         'H:i' => null,
                         'g:ia' => null);
Steven Wittens's avatar
Steven Wittens committed
544
        return strtr($format, $replace);
545
      case 'list':
Dries's avatar
   
Dries committed
546
        $values = split("[,\n\r]", $value);
Dries's avatar
Dries committed
547
548
        $fields = array();
        foreach ($values as $value) {
Steven Wittens's avatar
Steven Wittens committed
549
          if ($value = trim($value)) {
550
            $fields[] = $browse ? l($value, "profile/". drupal_urlencode($field->name) ."/". drupal_urlencode($value)) : check_plain($value);
Dries's avatar
Dries committed
551
552
553
          }
        }
        return implode(', ', $fields);
554
555
556
557
    }
  }
}

Dries's avatar
   
Dries committed
558
function profile_view_profile($user) {
Dries's avatar
   
Dries committed
559

560
  profile_load_profile($user);
Dries's avatar
   
Dries committed
561

Steven Wittens's avatar
Steven Wittens committed
562
563
  // Show private fields to administrators and people viewing their own account.
  if (user_access('administer users') || $GLOBALS['user']->uid == $user->uid) {
564
    $result = db_query('SELECT * FROM {profile_fields} WHERE visibility != %d ORDER BY category, weight', PROFILE_HIDDEN);
Steven Wittens's avatar
Steven Wittens committed
565
566
  }
  else {
567
    $result = db_query('SELECT * FROM {profile_fields} WHERE visibility != %d AND visibility != %d ORDER BY category, weight', PROFILE_PRIVATE, PROFILE_HIDDEN);
Steven Wittens's avatar
Steven Wittens committed
568
569
  }

Dries's avatar
   
Dries committed
570
  while ($field = db_fetch_object($result)) {
571
    if ($value = profile_view_field($user, $field)) {
Steven Wittens's avatar
Steven Wittens committed
572
      $description = ($field->visibility == PROFILE_PRIVATE) ? t('The content of this field is private and only visible to yourself.') : '';
573
      $title = ($field->type != 'checkbox') ? check_plain($field->title) : NULL;
574
575
576
577
578
      $item = array('title' => $title,
        'value' => $value,
        'class' => $field->name,
      );
      $fields[$field->category][] = $item;
Dries's avatar
   
Dries committed
579
580
    }
  }
Dries's avatar
Dries committed
581
  return $fields;
Dries's avatar
   
Dries committed
582
}
Dries's avatar
   
Dries committed
583

584
585
function _profile_form_explanation($field) {
  $output = $field->explanation;
Dries's avatar
   
Dries committed
586

587
  if ($field->type == 'list') {
588
    $output .= ' '. t('Put each item on a separate line or separate them by commas. No HTML allowed.');
589
590
591
592
593
594
595
596
597
598
  }

  if ($field->visibility == PROFILE_PRIVATE) {
    $output .= ' '. t('The content of this field is kept private and will not be shown publicly.');
  }

  return $output;
}

function profile_form_profile($edit, $user, $category) {
599
  if (arg(0) == 'user' && arg(1) == 'register') {
600
    $result = db_query('SELECT * FROM {profile_fields} WHERE visibility != %d AND register = 1 ORDER BY category, weight', PROFILE_HIDDEN);
Dries's avatar
   
Dries committed
601
  }
602
  elseif (arg(0) == 'admin' && arg(1) == 'user' && arg(2) == 'create') {
603
604
    $result = db_query('SELECT * FROM {profile_fields} WHERE register = 1 ORDER BY category, weight');
  }
605
  elseif (user_access('administer users')) {
606
    $result = db_query("SELECT * FROM {profile_fields} WHERE LOWER(category) = LOWER('%s') ORDER BY weight", $category);
Dries's avatar
   
Dries committed
607
  }
608
609
  else {
    $result = db_query("SELECT * FROM {profile_fields} WHERE visibility != %d AND LOWER(category) = LOWER('%s') ORDER BY weight", PROFILE_HIDDEN, $category);
610
611
    // Use LOWER('%s') instead of PHP's strtolower() to avoid UTF-8 conversion issues.
  }
612

Dries's avatar
   
Dries committed
613
  while ($field = db_fetch_object($result)) {
Dries's avatar
   
Dries committed
614
    $category = $field->category;
615
616
617
    if (!isset($fields[$category])) {
      $fields[$category] = array('#type' => 'fieldset', '#title' => $category, '#weight' => $w++);
    }
Dries's avatar
   
Dries committed
618
619
    switch ($field->type) {
      case 'textfield':
620
      case 'url':
621
        $fields[$category][$field->name] = array('#type' => 'textfield',
622
623
624
625
          '#title' => check_plain($field->title),
          '#default_value' => $edit[$field->name],
          '#maxlength' => 255,
          '#description' => _profile_form_explanation($field),
626
          '#required' => $field->required,
627
        );
Dries's avatar
   
Dries committed
628
        break;
629
      case 'textarea':
630
        $fields[$category][$field->name] = array('#type' => 'textarea',
631
632
633
          '#title' => check_plain($field->title),
          '#default_value' => $edit[$field->name],
          '#description' => _profile_form_explanation($field),
634
          '#required' => $field->required,
635
        );
Dries's avatar
Dries committed
636
637
        break;
      case 'list':
638
        $fields[$category][$field->name] = array('#type' => 'textarea',
639
640
641
          '#title' => check_plain($field->title),
          '#default_value' => $edit[$field->name],
          '#description' => _profile_form_explanation($field),
642
          '#required' => $field->required,
643
        );
Dries's avatar
   
Dries committed
644
        break;
645
      case 'checkbox':
646
        $fields[$category][$field->name] = array('#type' => 'checkbox',
647
648
649
          '#title' => check_plain($field->title),
          '#default_value' => $edit[$field->name],
          '#description' => _profile_form_explanation($field),
650
          '#required' => $field->required,
651
        );
Dries's avatar
   
Dries committed
652
653
654
        break;
      case 'selection':
        $options = array('--');
Dries's avatar
   
Dries committed
655
        $lines = split("[,\n\r]", $field->options);
Dries's avatar
   
Dries committed
656
657
658
659
660
        foreach ($lines as $line) {
          if ($line = trim($line)) {
            $options[$line] = $line;
          }
        }
661
        $fields[$category][$field->name] = array('#type' => 'select',
662
663
664
665
          '#title' => check_plain($field->title),
          '#default_value' => $edit[$field->name],
          '#options' => $options,
          '#description' => _profile_form_explanation($field),
666
          '#required' => $field->required,
667
        );
Dries's avatar
   
Dries committed
668
        break;
Steven Wittens's avatar
Steven Wittens committed
669
      case 'date':
670
        $fields[$category][$field->name] = array('#type' => 'date',
671
672
673
          '#title' => check_plain($field->title),
          '#default_value' => $edit[$field->name],
          '#description' => _profile_form_explanation($field),
674
          '#required' => $field->required,
675
        );
Steven Wittens's avatar
Steven Wittens committed
676
        break;
Dries's avatar
   
Dries committed
677
678
    }
  }
679
  return $fields;
Dries's avatar
   
Dries committed
680
681
}

682
683
684
/**
 * Helper function: update an array of user fields by calling profile_view_field
 */
685
function _profile_update_user_fields($fields, $account) {
686
687
688
689
690
  foreach ($fields as $key => $field) {
    if ($value = profile_view_field($account, $field)) {
      $fields[$key]->value = $value;
    }
  }
691
  return $fields;
692
693
}

694
function profile_validate_profile($edit, $category) {
695
  if (arg(0) == 'user' && arg(1) == 'register') {
696
    $result = db_query('SELECT * FROM {profile_fields} WHERE visibility != %d AND register = 1 ORDER BY category, weight', PROFILE_HIDDEN);
Dries's avatar
   
Dries committed
697
  }
698
  elseif (arg(0) == 'admin' && arg(1) == 'user' && arg(2) == 'create') {
699
700
    $result = db_query('SELECT * FROM {profile_fields} WHERE register = 1 ORDER BY category, weight');
  }
701
  elseif (user_access('administer users')) {
702
    $result = db_query("SELECT * FROM {profile_fields} WHERE LOWER(category) = LOWER('%s') ORDER BY weight", $category);
Dries's avatar
   
Dries committed
703
  }
704
705
  else {
    $result = db_query("SELECT * FROM {profile_fields} WHERE visibility != %d AND LOWER(category) = LOWER('%s') ORDER BY weight", PROFILE_HIDDEN, $category);
706
707
    // Use LOWER('%s') instead of PHP's strtolower() to avoid UTF-8 conversion issues.
  }
708
709

  while ($field = db_fetch_object($result)) {
710
    if ($edit[$field->name]) {
Dries's avatar
   
Dries committed
711
712
      if ($field->type == 'url') {
        if (!valid_url($edit[$field->name], true)) {
713
714
          form_set_error($field->name, t('The value provided for %field is not a valid URL.', array('%field' => theme('placeholder', $field->title))));
        }
715
716
      }
    }
717
    else if ($field->required && !user_access('administer users')) {
718
      form_set_error($field->name, t('The field %field is required.', array('%field' => theme('placeholder', $field->title))));
Dries's avatar
   
Dries committed
719
    }
720
721
722
723
724
  }

  return $edit;
}

725
726
727
function profile_categories() {
  $result = db_query("SELECT DISTINCT(category) FROM {profile_fields}");
  while ($category = db_fetch_object($result)) {
728
    $data[] = array('name' => check_plain($category->category), 'title' => $category->category, 'weight' => 3);
729
730
731
732
  }
  return $data;
}

733
function theme_profile_block($account, $fields = array()) {
734

735
  $output .= theme('user_picture', $account);
736
737

  foreach ($fields as $field) {
738
    if ($field->value) {
739
      $output .= "<p><strong>$field->title:</strong><br />$field->value</p>\n";
740
741
742
743
744
745
    }
  }

  return $output;
}

746
function theme_profile_listing($account, $fields = array()) {
Dries's avatar
   
Dries committed
747
748

  $output  = "<div class=\"profile\">\n";
749
750
  $output .= theme('user_picture', $account);
  $output .= ' <div class="name">'. theme('username', $account) ."</div>\n";
Dries's avatar
   
Dries committed
751
752

  foreach ($fields as $field) {
753
    if ($field->value) {
754
      $output .= " <div class=\"field\">$field->value</div>\n";
Dries's avatar
   
Dries committed
755
756
    }
  }
Dries's avatar
   
Dries committed
757
758
759
760
761
762
763

  $output .= "</div>\n";

  return $output;
}

function _profile_field_types($type = NULL) {
Steven Wittens's avatar
Steven Wittens committed
764
765
766
767
768
769
770
  $types = array('textfield' => t('single-line textfield'),
                 'textarea' => t('multi-line textfield'),
                 'checkbox' => t('checkbox'),
                 'selection' => t('list selection'),
                 'list' => t('freeform list'),
                 'url' => t('URL'),
                 'date' => t('date'));
Dries's avatar
   
Dries committed
771
  return isset($type) ? $types[$type] : $types;
Dries's avatar
   
Dries committed
772
773
}

Steven Wittens's avatar
Steven Wittens committed
774
775
776
function _profile_field_serialize($type = NULL) {
  return $type == 'date';
}