aggregator.module 55.4 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':
61
      return t('Aggregates syndicated content (RSS and RDF feeds).');
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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
  $form['aggregator_allowed_html_tags'] = array(
    type => 'textfield', title => t('Allowed HTML tags'), size => 80, maxlength => 255,
    default_value => variable_get('aggregator_allowed_html_tags', '<a> <b> <br> <dd> <dl> <dt> <em> <i> <li> <ol> <p> <strong> <u> <ul>'), 
    description => t('The list of tags which are allowed in feeds, i.e., which will not be removed by Drupal.')
  );

  $form['aggregator_summary_items'] = array(
    type => 'select', title => t('Items shown in sources and categories pages') , 
    default_value => variable_get('aggregator_summary_items', 3), options => $items, 
    description =>  t('The number of items which will be shown with each feed or category in the feed and category summary pages.')
  );

  $form['aggregator_clear'] = array(
    type => 'select', title => t('Discard news items older than'), 
    default_value => variable_get('aggregator_clear', 9676800), options => $period, 
    description => t('Older news items will be automatically discarded.  Requires crontab.')
  );
  
  $form['aggregator_category_selector'] = array(
    type => 'radios', title => t('Category selection type'), default_value => variable_get('aggregator_category_selector', 'check'),
    options => array('check' => t('checkboxes'), 'select' => t('multiple selector')),
    description => 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.')
  );
  return $form;
Dries's avatar
   
Dries committed
99
100
}

101
102
103
104
105
106
107
/**
 * Helper function for drupal_map_assoc.
 */
function _aggregator_items($count) {
  return format_plural($count, '1 item', '%count items');
}

Dries's avatar
   
Dries committed
108
109
110
/**
 * Implementation of hook_perm().
 */
Kjartan's avatar
Kjartan committed
111
function aggregator_perm() {
Dries's avatar
   
Dries committed
112
  return array('administer news feeds', 'access news feeds');
Dries's avatar
   
Dries committed
113
114
}

Dries's avatar
   
Dries committed
115
116
117
/**
 * Implementation of hook_menu().
 */
Dries's avatar
   
