danielebarchiesi@0: <?php
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * @file
danielebarchiesi@0:  *
danielebarchiesi@0:  * Plugin to provide a user context
danielebarchiesi@0:  */
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Plugins are described by creating a $plugin array which will be used
danielebarchiesi@0:  * by the system that includes this file.
danielebarchiesi@0:  */
danielebarchiesi@0: $plugin = array(
danielebarchiesi@0:   'title' => t("User"),
danielebarchiesi@0:   'description' => t('A single user object.'),
danielebarchiesi@0:   'context' => 'ctools_context_create_user',
danielebarchiesi@0:   'edit form' => 'ctools_context_user_settings_form',
danielebarchiesi@0:   'defaults' => array('type' => 'select', 'uid' => ''),
danielebarchiesi@0:   'keyword' => 'user',
danielebarchiesi@0:   'context name' => 'user',
danielebarchiesi@0:   'convert list' => 'ctools_context_user_convert_list',
danielebarchiesi@0:   'convert' => 'ctools_context_user_convert',
danielebarchiesi@0:   'convert default' => 'name',
danielebarchiesi@0: 
danielebarchiesi@0:   // This context is deprecated and should not be usable in the UI.
danielebarchiesi@0:   'no ui' => TRUE,
danielebarchiesi@0:   'no required context ui' => TRUE,
danielebarchiesi@0: );
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * It's important to remember that $conf is optional here, because contexts
danielebarchiesi@0:  * are not always created from the UI.
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_context_create_user($empty, $data = NULL, $conf = FALSE) {
danielebarchiesi@0:   $context = new ctools_context(array('entity:user', 'entity', 'user'));
danielebarchiesi@0:   $context->plugin = 'user';
danielebarchiesi@0: 
danielebarchiesi@0:   if ($empty) {
danielebarchiesi@0:     return $context;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   if ($conf) {
danielebarchiesi@0:     if ($data['type'] == 'current') {
danielebarchiesi@0:       global $user;
danielebarchiesi@0:       $data = user_load($user->uid);
danielebarchiesi@0:       $data->logged_in_user = TRUE;
danielebarchiesi@0:     }
danielebarchiesi@0:     else {
danielebarchiesi@0:       $data = user_load($data['uid']);
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0:   // Load entity if the data provided is a numeric value. This kind of data is
danielebarchiesi@0:   // passed by some relationships.
danielebarchiesi@0:   if (is_numeric($data)) {
danielebarchiesi@0:     $data = user_load($data);
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   if (!empty($data)) {
danielebarchiesi@0:     $context->data     = $data;
danielebarchiesi@0:     $context->title    = isset($data->name) ? $data->name : t('Anonymous');
danielebarchiesi@0:     $context->argument = $data->uid;
danielebarchiesi@0:     return $context;
danielebarchiesi@0:   }
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: function ctools_context_user_settings_form($form, &$form_state) {
danielebarchiesi@0:   $conf = $form_state['conf'];
danielebarchiesi@0: 
danielebarchiesi@0:   ctools_include('dependent');
danielebarchiesi@0:   $form['type'] = array(
danielebarchiesi@0:     '#title' => t('Enter the context type'),
danielebarchiesi@0:     '#type' => 'radios',
danielebarchiesi@0:     '#options' => array(
danielebarchiesi@0:       'select' => t('Select a user'),
danielebarchiesi@0:       'current' => t('Logged in user'),
danielebarchiesi@0:     ),
danielebarchiesi@0:     '#default_value' => $conf['type'],
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   $form['user'] = array(
danielebarchiesi@0:     '#title' => t('Enter a user name'),
danielebarchiesi@0:     '#type' => 'textfield',
danielebarchiesi@0:     '#maxlength' => 512,
danielebarchiesi@0:     '#autocomplete_path' => 'user/autocomplete',
danielebarchiesi@0:     '#dependency' => array('radio:type' => array('select')),
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   if (!empty($conf['uid'])) {
danielebarchiesi@0:     $info = user_load($conf['uid']);
danielebarchiesi@0:     if ($info) {
danielebarchiesi@0:       $form['user']['#description'] = t('Currently set to !link', array('!link' => theme('username', $info)));
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   $form['uid'] = array(
danielebarchiesi@0:     '#type' => 'value',
danielebarchiesi@0:     '#value' => $conf['uid'],
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   $form['set_identifier'] = array(
danielebarchiesi@0:     '#type' => 'checkbox',
danielebarchiesi@0:     '#default_value' => FALSE,
danielebarchiesi@0:     '#title' => t('Reset identifier to username'),
danielebarchiesi@0:     '#description' => t('If checked, the identifier will be reset to the user name of the selected user.'),
danielebarchiesi@0:     '#dependency' => array('radio:context[context_settings][type]' => array('select')),
danielebarchiesi@0:   );
danielebarchiesi@0: 
danielebarchiesi@0:   return $form;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Validate a user.
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_context_user_settings_form_validate($form, &$form_state) {
danielebarchiesi@0:   if ($form_state['values']['type'] != 'select') {
danielebarchiesi@0:     return;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   // Validate the autocomplete
danielebarchiesi@0:   if (empty($form_state['values']['uid']) && empty($form_state['values']['user'])) {
danielebarchiesi@0:     form_error($form['user'], t('You must select a user.'));
danielebarchiesi@0:     return;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   if (empty($form_state['values']['user'])) {
danielebarchiesi@0:     return;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   $account = user_load_by_name($form_state['values']['user']);
danielebarchiesi@0: 
danielebarchiesi@0:   if (!$account) {
danielebarchiesi@0:     form_error($form['user'], t('Invalid user selected.'));
danielebarchiesi@0:   }
danielebarchiesi@0:   else {
danielebarchiesi@0:     form_set_value($form['uid'], $account->uid, $form_state);
danielebarchiesi@0:   }
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: function ctools_context_user_settings_form_submit($form, &$form_state) {
danielebarchiesi@0:   if ($form_state['values']['set_identifier']) {
danielebarchiesi@0:     $account = user_load($form_state['values']['uid']);
danielebarchiesi@0:     $form_state['values']['identifier'] = $account->name;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   $form_state['conf']['type'] = $form_state['values']['type'];
danielebarchiesi@0:   $form_state['conf']['uid'] = $form_state['values']['uid'];
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Provide a list of replacements.
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_context_user_convert_list() {
danielebarchiesi@0:   $tokens = token_info();
danielebarchiesi@0:   foreach ($tokens['tokens']['user'] as $id => $info) {
danielebarchiesi@0:     if (!isset($list[$id])) {
danielebarchiesi@0:       $list[$id] = $info['name'];
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   return $list;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Convert a context into a string.
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_context_user_convert($context, $type) {
danielebarchiesi@0:   $tokens = token_info();
danielebarchiesi@0:   if (isset($tokens['tokens']['user'][$type])) {
danielebarchiesi@0:     $values = token_generate('user', array($type => $type), array('user' => $context->data));
danielebarchiesi@0:     if (isset($values[$type])) {
danielebarchiesi@0:       return $values[$type];
danielebarchiesi@0:     }
danielebarchiesi@0:   }
danielebarchiesi@0: }