aggregator.module 48.1 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
6
7
8
/**
 * @file
 * Used to aggregate syndicated content (RSS and RDF).
 */

Dries's avatar
   
Dries committed
9
10
11
/**
 * Implementation of hook_help().
 */
Dries's avatar
   
Dries committed
12
function aggregator_help($section) {
Dries's avatar
   
Dries committed
13
  switch ($section) {
Kjartan's avatar
Kjartan committed
14
    case 'admin/help#aggregator':
Dries's avatar
   
Dries committed
15
      return t('
Dries's avatar
   
Dries committed
16
17
18
19
20
21
22
      <p>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).</p>
      <p>You can read aggregated content from many sites using RSS feed readers, such as <a href="http://www.disobey.com/amphetadesk/">Amphetadesk</a>.</p>
      <p>Drupal provides the means to aggregate feeds from many sites and display these aggregated feeds to your site\'s visitors. To do this, enable the aggregator module in site administration and then go to the aggregator configuration page, where you can subscribe to feeds and set up other options.</p>
      <h3>How do I find RSS feeds to aggregate?</h3>
      <p>Many web sites (especially weblogs) display small XML icons or other obvious links on their home page. You can follow these to obtain the web address for the RSS feed. Common extensions for RSS feeds are .rss, .xml and .rdf. For example: <a href="http://slashdot.org/slashdot.rdf">Slashdot RSS</a>.</p>
      <p>If you can\'t find a feed for a site, or you want to find several feeds on a given topic, try an RSS syndication directory such as <a href="http://www.syndic8.com/">Syndic8</a>.</p>
      <p>To learn more about RSS, read Mark Pilgrim\'s <a href="http://www.xml.com/pub/a/2002/12/18/dive-into-xml.html">What is RSS</a> and WebReference.com\'s <a href="http://www.webreference.com/authoring/languages/xml/rss/1/">The Evolution of RSS</a> articles.</p>
Dries's avatar
   
Dries committed
23
      <p>NOTE: Enable your site\'s XML syndication button by turning on the Syndicate block in block management.</p>
Dries's avatar
   
Dries committed
24
      <h3>How do I add a news feed?</h3>
Dries's avatar
   
Dries committed
25
26
      <p>To subscribe to an RSS feed on another site, use the <a href="%admin-news">aggregation page</a>.</p>
      <p>Once there, click the <a href="%new-feed">new feed</a> tab.  Drupal will then ask for the following:</p>
Dries's avatar
   
Dries committed
27
      <ul>
Dries's avatar
   
Dries committed
28
29
30
       <li><strong>Title</strong> -- The text entered here will be used in your news aggregator, within the administration configuration section, and as a title for the news feed block. As a general rule, use the web site name from which the feed originates.</li>
       <li><strong>URL</strong> -- Here you\'ll enter the fully-qualified web address for the feed you wish to subscribe to.</li>
       <li><strong>Update interval</strong> -- This is how often Drupal will scan the feed for new content. This defaults to every hour. Checking a feed more frequently that this is typically a waste of bandwidth and is considered somewhat impolite. For automatic updates to work, cron.php must be called regularly. If it is not, you\'ll have to manually update the feeds one at a time within the news aggregation administration page by using <a href="%update-items">update items</a>.</li>
Dries's avatar
Dries committed
31
       <li><strong>Categorize news items</strong> -- As items are received from a feed they will be put in any categories you have selected here.</li>
Dries's avatar
   
Dries committed
32
      </ul>
Dries's avatar
   
Dries committed
33
      <p>Once you have submitted the new feed, check to make sure it is working properly by selecting <a href="%update-items">update items</a> on the <a href="%admin-news">aggregation page</a>. If you do not see any items listed for that feed, edit the feed and make sure that the URL was entered correctly.</p>
Dries's avatar
   
Dries committed
34
      <h3>Adding categories</h3>
Dries's avatar
   
Dries committed
35
      <p>News items can be filed into categories. To create a category, start at the <a href="%admin-news">aggregation page</a>.</p>
Dries's avatar
   
Dries committed
36
      <p>Once there, select <a href="%new-category">new category</a> from the menu. Drupal will then ask for the following:</p>
Dries's avatar
   
Dries committed
37
      <ul>
Dries's avatar
   
Dries committed
38
       <li><strong>Title</strong> -- The title will be used in the <em>news by topics</em> listing in your news aggregator and for the block created for the bundle.</li>
Dries's avatar
   
Dries committed
39
       <li><strong>Description</strong> -- A short description of the category to tell users more details about what news items they might find in the category.</li>
Dries's avatar
   
Dries committed
40
41
42
43
      </ul>
      <h3>Using the news aggregator</h3>
      <p>The news aggregator has a number of ways that it displays your subscribed content:</p>
      <ul>
Dries's avatar
   
Dries committed
44
45
46
       <li><strong><a href="%news-aggregator">News aggregator</a></strong> (latest news) -- Displays all incoming items in the order in which they were received.</li>
       <li><strong><a href="%sources">Sources</a></strong> -- Organizes incoming content by feed, displaying feed titles (each of which links to a page with the latest items from that feed) and item titles (which link to that item\'s actual story/article).</li>
       <li><strong><a href="%categories">Categories</a></strong> -- Organizes incoming content by category, displaying category titles (each of which links to a page with the latest items from that category) and item titles (which link to that item\'s actual story/article).</li>
Dries's avatar
   
Dries committed
47
      </ul>
Dries's avatar
   
Dries committed
48
      <p>Pages that display items (for sources, categories, etc.) display the following for each item:
Dries's avatar
   
Dries committed
49
      <ul>
Dries's avatar
   
Dries committed
50
51
52
53
       <li>The title of the item (its headline).</li>
       <li>The categories that the item belongs to, each of which links to that particular category page as detailed above.</li>
       <li>A description containing the first few paragraphs or a summary of the item (if available).</li>
       <li>The name of the feed, which links to the individual feed\'s page, listing information about that feed and items for that feed only. This is not shown on feed pages (they would link to the page you\'re currently on).</li>
Dries's avatar
   
Dries committed
54
      </ul>
Dries's avatar
   
Dries committed
55
      <p>Additionally, users with the <em>administer news feeds permission</em> will see a link to categorize the news items. Clicking this will allow them to select which category(s) each news item is in.</p>
Dries's avatar
   
Dries committed
56
      <h3>Technical details</h3>
Dries's avatar
   
Dries committed
57
      <p>Drupal automatically generates an OPML feed file that is available by selecting the XML icon on the News Sources page.</p>
Dries's avatar
   
Dries committed
58
      <p>When fetching feeds Drupal supports conditional GETs, this reduces the bandwidth usage for feeds that have not been updated since the last check.</p>
Dries's avatar
   
Dries committed
59
60
      <p>If a feed is permanently moved to a new location Drupal will automatically update the feed URL to the new address.</p>', array('%block' => url('admin/block'), '%admin-news' => url('admin/aggregator'), '%new-feed' => url('admin/aggregator/add/feed'), '%new-category' => url('admin/aggregator/add/category'), '%update-items' => url('admin/aggregator'), '%news-aggregator' => url('aggregator'), '%sources' => url('aggregator/sources'), '%categories' => url('aggregator/categories')));
    case 'admin/modules#description':
Dries's avatar
   
Dries committed
61
      return t('Used to aggregate syndicated content (RSS and RDF).');
Dries's avatar
   
Dries committed
62
    case 'admin/aggregator':
63
      return t('<p>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>.</p>', array('%block' => url('admin/block')));
Dries's avatar
   
Dries committed
64
    case 'admin/aggregator/add/feed':
65
      return t('<p>Add a site that has an RSS/RDF feed. The URL is the full path to the RSS 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>');
Dries's avatar
   
Dries committed
66
    case 'admin/aggregator/add/category':
67
      return t('<p>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
68
  }
69
70
}

71
function aggregator_settings() {
72
  $items = array(0 => t('none')) + drupal_map_assoc(array(3, 5, 10, 15, 20, 25), '_aggregator_items');
73
  $period = drupal_map_assoc(array(3600, 10800, 21600, 32400, 43200, 86400, 172800, 259200, 604800, 1209600, 2419200, 4838400, 9676800), 'format_interval');
Dries's avatar
   
Dries committed
74

75
  $output = '';
Dries's avatar
   
Dries committed
76
  $output .= form_select(t('Items shown in sources and categories pages'), 'aggregator_summary_items', variable_get('aggregator_summary_items', 3), $items, t('The number of items which will be shown with each feed or category in the feed and category summary pages.'));
77
   $output .= form_select(t('Discard news items older than'), 'aggregator_clear', variable_get('aggregator_clear', 9676800), $period, t('Older news items will be automatically discarded.  Requires crontab.'));
Dries's avatar
   
Dries committed
78
  $output .= form_radios(t('Category selection type'), 'aggregator_category_selector', variable_get('aggregator_category_selector', 'check'), array('check' => t('checkboxes'), 'select' => t('multiple selector')), t('The type of category selection widget which is shown on categorization pages. Checkboxes are easier to use; a multiple selector is good for working with large numbers of categories.'));
79
  return $output;
Dries's avatar
   
Dries committed
80
81
}

82
83
84
85
86
87
88
/**
 * Helper function for drupal_map_assoc.
 */
function _aggregator_items($count) {
  return format_plural($count, '1 item', '%count items');
}

Dries's avatar
   
Dries committed
89
90
91
/**
 * Implementation of hook_perm().
 */
Kjartan's avatar
Kjartan committed
92
function aggregator_perm() {
Dries's avatar
   
Dries committed
93
  return array('administer news feeds', 'access news feeds');
Dries's avatar
   
Dries committed
94
95
}

Dries's avatar
   
Dries committed
96
97
98
/**
 * Implementation of hook_menu().
 */
Dries's avatar
   
Dries committed
99
function aggregator_menu($may_cache) {
Dries's avatar
   
Dries committed
100
  $items = array();
Dries's avatar
   
Dries committed
101

Dries's avatar
   
Dries committed
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
  if ($may_cache) {
    $edit = user_access('administer news feeds');
    $view = user_access('access news feeds');

    $items[] = array('path' => 'admin/aggregator', 'title' => t('aggregator'),
      'callback' => 'aggregator_admin_overview', 'access' => $edit);
    $items[] = array('path' => 'admin/aggregator/edit/feed', 'title' => t('edit feed'),
      'callback' => 'aggregator_admin_edit_feed', 'access' => $edit,
      'type' => MENU_CALLBACK);
    $items[] = array('path' => 'admin/aggregator/edit/category', 'title' => t('edit category'),
      'callback' => 'aggregator_admin_edit_category', 'access' => $edit,
      'type' => MENU_CALLBACK);
    $items[] = array('path' => 'admin/aggregator/remove', 'title' => t('remove items'),
      'callback' => 'aggregator_admin_remove_feed', 'access' => $edit,
      'type' => MENU_CALLBACK);
    $items[] = array('path' => 'admin/aggregator/update', 'title' => t('update items'),
      'callback' => 'aggregator_admin_refresh_feed', 'access' => $edit,
      'type' => MENU_CALLBACK);

    $items[] = array('path' => 'admin/aggregator/list', 'title' => t('list'),
      'type' => MENU_DEFAULT_LOCAL_TASK, 'weight' => -10);
    $items[] = array('path' => 'admin/aggregator/add/feed', 'title' => t('add feed'),
      'callback' => 'aggregator_admin_edit_feed', 'access' => $edit,
      'type' => MENU_LOCAL_TASK);
    $items[] = array('path' => 'admin/aggregator/add/category', 'title' => t('add category'),
      'callback' => 'aggregator_admin_edit_category', 'access' => $edit,
      'type' => MENU_LOCAL_TASK);

    $items[] = array('path' => 'aggregator', 'title' => t('news aggregator'),
      'callback' => 'aggregator_page_last', 'access' => $view,
      'weight' => 5);
    $items[] = array('path' => 'aggregator/sources', 'title' => t('sources'),
      'callback' => 'aggregator_page_sources', 'access' => $view);
    $items[] = array('path' => 'aggregator/categories', 'title' => t('categories'),
      'callback' => 'aggregator_page_categories', 'access' => $view,
      'type' => MENU_ITEM_GROUPING);

Dries's avatar
   
Dries committed
139
140
141
142
143
    // Sources:
    $result = db_query('SELECT title, fid FROM {aggregator_feed} ORDER BY title');
    while ($feed = db_fetch_object($result)) {
      $items[] = array('path' => 'aggregator/sources/'. $feed->fid, 'title' => $feed->title,
        'callback' => 'aggregator_page_source', 'access' => $view);
Dries's avatar
   
Dries committed
144
145
      $items[] = array('path' => 'aggregator/sources/'. $feed->fid .'/view', 'title' => t('view'),
        'type' => MENU_DEFAULT_LOCAL_TASK, 'weight' => -10);
Dries's avatar
   
Dries committed
146
147
148
149
150
151
152
      $items[] = array('path' => 'aggregator/sources/'. $feed->fid .'/categorize', 'title' => t('categorize'),
        'callback' => 'aggregator_page_source', 'access' => $edit,
        'type' => MENU_LOCAL_TASK);
      $items[] = array('path' => 'aggregator/sources/'. $feed->fid .'/configure', 'title' => t('configure'),
        'callback' => 'aggregator_edit', 'access' => $edit,
        'type' => MENU_LOCAL_TASK,
        'weight' => 1);
Dries's avatar
   
Dries committed
153
    }
154

Dries's avatar
   
Dries committed
155
156
157
158
159
    // Categories:
    $result = db_query('SELECT title, cid FROM {aggregator_category} ORDER BY title');
    while ($category = db_fetch_object($result)) {
      $items[] = array('path' => 'aggregator/categories/'. $category->cid, 'title' => $category->title,
        'callback' => 'aggregator_page_category', 'access' => $view);
Dries's avatar
   
Dries committed
160
161
      $items[] = array('path' => 'aggregator/categories/'. $category->cid .'/view', 'title' => t('view'),
        'type' => MENU_DEFAULT_LOCAL_TASK, 'weight' => -10);
Dries's avatar
   
Dries committed
162
163
164
165
166
167
168
169
170
      $items[] = array('path' => 'aggregator/categories/'. $category->cid .'/categorize', 'title' => t('categorize'),
        'callback' => 'aggregator_page_category', 'access' => $edit,
        'type' => MENU_LOCAL_TASK);
      $items[] = array('path' => 'aggregator/categories/'. $category->cid .'/configure', 'title' => t('configure'),
        'callback' => 'aggregator_edit', 'access' => $edit,
        'type' => MENU_LOCAL_TASK,
        'weight' => 1);
    }

Dries's avatar
   
Dries committed
171
172
173
174
    $items[] = array('path' => 'aggregator/opml', 'title' => t('opml'),
      'callback' => 'aggregator_page_opml', 'access' => $view,
      'type' => MENU_CALLBACK);
  }
Dries's avatar
   
Dries committed
175
176

  return $items;
177
178
}

Dries's avatar
   
Dries committed
179
180
181
182
183
/**
 * Implementation of hook_cron().
 *
 * Checks news feeds for updates once their refresh interval has elapsed.
 */
Dries's avatar
   
Dries committed
184
function aggregator_cron() {
Dries's avatar
   
Dries committed
185
  $result = db_query('SELECT * FROM {aggregator_feed} WHERE checked + refresh < %d', time());
Dries's avatar
   
Dries committed
186
187
  while ($feed = db_fetch_array($result)) {
    aggregator_refresh($feed);
Dries's avatar
   
Dries committed
188
189
190
  }
}

Dries's avatar
   
Dries committed
191
192
193
194
195
/**
 * Implementation of hook_block().
 *
 * Generates blocks for the latest news items in each category and feed.
 */
Dries's avatar
Dries committed
196
function aggregator_block($op, $delta = 0, $edit = array()) {
Dries's avatar
   
Dries committed
197
  if (user_access('access news feeds')) {
Dries's avatar
   
Dries committed
198
    if ($op == 'list') {
Dries's avatar
Dries committed
199
      $result = db_query('SELECT cid, title FROM {aggregator_category} ORDER BY title');
Dries's avatar
   
Dries committed
200
201
      while ($category = db_fetch_object($result)) {
        $block['category:'. $category->cid]['info'] = t('%title category latest items', array('%title' => $category->title));
Kjartan's avatar
Kjartan committed
202
      }
Dries's avatar
Dries committed
203
      $result = db_query('SELECT fid, title FROM {aggregator_feed} ORDER BY fid');
Kjartan's avatar
Kjartan committed
204
      while ($feed = db_fetch_object($result)) {
Dries's avatar
   
Dries committed
205
        $block['feed:'. $feed->fid]['info'] = t('%title feed latest items', array('%title' => $feed->title));
Kjartan's avatar
Kjartan committed
206
      }
Dries's avatar
   
Dries committed
207
    }
Dries's avatar
Dries committed
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
    else if ($op == 'configure') {
      list($type, $id) = split(':', $delta);
      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));
      }

      $output = form_select(t('Number of news items in block'), 'block', $value, drupal_map_assoc(array(2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20)));
      return $output;
    }
    else if ($op == 'save') {
      list($type, $id) = split(':', $delta);
      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);
      }
    }
