aggregator.module 51 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
  $output = '';
76
  $output .= form_textfield(t('Allowed HTML tags'), 'aggregator_allowed_html_tags', variable_get('aggregator_allowed_html_tags', '<a> <b> <br> <dd> <dl> <dt> <em> <i> <li> <ol> <p> <strong> <u> <ul>'), 80, 255, t('The list of tags which are allowed in feeds, i.e., which will not be removed by Drupal.'));
Dries's avatar
   
Dries committed
77
  $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.'));
78
   $output .= form_select(t('Discard news items older than'), 'aggregator_clear', variable_get('aggregator_clear', 9676800), $period, t('Older news items will be automatically discarded.  Requires crontab.'));
Dries's avatar
   
Dries committed
79
  $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.'));
80
  return $output;
Dries's avatar
   
Dries committed
81
82
}

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

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

Dries's avatar
   
Dries committed
97
98
99
/**
 * Implementation of hook_menu().
 */
Dries's avatar
   
Dries committed
100
function aggregator_menu($may_cache) {
Dries's avatar
   
Dries committed
101
  $items = array();
102
103
  $edit = user_access('administer news feeds');
  $view = user_access('access news feeds');
Dries's avatar
   
Dries committed
104

Dries's avatar
   
Dries committed
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
  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);

    $items[] = array('path' => 'aggregator/opml', 'title' => t('opml'),
      'callback' => 'aggregator_page_opml', 'access' => $view,
      'type' => MENU_CALLBACK);
  }
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
  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
179
180

  return $items;
181
182
}

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

Dries's avatar
   
Dries committed
195
196
197
198
199
/**
 * Implementation of hook_block().
 *
 * Generates blocks for the latest news items in each category and feed.
 */
Dries's avatar
Dries committed
200
function aggregator_block($op, $delta = 0, $edit = array()) {
Dries's avatar
   
Dries committed
201
  if (user_access('access news feeds')) {
Dries's avatar
   
Dries committed
202
    if ($op == 'list') {
Dries's avatar
Dries committed
203
      $result = db_query('SELECT cid, title FROM {aggregator_category} ORDER BY title');
Dries's avatar
   
Dries committed
204
      while ($category = db_fetch_object($result)) {
205
        $block['category-'. $category->cid]['info'] = t('%title category latest items', array('%title' => theme('placeholder', $category->title)));
Kjartan's avatar
Kjartan committed
206
      }
Dries's avatar
Dries committed
207
      $result = db_query('SELECT fid, title FROM {aggregator_feed} ORDER BY fid');
Kjartan's avatar
Kjartan committed
208
      while ($feed = db_fetch_object($result)) {
209
        $block['feed-'. $feed->fid]['info'] = t('%title feed latest items', array('%title' => theme('placeholder', $feed->title)));
Kjartan's avatar
Kjartan committed
210
      }
Dries's avatar
   
Dries committed
211
    }
Dries's avatar
Dries committed
212
    else if ($op == 'configure') {
213
      list($type, $id) = explode('-', $delta);
Dries's avatar
Dries committed
214
215
216
217
218
219
220
221
222
223
224
      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') {
225
      list($type, $id) = explode('-', $delta);
Dries's avatar
Dries committed
226
227
228
229
230
231
232
      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);
      }
    }
