-
Alex Barth authoredAlex Barth authored
feeds.install 14.12 KiB
<?php
// $Id$
/**
* @file
* Schema definitions install/update/uninstall hooks.
*/
/**
* Implementation of hook_schema().
*/
function feeds_schema() {
$schema = array();
$schema['feeds_importer'] = array(
'description' => 'Configuration of feeds objects.',
'export' => array(
'key' => 'id',
'identifier' => 'feeds_importer',
'default hook' => 'feeds_importer_default', // Function hook name.
'api' => array(
'owner' => 'feeds',
'api' => 'feeds_importer_default', // Base name for api include files.
'minimum_version' => 1,
'current_version' => 1,
),
),
'fields' => array(
'id' => array(
'type' => 'varchar',
'length' => 128,
'not null' => TRUE,
'default' => '',
'description' => 'Id of the fields object.',
),
'config' => array(
'type' => 'text',
'not null' => FALSE,
'description' => 'Configuration of the feeds object.',
'serialize' => TRUE,
),
),
'primary key' => array('id'),
);
$schema['feeds_source'] = array(
'description' => 'Source definitions for feeds.',
'fields' => array(
'id' => array(
'type' => 'varchar',
'length' => 128,
'not null' => TRUE,
'default' => '',
'description' => 'Id of the feed configuration.',
),
'feed_nid' => array(
'type' => 'int',
'not null' => TRUE,
'default' => 0,
'unsigned' => TRUE,
'description' => 'Node nid if this particular source is attached to a feed node.',
),
'config' => array(
'type' => 'text',
'not null' => FALSE,
'description' => 'Configuration of the source.',
'serialize' => TRUE,
),
'source' => array(
'type' => 'text',
'not null' => TRUE, 'description' => t('Main source resource identifier. E. g. a path or a URL.'),
),
'batch' => array(
'type' => 'text',
'size' => 'big',
'not null' => FALSE,
'description' => t('Cache for batching.'),
'serialize' => TRUE,
),
),
'primary key' => array('id', 'feed_nid'),
'indexes' => array(
'id' => array('id'),
'feed_nid' => array('feed_nid'),
'id_source' => array('id', array('source', 128)),
),
);
$schema['feeds_schedule'] = array(
'description' => t('Contains feeds scheduled for refresh.'),
'fields' => array(
'feed_nid' => array(
'type' => 'int',
'not null' => TRUE,
'default' => 0,
'unsigned' => TRUE,
'description' => 'Node nid if this particular source is attached to a feed node.',
),
'id' => array(
'type' => 'varchar',
'length' => 128,
'not null' => TRUE,
'default' => '',
'description' => 'Id of the feed configuration.',
),
'callback' => array(
'type' => 'varchar',
'length' => 128,
'not null' => TRUE,
'default' => '',
'description' => 'Callback to be invoked.',
),
'last_executed_time' => array(
'type' => 'int',
'unsigned' => TRUE,
'default' => 0,
'not null' => TRUE,
'description' => 'Timestamp when a job was last executed.',
),
'scheduled' => array(
'type' => 'int',
'unsigned' => TRUE,
'default' => 0,
'not null' => TRUE,
'description' => 'Timestamp when a job was scheduled. 0 if a job is currently not scheduled.',
),
),
'indexes' => array(
'feed_nid' => array('feed_nid'),
'id' => array('id'),
'id_callback' => array('id', 'callback'),
'last_executed_time' => array('last_executed_time'),
'scheduled' => array('scheduled'),
),
);
$schema['feeds_node_item'] = array(
'description' => t('Stores additional information about feed item nodes. Used by FeedsNodeProcessor.'),
'fields' => array(
'nid' => array(
'type' => 'int',
'unsigned' => TRUE, 'not null' => TRUE,
'description' => t("Primary Key: The feed item node's nid."),
),
'id' => array(
'type' => 'varchar',
'length' => 128,
'not null' => TRUE,
'default' => '',
'description' => 'The id of the fields object that is the producer of this item.',
),
'feed_nid' => array(
'type' => 'int',
'unsigned' => TRUE,
'not null' => TRUE,
'description' => t("Node id of the owner feed, if available."),
),
'imported' => array(
'type' => 'int',
'not null' => TRUE,
'default' => 0,
'description' => t('Import date of the feed item, as a Unix timestamp.'),
),
'url' => array(
'type' => 'text',
'not null' => TRUE,
'description' => t('Link to the feed item.'),
),
'guid' => array(
'type' => 'text',
'not null' => TRUE,
'description' => t('Unique identifier for the feed item.'),
),
'hash' => array(
'type' => 'varchar',
'length' => 32, // The length of an MD5 hash.
'not null' => TRUE,
'default' => '',
'description' => t('The hash of the item.'),
),
),
'primary key' => array('nid'),
'indexes' => array(
'id' => array('id'),
'feed_nid' => array('feed_nid'),
'imported' => array('imported'),
'url' => array(array('url', 255)),
'guid' => array(array('guid', 255)),
),
);
$schema['feeds_push_subscriptions'] = array(
'description' => 'PubSubHubbub subscriptions.',
'fields' => array(
'domain' => array(
'type' => 'varchar',
'length' => 128,
'not null' => TRUE,
'default' => '',
'description' => 'Domain of the subscriber. Corresponds to an importer id.',
),
'subscriber_id' => array(
'type' => 'int',
'not null' => TRUE,
'default' => 0,
'unsigned' => TRUE,
'description' => 'ID of the subscriber. Corresponds to a feed nid.',
),
'timestamp' => array(
'type' => 'int',
'unsigned' => FALSE,
'default' => 0, 'not null' => TRUE,
'description' => 'Created timestamp.',
),
'hub' => array(
'type' => 'text',
'not null' => TRUE,
'description' => t('The URL of the hub endpoint of this subscription.'),
),
'topic' => array(
'type' => 'text',
'not null' => TRUE,
'description' => t('The topic URL (feed URL) of this subscription.'),
),
'secret' => array(
'type' => 'varchar',
'length' => 128,
'not null' => TRUE,
'default' => '',
'description' => 'Shared secret for message authentication.',
),
'status' => array(
'type' => 'varchar',
'length' => 64,
'not null' => TRUE,
'default' => '',
'description' => 'Status of subscription.',
),
'post_fields' => array(
'type' => 'text',
'not null' => FALSE,
'description' => 'Fields posted.',
'serialize' => TRUE,
),
),
'primary key' => array('domain', 'subscriber_id'),
'indexes' => array(
'timestamp' => array('timestamp'),
),
);
return $schema;
}
/**
* Implementation of hook_install().
*/
function feeds_install() {
// Create tables.
drupal_install_schema('feeds');
}
/**
* Implementation of hook_uninstall().
*/
function feeds_uninstall() {
// Remove tables.
drupal_uninstall_schema('feeds');
}
/**
* Remove class field on feeds_config.
*/
function feeds_update_6001() {
$ret = array();
db_drop_field($ret, 'feeds_config', 'class');
return $ret;
}
/**
* Rename table.
*/function feeds_update_6002() {
$ret = array();
db_rename_table($ret, 'feeds_config', 'feeds_importer');
return $ret;
}
/**
* Add primary keys to feeds_importer and feeds_source.
*/
function feeds_update_6003() {
$ret = array();
db_drop_index($ret, 'feeds_importer', 'id');
db_add_primary_key($ret, 'feeds_importer', array('id'));
db_add_primary_key($ret, 'feeds_source', array('id', 'feed_nid'));
return $ret;
}
/**
* Add source field to feeds_source, make fields part of PKs not null.
*/
function feeds_update_6004() {
$ret = array();
$spec = array(
'type' => 'text',
'not null' => TRUE,
'description' => t('Main source resource identifier. E. g. a path or a URL.'),
);
db_add_field($ret, 'feeds_source', 'source', $spec);
db_add_index($ret, 'feeds_source', 'id_source', array('id', array('source', 255)));
// Make feed_nid not null, default 0. It is part of the primary key.
$spec = array(
'type' => 'int',
'not null' => TRUE,
'default' => 0,
'unsigned' => TRUE,
'description' => 'Node nid if this particular source is attached to a feed node.',
);
db_change_field($ret, 'feeds_schedule', 'feed_nid', 'feed_nid', $spec);
// Same thing for feeds_source table.
$spec = array(
'type' => 'int',
'not null' => TRUE,
'default' => 0,
'unsigned' => TRUE,
'description' => 'Node nid if this particular source is attached to a feed node.',
);
db_change_field($ret, 'feeds_source', 'feed_nid', 'feed_nid', $spec);
return $ret;
}
/**
* Add callback column to feeds_schedule.
*/
function feeds_update_6005() {
$ret = array();
// Add a callback column and an index.
$spec = array(
'type' => 'varchar',
'length' => 128,
'not null' => TRUE,
'default' => '',
'description' => 'Callback to be invoked.',
);
db_add_field($ret, 'feeds_schedule', 'callback', $spec);
db_add_index($ret, 'feeds_schedule', 'id_callback', array('id', 'callback'));
return $ret;
}
/**
* Remove primary key from feeds_schedule and replace it by an index.
*/
function feeds_update_6006() {
$ret = array();
db_drop_primary_key($ret, 'feeds_schedule');
db_add_index($ret, 'feeds_schedule', 'feed_nid', array('feed_nid'));
return $ret;
}
/**
* Add hash column to feeds_node_item.
*/
function feeds_update_6007() {
$ret = array();
$spec = array(
'type' => 'varchar',
'length' => 32,
'not null' => TRUE,
'default' => '',
'description' => t('The hash of the item.'),
);
db_add_field($ret, 'feeds_node_item', 'hash', $spec);
return $ret;
}
/**
* Add batch field to feeds_source table, adjust feeds_schedule table.
*/
function feeds_update_6008() {
$ret = array();
$spec = array(
'type' => 'text',
'size' => 'big',
'not null' => FALSE,
'description' => t('Cache for batching.'),
'serialize' => TRUE,
);
db_add_field($ret, 'feeds_source', 'batch', $spec);
// Make scheduled flag a timestamp.
$spec = array(
'type' => 'int',
'size' => 'normal',
'unsigned' => TRUE,
'default' => 0,
'not null' => TRUE,
'description' => 'Timestamp when a job was scheduled. 0 if a job is currently not scheduled.',
);
db_change_field($ret, 'feeds_schedule', 'scheduled', 'scheduled', $spec);
// Rename last_scheduled_time to last_executed_time, fix unsigned property.
$spec = array(
'type' => 'int',
'size' => 'normal',
'unsigned' => TRUE,
'default' => 0,
'not null' => TRUE,
'description' => 'Timestamp when a job was last executed.', );
db_change_field($ret, 'feeds_schedule', 'last_scheduled_time', 'last_executed_time', $spec);
return $ret;
}
/**
* Add feeds_push_subscriptions tables.
*/
function feeds_update_6009() {
$ret = array();
$table = array(
'description' => 'PubSubHubbub subscriptions.',
'fields' => array(
'domain' => array(
'type' => 'varchar',
'length' => 128,
'not null' => TRUE,
'default' => '',
'description' => 'Domain of the subscriber. Corresponds to an importer id.',
),
'subscriber_id' => array(
'type' => 'int',
'not null' => TRUE,
'default' => 0,
'unsigned' => TRUE,
'description' => 'ID of the subscriber. Corresponds to a feed nid.',
),
'timestamp' => array(
'type' => 'int',
'unsigned' => FALSE,
'default' => 0,
'not null' => TRUE,
'description' => 'Created timestamp.',
),
'hub' => array(
'type' => 'text',
'not null' => TRUE,
'description' => t('The URL of the hub endpoint of this subscription.'),
),
'topic' => array(
'type' => 'text',
'not null' => TRUE,
'description' => t('The topic URL (feed URL) of this subscription.'),
),
'secret' => array(
'type' => 'varchar',
'length' => 128,
'not null' => TRUE,
'default' => '',
'description' => 'Shared secret for message authentication.',
),
'status' => array(
'type' => 'varchar',
'length' => 64,
'not null' => TRUE,
'default' => '',
'description' => 'Status of subscription.',
),
'post_fields' => array(
'type' => 'text',
'not null' => FALSE,
'description' => 'Fields posted.',
'serialize' => TRUE,
),
),
'primary key' => array('domain', 'subscriber_id'),
'indexes' => array(
'timestamp' => array('timestamp'),
), );
db_create_table($ret, 'feeds_push_subscriptions', $table);
return $ret;
}
/**
* Enable all Feeds News, Feeds Import and Feeds fast news features.
*/
function feeds_update_6010() {
drupal_install_modules(array('feeds_news', 'feeds_import'));
if (module_exists('data')) {
drupal_install_modules(array('feeds_fast_news'));
drupal_set_message(t('Installed Feeds News, Feeds Fast News and Feeds Import as replacement for Feeds Defaults module.'));
}
else {
drupal_set_message(t('Installed Feeds News and Feeds Import as replacement for Feeds Defaults module.'));
}
if (module_exists('features')) {
drupal_set_message(t('Replacement features have been installed. <strong>Review enabled state of importer configurations on admin/build/feeds and features on admin/build/features.</strong>'));
}
else {
drupal_set_message(t('Replacement modules have been installed. <strong>Review enabled state of importer configurations on admin/build/feeds and Feeds modules on admin/build/modules.</strong>'));
}
return array();
}