acl.admin.inc in ACL 7

Implementations of administration functions for the acl module.

File

acl.admin.inc

<?php

/**
 * @file
 * Implementations of administration functions for the acl module.
 */

/**
 * Implementation of acl_get_usernames().
 */
function _acl_get_usernames($acl_id) {
  $users = array();
  $result = db_query("SELECT u.uid, u.name FROM {users} u LEFT JOIN {acl_user} aclu ON aclu.uid = u.uid WHERE acl_id = :acl_id", array(
    'acl_id' => $acl_id,
  ));
  foreach ($result as $user) {
    $users[$user->uid] = _acl_format_username($user);
  }
  return $users;
}

/**
 * Implementation of acl_edit_form().
 */
function _acl_edit_form($acl_id, $label = NULL, $new_acl = FALSE) {
  $users = array();
  if (!$new_acl) {

    // Ensure the ACL in question even exists.
    if (!($record = db_query("SELECT name, number FROM {acl} WHERE acl_id = :acl_id", array(
      'acl_id' => $acl_id,
    ))
      ->fetchAssoc())) {
      return array();
    }
    $users = _acl_get_usernames($acl_id);
  }
  if (!isset($label)) {
    $label = isset($record['name']) ? $record['name'] : (isset($record['number']) ? $record['number'] : $acl_id);
  }
  $form = array(
    '#type' => 'fieldset',
    '#collapsible' => TRUE,
    '#title' => check_plain($label),
    '#tree' => TRUE,
  );
  $form['acl_id'] = array(
    '#type' => 'value',
    '#value' => $acl_id,
  );
  $form['deletions'] = array(
    '#type' => 'checkboxes',
    '#options' => array(),
  );

  // placeholder
  $form['delete_button'] = array(
    '#type' => 'button',
    '#name' => 'acl_' . $acl_id,
    '#value' => t('Remove Checked'),
    '#submit' => FALSE,
  );
  $form['add'] = array(
    '#type' => 'textfield',
    '#title' => t('Add user'),
    '#maxlength' => 60,
    '#size' => 40,
    '#autocomplete_path' => 'user/autocomplete',
  );
  $form['add_button'] = array(
    '#type' => 'button',
    '#name' => 'acl_' . $acl_id,
    '#value' => t('Add User'),
    '#submit' => FALSE,
  );
  $form['user_list'] = array(
    '#type' => 'hidden',
    '#default_value' => serialize($users),
  );
  $form['#after_build'] = array(
    '_acl_edit_form_after_build',
  );
  return $form;
}

/**
 * Process a form that had our buttons on it.
 */
function _acl_edit_form_after_build($form, &$form_state) {

  // We can't use the form values because it's the entire structure
  // and we have no clue where our values actually are. That's
  // ok tho cause #value still works for us.
  $user_list = acl_edit_form_get_user_list($form);
  if (isset($form_state['triggering_element']) && $form_state['triggering_element']['#value'] == $form['delete_button']['#value']) {
    $deletions = $form['deletions']['#value'];
    foreach ($deletions as $uid) {
      unset($user_list[$uid]);
      unset($form['deletions']['#value'][$uid]);
    }
  }
  elseif (isset($form_state['triggering_element']) && $form_state['triggering_element']['#value'] == $form['add_button']['#value'] && !empty($form['add']['#value'])) {
    $user = db_query("SELECT uid, name FROM {users} WHERE name = :name", array(
      'name' => $form['add']['#value'],
    ))
      ->fetchObject();
    if (!$user) {
      form_error($form['add'], t("Invalid user specified."));
    }
    else {
      $user_list[$user->uid] = _acl_format_username($user);
      $form['add']['#value'] = NULL;
    }
  }
  if (count($user_list) != 0) {
    $form['deletions']['#type'] = 'checkboxes';
    $form['deletions']['#title'] = t("Current users");
    $form['deletions']['#options'] = $user_list;
    $form['deletions']['#value'] = array();

    // don't carry value through.
    $form['deletions'] = form_builder(!empty($form['#post']) ? $form['#post']['form_id'] : 'acl_form', $form['deletions'], $form_state);
  }
  else {
    $form['delete_button']['#type'] = 'value';
  }
  $form['user_list']['#value'] = serialize($user_list);
  return $form;
}

/**
 * Write the results of a form.
 *
 * The module that embedded our form must call this function!
 */
function acl_save_form($form, $priority = NULL) {
  $users = acl_edit_form_get_user_list($form);
  db_delete('acl_user')
    ->condition('acl_id', $form['acl_id'])
    ->execute();
  $insert = db_insert('acl_user')
    ->fields(array(
    'acl_id',
    'uid',
  ));
  foreach ($users as $uid => $name) {
    $insert
      ->values(array(
      'acl_id' => $form['acl_id'],
      'uid' => $uid,
    ));
  }
  $insert
    ->execute();
  if (isset($priority)) {
    db_update('acl_node')
      ->fields(array(
      'priority' => $priority,
    ))
      ->condition('acl_id', $form['acl_id'])
      ->execute();
  }
}

/**
 * Decode and return the list of users.
 *
 * @param array $form
 *   The ACL form or form_state array.
 * @param bool $get_default
 *   (optional) In the case of a form array, whether to return the
 *   '#default_value' (or the '#value').
 *
 * @return array
 *   An array of $uid => $username.
 */
function acl_edit_form_get_user_list($form, $get_default = FALSE) {
  if (is_array($form['user_list'])) {
    return unserialize($form['user_list'][$get_default ? '#default_value' : '#value']);
  }
  return unserialize($form['user_list']);
}

Functions

Name	Description
acl_edit_form_get_user_list	Decode and return the list of users.
acl_save_form	Write the results of a form.
_acl_edit_form	Implementation of acl_edit_form().
_acl_edit_form_after_build	Process a form that had our buttons on it.
_acl_get_usernames	Implementation of acl_get_usernames().