233
    else if ($op == 'view') {
234
      list($type, $id) = explode('-', $delta);
Kjartan's avatar
Kjartan committed
235
      switch ($type) {
Dries's avatar
   
Dries committed
236
        case 'feed':
237
          if ($feed = db_fetch_object(db_query('SELECT fid, title, block FROM {aggregator_feed} WHERE fid = %d', $id))) {
238
            $block['subject'] = check_plain($feed->title);
239
240
241
            $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
242
          break;
243

Dries's avatar
   
Dries committed
244
        case 'category':
245
          if ($category = db_fetch_object(db_query('SELECT cid, title, block FROM {aggregator_category} WHERE cid = %d', $id))) {
246
            $block['subject'] = check_plain($category->title);
247
248
249
            $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
250
251
          break;
      }
Dries's avatar
   
Dries committed
252
253
      $items = array();
      while ($item = db_fetch_object($result)) {
Dries's avatar
   
Dries committed
254
        $items[] = theme('aggregator_block_item', $item);
Dries's avatar
   
Dries committed
255
      }
Dries's avatar
   
Dries committed
256
      $block['content'] = theme('item_list', $items) . $block['content'];
Dries's avatar
   
Dries committed
257
    }
Dries's avatar
   
Dries committed
258
    return $block;
Dries's avatar
   
Dries committed
259
  }
Dries's avatar
   
Dries committed
260
261
}

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

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

  switch ($name) {
Dries's avatar
   
Dries committed
282
283
    case 'IMAGE':
    case 'TEXTINPUT':
284
285
286
287
288
289
290
    case 'CONTENT':
    case 'SUMMARY':
    case 'TAGLINE':
    case 'SUBTITLE':
    case 'LOGO':
    case 'INFO':
    case 'ID':
Dries's avatar
   
Dries committed
291
292
      $element = $name;
      break;
293
294
295
296
297
298
299
300
301
302
    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
303
    case 'ITEM':
Dries's avatar
   
Dries committed
304
305
      $element = $name;
      $item += 1;
306
307
308
309
310
      break;
    case 'ENTRY':
      $element = 'ITEM';
      $item += 1;
      break;
311
312
313
314
315
  }

  $tag = $name;
}

Dries's avatar
   
Dries committed
316
317
318
/**
 * Call-back function used by the XML parser.
 */
Kjartan's avatar
Kjartan committed
319
function aggregator_element_end($parser, $name) {
Dries's avatar
   
Dries committed
320
321
  global $element;

Dries's avatar
   
Dries committed
322
  switch ($name) {
Dries's avatar
   
Dries committed
323
324
325
    case 'IMAGE':
    case 'TEXTINPUT':
    case 'ITEM':
326
327
328
329
    case 'ENTRY':
    case 'CONTENT':
    case 'INFO':
    case 'ID':
Dries's avatar
   
Dries committed
330
      $element = '';
Dries's avatar
   
Dries committed
331
  }
332
333
}

Dries's avatar
   
Dries committed
334
335
336
/**
 * Call-back function used by the XML parser.
 */
Kjartan's avatar
Kjartan committed
337
function aggregator_element_data($parser, $data) {
Dries's avatar
   
Dries committed
338
  global $channel, $element, $items, $item, $image, $tag;
Dries's avatar
   
Dries committed
339
340

  switch ($element) {
Dries's avatar
   
Dries committed
341
    case 'ITEM':
Dries's avatar
   
Dries committed
342
343
      $items[$item][$tag] .= $data;
      break;
Dries's avatar
   
Dries committed
344
    case 'IMAGE':
345
    case 'LOGO':
Dries's avatar
   
Dries committed
346
347
      $image[$tag] .= $data;
      break;
348
349
350
351
352
353
    case 'LINK':
      if ($data) {
        $items[$item][$tag] .= $data;
      }
      break;
    case 'CONTENT':
354
      $items[$item]['CONTENT'] .= $data;
355
356
      break;
    case 'SUMMARY':
357
      $items[$item]['SUMMARY'] .= $data;
358
359
360
361
362
363
364
      break;
    case 'TAGLINE':
    case 'SUBTITLE':
      $channel['DESCRIPTION'] .= $data;
      break;
    case 'INFO':
    case 'ID':
Dries's avatar
   
Dries committed
365
366
367
    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
368
369
370
      break;
    default:
      $channel[$tag] .= $data;
371
372
373
  }
}

Dries's avatar
   
Dries committed
374
375
376
/**
 * Checks a news feed for new items.
 */
