aggregator.module 35.8 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
      $output = '<p>' . t('Thousands of sites (particularly news sites and blogs) publish their latest headlines and posts in feeds, using a number of standardized XML-based formats. Formats supported by the aggregator include <a href="@rss">RSS</a>, <a href="@rdf">RDF</a>, and <a href="@atom">Atom</a>.', array('@rss' => 'http://cyber.law.harvard.edu/rss/', '@rdf' => 'http://www.w3.org/RDF/', '@atom' => 'http://www.atomenabled.org')) . '</p>';
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>';
27 28
    case 'admin/content/aggregator/add/opml':
      return '<p>' . t('<acronym title="Outline Processor Markup Language">OPML</acronym> is an XML format used to exchange multiple feeds between aggregators. A single OPML document may contain a collection of many feeds. Drupal can parse such a file and import all feeds at once, saving you the effort of adding them manually. You may either upload a local file from your computer or enter a URL where Drupal can download it.') . '</p>';
Dries's avatar
 
Dries committed
29
  }
30 31
}

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

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

  return $items;
}

241 242 243 244 245 246
/**
 * Menu callback.
 *
 * @return
 *   An aggregator category title.
 */
247 248 249 250
function _aggregator_category_title($category) {
  return $category['title'];
}

251 252 253
/**
 * Implementation of hook_init().
 */
254
function aggregator_init() {
255
  drupal_add_css(drupal_get_path('module', 'aggregator') . '/aggregator.css');
256
}
257

258 259 260 261 262 263
/**
 * 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.
 */
264
function _aggregator_has_categories() {
265
  return user_access('access news feeds') && db_query('SELECT COUNT(*) FROM {aggregator_category}')->fetchField();
266
}
267

Dries's avatar
 
Dries committed
268 269 270
/**
 * Implementation of hook_perm().
 */
Kjartan's avatar
Kjartan committed
271
function aggregator_perm() {
272
  return array(
273 274 275 276 277 278 279 280
    'administer news feeds' => array(
      'title' => t('Administer news feeds'),
      'description' => t('Add, edit or delete news feeds that are aggregated to your site.'),
    ),
    'access news feeds' => array(
      'title' => t('Access news feeds'),
      'description' => t('View aggregated news feed items.'),
    ),
281
  );
Dries's avatar
 
Dries committed
282 283
}

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

Dries's avatar
 
Dries committed
296 297 298 299 300
/**
 * Implementation of hook_block().
 *
 * Generates blocks for the latest news items in each category and feed.
 */
301
function aggregator_block($op = 'list', $delta = '', $edit = array()) {
Dries's avatar
 
Dries committed
302
  if (user_access('access news feeds')) {
Dries's avatar
 
Dries committed
303
    if ($op == 'list') {
Dries's avatar
Dries committed
304
      $result = db_query('SELECT cid, title FROM {aggregator_category} ORDER BY title');
305
      foreach ($result as $category) {
306
        $block['category-' . $category->cid]['info'] = t('!title category latest items', array('!title' => $category->title));
Kjartan's avatar
Kjartan committed
307
      }
308
      $result = db_query('SELECT fid, title FROM {aggregator_feed} WHERE block <> 0 ORDER BY fid');
309
      foreach ($result as $feed) {
310
        $block['feed-' . $feed->fid]['info'] = t('!title feed latest items', array('!title' => $feed->title));
Kjartan's avatar
Kjartan committed
311
      }
Dries's avatar
 
Dries committed
312
    }
313
    elseif ($op == 'configure') {
314
      list($type, $id) = explode('-', $delta);
Dries's avatar
Dries committed
315
      if ($type == 'category') {
316
        $value = db_query('SELECT block FROM {aggregator_category} WHERE cid = :cid', array(':cid' => $id))->fetchField();
317 318 319 320 321 322 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))
        );
        return $form;
Dries's avatar
Dries committed
324 325
      }
    }
326
    elseif ($op == 'save') {
327
      list($type, $id) = explode('-', $delta);
Dries's avatar
Dries committed
328
      if ($type == 'category') {
329 330 331 332
        db_merge('aggregator_category')
          ->key(array('cid' => $id))
          ->fields(array('block' => $edit['block']))
          ->execute();
Dries's avatar
Dries committed
333 334
      }
    }
335
    elseif ($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_query('SELECT fid, title, block FROM {aggregator_feed} WHERE block <> 0 AND fid = :fid', array(':fid' => $id))->fetchObject()) {
340
            $block['subject'] = check_plain($feed->title);
341
            $result = db_query_range("SELECT * FROM {aggregator_item} WHERE fid = :fid ORDER BY timestamp DESC, iid DESC", array(':fid' => $id), 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_query('SELECT cid, title, block FROM {aggregator_category} WHERE cid = :cid', array(':cid' => $id))->fetchObject()) {
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 = :cid ORDER BY i.timestamp DESC, i.iid DESC', array(':cid' => $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
      $items = array();
355
      foreach ($result as $item) {
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
  $link_path = 'aggregator/categories/';
  if (!empty($edit['cid'])) {
    $link_path .= $edit['cid'];
    if (!empty($edit['title'])) {
381 382 383 384 385 386 387
      db_merge('aggregator_category')
        ->key(array('cid' => $edit['cid']))
        ->fields(array(
          'title' => $edit['title'],
          'description' => $edit['description'],
        ))
        ->execute();
388 389 390
      $op = 'update';
    }
    else {
391 392 393
      db_delete('aggregator_category')
        ->condition('cid', $edit['cid'])
        ->execute();
394
      // Make sure there is no active block for this category.
395 396 397 398
      db_delete('blocks')
        ->condition('module', 'aggregator')
        ->condition('delta', 'category-' . $edit['cid'])
        ->execute();
399 400 401
      $edit['title'] = '';
      $op = 'delete';
    }
402
  }
403 404
  elseif (!empty($edit['title'])) {
    // A single unique id for bundles and feeds, to use in blocks.
405 406 407 408 409 410
    $link_path .= db_insert('aggregator_category')
      ->fields(array(
        'title' => $edit['title'],
        'description' => $edit['description'],
      ))
      ->execute();
411 412 413 414
    $op = 'insert';
  }
  if (isset($op)) {
    menu_link_maintain('aggregator', $op, $link_path, $edit['title']);
415 416 417 418 419
  }
}

/**
 * Add/edit/delete an aggregator feed.
420 421 422
 *
 * @param $edit
 *   An associative array describing the feed to be added/edited/deleted.
423 424
 */
function aggregator_save_feed($edit) {
425
  if (!empty($edit['fid'])) {
426
    // An existing feed is being modified, delete the category listings.
427 428 429
    db_delete('aggregator_category_feed')
      ->condition('fid', $edit['fid'])
      ->execute();
430
  }
431
  if (!empty($edit['fid']) && !empty($edit['title'])) {
432 433 434 435 436 437 438 439 440
    db_update('aggregator_feed')
      ->condition('fid', $edit['fid'])
      ->fields(array(
        'title' => $edit['title'],
        'url' => $edit['url'],
        'refresh' => $edit['refresh'],
        'block' => $edit['block'],
      ))
      ->execute();
441
  }
442
  elseif (!empty($edit['fid'])) {
443 444 445 446 447
    $iids = db_query('SELECT iid FROM {aggregator_item} WHERE fid = :fid', array(':fid' => $edit['fid']))->fetchCol();
    if ($iids) {
      db_delete('aggregator_category_item')
        ->condition('iid', $iids, 'IN')
        ->execute();
448
    }
449 450 451 452 453 454
    db_delete('aggregator_feed')->
      condition('fid', $edit['fid'])
      ->execute();
    db_delete('aggregator_item')
      ->condition('fid', $edit['fid'])
      ->execute();
455
    // Make sure there is no active block for this feed.
456 457 458 459
    db_delete('blocks')
      ->condition('module', 'aggregator')
      ->condition('delta', 'feed-' . $edit['fid'])
      ->execute();
460
  }
461
  elseif (!empty($edit['title'])) {
462 463 464 465 466 467 468 469 470 471
    $edit['fid'] = db_insert('aggregator_feed')
      ->fields(array(
        'title' => $edit['title'],
        'url' => $edit['url'],
        'refresh' => $edit['refresh'],
        'block' => $edit['block'],
        'description' => '',
        'image' => '',
      ))
      ->execute();
472

473
  }
474
  if (!empty($edit['title'])) {
475
    // The feed is being saved, save the categories as well.
476
    if (!empty($edit['category'])) {
477 478
      foreach ($edit['category'] as $cid => $value) {
        if ($value) {
479 480 481 482 483 484
          db_merge('aggregator_category_feed')
            ->fields(array(
              'fid' => $edit['fid'],
              'cid' => $cid,
            ))
            ->execute();
485 486 487 488 489 490
        }
      }
    }
  }
}

491 492 493 494 495 496
/**
 * Removes all items from a feed.
 *
 * @param $feed
 *   An associative array describing the feed to be cleared.
 */
Dries's avatar
 
Dries committed
497
function aggregator_remove($feed) {
498 499 500 501 502
  $iids = db_query('SELECT iid FROM {aggregator_item} WHERE fid = :fid', array(':fid' => $feed['fid']))->fetchCol();
  if ($iids) {
    db_delete('aggregator_category_item')
      ->condition('iid', $iids, 'IN')
      ->execute();
Dries's avatar
 
Dries committed
503
  }
504

505 506 507 508 509 510 511 512 513 514 515 516 517
  db_delete('aggregator_item')
    ->condition('fid', $feed['fid'])
    ->execute();
  db_merge('aggregator_feed')
    ->key(array('fid' => $feed['fid']))
    ->fields(array(
      'checked' => 0,
      'hash' => '',
      'modified' => 0,
      'description' => $feed['description'],
      'image' => $feed['image'],
    ))
    ->execute();
518
  drupal_set_message(t('The news items from %site have been removed.', array('%site' => $feed['title'])));
Dries's avatar
 
Dries committed
519 520
}

Dries's avatar
 
Dries committed
521
/**
522
 * Callback function used by the XML parser.
Dries's avatar
 
Dries committed
523
 */
Kjartan's avatar
Kjartan committed
524
function aggregator_element_start($parser, $name, $attributes) {
525
  global $item, $element, $tag, $items, $channel;
Dries's avatar
 
Dries committed
526 527

  switch ($name) {
Dries's avatar
 
Dries committed
528 529
    case 'IMAGE':
    case 'TEXTINPUT':
530 531 532 533 534 535
    case 'CONTENT':
    case 'SUMMARY':
    case 'TAGLINE':
    case 'SUBTITLE':
    case 'LOGO':
    case 'INFO':
Dries's avatar
 
Dries committed
536 537
      $element = $name;
      break;
538 539 540 541
    case 'ID':
      if ($element != 'ITEM') {
        $element = $name;
      }
542
    case 'LINK':
543
      if (!empty($attributes['REL']) && $attributes['REL'] == 'alternate') {
544 545 546 547 548 549 550 551
        if ($element == 'ITEM') {
          $items[$item]['LINK'] = $attributes['HREF'];
        }
        else {
          $channel['LINK'] = $attributes['HREF'];
        }
      }
      break;
Dries's avatar
 
Dries committed
552
    case 'ITEM':
Dries's avatar
 
Dries committed
553 554
      $element = $name;
      $item += 1;
555 556 557 558 559
      break;
    case 'ENTRY':
      $element = 'ITEM';
      $item += 1;
      break;
560 561 562 563 564
  }

  $tag = $name;
}

Dries's avatar
 
Dries committed
565 566 567
/**
 * Call-back function used by the XML parser.
 */
Kjartan's avatar
Kjartan committed
568
function aggregator_element_end($parser, $name) {
Dries's avatar
 
Dries committed
569 570
  global $element;

Dries's avatar
 
Dries committed
571
  switch ($name) {
Dries's avatar
 
Dries committed
572 573 574
    case 'IMAGE':
    case 'TEXTINPUT':
    case 'ITEM':
575 576 577
    case 'ENTRY':
    case 'CONTENT':
    case 'INFO':
578 579
      $element = '';
      break;
580
    case 'ID':
581
      if ($element == 'ID') {
582 583
        $element = '';
      }
Dries's avatar
 
Dries committed
584
  }
585 586
}

Dries's avatar
 
Dries committed
587
/**
588
 * Callback function used by the XML parser.
Dries's avatar
 
Dries committed
589
 */
Kjartan's avatar
Kjartan committed
590
function aggregator_element_data($parser, $data) {
Dries's avatar
 
Dries committed
591
  global $channel, $element, $items, $item, $image, $tag;
592
  $items += array($item => array());
Dries's avatar
 
Dries committed
593
  switch ($element) {
Dries's avatar
 
Dries committed
594
    case 'ITEM':
595
      $items[$item] += array($tag => '');
Dries's avatar
 
Dries committed
596 597
      $items[$item][$tag] .= $data;
      break;
Dries's avatar
 
Dries committed
598
    case 'IMAGE':
599
    case 'LOGO':
600
      $image += array($tag => '');
Dries's avatar
 
Dries committed
601 602
      $image[$tag] .= $data;
      break;
603 604
    case 'LINK':
      if ($data) {
605
        $items[$item] += array($tag => '');
606 607 608 609
        $items[$item][$tag] .= $data;
      }
      break;
    case 'CONTENT':
610
      $items[$item] += array('CONTENT' => '');
611
      $items[$item]['CONTENT'] .= $data;
612 613
      break;
    case 'SUMMARY':
614
      $items[$item] += array('SUMMARY' => '');
615
      $items[$item]['SUMMARY'] .= $data;
616 617 618
      break;
    case 'TAGLINE':
    case 'SUBTITLE':
619
      $channel += array('DESCRIPTION' => '');
620 621 622 623
      $channel['DESCRIPTION'] .= $data;
      break;
    case 'INFO':
    case 'ID':
Dries's avatar
 
Dries committed
624 625 626
    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
627 628
      break;
    default:
629
      $channel += array($tag => '');
Dries's avatar
 
Dries committed
630
      $channel[$tag] .= $data;
631 632 633
  }
}

Dries's avatar
 
Dries committed
634 635
/**
 * Checks a news feed for new items.
636 637 638
 *
 * @param $feed
 *   An associative array describing the feed to be refreshed.
Dries's avatar
 
Dries committed
639
 */
Kjartan's avatar
Kjartan committed
640
function aggregator_refresh($feed) {
Dries's avatar
 
Dries committed
641 642
  global $channel, $image;

Dries's avatar
 
Dries committed
643 644 645 646 647 648
  // Generate conditional GET headers.
  $headers = array();
  if ($feed['etag']) {
    $headers['If-None-Match'] = $feed['etag'];
  }
  if ($feed['modified']) {
649
    $headers['If-Modified-Since'] = gmdate('D, d M Y H:i:s', $feed['modified']) . ' GMT';
Dries's avatar
 
Dries committed
650 651 652 653 654
  }

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

655
  // Process HTTP response code.
Dries's avatar
 
Dries committed
656 657
  switch ($result->code) {
    case 304:
658 659 660 661
      db_update('aggregator_feed')
        ->fields(array('checked' => REQUEST_TIME))
        ->condition('fid', $feed['fid'])
        ->execute();
662
      drupal_set_message(t('There is no new syndicated content from %site.', array('%site' => $feed['title'])));
Dries's avatar
 
Dries committed
663
      break;
Dries's avatar
 
Dries committed
664 665
    case 301:
      $feed['url'] = $result->redirect_url;
666
      // Do not break here.
Dries's avatar
 
Dries committed
667 668 669
    case 200:
    case 302:
    case 307:
670 671 672 673 674
      // We store the md5 hash of feed data in the database. When refreshing a
      // feed we compare stored hash and new hash calculated from downloaded
      // data. If both are equal we say that feed is not updated.
      $md5 = md5($result->data);
      if ($feed['hash'] == $md5) {
675 676 677 678
        db_update('aggregator_feed')
          ->condition('fid', $feed['fid'])
          ->fields(array('checked' => REQUEST_TIME))
          ->execute();
679 680 681 682
        drupal_set_message(t('There is no new syndicated content from %site.', array('%site' => $feed['title'])));
        break;
      }

683
      // Filter the input data.
684
      if (aggregator_parse_feed($result->data, $feed)) {
685
        $modified = empty($result->headers['Last-Modified']) ? 0 : strtotime($result->headers['Last-Modified']);
Dries's avatar
Dries committed
686

687
        // Prepare the channel data.
688
        foreach ($channel as $key => $value) {
689
          $channel[$key] = trim($value);
690 691
        }

692
        // Prepare the image data (if any).
Dries's avatar
 
Dries committed
693 694 695
        foreach ($image as $key => $value) {
          $image[$key] = trim($value);
        }
Dries's avatar
 
Dries committed
696

697
        if (!empty($image['LINK']) && !empty($image['URL']) && !empty($image['TITLE'])) {
698
          $image = l(theme('image', $image['URL'], $image['TITLE']), $image['LINK'], array('html' => TRUE));
Dries's avatar
 
Dries committed
699
        }
Dries's avatar
 
Dries committed
700
        else {
701
          $image = '';
Dries's avatar
 
Dries committed
702
        }
Dries's avatar
 
Dries committed
703

704
        $etag = empty($result->headers['ETag']) ? '' : $result->headers['ETag'];
705
        // Update the feed data.
706 707 708 709 710 711 712 713 714 715 716 717 718
        db_merge('aggregator_feed')
          ->key(array('fid' => $feed['fid']))
          ->fields(array(
            'url' => $feed['url'],
            'checked' => REQUEST_TIME,
            'link' => $channel['LINK'],
            'description' => $channel['DESCRIPTION'],
            'image' => $image,
            'hash' => $md5,
            'etag' => $etag,
            'modified' => $modified,
          ))
          ->execute();
Dries's avatar
 
Dries committed
719

720
        // Clear the cache.
Dries's avatar
 
Dries committed
721
        cache_clear_all();
Dries's avatar
 
Dries committed
722

723 724 725 726
        if (isset($result->redirect_url)) {
          watchdog('aggregator', 'Updated URL for feed %title to %url.', array('%title' => $feed['title'], '%url' => $feed['url']));
        }

727
        watchdog('aggregator', 'There is new syndicated content from %site.', array('%site' => $feed['title']));
728
        drupal_set_message(t('There is new syndicated content from %site.', array('%site' => $feed['title'])));
Dries's avatar
 
Dries committed
729
      }
730
      break;
Dries's avatar
 
Dries committed
731
    default:
732 733
      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)));
734
      module_invoke('system', 'check_http_request');
Dries's avatar
 
Dries committed
735
  }
Dries's avatar
 
Dries committed
736
}
Dries's avatar
 
Dries committed
737

Dries's avatar
 
Dries committed
738
/**
739 740 741
 * Parse the W3C date/time format, a subset of ISO 8601.
 *
 * PHP date parsing functions do not handle this format.
Dries's avatar
 
Dries committed
742
 * See http://www.w3.org/TR/NOTE-datetime for more information.
743
 * Originally from MagpieRSS (http://magpierss.sourceforge.net/).
Dries's avatar
 
Dries committed
744
 *
745 746 747 748
 * @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
749 750 751 752
 */
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]);
753
    // Calculate the epoch for current date assuming GMT.
Dries's avatar
 
Dries committed
754 755 756
    $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]);
757
      // Zero out the variables.
Dries's avatar
 
Dries committed
758 759 760 761 762 763 764
      if (!$tz_hour) {
        $tz_hour = 0;
      }
      if (!$tz_min) {
        $tz_min = 0;
      }
      $offset_secs = (($tz_hour * 60) + $tz_min) * 60;
765
      // Is timezone ahead of GMT?  If yes, subtract offset.
Dries's avatar
 
Dries committed
766 767 768 769 770 771 772 773
      if ($tz_mod == '+') {
        $offset_secs *= -1;
      }
      $epoch += $offset_secs;
    }
    return $epoch;
  }
  else {
774
    return FALSE;
Dries's avatar
 
Dries committed
775 776 777
  }
}

778 779 780 781 782 783 784 785
/**
 * Parse a feed and store its items.
 *
 * @param $data
 *   The feed data.
 * @param $feed
 *   An associative array describing the feed to be parsed.
 * @return
786
 *   FALSE on error, TRUE otherwise.
787
 */
Dries's avatar
 
Dries committed
788
function aggregator_parse_feed(&$data, $feed) {
Dries's avatar
 
Dries committed
789
  global $items, $image, $channel;
Dries's avatar
 
Dries committed
790

791
  // Unset the global variables before we use them.
Dries's avatar
 
Dries committed
792
  unset($GLOBALS['element'], $GLOBALS['item'], $GLOBALS['tag']);
Dries's avatar
 
Dries committed
793
  $items = array();
Dries's avatar
 
Dries committed
794
  $image = array();
Dries's avatar
 
Dries committed
795
  $channel = array();
796

797
  // Parse the data.
Dries's avatar
 
Dries committed
798
  $xml_parser = drupal_xml_parser_create($data);
Dries's avatar
 
Dries committed
799 800
  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
801

Dries's avatar
 
Dries committed
802
  if (!xml_parse($xml_parser, $data, 1)) {
803
    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);
804
    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');
805
    return FALSE;
Dries's avatar
 
Dries committed
806 807
  }
  xml_parser_free($xml_parser);
