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

  return $items;
}

249 250 251 252 253 254
/**
 * Menu callback.
 *
 * @return
 *   An aggregator category title.
 */
255 256 257 258
function _aggregator_category_title($category) {
  return $category['title'];
}

259 260 261
/**
 * Implementation of hook_init().
 */
262 263 264
function aggregator_init() {
  drupal_add_css(drupal_get_path('module', 'aggregator') .'/aggregator.css');
}
265

266 267 268 269 270 271
/**
 * 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.
 */
272 273 274
function _aggregator_has_categories() {
  return user_access('access news feeds') && db_result(db_query('SELECT COUNT(*) FROM {aggregator_category}'));
}
275

Dries's avatar
 
Dries committed
276 277 278
/**
 * Implementation of hook_perm().
 */
Kjartan's avatar
Kjartan committed
279
function aggregator_perm() {
280 281 282 283
  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
284 285
}

Dries's avatar
 
Dries committed
286 287 288 289 290
/**
 * Implementation of hook_cron().
 *
 * Checks news feeds for updates once their refresh interval has elapsed.
 */
Dries's avatar
 
Dries committed
291
function aggregator_cron() {
Dries's avatar
 
Dries committed
292
  $result = db_query('SELECT * FROM {aggregator_feed} WHERE checked + refresh < %d', time());
Dries's avatar
 
Dries committed
293 294
  while ($feed = db_fetch_array($result)) {
    aggregator_refresh($feed);
Dries's avatar
 
Dries committed
295 296 297
  }
}

Dries's avatar
 
Dries committed
298 299 300 301 302
/**
 * Implementation of hook_block().
 *
 * Generates blocks for the latest news items in each category and feed.
 */
303
function aggregator_block($op = 'list', $delta = '', $edit = array()) {
Dries's avatar
 
Dries committed
304
  if (user_access('access news feeds')) {
Dries's avatar
 
Dries committed
305
    if ($op == 'list') {
Dries's avatar
Dries committed
306
      $result = db_query('SELECT cid, title FROM {aggregator_category} ORDER BY title');
Dries's avatar
 
Dries committed
307
      while ($category = db_fetch_object($result)) {
308
        $block['category-'. $category->cid]['info'] = t('!title category latest items', array('!title' => $category->title));
Kjartan's avatar
Kjartan committed
309
      }
Dries's avatar
Dries committed
310
      $result = db_query('SELECT fid, title FROM {aggregator_feed} ORDER BY fid');
Kjartan's avatar
Kjartan committed
311
      while ($feed = db_fetch_object($result)) {
312
        $block['feed-'. $feed->fid]['info'] = t('!title feed latest items', array('!title' => $feed->title));
Kjartan's avatar
Kjartan committed
313
      }
Dries's avatar
 
Dries committed
314
    }
Dries's avatar
Dries committed
315
    else if ($op == 'configure') {
316
      list($type, $id) = explode('-', $delta);
Dries's avatar
Dries committed
317 318 319 320 321 322
      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));
      }
323
      $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)));
324
      return $form;
Dries's avatar
Dries committed
325 326
    }
    else if ($op == 'save') {
327
      list($type, $id) = explode('-', $delta);
Dries's avatar
Dries committed
328 329 330 331 332 333 334
      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);
      }
    }
335
    else if ($op == 'view') {
336
      list($type, $id) = explode('-', $delta);
Kjartan's avatar
Kjartan committed
337
      switch ($type) {
Dries's avatar
 
Dries committed
338
        case 'feed':
339
          if ($feed = db_fetch_object(db_query('SELECT fid, title, block FROM {aggregator_feed} WHERE fid = %d', $id))) {
340
            $block['subject'] = check_plain($feed->title);
341
            $result = db_query_range('SELECT * FROM {aggregator_item} WHERE fid = %d ORDER BY timestamp DESC, iid DESC', $feed->fid, 0, $feed->block);
342
            $read_more = theme('more_link', url('aggregator/sources/'. $feed->fid), t("View this feed's recent news."));
343
          }
Kjartan's avatar
Kjartan committed
344
          break;
345

Dries's avatar
 
Dries committed
346
        case 'category':
347
          if ($category = db_fetch_object(db_query('SELECT cid, title, block FROM {aggregator_category} WHERE cid = %d', $id))) {
348
            $block['subject'] = check_plain($category->title);
349
            $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);
350
            $read_more = theme('more_link', url('aggregator/categories/'. $category->cid), t("View this category's recent news."));
351
          }
Kjartan's avatar
Kjartan committed
352 353
          break;
      }
