realname.admin.inc in Real Name 6

The RealName module allows the admin to choose fields from the user profile that will be used to add a "realname" element (method) to a user object. Hook_user is used to automatically add this to any user object that is loaded.

File

realname.admin.inc

<?php

/**
 * @file
 * The RealName module allows the admin to choose fields from the user profile
 * that will be used to add a "realname" element (method) to a user object.
 * Hook_user is used to automatically add this to any user object that is loaded.
 */

/**
 * Displays the admin settings form.
 * @TODO: move this admin stuff to separate file.
 */
function realname_admin_settings() {
  return drupal_get_form('realname_admin_general');
}
function realname_admin_general() {
  $form = array();
  $form['realname_nodeapi'] = array(
    '#type' => 'checkbox',
    '#title' => '<strong>' . t('Show realname in nodes') . '</strong>',
    '#description' => t('If this option is selected, the "Real name" will be used on node displays.'),
    '#default_value' => variable_get('realname_nodeapi', FALSE),
  );
  if (variable_get('realname_profile_module', NULL) == 'content_profile') {
    $form['realname_use_title'] = array(
      '#type' => 'checkbox',
      '#title' => '<strong>' . t('Add node title to available fields') . '</strong>',
      '#description' => t('This option allows you to include the profile title in the list of available fields.'),
      '#default_value' => variable_get('realname_use_title', FALSE),
    );
  }
  else {
    $form['realname_use_title'] = array(
      '#type' => 'value',
      '#value' => FALSE,
    );
  }
  if (module_exists('views')) {
    $form['realname_view'] = array(
      '#type' => 'checkbox',
      '#title' => '<strong>' . t('Overwrite user fields in view to show realnames') . '</strong>',
      '#description' => t('This option will overwrite the default user name definition in Views in order to show Realnames without the need to modify Views. Remember to rebuild your Views cache if you change this option.'),
      '#default_value' => variable_get('realname_view', FALSE),
    );
  }
  $form['realname_myacct'] = array(
    '#type' => 'textfield',
    '#title' => '<strong>' . t('Title for own account') . '</strong>',
    '#description' => t('This will be shown instead of "My account" on the user\'s own account pages and in the menu. If it is empty, the user\'s RealName will be shown.'),
    '#default_value' => variable_get('realname_myacct', t('My account')),
  );
  $form['search'] = array(
    '#type' => 'fieldset',
    '#title' => t('Search options'),
    '#description' => t('These settings control how RealName search will work.'),
    '#collapsible' => TRUE,
    '#collapsed' => FALSE,
  );
  $search_enable = variable_get('realname_search_enable', FALSE);
  $user_disable = variable_get('realname_user_disable', FALSE);
  $form['original_search_enable'] = array(
    '#type' => 'value',
    '#value' => $search_enable,
  );
  $form['original_user_disable'] = array(
    '#type' => 'value',
    '#value' => $user_disable,
  );
  $form['search']['realname_search_enable'] = array(
    '#type' => 'checkbox',
    '#title' => '<strong>' . t('Enable realname search') . '</strong>',
    '#description' => t('If this option is selected, the "Real name" searching will be allowed. The menus will be rebuilt if this setting changes.'),
    '#default_value' => $search_enable,
  );
  $form['search']['realname_user_disable'] = array(
    '#type' => 'checkbox',
    '#title' => '<strong>' . t('Disable user search') . '</strong>',
    '#description' => t('If this option is selected, the standard "Users" search page will be disabled. The menus will be rebuilt if this setting changes.'),
    '#default_value' => $user_disable,
  );
  $form['search']['realname_search_login'] = array(
    '#type' => 'checkbox',
    '#title' => '<strong>' . t('Include login name in search') . '</strong>',
    '#description' => t('Should the "Real name" search also index the login name?'),
    '#default_value' => variable_get('realname_search_login', FALSE),
  );
  $form['theme'] = array(
    '#type' => 'fieldset',
    '#title' => t('Theme_username options'),
    '#description' => t('These settings control how "theme(\'username\', ...)" will work.'),
    '#collapsible' => TRUE,
    '#collapsed' => FALSE,
  );
  $form['theme']['realname_theme'] = array(
    '#type' => 'checkbox',
    '#title' => '<strong>' . t('Override username theme') . '</strong>',
    '#description' => t('If this option is selected, the standard username theme function will be overriden to use the "Real name."'),
    '#default_value' => variable_get('realname_theme', TRUE),
  );
  $form['theme']['realname_max_username'] = array(
    '#type' => 'textfield',
    '#field_prefix' => '<strong>' . t('Maximum allowed username length') . '</strong> ',
    '#description' => t('Long usernames may "break" some tables or other displays; this setting limits the maximum length. Note that the core recommendation is 20.'),
    '#size' => 6,
    '#default_value' => variable_get('realname_max_username', 20),
  );
  $form['theme']['realname_notver'] = array(
    '#type' => 'checkbox',
    '#title' => '<strong>' . t('Show "Not verified" for anonymous users') . '</strong>',
    '#description' => t('Drupal core adds "Not verified" for anonymous users, this option allows that to be turned off.'),
    '#default_value' => variable_get('realname_notver', TRUE),
  );
  $form['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Save configuration'),
  );
  return $form;
}
function realname_admin_general_validate($form, &$form_state) {

  // If realname_search is not enabled, then we won't disable user_search.
  if (!$form_state['values']['realname_search_enable'] && $form_state['values']['realname_user_disable']) {
    form_set_error('realname_user_disable', t('User search disable cannot be used if RealName search is not enabled.'));
  }
}
function realname_admin_general_submit($form, &$form_state) {
  variable_set('realname_nodeapi', $form_state['values']['realname_nodeapi']);
  variable_set('realname_myacct', $form_state['values']['realname_myacct']);
  variable_set('realname_search_enable', $form_state['values']['realname_search_enable']);
  variable_set('realname_user_disable', $form_state['values']['realname_user_disable']);
  variable_set('realname_search_login', $form_state['values']['realname_search_login']);
  variable_set('realname_theme', $form_state['values']['realname_theme']);
  variable_set('realname_max_username', $form_state['values']['realname_max_username']);
  variable_set('realname_notver', $form_state['values']['realname_notver']);
  variable_set('realname_use_title', $form_state['values']['realname_use_title']);
  variable_set('realname_view', $form_state['values']['realname_view']);

  // Did the admin change the search enable or user disable settings?
  if ($form_state['values']['original_search_enable'] != $form_state['values']['realname_search_enable'] || $form_state['values']['original_user_disable'] != $form_state['values']['realname_user_disable']) {

    // Yes, so we have to rebuild the menu.
    menu_rebuild();
    drupal_set_message(t('The menu router has been rebuilt.'));
    watchdog('RealName', 'User module search disabled.');
  }
  drupal_set_message(t('Configuration saved.'));
}
function realname_admin_bypass() {
  $form = array();
  $current = variable_get('realname_bypass_forms', array(
    array(
      'name' => 'comment_form',
      'fields' => array(
        'name',
      ),
    ),
  ));
  $rows = count($current);
  $bypass_list = NULL;
  foreach ($current as $bypass) {
    $bypass_list .= $bypass['name'] . ' ' . implode(' ', $bypass['fields']) . "\n";
  }
  $form['warning'] = array(
    '#type' => 'markup',
    '#value' => '<div class="messages warning">' . t('<strong>WARNING</strong>: This form may cause errors if the instructions below are not followed or if you give an invalid form name or field name. Please do not remove the "comment_form" line.') . '</div>',
  );
  $form['bypass_forms'] = array(
    '#type' => 'textarea',
    '#title' => t('Bypass these forms'),
    '#rows' => max(array(
      $rows + 1,
      5,
    )),
    '#default_value' => $bypass_list,
    '#description' => t('Enter one form per line. Each line should start with the form name. That should be followed by the name of the field to be reset to the username. If the field is a child field, include its full parent path, separated by spaces. For example: mymodule_form fieldset_1 fieldset_2 name'),
    '#required' => TRUE,
  );
  $form['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Bypass these forms'),
  );
  return $form;
}
function realname_admin_bypass_submit($form, &$form_state) {
  $bypass_list = explode("\n", $form_state['values']['bypass_forms']);
  $bypass_forms = array();
  foreach ($bypass_list as $line) {
    $line = trim($line);
    if ($line) {
      $pieces = explode(' ', $line);
      $form_info = array(
        'name' => array_shift($pieces),
      );
      $form_info['fields'] = $pieces;
      $bypass_forms[] = $form_info;
    }
  }
  variable_set('realname_bypass_forms', $bypass_forms);

  // Mark form for realname recalculation.
  variable_set('realname_recalculate', TRUE);
  drupal_set_message(t('Information saved for !count forms.', array(
    '!count' => count($bypass_forms),
  )), 'status');
}
function realname_admin_module($form_state) {
  $form = array();

  // Get the list of modules we support.
  $supported_modules = realname_supported_modules();
  $choices = $show_types = array();
  foreach ($supported_modules as $module => $values) {
    if (module_exists($module)) {
      $choices[$module] = check_plain($values['name']);
      $show_types[$module] = $values['types'];
    }
  }
  $form['show_types'] = array(
    '#type' => 'value',
    '#value' => $show_types,
  );
  if (isset($form_state['storage']['module_chosen'])) {
    $module = $form_state['storage']['module_chosen'];
    $form['module'] = array(
      '#type' => 'item',
      '#value' => t('You have chosen the "@module" module to provide data.', array(
        '@module' => $module,
      )),
    );

    // Now show the types, if appropriate.
    $button_text = t('Use this content type');
    $form['type'] = array(
      '#type' => 'radios',
      '#title' => t('Content types available to @module', array(
        '@module' => $module,
      )),
      '#options' => $form_state['storage']['types'],
      '#default_value' => variable_get('realname_profile_type', NULL),
      '#required' => TRUE,
    );
  }
  else {
    $button_text = t('Use this module');
    $form['module'] = array(
      '#type' => 'radios',
      '#title' => t('These modules are available for providing data to RealName'),
      '#options' => $choices,
      '#default_value' => variable_get('realname_profile_module', NULL),
      '#required' => TRUE,
    );
  }
  $form['submit'] = array(
    '#type' => 'submit',
    '#value' => $button_text,
  );
  return $form;
}
function realname_admin_module_submit($form, &$form_state) {
  if (isset($form_state['storage']['module_chosen'])) {
    variable_set('realname_profile_type', $form_state['values']['type']);
  }
  else {

    // First time here, so sav ethe chosen module and prepare types.
    $module = $form_state['values']['module'];
    variable_set('realname_profile_module', $module);
    $form_state['storage']['module_chosen'] = $module;
    $show_types = $form_state['values']['show_types'];
    if ($show_types[$module]) {
      $module_info = realname_supported_modules($module);
      if (isset($module_info['file'])) {
        $path = !empty($module_info['path']) ? $module_info['path'] : drupal_get_path('module', $module);
        require_once $path . '/' . $module_info['file'];
      }

      // This module uses types, so let's see what types are allowed.
      $types = (array) module_invoke($module, 'realname_get_types');
      if (count($types) > 1) {
        $form_state['storage']['types'] = $types;
        return;
      }
      else {
        variable_set('realname_profile_type', key($types));
      }
    }
  }

  // Mark form for realname recalculation.
  variable_set('realname_recalculate', TRUE);

  // We are done with types, so go pick fields.
  unset($form_state['storage']);
  $form_state['redirect'] = 'admin/user/realname/fields';

  // Go get the fields now.
  return;
}
function realname_admin_fields() {
  $form = array();
  $module = variable_get('realname_profile_module', NULL);

  // Do we have a module set yet?
  if (!$module) {
    drupal_goto('admin/user/realname/module');
  }
  $module_info = $module ? realname_supported_modules($module) : NULL;
  if (isset($module_info['fields']) && !$module_info['fields']) {
    $form['heading'] = array(
      '#type' => 'item',
      '#value' => t("You are using the %module module to provide data and it doesn't utilize fields.", array(
        '%module' => $module,
      )),
    );
    return $form;
  }
  if (isset($module_info['file'])) {
    $path = !empty($module_info['path']) ? $module_info['path'] : drupal_get_path('module', $module);
    require_once $path . '/' . $module_info['file'];
  }
  $current = variable_get('realname_fields', array());
  $type = !isset($module_info['type']) || !$module_info['type'] ? variable_get('realname_profile_type', NULL) : NULL;
  $profile_fields = (array) module_invoke($module, 'realname_get_fields', $current, $type);
  $what = t('You are using the %module module to provide fields.', array(
    '%module' => $module,
  ));
  if ($type) {
    $what .= t('The %type type is the source of data.', array(
      '%type' => $type,
    ));
  }
  $form['heading'] = array(
    '#type' => 'item',
    '#value' => $what,
  );
  $fields = $profile_fields['fields'];
  uasort($fields, '_realname_sort');
  $links = $profile_fields['links'];
  asort($links);
  $form['start_table'] = array(
    '#type' => 'markup',
    '#value' => '<table><tr><th>Select</th><th>Field name</th><th>Weight</th></tr>',
  );
  $i = 0;
  foreach ($fields as $f_name => $values) {
    $form['field_select_' . $i] = array(
      '#type' => 'checkbox',
      '#default_value' => $values['selected'],
      '#prefix' => '<tr><td align="center">',
      '#suffix' => '</td>',
    );
    $form['field_name_' . $i] = array(
      '#type' => 'hidden',
      '#value' => $f_name,
    );
    $form['field_title_' . $i] = array(
      '#type' => 'item',
      '#value' => $values['title'],
      '#prefix' => '<td>',
      '#suffix' => '</td>',
    );
    $form['field_weight_' . $i] = array(
      '#type' => 'weight',
      '#delta' => 10,
      '#default_value' => $values['weight'],
      '#prefix' => '<td>',
      '#suffix' => '</td></tr>',
    );
    $i++;
  }
  $form['end_table'] = array(
    '#type' => 'markup',
    '#value' => '</table>',
  );
  $form['realname_pattern'] = array(
    '#type' => 'textfield',
    '#field_prefix' => '<strong>' . t('Name Pattern') . '</strong> ',
    '#description' => t('This determines how the fields will be used to create the "Real name." Use "%1" to refer to the first field, "%2" to refer to the second, etc.'),
    '#size' => 30,
    '#default_value' => variable_get('realname_pattern', '%1'),
  );

  // If there were any URL fields, give a home page option.
  $form['homepage'] = array(
    '#type' => 'fieldset',
    '#title' => t('Homepage options'),
    '#description' => t('There were URL fields in the profile. If one of these is a personal homepage link, you may choose to link to it rather than the user profile. Choose which field to use.'),
    '#collapsible' => TRUE,
    '#collapsed' => count($links) == 0,
    '#access' => !empty($links),
  );
  $form['homepage']['realname_homepage'] = array(
    '#type' => 'select',
    '#options' => array(
      '' => t('- None -'),
    ) + $links,
    '#title' => t('Link to homepage'),
    '#description' => t('Select a personal homepage link, if appropriate.'),
    '#default_value' => variable_get('realname_homepage', ''),
  );
  $form['homepage']['realname_nofollow'] = array(
    '#type' => 'checkbox',
    '#title' => t('Spam link deterrent'),
    '#description' => t('If enabled, Drupal will add rel="nofollow" to all links, as a measure to reduce the effectiveness of spam links. Note: this will also prevent valid links from being followed by search engines, therefore it is likely most effective when enabled for anonymous users.'),
    '#default_value' => variable_get('realname_nofollow', FALSE),
  );
  $form['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Save'),
  );
  return $form;
}

