<?php

// $Id: aggregator.module,v 1.374.2.5 2009/03/30 12:15:53 goba Exp $

/**

 * @file

 * Used to aggregate syndicated content (RSS, RDF, and Atom).

 */

/**

 * Implementation of hook_help().

 */

function aggregator_help($path, $arg) {

  switch ($path) {

    case 'admin/help#aggregator':

      $output = '<p>'. t('The aggregator is a powerful on-site syndicator and news reader that gathers fresh content from RSS-, RDF-, and Atom-based feeds made available across the web. Thousands of sites (particularly news sites and blogs) publish their latest headlines and posts in feeds, using a number of standardized XML-based formats. Formats supported by the aggregator include <a href="@rss">RSS</a>, <a href="@rdf">RDF</a>, and <a href="@atom">Atom</a>.', array('@rss' => 'http://cyber.law.harvard.edu/rss/', '@rdf' => 'http://www.w3.org/RDF/', '@atom' => 'http://www.atomenabled.org')) .'</p>';

      $output .= '<p>'. t('Feeds contain feed items, or individual posts published by the site providing the feed. Feeds may be grouped in categories, generally by topic. Users view feed items in the <a href="@aggregator">main aggregator display</a> or by <a href="@aggregator-sources">their source</a>. Administrators can <a href="@feededit">add, edit and delete feeds</a> and choose how often to check each feed for newly updated items. The most recent items in either a feed or category can be displayed as a block through the <a href="@admin-block">blocks administration page</a>. A <a href="@aggregator-opml">machine-readable OPML file</a> of all feeds is available. A correctly configured <a href="@cron">cron maintenance task</a> is required to update feeds automatically.', array('@aggregator' => url('aggregator'), '@aggregator-sources' => url('aggregator/sources'), '@feededit' => url('admin/content/aggregator'), '@admin-block' => url('admin/build/block'), '@aggregator-opml' => url('aggregator/opml'), '@cron' => url('admin/reports/status'))) .'</p>';

      $output .= '<p>'. t('For more information, see the online handbook entry for <a href="@aggregator">Aggregator module</a>.', array('@aggregator' => 'http://drupal.org/handbook/modules/aggregator/')) .'</p>';

      return $output;

    case 'admin/content/aggregator':

      $output = '<p>'. t('Thousands of sites (particularly news sites and blogs) publish their latest headlines and posts in feeds, using a number of standardized XML-based formats. Formats supported by the aggregator include <a href="@rss">RSS</a>, <a href="@rdf">RDF</a>, and <a href="@atom">Atom</a>.', array('@rss' => 'http://cyber.law.harvard.edu/rss/', '@rdf' => 'http://www.w3.org/RDF/', '@atom' => 'http://www.atomenabled.org')) .'</p>';

      $output .= '<p>'. t('Current feeds are listed below, and <a href="@addfeed">new feeds may be added</a>. For each feed or feed category, the <em>latest items</em> block may be enabled at the <a href="@block">blocks administration page</a>.', array('@addfeed' => url('admin/content/aggregator/add/feed'), '@block' => url('admin/build/block'))) .'</p>';

      return $output;

    case 'admin/content/aggregator/add/feed':

      return '<p>'. t('Add a feed in RSS, RDF or Atom format. A feed may only have one entry.') .'</p>';

    case 'admin/content/aggregator/add/category':

      return '<p>'. t('Categories allow feed items from different feeds to be grouped together. For example, several sport-related feeds may belong to a category named <em>Sports</em>. Feed items may be grouped automatically (by selecting a category when creating or editing a feed) or manually (via the <em>Categorize</em> page available from feed item listings). Each category provides its own feed page and block.') .'</p>';

  }

}

/**

 * Implementation of hook_theme()

 */

function aggregator_theme() {

  return array(

    'aggregator_wrapper' => array(

      'arguments' => array('content' => NULL),

      'file' => 'aggregator.pages.inc',

      'template' => 'aggregator-wrapper',

    ),

    'aggregator_categorize_items' => array(

      'arguments' => array('form' => NULL),

      'file' => 'aggregator.pages.inc',

    ),

    'aggregator_feed_source' => array(

      'arguments' => array('feed' => NULL),

      'file' => 'aggregator.pages.inc',

      'template' => 'aggregator-feed-source',

    ),

    'aggregator_block_item' => array(

      'arguments' => array('item' => NULL, 'feed' => 0),

    ),

    'aggregator_summary_items' => array(

      'arguments' => array('summary_items' => NULL, 'source' => NULL),

      'file' => 'aggregator.pages.inc',

      'template' => 'aggregator-summary-items',

    ),

    'aggregator_summary_item' => array(

      'arguments' => array('item' => NULL),

      'file' => 'aggregator.pages.inc',

      'template' => 'aggregator-summary-item',

    ),

    'aggregator_item' => array(

      'arguments' => array('item' => NULL),

      'file' => 'aggregator.pages.inc',

      'template' => 'aggregator-item',

    ),

    'aggregator_page_opml' => array(

      'arguments' => array('feeds' => NULL),

      'file' => 'aggregator.pages.inc',

    ),

    'aggregator_page_rss' => array(

      'arguments' => array('feeds' => NULL, 'category' => NULL),

      'file' => 'aggregator.pages.inc',

    ),

  );

}