229
    else if ($op == 'view') {
Dries's avatar
   
Dries committed
230
      list($type, $id) = split(':', $delta);
Kjartan's avatar
Kjartan committed
231
      switch ($type) {
Dries's avatar
   
Dries committed
232
233
234
235
236
        case 'feed':
          $feed = db_fetch_object(db_query('SELECT fid, title, block FROM {aggregator_feed} WHERE fid = %d', $id));
          $block['subject'] = $feed->title;
          $result = db_query_range('SELECT * FROM {aggregator_item} WHERE fid = %d ORDER BY timestamp DESC, iid DESC', $feed->fid, 0, $feed->block);
          $block['content'] = '<div class="more-link">'. l(t('more'), 'aggregator/sources/'. $feed->fid, array('title' => t('View this feed\'s recent news.'))) .'</div>';
Kjartan's avatar
Kjartan committed
237
          break;
Dries's avatar
   
Dries committed
238
239
240
241
242
        case 'category':
          $category = db_fetch_object(db_query('SELECT cid, title, block FROM {aggregator_category} WHERE cid = %d', $id));
          $block['subject'] = $category->title;
          $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);
          $block['content'] = '<div class="more-link">'. l(t('more'), 'aggregator/categories/'. $category->cid, array('title' => t('View this category\'s recent news.'))) .'</div>';
Kjartan's avatar
Kjartan committed
243
244
          break;
      }
