ding_campaign.install

<?php 
/**
 * @file ding_campaign.install
 * Installation and upgrade hooks for the ding_campaign module.
 */

/**
 * Implementation of hook_install().
 */
function ding_campaign_install() {
  drupal_install_schema('ding_campaign');
  variable_set('admin_theme_ding_campaign_ding_campaign_rules', 1);
}

/**
 * Implementation of hook_uninstall().
 */
function ding_campaign_uninstall() {
  drupal_uninstall_schema('ding_campaign');
  variable_del('admin_theme_ding_campaign_ding_campaign_rules');
}

/**
 * Implementation of hook_schema().
 */
function ding_campaign_schema() {  
  $schema['ding_campaign'] = array(
    'fields' => array(
      'vid' => array(
        'type' => 'int', 
        'unsigned' => TRUE, 
        'not null' => TRUE, 
        'description' => '{node}.vid for node',
      ),
      'nid' => array(
        'type' => 'int', 
        'unsigned' => TRUE,
        'not null' => TRUE,
        'description' => '{node}.nid for node',
      ),
      'campaign_type' => array(
        'type' => 'varchar',
        'length' => 50,
        'default' => 'normal',
        'description' => 'The campaign type, image-only, text-only, etc.',
      ),
      'campaign_theme' => array(
        'type' => 'varchar',
        'length' => 50,
        'default' => 'normal',
        'description' => 'The campaign colour scheme.',
      ),
      'campaign_weight' => array(
        'type' => 'int',
        'size' => 'tiny',
        'not null' => TRUE,
        'default' => 0,
      ),
    ),
    'primary key' => array('vid', 'nid'),
    'indexes' => array(
      'nid' => array('nid'),
      'campaign_weight' => array('campaign_weight'),
    ),
  );

  $schema['ding_campaign_rule'] = array(
    'fields' => array(
      'nid' => array(
        'type' => 'int', 
        'unsigned' => TRUE,
        'not null' => TRUE,
        'description' => '{node}.nid for node',
      ),
      'status' => array(
        'description' => 'Denormalised mirror of {node}.status so we can filter out unpublished campaigns without requiring a JOIN', 
        'type' => 'int', 
        'size' => 'tiny',
        'not null' => TRUE, 
        'default' => 0,
      ),
      'delta' => array(
        'type' => 'int', 
        'unsigned' => TRUE,
        'not null' => TRUE,
        'description' => 'Rule number - unique per node.',
      ),
      'type' => array(
        'type' => 'varchar',
        'length' => 50,
        'description' => 'Rule type - one of library, page, taxonomy and search_term',
      ),
      'value' => array(
        'type' => 'varchar',
        'length' => 255,
        'description' => 'Rule value, text-version. Canonical for search term only',
      ),
      'value_id' => array(
        'type' => 'int',
        'unsigned' => true,
        'not null' => FALSE,
        'description' => 'Rule value ID. For the applicable types it serves as a foreign key to nodes, terms, etc.',
      ),
    ),
    'primary key' => array('nid', 'delta'),
    'indexes' => array(
      'nid_status' => array('nid', 'status'),
      'type' => array('type'),
      'value' => array('value'),
      'value_id' => array('value_id'),
    ), 
  );

  return $schema;
}

/**
 * Implementation of hook_update_N().
 *
 * Rename system_path to path to reflect that they now work for both
 * system paths and path aliases.
 */
function ding_campaign_update_6001(&$sandbox) {
  $ret = array();

  $ret[] = update_sql("UPDATE {ding_campaign_rule} SET `type` = 'path' WHERE `type` = 'system_path';");

  return $ret;
}

/**
 * Implementation of hook_update_N().
 *
 * Remove campaign rules on non-campaign nodes.
 */
function ding_campaign_update_6002(&$sandbox) {
  $ret = array();

  $ret[] = update_sql("
    DELETE dcr FROM {ding_campaign_rule} AS dcr
    LEFT JOIN {node} AS n USING(nid)
    WHERE n.type != 'campaign';
  ");

  return $ret;
}

/**
 * Implementation of hook_update_N().
 *
 * Create cache table for Ding campaigns.
 */
function ding_campaign_update_6003(&$sandbox) {
  $ret = array();

  db_create_table($ret, 'cache_ding_campaign',
                  drupal_get_schema_unprocessed('system', 'cache'));
  return $ret;
}

/**
 * Implementation of hook_update_N().
 *
 * Delete cache table for Ding campaigns.
 */
function ding_campaign_update_6004(&$sandbox) {
  $ret = array();

  db_drop_table($ret, 'cache_ding_campaign');

  return $ret;
}

/**
 * Add status column to campaign rule table.
 */
function ding_campaign_update_6005(&$sandbox) {
  $ret = array();

  db_add_field($ret, 'ding_campaign_rule', 'status', array(
    'type' => 'int', 
    'size' => 'tiny',
    'not null' => TRUE, 
    'default' => 0,
  ));

  // Add status to the index, since we always filter on it.
  db_drop_index($ret, 'ding_campaign_rule', 'nid');
  db_add_index($ret, 'ding_campaign_rule', 'nid_status', array('nid', 'status'));

  return $ret;
}

/**
 * Set rule status from node table.
 */
function ding_campaign_update_6006(&$sandbox) {
  $ret = array();

  $ret[] = update_sql("
    UPDATE {ding_campaign_rule} AS dcr
    LEFT JOIN node AS n USING (nid)
    SET dcr.status = n.status
    WHERE n.status <> 0
  ");

  return $ret;
}