Dries's avatar
 
Dries committed
354 355
      $items = array();
      while ($item = db_fetch_object($result)) {
Dries's avatar
 
Dries committed
356
        $items[] = theme('aggregator_block_item', $item);
Dries's avatar
 
Dries committed
357
      }
358 359 360 361 362

      // 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
363
    }
364 365 366
    if (isset($block)) {
      return $block;
    }
Dries's avatar
 
Dries committed
367
  }
Dries's avatar
 
Dries committed
368 369
}

370 371
/**
 * Add/edit/delete aggregator categories.
372 373 374
 *
 * @param $edit
 *   An associative array describing the category to be added/edited/deleted.
375 376
 */
function aggregator_save_category($edit) {
377 378 379 380 381 382 383 384 385 386 387 388
  $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';
    }
389
  }
390
  else if (!empty($edit['title'])) {
391
    // A single unique id for bundles and feeds, to use in blocks
392
    db_query("INSERT INTO {aggregator_category} (title, description, block) VALUES ('%s', '%s', 5)", $edit['title'], $edit['description']);
393 394 395 396 397
    $link_path .= db_last_insert_id('aggregator', 'cid');
    $op = 'insert';
  }
  if (isset($op)) {
    menu_link_maintain('aggregator', $op, $link_path, $edit['title']);
398 399 400 401 402
  }
}

/**
 * Add/edit/delete an aggregator feed.
403 404 405
 *
 * @param $edit
 *   An associative array describing the feed to be added/edited/deleted.
406 407
 */
function aggregator_save_feed($edit) {
408
  if (!empty($edit['fid'])) {
409 410 411
    // An existing feed is being modified, delete the category listings.
    db_query('DELETE FROM {aggregator_category_feed} WHERE fid = %d', $edit['fid']);
  }
412
  if (!empty($edit['fid']) && !empty($edit['title'])) {
413 414
    db_query("UPDATE {aggregator_feed} SET title = '%s', url = '%s', refresh = %d WHERE fid = %d", $edit['title'], $edit['url'], $edit['refresh'], $edit['fid']);
  }
415
  else if (!empty($edit['fid'])) {
416
    $items = array();
417 418 419 420
    $result = db_query('SELECT iid FROM {aggregator_item} WHERE fid = %d', $edit['fid']);
    while ($item = db_fetch_object($result)) {
      $items[] = "iid = $item->iid";
    }
421
    if (!empty($items)) {
422 423 424 425 426
      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']);
  }
427
  else if (!empty($edit['title'])) {
428
    db_query("INSERT INTO {aggregator_feed} (title, url, refresh, block, description, image) VALUES ('%s', '%s', %d, 5, '', '')", $edit['title'], $edit['url'], $edit['refresh']);
429
    // A single unique id for bundles and feeds, to use in blocks.
430
    $edit['fid'] = db_last_insert_id('aggregator_feed', 'fid');
431
  }
432
  if (!empty($edit['title'])) {
433
    // The feed is being saved, save the categories as well.
434
    if (!empty($edit['category'])) {
435 436 437 438 439 440 441 442 443
      foreach ($edit['category'] as $cid => $value) {
        if ($value) {
          db_query('INSERT INTO {aggregator_category_feed} (fid, cid) VALUES (%d, %d)', $edit['fid'], $cid);
        }
      }
    }
  }
}

444 445 446 447 448 449
/**
 * Removes all items from a feed.
 *
 * @param $feed
 *   An associative array describing the feed to be cleared.
 */
Dries's avatar
 
Dries committed
450 451 452 453
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
454
  }
455
  if (!empty($items)) {
Dries's avatar
 
Dries committed
456
    db_query('DELETE FROM {aggregator_category_item} WHERE '. implode(' OR ', $items));
Dries's avatar
 
Dries committed
457
  }
Dries's avatar
 
