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>');
68
    case 'admin/aggregator/configure':
69
      return t('<p>These settings control the display of aggregated content.</p>');
Dries's avatar
   
Dries committed
70
  }
71
72
}

Dries's avatar
   
Dries committed
73
74
75
76
77
function aggregator_configure() {
  if ($_POST) {
    system_settings_save();
  }

Dries's avatar
   
Dries committed
78
  $output = '';
79
  $items = array(0 => t('none')) + drupal_map_assoc(array(3, 5, 10, 15, 20, 25), '_aggregator_items');
Dries's avatar
   
Dries committed
80

Dries's avatar
   
Dries committed
81
82
  $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.'));
  $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.'));
Dries's avatar
   
Dries committed
83

Dries's avatar
   
Dries committed
84
  print theme('page', system_settings_form($output));
Dries's avatar
   
Dries committed
85
86
}

87
88
89
90
91
92
93
/**
 * Helper function for drupal_map_assoc.
 */
function _aggregator_items($count) {
  return format_plural($count, '1 item', '%count items');
}

Dries's avatar
   
Dries committed
94
95
96
/**
 * Implementation of hook_perm().
 */
Kjartan's avatar
Kjartan committed
97
function aggregator_perm() {
Dries's avatar
   
Dries committed
98
  return array('administer news feeds', 'access news feeds');
Dries's avatar
   
Dries committed
99
100
}

Dries's avatar
   
Dries committed
101
102
103
/**
 * Implementation of hook_menu().
 */
Dries's avatar
   
Dries committed
104
function aggregator_menu($may_cache) {
Dries's avatar
   
Dries committed
105
  $items = array();
Dries's avatar
   
Dries committed
106

Dries's avatar
   
Dries committed
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
  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);
134
    $items[] = array('path' => 'admin/settings/aggregator', 'title' => t('configure'),
Dries's avatar
   
Dries committed
135
136
137
138
139
140
141
142
143
144
145
146
      'callback' => 'aggregator_configure', '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
147
148
149
150
151
    // 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
152
153
      $items[] = array('path' => 'aggregator/sources/'. $feed->fid .'/view', 'title' => t('view'),
        'type' => MENU_DEFAULT_LOCAL_TASK, 'weight' => -10);
Dries's avatar
   
Dries committed
154
155
156
157
158
159
160
      $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
161
    }
162

Dries's avatar
   
Dries committed
163
164
165
166
167
    // 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
168
169
      $items[] = array('path' => 'aggregator/categories/'. $category->cid .'/view', 'title' => t('view'),
        'type' => MENU_DEFAULT_LOCAL_TASK, 'weight' => -10);
Dries's avatar
   
Dries committed
170
171
172
173
174
175
176
177
178
      $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
179
180
181
182
    $items[] = array('path' => 'aggregator/opml', 'title' => t('opml'),
      'callback' => 'aggregator_page_opml', 'access' => $view,
      'type' => MENU_CALLBACK);
  }
Dries's avatar
   
Dries committed
183
184

  return $items;
185
186
}

Dries's avatar
   
Dries committed
187
188
189
190
191
/**
 * Implementation of hook_cron().
 *
 * Checks news feeds for updates once their refresh interval has elapsed.
 */
Dries's avatar
   
Dries committed
192
function aggregator_cron() {
Dries's avatar
   
Dries committed
193
  $result = db_query('SELECT * FROM {aggregator_feed} WHERE checked + refresh < %d', time());
Dries's avatar
   
Dries committed
194
195
  while ($feed = db_fetch_array($result)) {
    aggregator_refresh($feed);
Dries's avatar
   
Dries committed
196
197
198
  }
}

Dries's avatar
   
Dries committed
199
200
201
202
203
/**
 * Implementation of hook_block().
 *
 * Generates blocks for the latest news items in each category and feed.
 */
