Clean up access checks for external modules (domain views, ctools)

mymodule/plugins/access/domain.inc

// $Id$


/**
 * @file
 * Plugin to provide access control based upon domain membership.
 */

/**
 * Implementation of specially named hook_ctools_access().
 */
function mymodule_domain_ctools_access() {
  $args ['domain'] = array(
      'title' => t("User: domain editor"), 
      'description' => t('Control access by user domain.'), 
      'callback' => 'mymodule_domain_ctools_access_check', 
      'default' => array(
          'negate' => false 
      ), 
      'settings form' => 'mymodule_domain_ctools_access_settings', 
      'settings form submit' => 'mymodule_domain_ctools_access_settings_submit', 
      'summary' => 'mymodule_domain_ctools_acesss_summary', 
      'required context' => new ctools_context_required(t('User'), 'user') 
  );
  
  return $args;
}

/**
 * Settings form for the 'domain editor' access plugin
 */
function mymodule_domain_ctools_access_settings(&$form, &$form_state, $conf) {
  $form ['settings'] ['negate'] = array(
      '#type' => 'checkbox', 
      '#title' => t('Negate'), 
      '#default_value' => $conf ['negate'], 
      
      '#description' => t('User is domain editor of current domain') 
  );
}

/**
 * Compress the roles allowed to the minimum.
 */
function mymodule_domain_ctools_access_settings_submit(&$form, &$form_state) {
  $form_state ['values'] ['settings'] ['negate'] = $form_state ['values'] ['settings'] ['negate'];
}

/**
 * Check for access.
 */
function mymodule_domain_ctools_access_check($conf, $context) {
  // As far as I know there should always be a context at this point, but this
  // is safe.
  if (empty($context) || empty($context->data) || ! isset($context->data->roles)) {
    return FALSE;
  }
  $user = $context->data;
  
  //always access for uid 1
  if ($user->uid == 1) return TRUE;
  
  global $_domain;
  
  // user is assigned to current domain
  if (in_array($_domain ['domain_id'], $user->domain_user)) {
    return ! $conf ['negate'];
  }
  return $conf ['negate'];

}

/**
 * Provide a summary description
 */
function mymodule_domain_ctools_acesss_summary($conf, $context) {
 
  return t("Only users who are %not domain editors.", array('%not' => $conf['negate']?"not":""));
}

I made a patch. It (should) simply add a new file plugins/access/domain_editor.inc

At the moment I am using my own module (that does the same than domain_ctools plus the ability to control access per user) but I would drop it if this goes into yours.