Dries committed
118
function aggregator_menu($may_cache) {
Dries's avatar
   
Dries committed
119
  $items = array();
120
121
  $edit = user_access('administer news feeds');
  $view = user_access('access news feeds');
Dries's avatar
   
Dries committed
122

Dries's avatar
   
Dries committed
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
  if ($may_cache) {
    $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);
156
157
158
159
    $items[] = array('path' => 'aggregator/rss', 'title' => t('RSS feed'),
      'callback' => 'aggregator_page_rss', 'access' => $view,
      'type' => MENU_CALLBACK);
    $items[] = array('path' => 'aggregator/opml', 'title' => t('OPML feed'),
Dries's avatar
   
Dries committed
160
161
162
      'callback' => 'aggregator_page_opml', 'access' => $view,
      'type' => MENU_CALLBACK);
  }
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
  else {
    if (arg(0) == 'aggregator' && is_numeric(arg(2))) {
      if (arg(1) == 'sources') {
        $feed = db_fetch_object(db_query('SELECT title, fid FROM {aggregator_feed} WHERE fid = %d', arg(2)));
        if ($feed) {
          $items[] = array('path' => 'aggregator/sources/'. $feed->fid, 'title' => $feed->title,
                           'callback' => 'aggregator_page_source', 'access' => $view);
          $items[] = array('path' => 'aggregator/sources/'. $feed->fid .'/view', 'title' => t('view'),
                           'type' => MENU_DEFAULT_LOCAL_TASK, 'weight' => -10);
          $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);
        }
      }
      else if (arg(1) == 'categories') {
        $category = db_fetch_object(db_query('SELECT title, cid FROM {aggregator_category} WHERE cid = %d', arg(2)));
        if ($category) {
          $items[] = array('path' => 'aggregator/categories/'. $category->cid, 'title' => $category->title,
                           'callback' => 'aggregator_page_category', 'access' => $view);
          $items[] = array('path' => 'aggregator/categories/'. $category->cid .'/view', 'title' => t('view'),
                           'type' => MENU_DEFAULT_LOCAL_TASK, 'weight' => -10);
          $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
199
200

  return $items;
201
202
}

Dries's avatar
   
Dries committed
203
204
205
206
207
/**
 * Implementation of hook_cron().
 *
 * Checks news feeds for updates once their refresh interval has elapsed.
 */
Dries's avatar
   
Dries committed
208
function aggregator_cron() {
Dries's avatar
   
Dries committed
209
  $result = db_query('SELECT * FROM {aggregator_feed} WHERE checked + refresh < %d', time());
Dries's avatar
   
Dries committed
210
211
  while ($feed = db_fetch_array($result)) {
    aggregator_refresh($feed);
Dries's avatar
   
Dries committed
212
213
214
  }
}

Dries's avatar
   
Dries committed
215
216
217
218
219
/**
 * Implementation of hook_block().
 *
 * Generates blocks for the latest news items in each category and feed.
 */
Dries's avatar
Dries committed
220
function aggregator_block($op, $delta = 0, $edit = array()) {
Dries's avatar
   
Dries committed
221
  if (user_access('access news feeds')) {
Dries's avatar
   
Dries committed
222
    if ($op == 'list') {
Dries's avatar
Dries committed
223
      $result = db_query('SELECT cid, title FROM {aggregator_category} ORDER BY title');
Dries's avatar
   
Dries committed
224
      while ($category = db_fetch_object($result)) {
225
        $block['category-'. $category->cid]['info'] = t('%title category latest items', array('%title' => theme('placeholder', $category->title)));
Kjartan's avatar
Kjartan committed
226
      }
Dries's avatar
Dries committed
227
      $result = db_query('SELECT fid, title FROM {aggregator_feed} ORDER BY fid');
Kjartan's avatar
Kjartan committed
228
      while ($feed = db_fetch_object($result)) {
229
        $block['feed-'. $feed->fid]['info'] = t('%title feed latest items', array('%title' => theme('placeholder', $feed->title)));
Kjartan's avatar
Kjartan committed
230
      }
Dries's avatar
   
Dries committed
231
    }
Dries's avatar
Dries committed
232
    else if ($op == 'configure') {
233
      list($type, $id) = explode('-', $delta);
Dries's avatar
Dries committed
234
235
236
237
238
239
      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));
      }
240
241
      $form['block'] = array(type => 'select', title => t('Number of news items in block'), default_value => $value, options => drupal_map_assoc(array(2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20)));
      return $form;
Dries's avatar
Dries committed
242
243
    }
    else if ($op == 'save') {
244
      list($type, $id) = explode('-', $delta);
Dries's avatar
Dries committed
245
246
247
248
249
250
251
      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);
      }
    }
252
    else if ($op == 'view') {
253
      list($type, $id) = explode('-', $delta);
Kjartan's avatar
Kjartan committed
254
      switch ($type) {
Dries's avatar
   
Dries committed
255
        case 'feed':
256
          if ($feed = db_fetch_object(db_query('SELECT fid, title, block FROM {aggregator_feed} WHERE fid = %d', $id))) {
257
            $block['subject'] = check_plain($feed->title);
258
259
260
            $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
261
          break;
262

Dries's avatar
   
Dries committed
263
        case 'category':
264
          if ($category = db_fetch_object(db_query('SELECT cid, title, block FROM {aggregator_category} WHERE cid = %d', $id))) {
265
            $block['subject'] = check_plain($category->title);
266
267
268
            $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
269
270
          break;
      }
Dries's avatar
   
Dries committed
271
272
      $items = array();
      while ($item = db_fetch_object($result)) {
Dries's avatar
   
Dries committed
273
        $items[] = theme('aggregator_block_item', $item);
Dries's avatar
   
Dries committed
274
      }
Dries's avatar
   
Dries committed
275
      $block['content'] = theme('item_list', $items) . $block['content'];
Dries's avatar
   
Dries committed
276
    }
Dries's avatar
   
Dries committed
277
    return $block;
Dries's avatar
   
Dries committed
278
  }
Dries's avatar
   
Dries committed
279
280
}

Dries's avatar
   
Dries committed
281
282
283
284
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
285
  }
Dries's avatar
   
Dries committed
286
287
  if ($items) {
    db_query('DELETE FROM {aggregator_category_item} WHERE '. implode(' OR ', $items));
Dries's avatar
   
Dries committed
288
  }
Dries's avatar
   
Dries committed
289
  db_query('DELETE FROM {aggregator_item} WHERE fid = %d', $feed['fid']);