/**

 * Implementation of hook_menu().

 */

function aggregator_menu() {

  $items['admin/content/aggregator'] = array(

    'title' => 'Feed aggregator',

    'description' => "Configure which content your site aggregates from other sites, how often it polls them, and how they're categorized.",

    'page callback' => 'aggregator_admin_overview',

    'access arguments' => array('administer news feeds'),

    'file' => 'aggregator.admin.inc',

  );

  $items['admin/content/aggregator/add/feed'] = array(

    'title' => 'Add feed',

    'page callback' => 'drupal_get_form',

    'page arguments' => array('aggregator_form_feed'),

    'access arguments' => array('administer news feeds'),

    'type' => MENU_LOCAL_TASK,

    'parent' => 'admin/content/aggregator',

    'file' => 'aggregator.admin.inc',

  );

  $items['admin/content/aggregator/add/category'] = array(

    'title' => 'Add category',

    'page callback' => 'drupal_get_form',

    'page arguments' => array('aggregator_form_category'),

    'access arguments' => array('administer news feeds'),

    'type' => MENU_LOCAL_TASK,

    'parent' => 'admin/content/aggregator',

    'file' => 'aggregator.admin.inc',

  );

  $items['admin/content/aggregator/remove/%aggregator_feed'] = array(

    'title' => 'Remove items',

    'page callback' => 'drupal_get_form',

    'page arguments' => array('aggregator_admin_remove_feed', 4),

    'access arguments' => array('administer news feeds'),

    'type' => MENU_CALLBACK,

    'file' => 'aggregator.admin.inc',

  );

  $items['admin/content/aggregator/update/%aggregator_feed'] = array(

    'title' => 'Update items',

    'page callback' => 'aggregator_admin_refresh_feed',

    'page arguments' => array(4),

    'access arguments' => array('administer news feeds'),

    'type' => MENU_CALLBACK,

    'file' => 'aggregator.admin.inc',

  );

  $items['admin/content/aggregator/list'] = array(

    'title' => 'List',

    'type' => MENU_DEFAULT_LOCAL_TASK,

    'weight' => -10,

  );

  $items['admin/content/aggregator/settings'] = array(

    'title' => 'Settings',

    'page callback' => 'drupal_get_form',

    'page arguments' => array('aggregator_admin_settings'),

    'type' => MENU_LOCAL_TASK,

    'weight' => 10,

    'access arguments' => array('administer news feeds'),

    'file' => 'aggregator.admin.inc',

  );

  $items['aggregator'] = array(

    'title' => 'Feed aggregator',

    'page callback' => 'aggregator_page_last',

    'access arguments' => array('access news feeds'),

    'weight' => 5,

    'file' => 'aggregator.pages.inc',

  );

  $items['aggregator/sources'] = array(

    'title' => 'Sources',

    'page callback' => 'aggregator_page_sources',

    'access arguments' => array('access news feeds'),

    'file' => 'aggregator.pages.inc',

  );

  $items['aggregator/categories'] = array(

    'title' => 'Categories',

    'page callback' => 'aggregator_page_categories',

    'access callback' => '_aggregator_has_categories',

    'file' => 'aggregator.pages.inc',

  );

  $items['aggregator/rss'] = array(

    'title' => 'RSS feed',

    'page callback' => 'aggregator_page_rss',

    'access arguments' => array('access news feeds'),

    'type' => MENU_CALLBACK,

    'file' => 'aggregator.pages.inc',

  );

  $items['aggregator/opml'] = array(

    'title' => 'OPML feed',

    'page callback' => 'aggregator_page_opml',

    'access arguments' => array('access news feeds'),

    'type' => MENU_CALLBACK,

    'file' => 'aggregator.pages.inc',

  );

  $items['aggregator/categories/%aggregator_category'] = array(

    'title callback' => '_aggregator_category_title',

    'title arguments' => array(2),

    'page callback' => 'aggregator_page_category',

    'page arguments' => array(2),

    'access callback' => 'user_access',

    'access arguments' => array('access news feeds'),

    'file' => 'aggregator.pages.inc',

  );

  $items['aggregator/categories/%aggregator_category/view'] = array(

    'title' => 'View',

    'type' => MENU_DEFAULT_LOCAL_TASK,

    'weight' => -10,

  );

  $items['aggregator/categories/%aggregator_category/categorize'] = array(

    'title' => 'Categorize',

    'page callback' => 'drupal_get_form',

    'page arguments' => array('aggregator_page_category', 2),

    'access arguments' => array('administer news feeds'),

    'type' => MENU_LOCAL_TASK,

    'file' => 'aggregator.pages.inc',

  );

  $items['aggregator/categories/%aggregator_category/configure'] = array(

    'title' => 'Configure',

    'page callback' => 'drupal_get_form',

    'page arguments' => array('aggregator_form_category', 2),

    'access arguments' => array('administer news feeds'),

    'type' => MENU_LOCAL_TASK,

    'weight' => 1,

    'file' => 'aggregator.admin.inc',

  );

  $items['aggregator/sources/%aggregator_feed'] = array(

    'page callback' => 'aggregator_page_source',

    'page arguments' => array(2),

    'access arguments' => array('access news feeds'),

    'type' => MENU_CALLBACK,

    'file' => 'aggregator.pages.inc',

  );

  $items['aggregator/sources/%aggregator_feed/view'] = array(

    'title' => 'View',

    'type' => MENU_DEFAULT_LOCAL_TASK,

    'weight' => -10,

  );

  $items['aggregator/sources/%aggregator_feed/categorize'] = array(

    'title' => 'Categorize',

    'page callback' => 'drupal_get_form',

    'page arguments' => array('aggregator_page_source', 2),

    'access arguments' => array('administer news feeds'),

    'type' => MENU_LOCAL_TASK,

    'file' => 'aggregator.pages.inc',

  );

  $items['aggregator/sources/%aggregator_feed/configure'] = array(

    'title' => 'Configure',

    'page callback' => 'drupal_get_form',

    'page arguments' => array('aggregator_form_feed', 2),

    'access arguments' => array('administer news feeds'),

    'type' => MENU_LOCAL_TASK,

    'weight' => 1,

    'file' => 'aggregator.admin.inc',

  );

  $items['admin/content/aggregator/edit/feed/%aggregator_feed'] = array(

    'title' => 'Edit feed',

    'page callback' => 'drupal_get_form',

    'page arguments' => array('aggregator_form_feed', 5),

    'access arguments' => array('administer news feeds'),

    'type' => MENU_CALLBACK,

    'file' => 'aggregator.admin.inc',

  );

  $items['admin/content/aggregator/edit/category/%aggregator_category'] = array(

    'title' => 'Edit category',

    'page callback' => 'drupal_get_form',

    'page arguments' => array('aggregator_form_category', 5),

    'access arguments' => array('administer news feeds'),

    'type' => MENU_CALLBACK,

    'file' => 'aggregator.admin.inc',

  );

  return $items;

}

