Skip to content
profile.module 29.6 KiB
Newer Older
Dries Buytaert's avatar
Dries Buytaert committed
<?php
Dries Buytaert's avatar
Dries Buytaert committed
// $Id$
Dries Buytaert's avatar
Dries Buytaert committed

Dries Buytaert's avatar
 
Dries Buytaert committed
/**
 * @file
 * Support for configurable user profiles.
 */

/**
 * Flags to define the visibility of a profile field.
 */
define('PROFILE_PRIVATE', 1);
define('PROFILE_PUBLIC', 2);
define('PROFILE_PUBLIC_LISTINGS', 3);
Dries Buytaert's avatar
 
Dries Buytaert committed
/**
 * Implementation of hook_help().
 */
Dries Buytaert's avatar
 
Dries Buytaert committed
function profile_help($section) {
Dries Buytaert's avatar
 
Dries Buytaert committed
  switch ($section) {
      $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>';
      $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')));
      $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>';
Dries Buytaert's avatar
 
Dries Buytaert committed
    case 'admin/modules#description':
      return t('Supports configurable user profiles.');
    case 'admin/settings/profile':
      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 Buytaert's avatar
 
Dries Buytaert committed
  }
}

/**
 * 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();
    $result = db_query('SELECT name, title, weight FROM {profile_fields} ORDER BY weight');
    while ($record = db_fetch_object($result)) {
      $fields[$record->name] = $record->title;
    }
    $fields['user_profile'] = t('Link to full user profile');
    $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'))));
  }
  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)) {
        $account = user_load(array('uid' => $node->uid));

        if ($use_fields = variable_get('profile_block_author_fields', array())) {
          // Compile a list of fields to show
          $fields = array();
          $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.
            if (in_array($record->name, $use_fields)) {
          $fields = _profile_update_user_fields($fields, $account);
          $output .= theme('profile_block', $account, $fields, true);
        }

        if (in_array('user_profile', $use_fields)) {
          $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 Buytaert's avatar
 
Dries Buytaert committed
/**
Dries Buytaert's avatar
 
Dries Buytaert committed
 * Implementation of hook_menu().
Dries Buytaert's avatar
 
Dries Buytaert committed
 */
Dries Buytaert's avatar
 
Dries Buytaert committed
function profile_menu($may_cache) {
Dries Buytaert's avatar
 
Dries Buytaert committed
  $items = array();
Dries Buytaert's avatar
 
Dries Buytaert committed

  if ($may_cache) {
    $items[] = array('path' => 'profile', 'title' => t('user list'),
      'callback' => 'profile_browse',
      'access' => user_access('access user profiles'),
Dries Buytaert's avatar
 
Dries Buytaert committed
      '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'),
Dries Buytaert's avatar
 
Dries Buytaert committed
      'callback' => 'profile_admin_add',
      'type' => MENU_CALLBACK);
    $items[] = array('path' => 'admin/settings/profile/edit', 'title' => t('edit field'),
Dries Buytaert's avatar
 
Dries Buytaert committed
      'callback' => 'profile_admin_edit',
      'type' => MENU_CALLBACK);
    $items[] = array('path' => 'admin/settings/profile/delete', 'title' => t('delete field'),
Dries Buytaert's avatar
 
Dries Buytaert committed
      'callback' => 'profile_admin_delete',
      'type' => MENU_CALLBACK);
  }
Dries Buytaert's avatar
 
Dries Buytaert committed
  return $items;
Dries Buytaert's avatar
 
Dries Buytaert committed
}
Dries Buytaert's avatar
Dries Buytaert committed

Dries Buytaert's avatar
 
Dries Buytaert committed
/**
 * Menu callback; display a list of user information.
 */
Dries Buytaert's avatar
 
