aggregator.module 35 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
    '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
    'access arguments' => array('access news feeds'),
205
    'type' => MENU_CALLBACK,
206
    'file' => 'aggregator.pages.inc',
207
  );
208
  $items['aggregator/sources/%aggregator_feed/view'] = array(
209
    'title' => 'View',
210 211 212
    'type' => MENU_DEFAULT_LOCAL_TASK,
    'weight' => -10,
  );
213
  $items['aggregator/sources/%aggregator_feed/categorize'] = array(
214
    'title' => 'Categorize',
215
    'page callback' => 'drupal_get_form',
216
    'page arguments' => array('aggregator_page_source', 2),
217 218
    'access arguments' => array('administer news feeds'),
    'type' => MENU_LOCAL_TASK,
219
    'file' => 'aggregator.pages.inc',
220
  );
221
  $items['aggregator/sources/%aggregator_feed/configure'] = array(
222
    'title' => 'Configure',
223 224 225 226 227
    'page callback' => 'drupal_get_form',
    'page arguments' => array('aggregator_form_feed', 2),
    'access arguments' => array('administer news feeds'),
    'type' => MENU_LOCAL_TASK,
    'weight' => 1,
228
    'file' => 'aggregator.admin.inc',
229
  );
230
  $items['admin/content/aggregator/edit/feed/%aggregator_feed'] = array(
231
    'title' => 'Edit feed',
232 233 234 235
    'page callback' => 'drupal_get_form',
    'page arguments' => array('aggregator_form_feed', 5),
    'access arguments' => array('administer news feeds'),
    'type' => MENU_CALLBACK,
236
    'file' => 'aggregator.admin.inc',
237
  );
238
  $items['admin/content/aggregator/edit/category/%aggregator_category'] = array(
239
    'title' => 'Edit category',
240 241 242 243
    'page callback' => 'drupal_get_form',
    'page arguments' => array('aggregator_form_category', 5),
    'access arguments' => array('administer news feeds'),
    'type' => MENU_CALLBACK,
244
    'file' => 'aggregator.admin.inc',
245
  );
246 247 248 249

  return $items;
}

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

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

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

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

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

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

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

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

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

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

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

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

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

  $tag = $name;
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

788 789 790
    // 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.
791
    if (!empty($guid)) {
792 793 794
      $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
795
      $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
796 797
    }
    else {
Dries's avatar
 
Dries committed
798
      $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
799
    }
800 801
    $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
802
  }
Dries's avatar
 
Dries committed
803

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

808
  $items = array();
809
  $num_rows = FALSE;
810 811
  while ($item = db_fetch_object($result)) {
    $items[] = $item->iid;
812
    $num_rows = TRUE;
813
  }
814
  if ($num_rows) {