Kjartan's avatar
Kjartan committed
290
  db_query("UPDATE {aggregator_feed} SET checked = 0, etag = '', modified = 0 WHERE fid = %d", $feed['fid']);
291
  drupal_set_message(t('The news items from %site have been removed.', array('%site' => theme('placeholder', $feed['title']))));
Dries's avatar
   
Dries committed
292
293
}

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

  switch ($name) {
Dries's avatar
   
Dries committed
301
302
    case 'IMAGE':
    case 'TEXTINPUT':
303
304
305
306
307
308
    case 'CONTENT':
    case 'SUMMARY':
    case 'TAGLINE':
    case 'SUBTITLE':
    case 'LOGO':
    case 'INFO':
Dries's avatar
   
Dries committed
309
310
      $element = $name;
      break;
311
312
313
314
    case 'ID':
      if ($element != 'ITEM') {
        $element = $name;
      }
315
316
317
318
319
320
321
322
323
324
    case 'LINK':
      if ($attributes['REL'] == 'alternate') {
        if ($element == 'ITEM') {
          $items[$item]['LINK'] = $attributes['HREF'];
        }
        else {
          $channel['LINK'] = $attributes['HREF'];
        }
      }
      break;
Dries's avatar
   
Dries committed
325
    case 'ITEM':
Dries's avatar
   
Dries committed
326
327
      $element = $name;
      $item += 1;
328
329
330
331
332
      break;
    case 'ENTRY':
      $element = 'ITEM';
      $item += 1;
      break;
333
334
335
336
337
  }

  $tag = $name;
}

Dries's avatar
   
Dries committed
338
339
340
/**
 * Call-back function used by the XML parser.
 */
Kjartan's avatar
Kjartan committed
341
function aggregator_element_end($parser, $name) {
Dries's avatar
   
Dries committed
342
343
  global $element;

Dries's avatar
   
Dries committed
344
  switch ($name) {
Dries's avatar
   
Dries committed
345
346
347
    case 'IMAGE':
    case 'TEXTINPUT':
    case 'ITEM':
348
349
350
    case 'ENTRY':
    case 'CONTENT':
    case 'INFO':
351
352
      $element = '';
      break;
353
    case 'ID':
354
      if ($element == 'ID') {
Dries's avatar
   
Dries committed
355
      $element = '';
Dries's avatar
   
Dries committed
356
  }
357
}
358
}
359

Dries's avatar
   
Dries committed
360
361
362
/**
 * Call-back function used by the XML parser.
 */
Kjartan's avatar
Kjartan committed
363
function aggregator_element_data($parser, $data) {
Dries's avatar
   
Dries committed
364
  global $channel, $element, $items, $item, $image, $tag;
Dries's avatar
   
Dries committed
365
366

  switch ($element) {
Dries's avatar
   
Dries committed
367
    case 'ITEM':
Dries's avatar
   
Dries committed
368
369
      $items[$item][$tag] .= $data;
      break;
Dries's avatar
   
Dries committed
370
    case 'IMAGE':
371
    case 'LOGO':
Dries's avatar
   
Dries committed
372
373
      $image[$tag] .= $data;
      break;
374
375
376
377
378
379
    case 'LINK':
      if ($data) {
        $items[$item][$tag] .= $data;
      }
      break;
    case 'CONTENT':
380
      $items[$item]['CONTENT'] .= $data;
381
382
      break;
    case 'SUMMARY':
383
      $items[$item]['SUMMARY'] .= $data;
384
385
386
387
388
389
390
      break;
    case 'TAGLINE':
    case 'SUBTITLE':
      $channel['DESCRIPTION'] .= $data;
      break;
    case 'INFO':
    case 'ID':
Dries's avatar
   
Dries committed
391
392
393
    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
394
395
396
      break;
    default:
      $channel[$tag] .= $data;
397
398
399
  }
}

Dries's avatar
   
Dries committed
400
401
402
/**
 * Checks a news feed for new items.
 */
