<?php

/**

 * @file

 * Install, update and uninstall functions for the taxonomy module.

 */

/**

 * Implements hook_uninstall().

 */

function taxonomy_uninstall() {

  // Remove variables.

  variable_del('taxonomy_override_selector');

  variable_del('taxonomy_terms_per_page_admin');

  // Remove taxonomy_term bundles.

  $vocabularies = db_query("SELECT machine_name FROM {taxonomy_vocabulary}")->fetchCol();

  foreach ($vocabularies as $vocabulary) {

    field_attach_delete_bundle('taxonomy_term', $vocabulary);

  }

}

/**

 * Implements hook_schema().

 */

function taxonomy_schema() {

  $schema['taxonomy_term_data'] = array(

    'description' => 'Stores term information.',

    'fields' => array(

      'tid' => array(

        'type' => 'serial',

        'unsigned' => TRUE,

        'not null' => TRUE,

        'description' => 'Primary Key: Unique term ID.',

      ),

      'vid' => array(

        'type' => 'int',

        'unsigned' => TRUE,

        'not null' => TRUE,

        'default' => 0,

        'description' => 'The {taxonomy_vocabulary}.vid of the vocabulary to which the term is assigned.',

      ),

      'name' => array(

        'type' => 'varchar',

        'length' => 255,

        'not null' => TRUE,

        'default' => '',

        'description' => 'The term name.',

        'translatable' => TRUE,

      ),

      'description' => array(

        'type' => 'text',

        'not null' => FALSE,

        'size' => 'big',

        'description' => 'A description of the term.',

        'translatable' => TRUE,

      ),

      'format' => array(

        'type' => 'varchar',

        'length' => 255,

        'not null' => FALSE,

        'description' => 'The {filter_format}.format of the description.',

      ),

      'weight' => array(

        'type' => 'int',

        'not null' => TRUE,

        'default' => 0,

        'description' => 'The weight of this term in relation to other terms.',

      ),

    ),

    'primary key' => array('tid'),

    'foreign keys' => array(

      'vocabulary' => array(

        'table' => 'taxonomy_vocabulary',

        'columns' => array('vid' => 'vid'),

      ),

    ),

    'indexes' => array(

      'taxonomy_tree' => array('vid', 'weight', 'name'),

      'vid_name' => array('vid', 'name'),

      'name' => array('name'),

    ),

  );

  $schema['taxonomy_term_hierarchy'] = array(

    'description' => 'Stores the hierarchical relationship between terms.',

    'fields' => array(

      'tid' => array(

        'type' => 'int',

        'unsigned' => TRUE,

        'not null' => TRUE,

        'default' => 0,

        'description' => 'Primary Key: The {taxonomy_term_data}.tid of the term.',

      ),

      'parent' => array(

        'type' => 'int',

        'unsigned' => TRUE,

        'not null' => TRUE,

        'default' => 0,

        'description' => "Primary Key: The {taxonomy_term_data}.tid of the term's parent. 0 indicates no parent.",

      ),

    ),

    'indexes' => array(

      'parent' => array('parent'),

    ),

    'foreign keys' => array(

      'taxonomy_term_data' => array(

        'table' => 'taxonomy_term_data',

        'columns' => array('tid' => 'tid'),

      ),

    ),

    'primary key' => array('tid', 'parent'),

  );

  $schema['taxonomy_vocabulary'] = array(

    'description' => 'Stores vocabulary information.',

    'fields' => array(

      'vid' => array(

        'type' => 'serial',

        'unsigned' => TRUE,

        'not null' => TRUE,

        'description' => 'Primary Key: Unique vocabulary ID.',

      ),

      'name' => array(

        'type' => 'varchar',

        'length' => 255,

        'not null' => TRUE,

        'default' => '',

        'description' => 'Name of the vocabulary.',

        'translatable' => TRUE,

      ),

      'machine_name' => array(

        'type' => 'varchar',

        'length' => 255,

        'not null' => TRUE,

        'default' => '',

        'description' => 'The vocabulary machine name.',

      ),

      'description' => array(

        'type' => 'text',

        'not null' => FALSE,

        'size' => 'big',

        'description' => 'Description of the vocabulary.',

        'translatable' => TRUE,

      ),

      'hierarchy' => array(

        'type' => 'int',

        'unsigned' => TRUE,

        'not null' => TRUE,

        'default' => 0,

        'size' => 'tiny',

        'description' => 'The type of hierarchy allowed within the vocabulary. (0 = disabled, 1 = single, 2 = multiple)',

      ),

      'module' => array(

        'type' => 'varchar',

        'length' => 255,

        'not null' => TRUE,

        'default' => '',

        'description' => 'The module which created the vocabulary.',

      ),

      'weight' => array(

        'type' => 'int',

        'not null' => TRUE,

        'default' => 0,

        'description' => 'The weight of this vocabulary in relation to other vocabularies.',

      ),

    ),

    'primary key' => array('vid'),

    'indexes' => array(

      'list' => array('weight', 'name'),

    ),

    'unique keys' => array(

      'machine_name' => array('machine_name'),

    ),

  );

  $schema['taxonomy_index'] = array(

    'description' => 'Maintains denormalized information about node/term relationships.',

    'fields' => array(

      'nid' => array(

        'description' => 'The {node}.nid this record tracks.',

        'type' => 'int',

        'unsigned' => TRUE,

        'not null' => TRUE,

        'default' => 0,

      ),

      'tid' => array(

         'description' => 'The term ID.',

         'type' => 'int',

         'unsigned' => TRUE,

         'not null' => TRUE,

         'default' => 0,

      ),

      'sticky' => array(

        'description' => 'Boolean indicating whether the node is sticky.',

        'type' => 'int',

        'not null' => FALSE,

        'default' => 0,

        'size' => 'tiny',

      ),

      'created' => array(

        'description' => 'The Unix timestamp when the node was created.',

        'type' => 'int',

        'not null' => TRUE,

        'default'=> 0,

      ),

    ),

    'indexes' => array(

      'term_node' => array('tid', 'sticky', 'created'),

      'nid' => array('nid'),

    ),

    'foreign keys' => array(

      'tracked_node' => array(

        'table' => 'node',

        'columns' => array('nid' => 'nid'),

      ),

      'term' => array(

        'table' => 'taxonomy_term_data',

        'columns' => array('tid' => 'tid'),

      ),

    ),

  );

  return $schema;

}