Dries committed
458
  db_query('DELETE FROM {aggregator_item} WHERE fid = %d', $feed['fid']);
Kjartan's avatar
Kjartan committed
459
  db_query("UPDATE {aggregator_feed} SET checked = 0, etag = '', modified = 0 WHERE fid = %d", $feed['fid']);
460
  drupal_set_message(t('The news items from %site have been removed.', array('%site' => $feed['title'])));
Dries's avatar
 
Dries committed
461 462
}

Dries's avatar
 
Dries committed
463 464 465
/**
 * Call-back function used by the XML parser.
 */
Kjartan's avatar
Kjartan committed
466
function aggregator_element_start($parser, $name, $attributes) {
467
  global $item, $element, $tag, $items, $channel;
Dries's avatar
 
Dries committed
468 469

  switch ($name) {
Dries's avatar
 
Dries committed
470 471
    case 'IMAGE':
    case 'TEXTINPUT':
472 473 474 475 476 477
    case 'CONTENT':
    case 'SUMMARY':
    case 'TAGLINE':
    case 'SUBTITLE':
    case 'LOGO':
    case 'INFO':
Dries's avatar
 
Dries committed
478 479
      $element = $name;
      break;
480 481 482 483
    case 'ID':
      if ($element != 'ITEM') {
        $element = $name;
      }
484
    case 'LINK':
485
      if (!empty($attributes['REL']) && $attributes['REL'] == 'alternate') {
486 487 488 489 490 491 492 493
        if ($element == 'ITEM') {
          $items[$item]['LINK'] = $attributes['HREF'];
        }
        else {
          $channel['LINK'] = $attributes['HREF'];
        }
      }
      break;
Dries's avatar
 
Dries committed
494
    case 'ITEM':
Dries's avatar
 
Dries committed
495 496
      $element = $name;
      $item += 1;
497 498 499 500 501
      break;
    case 'ENTRY':
      $element = 'ITEM';
      $item += 1;
      break;
502 503 504 505 506
  }

  $tag = $name;
}

Dries's avatar
 
Dries committed
507 508 509
/**
 * Call-back function used by the XML parser.
 */
Kjartan's avatar
Kjartan committed
510
function aggregator_element_end($parser, $name) {
Dries's avatar
 
Dries committed
511 512
  global $element;

Dries's avatar
 
Dries committed
513
  switch ($name) {
Dries's avatar
 
Dries committed
514 515 516
    case 'IMAGE':
    case 'TEXTINPUT':
    case 'ITEM':
517 518 519
    case 'ENTRY':
    case 'CONTENT':
    case 'INFO':
520 521
      $element = '';
      break;
522
    case 'ID':
523
      if ($element == 'ID') {
524 525
        $element = '';
      }
Dries's avatar
 
Dries committed
526
  }
527 528
}

Dries's avatar
 
Dries committed
529 530 531
/**
 * Call-back function used by the XML parser.
 */
Kjartan's avatar
Kjartan committed
532
function aggregator_element_data($parser, $data) {
Dries's avatar
 
Dries committed
533
  global $channel, $element, $items, $item, $image, $tag;
534
  $items += array($item => array());
Dries's avatar
 
Dries committed
535
  switch ($element) {
Dries's avatar
 
Dries committed
536
    case 'ITEM':
537
      $items[$item] += array($tag => '');
Dries's avatar
 
Dries committed
538 539
      $items[$item][$tag] .= $data;
      break;
Dries's avatar
 
Dries committed
540
    case 'IMAGE':
541
    case 'LOGO':
542
      $image += array($tag => '');
Dries's avatar
 
Dries committed
543 544
      $image[$tag] .= $data;
      break;
545 546
    case 'LINK':
      if ($data) {
547
        $items[$item] += array($tag => '');
548 549 550 551
        $items[$item][$tag] .= $data;
      }
      break;
    case 'CONTENT':
552
      $items[$item] += array('CONTENT' => '');
553
      $items[$item]['CONTENT'] .= $data;
554 555
      break;
    case 'SUMMARY':
556
      $items[$item] += array('SUMMARY' => '');
557
      $items[$item]['SUMMARY'] .= $data;
558 559 560
      break;
    case 'TAGLINE':
    case 'SUBTITLE':
561
      $channel += array('DESCRIPTION' => '');
562 563 564 565
      $channel['DESCRIPTION'] .= $data;
      break;
    case 'INFO':
    case 'ID':
Dries's avatar
 
Dries committed
566 567 568
    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
569 570
      break;
    default:
571
      $channel += array($tag => '');
Dries's avatar
 
Dries committed
572
      $channel[$tag] .= $data;
573 574 575
  }
}

