aggregator.module 34.2 KB
Newer Older
1
<?php
Dries's avatar
Dries committed
2
// $Id$
Dries's avatar
 
Dries committed
3

Dries's avatar
 
Dries committed
4 5
/**
 * @file
6
 * Used to aggregate syndicated content (RSS, RDF, and Atom).
Dries's avatar
 
Dries committed
7 8
 */

Dries's avatar
 
Dries committed
9 10 11
/**
 * Implementation of hook_help().
 */
12 13
function aggregator_help($path, $arg) {
  switch ($path) {
Kjartan's avatar
Kjartan committed
14
    case 'admin/help#aggregator':
15 16 17
      $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>';
18
      return $output;
19
    case 'admin/content/aggregator':
20 21
      $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' => 'hsttp://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>';
22
      return $output;
23
    case 'admin/content/aggregator/add/feed':
24
      return '<p>' . t('Add a feed in RSS, RDF or Atom format. A feed may only have one entry.') . '</p>';
25
    case 'admin/content/aggregator/add/category':
26
      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>';
Dries's avatar
 
Dries committed
27
  }
28 29
}

30 31 32 33 34
/**
 * Implementation of hook_theme()
 */
function aggregator_theme() {
  return array(
35 36 37 38 39 40
    'aggregator_wrapper' => array(
      'arguments' => array('content' => NULL),
      'file' => 'aggregator.pages.inc',
      'template' => 'aggregator-wrapper',
    ),
    'aggregator_categorize_items' => array(
41
      'arguments' => array('form' => NULL),
42
      'file' => 'aggregator.pages.inc',
43
    ),
44
    'aggregator_feed_source' => array(
45
      'arguments' => array('feed' => NULL),
46
      'file' => 'aggregator.pages.inc',
47
      'template' => 'aggregator-feed-source',
48 49 50 51
    ),
    'aggregator_block_item' => array(
      'arguments' => array('item' => NULL, 'feed' => 0),
    ),
52 53 54 55 56
    'aggregator_summary_items' => array(
      'arguments' => array('summary_items' => NULL, 'source' => NULL),
      'file' => 'aggregator.pages.inc',
      'template' => 'aggregator-summary-items',
    ),
57 58
    'aggregator_summary_item' => array(
      'arguments' => array('item' => NULL),
59
      'file' => 'aggregator.pages.inc',
60
      'template' => 'aggregator-summary-item',
61
    ),
62
    'aggregator_item' => array(
63
      'arguments' => array('item' => NULL),
64 65 66 67 68 69 70 71 72
      '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),
73
      'file' => 'aggregator.pages.inc',
74 75
    ),
  );
76
}
77

78 79 80
/**
 * Implementation of hook_menu().
 */
81 82
function aggregator_menu() {
  $items['admin/content/aggregator'] = array(
83
    'title' => 'Feed aggregator',
84
    'description' => "Configure which content your site aggregates from other sites, how often it polls them, and how they're categorized.",
85 86 87 88
    'page callback' => 'aggregator_admin_overview',
    'access arguments' => array('administer news feeds'),
  );
  $items['admin/content/aggregator/add/feed'] = array(
89
    'title' => 'Add feed',
90 91 92 93
    'page callback' => 'drupal_get_form',
    'page arguments' => array('aggregator_form_feed'),
    'access arguments' => array('administer news feeds'),
    'type' => MENU_LOCAL_TASK,
94
    'parent' => 'admin/content/aggregator',
95 96
  );
  $items['admin/content/aggregator/add/category'] = array(
97
    'title' => 'Add category',
98 99 100 101
    'page callback' => 'drupal_get_form',
    'page arguments' => array('aggregator_form_category'),
    'access arguments' => array('administer news feeds'),
    'type' => MENU_LOCAL_TASK,
102
    'parent' => 'admin/content/aggregator',
103
  );
104
  $items['admin/content/aggregator/remove/%aggregator_feed'] = array(
105
    'title' => 'Remove items',
Gábor Hojtsy's avatar
Gábor Hojtsy committed
106 107
    'page callback' => 'drupal_get_form',
    'page arguments' => array('aggregator_admin_remove_feed', 4),
108 109 110
    'access arguments' => array('administer news feeds'),
    'type' => MENU_CALLBACK,
  );
111
  $items['admin/content/aggregator/update/%aggregator_feed'] = array(
112
    'title' => 'Update items',
113 114 115 116 117 118
    'page callback' => 'aggregator_admin_refresh_feed',
    'page arguments' => array(4),
    'access arguments' => array('administer news feeds'),
    'type' => MENU_CALLBACK,
  );
  $items['admin/content/aggregator/list'] = array(
119
    'title' => 'List',
120 121 122 123
    'type' => MENU_DEFAULT_LOCAL_TASK,
    'weight' => -10,
  );
  $items['admin/content/aggregator/settings'] = array(
124
    'title' => 'Settings',
125 126 127 128 129 130 131
    'page callback' => 'drupal_get_form',
    'page arguments' => array('aggregator_admin_settings'),
    'type' => MENU_LOCAL_TASK,
    'weight' => 10,
    'access arguments' => array('administer news feeds'),
  );
  $items['aggregator'] = array(
132
    'title' => 'Feed aggregator',
133 134 135 136 137
    'page callback' => 'aggregator_page_last',
    'access arguments' => array('access news feeds'),
    'weight' => 5,
  );
  $items['aggregator/sources'] = array(
138
    'title' => 'Sources',
139
    'page callback' => 'aggregator_page_sources',
140 141
    'access arguments' => array('access news feeds'),
  );
142
  $items['aggregator/categories'] = array(
143
    'title' => 'Categories',
144
    'page callback' => 'aggregator_page_categories',
145
    'access callback' => '_aggregator_has_categories',
146 147
  );
  $items['aggregator/rss'] = array(
148
    'title' => 'RSS feed',
149 150 151 152 153
    'page callback' => 'aggregator_page_rss',
    'access arguments' => array('access news feeds'),
    'type' => MENU_CALLBACK,
  );
  $items['aggregator/opml'] = array(
154
    'title' => 'OPML feed',
155 156 157 158
    'page callback' => 'aggregator_page_opml',
    'access arguments' => array('access news feeds'),
    'type' => MENU_CALLBACK,
  );
159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186
  $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'),
  );
  $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,
  );
  $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,
  );