/**

 * Menu callback.

 *

 * @return

 *   An aggregator category title.

 */

function _aggregator_category_title($category) {

  return $category['title'];

}

/**

 * Implementation of hook_init().

 */

function aggregator_init() {

  drupal_add_css(drupal_get_path('module', 'aggregator') .'/aggregator.css');

}

/**

 * Find out whether there are any aggregator categories.

 *

 * @return

 *   TRUE if there is at least one category and the user has access to them, FALSE otherwise.

 */

function _aggregator_has_categories() {

  return user_access('access news feeds') && db_result(db_query('SELECT COUNT(*) FROM {aggregator_category}'));

}

/**

 * Implementation of hook_perm().

 */

function aggregator_perm() {

  return array('administer news feeds', 'access news feeds');

}

/**

 * Implementation of hook_cron().

 *

 * Checks news feeds for updates once their refresh interval has elapsed.

 */

function aggregator_cron() {

  $result = db_query('SELECT * FROM {aggregator_feed} WHERE checked + refresh < %d', time());

  while ($feed = db_fetch_array($result)) {

    aggregator_refresh($feed);

  }

}

/**

 * Implementation of hook_block().

 *

 * Generates blocks for the latest news items in each category and feed.

 */

function aggregator_block($op = 'list', $delta = 0, $edit = array()) {

  if (user_access('access news feeds')) {

    if ($op == 'list') {

      $result = db_query('SELECT cid, title FROM {aggregator_category} ORDER BY title');

      while ($category = db_fetch_object($result)) {

        $block['category-'. $category->cid]['info'] = t('!title category latest items', array('!title' => $category->title));

      }

      $result = db_query('SELECT fid, title FROM {aggregator_feed} ORDER BY fid');

      while ($feed = db_fetch_object($result)) {

        $block['feed-'. $feed->fid]['info'] = t('!title feed latest items', array('!title' => $feed->title));

      }

    }

    else if ($op == 'configure') {

      list($type, $id) = explode('-', $delta);

      if ($type == 'category') {

        $value = db_result(db_query('SELECT block FROM {aggregator_category} WHERE cid = %d', $id));

      }

      else {

        $value = db_result(db_query('SELECT block FROM {aggregator_feed} WHERE fid = %d', $id));

      }

      $form['block'] = array('#type' => 'select', '#title' => t('Number of news items in block'), '#default_value' => $value, '#options' => drupal_map_assoc(array(2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20)));

      return $form;

    }

    else if ($op == 'save') {

      list($type, $id) = explode('-', $delta);

      if ($type == 'category') {

        $value = db_query('UPDATE {aggregator_category} SET block = %d WHERE cid = %d', $edit['block'], $id);

      }

      else {

        $value = db_query('UPDATE {aggregator_feed} SET block = %d WHERE fid = %d', $edit['block'], $id);

      }

    }

    else if ($op == 'view') {

      list($type, $id) = explode('-', $delta);

      switch ($type) {

        case 'feed':

          if ($feed = db_fetch_object(db_query('SELECT fid, title, block FROM {aggregator_feed} WHERE fid = %d', $id))) {

            $block['subject'] = check_plain($feed->title);

            $result = db_query_range('SELECT * FROM {aggregator_item} WHERE fid = %d ORDER BY timestamp DESC, iid DESC', $feed->fid, 0, $feed->block);

            $read_more = theme('more_link', url('aggregator/sources/'. $feed->fid), t("View this feed's recent news."));

          }

          break;

        case 'category':

          if ($category = db_fetch_object(db_query('SELECT cid, title, block FROM {aggregator_category} WHERE cid = %d', $id))) {

            $block['subject'] = check_plain($category->title);

            $result = db_query_range('SELECT i.* FROM {aggregator_category_item} ci LEFT JOIN {aggregator_item} i ON ci.iid = i.iid WHERE ci.cid = %d ORDER BY i.timestamp DESC, i.iid DESC', $category->cid, 0, $category->block);

            $read_more = theme('more_link', url('aggregator/categories/'. $category->cid), t("View this category's recent news."));

          }

          break;

      }

      $items = array();

      while ($item = db_fetch_object($result)) {

        $items[] = theme('aggregator_block_item', $item);

      }

      // Only display the block if there are items to show.

      if (count($items) > 0) {

        $block['content'] = theme('item_list', $items) . $read_more;

      }

    }

    if (isset($block)) {

      return $block;

    }

  }

}