Dries's avatar
Dries committed
204
function aggregator_block($op, $delta, $edit = array()) {
Dries's avatar
   
Dries committed
205
  if (user_access('access news feeds')) {
Dries's avatar
   
Dries committed
206
    if ($op == 'list') {
Dries's avatar
Dries committed
207
      $result = db_query('SELECT cid, title FROM {aggregator_category} ORDER BY title');
Dries's avatar
   
Dries committed
208
209
      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
210
      }
Dries's avatar
Dries committed
211
      $result = db_query('SELECT fid, title FROM {aggregator_feed} ORDER BY fid');
Kjartan's avatar
Kjartan committed
212
      while ($feed = db_fetch_object($result)) {
Dries's avatar
   
Dries committed
213
        $block['feed:'. $feed->fid]['info'] = t('%title feed latest items', array('%title' => $feed->title));
Kjartan's avatar
Kjartan committed
214
      }
Dries's avatar
   
Dries committed
215
    }
Dries's avatar
Dries committed
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
    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);
      }
    }
237
    else if ($op == 'view') {
Dries's avatar
   
Dries committed
238
      list($type, $id) = split(':', $delta);
Kjartan's avatar
Kjartan committed
239
      switch ($type) {
Dries's avatar
   
Dries committed
240
241
242
243
244
        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
245
          break;
Dries's avatar
   
Dries committed
246
247
248
249
250
        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
251
252
          break;
      }
Dries's avatar
   
Dries committed
253
254
      $items = array();
      while ($item = db_fetch_object($result)) {
Dries's avatar
   
Dries committed
255
        $items[] = theme('aggregator_block_item', $item);
Dries's avatar
   
Dries committed
256
      }
Dries's avatar
   
Dries committed
257
      $block['content'] = theme('item_list', $items) . $block['content'];
Dries's avatar
   
Dries committed
258
    }
Dries's avatar
   
Dries committed
259
    return $block;
Dries's avatar
   
Dries committed
260
  }
Dries's avatar
   
Dries committed
261
262
}

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

Dries's avatar
   
Dries committed
276
277
278
/**
 * Call-back function used by the XML parser.
 */
Kjartan's avatar
Kjartan committed
279
function aggregator_element_start($parser, $name, $attributes) {
Dries's avatar
   
Dries committed
280
281
282
  global $item, $element, $tag;

  switch ($name) {
Dries's avatar
   
Dries committed
283
284
    case 'IMAGE':
    case 'TEXTINPUT':
Dries's avatar
   
Dries committed
285
286
      $element = $name;
      break;
Dries's avatar
   
Dries committed
287
    case 'ITEM':
Dries's avatar
   
Dries committed
288
289
      $element = $name;
      $item += 1;
290
291
292
293
294
  }

  $tag = $name;
}

Dries's avatar
   
Dries committed
295
296
297
/**
 * Call-back function used by the XML parser.
 */
Kjartan's avatar
Kjartan committed
298
function aggregator_element_end($parser, $name) {
Dries's avatar
   
Dries committed
299
300
  global $element;

Dries's avatar
   
Dries committed
301
  switch ($name) {
Dries's avatar
   
Dries committed
302
303
304
305
    case 'IMAGE':
    case 'TEXTINPUT':
    case 'ITEM':
      $element = '';
Dries's avatar
   
Dries committed
306
  }
307
308
}

Dries's avatar
   
Dries committed
309
310
311
/**
 * Call-back function used by the XML parser.
 */
Kjartan's avatar
Kjartan committed
312
function aggregator_element_data($parser, $data) {
Dries's avatar
   
Dries committed
313
  global $channel, $element, $items, $item, $image, $tag;
Dries's avatar
   
Dries committed
314
315

  switch ($element) {
Dries's avatar
   
Dries committed
316
    case 'ITEM':
Dries's avatar
   
Dries committed
317
318
      $items[$item][$tag] .= $data;
      break;
Dries's avatar
   
Dries committed
319
    case 'IMAGE':
Dries's avatar
   
Dries committed
320
321
      $image[$tag] .= $data;
      break;
Dries's avatar
   
Dries committed
322
323
324
    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
325
326
327
      break;
    default:
      $channel[$tag] .= $data;
328
329
330
  }
}

Dries's avatar
   
Dries committed
331
332
333
/**
 * Checks a news feed for new items.
 */
Kjartan's avatar
Kjartan committed
334
function aggregator_refresh($feed) {
Dries's avatar
   
Dries committed
335
336
  global $channel, $image;

Dries's avatar
   
Dries committed
337
338
339
340
341
342
  // Generate conditional GET headers.
  $headers = array();
  if ($feed['etag']) {
    $headers['If-None-Match'] = $feed['etag'];
  }
  if ($feed['modified']) {
Dries's avatar
   
Dries committed
343
    $headers['If-Modified-Since'] = gmdate('D, d M Y H:i:s', $feed['modified']) .' GMT';
Dries's avatar
   
Dries committed
344
345
346
347
348
  }

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

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

Dries's avatar
   
Dries committed
360
361
362
363
    case 200:
    case 302:
    case 307:
      // Filter the input data:
364
     if (aggregator_parse_feed($result->data, $feed)) {
365

Dries's avatar
   
Dries committed
366
367
368
        if ($result->headers['Last-Modified']) {
          $modified = strtotime($result->headers['Last-Modified']);
        }
Dries's avatar
Dries committed
369

370
371
372
373
374
375
376
377
        /*
        ** Prepare the channel data:
        */

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

Dries's avatar
   
Dries committed
378
379
380
        /*
        ** Prepare the image data (if any):
        */
Dries's avatar
   
Dries committed
381

Dries's avatar
   
Dries committed
382
383
384
        foreach ($image as $key => $value) {
          $image[$key] = trim($value);
        }
Dries's avatar
   
Dries committed
385

Dries's avatar
   
Dries committed
386
        if ($image['LINK'] && $image['URL'] && $image['TITLE']) {
Dries's avatar
   
Dries committed
387
          $image = '<a href="'. $image['LINK'] .'"><img src="'. $image['URL'] .'" alt="'. $image['TITLE'] .'" /></a>';
Dries's avatar
   
Dries committed
388
        }
Dries's avatar
   
Dries committed
389
390
391
        else {
          $image = NULL;
        }
Dries's avatar
   
Dries committed
392

Dries's avatar
   
Dries committed
393
394
395
        /*
        ** Update the feed data:
        */
Dries's avatar
   
Dries committed
396

397
        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
398

Dries's avatar
   
Dries committed
399
400
401
        /*
        ** Clear the cache:
        */
Dries's avatar
   
Dries committed
402

Dries's avatar
   
Dries committed
403
        cache_clear_all();
Dries's avatar
   
Dries committed
404

405
406
407
        $message = t('Syndicated content from %site.', array('%site' => '<em>'. $feed[title] .'</em>'));
        watchdog('aggregator', $message);
        drupal_set_message($message);
Dries's avatar
   
Dries committed
408
409
      }
      break;
Dries's avatar
   
Dries committed
410
    default:
411
412
413
      $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
414
  }
Dries's avatar
   
Dries committed
415
}
Dries's avatar
   
Dries committed
416

Dries's avatar
   
Dries committed
417
418
419
420
421
422
423
/**
 * 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.
424
 * @return A timestamp if parsed successfully or -1 if not.
Dries's avatar
   
Dries committed
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
 */
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
454
function aggregator_parse_feed(&$data, $feed) {
Dries's avatar
   
Dries committed
455
  global $items, $image, $channel;
Dries's avatar
   
Dries committed
456

Dries's avatar
   
Dries committed
457
  // Unset the global variables before we use them:
Dries's avatar
   
Dries committed
458
  unset($GLOBALS['element'], $GLOBALS['item'], $GLOBALS['tag']);
Dries's avatar
   
Dries committed
459
  $items = array();
Dries's avatar
   
Dries committed
460
  $image = array();
Dries's avatar
   
Dries committed
461
  $channel = array();
462

Dries's avatar
   
Dries committed
463
464
  // parse the data:
  $xml_parser = drupal_xml_parser_create($data);
Dries's avatar
   
Dries committed
465
466
  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
467

Dries's avatar
   
Dries committed
468
  if (!xml_parse($xml_parser, $data, 1)) {
469
470
471
    $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
472
    return 0;
Dries's avatar
   
Dries committed
473
474
  }
  xml_parser_free($xml_parser);
Dries's avatar
   
Dries committed
475

Dries's avatar
   
Dries committed
476
  // initialize the translation table:
477
  $tt = array_flip(get_html_translation_table(HTML_SPECIALCHARS));
Dries's avatar
   
Dries committed
478
  $tt['&apos;'] = "'";
Dries's avatar
   
Dries committed
479

Dries's avatar
   
Dries committed
480
481
482
483
484
  /*
  ** 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
485

Dries's avatar
   
Dries committed
486
  $items = array_reverse($items);
Dries's avatar
   
Dries committed
487

Dries's avatar
   
Dries committed
488
489
  foreach ($items as $item) {
    unset($title, $link, $author, $description);
490

Dries's avatar
   
Dries committed
491
492
    // Prepare the item:
    foreach ($item as $key => $value) {
493
494
495
496
497
498
      // 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
499
    }
Dries's avatar
Dries committed
500

Dries's avatar
   
Dries committed
501
502
503
504
505
506
    /*
    ** 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
507
508
    if ($item['TITLE']) {
      $title = $item['TITLE'];
Dries's avatar
   
Dries committed
509
510
    }
    else {
Dries's avatar
   
Dries committed
511
      $title = preg_replace('/^(.*)[^\w;&].*?$/', "\\1", truncate_utf8($item['DESCRIPTION'], 40));
Dries's avatar
   
Dries committed
512
    }
Dries's avatar
   
Dries committed
513

Dries's avatar
   
Dries committed
514
515
516
517
    /*
    ** Resolve the items link.
    */

Dries's avatar
   
Dries committed
518
519
    if ($item['LINK']) {
      $link = $item['LINK'];
Dries's avatar
   
Dries committed
520
    }
Dries's avatar
   
Dries committed
521
522
    elseif ($item['GUID'] && (strncmp($item['GUID'], 'http://', 7) == 0)) {
      $link = $item['GUID'];
Dries's avatar
   
Dries committed
523
524
    }
    else {
Dries's avatar
   
Dries committed
525
      $link = $feed['link'];
Dries's avatar
   
Dries committed
526
    }
527

Dries's avatar
   
Dries committed
528
529
530
531
532
533
534
535
536
537
    /*
    ** 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
538
    else $date = 'now';
Dries's avatar
   
Dries committed
539

Dries's avatar
   
Dries committed
540
    $timestamp = strtotime($date); // strtotime() returns -1 on failure
Dries's avatar
   
Dries committed
541
    if ($timestamp < 0) {
Dries's avatar
   
Dries committed
542
543
544
545
      $timestamp = aggregator_parse_w3cdtf($date); // also returns -1 on failure
      if ($timestamp < 0) {
        $timestamp = time(); // better than nothing
      }
546
    }
Dries's avatar
   
Dries committed
547
548

    /*
Dries's avatar
   
Dries committed
549
550
551
    ** 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
552
553
    */

Dries's avatar
   
Dries committed
554
555
    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
556
557
    }
    else {
Dries's avatar
   
Dries committed
558
      $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
559
    }
Dries's avatar
   
Dries committed
560

561
    if (!valid_input_data($item['DESCRIPTION'])) {
Dries's avatar
   
Dries committed
562
      drupal_set_message(t('Failed to parse entry from %site feed: suspicious input data.', array('%site' => '<em>'. $feed['title'] .'</em>')), 'error');
563
564
565
566
    }
    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
567
  }
Dries's avatar
   
Dries committed
568

Dries's avatar
   
Dries committed
569
  /*
Dries's avatar
   
Dries committed
570
  ** Remove all items that are older than 3 months:
Dries's avatar
   
Dries committed
571
  */
Dries's avatar
   
Dries committed
572

573
  $age = time() - 8035200; // 60 * 60 * 24 * 31 * 3
Dries's avatar
   
Dries committed
574
  $result = db_query('SELECT iid FROM {aggregator_item} WHERE fid = %d AND timestamp < %d', $feed['fid'], $age);
Dries's avatar
   
Dries committed
575

576
577
578
579
580
581
582
  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
583
  }
Dries's avatar
   
Dries committed
584
585

  return 1;
586
587
}

Kjartan's avatar
Kjartan committed
588
function aggregator_save_item($edit) {
Dries's avatar
   
Dries committed
589
  if ($edit['iid'] && $edit['title']) {
Dries's avatar
   
Dries committed
590
    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']);
591
  }
Dries's avatar
   
Dries committed
592
593
594
  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']);
595
  }
Dries's avatar
   
Dries committed
596
  else if ($edit['title'] && $edit['link']) {
Dries's avatar
   
Dries committed
597
598
    $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
599
600
601
    // 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
602
      db_query('INSERT INTO {aggregator_category_item} (cid, iid) VALUES (%d, %d)', $category->cid, $edit['iid']);
Dries's avatar
   
Dries committed
603
    }
604
605
606
  }
}

Dries's avatar
   
Dries committed
607
608
609
610
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'));
611

Dries's avatar
   
Dries committed
612
613
614
  if ($edit['cid']) {
    $form .= form_submit(t('Delete'));
    $form .= form_hidden('cid', $edit['cid']);
615
616
  }

Dries's avatar
   
Dries committed
617
  return form($form);
618
619
}

Dries's avatar
   
Dries committed
620
621
function aggregator_save_category($edit) {
  if ($edit['cid'] && $edit['title']) {
Dries's avatar
Dries committed
622
    db_query('UPDATE {aggregator_category} SET title = \'%s\', description = \'%s\' WHERE cid = %d', $edit['title'], $edit['description'], $edit['cid']);
623
  }
Dries's avatar
   
Dries committed
624
625
  else if ($edit['cid']) {
    db_query('DELETE FROM {aggregator_category} WHERE cid = %d', $edit['cid']);
626
  }
Dries's avatar
   
Dries committed
627
  else if ($edit['title']) {
Dries's avatar
   
Dries committed
628
    // a single unique id for bundles and feeds, to use in blocks
Dries's avatar
   
Dries committed
629
    $next_id = db_next_id('{aggregator_category}_cid');
Dries's avatar
Dries committed
630
    db_query('INSERT INTO {aggregator_category} (cid, title, description, block) VALUES (%d, \'%s\', \'%s\', 5)', $next_id, $edit['title'], $edit['description']);
631
632
633
  }
}

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

Dries's avatar
   
Dries committed
637
638
  if ($edit['refresh'] == '') {
    $edit['refresh'] = 3600;
Dries's avatar
   
Dries committed
639
  }
Dries's avatar
   
Dries committed
640

Dries's avatar
   
Dries committed
641
  $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.'));
642
  $form .= form_textfield(t('URL'), 'url', $edit['url'], 50, 255, t('The fully-qualified URL of the feed.'));
Dries's avatar
   
Dries committed
643
  $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
644
645
646
647

  // Handling of categories:
  $options = array();
  $values = array();
Dries's avatar
   
Dries committed
648
  $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
649
  while ($category = db_fetch_object($categories)) {
Dries's avatar
Dries committed
650
651
    $options[$category->cid] = $category->title;
    if ($category->fid) $values[] = $category->cid;
Dries's avatar
   
Dries committed
652
  }
Dries's avatar
Dries committed
653
654
  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
655
  }
Dries's avatar
   
Dries committed
656

Dries's avatar
Dries committed
657
  // Form buttons:
Dries's avatar
   
Dries committed
658
659
660
661
  $form .= form_submit(t('Submit'));
  if ($edit['fid']) {
    $form .= form_submit(t('Delete'));
    $form .= form_hidden('fid', $edit['fid']);
662
663
  }

Dries's avatar
   
Dries committed
664
  return form($form);
665
666
}

Kjartan's avatar
Kjartan committed
667
function aggregator_save_feed($edit) {
Dries's avatar
   
Dries committed
668
  if ($edit['fid']) {
669
    // an existing feed is being modified, delete the category listings
Dries's avatar
   
Dries committed
670
    db_query('DELETE FROM {aggregator_category_feed} WHERE fid = %d', $edit['fid']);
671
  }
Dries's avatar
   
Dries committed
672
  if ($edit['fid'] && $edit['title']) {
Dries's avatar
Dries committed
673
    db_query('UPDATE {aggregator_feed} SET title = \'%s\', url = \'%s\', refresh = %d WHERE fid = %d', $edit['title'], $edit['url'], $edit['refresh'], $edit['fid']);
674
  }
Dries's avatar
   
Dries committed
675
676
677
678
679
680
681
682
683
684
  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']);
685
  }
Dries's avatar
   
Dries committed
686
687
688
  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
689
    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
690
691
692
  }
  if ($edit['title']) {
    // the feed is being saved, save the categories as well
Dries's avatar
Dries committed
693
    if ($edit['category']) {
Dries's avatar
Dries committed
694
695
      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
696
697
      }
    }
698
699
700
  }
}

Kjartan's avatar
Kjartan committed
701
function aggregator_get_feed($fid) {
Dries's avatar
   
Dries committed
702
  return db_fetch_array(db_query('SELECT * FROM {aggregator_feed} WHERE fid = %d', $fid));
703
704
}

Dries's avatar
   
Dries committed
705
function aggregator_get_category($cid) {
Dries's avatar
   
Dries committed
706
  return db_fetch_array(db_query('SELECT * FROM {aggregator_category} WHERE cid = %d', $cid));
707
708
}

Kjartan's avatar
Kjartan committed
709
function aggregator_view() {
Dries's avatar
   
Dries committed
710
  $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');
711

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

Dries's avatar
   
Dries committed
714
  $header = array(t('Title'), t('Items'), t('Last update'), t('Next update'), array('data' => t('Operations'), 'colspan' => '3'));
Dries's avatar
   
Dries committed
715
  $rows = array();
716
  while ($feed = db_fetch_object($result)) {
Dries's avatar
   
Dries committed
717
    $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"));
718
  }
Dries's avatar
   
Dries committed
719
  $output .= theme('table', $header, $rows);
720

Dries's avatar
   
Dries committed
721
  $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');
722

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

Dries's avatar
   
Dries committed
725
  $header = array(t('Title'), t('Items'), t('Operations'));
Dries's avatar
   
Dries committed
726
  $rows = array();
Dries's avatar
   
Dries committed
727
  while ($category = db_fetch_object($result)) {
Dries's avatar
   
Dries committed
728
    $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"));
729
  }
Dries's avatar
   
Dries committed
730
  $output .= theme('table', $header, $rows);
731
732
733
734

  return $output;
}

Dries's avatar
   
Dries committed
735
736
737
738
739
740
741
742
743
744
745
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.'));
    }
746

747
    menu_rebuild();
748
    drupal_goto($_GET['q']);
Dries's avatar
   
Dries committed
749
750
751
752
753
754
755
756
757
758
759
760
761
762
  }
  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.'));
    }

763
    menu_rebuild();
764
    drupal_goto('aggregator/'. arg(1));
Dries's avatar
   
Dries committed
765
766
767
768
769
770
771
772
773
774
775
776
777
  }

  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
778
/**
Dries's avatar
Dries committed
779
 * Menu callback; displays the category edit form, or saves changes and
780
 * redirects to the overview page.
Dries's avatar
   
Dries committed
781
782
783
784
785
786
787
788
789
790
791
 */
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);
792
      drupal_set_message($edit['title'] ? t('The category has been updated.') : t('The category has been deleted.'));
793
      menu_rebuild();
794
795
      drupal_goto('admin/aggregator');
      break;
Dries's avatar
   
Dries committed
796
797
798
    default:
      if ($category) {
        $output = aggregator_form_category(aggregator_get_category($category));
Dries's avatar
   
Dries committed
799
800
      }
      else {
Dries's avatar
   
Dries committed
801
        $output = aggregator_form_category();
Dries's avatar
   
Dries committed
802
      }
Dries's avatar
   
Dries committed
803
804
805
806
807
  }
  print theme('page', $output);
}

/**
Dries's avatar
Dries committed
808
809
 * Menu callback; displays the feed edit form.
 *
810
 * After editing, saves changes and redirects to the overview page.
Dries's avatar
   
Dries committed
811
812
813
814
815
816
817
818
819
820
821
 */
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);
822
      drupal_set_message($edit['title'] ? t('The feed has been updated.') : t('The feed has been deleted.'));
823
      menu_rebuild();
824
825
      drupal_goto('admin/aggregator');
      break;