Kjartan's avatar
Kjartan committed
403
function aggregator_refresh($feed) {
Dries's avatar
   
Dries committed
404
405
  global $channel, $image;

Dries's avatar
   
Dries committed
406
407
408
409
410
411
  // Generate conditional GET headers.
  $headers = array();
  if ($feed['etag']) {
    $headers['If-None-Match'] = $feed['etag'];
  }
  if ($feed['modified']) {
Dries's avatar
   
Dries committed
412
    $headers['If-Modified-Since'] = gmdate('D, d M Y H:i:s', $feed['modified']) .' GMT';
Dries's avatar
   
Dries committed
413
414
415
416
417
  }

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

418
  // Process HTTP response code.
Dries's avatar
   
Dries committed
419
420
  switch ($result->code) {
    case 304:
Dries's avatar
   
Dries committed
421
      db_query('UPDATE {aggregator_feed} SET checked = %d WHERE fid = %d', time(), $feed['fid']);
422
      drupal_set_message(t('There is no new syndicated content from %site.', array('%site' => theme('placeholder', $feed['title']))));
Dries's avatar
   
Dries committed
423
      break;
Dries's avatar
   
Dries committed
424
425
    case 301:
      $feed['url'] = $result->redirect_url;
426
      watchdog('aggregator', t('Updated URL for feed %title to %url.', array('%title' => theme('placeholder', $feed['title']), '%url' => theme('placeholder', $feed['url']))));
427
428
      break;

Dries's avatar
   
Dries committed
429
430
431
432
    case 200:
    case 302:
    case 307:
      // Filter the input data:
433
     if (aggregator_parse_feed($result->data, $feed)) {
434

Dries's avatar
   
Dries committed
435
436
437
        if ($result->headers['Last-Modified']) {
          $modified = strtotime($result->headers['Last-Modified']);
        }
Dries's avatar
Dries committed
438

439
440
441
442
443
444
445
446
        /*
        ** Prepare the channel data:
        */

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

Dries's avatar
   
Dries committed
447
448
449
        /*
        ** Prepare the image data (if any):
        */
Dries's avatar
   
Dries committed
450

Dries's avatar
   
Dries committed
451
452
453
        foreach ($image as $key => $value) {
          $image[$key] = trim($value);
        }
Dries's avatar
   
Dries committed
454

Dries's avatar
   
Dries committed
455
        if ($image['LINK'] && $image['URL'] && $image['TITLE']) {
Dries's avatar
   
Dries committed
456
          $image = '<a href="'. $image['LINK'] .'"><img src="'. $image['URL'] .'" alt="'. $image['TITLE'] .'" /></a>';
Dries's avatar
   
Dries committed
457
        }
Dries's avatar
   
Dries committed
458
459
460
        else {
          $image = NULL;
        }
Dries's avatar
   
Dries committed
461

Dries's avatar
   
Dries committed
462
463
464
        /*
        ** Update the feed data:
        */
Dries's avatar
   
Dries committed
465

466
        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
467

Dries's avatar
   
Dries committed
468
469
470
        /*
        ** Clear the cache:
        */
Dries's avatar
   
Dries committed
471

Dries's avatar
   
Dries committed
472
        cache_clear_all();
Dries's avatar
   
Dries committed
473

474
475
        watchdog('aggregator', t('There is new syndicated content from %site.', array('%site' => theme('placeholder', $feed[title]))));
        drupal_set_message(t('There is new syndicated content from %site.', array('%site' => theme('placeholder', $feed[title]))));
Dries's avatar
   
Dries committed
476
477
      }
      break;
Dries's avatar
   
Dries committed
478
    default:
479
480
      watchdog('aggregator', t('The RSS-feed from %site seems to be broken, due to "%error".', array('%site' => theme('placeholder', $feed['title']), '%error' => theme('placeholder', $result->code .' '. $result->error))), WATCHDOG_WARNING);
      drupal_set_message(t('The RSS-feed from %site seems to be broken, because of error "%error".', array('%site' => theme('placeholder', $feed['title']), '%error' => theme('placeholder', $result->code .' '. $result->error))));
Dries's avatar
   
Dries committed
481
  }
Dries's avatar
   
Dries committed
482
}
Dries's avatar
   
Dries committed
483

Dries's avatar
   