187
  $items['aggregator/sources/%aggregator_feed'] = array(
188
    'page callback' => 'aggregator_page_source',
189
    'page arguments' => array(2),
190
    'access arguments' => array('access news feeds'),
191 192
    'type' => MENU_CALLBACK,
  );
193
  $items['aggregator/sources/%aggregator_feed/view'] = array(
194
    'title' => 'View',
195 196 197
    'type' => MENU_DEFAULT_LOCAL_TASK,
    'weight' => -10,
  );
198
  $items['aggregator/sources/%aggregator_feed/categorize'] = array(
199
    'title' => 'Categorize',
200
    'page callback' => 'drupal_get_form',
201
    'page arguments' => array('aggregator_page_source', 2),
202 203 204
    'access arguments' => array('administer news feeds'),
    'type' => MENU_LOCAL_TASK,
  );
205
  $items['aggregator/sources/%aggregator_feed/configure'] = array(
206
    'title' => 'Configure',
207 208 209 210 211 212
    'page callback' => 'drupal_get_form',
    'page arguments' => array('aggregator_form_feed', 2),
    'access arguments' => array('administer news feeds'),
    'type' => MENU_LOCAL_TASK,
    'weight' => 1,
  );
213
  $items['admin/content/aggregator/edit/feed/%aggregator_feed'] = array(
214
    'title' => 'Edit feed',
215 216 217 218 219
    'page callback' => 'drupal_get_form',
    'page arguments' => array('aggregator_form_feed', 5),
    'access arguments' => array('administer news feeds'),
    'type' => MENU_CALLBACK,
  );
220
  $items['admin/content/aggregator/edit/category/%aggregator_category'] = array(
221
    'title' => 'Edit category',
222 223 224 225 226
    'page callback' => 'drupal_get_form',
    'page arguments' => array('aggregator_form_category', 5),
    'access arguments' => array('administer news feeds'),
    'type' => MENU_CALLBACK,
  );
227 228 229 230

  return $items;
}

231 232 233 234 235 236
/**
 * Menu callback.
 *
 * @return
 *   An aggregator category title.
 */
237 238 239 240
function _aggregator_category_title($category) {
  return $category['title'];
}

241 242 243
/**
 * Implementation of hook_init().
 */
244
function aggregator_init() {
245
  drupal_add_css(drupal_get_path('module', 'aggregator') . '/aggregator.css');
246
}
247

248 249 250 251 252 253
/**
 * 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.
 */
254 255 256
function _aggregator_has_categories() {
  return user_access('access news feeds') && db_result(db_query('SELECT COUNT(*) FROM {aggregator_category}'));
}
257

Dries's avatar
 
Dries committed
258 259 260
/**
 * Implementation of hook_perm().
 */
Kjartan's avatar
Kjartan committed
261
function aggregator_perm() {
262 263 264 265
  return array(
    'administer news feeds' => t('Add, edit or delete news feeds that are aggregated to your site.'),
    'access news feeds' => t('View aggregated news feed items.'),
  );
Dries's avatar
 
Dries committed
266 267
}

Dries's avatar
 
