taxonomy_access.install in Taxonomy Access Control 7

Install, update, and uninstall functions for Taxonomy Access Control.

File

taxonomy_access.install

<?php

/**
 * @file
 *  Install, update, and uninstall functions for Taxonomy Access Control.
 */

/**
 * Implements hook_update_last_removed().
 */
function taxonomy_access_last_removed() {
  return 5;
}

/**
 * Implements hook_install().
 *
 * Adds tables to database: 'taxonomy_access_term', 'taxonomy_access_default'
 */
function taxonomy_access_install() {

  // Default global perms for roles 1 (anonymous) and 2 (authenticated).
  db_query('INSERT INTO {taxonomy_access_default}
    (vid, rid, grant_view, grant_update, grant_delete, grant_create, grant_list)
    VALUES
    (:vid, :rid, :node_allow, :ignore, :ignore, :term_allow, :term_allow)', array(
    ':vid' => TAXONOMY_ACCESS_GLOBAL_DEFAULT,
    ':rid' => DRUPAL_ANONYMOUS_RID,
    ':node_allow' => TAXONOMY_ACCESS_NODE_ALLOW,
    ':ignore' => TAXONOMY_ACCESS_NODE_IGNORE,
    ':term_allow' => TAXONOMY_ACCESS_TERM_ALLOW,
  ));
  db_query('INSERT INTO {taxonomy_access_default}
    (vid, rid, grant_view, grant_update, grant_delete, grant_create, grant_list)
    VALUES
    (:vid, :rid, :node_allow, :ignore, :ignore, :term_allow, :term_allow)', array(
    ':vid' => TAXONOMY_ACCESS_GLOBAL_DEFAULT,
    ':rid' => DRUPAL_AUTHENTICATED_RID,
    ':node_allow' => TAXONOMY_ACCESS_NODE_ALLOW,
    ':ignore' => TAXONOMY_ACCESS_NODE_IGNORE,
    ':term_allow' => TAXONOMY_ACCESS_TERM_ALLOW,
  ));
}

/**
 * Implements hook_schema().
 */
function taxonomy_access_schema() {
  $schema = array();
  $schema['taxonomy_access_term'] = array(
    'description' => 'Identifies which roles may view, update, delete, create, and list nodes with a given term.',
    'fields' => array(
      'tid' => array(
        'description' => 'The term_data.tid this record affects.  Overrides vocabulary default in taxonomy_access_default.',
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
        'default' => TAXONOMY_ACCESS_VOCABULARY_DEFAULT,
      ),
      'rid' => array(
        'description' => "The role.rid a user must possess to gain this row's privileges on nodes for this term.",
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
        'default' => 0,
      ),
      'grant_view' => array(
        'description' => 'Whether this role can view nodes with this term. 0=>Ignore, 1=>Allow, 2=>Deny.',
        'type' => 'int',
        'unsigned' => TRUE,
        'size' => 'tiny',
        'not null' => TRUE,
        'default' => TAXONOMY_ACCESS_NODE_IGNORE,
      ),
      'grant_update' => array(
        'description' => 'Whether this role can edit nodes with this term. 0=>Ignore, 1=>Allow, 2=>Deny.',
        'type' => 'int',
        'unsigned' => TRUE,
        'size' => 'tiny',
        'not null' => TRUE,
        'default' => TAXONOMY_ACCESS_NODE_IGNORE,
      ),
      'grant_delete' => array(
        'description' => 'Whether this role can delete nodes with this term. 0=>Ignore, 1=>Allow, 2=>Deny.',
        'type' => 'int',
        'unsigned' => TRUE,
        'size' => 'tiny',
        'not null' => TRUE,
        'default' => TAXONOMY_ACCESS_NODE_IGNORE,
      ),
      'grant_create' => array(
        'description' => 'Whether this role can set this term when adding or editing a node. 0=>No, 1=>Yes.',
        'type' => 'int',
        'unsigned' => TRUE,
        'size' => 'tiny',
        'not null' => TRUE,
        'default' => TAXONOMY_ACCESS_TERM_DENY,
      ),
      'grant_list' => array(
        'description' => 'Whether this role can view the name of this term on a node or in category lists. 0=>No, 1=>Yes.',
        'type' => 'int',
        'unsigned' => TRUE,
        'size' => 'tiny',
        'not null' => TRUE,
        'default' => TAXONOMY_ACCESS_TERM_ALLOW,
      ),
    ),
    'primary key' => array(
      'tid',
      'rid',
    ),
  );
  $schema['taxonomy_access_default'] = array(
    'description' => 'Sets vocabulary defaults for which roles may view, update, delete, create, and list nodes with a given term. Overridden by {taxonomy_access_term}.',
    'fields' => array(
      'vid' => array(
        'description' => 'The vocabulary.vid for which this row sets defaults.',
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
        'default' => TAXONOMY_ACCESS_VOCABULARY_DEFAULT,
      ),
      'rid' => array(
        'description' => "The role.rid a user must possess to gain this row's privileges on nodes for terms in this vocabulary.",
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
        'default' => 0,
      ),
      'grant_view' => array(
        'description' => 'Whether this role can view nodes with terms in this vocabulary. 0=>Ignore, 1=>Allow, 2=>Deny.',
        'type' => 'int',
        'unsigned' => TRUE,
        'size' => 'tiny',
        'not null' => TRUE,
        'default' => TAXONOMY_ACCESS_NODE_IGNORE,
      ),
      'grant_update' => array(
        'description' => 'Whether this role can edit nodes with terms in this vocabulary. 0=>Ignore, 1=>Allow, 2=>Deny.',
        'type' => 'int',
        'unsigned' => TRUE,
        'size' => 'tiny',
        'not null' => TRUE,
        'default' => TAXONOMY_ACCESS_NODE_IGNORE,
      ),
      'grant_delete' => array(
        'description' => 'Whether this role can delete nodes with terms in this vocabulary. 0=>Ignore, 1=>Allow, 2=>Deny.',
        'type' => 'int',
        'unsigned' => TRUE,
        'size' => 'tiny',
        'not null' => TRUE,
        'default' => TAXONOMY_ACCESS_NODE_IGNORE,
      ),
      'grant_create' => array(
        'description' => 'Whether this role can set terms in this vocabulary when adding or editing a node. 0=>No, 1=>Yes.',
        'type' => 'int',
        'unsigned' => TRUE,
        'size' => 'tiny',
        'not null' => TRUE,
        'default' => TAXONOMY_ACCESS_TERM_DENY,
      ),
      'grant_list' => array(
        'description' => 'Whether this role can view the name of terms in this vocabulary on a node or in category lists. 0=>No, 1=>Yes.',
        'type' => 'int',
        'unsigned' => TRUE,
        'size' => 'tiny',
        'not null' => TRUE,
        'default' => TAXONOMY_ACCESS_TERM_DENY,
      ),
    ),
    'primary key' => array(
      'vid',
      'rid',
    ),
  );
  return $schema;
}

