aggregator.module 34.7 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://blogs.law.harvard.edu/tech/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://blogs/law.harvard.edu/tech/rss', '@rdf' => 'http://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',
109 110 111 112
    'page callback' => 'aggregator_admin_remove_feed',
    'page arguments' => array(4),
    '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() {
Dries's avatar
 
Dries committed
280
  return array('administer news feeds', 'access news feeds');
Dries's avatar
 
Dries committed
281 282
}

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

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

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

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

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

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

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

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

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

  $tag = $name;
}

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

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

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

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

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

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

594
  // Process HTTP response code.
Dries's avatar
 
Dries committed
595 596
  switch ($result->code) {
    case 304:
Dries's avatar
 
Dries committed
597
      db_query('UPDATE {aggregator_feed} SET checked = %d WHERE fid = %d', time(), $feed['fid']);
598
      drupal_set_message(t('There is no new syndicated content from %site.', array('%site' => $feed['title'])));
Dries's avatar
 
Dries committed
599
      break;
Dries's avatar
 
Dries committed
600 601
    case 301:
      $feed['url'] = $result->redirect_url;
602
      watchdog('aggregator', 'Updated URL for feed %title to %url.', array('%title' => $feed['title'], '%url' => $feed['url']));
603

Dries's avatar
 
Dries committed
604 605 606 607
    case 200:
    case 302:
    case 307:
      // Filter the input data:
608
      if (aggregator_parse_feed($result->data, $feed)) {
609

610
        $modified = empty($result->headers['Last-Modified']) ? 0 : strtotime($result->headers['Last-Modified']);
Dries's avatar
Dries committed
611

612 613 614 615 616
        /*
        ** Prepare the channel data:
        */

        foreach ($channel as $key => $value) {
617
          $channel[$key] = trim($value);
618 619
        }

Dries's avatar
 
Dries committed
620 621 622
        /*
        ** Prepare the image data (if any):
        */
Dries's avatar
 
Dries committed
623

Dries's avatar
 
Dries committed
624 625 626
        foreach ($image as $key => $value) {
          $image[$key] = trim($value);
        }
Dries's avatar
 
Dries committed
627

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

636
        $etag = empty($result->headers['ETag']) ? '' : $result->headers['ETag'];
Dries's avatar
 
Dries committed
637 638 639
        /*
        ** Update the feed data:
        */
Dries's avatar
 
Dries committed
640

641
        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
642

Dries's avatar
 
Dries committed
643 644 645
        /*
        ** Clear the cache:
        */
Dries's avatar
 
Dries committed
646

Dries's avatar
 
Dries committed
647
        cache_clear_all();
Dries's avatar
 
Dries committed
648

649
        watchdog('aggregator', 'There is new syndicated content from %site.', array('%site' => $feed['title']));
650
        drupal_set_message(t('There is new syndicated content from %site.', array('%site' => $feed['title'])));
Dries's avatar
 
Dries committed
651 652
      }
      break;
Dries's avatar
 
Dries committed
653
    default:
654
      watchdog('aggregator', 'The feed from %site seems to be broken, due to "%error".', array('%site' => $feed['title'], '%error' => $result->code .' '. $result->error), WATCHDOG_WARNING);
655
      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)));
Dries's avatar
 
Dries committed
656
  }
Dries's avatar
 
Dries committed
657
}
Dries's avatar
 
Dries committed
658

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

