taxonomy_access_admin.inc in Taxonomy Access Control 5.2

Administrative interface for taxonomy access control.

File

taxonomy_access_admin.inc

<?php

/**
 * @file
 * Administrative interface for taxonomy access control.
 */

/**
 * Cache roles
 */
function _taxonomy_access_user_roles() {
  static $roles;
  if (!is_array($roles)) {
    $roles = user_roles();
  }
  return $roles;
}

/**
 * Menu callback; presents the category permissions page of TAC (admin/user/taxonomy_access).
 */
function taxonomy_access_admin($op = NULL, $rid = NULL, $arg = NULL) {
  $roles = _taxonomy_access_user_roles();
  if (is_numeric($rid) and isset($roles[$rid])) {
    switch ($op) {
      case 'edit':
        return drupal_get_form('taxonomy_access_admin_form', $rid);
      case 'delete':
        return drupal_get_form('taxonomy_access_admin_delete_role', $rid);
    }
  }
  else {
    if (!isset($op) and !isset($rid)) {
      return theme_taxonomy_access_admin();
    }
    else {
      return drupal_not_found();
    }
  }
}

/**
 * Renders the main page of category permissions
 */
function theme_taxonomy_access_admin() {
  $roles = _taxonomy_access_user_roles();

  // Render role/permission overview:
  $header = array(
    t('Role'),
    array(
      'data' => '&nbsp;',
    ),
  );
  $rows = array();
  $result = db_query('SELECT rid FROM {term_access_defaults} WHERE vid=0 ');
  $active = array();
  while ($role = db_fetch_array($result)) {
    $active[$role['rid']] = TRUE;
  }
  foreach ($roles as $rid => $name) {
    $ops = array();
    if ($active[$rid]) {

      //only allow delete for "extra" roles
      if ($rid > 2) {
        $ops[] = l(t("disable"), "admin/user/taxonomy_access/delete/{$rid}");
      }
      $ops[] = l(t("edit"), "admin/user/taxonomy_access/edit/{$rid}");
    }
    else {
      $ops = array(
        l(t("enable"), "admin/user/taxonomy_access/edit/{$rid}"),
      );
    }
    $rows[] = array(
      $name,
      array(
        'data' => implode(' | ', $ops),
        'align' => 'right',
      ),
    );
  }
  return theme('table', $header, $rows);
}
function taxonomy_access_admin_delete_role($rid) {
  if (is_numeric($rid) and $rid > 2 and db_fetch_array(db_query('SELECT rid FROM {term_access_defaults} WHERE vid=0 AND rid=%d', $rid))) {
    if ($_POST['confirm']) {

      // issue #167977 - klance
      $affected_nodes = _taxonomy_access_get_nodes_for_role($rid);
      db_query('DELETE FROM {term_access} WHERE rid=%d', $rid);
      db_query('DELETE FROM {term_access_defaults} WHERE rid=%d', $rid);

      // issue #167977 - klance

      //node_access_rebuild();
      _taxonomy_access_node_access_update($affected_nodes);
      drupal_set_message("All term access rules deleted for role {$rid}.");
      drupal_goto('admin/user/taxonomy_access');
    }
    else {
      return confirm_form($form, t('Are you sure you want to delete all grant rules for role %rid?', array(
        '%rid' => $rid,
      )), 'admin/user/taxonomy_access', t('This action cannot be undone.'), t('Delete all'), t('Cancel'));
    }
  }
  else {
    return drupal_not_found();
  }
}

// TODO: clarify list VS create grants
function taxonomy_access_admin_build_row($grants = NULL) {
  $form['#title'] = $title;
  $form['#tree'] = TRUE;
  foreach (array(
    'view',
    'update',
    'delete',
  ) as $grant) {
    $form[$grant] = array(
      '#type' => 'radios',
      '#options' => array(
        '1' => '',
        '0' => '',
        '2' => '',
      ),
      //1: Allow, 0: Ignore, 2: Deny
      '#default_value' => is_string($grants['grant_' . $grant]) ? $grants['grant_' . $grant] : '0',
      '#required' => TRUE,
    );
  }
  foreach (array(
    'create',
    'list',
  ) as $grant) {
    $form[$grant] = array(
      '#type' => 'checkbox',
      '#default_value' => is_string($grants['grant_' . $grant]) ? $grants['grant_' . $grant] : '0',
    );
  }
  return $form;
}