Kjartan's avatar
Kjartan committed
377
function aggregator_refresh($feed) {
Dries's avatar
   
Dries committed
378
379
  global $channel, $image;

Dries's avatar
   
Dries committed
380
381
382
383
384
385
  // Generate conditional GET headers.
  $headers = array();
  if ($feed['etag']) {
    $headers['If-None-Match'] = $feed['etag'];
  }
  if ($feed['modified']) {
Dries's avatar
   
Dries committed
386
    $headers['If-Modified-Since'] = gmdate('D, d M Y H:i:s', $feed['modified']) .' GMT';
Dries's avatar
   
Dries committed
387
388
389
390
391
  }

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

392
  // Process HTTP response code.
Dries's avatar
   
Dries committed
393
394
  switch ($result->code) {
    case 304:
Dries's avatar
   
Dries committed
395
      db_query('UPDATE {aggregator_feed} SET checked = %d WHERE fid = %d', time(), $feed['fid']);
396
      drupal_set_message(t('There is no new syndicated content from %site.', array('%site' => theme('placeholder', $feed['title']))));
Dries's avatar
   
Dries committed
397
      break;
Dries's avatar
   
Dries committed
398
399
    case 301:
      $feed['url'] = $result->redirect_url;
400
      watchdog('aggregator', t('Updated URL for feed %title to %url.', array('%title' => theme('placeholder', $feed['title']), '%url' => theme('placeholder', $feed['url']))));
401
402
      break;

Dries's avatar
   
Dries committed
403
404
405
406
    case 200:
    case 302:
    case 307:
      // Filter the input data:
407
     if (aggregator_parse_feed($result->data, $feed)) {
408

Dries's avatar
   
Dries committed
409
410
411
        if ($result->headers['Last-Modified']) {
          $modified = strtotime($result->headers['Last-Modified']);
        }
Dries's avatar
Dries committed
412

413
414
415
416
417
418
419
420
        /*
        ** Prepare the channel data:
        */

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

Dries's avatar
   
Dries committed
421
422
423
        /*
        ** Prepare the image data (if any):
        */
Dries's avatar
   
Dries committed
424

Dries's avatar
   
Dries committed
425
426
427
        foreach ($image as $key => $value) {
          $image[$key] = trim($value);
        }
Dries's avatar
   
Dries committed
428

Dries's avatar
   
Dries committed
429
        if ($image['LINK'] && $image['URL'] && $image['TITLE']) {
Dries's avatar
   
Dries committed
430
          $image = '<a href="'. $image['LINK'] .'"><img src="'. $image['URL'] .'" alt="'. $image['TITLE'] .'" /></a>';
Dries's avatar
   
Dries committed
431
        }
Dries's avatar
   
Dries committed
432
433
434
        else {
          $image = NULL;
        }
Dries's avatar
   
Dries committed
435

Dries's avatar
   
Dries committed
436
437
438
        /*
        ** Update the feed data:
        */
Dries's avatar
   
Dries committed
439

440
        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
441

Dries's avatar
   
Dries committed
442
443
444
        /*
        ** Clear the cache:
        */
Dries's avatar
   
Dries committed
445

Dries's avatar
   
Dries committed
446
        cache_clear_all();
Dries's avatar
   
Dries committed
447

448
449
        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
450
451
      }
      break;
Dries's avatar
   
Dries committed
452
    default:
453
454
      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
455
  }
Dries's avatar
   
Dries committed
456
}
Dries's avatar
   
Dries committed
457

Dries's avatar
   