/**

 * Add/edit/delete aggregator categories.

 *

 * @param $edit

 *   An associative array describing the category to be added/edited/deleted.

 */

function aggregator_save_category($edit) {

  $link_path = 'aggregator/categories/';

  if (!empty($edit['cid'])) {

    $link_path .= $edit['cid'];

    if (!empty($edit['title'])) {

      db_query("UPDATE {aggregator_category} SET title = '%s', description = '%s' WHERE cid = %d", $edit['title'], $edit['description'], $edit['cid']);

      $op = 'update';

    }

    else {

      db_query('DELETE FROM {aggregator_category} WHERE cid = %d', $edit['cid']);

      // Make sure there is no active block for this category.

      db_query("DELETE FROM {blocks} WHERE module = '%s' AND delta = '%s'", 'aggregator', 'category-' . $edit['cid']);

      $edit['title'] = '';

      $op = 'delete';

    }

  }

  else if (!empty($edit['title'])) {

    // A single unique id for bundles and feeds, to use in blocks

    db_query("INSERT INTO {aggregator_category} (title, description, block) VALUES ('%s', '%s', 5)", $edit['title'], $edit['description']);

    $link_path .= db_last_insert_id('aggregator_category', 'cid');

    $op = 'insert';

  }

  if (isset($op)) {

    menu_link_maintain('aggregator', $op, $link_path, $edit['title']);

  }

}