Dries Buytaert committed
function profile_browse() {
Dries Buytaert's avatar
 
Dries Buytaert committed

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

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

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

    // Compile a list of fields to show
Dries Buytaert's avatar
 
Dries Buytaert committed
    $fields = array();
    $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 Buytaert's avatar
 
Dries Buytaert committed
    while ($record = db_fetch_object($result)) {
      $fields[] = $record;
    }
Dries Buytaert's avatar
Dries Buytaert committed

    // Determine what query to use:
    $arguments = array($field->fid);
    switch ($field->type) {
      case 'checkbox':
        $query = 'v.value = 1';
        break;
      case 'selection':
        $query = "v.value = '%s'";
        $arguments[] = $value;
        break;
      case 'list':
        $query = "v.value LIKE '%%%s%%'";
        $arguments[] = $value;
Steven Wittens's avatar
Steven Wittens committed
      default:
        drupal_not_found();
        return;
Dries Buytaert's avatar
 
Dries Buytaert committed
    // Extract the affected users:
    $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 Buytaert's avatar
Dries Buytaert committed

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

    if ($field->type == 'selection' || $field->type == 'list') {
      $title = strtr($field->page, array('%value' => theme('placeholder', $value)));
Dries Buytaert's avatar
 
Dries Buytaert committed
    }
    else {
Dries Buytaert's avatar
 
Dries Buytaert committed
      $title = $field->page;
Dries Buytaert's avatar
 
Dries Buytaert committed
    }
Dries Buytaert's avatar
 
Dries Buytaert committed
    $output .= '</div>';
Dries Buytaert's avatar
 
Dries Buytaert committed

    drupal_set_title($title);
Dries Buytaert's avatar
 
Dries Buytaert committed
    return $output;
Dries Buytaert's avatar
 
Dries Buytaert committed
  }
  else if ($name && !$field->fid) {
Dries Buytaert's avatar
 
Dries Buytaert committed
    drupal_not_found();
Dries Buytaert's avatar
Dries Buytaert committed
  }
Dries Buytaert's avatar
 
Dries Buytaert committed
  else {
    // Compile a list of fields to show
    $fields = array();
    $result = db_query('SELECT name, title, type, weight FROM {profile_fields} WHERE visibility = %d ORDER BY category, weight', PROFILE_PUBLIC_LISTINGS);
Dries Buytaert's avatar
 
Dries Buytaert committed
    while ($record = db_fetch_object($result)) {
      $fields[] = $record;
    }

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

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

    drupal_set_title(t('user list'));
Dries Buytaert's avatar
 
Dries Buytaert committed
    return $output;
Dries Buytaert's avatar
 
Dries Buytaert committed
  }
Dries Buytaert's avatar
 
Dries Buytaert committed
}
Dries Buytaert's avatar
Dries Buytaert committed

Dries Buytaert's avatar
 
Dries Buytaert committed
function profile_load_profile(&$user) {
Steven Wittens's avatar
Steven Wittens committed
  $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 Buytaert's avatar
 
Dries Buytaert committed
  while ($field = db_fetch_object($result)) {
    if (empty($user->{$field->name})) {
Steven Wittens's avatar
Steven Wittens committed
      $user->{$field->name} = _profile_field_serialize($field->type) ? unserialize($field->value) : $field->value;
Dries Buytaert's avatar
 
Dries Buytaert committed
    }
Dries Buytaert's avatar
 
Dries Buytaert committed
  }
Dries Buytaert's avatar
Dries Buytaert committed
}

function profile_save_profile(&$edit, &$user, $category) {
  if ($_GET['q'] == 'user/register' || $_GET['q'] == 'admin/user/create') {
    $result = db_query('SELECT fid, name, type FROM {profile_fields} WHERE register = 1 AND visibility != %d ORDER BY category, weight', PROFILE_HIDDEN);
Dries Buytaert's avatar
 
Dries Buytaert committed
  }
  else {
    $result = db_query("SELECT fid, name, type FROM {profile_fields} WHERE LOWER(category) = LOWER('%s') AND visibility != %d", $category, PROFILE_HIDDEN);
    // We use LOWER('%s') instead of PHP's strtolower() to avoid UTF-8 conversion issues.
Dries Buytaert's avatar
 
Dries Buytaert committed
  }
Dries Buytaert's avatar
 
Dries Buytaert committed
  while ($field = db_fetch_object($result)) {
Steven Wittens's avatar
Steven Wittens committed
    if (_profile_field_serialize($field->type)) {
       $edit[$field->name] = serialize($edit[$field->name]);
    }
    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]);
    // Mark field as handled (prevents saving to user->data).
