feeds.install

<?php

/**
 * @file
 * Schema definitions install/update/uninstall hooks.
 */

/**
 * Implements hook_requirements().
 */
function feeds_requirements($phase) {
  $t = get_t();

  $requirements = array();

  module_load_include('module', 'feeds');
  // Check if we have any SimplePie importers.
  $needs_simplepie = FALSE;
  foreach (feeds_importer_load_all() as $importer) {
    if ($importer->config['parser']['plugin_key'] === 'FeedsSimplePieParser') {
      $needs_simplepie = TRUE;
      break;
    }
  }

  if (!$needs_simplepie) {
    return $requirements;
  }

  $requirements['simplepie'] = array(
    'title' => $t('SimplePie'),
    'value' => $t('Installed'),
    'description' => $t('The SimplePie library is required for Feeds SimplePie Parser.'),
    'severity' => REQUIREMENT_OK,
  );

  if (!feeds_simplepie_exists()) {
    $requirements['simplepie']['value'] = $t('Not installed');

    $folder = backdrop_get_path('module', 'feeds') . '/libraries';
    if (module_exists('libraries')) {
      $folder = 'sites/all/libraries/simplepie';
    }

    $args = array(
      '!url' => 'http://simplepie.org/downloads/',
      '%folder' => $folder,
      '%file' => 'simplepie.compiled.php',
    );
    $requirements['simplepie']['description'] .= $t('<br />Download the compiled, single-file version of the library from the <a href="!url">SimplePie download page</a>, place it into %folder and rename it to %file.', $args);
    $requirements['simplepie']['severity'] = REQUIREMENT_ERROR;
  }

  return $requirements;
}