Dries committed
458
459
460
461
/**
 * 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.
462
 * Originally from MagpieRSS (http://magpierss.sourceforge.net/).
Dries's avatar
   
Dries committed
463
464
 *
 * @param $date_str A string with a potentially W3C DTF date.
465
 * @return A timestamp if parsed successfully or -1 if not.
Dries's avatar
   
Dries committed
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
 */
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
495
function aggregator_parse_feed(&$data, $feed) {
Dries's avatar
   
Dries committed
496
  global $items, $image, $channel;
Dries's avatar
   
Dries committed
497

Dries's avatar
   
Dries committed
498
  // Unset the global variables before we use them:
Dries's avatar
   
Dries committed
499
  unset($GLOBALS['element'], $GLOBALS['item'], $GLOBALS['tag']);
Dries's avatar
   
Dries committed
500
  $items = array();
Dries's avatar
   
Dries committed
501
  $image = array();
Dries's avatar
   
Dries committed
502
  $channel = array();
503

Dries's avatar
   
Dries committed
504
505
  // parse the data:
  $xml_parser = drupal_xml_parser_create($data);
Dries's avatar
   
Dries committed
506
507
  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
508

Dries's avatar
   
Dries committed
509
  if (!xml_parse($xml_parser, $data, 1)) {
510
511
    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
512
    return 0;
Dries's avatar
   
Dries committed
513
514
  }
  xml_parser_free($xml_parser);
Dries's avatar
   
Dries committed
515

Dries's avatar
   
Dries committed
516
517
518
519
520
  /*
  ** 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
521

Dries's avatar
   
Dries committed
522
  $items = array_reverse($items);
Dries's avatar
   
Dries committed
523

Dries's avatar
   
Dries committed
524
525
  foreach ($items as $item) {
    unset($title, $link, $author, $description);
526

Dries's avatar
   
Dries committed
527
528
    // Prepare the item:
    foreach ($item as $key => $value) {
529
      $value = decode_entities(trim($value));
530
      $value = strip_tags($value, variable_get('aggregator_allowed_html_tags', '<a> <b> <br> <dd> <dl> <dt> <em> <i> <li> <ol> <p> <strong> <u> <ul>'));
531
532
533
      $value = preg_replace('/\Wstyle\s*=[^>]+?>/i', '>', $value);
      $value = preg_replace('/\Won[a-z]+\s*=[^>]+?>/i', '>', $value);
      $item[$key] = $value;
Dries's avatar
   
Dries committed
534
    }
Dries's avatar
   
Dries committed
535
536
537
538
539
540
    /*
    ** 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
541
542
    if ($item['TITLE']) {
      $title = $item['TITLE'];
Dries's avatar
   
Dries committed
543
544
    }
    else {
Dries's avatar
   
Dries committed
545
      $title = preg_replace('/^(.*)[^\w;&].*?$/', "\\1", truncate_utf8($item['DESCRIPTION'], 40));
Dries's avatar
   
Dries committed
546
    }
Dries's avatar
   
Dries committed
547

Dries's avatar
   
Dries committed
548
549
550
551
    /*
    ** Resolve the items link.
    */

Dries's avatar
   
Dries committed
552
553
    if ($item['LINK']) {
      $link = $item['LINK'];
Dries's avatar
   
Dries committed
554
    }
Dries's avatar
   
Dries committed
555
556
    elseif ($item['GUID'] && (strncmp($item['GUID'], 'http://', 7) == 0)) {
      $link = $item['GUID'];
Dries's avatar
   
Dries committed
557
558
    }
    else {
Dries's avatar
   
Dries committed
559
      $link = $feed['link'];
Dries's avatar
   
Dries committed
560
    }
561

562
563
564
565
566
567
568
569
570
571
    /**
     * 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
572
573
574
575
576
577
578
579
580
581
    /*
    ** 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
582
    else $date = 'now';
Dries's avatar
   
Dries committed
583

Dries's avatar
   
Dries committed
584
    $timestamp = strtotime($date); // strtotime() returns -1 on failure
Dries's avatar
   
Dries committed
585
    if ($timestamp < 0) {
Dries's avatar
   
Dries committed
586
587
588
589
      $timestamp = aggregator_parse_w3cdtf($date); // also returns -1 on failure
      if ($timestamp < 0) {
        $timestamp = time(); // better than nothing
      }
590
    }
Dries's avatar
   
Dries committed
591
592

    /*
Dries's avatar
   
Dries committed
593
594
595
    ** 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
596
597
    */

Dries's avatar
   
Dries committed
598
599
    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
600
601
    }
    else {
Dries's avatar
   
Dries committed
602
      $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
603
    }