Dries committed
268 269 270 271 272
/**
 * Implementation of hook_cron().
 *
 * Checks news feeds for updates once their refresh interval has elapsed.
 */
Dries's avatar
 
Dries committed
273
function aggregator_cron() {
Dries's avatar
 
Dries committed
274
  $result = db_query('SELECT * FROM {aggregator_feed} WHERE checked + refresh < %d', time());
Dries's avatar
 
Dries committed
275 276
  while ($feed = db_fetch_array($result)) {
    aggregator_refresh($feed);
Dries's avatar
 
Dries committed
277 278 279
  }
}

Dries's avatar
 
Dries committed
280 281 282 283 284
/**
 * Implementation of hook_block().
 *
 * Generates blocks for the latest news items in each category and feed.
 */
285
function aggregator_block($op = 'list', $delta = '', $edit = array()) {
Dries's avatar
 
Dries committed
286
  if (user_access('access news feeds')) {
Dries's avatar
 
Dries committed
287
    if ($op == 'list') {
Dries's avatar
Dries committed
288
      $result = db_query('SELECT cid, title FROM {aggregator_category} ORDER BY title');
Dries's avatar
 
Dries committed
289
      while ($category = db_fetch_object($result)) {
290
        $block['category-' . $category->cid]['info'] = t('!title category latest items', array('!title' => $category->title));
Kjartan's avatar
Kjartan committed
291
      }
Dries's avatar
Dries committed
292
      $result = db_query('SELECT fid, title FROM {aggregator_feed} ORDER BY fid');
Kjartan's avatar
Kjartan committed
293
      while ($feed = db_fetch_object($result)) {
294
        $block['feed-' . $feed->fid]['info'] = t('!title feed latest items', array('!title' => $feed->title));
Kjartan's avatar
Kjartan committed
295
      }
Dries's avatar
 
Dries committed
296
    }
Dries's avatar
Dries committed
297
    else if ($op == 'configure') {
298
      list($type, $id) = explode('-', $delta);
Dries's avatar
Dries committed
299 300 301 302 303 304
      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));
      }
305
      $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)));
306
      return $form;
Dries's avatar
Dries committed
307 308
    }
    else if ($op == 'save') {
309
      list($type, $id) = explode('-', $delta);
Dries's avatar
Dries committed
310 311 312 313 314 315 316
      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);
      }
    }
317
    else if ($op == 'view') {
318
      list($type, $id) = explode('-', $delta);
Kjartan's avatar
Kjartan committed
319
      switch ($type) {
Dries's avatar
 
Dries committed
320
        case 'feed':
321
          if ($feed = db_fetch_object(db_query('SELECT fid, title, block FROM {aggregator_feed} WHERE fid = %d', $id))) {
322
            $block['subject'] = check_plain($feed->title);
323
            $result = db_query_range('SELECT * FROM {aggregator_item} WHERE fid = %d ORDER BY timestamp DESC, iid DESC', $feed->fid, 0, $feed->block);
324
            $read_more = theme('more_link', url('aggregator/sources/' . $feed->fid), t("View this feed's recent news."));
325
          }
Kjartan's avatar
Kjartan committed
326
          break;
327

Dries's avatar
 
Dries committed
328
        case 'category':
329
          if ($category = db_fetch_object(db_query('SELECT cid, title, block FROM {aggregator_category} WHERE cid = %d', $id))) {
330
            $block['subject'] = check_plain($category->title);
331
            $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);
332
            $read_more = theme('more_link', url('aggregator/categories/' . $category->cid), t("View this category's recent news."));
333
          }
Kjartan's avatar
Kjartan committed
334 335
          break;
      }
Dries's avatar
 
Dries committed
336 337
      $items = array();
      while ($item = db_fetch_object($result)) {
Dries's avatar
 
Dries committed
338
        $items[] = theme('aggregator_block_item', $item);
Dries's avatar
 
Dries committed
339
      }
340 341 342 343 344

      // Only display the block if there are items to show.
      if (count($items) > 0) {
        $block['content'] = theme('item_list', $items) . $read_more;
      }
Dries's avatar
 
Dries committed
345
    }
346 347 348
    if (isset($block)) {
      return $block;
    }
Dries's avatar
 
Dries committed
349
  }
Dries's avatar
 
Dries committed
350 351
}

352 353
/**
 * Add/edit/delete aggregator categories.
354 355 356
 *
 * @param $edit
 *   An associative array describing the category to be added/edited/deleted.
357 358
 */
function aggregator_save_category($edit) {
359 360 361 362 363 364 365 366 367 368 369 370
  $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']);
      $edit['title'] = '';
      $op = 'delete';
    }
371
  }