Dries's avatar
 
Dries committed
576 577
/**
 * Checks a news feed for new items.
578 579 580
 *
 * @param $feed
 *   An associative array describing the feed to be refreshed.
Dries's avatar
 
Dries committed
581
 */
Kjartan's avatar
Kjartan committed
582
function aggregator_refresh($feed) {
Dries's avatar
 
Dries committed
583 584
  global $channel, $image;

Dries's avatar
 
Dries committed
585 586 587 588 589 590
  // Generate conditional GET headers.
  $headers = array();
  if ($feed['etag']) {
    $headers['If-None-Match'] = $feed['etag'];
  }
  if ($feed['modified']) {
Dries's avatar
 
Dries committed
591
    $headers['If-Modified-Since'] = gmdate('D, d M Y H:i:s', $feed['modified']) .' GMT';
Dries's avatar
 
Dries committed
592 593 594 595 596
  }

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

597
  // Process HTTP response code.
Dries's avatar
 
Dries committed
598 599
  switch ($result->code) {
    case 304:
Dries's avatar
 
Dries committed
600
      db_query('UPDATE {aggregator_feed} SET checked = %d WHERE fid = %d', time(), $feed['fid']);
601
      drupal_set_message(t('There is no new syndicated content from %site.', array('%site' => $feed['title'])));
Dries's avatar
 
Dries committed
602
      break;
Dries's avatar
 
Dries committed
603 604
    case 301:
      $feed['url'] = $result->redirect_url;
605
      watchdog('aggregator', 'Updated URL for feed %title to %url.', array('%title' => $feed['title'], '%url' => $feed['url']));
606
      // Deliberate no break.
Dries's avatar
 
Dries committed
607 608 609 610
    case 200:
    case 302:
    case 307:
      // Filter the input data:
611
      if (aggregator_parse_feed($result->data, $feed)) {
612
        $modified = empty($result->headers['Last-Modified']) ? 0 : strtotime($result->headers['Last-Modified']);
Dries's avatar
Dries committed
613

614
        // Prepare the channel data.
615
        foreach ($channel as $key => $value) {
616
          $channel[$key] = trim($value);
617 618
        }

619
        // Prepare the image data (if any).
Dries's avatar
 
Dries committed
620 621 622
        foreach ($image as $key => $value) {
          $image[$key] = trim($value);
        }
Dries's avatar
 
Dries committed
623

624
        if (!empty($image['LINK']) && !empty($image['URL']) && !empty($image['TITLE'])) {
625 626
          // 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
          $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
627
        }
Dries's avatar
 
Dries committed
628 629 630
        else {
          $image = NULL;
        }
Dries's avatar
 
Dries committed
631

632
        $etag = empty($result->headers['ETag']) ? '' : $result->headers['ETag'];
633
        // Update the feed data.
634
        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
635

636
        // Clear the cache.
Dries's avatar
 
Dries committed
637
        cache_clear_all();
Dries's avatar
 
Dries committed
638

639
        watchdog('aggregator', 'There is new syndicated content from %site.', array('%site' => $feed['title']));
640
        drupal_set_message(t('There is new syndicated content from %site.', array('%site' => $feed['title'])));
641
        break;
Dries's avatar
 
Dries committed
642
      }
643 644
      $result->error = t('feed not parseable');
      // Deliberate no break.
Dries's avatar
 
Dries committed
645
    default:
646
      watchdog('aggregator', 'The feed from %site seems to be broken, due to "%error".', array('%site' => $feed['title'], '%error' => $result->code .' '. $result->error), WATCHDOG_WARNING);
647
      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)));
648
      module_invoke('system', 'check_http_request');
Dries's avatar
 
Dries committed
649
  }
Dries's avatar
 
Dries committed
650
}
Dries's avatar
 
Dries committed
651