Dries committed
484
485
486
487
/**
 * 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.
488
 * Originally from MagpieRSS (http://magpierss.sourceforge.net/).
Dries's avatar
   
Dries committed
489
490
 *
 * @param $date_str A string with a potentially W3C DTF date.
491
 * @return A timestamp if parsed successfully or -1 if not.
Dries's avatar
   
Dries committed
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
 */
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
521
function aggregator_parse_feed(&$data, $feed) {
Dries's avatar
   
Dries committed
522
  global $items, $image, $channel;
Dries's avatar
   
Dries committed
523

Dries's avatar
   
Dries committed
524
  // Unset the global variables before we use them:
Dries's avatar
   
Dries committed
525
  unset($GLOBALS['element'], $GLOBALS['item'], $GLOBALS['tag']);
Dries's avatar
   
Dries committed
526
  $items = array();
Dries's avatar
   
Dries committed
527
  $image = array();
Dries's avatar
   
Dries committed
528
  $channel = array();
529

Dries's avatar
   
Dries committed
530
531
  // parse the data:
  $xml_parser = drupal_xml_parser_create($data);
Dries's avatar
   
Dries committed
532
533
  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
534

Dries's avatar
   
Dries committed
535
  if (!xml_parse($xml_parser, $data, 1)) {
536
537
    watchdog('aggregator', t('The RSS-feed from %site seems to be broken, due to an error "%error" on line %line.', array('%site' => theme('placeholder', $feed['title']), '%error' => xml_error_string(xml_get_error_code($xml_parser)), '%line' => xml_get_current_line_number($xml_parser))), WATCHDOG_WARNING);
    drupal_set_message(t('The RSS-feed from %site seems to be broken, because of error "%error" on line %line.', array('%site' => theme('placeholder', $feed['title']), '%error' => xml_error_string(xml_get_error_code($xml_parser)), '%line' => xml_get_current_line_number($xml_parser))), 'error');
Dries's avatar
   
Dries committed
538
    return 0;
Dries's avatar
   
Dries committed
539
540
  }
  xml_parser_free($xml_parser);
Dries's avatar
   
Dries committed
541

Dries's avatar
   
Dries committed
542
543
544
545
546
  /*
  ** 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
547

Dries's avatar
   
Dries committed
548
  $items = array_reverse($items);
Dries's avatar
   
Dries committed
549

Dries's avatar
   
Dries committed
550
551
  foreach ($items as $item) {
    unset($title, $link, $author, $description);
552

Dries's avatar
   
Dries committed
553
554
    // Prepare the item:
    foreach ($item as $key => $value) {
555
      $value = decode_entities(trim($value));
556
      $value = strip_tags($value, variable_get('aggregator_allowed_html_tags', '<a> <b> <br> <dd> <dl> <dt> <em> <i> <li> <ol> <p> <strong> <u> <ul>'));
557
558
559
      $value = preg_replace('/\Wstyle\s*=[^>]+?>/i', '>', $value);
      $value = preg_replace('/\Won[a-z]+\s*=[^>]+?>/i', '>', $value);
      $item[$key] = $value;
Dries's avatar
   
Dries committed
560
    }
Dries's avatar
   
Dries committed
561
562
563
564
565
566
    /*
    ** 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
567
568
    if ($item['TITLE']) {
      $title = $item['TITLE'];
Dries's avatar
   
Dries committed
569
570
    }
    else {
Dries's avatar
   
Dries committed
571
      $title = preg_replace('/^(.*)[^\w;&].*?$/', "\\1", truncate_utf8($item['DESCRIPTION'], 40));
Dries's avatar
   
Dries committed
572
    }
Dries's avatar
   
Dries committed
573

Dries's avatar
   
Dries committed
574
575
576
577
    /*
    ** Resolve the items link.
    */

Dries's avatar
   
Dries committed
578
579
    if ($item['LINK']) {
      $link = $item['LINK'];
Dries's avatar
   
Dries committed
580
    }
Dries's avatar
   
Dries committed
581
582
    elseif ($item['GUID'] && (strncmp($item['GUID'], 'http://', 7) == 0)) {
      $link = $item['GUID'];
Dries's avatar
   
Dries committed
583
584
    }
    else {
Dries's avatar
   
Dries committed
585
      $link = $feed['link'];
Dries's avatar
   
Dries committed
586
    }
587

588
589
590
591
592
593
594
595
596
597
    /**
     * Atom feeds have a CONTENT and/or SUMMARY tag instead of a DESCRIPTION tag
     */
    if ($item['CONTENT']) {
      $item['DESCRIPTION'] = $item['CONTENT'];
    }
    else if ($item['SUMMARY']) {
      $item['DESCRIPTION'] = $item['SUMMARY'];
    }

Dries's avatar
   
Dries committed
598
599
600
601
602
603
604
605
606
607
    /*
    ** 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
608
    else $date = 'now';
Dries's avatar
   
Dries committed
609

Dries's avatar
   
Dries committed
610
    $timestamp = strtotime($date); // strtotime() returns -1 on failure
Dries's avatar
   
Dries committed
611
    if ($timestamp < 0) {
Dries's avatar
   
Dries committed
612
613
614
615
      $timestamp = aggregator_parse_w3cdtf($date); // also returns -1 on failure
      if ($timestamp < 0) {
        $timestamp = time(); // better than nothing
      }
616
    }
Dries's avatar
   
Dries committed
617
618

    /*
Dries's avatar
   
Dries committed
619
620
621
    ** 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
622
623
    */

Dries's avatar
   
Dries committed
624
625
    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
626
627
    }
    else {
Dries's avatar
   
Dries committed
628
      $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
629
    }
