danielebarchiesi@0: <?php
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * @file
danielebarchiesi@0:  * Plugin to provide access control based upon role membership.
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: role"),
danielebarchiesi@0:   'description' => t('Control access by role.'),
danielebarchiesi@0:   'callback' => 'ctools_role_ctools_access_check',
danielebarchiesi@0:   'default' => array('rids' => array()),
danielebarchiesi@0:   'settings form' => 'ctools_role_ctools_access_settings',
danielebarchiesi@0:   'settings form submit' => 'ctools_role_ctools_access_settings_submit',
danielebarchiesi@0:   'summary' => 'ctools_role_ctools_access_summary',
danielebarchiesi@0:   'required context' => new ctools_context_required(t('User'), 'user'),
danielebarchiesi@0: );
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Settings form for the 'by role' access plugin
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_role_ctools_access_settings($form, &$form_state, $conf) {
danielebarchiesi@0:   $form['settings']['rids'] = array(
danielebarchiesi@0:     '#type' => 'checkboxes',
danielebarchiesi@0:     '#title' => t('Role'),
danielebarchiesi@0:     '#default_value' => $conf['rids'],
danielebarchiesi@0:     '#options' => ctools_get_roles(),
danielebarchiesi@0:     '#description' => t('Only the checked roles will be granted access.'),
danielebarchiesi@0:   );
danielebarchiesi@0:   return $form;
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Compress the roles allowed to the minimum.
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_role_ctools_access_settings_submit($form, &$form_state) {
danielebarchiesi@0:   $form_state['values']['settings']['rids'] = array_keys(array_filter($form_state['values']['settings']['rids']));
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Check for access.
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_role_ctools_access_check($conf, $context) {
danielebarchiesi@0:   // As far as I know there should always be a context at this point, but this
danielebarchiesi@0:   // is safe.
danielebarchiesi@0:   if (empty($context) || empty($context->data) || !isset($context->data->roles)) {
danielebarchiesi@0:     return FALSE;
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   $roles = array_keys($context->data->roles);
danielebarchiesi@0:   $roles[] = $context->data->uid ? DRUPAL_AUTHENTICATED_RID : DRUPAL_ANONYMOUS_RID;
danielebarchiesi@0:   return (bool) array_intersect($conf['rids'], $roles);
danielebarchiesi@0: }
danielebarchiesi@0: 
danielebarchiesi@0: /**
danielebarchiesi@0:  * Provide a summary description based upon the checked roles.
danielebarchiesi@0:  */
danielebarchiesi@0: function ctools_role_ctools_access_summary($conf, $context) {
danielebarchiesi@0:   if (!isset($conf['rids'])) {
danielebarchiesi@0:     $conf['rids'] = array();
danielebarchiesi@0:   }
danielebarchiesi@0:   $roles = ctools_get_roles();
danielebarchiesi@0: 
danielebarchiesi@0:   $names = array();
danielebarchiesi@0:   foreach (array_filter($conf['rids']) as $rid) {
danielebarchiesi@0:     $names[] = check_plain($roles[$rid]);
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   if (empty($names)) {
danielebarchiesi@0:     return t('@identifier can have any role', array('@identifier' => $context->identifier));
danielebarchiesi@0:   }
danielebarchiesi@0: 
danielebarchiesi@0:   return format_plural(count($names), '@identifier has role "@roles"', '@identifier has one of "@roles"', array('@roles' => implode(', ', $names), '@identifier' => $context->identifier));
danielebarchiesi@0: }
danielebarchiesi@0: