aggregator.module 31.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
      $output = '<p>'. t('The news aggregator is a powerful on-site RSS syndicator/news reader that can gather fresh content from news sites and weblogs around the web.') .'</p>';
16 17
      $output .= '<p>'. t('Users can view the latest news chronologically in the <a href="@aggregator">main news aggregator display</a> or by <a href="@aggregator-sources">source</a>. Administrators can add, edit and delete feeds and choose how often to check for newly updated news for each individual feed. Administrators can also tag individual feeds with categories, offering selective grouping of some feeds into separate displays. Listings of the latest news for individual sources or categorized sources can be enabled as blocks for display in the sidebar through the <a href="@admin-block">block administration page</a>. The news aggregator requires cron to check for the latest news from the sites to which you have subscribed. Drupal also provides a <a href="@aggregator-opml">machine-readable OPML file</a> of all of your subscribed feeds.', array('@aggregator' => url('aggregator'), '@aggregator-sources' => url('aggregator/sources'), '@admin-block' => url('admin/build/block'), '@aggregator-opml' => url('aggregator/opml'))) .'</p>';
      $output .= '<p>'. t('For more information please read the configuration and customization handbook <a href="@aggregator">Aggregator page</a>.', array('@aggregator' => 'http://drupal.org/handbook/modules/aggregator/')) .'</p>';
18
      return $output;
19
    case 'admin/content/aggregator':
20
      return '<p>'. t('Thousands of sites (particularly news sites and weblogs) publish their latest headlines and/or stories in a machine-readable format so that other sites can easily link to them. This content is usually in the form of an <a href="http://blogs.law.harvard.edu/tech/rss">RSS</a> feed (which is an XML-based syndication standard). To display the feed or category in a block you must decide how many items to show by editing the feed or block and turning on the <a href="@block">feed\'s block</a>.', array('@block' => url('admin/build/block'))) .'</p>';
21
    case 'admin/content/aggregator/add/feed':
22
      return '<p>'. t('Add a site that has an RSS/RDF/Atom feed. The URL is the full path to the feed file. For the feed to update automatically you must run "cron.php" on a regular basis. If you already have a feed with the URL you are planning to use, the system will not accept another feed with the same URL.') .'</p>';
23
    case 'admin/content/aggregator/add/category':
24
      return '<p>'. t('Categories provide a way to group items from different news feeds together. Each news category has its own feed page and block. For example, you could tag various sport-related feeds as belonging to a category called <em>Sports</em>. News items can be added to a category automatically by setting a feed to automatically place its item into that category, or by using the categorize items link in any listing of news items.') .'</p>';
Dries's avatar
 
Dries committed
25
  }
26 27
}

28 29 30 31 32 33 34
/**
 * Implementation of hook_theme()
 */
function aggregator_theme() {
  return array(
    'aggregator_page_list' => array(
      'arguments' => array('form' => NULL),
35
      'file' => 'aggregator.pages.inc',
36 37 38
    ),
    'aggregator_feed' => array(
      'arguments' => array('feed' => NULL),
39
      'file' => 'aggregator.pages.inc',
40 41 42 43 44 45
    ),
    'aggregator_block_item' => array(
      'arguments' => array('item' => NULL, 'feed' => 0),
    ),
    'aggregator_summary_item' => array(
      'arguments' => array('item' => NULL),
46
      'file' => 'aggregator.pages.inc',
47 48 49
    ),
    'aggregator_page_item' => array(
      'arguments' => array('item' => NULL),
50
      'file' => 'aggregator.pages.inc',
51 52
    ),
  );
53
}
54

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

  return $items;
}

226 227 228 229
function _aggregator_category_title($category) {
  return $category['title'];
}

230 231 232
function aggregator_init() {
  drupal_add_css(drupal_get_path('module', 'aggregator') .'/aggregator.css');
}
233 234 235 236

function _aggregator_has_categories() {
  return user_access('access news feeds') && db_result(db_query('SELECT COUNT(*) FROM {aggregator_category}'));
}
237

Dries's avatar
Dries committed
238

Dries's avatar
 
Dries committed
239

Dries's avatar
 
Dries committed
240 241 242
/**
 * Implementation of hook_perm().
 */
Kjartan's avatar
Kjartan committed
243
function aggregator_perm() {
Dries's avatar
 
Dries committed
244
  return array('administer news feeds', 'access news feeds');
Dries's avatar
 
Dries committed
245 246
}

Dries's avatar
 
Dries committed
247 248 249 250 251
/**
 * Implementation of hook_cron().
 *
 * Checks news feeds for updates once their refresh interval has elapsed.
 */
Dries's avatar
 
Dries committed
252
function aggregator_cron() {
Dries's avatar
 
Dries committed
253
  $result = db_query('SELECT * FROM {aggregator_feed} WHERE checked + refresh < %d', time());
Dries's avatar
 
Dries committed
254 255
  while ($feed = db_fetch_array($result)) {
    aggregator_refresh($feed);
Dries's avatar
 
Dries committed
256 257 258
  }
}

Dries's avatar
 
Dries committed
259 260 261 262 263
/**
 * Implementation of hook_block().
 *
 * Generates blocks for the latest news items in each category and feed.
 */
264
function aggregator_block($op = 'list', $delta = 0, $edit = array()) {
Dries's avatar
 
Dries committed
265
  if (user_access('access news feeds')) {
Dries's avatar
 
Dries committed
266
    if ($op == 'list') {
Dries's avatar
Dries committed
267
      $result = db_query('SELECT cid, title FROM {aggregator_category} ORDER BY title');
Dries's avatar
 
Dries committed
268
      while ($category = db_fetch_object($result)) {
269
        $block['category-'. $category->cid]['info'] = t('!title category latest items', array('!title' => $category->title));
Kjartan's avatar
Kjartan committed
270
      }
Dries's avatar
Dries committed
271
      $result = db_query('SELECT fid, title FROM {aggregator_feed} ORDER BY fid');
Kjartan's avatar
Kjartan committed
272
      while ($feed = db_fetch_object($result)) {
273
        $block['feed-'. $feed->fid]['info'] = t('!title feed latest items', array('!title' => $feed->title));
Kjartan's avatar
Kjartan committed
274
      }
Dries's avatar
 
Dries committed
275
    }
Dries's avatar
Dries committed
276
    else if ($op == 'configure') {
277
      list($type, $id) = explode('-', $delta);
Dries's avatar
Dries committed
278 279 280 281 282 283
      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));
      }
284
      $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)));
285
      return $form;
Dries's avatar
Dries committed
286 287
    }
    else if ($op == 'save') {
288
      list($type, $id) = explode('-', $delta);
Dries's avatar
Dries committed
289 290 291 292 293 294 295
      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);
      }
    }
296
    else if ($op == 'view') {
297
      list($type, $id) = explode('-', $delta);
Kjartan's avatar
Kjartan committed
298
      switch ($type) {
Dries's avatar
 
Dries committed
299
        case 'feed':
300
          if ($feed = db_fetch_object(db_query('SELECT fid, title, block FROM {aggregator_feed} WHERE fid = %d', $id))) {
301
            $block['subject'] = check_plain($feed->title);
302
            $result = db_query_range('SELECT * FROM {aggregator_item} WHERE fid = %d ORDER BY timestamp DESC, iid DESC', $feed->fid, 0, $feed->block);
303
            $read_more = '<div class="more-link">'. l(t('more'), 'aggregator/sources/'. $feed->fid, array('title' => t("View this feed's recent news."))) .'</div>';
304
          }
Kjartan's avatar
Kjartan committed
305
          break;
306

Dries's avatar
 
Dries committed
307
        case 'category':
308
          if ($category = db_fetch_object(db_query('SELECT cid, title, block FROM {aggregator_category} WHERE cid = %d', $id))) {
309
            $block['subject'] = check_plain($category->title);
310
            $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);
311
            $read_more = '<div class="more-link">'. l(t('more'), 'aggregator/categories/'. $category->cid, array('title' => t("View this category's recent news."))) .'</div>';
312
          }
Kjartan's avatar
Kjartan committed
313 314
          break;
      }
Dries's avatar
 
Dries committed
315 316
      $items = array();
      while ($item = db_fetch_object($result)) {
Dries's avatar
 
Dries committed
317
        $items[] = theme('aggregator_block_item', $item);
Dries's avatar
 
Dries committed
318
      }
319 320 321 322 323

      // 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
324
    }
325 326 327
    if (isset($block)) {
      return $block;
    }
Dries's avatar
 
Dries committed
328
  }
Dries's avatar
 
Dries committed
329 330
}

331 332 333 334
/**
 * Add/edit/delete aggregator categories.
 */
function aggregator_save_category($edit) {
335
  if (!empty($edit['cid']) && !empty($edit['title'])) {
336 337
    db_query("UPDATE {aggregator_category} SET title = '%s', description = '%s' WHERE cid = %d", $edit['title'], $edit['description'], $edit['cid']);
  }
338
  else if (!empty($edit['cid'])) {
339 340
    db_query('DELETE FROM {aggregator_category} WHERE cid = %d', $edit['cid']);
  }
341
  else if (!empty($edit['title'])) {
342
    // A single unique id for bundles and feeds, to use in blocks
343
    db_query("INSERT INTO {aggregator_category} (title, description, block) VALUES ('%s', '%s', 5)", $edit['title'], $edit['description']);
344 345 346 347 348 349 350
  }
}

/**
 * Add/edit/delete an aggregator feed.
 */
function aggregator_save_feed($edit) {
351
  if (!empty($edit['fid'])) {
352 353 354
    // An existing feed is being modified, delete the category listings.
    db_query('DELETE FROM {aggregator_category_feed} WHERE fid = %d', $edit['fid']);
  }
355
  if (!empty($edit['fid']) && !empty($edit['title'])) {
356 357
    db_query("UPDATE {aggregator_feed} SET title = '%s', url = '%s', refresh = %d WHERE fid = %d", $edit['title'], $edit['url'], $edit['refresh'], $edit['fid']);
  }
358
  else if (!empty($edit['fid'])) {
359
    $items = array();
360 361 362 363
    $result = db_query('SELECT iid FROM {aggregator_item} WHERE fid = %d', $edit['fid']);
    while ($item = db_fetch_object($result)) {
      $items[] = "iid = $item->iid";
    }
364
    if (!empty($items)) {
365 366 367 368 369
      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']);
  }
370
  else if (!empty($edit['title'])) {
371
    db_query("INSERT INTO {aggregator_feed} (title, url, refresh, block, description, image) VALUES ('%s', '%s', %d, 5, '', '')", $edit['title'], $edit['url'], $edit['refresh']);
372
    // A single unique id for bundles and feeds, to use in blocks.
373
    $edit['fid'] = db_last_insert_id('aggregator_feed', 'fid');
374
  }
375
  if (!empty($edit['title'])) {
376
    // The feed is being saved, save the categories as well.
377
    if (!empty($edit['category'])) {
378 379 380 381 382 383 384 385 386
      foreach ($edit['category'] as $cid => $value) {
        if ($value) {
          db_query('INSERT INTO {aggregator_category_feed} (fid, cid) VALUES (%d, %d)', $edit['fid'], $cid);
        }
      }
    }
  }
}

Dries's avatar
 
Dries committed
387 388 389 390
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
391
  }
392
  if (!empty($items)) {
Dries's avatar
 
Dries committed
393
    db_query('DELETE FROM {aggregator_category_item} WHERE '. implode(' OR ', $items));
Dries's avatar
 
Dries committed
394
  }
Dries's avatar
 
Dries committed
395
  db_query('DELETE FROM {aggregator_item} WHERE fid = %d', $feed['fid']);
Kjartan's avatar
Kjartan committed
396
  db_query("UPDATE {aggregator_feed} SET checked = 0, etag = '', modified = 0 WHERE fid = %d", $feed['fid']);
397
  drupal_set_message(t('The news items from %site have been removed.', array('%site' => $feed['title'])));
Dries's avatar
 
Dries committed
398 399
}

Dries's avatar
 
Dries committed
400 401 402
/**
 * Call-back function used by the XML parser.
 */
Kjartan's avatar
Kjartan committed
403
function aggregator_element_start($parser, $name, $attributes) {
404
  global $item, $element, $tag, $items, $channel;
Dries's avatar
 
Dries committed
405 406

  switch ($name) {
Dries's avatar
 
Dries committed
407 408
    case 'IMAGE':
    case 'TEXTINPUT':
409 410 411 412 413 414
    case 'CONTENT':
    case 'SUMMARY':
    case 'TAGLINE':
    case 'SUBTITLE':
    case 'LOGO':
    case 'INFO':
Dries's avatar
 
Dries committed
415 416
      $element = $name;
      break;
417 418 419 420
    case 'ID':
      if ($element != 'ITEM') {
        $element = $name;
      }
421
    case 'LINK':
422
      if (!empty($attributes['REL']) && $attributes['REL'] == 'alternate') {
423 424 425 426 427 428 429 430
        if ($element == 'ITEM') {
          $items[$item]['LINK'] = $attributes['HREF'];
        }
        else {
          $channel['LINK'] = $attributes['HREF'];
        }
      }
      break;
Dries's avatar
 
Dries committed
431
    case 'ITEM':
Dries's avatar
 
Dries committed
432 433
      $element = $name;
      $item += 1;
434 435 436 437 438
      break;
    case 'ENTRY':
      $element = 'ITEM';
      $item += 1;
      break;
439 440 441 442 443
  }

  $tag = $name;
}

Dries's avatar
 
Dries committed
444 445 446
/**
 * Call-back function used by the XML parser.
 */
Kjartan's avatar
Kjartan committed
447
function aggregator_element_end($parser, $name) {
Dries's avatar
 
Dries committed
448 449
  global $element;

Dries's avatar
 
Dries committed
450
  switch ($name) {
Dries's avatar
 
Dries committed
451 452 453
    case 'IMAGE':
    case 'TEXTINPUT':
    case 'ITEM':
454 455 456
    case 'ENTRY':
    case 'CONTENT':
    case 'INFO':
457 458
      $element = '';
      break;
459
    case 'ID':
460
      if ($element == 'ID') {
461 462
        $element = '';
      }
Dries's avatar
 
Dries committed
463
  }
464 465
}

Dries's avatar
 
Dries committed
466 467 468
/**
 * Call-back function used by the XML parser.
 */
Kjartan's avatar
Kjartan committed
469
function aggregator_element_data($parser, $data) {
Dries's avatar
 
Dries committed
470
  global $channel, $element, $items, $item, $image, $tag;
471
  $items += array($item => array());
Dries's avatar
 
Dries committed
472
  switch ($element) {
Dries's avatar
 
Dries committed
473
    case 'ITEM':
474
      $items[$item] += array($tag => '');
Dries's avatar
 
Dries committed
475 476
      $items[$item][$tag] .= $data;
      break;
Dries's avatar
 
Dries committed
477
    case 'IMAGE':
478
    case 'LOGO':
479
      $image += array($tag => '');
Dries's avatar
 
Dries committed
480 481
      $image[$tag] .= $data;
      break;
482 483
    case 'LINK':
      if ($data) {
484
        $items[$item] += array($tag => '');
485 486 487 488
        $items[$item][$tag] .= $data;
      }
      break;
    case 'CONTENT':
489
      $items[$item] += array('CONTENT' => '');
490
      $items[$item]['CONTENT'] .= $data;
491 492
      break;
    case 'SUMMARY':
493
      $items[$item] += array('SUMMARY' => '');
494
      $items[$item]['SUMMARY'] .= $data;
495 496 497
      break;
    case 'TAGLINE':
    case 'SUBTITLE':
498
      $channel += array('DESCRIPTION' => '');
499 500 501 502
      $channel['DESCRIPTION'] .= $data;
      break;
    case 'INFO':
    case 'ID':
Dries's avatar
 
Dries committed
503 504 505
    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
506 507
      break;
    default:
508
      $channel += array($tag => '');
Dries's avatar
 
Dries committed
509
      $channel[$tag] .= $data;
510 511 512
  }
}

Dries's avatar
 
Dries committed
513 514 515
/**
 * Checks a news feed for new items.
 */
Kjartan's avatar
Kjartan committed
516
function aggregator_refresh($feed) {
Dries's avatar
 
Dries committed
517 518
  global $channel, $image;

Dries's avatar
 
Dries committed
519 520 521 522 523 524
  // Generate conditional GET headers.
  $headers = array();
  if ($feed['etag']) {
    $headers['If-None-Match'] = $feed['etag'];
  }
  if ($feed['modified']) {
Dries's avatar
 
Dries committed
525
    $headers['If-Modified-Since'] = gmdate('D, d M Y H:i:s', $feed['modified']) .' GMT';
Dries's avatar
 
Dries committed
526 527 528 529 530
  }

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

531
  // Process HTTP response code.
Dries's avatar
 
Dries committed
532 533
  switch ($result->code) {
    case 304:
Dries's avatar
 
Dries committed
534
      db_query('UPDATE {aggregator_feed} SET checked = %d WHERE fid = %d', time(), $feed['fid']);
535
      drupal_set_message(t('There is no new syndicated content from %site.', array('%site' => $feed['title'])));
Dries's avatar
 
Dries committed
536
      break;
Dries's avatar
 
Dries committed
537 538
    case 301:
      $feed['url'] = $result->redirect_url;
539
      watchdog('aggregator', 'Updated URL for feed %title to %url.', array('%title' => $feed['title'], '%url' => $feed['url']));
540

Dries's avatar
 
Dries committed
541 542 543 544
    case 200:
    case 302:
    case 307:
      // Filter the input data:
545
     if (aggregator_parse_feed($result->data, $feed)) {
546

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

549 550 551 552 553
        /*
        ** Prepare the channel data:
        */

        foreach ($channel as $key => $value) {
554
          $channel[$key] = trim($value);
555 556
        }

Dries's avatar
 
Dries committed
557 558 559
        /*
        ** Prepare the image data (if any):
        */
Dries's avatar
 
Dries committed
560

Dries's avatar
 
Dries committed
561 562 563
        foreach ($image as $key => $value) {
          $image[$key] = trim($value);
        }
Dries's avatar
 
Dries committed
564

565
        if (!empty($image['LINK']) && !empty($image['URL']) && !empty($image['TITLE'])) {
566 567
          // 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
568
        }
Dries's avatar
 
Dries committed
569 570 571
        else {
          $image = NULL;
        }
Dries's avatar
 
Dries committed
572

573
        $etag = empty($result->headers['ETag']) ? '' : $result->headers['ETag'];
Dries's avatar
 
Dries committed
574 575 576
        /*
        ** Update the feed data:
        */
Dries's avatar
 
Dries committed
577

578
        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
579

Dries's avatar
 
Dries committed
580 581 582
        /*
        ** Clear the cache:
        */
Dries's avatar
 
Dries committed
583

Dries's avatar
 
Dries committed
584
        cache_clear_all();
Dries's avatar
 
Dries committed
585

586
        watchdog('aggregator', 'There is new syndicated content from %site.', array('%site' => $feed['title']));
587
        drupal_set_message(t('There is new syndicated content from %site.', array('%site' => $feed['title'])));
Dries's avatar
 
Dries committed
588 589
      }
      break;
Dries's avatar
 
Dries committed
590
    default:
591
      watchdog('aggregator', 'The feed from %site seems to be broken, due to "%error".', array('%site' => $feed['title'], '%error' => $result->code .' '. $result->error), WATCHDOG_WARNING);
592
      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
593
  }
Dries's avatar
 
Dries committed
594
}
Dries's avatar
 
Dries committed
595

Dries's avatar
 
Dries committed
596 597 598 599
/**
 * 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.
600
 * Originally from MagpieRSS (http://magpierss.sourceforge.net/).
Dries's avatar
 
Dries committed
601 602
 *
 * @param $date_str A string with a potentially W3C DTF date.
603
 * @return A timestamp if parsed successfully or -1 if not.
Dries's avatar
 
Dries committed
604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628
 */
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 {
629
    return FALSE;
Dries's avatar
 
Dries committed
630 631 632
  }
}

Dries's avatar
 
Dries committed
633
function aggregator_parse_feed(&$data, $feed) {
Dries's avatar
 
Dries committed
634
  global $items, $image, $channel;
Dries's avatar
 
Dries committed
635

Dries's avatar
 
Dries committed
636
  // Unset the global variables before we use them:
Dries's avatar
 
Dries committed
637
  unset($GLOBALS['element'], $GLOBALS['item'], $GLOBALS['tag']);
Dries's avatar
 
Dries committed
638
  $items = array();
Dries's avatar
 
Dries committed
639
  $image = array();
Dries's avatar
 
Dries committed
640
  $channel = array();
641

Dries's avatar
 
Dries committed
642 643
  // parse the data:
  $xml_parser = drupal_xml_parser_create($data);
Dries's avatar
 
Dries committed
644 645
  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
646

Dries's avatar
 
Dries committed
647
  if (!xml_parse($xml_parser, $data, 1)) {
648
    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);
649
    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
650
    return 0;
Dries's avatar
 
Dries committed
651 652
  }
  xml_parser_free($xml_parser);
Dries's avatar
 
Dries committed
653

Dries's avatar
 
Dries committed
654 655
  /*
  ** We reverse the array such that we store the first item last,
656
  ** and the last item first. In the database, the newest item
Dries's avatar
 
Dries committed
657 658
  ** should be at the top.
  */
Dries's avatar
 
Dries committed
659

Dries's avatar
 
Dries committed
660
  $items = array_reverse($items);
Dries's avatar
 
Dries committed
661

662 663
  // Initialize variables
  $title = $link = $author = $description = $guid = NULL;
Dries's avatar
 
Dries committed
664
  foreach ($items as $item) {
665
    unset($title, $link, $author, $description, $guid);
666

Dries's avatar
 
Dries committed
667 668
    // Prepare the item:
    foreach ($item as $key => $value) {
669
      $item[$key] = trim($value);
Dries's avatar
 
Dries committed
670
    }
Dries's avatar
Dries committed
671

Dries's avatar
 
Dries committed
672
    /*
673
    ** Resolve the item's title. If no title is found, we use
Dries's avatar
 
Dries committed
674 675 676 677
    ** up to 40 characters of the description ending at a word
    ** boundary but not splitting potential entities.
    */

678
    if (!empty($item['TITLE'])) {
Dries's avatar
 
Dries committed
679
      $title = $item['TITLE'];
Dries's avatar
 
Dries committed
680
    }
681
    elseif (!empty($item['DESCRIPTION'])) {
Dries's avatar
 
Dries committed
682
      $title = preg_replace('/^(.*)[^\w;&].*?$/', "\\1", truncate_utf8($item['DESCRIPTION'], 40));
Dries's avatar
 
Dries committed
683
    }
684 685 686
    else {
      $title = '';
    }
Dries's avatar
 
Dries committed
687

Dries's avatar
 
Dries committed
688 689 690 691
    /*
    ** Resolve the items link.
    */

692
    if (!empty($item['LINK'])) {
Dries's avatar
 
Dries committed
693
      $link = $item['LINK'];
Dries's avatar
 
Dries committed
694 695
    }
    else {
Dries's avatar
 
Dries committed
696
      $link = $feed['link'];
Dries's avatar
 
Dries committed
697
    }
698
    $guid = isset($item['GUID']) ? $item['GUID'] : '';
699

700 701 702
    /**
     * Atom feeds have a CONTENT and/or SUMMARY tag instead of a DESCRIPTION tag
     */
703
    if (!empty($item['CONTENT:ENCODED'])) {
704
      $item['DESCRIPTION'] = $item['CONTENT:ENCODED'];
705
    }
706
    else if (!empty($item['SUMMARY'])) {
707 708
      $item['DESCRIPTION'] = $item['SUMMARY'];
    }
709
    else if (!empty($item['CONTENT'])) {
710 711
      $item['DESCRIPTION'] = $item['CONTENT'];
    }
712

Dries's avatar
 
Dries committed
713
    /*
714
    ** Try to resolve and parse the item's publication date. If no
Dries's avatar
 
Dries committed
715 716 717
    ** date is found, we use the current date instead.
    */

718 719 720 721 722 723 724
    $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
725

726 727 728 729
    $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
730 731
        $timestamp = time(); // better than nothing
      }
732
    }
Dries's avatar
 
Dries committed
733 734

    /*
735 736
    ** Save this item. Try to avoid duplicate entries as much as
    ** possible. If we find a duplicate entry, we resolve it and
Dries's avatar
 
Dries committed
737
    ** pass along it's ID such that we can update it if needed.
Dries's avatar
 
Dries committed
738 739
    */

740
    if (!empty($guid)) {
741 742 743
      $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
744
      $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
745 746
    }
    else {
Dries's avatar
 
Dries committed
747
      $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
748
    }
749 750
    $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
751
  }
Dries's avatar
 
Dries committed
752

Dries's avatar
 
Dries committed
753
  /*
754
  ** Remove all items that are older than flush item timer:
Dries's avatar
 
Dries committed
755
  */
Dries's avatar
 
Dries committed
756

757
  $age = time() - variable_get('aggregator_clear', 9676800);
Dries's avatar
 
Dries committed
758
  $result = db_query('SELECT iid FROM {aggregator_item} WHERE fid = %d AND timestamp < %d', $feed['fid'], $age);
Dries's avatar
 
Dries committed
759

760
  $items = array();
761
  $num_rows = FALSE;
762 763
  while ($item = db_fetch_object($result)) {
    $items[] = $item->iid;
764
    $num_rows = TRUE;
765
  }
766
  if ($num_rows) {
767 768
    db_query('DELETE FROM {aggregator_category_item} WHERE iid IN ('. implode(', ', $items) .')');
    db_query('DELETE FROM {aggregator_item} WHERE fid = %d AND timestamp < %d', $feed['fid'], $age);
Dries's avatar
 
Dries committed
769
  }
Dries's avatar
 
Dries committed
770 771

  return 1;
772 773
}

Kjartan's avatar
Kjartan committed
774
function aggregator_save_item($edit) {
Dries's avatar
 
Dries committed
775
  if ($edit['iid'] && $edit['title']) {
776
    db_query("UPDATE {aggregator_item} SET title = '%s', link = '%s', author = '%s', description = '%s', guid = '%s', timestamp = %d WHERE iid = %d", $edit['title'], $edit['link'], $edit['author'], $edit['description'], $edit['guid'], $edit['timestamp'], $edit['iid']);