Dries's avatar
   
Dries committed
245
246
      $items = array();
      while ($item = db_fetch_object($result)) {
Dries's avatar
   
Dries committed
247
        $items[] = theme('aggregator_block_item', $item);
Dries's avatar
   
Dries committed
248
      }
Dries's avatar
   
Dries committed
249
      $block['content'] = theme('item_list', $items) . $block['content'];
Dries's avatar
   
Dries committed
250
    }
Dries's avatar
   
Dries committed
251
    return $block;
Dries's avatar
   
Dries committed
252
  }
Dries's avatar
   
Dries committed
253
254
}

Dries's avatar
   
Dries committed
255
256
257
258
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
259
  }
Dries's avatar
   
Dries committed
260
261
  if ($items) {
    db_query('DELETE FROM {aggregator_category_item} WHERE '. implode(' OR ', $items));
Dries's avatar
   
Dries committed
262
  }
Dries's avatar
   
Dries committed
263
  db_query('DELETE FROM {aggregator_item} WHERE fid = %d', $feed['fid']);
Kjartan's avatar
Kjartan committed
264
  db_query("UPDATE {aggregator_feed} SET checked = 0, etag = '', modified = 0 WHERE fid = %d", $feed['fid']);
Steven Wittens's avatar
Steven Wittens committed
265
  drupal_set_message(t('Removed news items from %site.', array('%site' => '<em>'. $feed['title'] .'</em>')));
Dries's avatar
   
Dries committed
266
267
}

Dries's avatar
   
Dries committed
268
269
270
/**
 * Call-back function used by the XML parser.
 */
Kjartan's avatar
Kjartan committed
271
function aggregator_element_start($parser, $name, $attributes) {
Dries's avatar
   
Dries committed
272
273
274
  global $item, $element, $tag;

  switch ($name) {
Dries's avatar
   
Dries committed
275
276
    case 'IMAGE':
    case 'TEXTINPUT':
Dries's avatar
   
Dries committed
277
278
      $element = $name;
      break;
Dries's avatar
   
Dries committed
279
    case 'ITEM':
Dries's avatar
   
Dries committed
280
281
      $element = $name;
      $item += 1;
282
283
284
285
286
  }

  $tag = $name;
}

Dries's avatar
   
Dries committed
287
288
289
/**
 * Call-back function used by the XML parser.
 */
Kjartan's avatar
Kjartan committed
290
function aggregator_element_end($parser, $name) {
Dries's avatar
   
Dries committed
291
292
  global $element;

Dries's avatar
   
Dries committed
293
  switch ($name) {
Dries's avatar
   
Dries committed
294
295
296
297
    case 'IMAGE':
    case 'TEXTINPUT':
    case 'ITEM':
      $element = '';
Dries's avatar
   
Dries committed
298
  }
299
300
}

Dries's avatar
   
Dries committed
301
302
303
/**
 * Call-back function used by the XML parser.
 */
Kjartan's avatar
Kjartan committed
304
function aggregator_element_data($parser, $data) {
Dries's avatar
   
Dries committed
305
  global $channel, $element, $items, $item, $image, $tag;
Dries's avatar
   
Dries committed
306
307

  switch ($element) {
Dries's avatar
   
Dries committed
308
    case 'ITEM':
Dries's avatar
   
Dries committed
309
310
      $items[$item][$tag] .= $data;
      break;
Dries's avatar
   
Dries committed
311
    case 'IMAGE':
Dries's avatar
   
Dries committed
312
313
      $image[$tag] .= $data;
      break;
Dries's avatar
   
Dries committed
314
315
316
    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
317
318
319
      break;
    default:
      $channel[$tag] .= $data;
320
321
322
  }
}

Dries's avatar
   
Dries committed
323
324
325
/**
 * Checks a news feed for new items.
 */
Kjartan's avatar
Kjartan committed
326
function aggregator_refresh($feed) {
Dries's avatar
   
Dries committed
327
328
  global $channel, $image;

Dries's avatar
   
Dries committed
329
330
331
332
333
334
  // Generate conditional GET headers.
  $headers = array();
  if ($feed['etag']) {
    $headers['If-None-Match'] = $feed['etag'];
  }
  if ($feed['modified']) {
Dries's avatar
   
Dries committed
335
    $headers['If-Modified-Since'] = gmdate('D, d M Y H:i:s', $feed['modified']) .' GMT';
Dries's avatar
   
Dries committed
336
337
338
339
340
  }

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

341
  // Process HTTP response code.
Dries's avatar
   
Dries committed
342
343
  switch ($result->code) {
    case 304:
Dries's avatar
   
Dries committed
344
      db_query('UPDATE {aggregator_feed} SET checked = %d WHERE fid = %d', time(), $feed['fid']);
Dries's avatar
   
Dries committed
345
      drupal_set_message(t('No new syndicated content from %site.', array('%site' => '<em>'. $feed['title'] .'</em>')));
Dries's avatar
   
Dries committed
346
      break;
Dries's avatar
   
Dries committed
347
348
    case 301:
      $feed['url'] = $result->redirect_url;
349
      watchdog('aggregator', t('Updated URL for feed %title to %url.', array('%title' => '<em>'. $feed['title'] .'</em>', '%url' => '<em>'. $feed['url'] .'</em>')));
350
351
      break;

Dries's avatar
   
Dries committed
352
353
354
355
    case 200:
    case 302:
    case 307:
      // Filter the input data:
356
     if (aggregator_parse_feed($result->data, $feed)) {
357

Dries's avatar
   
Dries committed
358
359
360
        if ($result->headers['Last-Modified']) {
          $modified = strtotime($result->headers['Last-Modified']);
        }
Dries's avatar
Dries committed
361

362
363
364
365
366
367
368
369
        /*
        ** Prepare the channel data:
        */

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

Dries's avatar
   
Dries committed
370
371
372
        /*
        ** Prepare the image data (if any):
        */
Dries's avatar
   
Dries committed
373

Dries's avatar
   
Dries committed
374
375
376
        foreach ($image as $key => $value) {
          $image[$key] = trim($value);
        }
Dries's avatar
   
Dries committed
377

Dries's avatar
   
Dries committed
378
        if ($image['LINK'] && $image['URL'] && $image['TITLE']) {
Dries's avatar
   
Dries committed
379
          $image = '<a href="'. $image['LINK'] .'"><img src="'. $image['URL'] .'" alt="'. $image['TITLE'] .'" /></a>';
Dries's avatar
   
Dries committed
380
        }
Dries's avatar
   
Dries committed
381
382
383
        else {
          $image = NULL;
        }
Dries's avatar
   
Dries committed
384

Dries's avatar
   
Dries committed
385
386
387
        /*
        ** Update the feed data:
        */
Dries's avatar
   
Dries committed
388

389
        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, $result->headers['ETag'], $modified, $feed['fid']);
Dries's avatar
   
Dries committed
390

Dries's avatar
   
Dries committed
391
392
393
        /*
        ** Clear the cache:
        */
Dries's avatar
   
Dries committed
394

Dries's avatar
   
Dries committed
395
        cache_clear_all();
Dries's avatar
   
Dries committed
396

397
398
399
        $message = t('Syndicated content from %site.', array('%site' => '<em>'. $feed[title] .'</em>'));
        watchdog('aggregator', $message);
        drupal_set_message($message);
Dries's avatar
   
Dries committed
400
401
      }
      break;
Dries's avatar
   
Dries committed
402
    default:
403
404
405
      $message = t('Failed to parse RSS feed %site: %error.', array('%site' => '<em>'. $feed['title'] .'</em>', '%error' => "<em>$result->code $result->error</em>"));
      watchdog('aggregator', $message, WATCHDOG_WARNING);
      drupal_set_message($message);
Dries's avatar
   
Dries committed
406
  }
Dries's avatar
   
Dries committed
407
}
Dries's avatar
   
Dries committed
408

Dries's avatar
   
Dries committed
409
410
411
412
413
414
415
/**
 * 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.
 * Origionally from MagpieRSS (http://magpierss.sourceforge.net/).
 *
 * @param $date_str A string with a potentially W3C DTF date.
416
 * @return A timestamp if parsed successfully or -1 if not.
Dries's avatar
   
Dries committed
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
 */
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 {
    return -1;
  }
}

Dries's avatar
   
Dries committed
446
function aggregator_parse_feed(&$data, $feed) {
Dries's avatar
   
Dries committed
447
  global $items, $image, $channel;
Dries's avatar
   
Dries committed
448

Dries's avatar
   
Dries committed
449
  // Unset the global variables before we use them:
Dries's avatar
   
Dries committed
450
  unset($GLOBALS['element'], $GLOBALS['item'], $GLOBALS['tag']);
Dries's avatar
   
Dries committed
451
  $items = array();
Dries's avatar
   
Dries committed
452
  $image = array();
Dries's avatar
   
Dries committed
453
  $channel = array();
454

Dries's avatar
   
Dries committed
455
456
  // parse the data:
  $xml_parser = drupal_xml_parser_create($data);
Dries's avatar
   
Dries committed
457
458
  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
459

Dries's avatar
   
Dries committed
460
  if (!xml_parse($xml_parser, $data, 1)) {
461
462
463
    $message = t('Failed to parse RSS feed %site: %error at line %line.', array('%site' => '<em>'. $feed['title'] .'</em>', '%error' => xml_error_string(xml_get_error_code($xml_parser)), '%line' => xml_get_current_line_number($xml_parser)));
    watchdog('aggregator', $message, WATCHDOG_WARNING);
    drupal_set_message($message, 'error');
Dries's avatar
   
Dries committed
464
    return 0;
Dries's avatar
   
Dries committed
465
466
  }
  xml_parser_free($xml_parser);
Dries's avatar
   
Dries committed
467

Dries's avatar
   
Dries committed
468
  // initialize the translation table:
469
  $tt = array_flip(get_html_translation_table(HTML_SPECIALCHARS));
Dries's avatar
   
Dries committed
470
  $tt['&apos;'] = "'";
Dries's avatar
   
Dries committed
471

Dries's avatar
   
Dries committed
472
473
474
475
476
  /*
  ** 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
477

Dries's avatar
   
Dries committed
478
  $items = array_reverse($items);
Dries's avatar
   
Dries committed
479

Dries's avatar
   
Dries committed
480
481
  foreach ($items as $item) {
    unset($title, $link, $author, $description);
482

Dries's avatar
   
Dries committed
483
484
    // Prepare the item:
    foreach ($item as $key => $value) {
485
486
487
488
489
490
      // TODO: Make handling of aggregated HTML more flexible/configurable.
      $value = strtr(trim($value), $tt);
      $value = strip_tags($value, '<a> <b> <br> <dd> <dl> <dt> <em> <i> <li> <ol> <p> <strong> <u> <ul>');
      $value = preg_replace('/\Wstyle\s*=[^>]+?>/i', '>', $value);
      $value = preg_replace('/\Won[a-z]+\s*=[^>]+?>/i', '>', $value);
      $item[$key] = $value;
Dries's avatar
   
Dries committed
491
    }
Dries's avatar
Dries committed
492

Dries's avatar
   
Dries committed
493
494
495
496
497
498
    /*
    ** Resolve the item's title.  If no title is found, we use
    ** up to 40 characters of the description ending at a word
    ** boundary but not splitting potential entities.
    */

Dries's avatar
   
Dries committed
499
500
    if ($item['TITLE']) {
      $title = $item['TITLE'];
Dries's avatar
   
Dries committed
501
502
    }
    else {
Dries's avatar
   
Dries committed
503
      $title = preg_replace('/^(.*)[^\w;&].*?$/', "\\1", truncate_utf8($item['DESCRIPTION'], 40));
Dries's avatar
   
Dries committed
504
    }
Dries's avatar
   
Dries committed
505

Dries's avatar
   
Dries committed
506
507
508
509
    /*
    ** Resolve the items link.
    */

Dries's avatar
   
Dries committed
510
511
    if ($item['LINK']) {
      $link = $item['LINK'];
Dries's avatar
   
Dries committed
512
    }
Dries's avatar
   
Dries committed
513
514
    elseif ($item['GUID'] && (strncmp($item['GUID'], 'http://', 7) == 0)) {
      $link = $item['GUID'];
Dries's avatar
   
Dries committed
515
516
    }
    else {
Dries's avatar
   
Dries committed
517
      $link = $feed['link'];
Dries's avatar
   
Dries committed
518
    }
519

Dries's avatar
   
Dries committed
520
521
522
523
524
525
526
527
528
529
    /*
    ** Try to resolve and parse the item's publication date.  If no
    ** date is found, we use the current date instead.
    */

    if ($item['PUBDATE']) $date = $item['PUBDATE'];                        // RSS 2.0
    else if ($item['DC:DATE']) $date = $item['DC:DATE'];                   // Dublin core
    else if ($item['DCTERMS:ISSUED']) $date = $item['DCTERMS:ISSUED'];     // Dublin core
    else if ($item['DCTERMS:CREATED']) $date = $item['DCTERMS:CREATED'];   // Dublin core
    else if ($item['DCTERMS:MODIFIED']) $date = $item['DCTERMS:MODIFIED']; // Dublin core
Dries's avatar
   
Dries committed
530
    else $date = 'now';
Dries's avatar
   
Dries committed
531

Dries's avatar
   
Dries committed
532
    $timestamp = strtotime($date); // strtotime() returns -1 on failure
Dries's avatar
   
Dries committed
533
    if ($timestamp < 0) {
Dries's avatar
   
Dries committed
534
535
536
537
      $timestamp = aggregator_parse_w3cdtf($date); // also returns -1 on failure
      if ($timestamp < 0) {
        $timestamp = time(); // better than nothing
      }
538
    }
Dries's avatar
   
Dries committed
539
540

    /*
Dries's avatar
   
Dries committed
541
542
543
    ** Save this item.  Try to avoid duplicate entries as much as
    ** possible.  If we find a duplicate entry, we resolve it and
    ** pass along it's ID such that we can update it if needed.
Dries's avatar
   
Dries committed
544
545
    */

Dries's avatar
   
Dries committed
546
547
    if ($link && $link != $feed['link'] && $link != $feed['url']) {
      $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
548
549
    }
    else {
Dries's avatar
   
Dries committed
550
      $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
551
    }
Dries's avatar
   
Dries committed
552

553
    if (!valid_input_data($item['DESCRIPTION'])) {
Dries's avatar
   
Dries committed
554
      drupal_set_message(t('Failed to parse entry from %site feed: suspicious input data.', array('%site' => '<em>'. $feed['title'] .'</em>')), 'error');
555
556
557
558
    }
    else {
      aggregator_save_item(array('iid' => $entry->iid, 'fid' => $feed['fid'], 'timestamp' => $timestamp, 'title' => $title, 'link' => $link, 'author' => $item['AUTHOR'], 'description' => $item['DESCRIPTION']));
    }
Dries's avatar
   
Dries committed
559
  }
Dries's avatar
   
Dries committed
560

Dries's avatar
   
Dries committed
561
  /*
562
  ** Remove all items that are older than flush item timer:
Dries's avatar
   
Dries committed
563
  */
Dries's avatar
   
Dries committed
564

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

568
569
570
571
572
573
574
  if (db_num_rows($result)) {
    $items = array();
    while ($item = db_fetch_object($result)) {
      $items[] = $item->iid;
    }
    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
575
  }
Dries's avatar
   
Dries committed
576
577

  return 1;
578
579
}

Kjartan's avatar
Kjartan committed
580
function aggregator_save_item($edit) {
Dries's avatar
   
Dries committed
581
  if ($edit['iid'] && $edit['title']) {
Dries's avatar
   
Dries committed
582
    db_query('UPDATE {aggregator_item} SET title = \'%s\', link = \'%s\', author = \'%s\', description = \'%s\' WHERE iid = %d', $edit['title'], $edit['link'], $edit['author'], $edit['description'], $edit['iid']);
583
  }
Dries's avatar
   
Dries committed
584
585
586
  else if ($edit['iid']) {
    db_query('DELETE FROM {aggregator_item} WHERE iid = %d', $edit['iid']);
    db_query('DELETE FROM {aggregator_category_item} WHERE iid = %d', $edit['iid']);
587
  }
Dries's avatar
   
Dries committed
588
  else if ($edit['title'] && $edit['link']) {
Dries's avatar
   
Dries committed
589
590
    $edit['iid'] = db_next_id('{aggregator_item}_iid');
    db_query('INSERT INTO {aggregator_item} (iid, fid, title, link, author, description, timestamp) VALUES (%d, %d, \'%s\', \'%s\', \'%s\', \'%s\', %d)', $edit['iid'], $edit['fid'], $edit['title'], $edit['link'], $edit['author'], $edit['description'], $edit['timestamp']);
Dries's avatar
   
Dries committed
591
592
593
    // file the items in the categories indicated by the feed
    $categories = db_query('SELECT cid FROM {aggregator_category_feed} WHERE fid = %d', $edit['fid']);
    while ($category = db_fetch_object($categories)) {
Dries's avatar
   
Dries committed
594
      db_query('INSERT INTO {aggregator_category_item} (cid, iid) VALUES (%d, %d)', $category->cid, $edit['iid']);
Dries's avatar
   
Dries committed
595
    }
596
597
598
  }
}

Dries's avatar
   
Dries committed
599
600
601
602
function aggregator_form_category($edit = array()) {
  $form = form_textfield(t('Title'), 'title', $edit['title'], 50, 64);
  $form .= form_textarea(t('Description'), 'description', $edit['description'], 60, 5);
  $form .= form_submit(t('Submit'));
603

Dries's avatar
   
Dries committed
604
605
606
  if ($edit['cid']) {
    $form .= form_submit(t('Delete'));
    $form .= form_hidden('cid', $edit['cid']);
607
608
  }

Dries's avatar
   
Dries committed
609
  return form($form);
610
611
}

Dries's avatar
   
Dries committed
612
613
function aggregator_save_category($edit) {
  if ($edit['cid'] && $edit['title']) {
Dries's avatar
Dries committed
614
    db_query('UPDATE {aggregator_category} SET title = \'%s\', description = \'%s\' WHERE cid = %d', $edit['title'], $edit['description'], $edit['cid']);
615
  }
Dries's avatar
   
Dries committed
616
617
  else if ($edit['cid']) {
    db_query('DELETE FROM {aggregator_category} WHERE cid = %d', $edit['cid']);
618
  }
Dries's avatar
   
Dries committed
619
  else if ($edit['title']) {
Dries's avatar
   
Dries committed
620
    // a single unique id for bundles and feeds, to use in blocks
Dries's avatar
   
Dries committed
621
    $next_id = db_next_id('{aggregator_category}_cid');
Dries's avatar
Dries committed
622
    db_query('INSERT INTO {aggregator_category} (cid, title, description, block) VALUES (%d, \'%s\', \'%s\', 5)', $next_id, $edit['title'], $edit['description']);
623
624
625
  }
}

Kjartan's avatar
Kjartan committed
626
function aggregator_form_feed($edit = array()) {
Dries's avatar
   
Dries committed
627
  $period = drupal_map_assoc(array(900, 1800, 3600, 7200, 10800, 21600, 32400, 43200, 64800, 86400, 172800, 259200, 604800, 1209600, 2419200), 'format_interval');
628

Dries's avatar
   
Dries committed
629
630
  if ($edit['refresh'] == '') {
    $edit['refresh'] = 3600;
Dries's avatar
   
Dries committed
631
  }
Dries's avatar
   
Dries committed
632

Dries's avatar
   
Dries committed
633
  $form .= form_textfield(t('Title'), 'title', $edit['title'], 50, 64, t('The name of the feed; typically the name of the web site you syndicate content from.'));
634
  $form .= form_textfield(t('URL'), 'url', $edit['url'], 50, 255, t('The fully-qualified URL of the feed.'));
Dries's avatar
   
Dries committed
635
  $form .= form_select(t('Update interval'), 'refresh', $edit['refresh'], $period, t('The refresh interval indicating how often you want to update this feed.  Requires crontab.'));
Dries's avatar
Dries committed
636
637
638
639

  // Handling of categories:
  $options = array();
  $values = array();
Dries's avatar
   
Dries committed
640
  $categories = db_query('SELECT c.cid, c.title, f.fid FROM {aggregator_category} c LEFT JOIN {aggregator_category_feed} f ON c.cid = f.cid AND f.fid = %d ORDER BY title', $edit['fid']);
Dries's avatar
   
Dries committed
641
  while ($category = db_fetch_object($categories)) {
Dries's avatar
Dries committed
642
643
    $options[$category->cid] = $category->title;
    if ($category->fid) $values[] = $category->cid;
Dries's avatar
   
Dries committed
644
  }
Dries's avatar
Dries committed
645
646
  if ($options) {
    $form .= form_checkboxes(t('Categorize news items'), 'category', $values, $options, t('New items in this feed will be automatically filed in the the checked categories as they are received.'));
Dries's avatar
   
Dries committed
647
  }
Dries's avatar
   
Dries committed
648

Dries's avatar
Dries committed
649
  // Form buttons:
Dries's avatar
   
Dries committed
650
651
652
653
  $form .= form_submit(t('Submit'));
  if ($edit['fid']) {
    $form .= form_submit(t('Delete'));
    $form .= form_hidden('fid', $edit['fid']);
654
655
  }

Dries's avatar
   
Dries committed
656
  return form($form);
657
658
}