/**
 * Implements 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' => 'blob',
        'size' => 'big',
        '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' => 'blob',
        'size' => 'big',
        'not null' => FALSE,
        'description' => 'Configuration of the source.',
        'serialize' => TRUE,
      ),
      'source' => array(
        'type' => 'text',
        'not null' => TRUE,
        'description' => 'Main source resource identifier. E. g. a path or a URL.',
      ),
      'state' => array(
        'type' => 'blob',
        'size' => 'big',
        'not null' => FALSE,
        'description' => 'State of import or clearing batches.',
        'serialize' => TRUE,
      ),
      'fetcher_result' => array(
        'type' => 'blob',
        'size' => 'big',
        'not null' => FALSE,
        'description' => 'Cache for fetcher result.',
        'serialize' => TRUE,
      ),
      'imported' => array(
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
        'unsigned' => TRUE,
        'description' => 'Timestamp when this source was imported last.',
      ),
    ),
    '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_item'] = array(
    'description' => 'Tracks items such as nodes, terms, users.',
    'fields' => array(
      'entity_type' => array(
        'type' => 'varchar',
        'length' => 32,
        'not null' => TRUE,
        'default' => '',
        'description' => 'The entity type.',
      ),
      'entity_id' => array(
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
        'description' => 'The imported entity\'s serial id.',
      ),
      'id' => array(
        'type' => 'varchar',
        'length' => 128,
        'not null' => TRUE,
        'default' => '',
        'description' => 'The id of the importer that created this item.',
      ),
      'feed_nid' => array(
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
        'description' => 'Node id of the source, if available.',
      ),
      'imported' => array(
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
        'description' => 'Import date of the feed item, as a Unix timestamp.',
      ),
      'url' => array(
        'type' => 'text',
        'not null' => TRUE,
        'description' => 'Link to the feed item.',
      ),
      'guid' => array(
        'type' => 'text',
        'not null' => TRUE,
        'description' => 'Unique identifier for the feed item.'
      ),
      'hash' => array(
        'type' => 'varchar',
        'length' => 32, // The length of an MD5 hash.
        'not null' => TRUE,
        'default' => '',
        'description' => 'The hash of the source item.',
      ),
    ),
    'primary key' => array('entity_type', 'entity_id'),
    'indexes' => array(
      'id' => array('id'),
      'feed_nid' => array('feed_nid'),
      'lookup_url' => array('entity_type', 'id', 'feed_nid', array('url', 128)),
      'lookup_guid' => array('entity_type', 'id', 'feed_nid', array('guid', 128)),
      'global_lookup_url' => array('entity_type', array('url', 128)),
      'global_lookup_guid' => array('entity_type', array('guid', 128)),
      'imported' => array('imported'),
    ),
  );
  $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' => 'The URL of the hub endpoint of this subscription.',
      ),
      'topic' => array(
        'type' => 'text',
        'not null' => TRUE,
        'description' => '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'),
    ),
  );
  $schema['feeds_log'] = array(
    'description' => 'Table that contains logs of feeds events.',
    'fields' => array(
      'flid' => array(
        'type' => 'serial',
        'not null' => TRUE,
        'description' => 'Primary Key: Unique feeds event ID.',
      ),
      'id' => array(
        'type' => 'varchar',
        'length' => 128,
        'not null' => TRUE,
        'default' => '',
        'description' => 'The id of the importer that logged the event.',
      ),
      'feed_nid' => array(
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
        'description' => 'Node id of the source, if available.',
      ),
      'log_time' => array(
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
        'description' => 'Unix timestamp of when event occurred.',
      ),
      'request_time' => array(
        'type' => 'int',
        'not null' => TRUE,
        'default' => 0,
        'description' => 'Unix timestamp of the request when the event occurred.',
      ),
      'type' => array(
        'type' => 'varchar',
        'length' => 64,
        'not null' => TRUE,
        'default' => '',
        'description' => 'Type of log message, for example "feeds_import"."',
      ),
      'message' => array(
        'type' => 'text',
        'not null' => TRUE,
        'size' => 'big',
        'description' => 'Text of log message to be passed into the t() function.',
      ),
      'variables' => array(
        'type' => 'blob',
        'not null' => TRUE,
        'size' => 'big',
        'description' => 'Serialized array of variables that match the message string and that is passed into the t() function.',
      ),
      'severity' => array(
        'type' => 'int',
        'unsigned' => TRUE,
        'not null' => TRUE,
        'default' => 0,
        'size' => 'tiny',
        'description' => 'The severity level of the event; ranges from 0 (Emergency) to 7 (Debug)',
      ),
    ),
    'primary key' => array('flid'),
    'indexes' => array(
      'id' => array('id'),
      'id_feed_nid' => array('id', 'feed_nid'),
      'request_time' => array('request_time'),
      'log_time' => array('log_time'),
      'type' => array('type'),
    ),
  );

  $schema['cache_feeds_http'] = backdrop_get_schema_unprocessed('system', 'cache');
  $schema['cache_feeds_http']['description'] = 'Cache table for Feeds downloads.';

  return $schema;
}










function feeds_update_1000() {
  $config = config('feeds.settings');

  $config->set('feeds_reschedule', update_variable_get('feeds_reschedule'));
  $config->set('feeds_debug', update_variable_get('feeds_debug'));
  $config->set('feeds_importer_class', update_variable_get('feeds_importer_class'));
  $config->set('feeds_library_dir', update_variable_get('feeds_library_dir'));

  $config->set('default_feeds_importer', update_variable_get('default_feeds_importer'));
  $config->set('menu_rebuild_needed', update_variable_get('menu_rebuild_needed'));
  $config->set('feeds_source_class', update_variable_get('feeds_source_class'));
  $config->set('http_request_timeout', update_variable_get('http_request_timeout'));

  $config->set('proxy_server', update_variable_get('proxy_server'));
  $config->set('proxy_port', update_variable_get('proxy_port'));
  $config->set('proxy_username', update_variable_get('proxy_username'));
  $config->set('proxy_password', update_variable_get('proxy_password'));

  $config->set('proxy_auth_method', update_variable_get('proxy_auth_method'));
  $config->set('feeds_never_use_curl', update_variable_get('feeds_never_use_curl'));
  $config->set('feeds_library_dir', update_variable_get('feeds_library_dir'));
  $config->set('feeds_process_limit', update_variable_get('feeds_process_limit'));
  $config->set('default_nodes_main', update_variable_get('default_nodes_main'));

  $config->save();

  // Delete variables.
  update_variable_del('feeds_reschedule');
  update_variable_del('feeds_debug');
  update_variable_del('feeds_importer_class');
  update_variable_del('feeds_library_dir');

  update_variable_del('default_feeds_importer');
  update_variable_del('menu_rebuild_needed');
  update_variable_del('feeds_source_class');
  update_variable_del('http_request_timeout');

  update_variable_del('proxy_server');
  update_variable_del('proxy_port');
  update_variable_del('proxy_username');
  update_variable_del('proxy_password');

  update_variable_del('proxy_auth_method');
  update_variable_del('feeds_never_use_curl');
  update_variable_del('feeds_library_dir');
  update_variable_del('feeds_process_limit');
  update_variable_del('default_nodes_main');
}