/**

 * Implements hook_field_schema().

 */

function taxonomy_field_schema($field) {

  return array(

    'columns' => array(

      'tid' => array(

        'type' => 'int',

        'unsigned' => TRUE,

        'not null' => FALSE,

      ),

    ),

    'indexes' => array(

      'tid' => array('tid'),

    ),

    'foreign keys' => array(

      'tid' => array(

        'table' => 'taxonomy_term_data',

        'columns' => array('tid' => 'tid'),

      ),

    ),

  );

}

/**

 * Implements hook_update_dependencies().

 */

function taxonomy_update_dependencies() {

  // taxonomy_update_7004() migrates taxonomy term data to fields and therefore

  // must run after all Field modules have been enabled, which happens in

  // system_update_7027().

  $dependencies['taxonomy'][7004] = array(

    'system' => 7027,

  );

  return $dependencies;

}

/**

 * Utility function: get the list of vocabularies directly from the database.

 *

 * This function is valid for a database schema version 7002.

 *

 * @ingroup update_api

 */

function _update_7002_taxonomy_get_vocabularies() {

  return db_query('SELECT v.* FROM {taxonomy_vocabulary} v ORDER BY v.weight, v.name')->fetchAllAssoc('vid', PDO::FETCH_OBJ);

}

/**

 * Rename taxonomy tables.

 */