/**
 * Form for managing grants by role.
 */
function taxonomy_access_admin_form($rid) {

  // Fetch all default grants
  $result = db_query('SELECT * FROM {term_access_defaults} WHERE rid = %d', $rid);
  while ($row = db_fetch_array($result)) {
    $default_grants[$row['vid']] = $row;
  }

  // Fetch all grants
  $result = db_query('SELECT * FROM {term_access} WHERE rid = %d', $rid);
  while ($row = db_fetch_array($result)) {
    $grants[$row['tid']] = $row;
  }
  $form['rid'] = array(
    '#type' => 'value',
    '#value' => $rid,
  );
  $form['grants'] = $form['selected_terms'] = $form['selected_defaults'] = array(
    '#tree' => TRUE,
  );

  //Global default
  $form['vocabs'][0]['#title'] = 'Global';
  $form['grants'][0][0] = taxonomy_access_admin_build_row($default_grants[0]);
  $form['selected_defaults'][0] = array(
    '#type' => 'checkbox',
    '#disabled' => TRUE,
    '#title' => '<em>default<em>',
    '#description' => 'can\'t be disabled without disabling TAC for this role',
  );
  foreach (taxonomy_get_vocabularies() as $vid => $vocabulary) {
    $form['vocabs'][$vid]['#title'] = check_plain($vocabulary->name);
    if (isset($default_grants[$vid])) {
      $form['grants'][$vid][0] = taxonomy_access_admin_build_row($default_grants[$vid]);
      $form['selected_defaults'][$vid] = array(
        '#type' => 'checkbox',
        '#title' => '<em>default<em>',
      );
    }
    else {
      $add_items[$vocabulary->name]["default {$vid}"] = '*default*';
    }
    if ($tree = taxonomy_get_tree($vid)) {
      foreach ($tree as $term) {
        if (isset($grants[$term->tid])) {
          $form['grants'][$vid][$term->tid] = taxonomy_access_admin_build_row($grants[$term->tid]);
          $form['selected_terms'][$term->tid] = array(
            '#type' => 'checkbox',
            '#title' => str_repeat('&nbsp;&nbsp;', $term->depth) . check_plain($term->name),
          );
        }
        else {
          $add_items[$vocabulary->name]["term {$term->tid}"] = str_repeat('-', $term->depth) . check_plain($term->name);
        }
      }
    }
  }

  //New grant row
  if (isset($add_items)) {
    $form['new']['grants'] = taxonomy_access_admin_build_row();
    $form['new']['#tree'] = TRUE;
    $form['new']['item'] = array(
      '#type' => 'select',
      '#options' => $add_items,
    );
    $form['new']['add'] = array(
      '#type' => 'submit',
      '#value' => t('Add'),
    );
  }
  $form['delete'] = array(
    '#type' => 'submit',
    '#value' => t('Delete selected'),
  );
  $form['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Save all'),
  );
  return $form;
}

/**
 * Renders the permission matrix user form for choosen user role.
 */