Kjartan's avatar
Kjartan committed
659
function aggregator_save_feed($edit) {
Dries's avatar
   
Dries committed
660
  if ($edit['fid']) {
661
    // an existing feed is being modified, delete the category listings
Dries's avatar
   
Dries committed
662
    db_query('DELETE FROM {aggregator_category_feed} WHERE fid = %d', $edit['fid']);
663
  }
Dries's avatar
   
Dries committed
664
  if ($edit['fid'] && $edit['title']) {
Dries's avatar
Dries committed
665
    db_query('UPDATE {aggregator_feed} SET title = \'%s\', url = \'%s\', refresh = %d WHERE fid = %d', $edit['title'], $edit['url'], $edit['refresh'], $edit['fid']);
666
  }
Dries's avatar
   
Dries committed
667
668
669
670
671
672
673
674
675
676
  else if ($edit['fid']) {
    $result = db_query('SELECT iid FROM {aggregator_item} WHERE fid = %d', $edit['fid']);
    while ($item = db_fetch_object($result)) {
      $items[] = "iid = $item->iid";
    }
    if ($items) {
      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']);
677
  }
Dries's avatar
   
Dries committed
678
679
680
  else if ($edit['title']) {
    // a single unique id for bundles and feeds, to use in blocks
    $edit['fid'] = db_next_id('{aggregator_feed}_fid');
Dries's avatar
Dries committed
681
    db_query('INSERT INTO {aggregator_feed} (fid, title, url, refresh, block) VALUES (%d, \'%s\', \'%s\', %d, 5)', $edit['fid'], $edit['title'], $edit['url'], $edit['refresh']);
Dries's avatar
   
Dries committed
682
683
684
  }
  if ($edit['title']) {
    // the feed is being saved, save the categories as well
Dries's avatar
Dries committed
685
    if ($edit['category']) {
Dries's avatar
Dries committed
686
687
      foreach ($edit['category'] as $cid) {
        db_query('INSERT INTO {aggregator_category_feed} (fid, cid) VALUES (%d, %d)', $edit['fid'], $cid);
Dries's avatar
   
Dries committed
688
689
      }
    }
690
691
692
  }
}

Kjartan's avatar
Kjartan committed
693
function aggregator_get_feed($fid) {
Dries's avatar
   
Dries committed
694
  return db_fetch_array(db_query('SELECT * FROM {aggregator_feed} WHERE fid = %d', $fid));
695
696
}

Dries's avatar
   
Dries committed
697
function aggregator_get_category($cid) {
Dries's avatar
   
Dries committed
698
  return db_fetch_array(db_query('SELECT * FROM {aggregator_category} WHERE cid = %d', $cid));
699
700
}

Kjartan's avatar
Kjartan committed
701
function aggregator_view() {
Dries's avatar
   
Dries committed
702
  $result = db_query('SELECT f.*, COUNT(i.iid) AS items FROM {aggregator_feed} f LEFT JOIN {aggregator_item} i ON f.fid = i.fid GROUP BY f.fid, f.title, f.url, f.refresh, f.checked, f.link, f.description, f.etag, f.modified, f.image, f.block ORDER BY f.title');
703

Dries's avatar
   
Dries committed
704
  $output .= '<h3>'. t('Feed overview') .'</h3>';
Dries's avatar
   
Dries committed
705

Dries's avatar
   
Dries committed
706
  $header = array(t('Title'), t('Items'), t('Last update'), t('Next update'), array('data' => t('Operations'), 'colspan' => '3'));
Dries's avatar
   
Dries committed
707
  $rows = array();
708
  while ($feed = db_fetch_object($result)) {
Dries's avatar
   
Dries committed
709
    $rows[] = array(l($feed->title, "aggregator/sources/$feed->fid"), format_plural($feed->items, '1 item', '%count items'), ($feed->checked ? t('%time ago', array('%time' => format_interval(time() - $feed->checked))) : t('never')), ($feed->checked ? t('%time left', array('%time' => format_interval($feed->checked + $feed->refresh - time()))) : t('never')), l(t('edit'), "admin/aggregator/edit/feed/$feed->fid"), l(t('remove items'), "admin/aggregator/remove/$feed->fid"), l(t('update items'), "admin/aggregator/update/$feed->fid"));
710
  }
Dries's avatar
   
Dries committed
711
  $output .= theme('table', $header, $rows);
712

Dries's avatar
   
Dries committed
713
  $result = db_query('SELECT c.cid, c.title, count(ci.iid) as items FROM {aggregator_category} c LEFT JOIN {aggregator_category_item} ci ON c.cid = ci.cid GROUP BY c.cid, c.title ORDER BY title');
714

Dries's avatar
   
Dries committed
715
  $output .= '<h3>'. t('Category overview') .'</h3>';
Dries's avatar
   
Dries committed
716

Dries's avatar
   
Dries committed
717
  $header = array(t('Title'), t('Items'), t('Operations'));
Dries's avatar
   
Dries committed
718
  $rows = array();
Dries's avatar
   
Dries committed
719
  while ($category = db_fetch_object($result)) {
Dries's avatar
   
Dries committed
720
    $rows[] = array(l($category->title, "aggregator/categories/$category->cid"), format_plural($category->items, '1 item', '%count items'), l(t('edit'), "admin/aggregator/edit/category/$category->cid"));
721
  }
Dries's avatar
   
Dries committed
722
  $output .= theme('table', $header, $rows);
723
724
725
726

  return $output;
}

Dries's avatar
   
Dries committed
727
728
729
730
731
732
733
734
735
736
737
function aggregator_edit() {

  if ($_POST['op'] == t('Submit')) {
    if (arg(1) == 'categories') {
      aggregator_save_category($_POST['edit']);
      drupal_set_message(t('The category has been updated.'));
    }
    else {
      aggregator_save_feed($_POST['edit']);
      drupal_set_message(t('The feed has been updated.'));
    }
738

739
    menu_rebuild();
740
    drupal_goto($_GET['q']);
Dries's avatar
   
Dries committed
741
742
743
744
745
746
747
748
749
750
751
752
753
754
  }
  else if ($_POST['op'] == t('Delete')) {
    // Unset the title:
    unset($_POST['edit']['title']);

    if (arg(1) == 'categories') {
      aggregator_save_category($_POST['edit']);
      drupal_set_message(t('The category has been deleted.'));
    }
    else {
      aggregator_save_feed($_POST['edit']);
      drupal_set_message(t('The feed has been deleted.'));
    }

755
    menu_rebuild();
756
    drupal_goto('aggregator/'. arg(1));
Dries's avatar
   
Dries committed
757
758
759
760
761
762
763
764
765
766
767
768
769
  }

  if (arg(1) == 'categories') {
    $output = aggregator_form_category(aggregator_get_category(arg(2)));
  }
  else {
    $output = aggregator_form_feed(aggregator_get_feed(arg(2)));
  }

  print theme('page', $output);
}


Dries's avatar
   
Dries committed
770
/**
Dries's avatar
Dries committed
771
 * Menu callback; displays the category edit form, or saves changes and
772
 * redirects to the overview page.
Dries's avatar
   
Dries committed
773
774
775
776
777
778
779
780
781
782
783
 */
function aggregator_admin_edit_category($category = 0) {
  $edit = $_POST['edit'];
  $op = $_POST['op'];

  switch ($op) {
    case t('Delete'):
      $edit['title'] = 0;
      // Fall through:
    case t('Submit'):
      aggregator_save_category($edit);
784
      drupal_set_message($edit['title'] ? t('The category has been updated.') : t('The category has been deleted.'));
785
      menu_rebuild();
786
787
      drupal_goto('admin/aggregator');
      break;
Dries's avatar
   
Dries committed
788
789
790
    default:
      if ($category) {
        $output = aggregator_form_category(aggregator_get_category($category));
Dries's avatar
   
Dries committed
791
792
      }
      else {
Dries's avatar
   
Dries committed
793
        $output = aggregator_form_category();
Dries's avatar
   
Dries committed
794
      }
Dries's avatar
   
Dries committed
795
796
797
798
799
  }
  print theme('page', $output);
}

/**
Dries's avatar
Dries committed
800
801
 * Menu callback; displays the feed edit form.
 *
802
 * After editing, saves changes and redirects to the overview page.
Dries's avatar
   
Dries committed
803
804
805
806
807
808
809
810
811
812
813
 */
function aggregator_admin_edit_feed($feed = 0) {
  $edit = $_POST['edit'];
  $op = $_POST['op'];

  switch ($op) {
    case t('Delete'):
      $edit['title'] = 0;
      // Fall through:
    case t('Submit'):
      aggregator_save_feed($edit);
814
      drupal_set_message($edit['title'] ? t('The feed has been updated.') : t('The feed has been deleted.'));
815
      menu_rebuild();
816
817
      drupal_goto('admin/aggregator');
      break;
Dries's avatar
   
Dries committed
818
819
820
    default:
      if ($feed) {
        $output = aggregator_form_feed(aggregator_get_feed($feed));
Dries's avatar
   
Dries committed
821
822
      }
      else {
Dries's avatar
   
Dries committed
823
        $output = aggregator_form_feed();
Dries's avatar
   
Dries committed
824
      }
825
  }
Dries's avatar
   
Dries committed
826
827
828
829
  print theme('page', $output);
}

/**
830
 * Menu callback; removes all items from a feed, then redirects to the overview page.
Dries's avatar
   
Dries committed
831
832
833
 */
function aggregator_admin_remove_feed($feed) {
  aggregator_remove(aggregator_get_feed($feed));
834
  drupal_goto('admin/aggregator');
Dries's avatar
   
Dries committed
835
836
837
}

/**
838
 * Menu callback; refreshes a feed, then redirects to the overview page.
Dries's avatar
   
Dries committed
839
840
841
 */
function aggregator_admin_refresh_feed($feed) {
  aggregator_refresh(aggregator_get_feed($feed));
842
  drupal_goto('admin/aggregator');
Dries's avatar
   
Dries committed
843
844
845
}

/**
Dries's avatar
Dries committed
846
 * Menu callback; displays the aggregator administration page.
Dries's avatar
   
Dries committed
847
848
849
 */
function aggregator_admin_overview() {
  print theme('page', aggregator_view());
850
851
}

Dries's avatar
   
Dries committed
852
/**
Dries's avatar
Dries committed
853
 * Menu callback; displays the most recent items gathered from any feed.
Dries's avatar
   
Dries committed
854
 */
855
function aggregator_page_last() {
Dries's avatar
   
Dries committed
856
  _aggregator_page_list('SELECT i.*, f.title AS ftitle, f.link AS flink FROM {aggregator_item} i INNER JOIN {aggregator_feed} f ON i.fid = f.fid ORDER BY i.timestamp DESC, i.iid DESC', arg(1));
Dries's avatar
   
Dries committed
857
858
}

Dries's avatar
   
Dries committed
859
/**
Dries's avatar
Dries committed
860
 * Menu callback; displays all the items captured from a particular feed.
Dries's avatar
   
Dries committed
861
 */
862
function aggregator_page_source() {
Dries's avatar
   
Dries committed
863
  $feed = db_fetch_object(db_query('SELECT * FROM {aggregator_feed} WHERE fid = %d', arg(2)));
Dries's avatar
   
Dries committed
864
  $info = theme('aggregator_feed', $feed);
Dries's avatar
   
Dries committed
865

866
  _aggregator_page_list('SELECT * FROM {aggregator_item} WHERE fid = '. $feed->fid .' ORDER BY timestamp DESC, iid DESC', arg(3), "<div class=\"feed\">$info</div>");
Dries's avatar
   
Dries committed
867
868
}

Dries's avatar
   
Dries committed
869
/**
Dries's avatar
Dries committed
870
 * Menu callback; displays all the items aggregated in a particular category.
Dries's avatar
   
Dries committed
871
 */
872
function aggregator_page_category() {
Dries's avatar
   
Dries committed
873
  $category = db_fetch_object(db_query('SELECT cid, title FROM {aggregator_category} WHERE cid = %d', arg(2)));
Dries's avatar
   
Dries committed
874

875
  _aggregator_page_list('SELECT i.*, f.title AS ftitle, f.link AS flink FROM {aggregator_category_item} c LEFT JOIN {aggregator_item} i ON c.iid = i.iid LEFT JOIN {aggregator_feed} f ON i.fid = f.fid WHERE cid = '. $category->cid .' ORDER BY timestamp DESC, iid DESC', arg(3));
Dries's avatar
   
Dries committed
876
}
Dries's avatar
   
Dries committed
877

Dries's avatar
   
Dries committed
878
879
880
881
/**
 * Prints an aggregator page listing a number of feed items. Various
 * menu callbacks use this function to print their feeds.
 */
Dries's avatar
   
Dries committed
882
function _aggregator_page_list($sql, $op, $header = '') {
Dries's avatar
   
Dries committed
883
884
885
886
887
888
889
890
891
892
  if (user_access('administer news feeds') && $op == 'categorize') {
    if ($edit = $_POST['edit']) {
      foreach ($edit['categories'] as $iid => $selection) {
        db_query('DELETE FROM {aggregator_category_item} WHERE iid = %d', $iid);
        foreach ($selection as $cid) {
          if ($cid) {
            db_query('INSERT INTO {aggregator_category_item} (cid, iid) VALUES (%d, %d)', $cid, $iid);
          }
        }
      }
893
894
      drupal_set_message(t('The categories have been saved.'));
      drupal_goto($_GET['q']);
Dries's avatar
   
Dries committed
895
896
897
898
899
    }
    else {
      $categorize = true;
    }
  }
Dries's avatar
   
Dries committed
900

Dries's avatar
   
Dries committed
901
902
903
904
905
906
907
  $output = '<div id="aggregator">';
  if ($header) {
    $output .= $header;
  }
  if ($links) {
    $output .= theme('links', $links);
  }
Dries's avatar
   
Dries committed
908
909
910

  $result = pager_query($sql, 20);

Dries's avatar
   
Dries committed
911
912
  $rows = array();
  $categories = array();
Dries's avatar
   
Dries committed
913
  while ($item = db_fetch_object($result)) {
Dries's avatar
   
Dries committed
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
    if ($categorize) {
      $categories_result = db_query('SELECT c.cid, c.title, ci.iid FROM {aggregator_category} c LEFT JOIN {aggregator_category_item} ci ON c.cid = ci.cid AND ci.iid = %d', $item->iid);
      if (variable_get('aggregator_category_selector', 'check') == 'select') {
        $selected = array();
        while ($category = db_fetch_object($categories_result)) {
          if (!$done) {
            $categories[$category->cid] = check_form($category->title);
          }
          if ($category->iid) {
            $selected[] = $category->cid;
          }
        }
        $done = true;
        $form = form_select(NULL, 'categories]['. $item->iid, $selected, $categories, NULL, 'size="10"', true);
      }
      else {
        $form = '';
        while ($category = db_fetch_object($categories_result)) {
          $form .= form_checkbox(check_form($category->title), 'categories]['. $item->iid .'][', $category->cid, !is_null($category->iid));
        }
      }
      $rows[] = array(theme('aggregator_page_item', $item), array('data' => $form, 'class' => 'categorize-item'));
    }
    else {
      $output .= theme('aggregator_page_item', $item);
    }
Dries's avatar
   
Dries committed
940
  }
Dries's avatar
   
Dries committed
941
  if ($categorize) {
Dries's avatar
   
Dries committed
942
    $output .= form(theme('table', array('', t('Categorize')), $rows) . form_submit(t('Save categories')));
Dries's avatar
   
Dries committed
943
944
  }
  $output .= '</div>';
Dries's avatar
   
Dries committed
945
946
947
948
949

  if ($pager = theme('pager', NULL, 20, 0)) {
    $output .= $pager;
  }

Dries's avatar
   
Dries committed
950
  print theme('page', $output);
Dries's avatar
   
Dries committed
951
952
}

Dries's avatar
   
Dries committed
953
/**
Dries's avatar
Dries committed
954
 * Menu callback; displays all the feeds used by the aggregator.
Dries's avatar
   
Dries committed </