Dries's avatar
 
Dries committed
808

809 810
  // 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
811
  $items = array_reverse($items);
Dries's avatar
 
Dries committed
812

813
  // Initialize variables.
814
  $title = $link = $author = $description = $guid = NULL;
Dries's avatar
 
Dries committed
815
  foreach ($items as $item) {
816
    unset($title, $link, $author, $description, $guid);
817

Dries's avatar
 
Dries committed
818 819
    // Prepare the item:
    foreach ($item as $key => $value) {
820
      $item[$key] = trim($value);
Dries's avatar
 
Dries committed
821
    }
Dries's avatar
Dries committed
822

823
    // Resolve the item's title. If no title is found, we use up to 40
824
    // characters of the description ending at a word boundary, but not
825
    // splitting potential entities.
826
    if (!empty($item['TITLE'])) {
Dries's avatar
 
Dries committed
827
      $title = $item['TITLE'];
Dries's avatar
 
Dries committed
828
    }
829
    elseif (!empty($item['DESCRIPTION'])) {
Dries's avatar
 
Dries committed
830
      $title = preg_replace('/^(.*)[^\w;&].*?$/', "\\1", truncate_utf8($item['DESCRIPTION'], 40));
Dries's avatar
 
Dries committed
831
    }
832 833 834
    else {
      $title = '';
    }
Dries's avatar
 
Dries committed
835

836
    // Resolve the items link.
837
    if (!empty($item['LINK'])) {
Dries's avatar
 
Dries committed
838
      $link = $item['LINK'];
Dries's avatar
 
Dries committed
839 840
    }
    else {
Dries's avatar
 
Dries committed
841
      $link = $feed['link'];
Dries's avatar
 
Dries committed
842
    }
843
    $guid = isset($item['GUID']) ? $item['GUID'] : '';
844

845
    // Atom feeds have a CONTENT and/or SUMMARY tag instead of a DESCRIPTION tag.