access.access.inc in Access Control Kit 7

Access control kit API hook implementations to integrate with core modules.

File

access.access.inc

<?php

/**
 * @file
 * Access control kit API hook implementations to integrate with core modules.
 */

/**
 * Implements hook_access_scheme_info().
 */
function access_access_scheme_info() {
  $info['boolean'] = array(
    'label' => t('Boolean'),
    'data_type' => 'boolean',
    'description' => t('A <em>boolean</em> scheme controls access based on a true/false value (or yes/no, checked/unchecked, etc.). For example, you could grant access to content based on the "sticky" property, or to user profiles based on the value of a boolean field provided by the list module.'),
    'realms callback' => 'access_scheme_boolean_realms',
    'file' => 'callbacks/access.boolean.inc',
  );
  foreach (array(
    'integer',
    'float',
    'text',
  ) as $data_type) {

    // See if a list field exists of this type.
    $field_type = 'list_' . $data_type;
    $fields = field_read_fields(array(
      'type' => $field_type,
    ));

    // Don't include other realm fields.
    foreach ($fields as $field_name => $field) {
      if (!empty($field['settings']['allowed_values_function']) && $field['settings']['allowed_values_function'] == '_access_field_allowed_values') {
        unset($fields[$field_name]);
      }
    }
    if (!empty($fields)) {
      $info[$field_type] = array(
        'data_type' => $data_type,
        'realms callback' => 'access_scheme_list_field_realms',
        'settings callback' => 'access_scheme_list_field_settings',
        'file' => 'callbacks/access.list.inc',
      );
      switch ($data_type) {
        case 'integer':
          $info[$field_type]['label'] = t('List (integer) field');
          $info[$field_type]['description'] = t('A <em>list (integer) field</em> scheme controls access based on the value of an integer field provided by the list module. The allowed values list of the selected field will become the access realms for the site, and you will be able to grant access based on the value of that field to any ACK-supported fieldable entity that uses the field. ACK modules that support non-fieldable objects (such as the ACK menu module, for menu links) may also provide the ability to map those objects to a list value.');
          break;
        case 'float':
          $info[$field_type]['label'] = t('List (float) field');
          $info[$field_type]['description'] = t('A <em>list (float) field</em> scheme controls access based on the value of a float field provided by the list module. The allowed values list of the selected field will become the access realms for the site, and you will be able to grant access based on the value of that field to any ACK-supported fieldable entity that uses the field. ACK modules that support non-fieldable objects (such as the ACK menu module, for menu links) may also provide the ability to map those objects to a list value.');
          break;
        case 'text':
          $info[$field_type]['label'] = t('List (text) field');
          $info[$field_type]['description'] = t('A <em>list (text) field</em> scheme controls access based on the value of a text field provided by the list module. The allowed values list of the selected field will become the access realms for the site, and you will be able to grant access based on the value of that field to any ACK-supported fieldable entity that uses the field. ACK modules that support non-fieldable objects (such as the ACK menu module, for menu links) may also provide the ability to map those objects to a list value.');
          break;
      }
    }
  }
  if (module_exists('taxonomy')) {

    // See if any vocabularies exist.
    $exists = db_select('taxonomy_vocabulary', 't')
      ->fields('t', array(
      'vid',
    ))
      ->range(0, 1)
      ->execute()
      ->fetchField();
    if ($exists) {
      $info['taxonomy_term'] = array(
        'label' => t('Taxonomy'),
        'data_type' => 'integer',
        // @todo Support cascading hierarchical privileges as an option.
        'description' => t('A <em>taxonomy</em> scheme controls access based on the terms of a selected vocabulary. You will be able to grant access to any ACK-supported fieldable entity based on the terms associated with that entity through a taxonomy term reference field. ACK modules that support non-fieldable objects (such as the ACK menu module, for menu links) may also provide the ability to map those objects to a term.'),
        'realms callback' => 'access_scheme_taxonomy_term_realms',
        'settings callback' => 'access_scheme_taxonomy_term_settings',
        'file' => 'callbacks/access.taxonomy.inc',
      );
    }
  }
  $info['user'] = array(
    'label' => t('User account'),
    'data_type' => 'integer',
    'description' => t('A <em>user account</em> scheme controls access to ACK-supported objects based on the users associated with those objects. For example, you could grant User A access to all content authored by User B.'),
    'realms callback' => 'access_scheme_user_realms',
    'file' => 'callbacks/access.user.inc',
  );
  return $info;
}

/**
 * Implements hook_access_scheme_load().
 */
function access_access_scheme_load($schemes) {

  // Get all roles, excluding "anonymous users" and "authenticated users."
  $roles = user_roles(TRUE);
  unset($roles[DRUPAL_AUTHENTICATED_RID]);
  foreach ($schemes as $scheme) {

    // Attach role information.
    $scheme_roles = variable_get('access_scheme_roles_' . $scheme->machine_name, array());
    $scheme->roles = array_intersect_assoc($roles, $scheme_roles);
  }
}

/**
 * Implements hook_access_scheme_presave().
 */