Dries's avatar
   
Dries committed
826
827
828
    default:
      if ($feed) {
        $output = aggregator_form_feed(aggregator_get_feed($feed));
Dries's avatar
   
Dries committed
829
830
      }
      else {
Dries's avatar
   
Dries committed
831
        $output = aggregator_form_feed();
Dries's avatar
   
Dries committed
832
      }
833
  }
Dries's avatar
   
Dries committed
834
835
836
837
  print theme('page', $output);
}

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

/**
846
 * Menu callback; refreshes a feed, then redirects to the overview page.
Dries's avatar
   
Dries committed
847
848
849
 */
function aggregator_admin_refresh_feed($feed) {
  aggregator_refresh(aggregator_get_feed($feed));
850
  drupal_goto('admin/aggregator');
Dries's avatar
   
Dries committed
851
852
853
}

/**
Dries's avatar
Dries committed
854
 * Menu callback; displays the aggregator administration page.
Dries's avatar
   
Dries committed
855
856
857
 */
function aggregator_admin_overview() {
  print theme('page', aggregator_view());
858
859
}

Dries's avatar
   
Dries committed
860
/**
Dries's avatar
Dries committed
861
 * Menu callback; displays the most recent items gathered from any feed.
Dries's avatar
   
Dries committed
862
 */
863
function aggregator_page_last() {
Dries's avatar
   
Dries committed
864
  _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
865
866
}

Dries's avatar
   
Dries committed
867
/**
Dries's avatar
Dries committed
868
 * Menu callback; displays all the items captured from a particular feed.
Dries's avatar
   
Dries committed
869
 */
870
function aggregator_page_source() {
Dries's avatar
   
Dries committed
871
  $feed = db_fetch_object(db_query('SELECT * FROM {aggregator_feed} WHERE fid = %d', arg(2)));
Dries's avatar
   
Dries committed
872
  $info = theme('aggregator_feed', $feed);
Dries's avatar
   
Dries committed
873

874
  _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
875
876
}

Dries's avatar
   
Dries committed
877
/**
Dries's avatar
Dries committed
878
 * Menu callback; displays all the items aggregated in a particular category.
Dries's avatar
   
Dries committed
879
 */
880
function aggregator_page_category() {
Dries's avatar
   
Dries committed
881
  $category = db_fetch_object(db_query('SELECT cid, title FROM {aggregator_category} WHERE cid = %d', arg(2)));
Dries's avatar
   
Dries committed
882

883
  _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
884
}
Dries's avatar
   
Dries committed
885

Dries's avatar
   
Dries committed
886
887
888
889
/**
 * 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
890
function _aggregator_page_list($sql, $op, $header = '') {
Dries's avatar
   
Dries committed
891
892
893
894
895
896
897
898
899
900
  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);
          }
        }
      }
901
902
      drupal_set_message(t('The categories have been saved.'));
      drupal_goto($_GET['q']);
Dries's avatar
   
Dries committed
903
904
905
906
907
    }
    else {
      $categorize = true;
    }
  }
Dries's avatar
   
Dries committed
908

Dries's avatar
   
Dries committed
909
910
911
912
913
914
915
  $output = '<div id="aggregator">';
  if ($header) {
    $output .= $header;
  }
  if ($links) {
    $output .= theme('links', $links);
  }
Dries's avatar
   
Dries committed
916
917
918

  $result = pager_query($sql, 20);

Dries's avatar
   
Dries committed
919
920
  $rows = array();
  $categories = array();
Dries's avatar
   
Dries committed
921
  while ($item = db_fetch_object($result)) {
Dries's avatar
   
Dries committed
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
    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
948
  }
Dries's avatar
   
Dries committed
949
  if ($categorize) {
Dries's avatar
   
Dries committed
950
    $output .= form(theme('table', array('', t('Categorize')), $rows) . form_submit(t('Save categories')));
Dries's avatar
   
Dries committed
951
952
  }
  $output .= '</div>';
Dries's avatar
   
Dries committed
953
954
955
956
957

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

Dries's avatar
   
Dries committed
958
  print theme('page', $output);
Dries's avatar
   
Dries committed
959
960
}

Dries's avatar