function theme_taxonomy_access_admin_form($form) {
  $roles = _taxonomy_access_user_roles();
  $header = array(
    array(
      'data' => t('Category'),
      'colspan' => 3,
    ),
    array(
      'data' => t('View'),
      'colspan' => 4,
    ),
    array(
      'data' => t('Update'),
      'colspan' => 4,
    ),
    array(
      'data' => t('Delete'),
      'colspan' => 4,
    ),
    array(
      'data' => t('Create'),
    ),
    array(
      'data' => t('List'),
    ),
  );
  $sub_header = array(
    '&nbsp;<strong>' . t('A') . '</strong>',
    '&nbsp;<strong>' . t('I') . '</strong>',
    '&nbsp;<strong>' . t('D') . '</strong>',
    '&nbsp;',
  );
  $sub_header = array_merge(array(
    '&nbsp;',
  ), $sub_header, $sub_header, $sub_header);
  $sub_header = array_pad($sub_header, 15, '&nbsp;');
  $node_grant_types = array(
    'view',
    'update',
    'delete',
  );
  $radios = array(
    '1' => t('Allow'),
    '0' => t('Ignore'),
    '2' => t('Deny'),
  );
  drupal_set_title(t('Grants for %role', array(
    '%role' => $roles[$form['rid']['#value']],
  )));
  $rows = array();
  foreach (array_keys($form['vocabs']) as $vid) {
    if (is_numeric($vid) and isset($form['grants'][$vid])) {
      $row = $sub_header;
      $row[0] = array(
        'data' => '<h3>' . check_plain($form['vocabs'][$vid]['#title']) . '</h3>',
        'colspan' => 3,
      );
      $rows[] = $row;
      foreach (array_keys($form['grants'][$vid]) as $tid) {
        if (is_numeric($tid)) {
          $select_key = $tid ? 'selected_terms' : 'selected_defaults';
          $select_id = $tid ? $tid : $vid;
          $row = array(
            array(
              'data' => drupal_render($form[$select_key][$select_id]),
              'colspan' => 3,
            ),
          );
          foreach ($node_grant_types as $grant) {
            foreach (array_keys($radios) as $key) {

              // I need this hack to display radio buttons horizontally (instead of standard form 'radios')
              $row[] = array(
                'data' => drupal_render($form['grants'][$vid][$tid][$grant][$key]),
              );
            }
            $row[] = '&nbsp;';
          }
          foreach (array(
            'create',
            'list',
          ) as $grant) {
            $row[] = array(
              'data' => drupal_render($form['grants'][$vid][$tid][$grant]),
            );
          }
          $rows[] = $row;
        }
      }
    }
  }
  if (isset($form['new'])) {
    $row = array(
      array(
        'data' => drupal_render($form['new']['item']),
        'colspan' => 2,
      ),
      drupal_render($form['new']['add']),
    );
    foreach ($node_grant_types as $grant) {
      foreach (array_keys($radios) as $key) {

        // I need this hack to display radio buttons horizontally (instead of standard form 'radios')
        $row[] = array(
          'data' => drupal_render($form['new']['grants'][$grant][$key]),
        );
      }
      $row[] = '&nbsp;';
    }
    foreach (array(
      'create',
      'list',
    ) as $grant) {
      $row[] = array(
        'data' => drupal_render($form['new']['grants'][$grant]),
      );
    }
    $rows[] = $row;
    $row = array();
  }
  $output .= theme('table', $header, $rows);
  $output .= drupal_render($form);
  return $output;
}
function taxonomy_access_admin_form_submit($form_id, $form_values) {
  switch ($form_values['op']) {
    case t('Delete selected'):
      if (is_array($form_values['selected_terms'])) {
        foreach ($form_values['selected_terms'] as $tid => $enabled) {
          if ($enabled) {

            // issue #167977 - klance
            $affected_nodes = _taxonomy_access_get_nodes_for_term($tid);
            db_query('DELETE FROM {term_access} WHERE rid = %d AND tid = %d', $form_values['rid'], $tid);

            // issue #167977 - klance
            _taxonomy_access_node_access_update($affected_nodes);
          }
        }
      }
      if (is_array($form_values['selected_defaults'])) {
        foreach ($form_values['selected_defaults'] as $vid => $enabled) {
          if ($enabled) {

            // issue #167977 - klance
            $affected_nodes = _taxonomy_access_get_nodes_for_vocabulary($vid, $form_values['rid']);
            db_query('DELETE FROM {term_access_defaults} WHERE rid = %d AND vid = %d', $form_values['rid'], $vid);

            // issue #167977 - klance
            _taxonomy_access_node_access_update($affected_nodes);
          }
        }
      }

      // issue #167977 - klance

      //node_access_rebuild();
      break;
    case t('Add'):
      $new = $form_values['new'];
      list($type, $id) = explode(' ', $new['item']);
      if ($type == 'term') {
        taxonomy_access_grant_update($id, $form_values['rid'], $new['grants']);
      }
      elseif ($type == 'default') {
        taxonomy_access_defaults_update($id, $form_values['rid'], $new['grants']);
      }

      // issue #167977 - klance

      //node_access_rebuild();
      break;
    case t('Save all'):
      foreach ($form_values['grants'] as $vid => $rows) {
        foreach ($rows as $tid => $grants) {
          if ($tid == 0) {
            taxonomy_access_defaults_update($vid, $form_values['rid'], $grants);
          }
          else {
            taxonomy_access_grant_update($tid, $form_values['rid'], $grants);
          }
        }
      }

      // issue #167977 - klance

      //node_access_rebuild();
      drupal_goto('admin/user/taxonomy_access');
  }
}