/**
 * Add vocabulary defaults for all configured vocabularies.
 */
function taxonomy_access_update_7002() {

  // Get a list of all vocabularies with any term configurations for each role.
  $ta_configs = db_query("SELECT td.vid, ta.rid\n     FROM {taxonomy_access_term} ta\n     INNER JOIN {taxonomy_term_data} td ON ta.tid = td.tid\n     GROUP BY td.vid, ta.rid")
    ->fetchAll();

  // Get a list of all configured vocabularies.
  $td_configs = db_query("SELECT vid, rid\n     FROM {taxonomy_access_default}")
    ->fetchAll();
  $records = array();
  $global_defaults = taxonomy_access_global_defaults();
  foreach ($ta_configs as $config) {
    if (!in_array($config, $td_configs)) {
      $record = (array) $global_defaults[$config->rid];
      $records[] = _taxonomy_access_format_grant_record($config->vid, $config->rid, $record, TRUE);
    }
  }
  if (taxonomy_access_set_default_grants($records)) {
    return t('Update completed successfully.');
  }
  else {
    return t('Update failed.');
  }
}

/**
 * Rename grant realm.
 */
function taxonomy_access_update_7001() {
  db_query("UPDATE {node_access} SET realm = 'taxonomy_access_role'\n    WHERE realm = 'term_access'");
}

/**
 * Rename database tables to follow Drupal 7 standards.
 */
function taxonomy_access_update_7000() {
  db_rename_table('term_access', 'taxonomy_access_term');
  db_rename_table('term_access_defaults', 'taxonomy_access_default');
}

/**
 * Implements hook_enable().
 *
 * Housekeeping: while we were away, did you delete any terms/vocabs/roles?
 * 1: Weight this module below the Taxonomy module.
 * 2: Delete ta, tad rows for missing roles.
 * 3: Delete ta rows for missing terms.
 * 4: Delete tad rows for missing vocabs.
 */
function taxonomy_access_enable() {

  // Weight this module below the Taxonomy module.
  $tax_weight = db_query("SELECT weight FROM {system}\n      WHERE name = 'taxonomy'")
    ->fetchField();
  db_update('system')
    ->fields(array(
    'weight' => $tax_weight + 1,
  ))
    ->condition('name', 'taxonomy_access')
    ->execute();

  // Delete any records for roles not in {roles}.
  $roles = _taxonomy_access_user_roles();
  $config_roles = db_query("SELECT DISTINCT rid FROM {taxonomy_access_default}")
    ->fetchCol();
  $missing_roles = array_diff($config_roles, array_keys($roles));

  // Core flags node access for rebuild on enable, so skip node updates.
  foreach ($missing_roles as $rid) {
    taxonomy_access_delete_role_grants($rid, FALSE);
  }

  // Delete any term configurations not in {taxonomy_term_data}.
  $term_ids = db_query("SELECT ta.tid\n      FROM {taxonomy_access_term} ta\n      LEFT JOIN {taxonomy_term_data} td ON ta.tid = td.tid\n      WHERE ta.tid <> :tid AND td.tid IS NULL", array(
    ':tid' => TAXONOMY_ACCESS_VOCABULARY_DEFAULT,
  ))
    ->fetchCol();

  // Core flags node access for rebuild on enable, so skip node updates.
  taxonomy_access_delete_term_grants($term_ids, NULL, FALSE);
  unset($term_ids);

  // Delete any defaults for vocabularies not in {taxonomy_vocabulary}.
  $vocab_ids = db_query("SELECT tad.vid\n      FROM {taxonomy_access_default} tad\n      LEFT JOIN {taxonomy_vocabulary} tv ON tad.vid = tv.vid\n      WHERE tad.vid <> :vid AND tv.vid IS NULL", array(
    ':vid' => TAXONOMY_ACCESS_GLOBAL_DEFAULT,
  ))
    ->fetchCol();

  // Core flags node access for rebuild on enable, so skip node updates.
  taxonomy_access_delete_default_grants($vocab_ids, FALSE);
  unset($vocab_ids);
}

Functions

Name	Description
taxonomy_access_enable	Implements hook_enable().
taxonomy_access_install	Implements hook_install().
taxonomy_access_last_removed	Implements hook_update_last_removed().
taxonomy_access_schema	Implements hook_schema().
taxonomy_access_update_7000	Rename database tables to follow Drupal 7 standards.
taxonomy_access_update_7001	Rename grant realm.
taxonomy_access_update_7002	Add vocabulary defaults for all configured vocabularies.