Dries's avatar
   
Dries committed
630

631
    if (!valid_input_data($item['DESCRIPTION'])) {
632
      drupal_set_message(t('The RSS feed from %site seems to be broken, because of suspicious input data.', array('%site' => theme('placeholder', $feed['title']))), 'error');
633
634
635
636
    }
    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
637
  }
Dries's avatar
   
Dries committed
638

Dries's avatar
   
Dries committed
639
  /*
640
  ** Remove all items that are older than flush item timer:
Dries's avatar
   
Dries committed
641
  */
Dries's avatar
   
Dries committed
642

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

646
647
648
649
650
651
652
  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
653
  }
Dries's avatar
   
Dries committed
654
655

  return 1;
656
657
}

Kjartan's avatar
Kjartan committed
658
function aggregator_save_item($edit) {
Dries's avatar
   
Dries committed
659
  if ($edit['iid'] && $edit['title']) {
Dries's avatar
   
Dries committed
660
    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']);
661
  }
Dries's avatar
   
Dries committed
662
663
664
  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']);
665
  }
Dries's avatar
   
Dries committed
666
  else if ($edit['title'] && $edit['link']) {
Dries's avatar
   
Dries committed
667
668
    $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
669
670
671
    // 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
672
      db_query('INSERT INTO {aggregator_category_item} (cid, iid) VALUES (%d, %d)', $category->cid, $edit['iid']);
Dries's avatar
   
Dries committed
673
    }
674
675
676
  }
}

Dries's avatar
   
Dries committed
677
function aggregator_form_category($edit = array()) {
678
679
680
  $form['title'] = array(type => 'textfield', title => t('Title'), default_value => $edit['title'], size => 60, maxlength =>  64);
  $form['description'] = array(type => 'textarea', title => t('Description'), default_value => $edit['description'], cols => 60, rows =>  5);
  $form['submit'] = array(type => 'submit', value =>t('Submit'));
681

Dries's avatar
   
Dries committed
682
  if ($edit['cid']) {
683
684
    $form['delete'] = array(type => 'submit', value =>t('Delete'));
    $form['cid'] = array(type => 'hidden', value => $edit['cid']);
685
686
  }

687
  return drupal_get_form('aggregator_form_category', $form);
688
689
}

Dries's avatar
   
Dries committed
690
691
function aggregator_save_category($edit) {
  if ($edit['cid'] && $edit['title']) {
Dries's avatar
Dries committed
692
    db_query('UPDATE {aggregator_category} SET title = \'%s\', description = \'%s\' WHERE cid = %d', $edit['title'], $edit['description'], $edit['cid']);
693
  }
Dries's avatar
   
Dries committed
694
695
  else if ($edit['cid']) {
    db_query('DELETE FROM {aggregator_category} WHERE cid = %d', $edit['cid']);
696
  }
Dries's avatar
   
Dries committed
697
  else if ($edit['title']) {
Dries's avatar
   
Dries committed
698
    // a single unique id for bundles and feeds, to use in blocks
Dries's avatar
   
Dries committed
699
    $next_id = db_next_id('{aggregator_category}_cid');
Dries's avatar
Dries committed
700
    db_query('INSERT INTO {aggregator_category} (cid, title, description, block) VALUES (%d, \'%s\', \'%s\', 5)', $next_id, $edit['title'], $edit['description']);
701
702
703
  }
}

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

Dries's avatar
   
Dries committed
707
708
  if ($edit['refresh'] == '') {
    $edit['refresh'] = 3600;
Dries's avatar
   
Dries committed
709
  }
Dries's avatar
   
Dries committed
710

711
712
713
714
  
  $form['title'] = array(type => 'textfield', title => t('Title'), default_value => $edit['title'], size => 60, maxlength =>  64, description => t('The name of the feed; typically the name of the web site you syndicate content from.'));
  $form['url'] = array(type => 'textfield', title => t('URL'), default_value => $edit['url'], size => 60, maxlength => 255, description => t('The fully-qualified URL of the feed.'));
  $form['refresh'] = array(type => 'select', title => t('Update interval'), default_value => $edit['refresh'], options => $period, description => t('The refresh interval indicating how often you want to update this feed.  Requires crontab.'));
Dries's avatar
Dries committed
715
716
717
718

  // Handling of categories:
  $options = array();
  $values = array();
Dries's avatar
   
Dries committed
719
  $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
720
  while ($category = db_fetch_object($categories)) {
Dries's avatar
Dries committed
721
    $options[$category->cid] = $category->title;
722
    if ($category->fid) $values[] = check_plain($category->cid);
Dries's avatar
   
Dries committed
723
  }
Dries's avatar
Dries committed
724
  if ($options) {
725
    $form['category'] = array(type => 'checkboxes', title => t('Categorize news items'), default_value => $values, options => $options, description => t('New items in this feed will be automatically filed in the checked categories as they are received.'));
Dries's avatar
   
Dries committed
726
  }
727
  $form['submit'] = array(type => 'submit', value =>t('Submit'));
Dries's avatar
   
Dries committed
728

Dries's avatar
   
Dries committed
729
  if ($edit['fid']) {
730
731
    $form['delete'] = array(type => 'submit', value =>t('Delete'));
    $form['fid'] = array(type => 'hidden', value => $edit['fid']);
732
733
  }

734
  return drupal_get_form('aggregator_form_feed', $form);
735
736
}

Kjartan's avatar
Kjartan committed
737
function aggregator_save_feed($edit) {
Dries's avatar
   
Dries committed
738
  if ($edit['fid']) {
739
    // an existing feed is being modified, delete the category listings
Dries's avatar
   
Dries committed
740
    db_query('DELETE FROM {aggregator_category_feed} WHERE fid = %d', $edit['fid']);
741
  }
Dries's avatar
   
Dries committed
742
  if ($edit['fid'] && $edit['title']) {
Dries's avatar
Dries committed
743
    db_query('UPDATE {aggregator_feed} SET title = \'%s\', url = \'%s\', refresh = %d WHERE fid = %d', $edit['title'], $edit['url'], $edit['refresh'], $edit['fid']);
744
  }
Dries's avatar
   
Dries committed
745
746
747
748
749
750
751
752
753
754
  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']);
755
  }
Dries's avatar
   
Dries committed
756
757
758
  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
759
    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
760
761
762
  }
  if ($edit['title']) {
    // the feed is being saved, save the categories as well
Dries's avatar
Dries committed
763
    if ($edit['category']) {
Dries's avatar
Dries committed
764
765
      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
766
767
      }
    }
768
769
770
  }
}

Kjartan's avatar
Kjartan committed
771
function aggregator_get_feed($fid) {
Dries's avatar
   
Dries committed
772
  return db_fetch_array(db_query('SELECT * FROM {aggregator_feed} WHERE fid = %d', $fid));
773
774
}

Dries's avatar
   
Dries committed
775
function aggregator_get_category($cid) {
Dries's avatar
   
Dries committed
776
  return db_fetch_array(db_query('SELECT * FROM {aggregator_category} WHERE cid = %d', $cid));
777
778
}

Kjartan's avatar
Kjartan committed
779
function aggregator_view() {
Dries's avatar
   
Dries committed
780
  $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');
781

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

Dries's avatar
   
Dries committed
784
  $header = array(t('Title'), t('Items'), t('Last update'), t('Next update'), array('data' => t('Operations'), 'colspan' => '3'));
Dries's avatar
   
Dries committed
785
  $rows = array();
786
  while ($feed = db_fetch_object($result)) {
Dries's avatar
   
Dries committed
787
    $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"));
788
  }
Dries's avatar
   
Dries committed
789
  $output .= theme('table', $header, $rows);
790

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

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

Dries's avatar
   
Dries committed
795
  $header = array(t('Title'), t('Items'), t('Operations'));
Dries's avatar
   
Dries committed
796
  $rows = array();
Dries's avatar
   
Dries committed
797
  while ($category = db_fetch_object($result)) {
Dries's avatar
   
Dries committed
798
    $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"));
799
  }
Dries's avatar
   
Dries committed
800
  $output .= theme('table', $header, $rows);
801
802
803
804

  return $output;
}