function taxonomy_update_7001() {

  db_rename_table('term_data', 'taxonomy_term_data');

  db_rename_table('term_hierarchy', 'taxonomy_term_hierarchy');

  db_rename_table('term_node', 'taxonomy_term_node');

  db_rename_table('term_relation', 'taxonomy_term_relation');

  db_rename_table('term_synonym', 'taxonomy_term_synonym');

  db_rename_table('vocabulary', 'taxonomy_vocabulary');

  db_rename_table('vocabulary_node_types', 'taxonomy_vocabulary_node_type');

}

/**

 * Add {vocabulary}.machine_name column.

 */

function taxonomy_update_7002() {

  $field = array(

    'type' => 'varchar',

    'length' => 255,

    'not null' => TRUE,

    'default' => '',

    'description' => 'The vocabulary machine name.',

  );

  db_add_field('taxonomy_vocabulary', 'machine_name', $field);

  // Do a direct query here, rather than calling taxonomy_get_vocabularies(),

  // in case Taxonomy module is disabled.

  $vids = db_query('SELECT vid FROM {taxonomy_vocabulary}')->fetchCol();

  foreach ($vids as $vid) {

    $machine_name = 'vocabulary_' . $vid;

    db_update('taxonomy_vocabulary')

      ->fields(array('machine_name' => $machine_name))

      ->condition('vid', $vid)

      ->execute();

  }

  // The machine_name unique key can only be added after we ensure the

  // machine_name column contains unique values.

  db_add_unique_key('taxonomy_vocabulary', 'machine_name', array('machine_name'));

}

/**

 * Remove the related terms setting from vocabularies.

 *

 * This setting has not been used since Drupal 6. The {taxonomy_relations} table

 * itself is retained to allow for data to be upgraded.

 */

function taxonomy_update_7003() {

  db_drop_field('taxonomy_vocabulary', 'relations');

}

/**

 * Move taxonomy vocabulary associations for nodes to fields and field instances.

 */