/**
 * Updates permissions for a role for a term
 * @param $tid
 *   The term to add the permission for.
 * @param $rid
 *   The role id to add the permission for.
 * @param $grants
 *   A hash of the grants in the form of $grants['perm'] = boolean
 *   A value of 1 will grant the permission for this user and term.
**/
function taxonomy_access_grant_update($tid, $rid = null, $grants = null) {
  if (!isset($tid) or !is_numeric($rid)) {
    return FALSE;
  }
  $args = array();
  $ta_sql = "INSERT INTO {term_access} (tid";
  $ta_sql_values = " VALUES (%d";
  $args[] = $tid;
  if (isset($rid)) {
    $ta_sql .= ",rid";
    $ta_sql_values .= ",%d";
    $args[] = $rid;
  }
  $sql = "";
  if (isset($grants)) {
    foreach ($grants as $perm => $value) {
      $sql .= ',' . db_escape_table("grant_{$perm}");
      $ta_sql_values .= ',%d';
      $args[] = is_array($value) ? $value[0] : $value;
    }
    $sql .= ")";
    $ta_sql_values .= ")";
  }
  else {
    $sql .= ")";
    $ta_sql_values .= ")";
  }
  $ta_sql .= $sql . $ta_sql_values;

  // issue #167977 - klance
  $affected_nodes = _taxonomy_access_get_nodes_for_term($tid);
  db_query("DELETE FROM {term_access} WHERE tid=%d AND rid=%d", $tid, $rid);
  db_query($ta_sql, $args);

  // insert into term_access
  // issue #167977 - klance
  _taxonomy_access_node_access_update($affected_nodes);
}

/**
 * Updates default permissions for a role for a vocabulary
 * @param $vid
 *   The vocab to add the permission for.
 * @param $rid
 *   The role id to add the permission to.
 * @param $grants
 *   A hash of the grants in the form of $grants['perm'] = boolean
 *   A value of 1 will grant the permission for this user and term.
**/
function taxonomy_access_defaults_update($vid, $rid = null, $grants = null) {
  if (!isset($vid) or !is_numeric($rid)) {
    return FALSE;
  }
  $args = array();
  $ta_sql = "INSERT INTO {term_access_defaults} (vid";
  $ta_sql_values = " VALUES (%d";
  $args[] = $vid;
  if (isset($rid)) {
    $ta_sql .= ",rid";
    $ta_sql_values .= ",%d";
    $args[] = $rid;
  }
  $sql = "";
  if (isset($grants)) {
    foreach ($grants as $perm => $value) {
      $sql .= ',' . db_escape_table("grant_{$perm}");
      $ta_sql_values .= ',%d';
      $args[] = is_array($value) ? $value[0] : $value;
    }
    $sql .= ")";
    $ta_sql_values .= ")";
  }
  else {
    $sql .= ")";
    $ta_sql_values .= ")";
  }
  $ta_sql .= $sql . $ta_sql_values;

  // issue #167977 - klance
  $affected_nodes = _taxonomy_access_get_nodes_for_vocabulary($vid, $rid);
  db_query("DELETE FROM {term_access_defaults} WHERE vid=%d AND rid=%d", $vid, $rid);
  db_query($ta_sql, $args);

  // insert into term_access_defaults
  // issue #167977 - klance
  _taxonomy_access_node_access_update($affected_nodes);
}

Functions

Name	Description
taxonomy_access_admin	Menu callback; presents the category permissions page of TAC (admin/user/taxonomy_access).
taxonomy_access_admin_build_row
taxonomy_access_admin_delete_role
taxonomy_access_admin_form	Form for managing grants by role.
taxonomy_access_admin_form_submit
taxonomy_access_defaults_update	Updates default permissions for a role for a vocabulary
taxonomy_access_grant_update	Updates permissions for a role for a term
theme_taxonomy_access_admin	Renders the main page of category permissions
theme_taxonomy_access_admin_form	Renders the permission matrix user form for choosen user role.
_taxonomy_access_user_roles	Cache roles