698 699 700 701 702 703 704 705 706 707
/**
 * 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
708
function aggregator_parse_feed(&$data, $feed) {
Dries's avatar
 
Dries committed
709
  global $items, $image, $channel;
Dries's avatar
 
Dries committed
710

Dries's avatar
 
Dries committed
711
  // Unset the global variables before we use them:
Dries's avatar
 
Dries committed
712
  unset($GLOBALS['element'], $GLOBALS['item'], $GLOBALS['tag']);
Dries's avatar
 
Dries committed
713
  $items = array();
Dries's avatar
 
Dries committed
714
  $image = array();
Dries's avatar
 
Dries committed
715
  $channel = array();
716

Dries's avatar
 
Dries committed
717 718
  // parse the data:
  $xml_parser = drupal_xml_parser_create($data);
Dries's avatar
 
Dries committed
719 720
  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
721

Dries's avatar
 
Dries committed
722
  if (!xml_parse($xml_parser, $data, 1)) {
723
    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);
724
    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
725
    return 0;
Dries's avatar
 
Dries committed
726 727
  }
  xml_parser_free($xml_parser);
Dries's avatar
 
Dries committed
728

Dries's avatar
 
Dries committed
729 730
  /*
  ** We reverse the array such that we store the first item last,
731
  ** and the last item first. In the database, the newest item
Dries's avatar
 
Dries committed
732 733
  ** should be at the top.
  */
Dries's avatar
 
Dries committed
734

Dries's avatar
 
Dries committed
735
  $items = array_reverse($items);
Dries's avatar
 
Dries committed
736

737 738
  // Initialize variables
  $title = $link = $author = $description = $guid = NULL;
Dries's avatar
 
Dries committed
739
  foreach ($items as $item) {
740
    unset($title, $link, $author, $description, $guid);
741

Dries's avatar
 
Dries committed
742 743
    // Prepare the item:
    foreach ($item as $key => $value) {
744
      $item[$key] = trim($value);
Dries's avatar
 
Dries committed
745
    }
Dries's avatar
Dries committed
746

Dries's avatar
 
Dries committed
747
    /*
748
    ** Resolve the item's title. If no title is found, we use
Dries's avatar
 
Dries committed
749 750 751 752
    ** up to 40 characters of the description ending at a word
    ** boundary but not splitting potential entities.
    */

753
    if (!empty($item['TITLE'])) {
Dries's avatar
 
Dries committed
754
      $title = $item['TITLE'];
Dries's avatar
 
Dries committed
755
    }
756
    elseif (!empty($item['DESCRIPTION'])) {
Dries's avatar
 
Dries committed
757
      $title = preg_replace('/^(.*)[^\w;&].*?$/', "\\1", truncate_utf8($item['DESCRIPTION'], 40));
Dries's avatar
 
Dries committed
758
    }
759 760 761
    else {
      $title = '';
    }
Dries's avatar
 
Dries committed
762

Dries's avatar
 
Dries committed
763 764 765 766
    /*
    ** Resolve the items link.
    */

767
    if (!empty($item['LINK'])) {
Dries's avatar
 
Dries committed
768
      $link = $item['LINK'];
Dries's avatar
 
Dries committed
769 770
    }
    else {
Dries's avatar
 
Dries committed
771
      $link = $feed['link'];
Dries's avatar
 
Dries committed
772
    }
773
    $guid = isset($item['GUID']) ? $item['GUID'] : '';
774

775 776 777
    /**
     * Atom feeds have a CONTENT and/or SUMMARY tag instead of a DESCRIPTION tag
     */
778
    if (!empty($item['CONTENT:ENCODED'])) {
779
      $item['DESCRIPTION'] = $item['CONTENT:ENCODED'];
780
    }
781
    else if (!empty($item['SUMMARY'])) {
782 783
      $item['DESCRIPTION'] = $item['SUMMARY'];
    }
784
    else if (!empty($item['CONTENT'])) {
785 786
      $item['DESCRIPTION'] = $item['CONTENT'];
    }
787

Dries's avatar
 
Dries committed
788
    /*
789
    ** Try to resolve and parse the item's publication date. If no
Dries's avatar
 
Dries committed
790 791 792
    ** date is found, we use the current date instead.
    */

793 794 795 796 797 798 799
    $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
800

801 802 803 804
    $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
805 806
        $timestamp = time(); // better than nothing
      }
807
    }
Dries's avatar
 
Dries committed
808 809

    /*
810