Dries's avatar
   
Dries committed
604

605
    if (!valid_input_data($item['DESCRIPTION'])) {
606
      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');
607
608
609
610
    }
    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
611
  }
Dries's avatar
   
Dries committed
612

Dries's avatar
   
Dries committed
613
  /*
614
  ** Remove all items that are older than flush item timer:
Dries's avatar
   
Dries committed
615
  */
Dries's avatar
   
Dries committed
616

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

620
621
622
623
624
625
626
  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
627
  }
Dries's avatar
   
Dries committed
628
629

  return 1;
630
631
}

Kjartan's avatar
Kjartan committed
632
function aggregator_save_item($edit) {
Dries's avatar
   
Dries committed
633
  if ($edit['iid'] && $edit['title']) {
Dries's avatar
   
Dries committed
634
    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']);
635
  }
Dries's avatar
   
Dries committed
636
637
638
  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']);
639
  }
Dries's avatar
   
Dries committed
640
  else if ($edit['title'] && $edit['link']) {
Dries's avatar
   
Dries committed
641
642
    $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
643
644
645
    // 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
646
      db_query('INSERT INTO {aggregator_category_item} (cid, iid) VALUES (%d, %d)', $category->cid, $edit['iid']);
Dries's avatar
   
Dries committed
647
    }
648
649
650
  }
}

Dries's avatar
   
Dries committed
651
function aggregator_form_category($edit = array()) {
652
  $form  = form_textfield(t('Title'), 'title', $edit['title'], 60, 64);
Dries's avatar
   
Dries committed
653
654
  $form .= form_textarea(t('Description'), 'description', $edit['description'], 60, 5);
  $form .= form_submit(t('Submit'));
655

Dries's avatar
   
Dries committed
656
657
658
  if ($edit['cid']) {
    $form .= form_submit(t('Delete'));
    $form .= form_hidden('cid', $edit['cid']);
659
660
  }

Dries's avatar
   
Dries committed
661
  return form($form);
662
663
}

Dries's avatar
   
Dries committed
664
665
function aggregator_save_category($edit) {
  if ($edit['cid'] && $edit['title']) {
Dries's avatar
Dries committed
666
    db_query('UPDATE {aggregator_category} SET title = \'%s\', description = \'%s\' WHERE cid = %d', $edit['title'], $edit['description'], $edit['cid']);
667
  }
Dries's avatar
   
Dries committed
668
669
  else if ($edit['cid']) {
    db_query('DELETE FROM {aggregator_category} WHERE cid = %d', $edit['cid']);
670
  }
Dries's avatar
   
Dries committed
671
  else if ($edit['title']) {
Dries's avatar
   
Dries committed
672
    // a single unique id for bundles and feeds, to use in blocks
Dries's avatar
   
Dries committed
673
    $next_id = db_next_id('{aggregator_category}_cid');
Dries's avatar
Dries committed
674
    db_query('INSERT INTO {aggregator_category} (cid, title, description, block) VALUES (%d, \'%s\', \'%s\', 5)', $next_id, $edit['title'], $edit['description']);
675
676
677
  }
}

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

Dries's avatar
   
Dries committed
681
682
  if ($edit['refresh'] == '') {
    $edit['refresh'] = 3600;
Dries's avatar
   
Dries committed
683
  }
Dries's avatar
   
Dries committed
684

685
686
  $form .= form_textfield(t('Title'), 'title', $edit['title'], 60, 64, t('The name of the feed; typically the name of the web site you syndicate content from.'));
  $form .= form_textfield(t('URL'), 'url', $edit['url'], 60, 255, t('The fully-qualified URL of the feed.'));
Dries's avatar
   
Dries committed
687
  $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
688
689
690
691

  // Handling of categories:
  $options = array();
  $values = array();
Dries's avatar
   
Dries committed
692
  $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
693
  while ($category = db_fetch_object($categories)) {
Dries's avatar
Dries committed
694
    $options[$category->cid] = $category->title;
695
    if ($category->fid) $values[] = check_plain($category->cid);
Dries's avatar
   
Dries committed
696
  }
Dries's avatar
Dries committed
697
  if ($options) {
698
    $form .= form_checkboxes(t('Categorize news items'), 'category', $values, $options, t('New items in this feed will be automatically filed in the checked categories as they are received.'));
Dries's avatar
   
Dries committed
699
  }
Dries's avatar
   
Dries committed
700

Dries's avatar
Dries committed
701
  // Form buttons:
Dries's avatar
   
Dries committed
702
703
704
705
  $form .= form_submit(t('Submit'));
  if ($edit['fid']) {
    $form .= form_submit(t('Delete'));
    $form .= form_hidden('fid', $edit['fid']);
706
707
  }

Dries's avatar
   
Dries committed
708
  return form($form);
709
710
}

Kjartan's avatar
Kjartan committed
711
function aggregator_save_feed($edit) {
Dries's avatar
   
Dries committed
712
  if ($edit['fid']) {
713
    // an existing feed is being modified, delete the category listings
Dries's avatar
   
Dries committed
714
    db_query('DELETE FROM {aggregator_category_feed} WHERE fid = %d', $edit['fid']);
715
  }
Dries's avatar
   
Dries committed
716
  if ($edit['fid'] && $edit['title']) {
Dries's avatar
Dries committed
717
    db_query('UPDATE {aggregator_feed} SET title = \'%s\', url = \'%s\', refresh = %d WHERE fid = %d', $edit['title'], $edit['url'], $edit['refresh'], $edit['fid']);
718
  }
Dries's avatar
   
Dries committed
719
720
721
722
723
724
725
726
727
728
  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']);
729
  }
Dries's avatar
   
Dries committed
730
731
732
  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
733
    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
734
735
736
  }
  if ($edit['title']) {
    // the feed is being saved, save the categories as well
Dries's avatar
Dries committed
737
    if ($edit['category']) {
Dries's avatar
Dries committed
738
739
      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
740
741
      }
    }
742
743
744
  }
}

Kjartan's avatar
Kjartan committed
745
function aggregator_get_feed($fid) {
Dries's avatar
   
Dries committed
746
  return db_fetch_array(db_query('SELECT * FROM {aggregator_feed} WHERE fid = %d', $fid));
747
748
}

Dries's avatar
   
Dries committed
749
function aggregator_get_category($cid) {
Dries's avatar
   
Dries committed
750
  return db_fetch_array(db_query('SELECT * FROM {aggregator_category} WHERE cid = %d', $cid));
751
752
}

Kjartan's avatar
Kjartan committed
753
function aggregator_view() {
Dries's avatar
   
Dries committed
754
  $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');
755

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

Dries's avatar
   
Dries committed
758
  $header = array(t('Title'), t('Items'), t('Last update'), t('Next update'), array('data' => t('Operations'), 'colspan' => '3'));
Dries's avatar
   
Dries committed
759
  $rows = array();
760
  while ($feed = db_fetch_object($result)) {
Dries's avatar
   
Dries committed
761
    $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"));
762
  }
Dries's avatar
   
Dries committed
763
  $output .= theme('table', $header, $rows);
764

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

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

Dries's avatar
   
Dries committed
769
  $header = array(t('Title'), t('Items'), t('Operations'));
Dries's avatar
   
Dries committed
770
  $rows = array();
Dries's avatar
   
Dries committed
771
  while ($category = db_fetch_object($result)) {
Dries's avatar
   
Dries committed
772
    $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"));
773
  }
Dries's avatar
   
Dries committed
774
  $output .= theme('table', $header, $rows);
775
776
777
778

  return $output;
}