372
  else if (!empty($edit['title'])) {
373
    // A single unique id for bundles and feeds, to use in blocks
374
    db_query("INSERT INTO {aggregator_category} (title, description, block) VALUES ('%s', '%s', 5)", $edit['title'], $edit['description']);
375 376 377 378 379
    $link_path .= db_last_insert_id('aggregator', 'cid');
    $op = 'insert';
  }
  if (isset($op)) {
    menu_link_maintain('aggregator', $op, $link_path, $edit['title']);
380 381 382 383 384
  }
}

/**
 * Add/edit/delete an aggregator feed.
385 386 387
 *
 * @param $edit
 *   An associative array describing the feed to be added/edited/deleted.
388 389
 */
function aggregator_save_feed($edit) {
390
  if (!empty($edit['fid'])) {
391 392 393
    // An existing feed is being modified, delete the category listings.
    db_query('DELETE FROM {aggregator_category_feed} WHERE fid = %d', $edit['fid']);
  }
394
  if (!empty($edit['fid']) && !empty($edit['title'])) {
395 396
    db_query("UPDATE {aggregator_feed} SET title = '%s', url = '%s', refresh = %d WHERE fid = %d", $edit['title'], $edit['url'], $edit['refresh'], $edit['fid']);
  }
397
  else if (!empty($edit['fid'])) {
398
    $items = array();
399 400 401 402
    $result = db_query('SELECT iid FROM {aggregator_item} WHERE fid = %d', $edit['fid']);
    while ($item = db_fetch_object($result)) {
      $items[] = "iid = $item->iid";
    }
403
    if (!empty($items)) {
404
      db_query('DELETE FROM {aggregator_category_item} WHERE ' . implode(' OR ', $items));
405 406 407 408
    }
    db_query('DELETE FROM {aggregator_feed} WHERE fid = %d', $edit['fid']);
    db_query('DELETE FROM {aggregator_item} WHERE fid = %d', $edit['fid']);
  }
409
  else if (!empty($edit['title'])) {
410
    db_query("INSERT INTO {aggregator_feed} (title, url, refresh, block, description, image) VALUES ('%s', '%s', %d, 5, '', '')", $edit['title'], $edit['url'], $edit['refresh']);
411
    // A single unique id for bundles and feeds, to use in blocks.
412
    $edit['fid'] = db_last_insert_id('aggregator_feed', 'fid');
413
  }
414
  if (!empty($edit['title'])) {
415
    // The feed is being saved, save the categories as well.
416
    if (!empty($edit['category'])) {
417 418 419 420 421 422 423 424 425
      foreach ($edit['category'] as $cid => $value) {
        if ($value) {
          db_query('INSERT INTO {aggregator_category_feed} (fid, cid) VALUES (%d, %d)', $edit['fid'], $cid);
        }
      }
    }
  }
}

426 427 428 429 430 431
/**
 * Removes all items from a feed.
 *
 * @param $feed
 *   An associative array describing the feed to be cleared.
 */
Dries's avatar
 
Dries committed
432 433 434 435
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";
Dries's avatar
 
Dries committed
436
  }
437
  if (!empty($items)) {
438
    db_query('DELETE FROM {aggregator_category_item} WHERE ' . implode(' OR ', $items));
Dries's avatar
 
Dries committed
439
  }
Dries's avatar
 
Dries committed
440
  db_query('DELETE FROM {aggregator_item} WHERE fid = %d', $feed['fid']);
Kjartan's avatar
Kjartan committed
441
  db_query("UPDATE {aggregator_feed} SET checked = 0, etag = '', modified = 0 WHERE fid = %d", $feed['fid']);
442
  drupal_set_message(t('The news items from %site have been removed.', array('%site' => $feed['title'])));
Dries's avatar
 
Dries committed
443 444
}

Dries's avatar
 
Dries committed
445 446 447
/**
 * Call-back function used by the XML parser.
 */
Kjartan's avatar
Kjartan committed
448
function aggregator_element_start($parser, $name, $attributes) {
449
  global $item, $element, $tag, $items, $channel;
Dries's avatar
 
Dries committed
450 451

  switch ($name) {
Dries's avatar
 
Dries committed
452 453
    case 'IMAGE':
    case 'TEXTINPUT':
454 455 456 457 458 459
    case 'CONTENT':
    case 'SUMMARY':
    case 'TAGLINE':
    case 'SUBTITLE':
    case 'LOGO':
    case 'INFO':
Dries's avatar
 
Dries committed
460 461
      $element = $name;
      break;
462 463 464 465
    case 'ID':
      if ($element != 'ITEM') {
        $element = $name;
      }
466
    case 'LINK':
467
      if (!empty($attributes['REL']) && $attributes['REL'] == 'alternate') {
468 469 470 471 472 473 474 475
        if ($element == 'ITEM') {
          $items[$item]['LINK'] = $attributes['HREF'];
        }
        else {
          $channel['LINK'] = $attributes['HREF'];
        }
      }
      break;
Dries's avatar
 
Dries committed
476
    case 'ITEM':
Dries's avatar
 
Dries committed
477 478
      $element = $name;
      $item += 1;
479 480 481 482 483
      break;
    case 'ENTRY':
      $element = 'ITEM';
      $item += 1;
      break;
484 485 486 487 488
  }

  $tag = $name;
}

