profile.module 31.5 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
  }
  $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.')),
  );
254
  if ($type == 'selection' || $type == 'list' || $type == 'textfield') {
255
256
257
    $form['fields']['page'] = array('#type' => 'textfield',
      '#title' => t('Page title'),
      '#default_value' => $edit['page'],
258
      '#description' => t('To enable browsing this field by value, enter a title for the resulting page. 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.'),
259
260
    );
  }
261
  else if ($type == 'checkbox') {
262
263
264
    $form['fields']['page'] = array('#type' => 'textfield',
      '#title' => t('Page title'),
      '#default_value' => $edit['page'],
265
      '#description' => t('To enable browsing this field by value, enter a title for the resulting page. An example page title is "People who are employed". This is only applicable for a public field.'),
266
267
268
269
270
271
272
273
274
275
276
277
278
    );
  }
  $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
407
408
409
410
    // Only allow browsing of fields that have a page title set.
    if (empty($field->page)) {
      drupal_not_found();
      return;
    }
411
    // Do not allow browsing of private fields by non-admins.
Steven Wittens's avatar
Steven Wittens committed
412
413
414
415
416
    if (!user_access('administer users') && $field->visibility == PROFILE_PRIVATE) {
       drupal_access_denied();
       return;
    }

417
    // Compile a list of fields to show.
Dries's avatar
   
Dries committed
418
    $fields = array();
419
    $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
420
421
422
    while ($record = db_fetch_object($result)) {
      $fields[] = $record;
    }
Dries's avatar
   
Dries committed
423

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

Dries's avatar
   
Dries committed
444
    // Extract the affected users:
445
    $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
446

Dries's avatar
   
Dries committed
447
    $output = '<div id="profile">';
Dries's avatar
   
Dries committed
448
    while ($account = db_fetch_object($result)) {
449
      $account = user_load(array('uid' => $account->uid));
450
451
      $profile = _profile_update_user_fields($fields, $account);
      $output .= theme('profile_listing', $account, $profile);
Dries's avatar
   
Dries committed
452
453
454
    }
    $output .= theme('pager', NULL, 20);

455
    if ($field->type == 'selection' || $field->type == 'list' || $field->type == 'textfield') {
456
      $title = strtr($field->page, array('%value' => theme('placeholder', $value)));
Dries's avatar
   
Dries committed
457
458
    }
    else {
Dries's avatar
   
Dries committed
459
      $title = $field->page;
Dries's avatar
   
Dries committed
460
    }
Dries's avatar
   
Dries committed
461
    $output .= '</div>';
Dries's avatar
   
Dries committed
462

463
    drupal_set_title($title);
Dries's avatar
   
Dries committed
464
    return $output;
Dries's avatar
   
Dries committed
465
  }
466
  else if ($name && !$field->fid) {
Dries's avatar
   
Dries committed
467
    drupal_not_found();
Dries's avatar
   
Dries committed
468
  }
Dries's avatar
   
Dries committed
469
  else {
470
    // Compile a list of fields to show.
Dries's avatar
   
Dries committed
471
    $fields = array();
472
    $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
473
474
475
476
477
    while ($record = db_fetch_object($result)) {
      $fields[] = $record;
    }

    // Extract the affected users:
478
    $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
479
480
481

    $output = '<div id="profile">';
    while ($account = db_fetch_object($result)) {
482
      $account = user_load(array('uid' => $account->uid));
483
484
      $profile = _profile_update_user_fields($fields, $account);
      $output .= theme('profile_listing', $account, $profile);
Dries's avatar
   
Dries committed
485
486
487
488
    }
    $output .= '</div>';
    $output .= theme('pager', NULL, 20);

489
    drupal_set_title(t('user list'));
Dries's avatar
   
Dries committed
490
    return $output;
Dries's avatar
   
Dries committed
491
  }
Dries's avatar
   
Dries committed
492
}
Dries's avatar
   
Dries committed
493

Dries's avatar
   
Dries committed
494
function profile_load_profile(&$user) {
Steven Wittens's avatar
Steven Wittens committed
495
  $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
496
497
  while ($field = db_fetch_object($result)) {
    if (empty($user->{$field->name})) {
Steven Wittens's avatar
Steven Wittens committed
498
      $user->{$field->name} = _profile_field_serialize($field->type) ? unserialize($field->value) : $field->value;
Dries's avatar
   
Dries committed
499
    }
Dries's avatar
   
Dries committed
500
  }
Dries's avatar
   
Dries committed
501
502
}

