aggregator.module 35.9 KB
Newer Older
1
<?php
Dries's avatar
Dries committed
2
// $Id$
Dries's avatar
   
Dries committed
3

Dries's avatar
   
Dries committed
4
5
/**
 * @file
6
 * Used to aggregate syndicated content (RSS, RDF, and Atom).
Dries's avatar
   
Dries committed
7
8
 */

Dries's avatar
   
Dries committed
9
10
11
/**
 * Implementation of hook_help().
 */
12
13
function aggregator_help($path, $arg) {
  switch ($path) {
Kjartan's avatar
Kjartan committed
14
    case 'admin/help#aggregator':
15
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
265
266
function _aggregator_has_categories() {
  return user_access('access news feeds') && db_result(db_query('SELECT COUNT(*) FROM {aggregator_category}'));
}
267

Dries's avatar
   
Dries committed
268
269
270
/**
 * Implementation of hook_perm().
 */
Kjartan's avatar
Kjartan committed
271
function aggregator_perm() {
272
273
274
275
  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
276
277
}

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

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

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

      // 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
354
    }
355
356
357
    if (isset($block)) {
      return $block;
    }
Dries's avatar
   
Dries committed
358
  }
Dries's avatar
   
Dries committed
359
360
}

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

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

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

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

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

  $tag = $name;
}

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

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

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

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

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

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

592
  // Process HTTP response code.
Dries's avatar
   
Dries committed
593
594
  switch ($result->code) {
    case 304:
595
      db_query('UPDATE {aggregator_feed} SET checked = %d WHERE fid = %d', REQUEST_TIME, $feed['fid']);
596
      drupal_set_message(t('There is no new syndicated content from %site.', array('%site' => $feed['title'])));
Dries's avatar
   
Dries committed
597
      break;
Dries's avatar
   
Dries committed
598
599
    case 301:
      $feed['url'] = $result->redirect_url;
600
      // Do not break here.
Dries's avatar
   
Dries committed
601
602
603
    case 200:
    case 302:
    case 307:
604
605
606
607
608
      // 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) {
609
        db_query('UPDATE {aggregator_feed} SET checked = %d WHERE fid = %d', REQUEST_TIME, $feed['fid']);
610
611
612
613
        drupal_set_message(t('There is no new syndicated content from %site.', array('%site' => $feed['title'])));
        break;
      }

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

618
        // Prepare the channel data.
619
        foreach ($channel as $key => $value) {
620
          $channel[$key] = trim($value);
621
622
        }

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

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

637
        $etag = empty($result->headers['ETag']) ? '' : $result->headers['ETag'];
638
        // Update the feed data.
639
        db_query("UPDATE {aggregator_feed} SET url = '%s', checked = %d, link = '%s', description = '%s', image = '%s', hash = '%s', etag = '%s', modified = %d WHERE fid = %d", $feed['url'], REQUEST_TIME, $channel['LINK'], $channel['DESCRIPTION'], $image, $md5, $etag, $modified, $feed['fid']);
Dries's avatar
   
Dries committed
640

641
        // Clear the cache.
Dries's avatar
   
Dries committed
642
        cache_clear_all();
Dries's avatar
   
Dries committed
643

644
645
646
647
        if (isset($result->redirect_url)) {
          watchdog('aggregator', 'Updated URL for feed %title to %url.', array('%title' => $feed['title'], '%url' => $feed['url']));
        }

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

Dries's avatar
   
Dries committed
659
/**
660
661
662
 * Parse the W3C date/time format, a subset of ISO 8601.
 *
 * PHP date parsing functions do not handle this format.
Dries's avatar
   
Dries committed
663
 * See http://www.w3.org/TR/NOTE-datetime for more information.
664
 * Originally from MagpieRSS (http://magpierss.sourceforge.net/).
Dries's avatar
   
Dries committed
665
 *
666
667
668
669
 * @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
670
671
672
673
 */
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]);
674
    // Calculate the epoch for current date assuming GMT.
Dries's avatar
   
Dries committed
675
676
677
    $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]);
678
      // Zero out the variables.
Dries's avatar
   
Dries committed
679
680
681
682
683
684
685
      if (!$tz_hour) {
        $tz_hour = 0;
      }
      if (!$tz_min) {
        $tz_min = 0;
      }
      $offset_secs = (($tz_hour * 60) + $tz_min) * 60;
686
      // Is timezone ahead of GMT?  If yes, subtract offset.
Dries's avatar
   
Dries committed
687
688
689
690
691
692
693
694
      if ($tz_mod == '+') {
        $offset_secs *= -1;
      }
      $epoch += $offset_secs;
    }
    return $epoch;
  }
  else {
695
    return FALSE;
Dries's avatar
   
Dries committed
696
697
698
  }
}

699
700
701
702
703
704
705
706
/**
 * Parse a feed and store its items.
 *
 * @param $data
 *   The feed data.
 * @param $feed
 *   An associative array describing the feed to be parsed.
 * @return
707
 *   FALSE on error, TRUE otherwise.
708
 */
Dries's avatar
   