/**
 * Form submit handler.
 */
function realname_admin_fields_submit($form, &$form_state) {
  $i = 0;
  $fields = array();

  // Run the form values to get all the fields they want.
  while (isset($form_state['values']['field_select_' . $i])) {
    if ($form_state['values']['field_select_' . $i]) {
      $fields[] = array(
        'title' => $form_state['values']['field_name_' . $i],
        'weight' => $form_state['values']['field_weight_' . $i],
      );
    }
    $i++;
  }

  // A little hoop jumping to sort right.
  uasort($fields, '_realname_sort');
  $realname_fields = array();
  foreach ($fields as $key => $values) {
    $realname_fields[$values['title']] = $values['weight'];
  }

  // Okay, save the stuff.
  variable_set('realname_fields', $realname_fields);
  variable_set('realname_pattern', $form_state['values']['realname_pattern']);
  variable_set('realname_homepage', $form_state['values']['realname_homepage']);
  variable_set('realname_nofollow', $form_state['values']['realname_nofollow']);

  // Mark form for realname recalculation.
  variable_set('realname_recalculate', TRUE);
  drupal_set_message(t('Configuration has been updated.'), 'status');
}

/**
 * Real names rebuild (in case of config change) handlers.
 */

/**
 * Menu callback: confirm rebuilding of realnames.
 */
function realname_rebuild_confirm() {
  return confirm_form(array(), t('Are you sure you want to rebuild the RealNames for all site users?'), 'admin/user/realname', t('This action rebuilds RealNames for all users, and may be a lengthy process.
    This action cannot be undone.'), t('Rebuild realnames'), t('Cancel'));
}

/**
 * Handler for rebuild confirmation
 */
function realname_rebuild_confirm_submit($form, &$form_state) {
  $batch = array(
    'title' => t('Rebuilding realnames'),
    'operations' => array(
      array(
        '_realname_rebuild_realnames',
        array(),
      ),
    ),
    'file' => drupal_get_path('module', 'realname') . '/realname.admin.inc',
    'finished' => '_realname_rebuild_batch_finished',
  );
  batch_set($batch);
}

/**
 * Batchable function used to rebuild realnames
 */
function _realname_rebuild_realnames(&$context) {
  if (empty($context['sandbox'])) {

    // Initiate multistep processing.
    $context['sandbox']['progress'] = 0;

    //    $context['sandbox']['current_user'] = 0;
    // Skip user 0 (anonymous).
    $context['sandbox']['current_user'] = 1;
    $context['sandbox']['max'] = db_result(db_query('SELECT COUNT(DISTINCT uid) FROM {users} WHERE uid > 0'));

    // Let's get rid of all existing data and start fresh.
    db_query('TRUNCATE {realname}');
  }

  // Process the next 20 users.
  $limit = 20;
  $result = db_query_range("SELECT u.uid, u.name, u.mail FROM {users} u WHERE uid > %d ORDER BY uid ASC", $context['sandbox']['current_user'], 0, $limit);
  while ($row = db_fetch_object($result)) {
    $realname->uid = $row->uid;
    $realname->realname = _realname_make_name($row);

    // Try to update, if fail - try to insert.
    if (db_result(db_query('SELECT COUNT(uid) FROM {realname} WHERE uid=%d', $realname->uid))) {
      drupal_write_record('realname', $realname, 'uid');
    }
    else {
      drupal_write_record('realname', $realname);
    }
    $context['sandbox']['progress']++;
    $context['sandbox']['current_user'] = $row->uid;
  }

  // Multistep processing : report progress.
  if ($context['sandbox']['progress'] != $context['sandbox']['max'] - 1) {
    $context['finished'] = $context['sandbox']['progress'] / $context['sandbox']['max'];
  }
}
function _realname_rebuild_batch_finished($success, $results, $operations) {
  if ($success) {
    drupal_set_message(t('The realnames have been rebuilt.'));
    variable_set('realname_recalculate', FALSE);
    drupal_goto('admin/user/realname');
  }
  else {
    drupal_set_message(t('The realnames have not been properly rebuilt.'), 'error');
  }
}

Functions

Name	Description
realname_admin_bypass
realname_admin_bypass_submit
realname_admin_fields
realname_admin_fields_submit	Form submit handler.
realname_admin_general
realname_admin_general_submit
realname_admin_general_validate
realname_admin_module
realname_admin_module_submit
realname_admin_settings	Displays the admin settings form. @TODO: move this admin stuff to separate file.
realname_rebuild_confirm	Menu callback: confirm rebuilding of realnames.
realname_rebuild_confirm_submit	Handler for rebuild confirmation
_realname_rebuild_batch_finished
_realname_rebuild_realnames	Batchable function used to rebuild realnames