Dries's avatar
 
Dries committed
489 490 491
/**
 * Call-back function used by the XML parser.
 */
Kjartan's avatar
Kjartan committed
492
function aggregator_element_end($parser, $name) {
Dries's avatar
 
Dries committed
493 494
  global $element;

Dries's avatar
 
Dries committed
495
  switch ($name) {
Dries's avatar
 
Dries committed
496 497 498
    case 'IMAGE':
    case 'TEXTINPUT':
    case 'ITEM':
499 500 501
    case 'ENTRY':
    case 'CONTENT':
    case 'INFO':
502 503
      $element = '';
      break;
504
    case 'ID':
505
      if ($element == 'ID') {
506 507
        $element = '';
      }
Dries's avatar
 
Dries committed
508
  }
509 510
}

Dries's avatar
 
Dries committed
511 512 513
/**
 * Call-back function used by the XML parser.
 */
Kjartan's avatar
Kjartan committed
514
function aggregator_element_data($parser, $data) {
Dries's avatar
 
Dries committed
515
  global $channel, $element, $items, $item, $image, $tag;
516
  $items += array($item => array());
Dries's avatar
 
Dries committed
517
  switch ($element) {
Dries's avatar
 
Dries committed
518
    case 'ITEM':
519
      $items[$item] += array($tag => '');
Dries's avatar
 
Dries committed
520 521
      $items[$item][$tag] .= $data;
      break;
Dries's avatar
 
Dries committed
522
    case 'IMAGE':
523
    case 'LOGO':
524
      $image += array($tag => '');
Dries's avatar
 
Dries committed
525 526
      $image[$tag] .= $data;
      break;
527 528
    case 'LINK':
      if ($data) {
529
        $items[$item] += array($tag => '');
530 531 532 533
        $items[$item][$tag] .= $data;
      }
      break;
    case 'CONTENT':
534
      $items[$item] += array('CONTENT' => '');
535
      $items[$item]['CONTENT'] .= $data;
536 537
      break;
    case 'SUMMARY':
538
      $items[$item] += array('SUMMARY' => '');
539
      $items[$item]['SUMMARY'] .= $data;
540 541 542
      break;
    case 'TAGLINE':
    case 'SUBTITLE':
543
      $channel += array('DESCRIPTION' => '');
544 545 546 547
      $channel['DESCRIPTION'] .= $data;
      break;
    case 'INFO':
    case 'ID':
Dries's avatar
 
Dries committed
548 549 550
    case 'TEXTINPUT':
      // The sub-element is not supported. However, we must recognize
      // it or its contents will end up in the item array.
Dries's avatar
 
Dries committed
551 552
      break;
    default:
553
      $channel += array($tag => '');
Dries's avatar
 
Dries committed
554
      $channel[$tag] .= $data;
555 556 557
  }
}

Dries's avatar
 
Dries committed
558 559
/**
 * Checks a news feed for new items.
560 561 562
 *
 * @param $feed
 *   An associative array describing the feed to be refreshed.
Dries's avatar
 
Dries committed
563
 */