Dries committed
709
function aggregator_parse_feed(&$data, $feed) {
Dries's avatar
   
Dries committed
710
  global $items, $image, $channel;
Dries's avatar
   
Dries committed
711

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

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

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

730
731
  // 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
732
  $items = array_reverse($items);
Dries's avatar
   
Dries committed
733

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

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

744
    // Resolve the item's title. If no title is found, we use up to 40
745
    // characters of the description ending at a word boundary, but not
746
    // splitting potential entities.
747
    if (!empty($item['TITLE'])) {
Dries's avatar
   
Dries committed
748
      $title = $item['TITLE'];
Dries's avatar
   
Dries committed
749
    }
750
    elseif (!empty($item['DESCRIPTION'])) {
Dries's avatar
   
Dries committed
751
      $title = preg_replace('/^(.*)[^\w;&].*?$/', "\\1", truncate_utf8($item['DESCRIPTION'], 40));
Dries's avatar
   
Dries committed
752
    }
753
754
755
    else {
      $title = '';
    }
Dries's avatar
   
Dries committed
756

757
    // Resolve the items link.
758
    if (!empty($item['LINK'])) {
Dries's avatar
   
Dries committed
759
      $link = $item['LINK'];
Dries's avatar
   
Dries committed
760
761
    }
    else {
Dries's avatar
   
Dries committed
762
      $link = $feed['link'];
Dries's avatar
   
Dries committed
763
    }
764
    $guid = isset($item['GUID']) ? $item['GUID'] : '';
765

766
    // Atom feeds have a CONTENT and/or SUMMARY tag instead of a DESCRIPTION tag.
767
    if (!empty($item['CONTENT:ENCODED'])) {
768
      $item['DESCRIPTION'] = $item['CONTENT:ENCODED'];
769
    }
770
    elseif (!empty($item['SUMMARY'])) {
771
772
      $item['DESCRIPTION'] = $item['SUMMARY'];
    }
773
    elseif (!empty($item['CONTENT'])) {
774
775
      $item['DESCRIPTION'] = $item['CONTENT'];
    }
776

777
778
    // Try to resolve and parse the item's publication date.
    $date = '';
779
780
781
782
783
784
    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
785

786
    $timestamp = strtotime($date); // As of PHP 5.1.0, strtotime returns FALSE on failure instead of -1.
787

788
    if ($timestamp <= 0) {
789
      $timestamp = aggregator_parse_w3cdtf($date); // Aggregator_parse_w3cdtf() returns FALSE on failure.
790
    }
Dries's avatar
   
Dries committed
791

792
793
794
    // 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.
795
    if (!empty($guid)) {
796
      $entry = db_fetch_object(db_query("SELECT iid, timestamp FROM {aggregator_item} WHERE fid = %d AND guid = '%s'", $feed['fid'], $guid));
797
798
    }
    else if ($link && $link != $feed['link'] && $link != $feed['url']) {
799
      $entry = db_fetch_object(db_query("SELECT iid, timestamp FROM {aggregator_item} WHERE fid = %d AND link = '%s'", $feed['fid'], $link));
Dries's avatar
   
Dries committed
800
801
    }
    else {
802
803
804
805
      $entry = db_fetch_object(db_query("SELECT iid, timestamp FROM {aggregator_item} WHERE fid = %d AND title = '%s'", $feed['fid'], $title));
    }

    if (!$timestamp) {
806
      $timestamp = isset($entry->timestamp) ? $entry->timestamp : REQUEST_TIME;
Dries's avatar
   
Dries committed
807
    }
808
    $item += array('AUTHOR' => '', 'DESCRIPTION' => '');
809
    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
810
  }
Dries's avatar
   
Dries committed
811

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

816
  $items = array();
817
  $num_rows = FALSE;
818
819
  while ($item = db_fetch_object($result)) {
    $items[] = $item->iid;
820
    $num_rows = TRUE;
821
  }
822
  if ($num_rows) {
823
    db_query('DELETE FROM {aggregator_category_item} WHERE iid IN (' . implode(', ', $items) . ')');
824
    db_query('DELETE FROM {aggregator_item} WHERE fid = %d AND timestamp < %d', $feed['fid'], $age);
Dries's avatar
   
Dries committed
825
  }
Dries's avatar
   
Dries committed
826

827
  return TRUE;
828
829
}

830
831
832
833
834
835
/**
 * Add/edit/delete an aggregator item.
 *
 * @param $edit
 *   An associative array describing the item to be added/edited/deleted.
 */
Kjartan's avatar
Kjartan committed
836
function aggregator_save_item($edit) {
Dries's avatar
   
Dries committed
837
  if ($edit['iid'] && $edit['title']) {
838
    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']);
839
  }
840
  elseif ($edit['iid']) {
Dries's avatar
   
Dries committed
841
842
    db_query('DELETE FROM {aggregator_item} WHERE iid = %d', $edit['iid']);
    db_query('DELETE FROM {aggregator_category_item} WHERE iid = %d', $edit['iid']);
843
  }
844
  elseif ($edit['title'] && $edit['link']) {
845
846