503
function profile_save_profile(&$edit, &$user, $category) {
504
  if ((arg(0) == 'user' && arg(1) == 'register') || (arg(0) == 'admin' && arg(1) == 'user' && arg(2) == 'create')) {
505
    $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
506
507
  }
  else {
508
    $result = db_query("SELECT fid, name, type FROM {profile_fields} WHERE LOWER(category) = LOWER('%s') AND visibility != %d", $category, PROFILE_HIDDEN);
509
    // Use LOWER('%s') instead of PHP's strtolower() to avoid UTF-8 conversion issues.
Dries's avatar
   
Dries committed
510
  }
Dries's avatar
   
Dries committed
511
  while ($field = db_fetch_object($result)) {
Steven Wittens's avatar
Steven Wittens committed
512
513
514
    if (_profile_field_serialize($field->type)) {
       $edit[$field->name] = serialize($edit[$field->name]);
    }
515
516
    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]);
517
    // Mark field as handled (prevents saving to user->data).
518
    $edit[$field->name] = NULL;
Dries's avatar
   
Dries committed
519
  }
Dries's avatar
   
Dries committed
520
521
}

522
function profile_view_field($user, $field) {
523
524
525
526
527
528
  // Only allow browsing of private fields for admins, if browsing is enabled,
  // and if a user has permission to view profiles. Note that this check is
  // necessary because a user may always see their own profile.
  $browse = user_access('access user profiles')
         && (user_access('administer users') || $field->visibility != PROFILE_PRIVATE)
         && !empty($field->page);
Steven Wittens's avatar
Steven Wittens committed
529

530
531
532
  if ($value = $user->{$field->name}) {
    switch ($field->type) {
      case 'textarea':
533
        return check_markup($value);
534
      case 'textfield':
535
      case 'selection':
536
        return $browse ? l($value, 'profile/'. $field->name .'/'. $value) : check_plain($value);
537
      case 'checkbox':
538
        return $browse ? l($field->title, 'profile/'. $field->name) : check_plain($field->title);
539
      case 'url':
540
        return '<a href="'. check_url($value) .'">'. check_plain($value) .'</a>';
Steven Wittens's avatar
Steven Wittens committed
541
      case 'date':
542
        $format = substr(variable_get('date_format_short', 'm/d/Y - H:i'), 0, 5);
543
        // Note: Avoid PHP's date() because it does not handle dates before
Steven Wittens's avatar
Steven Wittens committed
544
545
546
547
548
        // 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']),
549
                         'M' => map_month($value['month']),
550
551
552
                         'Y' => $value['year'],
                         'H:i' => null,
                         'g:ia' => null);
Steven Wittens's avatar
Steven Wittens committed
553
        return strtr($format, $replace);
554
      case 'list':
Dries's avatar
   
Dries committed
555
        $values = split("[,\n\r]", $value);
Dries's avatar
Dries committed
556
557
        $fields = array();
        foreach ($values as $value) {
Steven Wittens's avatar
Steven Wittens committed
558
          if ($value = trim($value)) {
559
            $fields[] = $browse ? l($value, 'profile/'. $field->name .'/'. $value) : check_plain($value);
Dries's avatar
Dries committed
560
561
562
          }
        }
        return implode(', ', $fields);
563
564
565
566
    }
  }
}

Dries's avatar
   
Dries committed
567
function profile_view_profile($user) {
Dries's avatar
   
Dries committed
568

569
  profile_load_profile($user);
Dries's avatar
   
Dries committed
570

Steven Wittens's avatar
Steven Wittens committed
571
572
  // Show private fields to administrators and people viewing their own account.
  if (user_access('administer users') || $GLOBALS['user']->uid == $user->uid) {
573
    $result = db_query('SELECT * FROM {profile_fields} WHERE visibility != %d ORDER BY category, weight', PROFILE_HIDDEN);
Steven Wittens's avatar
Steven Wittens committed
574
575
  }
  else {
576
    $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
577
578
  }

Dries's avatar
   
Dries committed
579
  while ($field = db_fetch_object($result)) {
580
    if ($value = profile_view_field($user, $field)) {
Steven Wittens's avatar
Steven Wittens committed
581
      $description = ($field->visibility == PROFILE_PRIVATE) ? t('The content of this field is private and only visible to yourself.') : '';
582
      $title = ($field->type != 'checkbox') ? check_plain($field->title) : NULL;
583
584
585
586
587
      $item = array('title' => $title,
        'value' => $value,
        'class' => $field->name,
      );
      $fields[$field->category][] = $item;
Dries's avatar
   
Dries committed
588
589
    }
  }
Dries's avatar
Dries committed
590
  return $fields;
Dries's avatar
   
Dries committed
591
}
Dries's avatar
   