function access_access_scheme_presave($scheme) {

  // Prevent a blank realm_field_name property.
  if (empty($scheme->realm_field_name)) {
    $scheme->realm_field_name = 'ack_' . $scheme->machine_name;
  }

  // Make sure we have the scheme type definition on the object.
  if (empty($scheme->info)) {
    $scheme->info = access_scheme_info($scheme->type);
  }
  if (!empty($scheme->info)) {

    // If the realm field doesn't exist, create it.
    $field = field_info_field($scheme->realm_field_name);
    if (empty($field)) {
      $field = array(
        'field_name' => $scheme->realm_field_name,
        'type' => 'list_' . $scheme->info['data_type'],
        'entity_types' => array(
          'access_grant',
        ),
        'cardinality' => FIELD_CARDINALITY_UNLIMITED,
        'locked' => TRUE,
        'settings' => array(
          'allowed_values' => array(),
          'allowed_values_function' => '_access_field_allowed_values',
        ),
      );
      field_create_field($field);
    }
  }
}

/**
 * Implements hook_access_scheme_insert().
 */
function access_access_scheme_insert($scheme) {

  // Create the realm field instance.
  $instance = field_info_instance('access_grant', $scheme->realm_field_name, $scheme->machine_name);
  if (empty($instance)) {
    $instance = array(
      'field_name' => $scheme->realm_field_name,
      'entity_type' => 'access_grant',
      'bundle' => $scheme->machine_name,
      'label' => check_plain($scheme->name),
      'description' => filter_xss($scheme->description),
      'required' => TRUE,
      'widget' => array(
        'type' => 'options_buttons',
        'settings' => array(),
      ),
    );
    field_create_instance($instance);
  }

  // Save the roles.
  if (empty($scheme->roles)) {
    $scheme->roles = array();
  }
  variable_set('access_scheme_roles_' . $scheme->machine_name, $scheme->roles);
}

/**
 * Implements hook_access_scheme_update().
 */
function access_access_scheme_update($scheme) {
  access_access_scheme_insert($scheme);
}

/**
 * Implements hook_access_scheme_delete().
 */
function access_access_scheme_delete($scheme) {

  // Delete the scheme's role configuration.
  variable_del('access_scheme_roles_' . $scheme->machine_name);
}

/**
 * Implements hook_access_handler_info().
 */
function access_access_handler_info() {

  // Generic Field API handler.
  $info['ACKEntityField'] = array(
    'label' => t('Field instance'),
    'scheme types' => array(
      'list_integer',
      'list_float',
      'list_text',
    ),
    'object types' => array(
      'fieldable entity',
    ),
  );

  // Handler for taxonomy term reference fields.
  if (module_exists('taxonomy')) {
    $info['ACKEntityTaxonomyTermReference'] = array(
      'label' => t('Term reference field'),
      'scheme types' => array(
        'taxonomy_term',
      ),
      'object types' => array(
        'fieldable entity',
      ),
    );
  }
  return $info;
}

/**
 * Implements hook_access_grant_view().
 */
function access_access_grant_view($grant) {
  $account = user_load($grant->uid);
  $grant->content['user'] = array(
    '#type' => 'item',
    '#title' => t('User:'),
    '#markup' => theme('username', array(
      'account' => $account,
    )),
    '#weight' => -5,
  );
  $role = user_role_load($grant->rid);
  $grant->content['role'] = array(
    '#type' => 'item',
    '#title' => t('Role:'),
    '#markup' => check_plain($role->name),
    '#weight' => -4,
  );
}

/**
 * Implements hook_access_scheme_views_data_alter().
 */
function access_access_scheme_views_data_alter(&$data, $field_value_name, $field_name, $scheme_type) {
  switch ($scheme_type) {
    case 'taxonomy_term':

      // Add a relationship to the referenced taxonomy term.
      $data[$field_value_name]['relationship'] = array(
        'handler' => 'views_handler_relationship',
        'base' => 'taxonomy_term_data',
        'base field' => 'tid',
        'label' => t('term from !field_name', array(
          '!field_name' => $field_name,
        )),
      );
      break;
    case 'user':

      // Add a relationship to the referenced user.
      $data[$field_value_name]['relationship'] = array(
        'handler' => 'views_handler_relationship',
        'base' => 'users',
        'base field' => 'uid',
        'label' => t('user from !field_name', array(
          '!field_name' => $field_name,
        )),
      );
      break;
  }
}

Functions

Name	Description
access_access_grant_view	Implements hook_access_grant_view().
access_access_handler_info	Implements hook_access_handler_info().
access_access_scheme_delete	Implements hook_access_scheme_delete().
access_access_scheme_info	Implements hook_access_scheme_info().
access_access_scheme_insert	Implements hook_access_scheme_insert().
access_access_scheme_load	Implements hook_access_scheme_load().
access_access_scheme_presave	Implements hook_access_scheme_presave().
access_access_scheme_update	Implements hook_access_scheme_update().
access_access_scheme_views_data_alter	Implements hook_access_scheme_views_data_alter().