danielebarchiesi@4: <?php
danielebarchiesi@4: 
danielebarchiesi@4: /**
danielebarchiesi@4:  * @file
danielebarchiesi@4:  * Defines a field type for referencing a user from a node.
danielebarchiesi@4:  */
danielebarchiesi@4: 
danielebarchiesi@4: /**
danielebarchiesi@4:  * Implements hook_menu().
danielebarchiesi@4:  */
danielebarchiesi@4: function user_reference_menu() {
danielebarchiesi@4:   $items['user_reference/autocomplete/%/%/%'] = array(
danielebarchiesi@4:     'page callback' => 'user_reference_autocomplete',
danielebarchiesi@4:     'page arguments' => array(2, 3, 4),
danielebarchiesi@4:     'access callback' => 'reference_autocomplete_access',
danielebarchiesi@4:     'access arguments' => array(2, 3, 4),
danielebarchiesi@4:     'type' => MENU_CALLBACK,
danielebarchiesi@4:   );
danielebarchiesi@4:   return $items;
danielebarchiesi@4: }
danielebarchiesi@4: 
danielebarchiesi@4: /**
danielebarchiesi@4:  * Implements hook_field_info().
danielebarchiesi@4:  */
danielebarchiesi@4: function user_reference_field_info() {
danielebarchiesi@4:   return array(
danielebarchiesi@4:     'user_reference' => array(
danielebarchiesi@4:       'label' => t('User reference'),
danielebarchiesi@4:       'description' => t('This field stores the ID of a related user as an integer value.'),
danielebarchiesi@4:       'settings' => array(
danielebarchiesi@4:         'referenceable_roles' => array(),
danielebarchiesi@4:         'referenceable_status' => array(),
danielebarchiesi@4:         'view' => array(
danielebarchiesi@4:           'view_name' => '',
danielebarchiesi@4:           'display_name' => '',
danielebarchiesi@4:           'args' => array(),
danielebarchiesi@4:         ),
danielebarchiesi@4:       ),
danielebarchiesi@4:       'default_widget' => 'user_reference_autocomplete',
danielebarchiesi@4:       'default_formatter' => 'user_reference_default',
danielebarchiesi@4:       // Support hook_entity_property_info() from contrib "Entity API".
danielebarchiesi@4:       'property_type' => 'user',
danielebarchiesi@4:       // Support default token formatter for field tokens.
danielebarchiesi@4:       'default_token_formatter' => 'user_reference_plain',
danielebarchiesi@4:     ),
danielebarchiesi@4:   );
danielebarchiesi@4: }
danielebarchiesi@4: 
danielebarchiesi@4: /**
danielebarchiesi@4:  * Implements hook_field_settings_form().
danielebarchiesi@4:  */
danielebarchiesi@4: function user_reference_field_settings_form($field, $instance, $has_data) {
danielebarchiesi@4:   $settings = $field['settings'];
danielebarchiesi@4: 
danielebarchiesi@4:   $form = array();
danielebarchiesi@4:   $form['referenceable_roles'] = array(
danielebarchiesi@4:     '#type' => 'checkboxes',
danielebarchiesi@4:     '#title' => t('User roles that can be referenced'),
danielebarchiesi@4:     '#default_value' => is_array($settings['referenceable_roles'])
danielebarchiesi@4:        ? array_filter($settings['referenceable_roles'])
danielebarchiesi@4:        : array(),
danielebarchiesi@4:     '#options' => user_roles(TRUE),
danielebarchiesi@4:   );
danielebarchiesi@4:   $form['referenceable_status'] = array(
danielebarchiesi@4:     '#type' => 'checkboxes',
danielebarchiesi@4:     '#title' => t('User status that can be referenced'),
danielebarchiesi@4:     '#default_value' => is_array($settings['referenceable_status'])
danielebarchiesi@4:       ? array_filter($settings['referenceable_status'])
danielebarchiesi@4:       : array(1),
danielebarchiesi@4:     '#options' => array(1 => t('Active'), 0 => t('Blocked')),
danielebarchiesi@4:   );
danielebarchiesi@4: 
danielebarchiesi@4:   if (module_exists('views')) {
danielebarchiesi@4:     $view_settings = $settings['view'];
danielebarchiesi@4: 
danielebarchiesi@4:     $description = '<p>' . t('The list of users that can be referenced can provided by a view (Views module) using the "References" display type.') . '</p>';
danielebarchiesi@4: 
danielebarchiesi@4:     // Special note for legacy fields migrated from D6.
danielebarchiesi@4:     if (!empty($view_settings['view_name']) && $view_settings['display_name'] == 'default') {
danielebarchiesi@4:       $description .= '<p><strong><span class="admin-missing">'. t("Important D6 migration note:") . '</span></strong>';
danielebarchiesi@4:       $description .= '<br/>' . t("The field is currently configured to use the 'Master' display of the view %view_name.", array('%view_name' => $view_settings['view_name']));
danielebarchiesi@4:       $description .= '<br/>' . t("It is highly recommended that you: <br/>- edit this view and create a new display using the 'References' display type, <br/>- update the field settings to explicitly select the correct view and display.");
danielebarchiesi@4:       $description .= '<br/>' . t("The field will work correctly until then, but submitting this form might inadvertently change the field settings.") . '</p>';
danielebarchiesi@4:     }
danielebarchiesi@4: 
danielebarchiesi@4:     $form['view'] = array(
danielebarchiesi@4:       '#type' => 'fieldset',
danielebarchiesi@4:       '#title' => t('Views - Users that can be referenced'),
danielebarchiesi@4:       '#collapsible' => TRUE,
danielebarchiesi@4:       '#collapsed' => empty($view_settings['view_name']),
danielebarchiesi@4:       '#description' => $description,
danielebarchiesi@4:     );
danielebarchiesi@4: 
danielebarchiesi@4:     $views_options = references_get_views_options('user');
danielebarchiesi@4:     if ($views_options) {
danielebarchiesi@4:       // The value of the 'view_and_display' select below will need to be split
danielebarchiesi@4:       // into 'view_name' and 'view_display' in the final submitted values, so
danielebarchiesi@4:       // we massage the data at validate time on the wrapping element (not
danielebarchiesi@4:       // ideal).
danielebarchiesi@4:       $form['view']['#element_validate'] = array('_user_reference_view_settings_validate');
danielebarchiesi@4: 
danielebarchiesi@4:       $views_options = array('' => '<' . t('none') . '>') + $views_options;
danielebarchiesi@4:       $default = empty($view_settings['view_name']) ? '' : $view_settings['view_name'] . ':' .$view_settings['display_name'];
danielebarchiesi@4:       $form['view']['view_and_display'] = array(
danielebarchiesi@4:         '#type' => 'select',
danielebarchiesi@4:         '#title' => t('View used to select the users'),
danielebarchiesi@4:         '#options' => $views_options,
danielebarchiesi@4:         '#default_value' => $default,
danielebarchiesi@4:         '#description' => '<p>' . t('Choose the view and display that select the nodes that can be referenced.<br />Only views with a display of type "References" are eligible.') . '</p>' .
danielebarchiesi@4:           t('Note:<ul><li>This will discard the "Referenceable Roles" and "Referenceable Status" settings above. Use the view\'s "filters" section instead.</li><li>Use the view\'s "fields" section to display additional informations about candidate users on user creation/edition form.</li><li>Use the view\'s "sort criteria" section to determine the order in which candidate users will be displayed.</li></ul>'),
danielebarchiesi@4:       );
danielebarchiesi@4: 
danielebarchiesi@4:       $default = implode(', ', $view_settings['args']);
danielebarchiesi@4:       $form['view']['args'] = array(
danielebarchiesi@4:         '#type' => 'textfield',
danielebarchiesi@4:         '#title' => t('View arguments'),
danielebarchiesi@4:         '#default_value' => $default,
danielebarchiesi@4:         '#required' => FALSE,
danielebarchiesi@4:         '#description' => t('Provide a comma separated list of arguments to pass to the view.'),
danielebarchiesi@4:       );
danielebarchiesi@4:     }
danielebarchiesi@4:     else {
danielebarchiesi@4:       $form['view']['no_view_help'] = array(
danielebarchiesi@4:         '#markup' => '<p>' . t('No eligible view was found.') .'</p>',
danielebarchiesi@4:       );
danielebarchiesi@4:     }
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   return $form;
danielebarchiesi@4: }
danielebarchiesi@4: 
danielebarchiesi@4: /**
danielebarchiesi@4:  * Validate callback for the 'view settings' fieldset.
danielebarchiesi@4:  *
danielebarchiesi@4:  * Puts back the various form values in the expected shape.
danielebarchiesi@4:  */
danielebarchiesi@4: function _user_reference_view_settings_validate($element, &$form_state, $form) {
danielebarchiesi@4:   // Split view name and display name from the 'view_and_display' value.
danielebarchiesi@4:   if (!empty($element['view_and_display']['#value'])) {
danielebarchiesi@4:     list($view, $display) = explode(':', $element['view_and_display']['#value']);
danielebarchiesi@4:   }
danielebarchiesi@4:   else {
danielebarchiesi@4:     $view = '';
danielebarchiesi@4:     $display = '';
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   // Explode the 'args' string into an actual array. Beware, explode() turns an
danielebarchiesi@4:   // empty string into an array with one empty string. We'll need an empty array
danielebarchiesi@4:   // instead.
danielebarchiesi@4:   $args_string = trim($element['args']['#value']);
danielebarchiesi@4:   $args = ($args_string === '') ? array() : array_map('trim', explode(',', $args_string));
danielebarchiesi@4: 
danielebarchiesi@4:   $value = array('view_name' => $view, 'display_name' => $display, 'args' => $args);
danielebarchiesi@4:   form_set_value($element, $value, $form_state);
danielebarchiesi@4: }
danielebarchiesi@4: 
danielebarchiesi@4: /**
danielebarchiesi@4:  * Implements hook_field_validate().
danielebarchiesi@4:  *
danielebarchiesi@4:  * Possible error codes:
danielebarchiesi@4:  * - 'invalid_uid': uid is not valid for the field (not a valid user id, or the user is not referenceable).
danielebarchiesi@4:  */
danielebarchiesi@4: function user_reference_field_validate($entity_type, $entity, $field, $instance, $langcode, $items, &$errors) {
danielebarchiesi@4:   // Extract uids to check.
danielebarchiesi@4:   $ids = array();
danielebarchiesi@4: 
danielebarchiesi@4:   // First check non-numeric uid's to avoid losing time with them.
danielebarchiesi@4:   foreach ($items as $delta => $item) {
danielebarchiesi@4:     if (is_array($item) && !empty($item['uid'])) {
danielebarchiesi@4:       if (is_numeric($item['uid'])) {
danielebarchiesi@4:         $ids[] = $item['uid'];
danielebarchiesi@4:       }
danielebarchiesi@4:       else {
danielebarchiesi@4:         $errors[$field['field_name']][$langcode][$delta][] = array(
danielebarchiesi@4:           'error' => 'invalid_uid',
danielebarchiesi@4:           'message' => t('%name: invalid input.',
danielebarchiesi@4:             array('%name' => $instance['label'])),
danielebarchiesi@4:         );
danielebarchiesi@4:       }
danielebarchiesi@4:     }
danielebarchiesi@4:   }
danielebarchiesi@4:   // Prevent performance hog if there are no ids to check.
danielebarchiesi@4:   if ($ids) {
danielebarchiesi@4:     $options = array(
danielebarchiesi@4:       'ids' => $ids,
danielebarchiesi@4:     );
danielebarchiesi@4:     $refs = user_reference_potential_references($field, $options);
danielebarchiesi@4:     foreach ($items as $delta => $item) {
danielebarchiesi@4:       if (is_array($item)) {
danielebarchiesi@4:         if (!empty($item['uid']) && !isset($refs[$item['uid']])) {
danielebarchiesi@4:           $errors[$field['field_name']][$langcode][$delta][] = array(
danielebarchiesi@4:             'error' => 'invalid_uid',
danielebarchiesi@4:             'message' => t("%name: this user can't be referenced.",
danielebarchiesi@4:               array('%name' => $instance['label'])),
danielebarchiesi@4:           );
danielebarchiesi@4:         }
danielebarchiesi@4:       }
danielebarchiesi@4:     }
danielebarchiesi@4:   }
danielebarchiesi@4: }
danielebarchiesi@4: 
danielebarchiesi@4: /**
danielebarchiesi@4:  * Implements hook_field_prepare_view().
danielebarchiesi@4:  */
danielebarchiesi@4: function user_reference_field_prepare_view($entity_type, $entities, $field, $instances, $langcode, &$items) {
danielebarchiesi@4:   $checked_ids = &drupal_static(__FUNCTION__, array());
danielebarchiesi@4: 
danielebarchiesi@4:   // Set an 'access' property on each item (TRUE if the user exists).
danielebarchiesi@4: 
danielebarchiesi@4:   // Extract ids to check.
danielebarchiesi@4:   $ids = array();
danielebarchiesi@4:   foreach ($items as $id => $entity_items) {
danielebarchiesi@4:     foreach ($entity_items as $delta => $item) {
danielebarchiesi@4:       if (is_array($item)) {
danielebarchiesi@4:         // Default to 'not accessible'.
danielebarchiesi@4:         $items[$id][$delta]['access'] = FALSE;
danielebarchiesi@4:         if (!empty($item['uid']) && is_numeric($item['uid'])) {
danielebarchiesi@4:           $ids[$item['uid']] = $item['uid'];
danielebarchiesi@4:         }
danielebarchiesi@4:       }
danielebarchiesi@4:     }
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   if ($ids) {
danielebarchiesi@4:     // Load information about ids that we haven't already loaded during this
danielebarchiesi@4:     // page request.
danielebarchiesi@4:     $ids_to_check = array_diff($ids, array_keys($checked_ids));
danielebarchiesi@4:     if (!empty($ids_to_check)) {
danielebarchiesi@4:       $query = db_select('users', 'u')
danielebarchiesi@4:         ->addMetaData('id', 'user_reference_field_prepare_view')
danielebarchiesi@4:         ->addMetaData('field', $field)
danielebarchiesi@4:         ->fields('u', array('uid'))
danielebarchiesi@4:         ->condition('u.uid', $ids_to_check, 'IN');
danielebarchiesi@4:       $accessible_ids = $query->execute()->fetchAllAssoc('uid');
danielebarchiesi@4: 
danielebarchiesi@4:       // Populate our static list so that we do not query on those ids again.
danielebarchiesi@4:       foreach ($ids_to_check as $id) {
danielebarchiesi@4:         $checked_ids[$id] = isset($accessible_ids[$id]);
danielebarchiesi@4:       }
danielebarchiesi@4:     }
danielebarchiesi@4: 
danielebarchiesi@4:     foreach ($items as $id => $entity_items) {
danielebarchiesi@4:       foreach ($entity_items as $delta => $item) {
danielebarchiesi@4:         if (is_array($item) && !empty($item['uid']) && !empty($checked_ids[$item['uid']])) {
danielebarchiesi@4:           $items[$id][$delta]['access'] = TRUE;
danielebarchiesi@4:         }
danielebarchiesi@4:       }
danielebarchiesi@4:     }
danielebarchiesi@4:   }
danielebarchiesi@4: }
danielebarchiesi@4: 
danielebarchiesi@4: /**
danielebarchiesi@4:  * Implements hook_field_is_empty().
danielebarchiesi@4:  */
danielebarchiesi@4: function user_reference_field_is_empty($item, $field) {
danielebarchiesi@4:   return empty($item['uid']);
danielebarchiesi@4: }
danielebarchiesi@4: 
danielebarchiesi@4: /**
danielebarchiesi@4:  * Implements hook_field_formatter_info().
danielebarchiesi@4:  */
danielebarchiesi@4: function user_reference_field_formatter_info() {
danielebarchiesi@4:   return array(
danielebarchiesi@4:     'user_reference_default' => array(
danielebarchiesi@4:       'label' => t('Default'),
danielebarchiesi@4:       'description' => t("Display the name of the referenced user as a link to the user's profile page."),
danielebarchiesi@4:       'field types' => array('user_reference'),
danielebarchiesi@4:     ),
danielebarchiesi@4:     'user_reference_plain' => array(
danielebarchiesi@4:       'label' => t('Plain text'),
danielebarchiesi@4:       'description' => t('Display the name of the referenced user as plain text.'),
danielebarchiesi@4:       'field types' => array('user_reference'),
danielebarchiesi@4:     ),
danielebarchiesi@4:     'user_reference_user' => array(
danielebarchiesi@4:       'label'       => t('Rendered user'),
danielebarchiesi@4:       'description' => t('Display the referenced user in a specific view mode'),
danielebarchiesi@4:       'field types' => array('user_reference'),
danielebarchiesi@4:       'settings'    => array('user_reference_view_mode' => 'full'),
danielebarchiesi@4:     ),
danielebarchiesi@4:     'user_reference_uid' => array(
danielebarchiesi@4:       'label' => t('User ID'),
danielebarchiesi@4:       'description' => t('Display the referenced user ID'),
danielebarchiesi@4:       'field types' => array('user_reference'),
danielebarchiesi@4:     ),
danielebarchiesi@4:     'user_reference_path' => array(
danielebarchiesi@4:       'label' => t('URL as plain text'),
danielebarchiesi@4:       'description' => t('Display the URL of the referenced user'),
danielebarchiesi@4:       'field types' => array('user_reference'),
danielebarchiesi@4:       'settings' => array(
danielebarchiesi@4:         'alias' => TRUE,
danielebarchiesi@4:         'absolute' => FALSE
danielebarchiesi@4:       ),
danielebarchiesi@4:     ),
danielebarchiesi@4:   );
danielebarchiesi@4: }
danielebarchiesi@4: 
danielebarchiesi@4: /**
danielebarchiesi@4:  * Implements hook_field_formatter_settings_form().
danielebarchiesi@4:  */
danielebarchiesi@4: function user_reference_field_formatter_settings_form($field, $instance, $view_mode, $form, &$form_state) {
danielebarchiesi@4:   $display = $instance['display'][$view_mode];
danielebarchiesi@4:   $settings = $display['settings'];
danielebarchiesi@4: 
danielebarchiesi@4:   $element = array();
danielebarchiesi@4: 
danielebarchiesi@4:   switch ($display['type']) {
danielebarchiesi@4:     case 'user_reference_user':
danielebarchiesi@4:       $entity_info = entity_get_info('user');
danielebarchiesi@4:       $modes = $entity_info['view modes'];
danielebarchiesi@4:       $options = array();
danielebarchiesi@4:       foreach ($modes as $name => $mode) {
danielebarchiesi@4:         $options[$name] = $mode['label'];
danielebarchiesi@4:       }
danielebarchiesi@4:       $element['user_reference_view_mode'] = array(
danielebarchiesi@4:         '#title'   => t('View mode'),
danielebarchiesi@4:         '#type'    => 'select',
danielebarchiesi@4:         '#options' => $options,
danielebarchiesi@4:         '#default_value' => $settings['user_reference_view_mode'],
danielebarchiesi@4:         // Never empty, so no #empty_option
danielebarchiesi@4:       );
danielebarchiesi@4:       break;
danielebarchiesi@4: 
danielebarchiesi@4:     case 'user_reference_path':
danielebarchiesi@4:       $element['alias'] = array(
danielebarchiesi@4:         '#type' => 'checkbox',
danielebarchiesi@4:         '#title' => t('Display the aliased path (if exists) instead of the system path'),
danielebarchiesi@4:         '#default_value' => $settings['alias'],
danielebarchiesi@4:       );
danielebarchiesi@4:       $element['absolute'] = array(
danielebarchiesi@4:         '#type' => 'checkbox',
danielebarchiesi@4:         '#title' => t('Display an absolute URL'),
danielebarchiesi@4:         '#default_value' => $settings['absolute'],
danielebarchiesi@4:       );
danielebarchiesi@4:       break;
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   return $element;
danielebarchiesi@4: }
danielebarchiesi@4: 
danielebarchiesi@4: /**
danielebarchiesi@4:  * Implements hook_field_formatter_settings_summary().
danielebarchiesi@4:  */
danielebarchiesi@4: function user_reference_field_formatter_settings_summary($field, $instance, $view_mode) {
danielebarchiesi@4:   $display = $instance['display'][$view_mode];
danielebarchiesi@4:   $settings = $display['settings'];
danielebarchiesi@4:   $summary = array();
danielebarchiesi@4: 
danielebarchiesi@4:   switch ($display['type']) {
danielebarchiesi@4:     case 'user_reference_user':
danielebarchiesi@4:       $entity_info = entity_get_info('user');
danielebarchiesi@4:       $modes = $entity_info['view modes'];
danielebarchiesi@4:       $mode = $modes[$settings['user_reference_view_mode']]['label'];
danielebarchiesi@4:       $summary[] = t('View mode: %mode', array('%mode' => $mode));
danielebarchiesi@4:       break;
danielebarchiesi@4: 
danielebarchiesi@4:     case 'user_reference_path':
danielebarchiesi@4:       $summary[] = t('Aliased path: %yes_no', array('%yes_no' => $settings['alias'] ? t('Yes') : t('No')));
danielebarchiesi@4:       $summary[] = t('Absolute URL: %yes_no', array('%yes_no' => $settings['absolute'] ? t('Yes') : t('No')));
danielebarchiesi@4:       break;
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   return implode('<br />', $summary);
danielebarchiesi@4: }
danielebarchiesi@4: 
danielebarchiesi@4: 
danielebarchiesi@4: /**
danielebarchiesi@4:  * Implements hook_field_formatter_prepare_view().
danielebarchiesi@4:  *
danielebarchiesi@4:  * Preload all user referenced by items using 'full entity' formatters.
danielebarchiesi@4:  */
danielebarchiesi@4: function user_reference_field_formatter_prepare_view($entity_type, $entities, $field, $instances, $langcode, &$items, $displays) {
danielebarchiesi@4:   // Load the referenced users, except for the 'user_reference_uid' which does
danielebarchiesi@4:   // not need full objects.
danielebarchiesi@4: 
danielebarchiesi@4:   // Collect ids to load.
danielebarchiesi@4:   $ids = array();
danielebarchiesi@4:   foreach ($displays as $id => $display) {
danielebarchiesi@4:     if ($display['type'] != 'user_reference_uid') {
danielebarchiesi@4:       foreach ($items[$id] as $delta => $item) {
danielebarchiesi@4:         if ($item['access']) {
danielebarchiesi@4:           $ids[$item['uid']] = $item['uid'];
danielebarchiesi@4:         }
danielebarchiesi@4:       }
danielebarchiesi@4:     }
danielebarchiesi@4:   }
danielebarchiesi@4:   $entities = user_load_multiple($ids);
danielebarchiesi@4: 
danielebarchiesi@4:   // Add the loaded user objects to the items.
danielebarchiesi@4:   foreach ($displays as $id => $display) {
danielebarchiesi@4:     if ($display['type'] != 'user_reference_uid') {
danielebarchiesi@4:       foreach ($items[$id] as $delta => $item) {
danielebarchiesi@4:         if ($item['access']) {
danielebarchiesi@4:           $items[$id][$delta]['user'] = $entities[$item['uid']];
danielebarchiesi@4:         }
danielebarchiesi@4:       }
danielebarchiesi@4:     }
danielebarchiesi@4:   }
danielebarchiesi@4: }
danielebarchiesi@4: 
danielebarchiesi@4: /**
danielebarchiesi@4:  * Implements hook_field_formatter_view().
danielebarchiesi@4:  */
danielebarchiesi@4: function user_reference_field_formatter_view($entity_type, $entity, $field, $instance, $langcode, $items, $display) {
danielebarchiesi@4:   $settings = $display['settings'];
danielebarchiesi@4:   $result = array();
danielebarchiesi@4: 
danielebarchiesi@4:   // @todo Optimisation: use hook_field_formatter_prepare_view() to load
danielebarchiesi@4:   // user names or full user entities in 'multiple' mode.
danielebarchiesi@4: 
danielebarchiesi@4:   // Collect the list of user ids.
danielebarchiesi@4:   $uids = array();
danielebarchiesi@4:   foreach ($items as $delta => $item) {
danielebarchiesi@4:     $uids[$item['uid']] = $item['uid'];
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   switch ($display['type']) {
danielebarchiesi@4:     case 'user_reference_default':
danielebarchiesi@4:     case 'user_reference_plain':
danielebarchiesi@4:       foreach ($items as $delta => $item) {
danielebarchiesi@4:         if ($item['access']) {
danielebarchiesi@4:           $user = $item['user'];
danielebarchiesi@4:           $label = entity_label('user', $user);
danielebarchiesi@4:           if ($display['type'] == 'user_reference_default') {
danielebarchiesi@4:             $uri = entity_uri('user', $user);
danielebarchiesi@4:             $result[$delta] = array(
danielebarchiesi@4:               '#type' => 'link',
danielebarchiesi@4:               '#title' => $label,
danielebarchiesi@4:               '#href' => $uri['path'],
danielebarchiesi@4:               '#options' => $uri['options'],
danielebarchiesi@4:             );
danielebarchiesi@4:           }
danielebarchiesi@4:           else {
danielebarchiesi@4:             $result[$delta] = array(
danielebarchiesi@4:               '#markup' => check_plain($label),
danielebarchiesi@4:             );
danielebarchiesi@4:           }
danielebarchiesi@4:         }
danielebarchiesi@4:       }
danielebarchiesi@4:       break;
danielebarchiesi@4: 
danielebarchiesi@4:     case 'user_reference_user':
danielebarchiesi@4:       $view_mode = $display['settings']['user_reference_view_mode'];
danielebarchiesi@4:       // To prevent infinite recursion caused by reference cycles, we store
danielebarchiesi@4:       // diplayed accounts in a recursion queue.
danielebarchiesi@4:       $recursion_queue = &drupal_static(__FUNCTION__, array());
danielebarchiesi@4: 
danielebarchiesi@4:       // If no 'referencing entity' is set, we are starting a new 'reference
danielebarchiesi@4:       // thread' and need to reset the queue.
danielebarchiesi@4:       // @todo Bug: $entity->referencing_entity on accounts referenced in a different
danielebarchiesi@4:       // thread on the page. E.g: 1 references 1+2 / 2 references 1+2 / visit homepage.
danielebarchiesi@4:       // We'd need a more accurate way...
danielebarchiesi@4:       if (!isset($entity->referencing_entity)) {
danielebarchiesi@4:         $recursion_queue = array();
danielebarchiesi@4:       }
danielebarchiesi@4: 
danielebarchiesi@4:       // The recursion queue only needs to track nodes.
danielebarchiesi@4:       if ($entity_type == 'user') {
danielebarchiesi@4:         list($id) = entity_extract_ids($entity_type, $entity);
danielebarchiesi@4:         $recursion_queue[$id] = $id;
danielebarchiesi@4:       }
danielebarchiesi@4: 
danielebarchiesi@4:       // Check the recursion queue to determine which accounts should be fully
danielebarchiesi@4:       // displayed, and which accounts will only be displayed as a username.
danielebarchiesi@4:       $users_display = array();
danielebarchiesi@4:       foreach ($items as $delta => $item) {
danielebarchiesi@4:         if ($item['access'] && !isset($recursion_queue[$item['uid']])) {
danielebarchiesi@4:           $users_display[$item['uid']] = $item['user'];
danielebarchiesi@4:         }
danielebarchiesi@4:       }
danielebarchiesi@4: 
danielebarchiesi@4:       // Load and build the fully displayed nodes.
danielebarchiesi@4:       if ($users_display) {
danielebarchiesi@4:         $users_built = array('users' => array('#sorted' => TRUE));
danielebarchiesi@4:         foreach ($users_display as $uid => $account) {
danielebarchiesi@4:           $users_display[$uid]->referencing_entity = $entity;
danielebarchiesi@4:           $users_display[$uid]->referencing_field = $field['field_name'];
danielebarchiesi@4:           $users_built['users'][$account->uid] = user_view($account, $settings['user_reference_view_mode']);
danielebarchiesi@4:         }
danielebarchiesi@4:       }
danielebarchiesi@4: 
danielebarchiesi@4:       // Assemble the render array.
danielebarchiesi@4:       foreach ($items as $delta => $item) {
danielebarchiesi@4:         if ($item['access']) {
danielebarchiesi@4:           if (isset($users_display[$item['uid']])) {
danielebarchiesi@4:             $result[$delta] = $users_built['users'][$item['uid']];
danielebarchiesi@4:           }
danielebarchiesi@4:           else {
danielebarchiesi@4:             $account = $item['user'];
danielebarchiesi@4:             $label = entity_label('user', $user);
danielebarchiesi@4:             $uri = entity_uri('user', $account);
danielebarchiesi@4:             $result[$delta] = array(
danielebarchiesi@4:               '#type' => 'link',
danielebarchiesi@4:               '#title' => $label,
danielebarchiesi@4:               '#href' => $uri['path'],
danielebarchiesi@4:               '#options' => $uri['options'],
danielebarchiesi@4:             );
danielebarchiesi@4:             if (!$account->status) {
danielebarchiesi@4:               $result[$delta]['#prefix'] = '<span class="user-unpublished">';
danielebarchiesi@4:               $result[$delta]['#suffix'] = '</span>';
danielebarchiesi@4:             }
danielebarchiesi@4:           }
danielebarchiesi@4:         }
danielebarchiesi@4:       }
danielebarchiesi@4:       break;
danielebarchiesi@4: 
danielebarchiesi@4:     case 'user_reference_uid':
danielebarchiesi@4:       foreach ($items as $delta => $item) {
danielebarchiesi@4:         if ($item['access']) {
danielebarchiesi@4:           $result[$delta] = array(
danielebarchiesi@4:             '#markup' => $item['uid'],
danielebarchiesi@4:           );
danielebarchiesi@4:         }
danielebarchiesi@4:       }
danielebarchiesi@4:       break;
danielebarchiesi@4: 
danielebarchiesi@4:     case 'user_reference_path':
danielebarchiesi@4:       foreach ($items as $delta => $item) {
danielebarchiesi@4:         if ($item['access']) {
danielebarchiesi@4:           $uri = entity_uri('user', $item['user']);
danielebarchiesi@4:           $options = array(
danielebarchiesi@4:             'absolute' => $settings['absolute'],
danielebarchiesi@4:             'alias' => !$settings['alias'],
danielebarchiesi@4:           );
danielebarchiesi@4: 
danielebarchiesi@4:           $options += $uri['options'];
danielebarchiesi@4:           $result[$delta] = array(
danielebarchiesi@4:             '#markup' => url($uri['path'], $options),
danielebarchiesi@4:           );
danielebarchiesi@4:         }
danielebarchiesi@4:       }
danielebarchiesi@4:       break;
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   return $result;
danielebarchiesi@4: }
danielebarchiesi@4: 
danielebarchiesi@4: /**
danielebarchiesi@4:  * Helper function for widgets and formatters.
danielebarchiesi@4:  *
danielebarchiesi@4:  * Store user names collected in the curent request.
danielebarchiesi@4:  */
danielebarchiesi@4: function _user_reference_get_user_names($uids, $known_titles = array()) {
danielebarchiesi@4:   $titles = &drupal_static(__FUNCTION__, array());
danielebarchiesi@4: 
danielebarchiesi@4:   // Save titles we receive.
danielebarchiesi@4:   $titles += $known_titles;
danielebarchiesi@4: 
danielebarchiesi@4:   // Collect nids to retrieve from database.
danielebarchiesi@4:   $uids_query = array();
danielebarchiesi@4:   foreach ($uids as $uid) {
danielebarchiesi@4:     if (!isset($titles[$uid])) {
danielebarchiesi@4:       $uids_query[] = $uid;
danielebarchiesi@4:     }
danielebarchiesi@4:   }
danielebarchiesi@4:   if ($uids_query) {
danielebarchiesi@4:     $query = db_select('users', 'u')
danielebarchiesi@4:       ->fields('u', array('uid', 'name'))
danielebarchiesi@4:       ->condition('u.uid', $uids);
danielebarchiesi@4:     $titles += $query->execute()->fetchAllKeyed();
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   // Build the results array.
danielebarchiesi@4:   $return = array();
danielebarchiesi@4:   foreach ($uids as $uid) {
danielebarchiesi@4:     $return[$uid] = isset($titles[$uid]) ? $titles[$uid] : '';
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   return $return;
danielebarchiesi@4: }
danielebarchiesi@4: 
danielebarchiesi@4: /**
danielebarchiesi@4:  * Implements hook_field_widget_info().
danielebarchiesi@4:  */
danielebarchiesi@4: function user_reference_field_widget_info() {
danielebarchiesi@4:   return array(
danielebarchiesi@4:     'user_reference_autocomplete' => array(
danielebarchiesi@4:       'label' => t('Autocomplete text field'),
danielebarchiesi@4:       'description' => t('Display the list of referenceable users as a textfield with autocomplete behaviour.'),
danielebarchiesi@4:       'field types' => array('user_reference'),
danielebarchiesi@4:       'settings' => array(
danielebarchiesi@4:         'autocomplete_match' => 'contains',
danielebarchiesi@4:         'size' => 60,
danielebarchiesi@4:         'autocomplete_path' => 'user_reference/autocomplete',
danielebarchiesi@4:       ),
danielebarchiesi@4:     ),
danielebarchiesi@4:   );
danielebarchiesi@4: }
danielebarchiesi@4: 
danielebarchiesi@4: /**
danielebarchiesi@4:  * Implements hook_field_widget_info_alter().
danielebarchiesi@4:  */
danielebarchiesi@4: function user_reference_field_widget_info_alter(&$info) {
danielebarchiesi@4:   $info['options_select']['field types'][] = 'user_reference';
danielebarchiesi@4:   $info['options_buttons']['field types'][] = 'user_reference';
danielebarchiesi@4: }
danielebarchiesi@4: 
danielebarchiesi@4: /**
danielebarchiesi@4:  * Implements hook_field_widget_settings_form().
danielebarchiesi@4:  */
danielebarchiesi@4: function user_reference_field_widget_settings_form($field, $instance) {
danielebarchiesi@4:   $widget   = $instance['widget'];
danielebarchiesi@4:   $defaults = field_info_widget_settings($widget['type']);
danielebarchiesi@4:   $settings = array_merge($defaults, $widget['settings']);
danielebarchiesi@4: 
danielebarchiesi@4:   $form = array();
danielebarchiesi@4:   if ($widget['type'] == 'user_reference_autocomplete') {
danielebarchiesi@4:     $form['autocomplete_match'] = array(
danielebarchiesi@4:       '#type'             => 'select',
danielebarchiesi@4:       '#title'            => t('Autocomplete matching'),
danielebarchiesi@4:       '#default_value'    => $settings['autocomplete_match'],
danielebarchiesi@4:       '#options'          => array(
danielebarchiesi@4:         'starts_with'     => t('Starts with'),
danielebarchiesi@4:         'contains'        => t('Contains'),
danielebarchiesi@4:       ),
danielebarchiesi@4:       '#description'      => t('Select the method used to collect autocomplete suggestions. Note that <em>Contains</em> can cause performance issues on sites with thousands of users.'),
danielebarchiesi@4:     );
danielebarchiesi@4:     $form['size'] = array(
danielebarchiesi@4:       '#type'             => 'textfield',
danielebarchiesi@4:       '#title'            => t('Size of textfield'),
danielebarchiesi@4:       '#default_value'    => $settings['size'],
danielebarchiesi@4:       '#element_validate' => array('_element_validate_integer_positive'),
danielebarchiesi@4:       '#required'         => TRUE,
danielebarchiesi@4:     );
danielebarchiesi@4:   }
danielebarchiesi@4:  return $form;
danielebarchiesi@4: }
danielebarchiesi@4: 
danielebarchiesi@4: /**
danielebarchiesi@4:  * Implements hook_field_widget_form().
danielebarchiesi@4:  */
danielebarchiesi@4: function user_reference_field_widget_form(&$form, &$form_state, $field, $instance, $langcode, $items, $delta, $element) {
danielebarchiesi@4:   switch ($instance['widget']['type']) {
danielebarchiesi@4:     case 'user_reference_autocomplete':
danielebarchiesi@4:       $element += array(
danielebarchiesi@4:         '#type' => 'textfield',
danielebarchiesi@4:         '#default_value' => isset($items[$delta]['uid']) ? $items[$delta]['uid'] : NULL,
danielebarchiesi@4:         '#autocomplete_path' => $instance['widget']['settings']['autocomplete_path'] . '/' . $instance['entity_type'] . '/' . $instance['bundle'] . '/' . $field['field_name'],
danielebarchiesi@4:         '#size' => $instance['widget']['settings']['size'],
danielebarchiesi@4:         '#element_validate' => array('user_reference_autocomplete_validate'),
danielebarchiesi@4:         '#value_callback' => 'user_reference_autocomplete_value',
danielebarchiesi@4:       );
danielebarchiesi@4:       break;
danielebarchiesi@4:   }
danielebarchiesi@4:   return array('uid' => $element);
danielebarchiesi@4: }
danielebarchiesi@4: 
danielebarchiesi@4: /**
danielebarchiesi@4:  * Value callback for a user_reference autocomplete element.
danielebarchiesi@4:  *
danielebarchiesi@4:  * Substitute in the user name for the uid.
danielebarchiesi@4:  */
danielebarchiesi@4: function user_reference_autocomplete_value($element, $input = FALSE, $form_state) {
danielebarchiesi@4:   if ($input === FALSE) {
danielebarchiesi@4:     // We're building the displayed 'default value': expand the raw uid into
danielebarchiesi@4:     // "user name [uid:n]".
danielebarchiesi@4:     $uid = $element['#default_value'];
danielebarchiesi@4:     if (!empty($uid)) {
danielebarchiesi@4:       $q = db_select('users', 'u');
danielebarchiesi@4:       $q->addField('u', 'name');
danielebarchiesi@4: 
danielebarchiesi@4:       $q->condition('u.uid', $uid)
danielebarchiesi@4:         ->range(0, 1);
danielebarchiesi@4:       $result = $q->execute();
danielebarchiesi@4:       // @todo If no result (user doesn't exist).
danielebarchiesi@4:       $value = $result->fetchField();
danielebarchiesi@4:       $value .= ' [uid:' . $uid . ']';
danielebarchiesi@4:       return $value;
danielebarchiesi@4:     }
danielebarchiesi@4:   }
danielebarchiesi@4: }
danielebarchiesi@4: 
danielebarchiesi@4: /**
danielebarchiesi@4:  * Validation callback for a user_reference autocomplete element.
danielebarchiesi@4:  */
danielebarchiesi@4: function user_reference_autocomplete_validate($element, &$form_state, $form) {
danielebarchiesi@4:   $field = field_widget_field($element, $form_state);
danielebarchiesi@4:   $instance = field_widget_instance($element, $form_state);
danielebarchiesi@4: 
danielebarchiesi@4:   $value = $element['#value'];
danielebarchiesi@4:   $uid = NULL;
danielebarchiesi@4: 
danielebarchiesi@4:   if (!empty($value)) {
danielebarchiesi@4:     // Check whether we have an explicit "[uid:n]" input.
danielebarchiesi@4:     preg_match('/^(?:\s*|(.*) )?\[\s*uid\s*:\s*(\d+)\s*\]$/', $value, $matches);
danielebarchiesi@4:     if (!empty($matches)) {
danielebarchiesi@4:       // Explicit uid. Check that the 'name' part matches the actual name for
danielebarchiesi@4:       // the uid.
danielebarchiesi@4:       list(, $name, $uid) = $matches;
danielebarchiesi@4:       if (!empty($name)) {
danielebarchiesi@4:         $names = _user_reference_get_user_names(array($uid));
danielebarchiesi@4:         if ($name != $names[$uid]) {
danielebarchiesi@4:           form_error($element, t('%name: name mismatch. Please check your selection.', array('%name' => $instance['label'])));
danielebarchiesi@4:         }
danielebarchiesi@4:       }
danielebarchiesi@4:     }
danielebarchiesi@4:     else {
danielebarchiesi@4:       // No explicit uid (the submitted value was not populated by autocomplete
danielebarchiesi@4:       // selection). Get the uid of a referencable user from the entered name.
danielebarchiesi@4:       $options = array(
danielebarchiesi@4:         'string' => $value,
danielebarchiesi@4:         'match' => 'equals',
danielebarchiesi@4:         'limit' => 1,
danielebarchiesi@4:       );
danielebarchiesi@4:       $references = user_reference_potential_references($field, $options);
danielebarchiesi@4:       if ($references) {
danielebarchiesi@4:         // @todo The best thing would be to present the user with an
danielebarchiesi@4:         // additional form, allowing the user to choose between valid
danielebarchiesi@4:         // candidates with the same name. ATM, we pick the first
danielebarchiesi@4:         // matching candidate...
danielebarchiesi@4:         $uid = key($references);
danielebarchiesi@4:       }
danielebarchiesi@4:       else {
danielebarchiesi@4:         form_error($element, t('%name: found no valid user with that name.', array('%name' => $instance['label'])));
danielebarchiesi@4:       }
danielebarchiesi@4:     }
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   // Set the element's value as the user id that was extracted from the entered
danielebarchiesi@4:   // input.
danielebarchiesi@4:   form_set_value($element, $uid, $form_state);
danielebarchiesi@4: }
danielebarchiesi@4: 
danielebarchiesi@4: /**
danielebarchiesi@4:  * Implements hook_field_widget_error().
danielebarchiesi@4:  */
danielebarchiesi@4: function user_reference_field_widget_error($element, $error, $form, &$form_state) {
danielebarchiesi@4:   form_error($element['uid'], $error['message']);
danielebarchiesi@4: }
danielebarchiesi@4: 
danielebarchiesi@4: /**
danielebarchiesi@4:  * Builds a list of referenceable users suitable for the '#option' FAPI property.
danielebarchiesi@4:  *
danielebarchiesi@4:  * Warning: the function does NOT take care of encoding or escaping the user
danielebarchiesi@4:  * names. Proper massaging needs to be performed by the caller, according to
danielebarchiesi@4:  * the destination FAPI '#type' (radios / checkboxes / select).
danielebarchiesi@4:  *
danielebarchiesi@4:  * @param $field
danielebarchiesi@4:  *   The field definition.
danielebarchiesi@4:  *
danielebarchiesi@4:  * @return
danielebarchiesi@4:  *   An array of referenceable user names, keyed by user id.
danielebarchiesi@4:  */
danielebarchiesi@4: function _user_reference_options($field, $flat = TRUE) {
danielebarchiesi@4:   $references = user_reference_potential_references($field);
danielebarchiesi@4: 
danielebarchiesi@4:   $options = array();
danielebarchiesi@4:   foreach ($references as $key => $value) {
danielebarchiesi@4:     // The label, displayed in selects and checkboxes/radios, should have HTML
danielebarchiesi@4:     // entities unencoded. The widgets (core's options.module) take care of
danielebarchiesi@4:     // applying the relevant filters (strip_tags() or filter_xss()).
danielebarchiesi@4:     $label = html_entity_decode($value['rendered'], ENT_QUOTES);
danielebarchiesi@4:     if (empty($value['group']) || $flat) {
danielebarchiesi@4:       $options[$key] = $label;
danielebarchiesi@4:     }
danielebarchiesi@4:     else {
danielebarchiesi@4:       // The group name, displayed in selects, cannot contain tags, and should
danielebarchiesi@4:       // have HTML entities unencoded.
danielebarchiesi@4:       $group = html_entity_decode(strip_tags($value['group']), ENT_QUOTES);
danielebarchiesi@4:       $options[$group][$key] = $label;
danielebarchiesi@4:     }
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   return $options;
danielebarchiesi@4: }
danielebarchiesi@4: 
danielebarchiesi@4: /**
danielebarchiesi@4:  * Retrieves an array of candidate referenceable users.
danielebarchiesi@4:  *
danielebarchiesi@4:  * This info is used in various places (aloowed values, autocomplete results,
danielebarchiesi@4:  * input validation...). Some of them only need the uids, others nid + names,
danielebarchiesi@4:  * others yet uid + names + rendered row (for display in widgets).
danielebarchiesi@4:  * The array we return contains all the potentially needed information, and lets
danielebarchiesi@4:  * consumers use the parts they actually need.
danielebarchiesi@4:  *
danielebarchiesi@4:  * @param $field
danielebarchiesi@4:  *   The field definition.
danielebarchiesi@4:  * @param $options
danielebarchiesi@4:  *   An array of options to limit the scope of the returned list. The following
danielebarchiesi@4:  *   key/value pairs are accepted:
danielebarchiesi@4:  *   - string: string to filter titles on (used by autocomplete).
danielebarchiesi@4:  *   - match: operator to match the above string against, can be any of:
danielebarchiesi@4:  *     'contains', 'equals', 'starts_with'. Defaults to 'contains'.
danielebarchiesi@4:  *   - ids: array of specific node ids to lookup.
danielebarchiesi@4:  *   - limit: maximum size of the the result set. Defaults to 0 (no limit).
danielebarchiesi@4:  *
danielebarchiesi@4:  * @return
danielebarchiesi@4:  *   An array of valid users in the form:
danielebarchiesi@4:  *   array(
danielebarchiesi@4:  *     uid => array(
danielebarchiesi@4:  *       'title' => The user name,
danielebarchiesi@4:  *       'rendered' => The text to display in widgets (can be HTML)
danielebarchiesi@4:  *     ),
danielebarchiesi@4:  *     ...
danielebarchiesi@4:  *   )
danielebarchiesi@4:  */
danielebarchiesi@4: function user_reference_potential_references($field, $options = array()) {
danielebarchiesi@4:   // Fill in default options.
danielebarchiesi@4:   $options += array(
danielebarchiesi@4:     'string' => '',
danielebarchiesi@4:     'match' => 'contains',
danielebarchiesi@4:     'ids' => array(),
danielebarchiesi@4:     'limit' => 0,
danielebarchiesi@4:   );
danielebarchiesi@4: 
danielebarchiesi@4:   $results = &drupal_static(__FUNCTION__, array());
danielebarchiesi@4: 
danielebarchiesi@4:   // Create unique id for static cache.
danielebarchiesi@4:   $cid = $field['field_name'] . ':' . $options['match'] . ':'
danielebarchiesi@4:     . ($options['string'] !== '' ? $options['string'] : implode('-', $options['ids']))
danielebarchiesi@4:     . ':' . $options['limit'];
danielebarchiesi@4:   if (!isset($results[$cid])) {
danielebarchiesi@4:     $references = FALSE;
danielebarchiesi@4:     if (module_exists('views') && !empty($field['settings']['view']['view_name'])) {
danielebarchiesi@4:       $references = _user_reference_potential_references_views($field, $options);
danielebarchiesi@4:     }
danielebarchiesi@4: 
danielebarchiesi@4:     if ($references === FALSE) {
danielebarchiesi@4:       $references = _user_reference_potential_references_standard($field, $options);
danielebarchiesi@4:     }
danielebarchiesi@4: 
danielebarchiesi@4:     // Store the results.
danielebarchiesi@4:     $results[$cid] = !empty($references) ? $references : array();
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   return $results[$cid];
danielebarchiesi@4: }
danielebarchiesi@4: 
danielebarchiesi@4: /**
danielebarchiesi@4:  * Helper function for user_reference_potential_references().
danielebarchiesi@4:  *
danielebarchiesi@4:  * Case of Views-defined referenceable users.
danielebarchiesi@4:  */
danielebarchiesi@4: function _user_reference_potential_references_views($field, $options) {
danielebarchiesi@4:   $settings = $field['settings']['view'];
danielebarchiesi@4:   $options['title_field'] = 'name';
danielebarchiesi@4:   return references_potential_references_view('user', $settings['view_name'], $settings['display_name'], $settings['args'], $options);
danielebarchiesi@4: }
danielebarchiesi@4: 
danielebarchiesi@4: /**
danielebarchiesi@4:  * Helper function for user_reference_potential_references().
danielebarchiesi@4:  *
danielebarchiesi@4:  * List of referenceable users defined by user role and status.
danielebarchiesi@4:  */
danielebarchiesi@4: function _user_reference_potential_references_standard($field, $options) {
danielebarchiesi@4:   // Avoid useless work.
danielebarchiesi@4:   $filter_roles = array_filter($field['settings']['referenceable_roles']);
danielebarchiesi@4:   $filter_status = array_filter($field['settings']['referenceable_status']);
danielebarchiesi@4:   if (!count($filter_status) && !count($filter_roles)) {
danielebarchiesi@4:     return array();
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   $query = db_select('users', 'u')
danielebarchiesi@4:     // Select the whole record, so that format_username() has enough
danielebarchiesi@4:     // information.
danielebarchiesi@4:     ->fields('u')
danielebarchiesi@4:     ->addMetaData('id', ' _user_reference_potential_references_standard')
danielebarchiesi@4:     ->addMetaData('field', $field)
danielebarchiesi@4:     ->addMetaData('options', $options);
danielebarchiesi@4: 
danielebarchiesi@4:   // Enable this filter only if any statuses checked (and not both).
danielebarchiesi@4:   if (count($filter_status) == 1) {
danielebarchiesi@4:     $query->condition('u.status', array_keys($filter_status), 'IN');
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   // Skip filter when "authenticated user" choosen.
danielebarchiesi@4:   if ($filter_roles && !isset($filter_roles[DRUPAL_AUTHENTICATED_RID])) {
danielebarchiesi@4:     $query->join('users_roles', 'r', 'u.uid = r.uid');
danielebarchiesi@4:     $query->condition('r.rid', array_keys($filter_roles), 'IN');
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   if ($options['string'] !== '') {
danielebarchiesi@4:     switch ($options['match']) {
danielebarchiesi@4:       case 'contains':
danielebarchiesi@4:         $query->condition('u.name', '%' . $options['string'] . '%', 'LIKE');
danielebarchiesi@4:         break;
danielebarchiesi@4: 
danielebarchiesi@4:       case 'starts_with':
danielebarchiesi@4:         $query->condition('u.name', $options['string'] . '%', 'LIKE');
danielebarchiesi@4:         break;
danielebarchiesi@4: 
danielebarchiesi@4:       case 'equals':
danielebarchiesi@4:       default: // no match type or incorrect match type: use "="
danielebarchiesi@4:         $query->condition('u.name', $options['string'], '=');
danielebarchiesi@4:         break;
danielebarchiesi@4:     }
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   if ($options['ids']) {
danielebarchiesi@4:     $query->condition('u.uid', $options['ids'], 'IN');
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   // Explicitly exclude the anonymous user.
danielebarchiesi@4:   $query->condition('u.uid', 0, '<>');
danielebarchiesi@4: 
danielebarchiesi@4:   if ($options['limit']) {
danielebarchiesi@4:     $query->range(0, $options['limit']);
danielebarchiesi@4:   }
danielebarchiesi@4:   $query->orderBy('u.name');
danielebarchiesi@4: 
danielebarchiesi@4:   $result = $query->execute()->fetchAll();
danielebarchiesi@4:   $references = array();
danielebarchiesi@4:   foreach ($result as $account) {
danielebarchiesi@4:     $references[$account->uid] = array(
danielebarchiesi@4:       'title'    => $account->name,
danielebarchiesi@4:       'rendered' => check_plain(format_username($account)),
danielebarchiesi@4:     );
danielebarchiesi@4:   }
danielebarchiesi@4:   return $references;
danielebarchiesi@4: }
danielebarchiesi@4: 
danielebarchiesi@4: /**
danielebarchiesi@4:  * Menu callback; Retrieve a pipe delimited string of autocomplete suggestions for existing users
danielebarchiesi@4:  */
danielebarchiesi@4: function user_reference_autocomplete($entity_type, $bundle, $field_name, $string = '') {
danielebarchiesi@4:   $field = field_info_field($field_name);
danielebarchiesi@4:   $instance = field_info_instance($entity_type, $field_name, $bundle);
danielebarchiesi@4: 
danielebarchiesi@4:   $options = array(
danielebarchiesi@4:     'string' => $string,
danielebarchiesi@4:     'match' => $instance['widget']['settings']['autocomplete_match'],
danielebarchiesi@4:     'limit' => 10,
danielebarchiesi@4:   );
danielebarchiesi@4:   $references = user_reference_potential_references($field, $options);
danielebarchiesi@4: 
danielebarchiesi@4:   $matches = array();
danielebarchiesi@4:   foreach ($references as $id => $row) {
danielebarchiesi@4:     // Markup is fine in autocompletion results (might happen when rendered
danielebarchiesi@4:     // through Views) but we want to remove hyperlinks.
danielebarchiesi@4:     $suggestion = preg_replace('/<a href="([^<]*)">([^<]*)<\/a>/', '$2', $row['rendered']);
danielebarchiesi@4:     // Remove link tags Add a class wrapper for a few required CSS overrides.
danielebarchiesi@4:     $matches[$row['title'] . " [uid:$id]"] = '<div class="reference-autocomplete">' . $suggestion . '</div>';
danielebarchiesi@4:   }
danielebarchiesi@4:   drupal_json_output($matches);
danielebarchiesi@4: }
danielebarchiesi@4: 
danielebarchiesi@4: /**
danielebarchiesi@4:  * Implements hook_options_list().
danielebarchiesi@4:  */
danielebarchiesi@4: function user_reference_options_list($field) {
danielebarchiesi@4:   return _user_reference_options($field, FALSE);
danielebarchiesi@4: }
danielebarchiesi@4: 
danielebarchiesi@4: /**
danielebarchiesi@4:  * Implementation of hook_user_load().
danielebarchiesi@4:  */
danielebarchiesi@4: /*function user_reference_user_load($accounts) {
danielebarchiesi@4: 
danielebarchiesi@4:   // Only add links if we are on the user 'view' page.
danielebarchiesi@4:   if (arg(0) != 'user' || arg(2)) {
danielebarchiesi@4:     return;
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   foreach ($accounts as $uid => $account) {
danielebarchiesi@4: 
danielebarchiesi@4:     // find CCK user_reference field tables
danielebarchiesi@4:     // search through them for matching user ids and load those nodes
danielebarchiesi@4:     $additions = array();
danielebarchiesi@4:     $fields = field_info_instances('user');
danielebarchiesi@4: 
danielebarchiesi@4:     // TODO : replace with field_attach_query() + synchronize with latest D6 code.
danielebarchiesi@4: 
danielebarchiesi@4:     // Find the table and columns to search through, if the same
danielebarchiesi@4:     // table comes up in more than one field type, we only need
danielebarchiesi@4:     // to search it once.
danielebarchiesi@4:     $search_tables = array();
danielebarchiesi@4:     $search_links = array();
danielebarchiesi@4:     foreach ($fields as $field) {
danielebarchiesi@4:       if ($field['type'] == 'user_reference' && !empty($field['widget']['reverse_link'])) {
danielebarchiesi@4:         $db_info = content_database_info($field);
danielebarchiesi@4:         $search_tables[$db_info['table']] = $db_info['columns']['uid']['column'];
danielebarchiesi@4:         $search_links[$db_info['table']] = $field['widget']['reverse_link'];
danielebarchiesi@4:       }
danielebarchiesi@4:     }
danielebarchiesi@4:     foreach ($search_tables as $table => $column) {
danielebarchiesi@4:       $ids = db_query(db_rewrite_sql("SELECT DISTINCT(n.nid) FROM {node} n LEFT JOIN {". $table ."} f ON n.vid = f.vid WHERE f.". $column ."=". $account->uid. " AND n.status = 1"));
danielebarchiesi@4:       while ($data = db_fetch_object($ids)) {
danielebarchiesi@4:         // TODO, do we really want a complete node_load() here? We only need the title to create a link.
danielebarchiesi@4:         $node = node_load($data->nid);
danielebarchiesi@4:         $node->reverse_link = $search_links[$table];
danielebarchiesi@4:         $additions[$node->type][] = $node;
danielebarchiesi@4:       }
danielebarchiesi@4:     }
danielebarchiesi@4:     $accounts[$uid]->user_reference = $additions;
danielebarchiesi@4:   }
danielebarchiesi@4:   return;
danielebarchiesi@4: }*/
danielebarchiesi@4: 
danielebarchiesi@4: /**
danielebarchiesi@4:  * Implementation of hook_user_view().
danielebarchiesi@4:  */
danielebarchiesi@4: /*function user_reference_user_view($account, $view_mode, $langcode) {
danielebarchiesi@4:   if (!empty($account->user_reference)) {
danielebarchiesi@4:     $node_types = content_types();
danielebarchiesi@4:     $additions = array();
danielebarchiesi@4:     $values = array();
danielebarchiesi@4:     foreach ($account->user_reference as $node_type => $nodes) {
danielebarchiesi@4:       foreach ($nodes as $node) {
danielebarchiesi@4:         if ($node->reverse_link) {
danielebarchiesi@4:           $values[$node_type][] = l($node->title, 'node/' . $node->nid);
danielebarchiesi@4:         }
danielebarchiesi@4:       }
danielebarchiesi@4:       if (isset($values[$node_type])) {
danielebarchiesi@4:         $additions[] = array(
danielebarchiesi@4:           '#type' => 'user_profile_item',
danielebarchiesi@4:           '#title' => check_plain($node_types[$node_type]['name']),
danielebarchiesi@4:           '#value' => theme('item_list', $values[$node_type]),
danielebarchiesi@4:         );
danielebarchiesi@4:       }
danielebarchiesi@4:     }
danielebarchiesi@4:     if ($additions) {
danielebarchiesi@4:       $account->content['user_reference'] = $additions + array(
danielebarchiesi@4:         '#type' => 'user_profile_category',
danielebarchiesi@4:         '#attributes' => array('class' => array('user-member')),
danielebarchiesi@4:         '#title' => t('Related content'),
danielebarchiesi@4:         '#weight' => 10,
danielebarchiesi@4:       );
danielebarchiesi@4:     }
danielebarchiesi@4:   }
danielebarchiesi@4: }*/
danielebarchiesi@4: 
danielebarchiesi@4: /**
danielebarchiesi@4:  * Implements hook_content_migrate_field_alter().
danielebarchiesi@4:  *
danielebarchiesi@4:  * Use this to tweak the conversion of field settings
danielebarchiesi@4:  * from the D6 style to the D7 style for specific
danielebarchiesi@4:  * situations not handled by basic conversion,
danielebarchiesi@4:  * as when field types or settings are changed.
danielebarchiesi@4:  *
danielebarchiesi@4:  * $field_value['widget_type'] is available to
danielebarchiesi@4:  * see what widget type was originally used.
danielebarchiesi@4:  */
danielebarchiesi@4: function user_reference_content_migrate_field_alter(&$field_value, $instance_value) {
danielebarchiesi@4:   switch ($field_value['module']) {
danielebarchiesi@4:     case 'userreference':
danielebarchiesi@4:       $field_value['module'] = 'user_reference';
danielebarchiesi@4:       $field_value['type'] = 'user_reference';
danielebarchiesi@4: 
danielebarchiesi@4:       // Translate 'view' settings.
danielebarchiesi@4:       $view_name = isset($field_value['settings']['advanced_view']) ? $field_value['settings']['advanced_view'] : '';
danielebarchiesi@4:       $view_args = isset($field_value['settings']['advanced_view_args']) ? $field_value['settings']['advanced_view_args'] : '';
danielebarchiesi@4:       $view_args = array_map('trim', explode(',', $view_args));
danielebarchiesi@4:       $field_value['settings']['view'] = array(
danielebarchiesi@4:         'view_name' => $view_name,
danielebarchiesi@4:         'display_name' => 'default',
danielebarchiesi@4:         'args' => $view_args,
danielebarchiesi@4:       );
danielebarchiesi@4:       if ($view_name) {
danielebarchiesi@4:         $field_value['messages'][] = t("The field uses the view @view_name to determine referenceable users. You will need to manually edit the view and add a display of type 'References'.", array('@view_name' => $view_name));
danielebarchiesi@4:       }
danielebarchiesi@4:       unset($field_value['settings']['advanced_view']);
danielebarchiesi@4:       unset($field_value['settings']['advanced_view_args']);
danielebarchiesi@4:       break;
danielebarchiesi@4:   }
danielebarchiesi@4: }
danielebarchiesi@4: 
danielebarchiesi@4: /**
danielebarchiesi@4:  * Implements hook_content_migrate_instance_alter().
danielebarchiesi@4:  *
danielebarchiesi@4:  * Use this to tweak the conversion of instance or widget settings
danielebarchiesi@4:  * from the D6 style to the D7 style for specific
danielebarchiesi@4:  * situations not handled by basic conversion, as when
danielebarchiesi@4:  * formatter or widget names or settings are changed.
danielebarchiesi@4:  */
danielebarchiesi@4: function user_reference_content_migrate_instance_alter(&$instance_value, $field_value) {
danielebarchiesi@4:   // The module name for the instance was corrected
danielebarchiesi@4:   // by the change in user_reference_content_migrate_field_alter().
danielebarchiesi@4:   switch ($field_value['type']) {
danielebarchiesi@4:     case 'userreference':
danielebarchiesi@4:       // The formatter names changed, all are prefixed
danielebarchiesi@4:       // with 'user_reference_'.
danielebarchiesi@4:       foreach ($instance_value['display'] as $context => $settings) {
danielebarchiesi@4:         $instance_value['display'][$context]['type'] = 'user_reference_' . $settings['type'];
danielebarchiesi@4:       }
danielebarchiesi@4:       // Massage the widget.
danielebarchiesi@4:       switch ($instance_value['widget']['type']) {
danielebarchiesi@4:         case 'userreference_autocomplete':
danielebarchiesi@4:           $instance_value['widget']['type'] = 'user_reference_autocomplete';
danielebarchiesi@4:           $instance_value['widget']['module'] = 'user_reference';
danielebarchiesi@4:           break;
danielebarchiesi@4:         case 'userreference_select':
danielebarchiesi@4:           $instance_value['widget']['type'] = 'options_select';
danielebarchiesi@4:           $instance_value['widget']['module'] = 'options';
danielebarchiesi@4:           break;
danielebarchiesi@4:         case 'userreference_buttons':
danielebarchiesi@4:           $instance_value['widget']['type'] = 'options_buttons';
danielebarchiesi@4:           $instance_value['widget']['module'] = 'options';
danielebarchiesi@4:       }
danielebarchiesi@4:       break;
danielebarchiesi@4:   }
danielebarchiesi@4: }
danielebarchiesi@4: 
danielebarchiesi@4: /**
danielebarchiesi@4:  * Implements hook_field_views_data().
danielebarchiesi@4:  *
danielebarchiesi@4:  * In addition to the default field information we add the relationship for
danielebarchiesi@4:  * views to connect back to the users table.
danielebarchiesi@4:  */
danielebarchiesi@4: function user_reference_field_views_data($field) {
danielebarchiesi@4:   // No module_load_include(): this hook is invoked from
danielebarchiesi@4:   // views/modules/field.views.inc, which is where that function is defined.
danielebarchiesi@4:   $data = field_views_field_default_views_data($field);
danielebarchiesi@4: 
danielebarchiesi@4:   $storage = $field['storage']['details']['sql'];
danielebarchiesi@4: 
danielebarchiesi@4:   foreach ($storage as $age => $table_data) {
danielebarchiesi@4:     $table = key($table_data);
danielebarchiesi@4:     $columns = current($table_data);
danielebarchiesi@4:     $id_column = $columns['uid'];
danielebarchiesi@4:     if (isset($data[$table])) {
danielebarchiesi@4:       // Filter: swap the handler to the 'in' operator. The callback receives
danielebarchiesi@4:       // the field name instead of the whole $field structure to keep views
danielebarchiesi@4:       // data to a reasonable size.
danielebarchiesi@4:       $data[$table][$id_column]['filter']['handler'] = 'views_handler_filter_in_operator';
danielebarchiesi@4:       $data[$table][$id_column]['filter']['options callback'] = 'user_reference_views_filter_options';
danielebarchiesi@4:       $data[$table][$id_column]['filter']['options arguments'] = array($field['field_name']);
danielebarchiesi@4: 
danielebarchiesi@4:       // Argument: display users.name in argument titles (handled in our custom
danielebarchiesi@4:       // handler) and summary lists (handled by the base views_handler_argument
danielebarchiesi@4:       // handler).
danielebarchiesi@4:       // Both mechanisms rely on the 'name table' and 'name field' information
danielebarchiesi@4:       // below, by joining to a separate copy of the base table from the field
danielebarchiesi@4:       // data table.
danielebarchiesi@4:       $data[$table][$id_column]['argument']['handler'] = 'references_handler_argument';
danielebarchiesi@4:       $data[$table][$id_column]['argument']['name table'] = $table . '_reference';
danielebarchiesi@4:       $data[$table][$id_column]['argument']['name field'] = 'name';
danielebarchiesi@4:       $data[$table . '_reference']['table']['join'][$table] = array(
danielebarchiesi@4:         'left_field' => $id_column,
danielebarchiesi@4:         'table' => 'users',
danielebarchiesi@4:         'field' => 'uid',
danielebarchiesi@4:       );
danielebarchiesi@4: 
danielebarchiesi@4:       // Relationship.
danielebarchiesi@4:       $data[$table][$id_column]['relationship'] = array(
danielebarchiesi@4:         'handler' => 'references_handler_relationship',
danielebarchiesi@4:         'base' => 'users',
danielebarchiesi@4:         'base field' => 'uid',
danielebarchiesi@4:         'field' => $id_column,
danielebarchiesi@4:         'label' => $field['field_name'],
danielebarchiesi@4:         'field_name' => $field['field_name'],
danielebarchiesi@4:       );
danielebarchiesi@4:     }
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   return $data;
danielebarchiesi@4: }
danielebarchiesi@4: 
danielebarchiesi@4: /**
danielebarchiesi@4:  * Implements hook_field_views_data_views_data_alter().
danielebarchiesi@4:  */
danielebarchiesi@4: function user_reference_field_views_data_views_data_alter(&$data, $field) {
danielebarchiesi@4:   foreach ($field['bundles'] as $entity_type => $bundles) {
danielebarchiesi@4:     $entity_info = entity_get_info($entity_type);
danielebarchiesi@4:     $pseudo_field_name = 'reverse_' . $field['field_name'] . '_' . $entity_type;
danielebarchiesi@4: 
danielebarchiesi@4:     list($label, $all_labels) = field_views_field_label($field['field_name']);
danielebarchiesi@4:     $entity = $entity_info['label'];
danielebarchiesi@4:     if ($entity == t('Node')) {
danielebarchiesi@4:       $entity = t('Content');
danielebarchiesi@4:     }
danielebarchiesi@4: 
danielebarchiesi@4:     // Only specify target entity type if the field is used in more than one.
danielebarchiesi@4:     if (count($field['bundles']) > 1) {
danielebarchiesi@4:       $title = t('@field (@field_name) - reverse (to @entity)', array('@entity' => $entity, '@field' => $label, '@field_name' => $field['field_name']));
danielebarchiesi@4:     }
danielebarchiesi@4:     else {
danielebarchiesi@4:       $title = t('@field (@field_name) - reverse', array('@entity' => $entity, '@field' => $label, '@field_name' => $field['field_name']));
danielebarchiesi@4:     }
danielebarchiesi@4:     $data['users'][$pseudo_field_name]['relationship'] = array(
danielebarchiesi@4:       'title' => $title,
danielebarchiesi@4:       'help' => t('Relate each @entity referencing the user through @field.', array('@entity' => $entity, '@field' => $label)),
danielebarchiesi@4:       'handler' => 'views_handler_relationship_entity_reverse',
danielebarchiesi@4:       'field_name' => $field['field_name'],
danielebarchiesi@4:       'field table' => _field_sql_storage_tablename($field),
danielebarchiesi@4:       'field field' => $field['field_name'] . '_uid',
danielebarchiesi@4:       'base' => $entity_info['base table'],
danielebarchiesi@4:       'base field' => $entity_info['entity keys']['id'],
danielebarchiesi@4:       'label' => t('!field_name', array('!field_name' => $field['field_name'])),
danielebarchiesi@4:     );
danielebarchiesi@4:   }
danielebarchiesi@4: }
danielebarchiesi@4: 
danielebarchiesi@4: /**
danielebarchiesi@4:  * 'options callback' for the views_handler_filter_in_operator filter.
danielebarchiesi@4:  *
danielebarchiesi@4:  * @param $field_name
danielebarchiesi@4:  *   The field name.
danielebarchiesi@4:  *
danielebarchiesi@4:  * @return
danielebarchiesi@4:  *   The array of allowed options for the filter.
danielebarchiesi@4:  */
danielebarchiesi@4: function user_reference_views_filter_options($field_name) {
danielebarchiesi@4:   $options = array();
danielebarchiesi@4: 
danielebarchiesi@4:   if ($field = field_info_field($field_name)) {
danielebarchiesi@4:     $options = _user_reference_options($field, TRUE);
danielebarchiesi@4: 
danielebarchiesi@4:     // The options are displayed in checkboxes within the filter admin form, and
danielebarchiesi@4:     // in a select within an exposed filter. Checkboxes accept HTML, other
danielebarchiesi@4:     // entities should be encoded; selects require the exact opposite: no HTML,
danielebarchiesi@4:     // no encoding. We go for a middle ground: strip tags, leave entities
danielebarchiesi@4:     // unencoded.
danielebarchiesi@4:     foreach ($options as $key => $value) {
danielebarchiesi@4:       $options[$key] = strip_tags($value);
danielebarchiesi@4:     }
danielebarchiesi@4:   }
danielebarchiesi@4: 
danielebarchiesi@4:   return $options;
danielebarchiesi@4: }