Dries committed
592

593
594
function _profile_form_explanation($field) {
  $output = $field->explanation;
Dries's avatar
   
Dries committed
595

596
  if ($field->type == 'list') {
597
    $output .= ' '. t('Put each item on a separate line or separate them by commas. No HTML allowed.');
598
599
600
601
602
603
604
605
606
607
  }

  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) {
608
  if (arg(0) == 'user' && arg(1) == 'register') {
609
    $result = db_query('SELECT * FROM {profile_fields} WHERE visibility != %d AND register = 1 ORDER BY category, weight', PROFILE_HIDDEN);
Dries's avatar
   
Dries committed
610
  }
611
  elseif (arg(0) == 'admin' && arg(1) == 'user' && arg(2) == 'create') {
612
613
    $result = db_query('SELECT * FROM {profile_fields} WHERE register = 1 ORDER BY category, weight');
  }
614
  elseif (user_access('administer users')) {
615
    $result = db_query("SELECT * FROM {profile_fields} WHERE LOWER(category) = LOWER('%s') ORDER BY weight", $category);
Dries's avatar
   
Dries committed
616
  }
617
618
  else {
    $result = db_query("SELECT * FROM {profile_fields} WHERE visibility != %d AND LOWER(category) = LOWER('%s') ORDER BY weight", PROFILE_HIDDEN, $category);
619
620
    // Use LOWER('%s') instead of PHP's strtolower() to avoid UTF-8 conversion issues.
  }
621

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

691
692
693
/**
 * Helper function: update an array of user fields by calling profile_view_field
 */
694
function _profile_update_user_fields($fields, $account) {
695
  foreach ($fields as $key => $field) {
696
    $fields[$key]->value = profile_view_field($account, $field);
697
  }
698
  return $fields;
699
700
}

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

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

  return $edit;
}

732
733
734
function profile_categories() {
  $result = db_query("SELECT DISTINCT(category) FROM {profile_fields}");
  while ($category = db_fetch_object($result)) {
735
    $data[] = array('name' => check_plain($category->category), 'title' => $category->category, 'weight' => 3);
736
737
738
739
  }
  return $data;
}

740
function theme_profile_block($account, $fields = array()) {
741

742
  $output .= theme('user_picture', $account);
743
744

  foreach ($fields as $field) {
745
    if ($field->value) {
746
747
748
749
750
751
      if ($field->type == 'checkbox') {
        $output .= "<p>$field->value</p>\n";
      }
      else {
        $output .= "<p><strong>$field->title</strong><br />$field->value</p>\n";
      }
752
753
754
755
756
757
    }
  }

  return $output;
}

758
function theme_profile_listing($account, $fields = array()) {
Dries's avatar
   
Dries committed
759
760

  $output  = "<div class=\"profile\">\n";
761
762
  $output .= theme('user_picture', $account);
  $output .= ' <div class="name">'. theme('username', $account) ."</div>\n";
Dries's avatar
   
Dries committed
763
764

  foreach ($fields as $field) {
765
    if ($field->value) {
766
      $output .= " <div class=\"field\">$field->value</div>\n";
Dries's avatar
   
Dries committed
767
768
    }
  }
Dries's avatar
   
Dries committed
769
770
771
772
773
774
775

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

  return $output;
}

function _profile_field_types($type = NULL) {
Steven Wittens's avatar
Steven Wittens committed
776
777
778
779
780
781
782
  $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
783
  return isset($type) ? $types[$type] : $types;
Dries's avatar
   
Dries committed
784
785
}

Steven Wittens's avatar
Steven Wittens committed
786
787
788
function _profile_field_serialize($type = NULL) {
  return $type == 'date';
}