Dries Buytaert's avatar
 
Dries Buytaert committed
  }
Dries Buytaert's avatar
Dries Buytaert committed
}

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

  if ($value = $user->{$field->name}) {
    switch ($field->type) {
      case 'textfield':
        return check_plain($value);
        return $browse ? l($value, 'profile/'. $field->name .'/'. $value) : check_plain($value);
        return $browse ? l($field->title, 'profile/'. $field->name) : check_plain($field->title);
        return '<a href="'. check_url($value) .'">'. check_plain($value) .'</a>';
Steven Wittens's avatar
Steven Wittens committed
      case 'date':
        list($format) = explode(' - ', variable_get('date_format_short', 'm/d/Y - H:i'), 2);
        // Note: we avoid PHP's date() because it does not handle dates before
        // 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']),
                         'Y' => $value['year'],
                         'H:i' => null,
                         'g:ia' => null);
Steven Wittens's avatar
Steven Wittens committed
        return strtr($format, $replace);
Dries Buytaert's avatar
 
Dries Buytaert committed
        $values = split("[,\n\r]", $value);
        $fields = array();
        foreach ($values as $value) {
Steven Wittens's avatar
Steven Wittens committed
          if ($value = trim($value)) {
            $fields[] = $browse ? l($value, "profile/". drupal_urlencode($field->name) ."/". drupal_urlencode($value)) : check_plain($value);
          }
        }
        return implode(', ', $fields);
Dries Buytaert's avatar
 
Dries Buytaert committed
function profile_view_profile($user) {
Dries Buytaert's avatar
Dries Buytaert committed

  profile_load_profile($user);
Dries Buytaert's avatar
Dries Buytaert committed

Steven Wittens's avatar
Steven Wittens committed
  // Show private fields to administrators and people viewing their own account.
  if (user_access('administer users') || $GLOBALS['user']->uid == $user->uid) {
    $result = db_query('SELECT * FROM {profile_fields} WHERE visibility != %d ORDER BY category, weight', PROFILE_HIDDEN);
Steven Wittens's avatar
Steven Wittens committed
  }
  else {
    $result = db_query('SELECT * FROM {profile_fields} WHERE visibility != %d AND visibility != %d ORDER BY category, weight', PROFILE_PRIVATE, PROFILE_HIDDEN);
Dries Buytaert's avatar
 
Dries Buytaert committed
  while ($field = db_fetch_object($result)) {
    if ($value = profile_view_field($user, $field)) {
Steven Wittens's avatar
Steven Wittens committed
      $description = ($field->visibility == PROFILE_PRIVATE) ? t('The content of this field is private and only visible to yourself.') : '';
      $title = ($field->type != 'checkbox') ? check_plain($field->title) : NULL;
      $item = array('title' => $title,
        'value' => $value,
        'class' => $field->name,
      );
      $fields[$field->category][] = $item;
Dries Buytaert's avatar
Dries Buytaert committed
    }
  }
  return $fields;
Dries Buytaert's avatar
 
Dries Buytaert committed
}
Dries Buytaert's avatar
Dries Buytaert committed

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

  if ($field->type == 'list') {
    $output .= ' '. t('Put each item on a separate line or separate them by commas. No HTML allowed.');
  }

  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) {
  if ($_GET['q'] == 'user/register') {
    $result = db_query('SELECT * FROM {profile_fields} WHERE visibility != %d AND register = 1 ORDER BY category, weight', PROFILE_HIDDEN);
Dries Buytaert's avatar
 
Dries Buytaert committed
  }
  elseif ($_GET['q'] == 'admin/user/create') {
     $result = db_query('SELECT * FROM {profile_fields} WHERE register = 1 ORDER BY category, weight');
   }
  elseif (user_access('administer users')) {
     $result = db_query("SELECT * FROM {profile_fields} WHERE LOWER(category) = LOWER('%s') ORDER BY weight", $category);
Dries Buytaert's avatar
 
Dries Buytaert committed
  }
  else {
    $result = db_query("SELECT * FROM {profile_fields} WHERE visibility != %d AND LOWER(category) = LOWER('%s') ORDER BY weight", PROFILE_HIDDEN, $category);
     // We use LOWER('%s') instead of PHP's strtolower() to avoid UTF-8 conversion issues.
   }
Dries Buytaert's avatar
 
Dries Buytaert committed
  while ($field = db_fetch_object($result)) {
Dries Buytaert's avatar
 
Dries Buytaert committed
    $category = $field->category;
    if (!isset($fields[$category])) {
      $fields[$category] = array('#type' => 'fieldset', '#title' => $category, '#weight' => $w++);
    }
Dries Buytaert's avatar
 
Dries Buytaert committed
    switch ($field->type) {
      case 'textfield':
        $fields[$category][$field->name] = array(
          '#type' => 'textfield',
          '#title' => check_plain($field->title),
          '#default_value' => $edit[$field->name],
          '#maxlength' => 255,
          '#description' => _profile_form_explanation($field),
          '#required' => $field->required
        );
Dries Buytaert's avatar
 
Dries Buytaert committed
        break;
      case 'textarea':
        $fields[$category][$field->name] = array(
          '#type' => 'textarea',
          '#title' => check_plain($field->title),
          '#default_value' => $edit[$field->name],
          '#description' => _profile_form_explanation($field),
          '#required' => $field->required
        );
        break;
      case 'list':
        $fields[$category][$field->name] = array(
          '#type' => 'textarea',
          '#title' => check_plain($field->title),
          '#default_value' => $edit[$field->name],
          '#description' => _profile_form_explanation($field),
          '#required' => $field->required
        );
Dries Buytaert's avatar
 
Dries Buytaert committed
        break;
      case 'checkbox':
        $fields[$category][$field->name] = array(
          '#type' => 'checkbox',
          '#title' => check_plain($field->title),
          '#default_value' => $edit[$field->name],
          '#description' => _profile_form_explanation($field),
          '#required' => $field->required
        );
Dries Buytaert's avatar
 
Dries Buytaert committed
        break;
      case 'selection':
        $options = array('--');
Dries Buytaert's avatar
 
Dries Buytaert committed
        $lines = split("[,\n\r]", $field->options);
Dries Buytaert's avatar
 
Dries Buytaert committed
        foreach ($lines as $line) {
          if ($line = trim($line)) {
            $options[$line] = $line;
          }
        }
        $fields[$category][$field->name] = array(
          '#type' => 'select',
          '#title' => check_plain($field->title),
          '#default_value' => $edit[$field->name],
          '#options' => $options,
          '#description' => _profile_form_explanation($field),
          '#required' => $field->required
        );
Dries Buytaert's avatar
 
Dries Buytaert committed
        break;
Steven Wittens's avatar
Steven Wittens committed
      case 'date':
        $fields[$category][$field->name] = array(
          '#type' => 'date',
          '#title' => check_plain($field->title),
          '#default_value' => $edit[$field->name],
          '#description' => _profile_form_explanation($field),
          '#required' => $field->required
        );
Steven Wittens's avatar
Steven Wittens committed
        break;
Dries Buytaert's avatar
Dries Buytaert committed
    }
  }
Dries Buytaert's avatar
Dries Buytaert committed
}

/**
 * Helper function: update an array of user fields by calling profile_view_field
 */
function _profile_update_user_fields($fields, $account) {
  foreach ($fields as $key => $field) {
    if ($value = profile_view_field($account, $field)) {
      $fields[$key]->value = $value;
    }
  }
function profile_validate_profile($edit, $category) {
  if ($_GET['q'] == 'user/register') {
    $result = db_query('SELECT * FROM {profile_fields} WHERE visibility != %d AND register = 1 ORDER BY category, weight', PROFILE_HIDDEN);
Dries Buytaert's avatar
 
Dries Buytaert committed
  }
  elseif ($_GET['q'] == 'admin/user/create') {
     $result = db_query('SELECT * FROM {profile_fields} WHERE register = 1 ORDER BY category, weight');
   }
  elseif (user_access('administer users')) {
     $result = db_query("SELECT * FROM {profile_fields} WHERE LOWER(category) = LOWER('%s') ORDER BY weight", $category);
Dries Buytaert's avatar
 
Dries Buytaert committed
  }
  else {
    $result = db_query("SELECT * FROM {profile_fields} WHERE visibility != %d AND LOWER(category) = LOWER('%s') ORDER BY weight", PROFILE_HIDDEN, $category);
     // We use LOWER('%s') instead of PHP's strtolower() to avoid UTF-8 conversion issues.
   }

  while ($field = db_fetch_object($result)) {
Dries Buytaert's avatar
 
Dries Buytaert committed
      if ($field->type == 'url') {
        if (!valid_url($edit[$field->name], true)) {
          form_set_error($field->name, t('The value provided for %field is not a valid URL.', array('%field' => theme('placeholder', $field->title))));
        }
    else if ($field->required && !user_access('administer users')) {
      form_set_error($field->name, t('The field %field is required.', array('%field' => theme('placeholder', $field->title))));
Dries Buytaert's avatar
 
Dries Buytaert committed
    }
function profile_categories() {
  $result = db_query("SELECT DISTINCT(category) FROM {profile_fields}");
  while ($category = db_fetch_object($result)) {
    $data[] = array('name' => check_plain($category->category), 'title' => $category->category, 'weight' => 3);
Dries Buytaert's avatar
 
Dries Buytaert committed
/**
 * Implementation of hook_user().
 */
function profile_user($type, &$edit, &$user, $category = NULL) {
Dries Buytaert's avatar
 
Dries Buytaert committed
  switch ($type) {
    case 'load':
      return profile_load_profile($user);
Dries Buytaert's avatar
 
Dries Buytaert committed
    case 'register':
      return profile_form_profile($edit, $user, $category);
Dries Buytaert's avatar
 
Dries Buytaert committed
    case 'update':
      return profile_save_profile($edit, $user, $category);
Dries Buytaert's avatar
 
Dries Buytaert committed
    case 'view':
      return profile_view_profile($user);
      return profile_form_profile($edit, $user, $category);
Dries Buytaert's avatar
 
Dries Buytaert committed
    case 'validate':
      return profile_validate_profile($edit, $category);
    case 'categories':
      return profile_categories();
Dries Buytaert's avatar
 
Dries Buytaert committed
  }
}
Dries Buytaert's avatar
 
Dries Buytaert committed

Dries Buytaert's avatar
 
Dries Buytaert committed
function profile_validate_form($edit) {
Dries Buytaert's avatar
Dries Buytaert committed

Dries Buytaert's avatar
 
Dries Buytaert committed
  // Validate the title:
  if (!$edit['title']) {
Dries Buytaert's avatar
 
Dries Buytaert committed
    form_set_error('title', t('You must enter a title.'));
Dries Buytaert's avatar
Dries Buytaert committed
  }

Dries Buytaert's avatar
 
Dries Buytaert committed
  // Validate the 'form name':
  if (eregi('[^a-z0-9_-]', $edit['name'])) {
    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.'));
Dries Buytaert's avatar
Dries Buytaert committed
  }

Dries Buytaert's avatar
 
Dries Buytaert committed
  if (in_array($edit['name'], user_fields())) {
Dries Buytaert's avatar
 
Dries Buytaert committed
    form_set_error('name', t('The specified form name is reserved for use by Drupal.'));
Dries Buytaert's avatar
Dries Buytaert committed
  }

Dries Buytaert's avatar
 
Dries Buytaert committed
  // Validate the category:
  if (!$edit['category']) {
Dries Buytaert's avatar
 
Dries Buytaert committed
    form_set_error('category', t('You must enter a category.'));
Dries Buytaert's avatar
 
Dries Buytaert committed
  }

  if ($edit['category'] == 'account') {
    form_set_error('category', t('The specified category name is reserved for use by Drupal.'));
  }
Dries Buytaert's avatar
Dries Buytaert committed
}

Dries Buytaert's avatar
 
Dries Buytaert committed
/**
 * Menu callback; adds a new field to all user profiles.
 */
Dries Buytaert's avatar
 
Dries Buytaert committed
function profile_admin_add($type) {
  if ($_POST['op']) {
    $data = $_POST['edit'];
Dries Buytaert's avatar
Dries Buytaert committed

Dries Buytaert's avatar
 
Dries Buytaert committed
    // Validate the form:
    profile_validate_form($data);

    if (db_result(db_query("SELECT fid FROM {profile_fields} WHERE title = '%s' AND category = '%s'", $data['title'], $data['category']))) {
Steven Wittens's avatar
Steven Wittens committed
      form_set_error('title', t('The specified title is already in use.'));
Dries Buytaert's avatar
 
Dries Buytaert committed

    if (db_result(db_query("SELECT fid FROM {profile_fields} WHERE name = '%s'", $data['name']))) {
Steven Wittens's avatar
Steven Wittens committed
      form_set_error('name', t('The specified name is already in use.'));
Dries Buytaert's avatar
 
Dries Buytaert committed

Dries Buytaert's avatar
 
Dries Buytaert committed
    if (!form_get_errors()) {
Dries Buytaert's avatar
 
Dries Buytaert committed
      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')", $data['title'], $data['name'], $data['explanation'], $data['category'], $type, $data['weight'], $data['required'], $data['register'], $data['visibility'], $data['options'], $data['page']);
Dries Buytaert's avatar
Dries Buytaert committed

Dries Buytaert's avatar
 
Dries Buytaert committed
      cache_clear_all();

Steven Wittens's avatar
Steven Wittens committed
      drupal_set_message(t('The field has been created.'));
      drupal_goto('admin/settings/profile');
Dries Buytaert's avatar
 
Dries Buytaert committed
    }
Dries Buytaert's avatar
 
Dries Buytaert committed
  }
Dries Buytaert's avatar
 
Dries Buytaert committed
  else {
    $data = array('name' => 'profile_');
  }

  drupal_set_title(t('Add new %type', array('%type' => _profile_field_types($type))));
Dries Buytaert's avatar
 
Dries Buytaert committed
  return _profile_field_form($type, $data);
Dries Buytaert's avatar
 
Dries Buytaert committed
}

Dries Buytaert's avatar
 
Dries Buytaert committed
/**
 * Menu callback; displays the profile field editing form.
 */
Dries Buytaert's avatar
 
Dries Buytaert committed
function profile_admin_edit($fid) {
Dries Buytaert's avatar
Dries Buytaert committed

Dries Buytaert's avatar
 
Dries Buytaert committed
  if ($_POST['op']) {
    $data = $_POST['edit'];
Dries Buytaert's avatar
Dries Buytaert committed

Dries Buytaert's avatar
 
Dries Buytaert committed
    // Validate form:
    profile_validate_form($data);
Dries Buytaert's avatar
Dries Buytaert committed

Dries Buytaert's avatar
 
Dries Buytaert committed
    if (!form_get_errors()) {
Dries Buytaert's avatar
 
Dries Buytaert committed
      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", $data['title'], $data['name'], $data['explanation'], $data['category'], $data['weight'], $data['required'], $data['register'], $data['visibility'], $data['options'], $data['page'], $fid);
Dries Buytaert's avatar
 
Dries Buytaert committed

Dries Buytaert's avatar
 
Dries Buytaert committed
      cache_clear_all();

Steven Wittens's avatar
Steven Wittens committed
      drupal_set_message(t('The field has been updated.'));
      drupal_goto('admin/settings/profile');
Dries Buytaert's avatar
 
Dries Buytaert committed
    }
Dries Buytaert's avatar
 
Dries Buytaert committed
  }
  else {
Dries Buytaert's avatar
 
Dries Buytaert committed
    $data = db_fetch_array(db_query('SELECT * FROM {profile_fields} WHERE fid = %d', $fid));
Dries Buytaert's avatar
Dries Buytaert committed
  }

  drupal_set_title(t('Edit %type', array('%type' => $data['type'])));
Dries Buytaert's avatar
 
Dries Buytaert committed
  return _profile_field_form($data['type'], $data);
Dries Buytaert's avatar
Dries Buytaert committed
}

Dries Buytaert's avatar
 
Dries Buytaert committed
/**
 * Menu callback; deletes a field from all user profiles.
 */
Dries Buytaert's avatar
 
Dries Buytaert committed
function profile_admin_delete($fid) {
  $field = db_fetch_object(db_query("SELECT title FROM {profile_fields} WHERE fid = %d", $fid));
  if ($_POST['edit']['confirm']) {
    db_query('DELETE FROM {profile_fields} WHERE fid = %d', $fid);
    db_query('DELETE FROM {profile_values} WHERE fid = %d', $fid);
    cache_clear_all();
    drupal_set_message(t('The field %field has been deleted.', array('%field' => theme('placeholder', $field->title))));
    drupal_goto('admin/settings/profile');
  }
  else {
    return confirm_form('profile_confirm_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 profile field\' so that it may only be accessed by administrators.', array('%edit-field' => url('admin/settings/profile/edit/' . $fid))),
                        t('Delete'),
                        t('Cancel'));
Dries Buytaert's avatar
Dries Buytaert committed
}

Dries Buytaert's avatar
 
Dries Buytaert committed
function _profile_field_form($type, $edit = array()) {
  $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.'),
  );
Dries Buytaert's avatar
 
Dries Buytaert committed
  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". Only applicable if the field is configured to be shown on member list pages.'),
    );
Dries Buytaert's avatar
 
Dries Buytaert committed
  }
  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'),
  );
Dries Buytaert's avatar
 
Dries Buytaert committed

  return drupal_get_form('_profile_field_form', $form);
Dries Buytaert's avatar
 
Dries Buytaert committed
}

Dries Buytaert's avatar
 
Dries Buytaert committed
/**
 * Menu callback; display a listing of all editable profile fields.
 */
Dries Buytaert's avatar
 
Dries Buytaert committed
function profile_admin_overview() {

  $result = db_query('SELECT * FROM {profile_fields} ORDER BY category, weight');
Steven Wittens's avatar
Steven Wittens committed
  $rows = array();
Dries Buytaert's avatar
 
Dries Buytaert committed
  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"));
Steven Wittens's avatar
Steven Wittens committed
  }
  if (count($rows) == 0) {
    $rows[] = array(array('data' => t('No fields defined.'), 'colspan' => '6'));
Dries Buytaert's avatar
Dries Buytaert committed
  }
Dries Buytaert's avatar
 
Dries Buytaert committed

Dries Buytaert's avatar
 
Dries Buytaert committed
  $header = array(t('Title'), t('Name'), t('Type'), t('Category'), array('data' => t('Operations'), 'colspan' => '2'));
Dries Buytaert's avatar
 
Dries Buytaert committed

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

Dries Buytaert's avatar
 
Dries Buytaert committed
  return $output;
Dries Buytaert's avatar
Dries Buytaert committed
}

function theme_profile_block($account, $fields = array()) {
  $output .= theme('user_picture', $account);
      $output .= "<p><strong>$field->title:</strong><br />$field->value</p>\n";
function theme_profile_listing($account, $fields = array()) {
Dries Buytaert's avatar
 
Dries Buytaert committed

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

  foreach ($fields as $field) {
      $output .= " <div class=\"field\">$field->value</div>\n";
Dries Buytaert's avatar
Dries Buytaert committed
    }
  }
Dries Buytaert's avatar
 
Dries Buytaert committed

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

  return $output;
}

function _profile_field_types($type = NULL) {
Steven Wittens's avatar
Steven Wittens committed
  $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 Buytaert's avatar
 
Dries Buytaert committed
  return isset($type) ? $types[$type] : $types;
Dries Buytaert's avatar
Dries Buytaert committed
}

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