Dries's avatar
   
Dries committed
805
806
807
808
809
810
811
812
813
814
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.'));
    }
815

816
    menu_rebuild();
817
    drupal_goto($_GET['q']);
Dries's avatar
   
Dries committed
818
819
820
821
822
823
824
825
826
827
828
829
830
831
  }
  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.'));
    }

832
    menu_rebuild();
833
    drupal_goto('aggregator/'. arg(1));
Dries's avatar
   
Dries committed
834
835
836
837
838
839
840
841
842
  }

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

Dries's avatar
   
Dries committed
843
  return $output;
Dries's avatar
   
Dries committed
844
845
846
}


Dries's avatar
   
Dries committed
847
/**
Dries's avatar
Dries committed
848
 * Menu callback; displays the category edit form, or saves changes and
849
 * redirects to the overview page.
Dries's avatar
   
Dries committed
850
851
852
853
854
855
856
857
858
859
860
 */
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);
861
      drupal_set_message($edit['title'] ? t('The category has been updated.') : t('The category has been removed.'));
862
      menu_rebuild();
863
864
      drupal_goto('admin/aggregator');
      break;
Dries's avatar
   
Dries committed
865
866
867
    default:
      if ($category) {
        $output = aggregator_form_category(aggregator_get_category($category));
Dries's avatar
   
Dries committed
868
869
      }
      else {
Dries's avatar
   
Dries committed
870
        $output = aggregator_form_category();
Dries's avatar
   
Dries committed
871
      }
Dries's avatar
   
Dries committed
872
  }
Dries's avatar
   
Dries committed
873
  return $output;
Dries's avatar
   
Dries committed
874
875
876
}

/**
Dries's avatar
Dries committed
877
878
 * Menu callback; displays the feed edit form.
 *
879
 * After editing, saves changes and redirects to the overview page.
Dries's avatar
   
Dries committed
880
881
882
883
884
885
886
887
888
889
890
 */
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);
891
      drupal_set_message($edit['title'] ? t('The feed has been updated.') : t('The feed has been removed.'));
892
      menu_rebuild();
893
894
      drupal_goto('admin/aggregator');
      break;
Dries's avatar
   
Dries committed
895
896
897
    default:
      if ($feed) {
        $output = aggregator_form_feed(aggregator_get_feed($feed));
Dries's avatar
   
Dries committed
898
899
      }
      else {
Dries's avatar
   
Dries committed
900
        $output = aggregator_form_feed();
Dries's avatar
   
Dries committed
901
      }
902
  }
Dries's avatar
   
Dries committed
903
  return $output;
Dries's avatar
   
Dries committed
904
905
906
}

/**
907
 * Menu callback; removes all items from a feed, then redirects to the overview page.
Dries's avatar
   
Dries committed
908
909
910
 */
function aggregator_admin_remove_feed($feed) {
  aggregator_remove(aggregator_get_feed($feed));
911
  drupal_goto('admin/aggregator');
Dries's avatar
   
Dries committed
912
913
914
}

/**
915
 * Menu callback; refreshes a feed, then redirects to the overview page.
Dries's avatar
   
Dries committed
916
917
918
 */
function aggregator_admin_refresh_feed($feed) {
  aggregator_refresh(aggregator_get_feed($feed));
919
  drupal_goto('admin/aggregator');
Dries's avatar
   
Dries committed
920
921
922
}

/**
Dries's avatar
Dries committed
923
 * Menu callback; displays the aggregator administration page.
Dries's avatar
   
Dries committed
924
925
 */
function aggregator_admin_overview() {
Dries's avatar
   
Dries committed
926
  return aggregator_view();
927
928
}

Dries's avatar
   
Dries committed
929
/**
Dries's avatar
Dries committed
930
 * Menu callback; displays the most recent items gathered from any feed.
Dries's avatar
   
Dries committed
931
 */
932
function aggregator_page_last() {
933
  return _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
934
935
}

Dries's avatar
   
Dries committed
936
/**
Dries's avatar
Dries committed
937
 * Menu callback; displays all the items captured from a particular feed.
Dries's avatar
   
Dries committed
938
 */