function taxonomy_update_7004() {

  $taxonomy_index = array(

    'description' => 'Maintains denormalized information about node/term relationships.',

    'fields' => array(

      'nid' => array(

        'description' => 'The {node}.nid this record tracks.',

        'type' => 'int',

        'unsigned' => TRUE,

        'not null' => TRUE,

        'default' => 0,

      ),

      'tid' => array(

         'description' => 'The term ID.',

         'type' => 'int',

         'unsigned' => TRUE,

         'not null' => TRUE,

         'default' => 0,

      ),

      'sticky' => array(

        'description' => 'Boolean indicating whether the node is sticky.',

        'type' => 'int',

        'not null' => FALSE,

        'default' => 0,

        'size' => 'tiny',

      ),

      'created' => array(

        'description' => 'The Unix timestamp when the node was created.',

        'type' => 'int',

        'unsigned' => TRUE,

        'not null' => TRUE,

        'default'=> 0,

      ),

    ),

    'indexes' => array(

      'term_node' => array('tid', 'sticky', 'created'),

      'nid' => array('nid'),

    ),

    'foreign keys' => array(

      'tracked_node' => array(

        'table' => 'node',

        'columns' => array('nid' => 'nid'),

      ),

      'term' => array(

        'table' => 'taxonomy_term_data',

        'columns' => array('tid' => 'tid'),

      ),

    ),

  );

  db_create_table('taxonomy_index', $taxonomy_index);

  // Use an inline version of Drupal 6 taxonomy_get_vocabularies() here since

  // we can no longer rely on $vocabulary->nodes from the API function.

  $result = db_query('SELECT v.*, n.type FROM {taxonomy_vocabulary} v LEFT JOIN {taxonomy_vocabulary_node_type} n ON v.vid = n.vid ORDER BY v.weight, v.name');

  $vocabularies = array();

  foreach ($result as $record) {

    // If no node types are associated with a vocabulary, the LEFT JOIN will

    // return a NULL value for type.

    if (isset($record->type)) {

      $node_types[$record->vid][$record->type] = $record->type;

      unset($record->type);

      $record->nodes = $node_types[$record->vid];

    }

    elseif (!isset($record->nodes)) {

      $record->nodes = array();

    }

    $vocabularies[$record->vid] = $record;

  }

  foreach ($vocabularies as $vocabulary) {

    $field_name = 'taxonomy_' . $vocabulary->machine_name;

    $field = array(

      'field_name' => $field_name,

      'module' => 'taxonomy',

      'type' => 'taxonomy_term_reference',

      'cardinality' => $vocabulary->multiple || $vocabulary->tags ? FIELD_CARDINALITY_UNLIMITED : 1,

      'settings' => array(

        'required' => $vocabulary->required ? TRUE : FALSE,

        'allowed_values' => array(

          array(

            'vocabulary' => $vocabulary->machine_name,

            'parent' => 0,

          ),

        ),

      ),

    );

    _update_7000_field_create_field($field);

    foreach ($vocabulary->nodes as $bundle) {

      $instance = array(

        'label' => $vocabulary->name,

        'field_name' => $field_name,

        'bundle' => $bundle,

        'entity_type' => 'node',

        'settings' => array(),

        'description' => $vocabulary->help,

        'required' => $vocabulary->required,

        'widget' => array(),

        'display' => array(

          'default' => array(

            'type' => 'taxonomy_term_reference_link',

            'weight' => 10,

          ),

          'teaser' => array(

            'type' => 'taxonomy_term_reference_link',

            'weight' => 10,

          ),

        ),

      );

      if ($vocabulary->tags) {

        $instance['widget'] = array(

          'type' => 'taxonomy_autocomplete',

          'module' => 'taxonomy',

          'settings' => array(

            'size' => 60,

            'autocomplete_path' => 'taxonomy/autocomplete',

          ),

        );

      }

      else {

        $instance['widget'] = array(

          'type' => 'select',

          'module' => 'options',

          'settings' => array(),

        );

      }

      _update_7000_field_create_instance($field, $instance);

    }

  }

  // Some contrib projects stored term node associations without regard for the

  // selections in the taxonomy_vocabulary_node_types table, or have more terms

  // for a single node than the vocabulary allowed. We construct the

  // taxonomyextra field to store all the extra stuff.

  // Allowed values for this extra vocabs field is every vocabulary.

  $allowed_values = array();

  foreach (_update_7002_taxonomy_get_vocabularies() as $vocabulary) {

    $allowed_values[] = array(

      'vocabulary' => $vocabulary->machine_name,

      'parent' => 0,

    );

  }

  $field_name = 'taxonomyextra';

  $field = array(

    'field_name' => $field_name,

    'module' => 'taxonomy',

    'type' => 'taxonomy_term_reference',

    'cardinality' => FIELD_CARDINALITY_UNLIMITED,

    'settings' => array(

      'required' => FALSE,

      'allowed_values' => $allowed_values,

    ),

  );

  _update_7000_field_create_field($field);

  foreach (_update_7000_node_get_types() as $bundle) {

    $instance = array(

      'label' => 'Taxonomy upgrade extras',

      'field_name' => $field_name,

      'entity_type' => 'node',

      'bundle' => $bundle->type,

      'settings' => array(),

      'description' => 'Debris left over after upgrade from Drupal 6',

      'required' => FALSE,

      'widget' => array(

        'type' => 'taxonomy_autocomplete',

        'module' => 'taxonomy',

        'settings' => array(),

      ),

      'display' => array(

        'default' => array(

          'type' => 'taxonomy_term_reference_link',

          'weight' => 10,

        ),

        'teaser' => array(

          'type' => 'taxonomy_term_reference_link',

          'weight' => 10,

        ),

      ),

    );

    _update_7000_field_create_instance($field, $instance);

  }

  $fields = array('help', 'multiple', 'required', 'tags');

  foreach ($fields as $field) {

    db_drop_field('taxonomy_vocabulary', $field);

  }

}

/**

 * Migrate {taxonomy_term_node} table to field storage.

 *

 * @todo: This function can possibly be made much faster by wrapping a

 * transaction around all the inserts.

 */

function taxonomy_update_7005(&$sandbox) {

  // $sandbox contents:

  // - total: The total number of term_node relationships to migrate.