Kjartan's avatar
Kjartan committed
564
function aggregator_refresh($feed) {
Dries's avatar
 
Dries committed
565 566
  global $channel, $image;

Dries's avatar
 
Dries committed
567 568 569 570 571 572
  // Generate conditional GET headers.
  $headers = array();
  if ($feed['etag']) {
    $headers['If-None-Match'] = $feed['etag'];
  }
  if ($feed['modified']) {
573
    $headers['If-Modified-Since'] = gmdate('D, d M Y H:i:s', $feed['modified']) . ' GMT';
Dries's avatar
 
Dries committed
574 575 576 577 578
  }

  // Request feed.
  $result = drupal_http_request($feed['url'], $headers);

579
  // Process HTTP response code.
Dries's avatar
 
Dries committed
580 581
  switch ($result->code) {
    case 304:
Dries's avatar
 
Dries committed
582
      db_query('UPDATE {aggregator_feed} SET checked = %d WHERE fid = %d', time(), $feed['fid']);
583
      drupal_set_message(t('There is no new syndicated content from %site.', array('%site' => $feed['title'])));
Dries's avatar
 
Dries committed
584
      break;
Dries's avatar
 
Dries committed
585 586
    case 301:
      $feed['url'] = $result->redirect_url;
587
      watchdog('aggregator', 'Updated URL for feed %title to %url.', array('%title' => $feed['title'], '%url' => $feed['url']));
588
      // Deliberate no break.
Dries's avatar
 
Dries committed
589 590 591 592
    case 200:
    case 302:
    case 307:
      // Filter the input data:
593
      if (aggregator_parse_feed($result->data, $feed)) {
594
        $modified = empty($result->headers['Last-Modified']) ? 0 : strtotime($result->headers['Last-Modified']);
Dries's avatar
Dries committed
595

596
        // Prepare the channel data.
597
        foreach ($channel as $key => $value) {
598
          $channel[$key] = trim($value);
599 600
        }

601
        // Prepare the image data (if any).
Dries's avatar
 
Dries committed
602 603 604
        foreach ($image as $key => $value) {
          $image[$key] = trim($value);
        }
Dries's avatar
 
Dries committed
605

606
        if (!empty($image['LINK']) && !empty($image['URL']) && !empty($image['TITLE'])) {
607
          // Note, we should really use theme_image() here but that only works with local images it won't work with images fetched with a URL unless PHP version > 5
608
          $image = '<a href="' . check_url($image['LINK']) . '" class="feed-image"><img src="' . check_url($image['URL']) . '" alt="' . check_plain($image['TITLE']) . '" /></a>';
Dries's avatar
 
Dries committed
609
        }
Dries's avatar
 
Dries committed
610 611 612
        else {
          $image = NULL;
        }
Dries's avatar
 
Dries committed
613

614
        $etag = empty($result->headers['ETag']) ? '' : $result->headers['ETag'];
615
        // Update the feed data.
616
        db_query("UPDATE {aggregator_feed} SET url = '%s', checked = %d, link = '%s', description = '%s', image = '%s', etag = '%s', modified = %d WHERE fid = %d", $feed['url'], time(), $channel['LINK'], $channel['DESCRIPTION'], $image, $etag, $modified, $feed['fid']);
Dries's avatar
 
Dries committed
617

618
        // Clear the cache.
Dries's avatar
 
Dries committed
619
        cache_clear_all();
Dries's avatar
 
Dries committed
620

621
        watchdog('aggregator', 'There is new syndicated content from %site.', array('%site' => $feed['title']));
622
        drupal_set_message(t('There is new syndicated content from %site.', array('%site' => $feed['title'])));
623
        break;
Dries's avatar
 
Dries committed
624
      }
625 626
      $result->error = t('feed not parseable');
      // Deliberate no break.
Dries's avatar
 
Dries committed
627
    default:
628 629
      watchdog('aggregator', 'The feed from %site seems to be broken, due to "%error".', array('%site' => $feed['title'], '%error' => $result->code . ' ' . $result->error), WATCHDOG_WARNING);
      drupal_set_message(t('The feed from %site seems to be broken, because of error "%error".', array('%site' => $feed['title'], '%error' => $result->code . ' ' . $result->error)));
630
      module_invoke('system', 'check_http_request');
Dries's avatar
 
Dries committed
631
  }
Dries's avatar
 
Dries committed
632
}
Dries's avatar
 
Dries committed
633

Dries's avatar
 
Dries committed
634 635 636 637
/**
 * Parse the W3C date/time format, a subset of ISO 8601. PHP date parsing
 * functions do not handle this format.
 * See http://www.w3.org/TR/NOTE-datetime for more information.
638
 * Originally from MagpieRSS (http://magpierss.sourceforge.net/).
Dries's avatar
 
Dries committed
639
 *
640 641 642 643
 * @param $date_str
 *   A string with a potentially W3C DTF date.
 * @return
 *   A timestamp if parsed successfully or FALSE if not.
Dries's avatar
 
Dries committed
644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668
 */
function aggregator_parse_w3cdtf($date_str) {
  if (preg_match('/(\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2})(:(\d{2}))?(?:([-+])(\d{2}):?(\d{2})|(Z))?/', $date_str, $match)) {
    list($year, $month, $day, $hours, $minutes, $seconds) = array($match[1], $match[2], $match[3], $match[4], $match[5], $match[6]);
    // calc epoch for current date assuming GMT
    $epoch = gmmktime($hours, $minutes, $seconds, $month, $day, $year);
    if ($match[10] != 'Z') { // Z is zulu time, aka GMT
      list($tz_mod, $tz_hour, $tz_min) = array($match[8], $match[9], $match[10]);
      // zero out the variables
      if (!$tz_hour) {
        $tz_hour = 0;
      }
      if (!$tz_min) {
        $tz_min = 0;
      }
      $offset_secs = (($tz_hour * 60) + $tz_min) * 60;
      // is timezone ahead of GMT?  then subtract offset
      if ($tz_mod == '+') {
        $offset_secs *= -1;
      }
      $epoch += $offset_secs;
    }
    return $epoch;
  }
  else {
669
    return FALSE;
Dries's avatar
 
Dries committed
670 671 672
  }
}