/**

 * Add/edit/delete an aggregator feed.

 *

 * @param $edit

 *   An associative array describing the feed to be added/edited/deleted.

 */

function aggregator_save_feed($edit) {

  if (!empty($edit['fid'])) {

    // An existing feed is being modified, delete the category listings.

    db_query('DELETE FROM {aggregator_category_feed} WHERE fid = %d', $edit['fid']);

  }

  if (!empty($edit['fid']) && !empty($edit['title'])) {

    db_query("UPDATE {aggregator_feed} SET title = '%s', url = '%s', refresh = %d WHERE fid = %d", $edit['title'], $edit['url'], $edit['refresh'], $edit['fid']);

  }

  else if (!empty($edit['fid'])) {

    $items = array();

    $result = db_query('SELECT iid FROM {aggregator_item} WHERE fid = %d', $edit['fid']);

    while ($item = db_fetch_object($result)) {

      $items[] = "iid = $item->iid";

    }

    if (!empty($items)) {

      db_query('DELETE FROM {aggregator_category_item} WHERE '. implode(' OR ', $items));

    }

    db_query('DELETE FROM {aggregator_feed} WHERE fid = %d', $edit['fid']);

    db_query('DELETE FROM {aggregator_item} WHERE fid = %d', $edit['fid']);

    // Make sure there is no active block for this feed.

    db_query("DELETE FROM {blocks} WHERE module = '%s' AND delta = '%s'", 'aggregator', 'feed-' . $edit['fid']);

  }

  else if (!empty($edit['title'])) {

    db_query("INSERT INTO {aggregator_feed} (title, url, refresh, block, description, image) VALUES ('%s', '%s', %d, 5, '', '')", $edit['title'], $edit['url'], $edit['refresh']);

    // A single unique id for bundles and feeds, to use in blocks.

    $edit['fid'] = db_last_insert_id('aggregator_feed', 'fid');

  }

  if (!empty($edit['title'])) {

    // The feed is being saved, save the categories as well.

    if (!empty($edit['category'])) {

      foreach ($edit['category'] as $cid => $value) {

        if ($value) {

          db_query('INSERT INTO {aggregator_category_feed} (fid, cid) VALUES (%d, %d)', $edit['fid'], $cid);

        }

      }

    }

  }

}

/**

 * Removes all items from a feed.

 *

 * @param $feed

 *   An associative array describing the feed to be cleared.

 */

function aggregator_remove($feed) {

  $result = db_query('SELECT iid FROM {aggregator_item} WHERE fid = %d', $feed['fid']);

  while ($item = db_fetch_object($result)) {

    $items[] = "iid = $item->iid";

  }

  if (!empty($items)) {

    db_query('DELETE FROM {aggregator_category_item} WHERE '. implode(' OR ', $items));

  }

  db_query('DELETE FROM {aggregator_item} WHERE fid = %d', $feed['fid']);

  db_query("UPDATE {aggregator_feed} SET checked = 0, etag = '', modified = 0 WHERE fid = %d", $feed['fid']);

  drupal_set_message(t('The news items from %site have been removed.', array('%site' => $feed['title'])));

}

/**

 * Call-back function used by the XML parser.

 */

function aggregator_element_start($parser, $name, $attributes) {

  global $item, $element, $tag, $items, $channel;

  switch ($name) {

    case 'IMAGE':

    case 'TEXTINPUT':

    case 'CONTENT':

    case 'SUMMARY':

    case 'TAGLINE':

    case 'SUBTITLE':

    case 'LOGO':

    case 'INFO':

      $element = $name;

      break;

    case 'ID':

      if ($element != 'ITEM') {

        $element = $name;

      }

    case 'LINK':

      if (!empty($attributes['REL']) && $attributes['REL'] == 'alternate') {

        if ($element == 'ITEM') {

          $items[$item]['LINK'] = $attributes['HREF'];

        }

        else {

          $channel['LINK'] = $attributes['HREF'];

        }

      }

      break;

    case 'ITEM':

      $element = $name;

      $item += 1;

      break;

    case 'ENTRY':

      $element = 'ITEM';

      $item += 1;

      break;

  }

  $tag = $name;

}

/**

 * Call-back function used by the XML parser.

 */

function aggregator_element_end($parser, $name) {

  global $element;

  switch ($name) {

    case 'IMAGE':

    case 'TEXTINPUT':

    case 'ITEM':

    case 'ENTRY':

    case 'CONTENT':

    case 'INFO':

      $element = '';

      break;

    case 'ID':

      if ($element == 'ID') {

        $element = '';

      }

  }

}