Dries's avatar
 
Dries committed
652 653 654 655
/**
 * 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.
656
 * Originally from MagpieRSS (http://magpierss.sourceforge.net/).
Dries's avatar
 
Dries committed
657
 *
658 659 660 661
 * @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
662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686
 */
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 {
687
    return FALSE;
Dries's avatar
 
Dries committed
688 689 690
  }
}

691 692 693 694 695 696 697 698 699 700
/**
 * 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
701
function aggregator_parse_feed(&$data, $feed) {
Dries's avatar
 
Dries committed
702
  global $items, $image, $channel;
Dries's avatar
 
Dries committed
703

Dries's avatar
 
Dries committed
704
  // Unset the global variables before we use them:
Dries's avatar
 
Dries committed
705
  unset($GLOBALS['element'], $GLOBALS['item'], $GLOBALS['tag']);
Dries's avatar
 
Dries committed
706
  $items = array();
Dries's avatar
 
Dries committed
707
  $image = array();
Dries's avatar
 
Dries committed
708
  $channel = array();
709

Dries's avatar
 
Dries committed
710 711
  // parse the data:
  $xml_parser = drupal_xml_parser_create($data);
Dries's avatar
 
Dries committed
712 713
  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
714

Dries's avatar
 
Dries committed
715
  if (!xml_parse($xml_parser, $data, 1)) {
716
    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);
717
    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
718
    return 0;
Dries's avatar
 
Dries committed
719 720
  }
  xml_parser_free($xml_parser);
Dries's avatar
 
Dries committed
721

722 723
  // 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
724
  $items = array_reverse($items);
Dries's avatar
 
Dries committed
725

726
  // Initialize variables.
727
  $title = $link = $author = $description = $guid = NULL;
Dries's avatar
 
Dries committed
728
  foreach ($items as $item) {
729
    unset($title, $link, $author, $description, $guid);
730

Dries's avatar
 
Dries committed
731 732
    // Prepare the item:
    foreach ($item as $key => $value) {
733
      $item[$key] = trim($value);
Dries's avatar
 
Dries committed
734
    }
Dries's avatar
Dries committed
735

736 737 738
    // 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.
739
    if (!empty($item['TITLE'])) {
Dries's avatar
 
Dries committed
740
      $title = $item['TITLE'];
Dries's avatar
 
Dries committed
741
    }
742
    elseif (!empty($item['DESCRIPTION'])) {
Dries's avatar
 
Dries committed
743
      $title = preg_replace('/^(.*)[^\w;&].*?$/', "\\1", truncate_utf8($item['DESCRIPTION'], 40));
Dries's avatar
 
Dries committed
744
    }
745 746 747
    else {
      $title = '';
    }
Dries's avatar
 
Dries committed
748

749
    // Resolve the items link.
750
    if (!empty($item['LINK'])) {
Dries's avatar
 
Dries committed
751
      $link = $item['LINK'];
Dries's avatar
 
Dries committed
752 753
    }
    else {
Dries's avatar
 
Dries committed
754
      $link = $feed['link'];
Dries's avatar
 
Dries committed
755
    }
756
    $guid = isset($item['GUID']) ? $item['GUID'] : '';
757

758
    // Atom feeds have a CONTENT and/or SUMMARY tag instead of a DESCRIPTION tag.
759
    if (!empty($item['CONTENT:ENCODED'])) {
760
      $item['DESCRIPTION'] = $item['CONTENT:ENCODED'];
761
    }
762
    else if (!empty($item['SUMMARY'])) {
763 764
      $item['DESCRIPTION'] = $item['SUMMARY'];
    }
765
    else if (!empty($item['CONTENT'])) {
766 767
      $item['DESCRIPTION'] = $item['CONTENT'];
    }
768

769 770
    // Try to resolve and parse the item's publication date. If no date is
    // found, we use the current date instead.
771 772 773 774 775 776 777
    $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
778

779 780 781 782
    $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
783 784
        $timestamp = time(); // better than nothing
      }
785
    }
Dries's avatar
 
Dries committed
786

787 788 789
    // 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.
790
    if (!empty($guid)) {
791 792 793
      $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
794
      $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
795 796
    }
    else {
Dries's avatar