Dries's avatar
   
Dries committed
779
780
781
782
783
784
785
786
787
788
789
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.'));
    }
790

791
    menu_rebuild();
792
    drupal_goto($_GET['q']);
Dries's avatar
   
Dries committed
793
794
795
796
797
798
799
800
801
802
803
804
805
806
  }
  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.'));
    }

807
    menu_rebuild();
808
    drupal_goto('aggregator/'. arg(1));
Dries's avatar
   
Dries committed
809
810
811
812
813
814
815
816
817
  }

  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
818
  return $output;
Dries's avatar
   
Dries committed
819
820
821
}


Dries's avatar
   
Dries committed
822
/**
Dries's avatar
Dries committed
823
 * Menu callback; displays the category edit form, or saves changes and
824
 * redirects to the overview page.
Dries's avatar
   
Dries committed
825
826
827
828
829
830
831
832
833
834
835
 */
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);
836
      drupal_set_message($edit['title'] ? t('The category has been updated.') : t('The category has been removed.'));
837
      menu_rebuild();
838
839
      drupal_goto('admin/aggregator');
      break;
Dries's avatar
   
Dries committed
840
841
842
    default:
      if ($category) {
        $output = aggregator_form_category(aggregator_get_category($category));
Dries's avatar
   
Dries committed
843
844
      }
      else {
Dries's avatar
   
Dries committed
845
        $output = aggregator_form_category();
Dries's avatar
   
Dries committed
846
      }
Dries's avatar
   
Dries committed
847
  }
Dries's avatar
   
Dries committed
848
  return $output;
Dries's avatar
   
Dries committed
849
850
851
}

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

/**
882
 * Menu callback; removes all items from a feed, then redirects to the overview page.
Dries's avatar
   
Dries committed
883
884
885
 */
function aggregator_admin_remove_feed($feed) {
  aggregator_remove(aggregator_get_feed($feed));
886
  drupal_goto('admin/aggregator');
Dries's avatar
   
Dries committed
887
888
889
}

/**
890
 * Menu callback; refreshes a feed, then redirects to the overview page.
Dries's avatar
   
Dries committed
891
892
893
 */
function aggregator_admin_refresh_feed($feed) {
  aggregator_refresh(aggregator_get_feed($feed));
894
  drupal_goto('admin/aggregator');
Dries's avatar
   
Dries committed
895
896
897
}

/**
Dries's avatar
Dries committed
898
 * Menu callback; displays the aggregator administration page.
Dries's avatar
   
Dries committed
899
900
 */
function aggregator_admin_overview() {
Dries's avatar
   
Dries committed
901
  return aggregator_view();
902
903
}

Dries's avatar
   
Dries committed
904
/**
Dries's avatar
Dries committed
905
 * Menu callback; displays the most recent items gathered from any feed.
Dries's avatar
   
Dries committed
906
 */
907
function aggregator_page_last() {
908
  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
909
910
}

Dries's avatar
   
Dries committed
911
/**
Dries's avatar
Dries committed
912
 * Menu callback; displays all the items captured from a particular feed.
Dries's avatar
   
Dries committed
913
 */
914
function aggregator_page_source() {
Dries's avatar
   
Dries committed
915
  $feed = db_fetch_object(db_query('SELECT * FROM {aggregator_feed} WHERE fid = %d', arg(2)));
Dries's avatar
   
Dries committed
916
  $info = theme('aggregator_feed', $feed);
Dries's avatar
   
Dries committed
917

918
  return _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
919
920
}

Dries's avatar
   
Dries committed
921
/**
Dries's avatar
Dries committed
922
 * Menu callback; displays all the items aggregated in a particular category.
Dries's avatar
   
Dries committed
923
 */
924
function aggregator_page_category() {
Dries's avatar
   
Dries committed
925
  $category = db_fetch_object(db_query('SELECT cid, title FROM {aggrega