673 674 675 676 677 678 679 680 681 682
/**
 * Parse a feed and store its items.
 *
 * @param $data
 *   The feed data.
 * @param $feed
 *   An associative array describing the feed to be parsed.
 * @return
 *   0 on error, 1 otherwise.
 */
Dries's avatar
 
Dries committed
683
function aggregator_parse_feed(&$data, $feed) {
Dries's avatar
 
Dries committed
684
  global $items, $image, $channel;
Dries's avatar
 
Dries committed
685

Dries's avatar
 
Dries committed
686
  // Unset the global variables before we use them:
Dries's avatar
 
Dries committed
687
  unset($GLOBALS['element'], $GLOBALS['item'], $GLOBALS['tag']);
Dries's avatar
 
Dries committed
688
  $items = array();
Dries's avatar
 
Dries committed
689
  $image = array();
Dries's avatar
 
Dries committed
690
  $channel = array();
691

Dries's avatar
 
Dries committed
692 693
  // parse the data:
  $xml_parser = drupal_xml_parser_create($data);
Dries's avatar
 
Dries committed
694 695
  xml_set_element_handler($xml_parser, 'aggregator_element_start', 'aggregator_element_end');
  xml_set_character_data_handler($xml_parser, 'aggregator_element_data');
Dries's avatar
 
Dries committed
696

Dries's avatar
 
Dries committed
697
  if (!xml_parse($xml_parser, $data, 1)) {
698
    watchdog('aggregator', 'The feed from %site seems to be broken, due to an error "%error" on line %line.', array('%site' => $feed['title'], '%error' => xml_error_string(xml_get_error_code($xml_parser)), '%line' => xml_get_current_line_number($xml_parser)), WATCHDOG_WARNING);
699
    drupal_set_message(t('The feed from %site seems to be broken, because of error "%error" on line %line.', array('%site' => $feed['title'], '%error' => xml_error_string(xml_get_error_code($xml_parser)), '%line' => xml_get_current_line_number($xml_parser))), 'error');
Dries's avatar
 
Dries committed
700
    return 0;
Dries's avatar
 
Dries committed
701 702
  }
  xml_parser_free($xml_parser);
Dries's avatar
 
Dries committed
703

704 705
  // We reverse the array such that we store the first item last, and the last
  // item first. In the database, the newest item should be at the top.
Dries's avatar
 
Dries committed
706
  $items = array_reverse($items);
Dries's avatar
 
Dries committed
707

708
  // Initialize variables.
709
  $title = $link = $author = $description = $guid = NULL;
Dries's avatar
 
Dries committed
710
  foreach ($items as $item) {
711
    unset($title, $link, $author, $description, $guid);
712

Dries's avatar
 
Dries committed
713 714
    // Prepare the item:
    foreach ($item as $key => $value) {
715
      $item[$key] = trim($value);
Dries's avatar
 
Dries committed
716
    }
Dries's avatar
Dries committed
717

718 719 720
    // Resolve the item's title. If no title is found, we use up to 40
    // characters of the description ending at a word boundary but not
    // splitting potential entities.
721
    if (!empty($item['TITLE'])) {
Dries's avatar
 
Dries committed
722
      $title = $item['TITLE'];
Dries's avatar
 
Dries committed
723
    }
724
    elseif (!empty($item['DESCRIPTION'])) {
Dries's avatar
 
Dries committed
725
      $title = preg_replace('/^(.*)[^\w;&].*?$/', "\\1", truncate_utf8($item['DESCRIPTION'], 40));
Dries's avatar
 
Dries committed
726
    }
727 728 729
    else {
      $title = '';
    }
Dries's avatar
 
Dries committed
730

731
    // Resolve the items link.
732
    if (!empty($item['LINK'])) {
Dries's avatar
 
Dries committed
733
      $link = $item['LINK'];
Dries's avatar
 
Dries committed
734 735
    }
    else {
Dries's avatar
 
Dries committed
736
      $link = $feed['link'];
Dries's avatar
 
Dries committed
737
    }
738
    $guid = isset($item['GUID']) ? $item['GUID'] : '';
739

740
    // Atom feeds have a CONTENT and/or SUMMARY tag instead of a DESCRIPTION tag.
741
    if (!empty($item['CONTENT:ENCODED'])) {
742
      $item['DESCRIPTION'] = $item['CONTENT:ENCODED'];
743
    }
744
    else if (!empty($item['SUMMARY'])) {
745 746
      $item['DESCRIPTION'] = $item['SUMMARY'];
    }
747
    else if (!empty($item['CONTENT'])) {
748 749
      $item['DESCRIPTION'] = $item['CONTENT'];
    }
750

751 752
    // Try to resolve and parse the item's publication date. If no date is
    // found, we use the current date instead.
753 754 755 756 757 758 759
    $date = 'now';
    foreach (array('PUBDATE', 'DC:DATE', 'DCTERMS:ISSUED', 'DCTERMS:CREATED', 'DCTERMS:MODIFIED', 'ISSUED', 'CREATED', 'MODIFIED', 'PUBLISHED', 'UPDATED') as $key) {
      if (!empty($item[$key])) {
        $date = $item[$key];
        break;
      }
    }
Dries's avatar
 
Dries committed
760

761 762 763 764
    $timestamp = strtotime($date); // As of PHP 5.1.0, strtotime returns FALSE on failure instead of -1.
    if ($timestamp <= 0) {
      $timestamp = aggregator_parse_w3cdtf($date); // Returns FALSE on failure
      if (!$timestamp) {
Dries's avatar
 
Dries committed
765 766
        $timestamp = time(); // better than nothing
      }
767
    }
Dries's avatar
 
Dries committed
768

769 770 771
    // Save this item. Try to avoid duplicate entries as much as possible. If
    // we find a duplicate entry, we resolve it and pass along its ID is such
    // that we can update it if needed.
772
    if (!empty($guid)) {
773 774 775
      $entry = db_fetch_object(db_query("SELECT iid FROM {aggregator_item} WHERE fid = %d AND guid = '%s'", $feed['fid'], $guid));
    }
    else if ($link && $link != $feed['link'] && $link != $feed['url']) {
Dries's avatar
 
Dries committed
776
      $entry = db_fetch_object(db_query("SELECT iid FROM {aggregator_item} WHERE fid = %d AND link = '%s'", $feed['fid'], $link));
Dries's avatar
 
Dries committed
777 778
    }
    else {
Dries's avatar
 
Dries committed
779
      $entry = db_fetch_object(db_query("SELECT iid FROM {aggregator_item} WHERE fid = %d AND title = '%s'", $feed['fid'], $title));
Dries's avatar
 
Dries committed
780
    }
781 782
    $item += array('AUTHOR' => '', 'DESCRIPTION' => '');
    aggregator_save_item(array('iid' => (isset($entry->iid) ? $entry->iid:  ''), 'fid' => $feed['fid'], 'timestamp' => $timestamp, 'title' => $title, 'link' => $link, 'author' => $item['AUTHOR'], 'description' => $item['DESCRIPTION'], 'guid' => $guid));
Dries's avatar
 
Dries committed
783
  }
Dries's avatar
 
Dries committed
784

785
  // Remove all items that are older than flush item timer.
786
  $age = time() - variable_get('aggregator_clear', 9676800);
Dries's avatar
 
Dries committed
787
  $result = db_query('SELECT iid FROM {aggregator_item} WHERE fid = %d AND timestamp < %d', $feed['fid'], $age);
Dries's avatar
 
Dries committed
788

789
  $items = array();
790
  $num_rows = FALSE;
791 792
  while ($item = db_fetch_object($result)) {
    $items[] = $item->iid;
793
    $num_rows = TRUE;
794
  }
795
  if ($num_rows) {
796
    db_query('DELETE FROM {aggregator_category_item} WHERE iid IN (' . implode(', ', $items) . ')');
797
    db_query('DELETE FROM {aggregator_item} WHERE fid = %d AND timestamp < %d', $feed['fid'], $age);
Dries's avatar
 
Dries committed
798
  }
Dries's avatar
 
Dries committed
799 800

  return 1;
801 802
}

803 804 805 806 807 808
/**
 * Add/edit/delete an aggregator item.
 *
 * @param $edit
 *   An associative array describing the item to be added/edited/deleted.
 */
Kjartan's avatar
Kjartan committed
809
function aggregator_save_item($edit) {
Dries's avatar
 
Dries committed
810
  if ($edit['iid'] && $edit['title']) {
811
    db_query("UPDATE {aggregator_item} SET title = '%s', link = '%s', author = '%s', description = '%s', guid = '%s', timestamp = %d WHERE iid = %d", $edit['title'], $edit['link'], $edit['author'], $edit['description'], $edit['guid'], $edit['timestamp'], $edit['iid']);
812
  }
Dries's avatar
 
Dries committed
813 814 815
  else if ($edit['iid']) {
    db_query('DELETE FROM {aggregator_item} WHERE iid = %d', $edit['iid']);