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

Dries's avatar
   
Dries committed
4
5
6
/**
 * Implementation of hook_help().
 */
Dries's avatar
   
Dries committed
7
function aggregator_help($section) {
Dries's avatar
   
Dries committed
8
  switch ($section) {
Kjartan's avatar
Kjartan committed
9
    case 'admin/help#aggregator':
Dries's avatar
   
Dries committed
10
      return t('
Dries's avatar
   
Dries committed
11
12
13
14
15
16
17
      <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
18
      <p>NOTE: Enable your site\'s XML syndication button by turning on the Syndicate block in block management.</p>
Dries's avatar
   
Dries committed
19
      <h3>How do I add a news feed?</h3>
Dries's avatar
   
Dries committed
20
21
      <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
22
      <ul>
Dries's avatar
   
Dries committed
23
24
25
       <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
26
       <li><strong>Latest items block</strong> -- The number of items selected here will determine how many of the latest items from the feed will appear in a block which may be enabled and placed in the <a href="%block">blocks</a> administration page.</li>
Dries's avatar
   
Dries committed
27
       <li><strong>Automatically file 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
28
      </ul>
Dries's avatar
   
Dries committed
29
      <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
30
      <h3>Adding categories</h3>
Dries's avatar
   
Dries committed
31
      <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
32
      <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
33
      <ul>
Dries's avatar
   
Dries committed
34
       <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
35
       <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
36
       <li><strong>Latest items block</strong> -- The number of items selected here will determine how many of the latest items from the category will appear in a block which may be enabled and placed in the <a href="%block">blocks</a> administration page.</li>
Dries's avatar
   
Dries committed
37
38
39
40
      </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
41
42
43
       <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
44
      </ul>
Dries's avatar
   
Dries committed
45
      <p>Pages that display items (for sources, categories, etc.) display the following for each item:
Dries's avatar
   
Dries committed
46
      <ul>
Dries's avatar
   
Dries committed
47
48
49
50
       <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
51
      </ul>
Dries's avatar
   
Dries committed
52
      <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
53
      <h3>Technical details</h3>
Dries's avatar
   
Dries committed
54
      <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
55
      <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
56
57
      <p>If a feed is permanently moved to a new location Drupal will automatically update the feed URL to the new address.</p>', array('%block' => url('admin/block'), '%admin-news' => url('admin/aggregator'), '%new-feed' => url('admin/aggregator/add/feed'), '%new-category' => url('admin/aggregator/add/category'), '%update-items' => url('admin/aggregator'), '%news-aggregator' => url('aggregator'), '%sources' => url('aggregator/sources'), '%categories' => url('aggregator/categories')));
    case 'admin/modules#description':
Dries's avatar
   
Dries committed
58
      return t('Used to aggregate syndicated content (RSS and RDF).');
Dries's avatar
   
Dries committed
59
    case 'admin/aggregator':
Dries's avatar
   
Dries committed
60
      return t('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>.<br /><strong>NOTE: This module requires <a href="%cron">cron</a>.</strong>', array('%block' => url('admin/block'), '%cron' => url('admin/help', NULL, 'cron')));
Dries's avatar
   
Dries committed
61
    case 'admin/aggregator/add/feed':
Dries's avatar
   
Dries committed
62
      return t('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.');
Dries's avatar
   
Dries committed
63
    case 'admin/aggregator/add/category':
Dries's avatar
   
Dries committed
64
      return t('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.');
65
66
    case 'admin/aggregator/configure':
      return t('These settings control the display of aggregated content.');
Dries's avatar
   
Dries committed
67
  }
68
69
}

Dries's avatar
   
Dries committed
70
/**
Dries's avatar
Dries committed
71
 * Menu callback; displays the aggregator-specific information from admin/help.
Dries's avatar
   
Dries committed
72
 */
Kjartan's avatar
Kjartan committed
73
function aggregator_help_page() {
Dries's avatar
   
Dries committed
74
  print theme('page', aggregator_help('admin/help#aggregator'));
Dries's avatar
   
Dries committed
75
76
}

Dries's avatar
   
Dries committed
77
78
79
80
81
function aggregator_configure() {
  if ($_POST) {
    system_settings_save();
  }

Dries's avatar
   
Dries committed
82
  $output = '';
Dries's avatar
   
Dries committed
83
  $number = drupal_map_assoc(array(5, 10, 15, 20, 25, 30, 35, 40, 45, 50, 55, 60, 65, 70, 75, 80, 85, 90, 95, 100));
Dries's avatar
   
Dries committed
84
  $items = array(0 => t('none'), 3 => t('3 items'), 5 => t('5 items'), 10 => t('10 items'), 15 => t('15 items'), 20 => t('20 items'), 25 => t('25 items'));
Dries's avatar
   
Dries committed
85

Dries's avatar
   
Dries committed
86
87
  $output .= form_select(t('Items shown in sources and categories pages'), 'aggregator_summary_items', variable_get('aggregator_summary_items', 3), $items, t('The number of items which will be shown with each feed or category in the feed and category summary pages.'));
  $output .= form_radios(t('Category selection type'), 'aggregator_category_selector', variable_get('aggregator_category_selector', 'check'), array('check' => t('checkboxes'), 'select' => t('multiple selector')), t('The type of category selection widget which is shown on categorization pages. Checkboxes are easier to use; a multiple selector is good for working with large numbers of categories.'));
Dries's avatar
   
Dries committed
88

Dries's avatar
   
Dries committed
89
  print theme('page', system_settings_form($output));
Dries's avatar
   
Dries committed
90
91
}

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

Dries's avatar
   
Dries committed
99
100
101
/**
 * Implementation of hook_link().
 */
Kjartan's avatar
Kjartan committed
102
function aggregator_link($type) {
Dries's avatar
   
Dries committed
103
104
105
  if ($type == 'page' && user_access('access news feeds')) {
    return array(l(t('news feeds'), 'aggregator', array('title' => t('Read the latest news from syndicated web sites.'))));
  }
Dries's avatar
   
Dries committed
106
}
Dries's avatar
   
Dries committed
107

Dries's avatar
   
Dries committed
108
109
110
111
112
/**
 * Implementation of hook_menu().
 */
function aggregator_menu() {
  $items = array();
Dries's avatar
   
Dries committed
113

Dries's avatar
   
Dries committed
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
  $edit = user_access('administer news feeds');
  $view = user_access('access news feeds');

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

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

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

  // To reduce the number of SQL queries, we don't query the database when
  // not on an aggregator page.
  // If caching of the menu is implemented, this check should be removed
  // so that DHTML menu presentation can be used correctly.
  if (arg(0) == 'aggregator') {
    // Sources:
    $result = db_query('SELECT title, fid FROM {aggregator_feed} ORDER BY title');
    while ($feed = db_fetch_object($result)) {
      $items[] = array('path' => 'aggregator/sources/'. $feed->fid, 'title' => $feed->title,
        'callback' => 'aggregator_page_source', 'access' => $view);
Dries's avatar
   
Dries committed
163
164
      $items[] = array('path' => 'aggregator/sources/'. $feed->fid .'/view', 'title' => t('view'),
        'type' => MENU_DEFAULT_LOCAL_TASK, 'weight' => -10);
Dries's avatar
   
Dries committed
165
166
167
168
169
170
171
      $items[] = array('path' => 'aggregator/sources/'. $feed->fid .'/categorize', 'title' => t('categorize'),
        'callback' => 'aggregator_page_source', 'access' => $edit,
        'type' => MENU_LOCAL_TASK);
      $items[] = array('path' => 'aggregator/sources/'. $feed->fid .'/configure', 'title' => t('configure'),
        'callback' => 'aggregator_edit', 'access' => $edit,
        'type' => MENU_LOCAL_TASK,
        'weight' => 1);
Dries's avatar
   
Dries committed
172
    }
173

Dries's avatar
   
Dries committed
174
175
176
177
178
    // Categories:
    $result = db_query('SELECT title, cid FROM {aggregator_category} ORDER BY title');
    while ($category = db_fetch_object($result)) {
      $items[] = array('path' => 'aggregator/categories/'. $category->cid, 'title' => $category->title,
        'callback' => 'aggregator_page_category', 'access' => $view);
Dries's avatar
   
Dries committed
179
180
      $items[] = array('path' => 'aggregator/categories/'. $category->cid .'/view', 'title' => t('view'),
        'type' => MENU_DEFAULT_LOCAL_TASK, 'weight' => -10);
Dries's avatar
   
Dries committed
181
182
183
184
185
186
187
188
      $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);
    }
189
  }
Dries's avatar
   
Dries committed
190
191
192
193
194
195

  $items[] = array('path' => 'aggregator/opml', 'title' => t('opml'),
    'callback' => 'aggregator_page_opml', 'access' => $view,
    'type' => MENU_CALLBACK);

  return $items;
196
197
}

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

Dries's avatar
   
Dries committed
210
211
212
213
214
/**
 * Implementation of hook_block().
 *
 * Generates blocks for the latest news items in each category and feed.
 */
Kjartan's avatar
Kjartan committed
215
function aggregator_block($op, $delta) {
Dries's avatar
   
Dries committed
216
  if (user_access('access news feeds')) {
Dries's avatar
   
Dries committed
217
218
219
220
    if ($op == 'list') {
      $result = db_query('SELECT cid, title FROM {aggregator_category} WHERE block != 0 ORDER BY title');
      while ($category = db_fetch_object($result)) {
        $block['category:'. $category->cid]['info'] = t('%title category latest items', array('%title' => $category->title));
Kjartan's avatar
Kjartan committed
221
      }
Dries's avatar
   
Dries committed
222
      $result = db_query('SELECT fid, title FROM {aggregator_feed} WHERE block != 0 ORDER BY fid');
Kjartan's avatar
Kjartan committed
223
      while ($feed = db_fetch_object($result)) {
Dries's avatar
   
Dries committed
224
        $block['feed:'. $feed->fid]['info'] = t('%title feed latest items', array('%title' => $feed->title));
Kjartan's avatar
Kjartan committed
225
      }
Dries's avatar
   
Dries committed
226
    }
Kjartan's avatar
Kjartan committed
227
    else {
Dries's avatar
   
Dries committed
228
      list($type, $id) = split(':', $delta);
Kjartan's avatar
Kjartan committed
229
      switch ($type) {
Dries's avatar
   
Dries committed
230
231
232
233
234
        case 'feed':
          $feed = db_fetch_object(db_query('SELECT fid, title, block FROM {aggregator_feed} WHERE fid = %d', $id));
          $block['subject'] = $feed->title;
          $result = db_query_range('SELECT * FROM {aggregator_item} WHERE fid = %d ORDER BY timestamp DESC, iid DESC', $feed->fid, 0, $feed->block);
          $block['content'] = '<div class="more-link">'. l(t('more'), 'aggregator/sources/'. $feed->fid, array('title' => t('View this feed\'s recent news.'))) .'</div>';
Kjartan's avatar
Kjartan committed
235
          break;
Dries's avatar
   
Dries committed
236
237
238
239
240
        case 'category':
          $category = db_fetch_object(db_query('SELECT cid, title, block FROM {aggregator_category} WHERE cid = %d', $id));
          $block['subject'] = $category->title;
          $result = db_query_range('SELECT i.* FROM {aggregator_category_item} ci LEFT JOIN {aggregator_item} i ON ci.iid = i.iid WHERE ci.cid = %d ORDER BY i.timestamp DESC, i.iid DESC', $category->cid, 0, $category->block);
          $block['content'] = '<div class="more-link">'. l(t('more'), 'aggregator/categories/'. $category->cid, array('title' => t('View this category\'s recent news.'))) .'</div>';
Kjartan's avatar
Kjartan committed
241
242
          break;
      }
Dries's avatar
   
Dries committed
243
244
      $items = array();
      while ($item = db_fetch_object($result)) {
Dries's avatar
   
Dries committed
245
        $items[] = theme('aggregator_block_item', $item);
Dries's avatar
   
Dries committed
246
      }
Dries's avatar
   
Dries committed
247
      $block['content'] = theme('item_list', $items) . $block['content'];
Dries's avatar
   
Dries committed
248
    }
Dries's avatar
   
Dries committed
249
    return $block;
Dries's avatar
   
Dries committed
250
  }
Dries's avatar
   
Dries committed
251
252
}

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

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

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

  $tag = $name;
}

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

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

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

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

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

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

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

339
  // Process HTTP response code.
Dries's avatar
   
Dries committed
340
341
  switch ($result->code) {
    case 304:
Dries's avatar
   
Dries committed
342
      db_query('UPDATE {aggregator_feed} SET checked = %d WHERE fid = %d', time(), $feed['fid']);
Dries's avatar
   
Dries committed
343
      drupal_set_message(t('No new syndicated content from "%site".', array('%site' => $feed['title'])));
Dries's avatar
   
Dries committed
344
      break;
Dries's avatar
   
Dries committed
345
346
    case 301:
      $feed['url'] = $result->redirect_url;
347
      watchdog('special', t('aggregator: updated URL for feed "%title" to %url', array('%title' => $feed[title], '%url' => $feed[url])));
Dries's avatar
   
Dries committed
348
349
350
351
    case 200:
    case 302:
    case 307:
      // Filter the input data:
352
     if (aggregator_parse_feed($result->data, $feed)) {
353

Dries's avatar
   
Dries committed
354
355
356
        if ($result->headers['Last-Modified']) {
          $modified = strtotime($result->headers['Last-Modified']);
        }
Dries's avatar
Dries committed
357

Dries's avatar
   
Dries committed
358
359
360
        /*
        ** Prepare the image data (if any):
        */
Dries's avatar
   
Dries committed
361

Dries's avatar
   
Dries committed
362
363
364
        foreach ($image as $key => $value) {
          $image[$key] = trim($value);
        }
Dries's avatar
   
Dries committed
365

Dries's avatar
   
Dries committed
366
        if ($image['LINK'] && $image['URL'] && $image['TITLE']) {
Dries's avatar
   
Dries committed
367
          $image = '<a href="'. $image['LINK'] .'"><img src="'. $image['URL'] .'" alt="'. $image['TITLE'] .'" /></a>';
Dries's avatar
   
Dries committed
368
        }
Dries's avatar
   
Dries committed
369
370
371
        else {
          $image = NULL;
        }
Dries's avatar
   
Dries committed
372

Dries's avatar
   
Dries committed
373
374
375
        /*
        ** Update the feed data:
        */
Dries's avatar
   
Dries committed
376

Dries's avatar
   
Dries committed
377
        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(), strip_tags($channel['LINK']), strip_tags($channel['DESCRIPTION']), $image, $result->headers['ETag'], $modified, $feed['fid']);
Dries's avatar
   
Dries committed
378

Dries's avatar
   
Dries committed
379
380
381
        /*
        ** Clear the cache:
        */
Dries's avatar
   
Dries committed
382

Dries's avatar
   
Dries committed
383
        cache_clear_all();
Dries's avatar
   
Dries committed
384

385
        watchdog('regular', t('aggregator: syndicated content from "%site"', array('%site' => $feed[title])));
Dries's avatar
   
Dries committed
386
        drupal_set_message(t('Syndicated content from "%site".', array('%site' => $feed['title'])));
Dries's avatar
   
Dries committed
387
388
      }
      break;
Dries's avatar
   
Dries committed
389
    default:
390
      watchdog('error', t('aggregator: failed to parse RSS feed "%site": %error', array('%site' => $feed['title'], '%error' => $result->code .' '. $result->error)));
Dries's avatar
   
Dries committed
391
      drupal_set_message(t('Failed to parse RSS feed "%site": %error.', array('%site' => $feed['title'], '%error' => $result->code .' '. $result->error)));
Dries's avatar
   
Dries committed
392
  }
Dries's avatar
   
Dries committed
393
}
Dries's avatar
   
Dries committed
394

Dries's avatar
   
Dries committed
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
/**
 * Parse the W3C date/time format, a subset of ISO 8601. PHP date parsing
 * functions do not handle this format.
 * See http://www.w3.org/TR/NOTE-datetime for more information.
 * Origionally from MagpieRSS (http://magpierss.sourceforge.net/).
 *
 * @param $date_str A string with a potentially W3C DTF date.
 * @return A timestamp if parsed sucessfully or -1 if not.
 */
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
432
function aggregator_parse_feed(&$data, $feed) {
Dries's avatar
   
Dries committed
433
  global $items, $image, $channel;
Dries's avatar
   
Dries committed
434

Dries's avatar
   
Dries committed
435
  // Unset the global variables before we use them:
Dries's avatar
   
Dries committed
436
  unset($GLOBALS['element'], $GLOBALS['item'], $GLOBALS['tag']);
Dries's avatar
   
Dries committed
437
  $items = array();
Dries's avatar
   
Dries committed
438
  $image = array();
Dries's avatar
   
Dries committed
439
  $channel = array();
440

Dries's avatar
   
Dries committed
441
442
  // parse the data:
  $xml_parser = drupal_xml_parser_create($data);
Dries's avatar
   
Dries committed
443
444
  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
445

Dries's avatar
   
Dries committed
446
  if (!xml_parse($xml_parser, $data, 1)) {
447
    watchdog('error', t('aggregator: failed to parse RSS feed "%site": %error at line %line.', array('%site' => $feed['title'], '%error' => xml_error_string(xml_get_error_code($xml_parser)), '%line' => xml_get_current_line_number($xml_parser))));
Dries's avatar
   
Dries committed
448
    drupal_set_message(t('Failed to parse RSS feed "%site": %error at line %line.', array('%site' => $feed['title'], '%error' => xml_error_string(xml_get_error_code($xml_parser)), '%line' => xml_get_current_line_number($xml_parser))), 'error');
Dries's avatar
   
Dries committed
449
    return 0;
Dries's avatar
   
Dries committed
450
451
  }
  xml_parser_free($xml_parser);
Dries's avatar
   
Dries committed
452

Dries's avatar
   
Dries committed
453
  // initialize the translation table:
454
  $tt = array_flip(get_html_translation_table(HTML_SPECIALCHARS));
Dries's avatar
   
Dries committed
455
  $tt['&apos;'] = "'";
Dries's avatar
   
Dries committed
456

Dries's avatar
   
Dries committed
457
458
459
460
461
  /*
  ** 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
462

Dries's avatar
   
Dries committed
463
  $items = array_reverse($items);
Dries's avatar
   
Dries committed
464

Dries's avatar
   
Dries committed
465
466
  foreach ($items as $item) {
    unset($title, $link, $author, $description);
467

Dries's avatar
   
Dries committed
468
469
    // Prepare the item:
    foreach ($item as $key => $value) {
470
471
472
473
474
475
      // TODO: Make handling of aggregated HTML more flexible/configurable.
      $value = strtr(trim($value), $tt);
      $value = strip_tags($value, '<a> <b> <br> <dd> <dl> <dt> <em> <i> <li> <ol> <p> <strong> <u> <ul>');
      $value = preg_replace('/\Wstyle\s*=[^>]+?>/i', '>', $value);
      $value = preg_replace('/\Won[a-z]+\s*=[^>]+?>/i', '>', $value);
      $item[$key] = $value;
Dries's avatar
   
Dries committed
476
    }
Dries's avatar
Dries committed
477

Dries's avatar
   
Dries committed
478
479
480
481
482
483
    /*
    ** 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
484
485
    if ($item['TITLE']) {
      $title = $item['TITLE'];
Dries's avatar
   
Dries committed
486
487
    }
    else {
Dries's avatar
   
Dries committed
488
      $title = preg_replace('/^(.*)[^\w;&].*?$/', "\\1", truncate_utf8($item['DESCRIPTION'], 40));
Dries's avatar
   
Dries committed
489
    }
Dries's avatar
   
Dries committed
490

Dries's avatar
   
Dries committed
491
492
493
494
    /*
    ** Resolve the items link.
    */

Dries's avatar
   
Dries committed
495
496
    if ($item['LINK']) {
      $link = $item['LINK'];
Dries's avatar
   
Dries committed
497
    }
Dries's avatar
   
Dries committed
498
499
    elseif ($item['GUID'] && (strncmp($item['GUID'], 'http://', 7) == 0)) {
      $link = $item['GUID'];
Dries's avatar
   
Dries committed
500
501
    }
    else {
Dries's avatar
   
Dries committed
502
      $link = $feed['link'];
Dries's avatar
   
Dries committed
503
    }
504

Dries's avatar
   
Dries committed
505
506
507
508
509
510
511
512
513
514
    /*
    ** 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
515
    else $date = 'now';
Dries's avatar
   
Dries committed
516

Dries's avatar
   
Dries committed
517
    $timestamp = strtotime($date); // strtotime() returns -1 on failure
Dries's avatar
   
Dries committed
518
    if ($timestamp < 0) {
Dries's avatar
   
Dries committed
519
520
521
522
      $timestamp = aggregator_parse_w3cdtf($date); // also returns -1 on failure
      if ($timestamp < 0) {
        $timestamp = time(); // better than nothing
      }
523
    }
Dries's avatar
   
Dries committed
524
525

    /*
Dries's avatar
   
Dries committed
526
527
528
    ** 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
529
530
    */

Dries's avatar
   
Dries committed
531
532
    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
533
534
    }
    else {
Dries's avatar
   
Dries committed
535
      $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
536
    }
Dries's avatar
   
Dries committed
537

538
    if (!valid_input_data($item['DESCRIPTION'])) {
Dries's avatar
   
Dries committed
539
      drupal_set_message(t('Failed to parse entry from "%site" feed: suspicious input data.', array('%site' => $feed['title'])), 'error');
540
541
542
543
    }
    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
544
  }
Dries's avatar
   
Dries committed
545

Dries's avatar
   
Dries committed
546
  /*
Dries's avatar
   
Dries committed
547
  ** Remove all items that are older than 3 months:
Dries's avatar
   
Dries committed
548
  */
Dries's avatar
   
Dries committed
549

Dries's avatar
   
Dries committed
550
551
  $age = time() - 1209600; // 3 month
  $result = db_query('SELECT iid FROM {aggregator_item} WHERE fid = %d AND timestamp < %d', $feed['fid'], $age);
Dries's avatar
   
Dries committed
552

553
554
555
556
557
558
559
  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
560
  }
Dries's avatar
   
Dries committed
561
562

  return 1;
563
564
}

Kjartan's avatar
Kjartan committed
565
function aggregator_save_item($edit) {
Dries's avatar
   
Dries committed
566
  if ($edit['iid'] && $edit['title']) {
Dries's avatar
   
Dries committed
567
    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']);
568
  }
Dries's avatar
   
Dries committed
569
570
571
  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']);
572
  }
Dries's avatar
   
Dries committed
573
  else if ($edit['title'] && $edit['link']) {
Dries's avatar
   
Dries committed
574
575
    $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
576
577
578
    // 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
579
      db_query('INSERT INTO {aggregator_category_item} (cid, iid) VALUES (%d, %d)', $category->cid, $edit['iid']);
Dries's avatar
   
Dries committed
580
    }
581
582
583
  }
}

Dries's avatar
   
Dries committed
584
585
function aggregator_form_category($edit = array()) {
  $block_items = array(0 => t('no block'), 3 => t('3 items'), 5 => t('5 items'), 10 => t('10 items'), 15 => t('15 items'), 20 => t('20 items'), 25 => t('25 items'));
586

Dries's avatar
   
Dries committed
587
588
  $form = form_textfield(t('Title'), 'title', $edit['title'], 50, 64);
  $form .= form_textarea(t('Description'), 'description', $edit['description'], 60, 5);
589
  $form .= form_select(t('Latest items block'), 'block', $edit['block'], $block_items, t('If enabled, a block containing the latest items in this category will be available for placement on the <a href="%url">block configuration</a> page.', array('%url' => url('admin/block'))));
Dries's avatar
   
Dries committed
590
  $form .= form_submit(t('Submit'));
591

Dries's avatar
   
Dries committed
592
593
594
  if ($edit['cid']) {
    $form .= form_submit(t('Delete'));
    $form .= form_hidden('cid', $edit['cid']);
595
596
  }

Dries's avatar
   
Dries committed
597
  return form($form);
598
599
}

Dries's avatar
   
Dries committed
600
601
602
function aggregator_save_category($edit) {
  if ($edit['cid'] && $edit['title']) {
    db_query('UPDATE {aggregator_category} SET title = \'%s\', description = \'%s\', block = %d WHERE cid = %d', $edit['title'], $edit['description'], $edit['block'], $edit['cid']);
603
  }
Dries's avatar
   
Dries committed
604
605
  else if ($edit['cid']) {
    db_query('DELETE FROM {aggregator_category} WHERE cid = %d', $edit['cid']);
606
  }
Dries's avatar
   
Dries committed
607
  else if ($edit['title']) {
Dries's avatar
   
Dries committed
608
    // a single unique id for bundles and feeds, to use in blocks
Dries's avatar
   
Dries committed
609
610
    $next_id = db_next_id('{aggregator_category}_cid');
    db_query('INSERT INTO {aggregator_category} (cid, title, description, block) VALUES (%d, \'%s\', \'%s\', %d)', $next_id, $edit['title'], $edit['description'], $edit['block']);
611
612
613
  }
}

Kjartan's avatar
Kjartan committed
614
function aggregator_form_feed($edit = array()) {
Dries's avatar
   
Dries committed
615
  $period = drupal_map_assoc(array(900, 1800, 3600, 7200, 10800, 21600, 32400, 43200, 64800, 86400, 172800, 259200, 604800, 1209600, 2419200), 'format_interval');
Dries's avatar
   
Dries committed
616
  $block_items = array(0 => t('no block'), 3 => t('3 items'), 5 => t('5 items'), 10 => t('10 items'), 15 => t('15 items'), 20 => t('20 items'), 25 => t('25 items'));
617

Dries's avatar
   
Dries committed
618
619
  if ($edit['refresh'] == '') {
    $edit['refresh'] = 3600;
Dries's avatar
   
Dries committed
620
  }
Dries's avatar
   
Dries committed
621

Dries's avatar
   
Dries committed
622
  $form .= form_textfield(t('Title'), 'title', $edit['title'], 50, 64, t('The name of the feed; typically the name of the web site you syndicate content from.'));
623
  $form .= form_textfield(t('URL'), 'url', $edit['url'], 50, 255, t('The fully-qualified URL of the feed.'));
Dries's avatar
   
Dries committed
624
  $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.'));
625
  $form .= form_select(t('Latest items block'), 'block', $edit['block'], $block_items, t('If enabled, a block containing the latest items from this feed will be available for placement on the <a href="%url">block configuration</a> page.', array('%url' => url('admin/block'))));
Dries's avatar
   
Dries committed
626
  $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
627
628
629
630
  while ($category = db_fetch_object($categories)) {
    $checkboxes .= form_checkbox($category->title, "category][$category->cid", 1, $category->fid ? 1 : 0);
  }
  if ($checkboxes) {
631
    $form .= form_group(t('Automatically file items'), $checkboxes, t('New items in this feed will be automatically filed in the the checked categories as they are received.'));
Dries's avatar
   
Dries committed
632
  }
633

Dries's avatar
   
Dries committed
634
  $form .= form_submit(t('Submit'));
635

Dries's avatar
   
Dries committed
636
637
638
  if ($edit['fid']) {
    $form .= form_submit(t('Delete'));
    $form .= form_hidden('fid', $edit['fid']);
639
640
  }

Dries's avatar
   
Dries committed
641
  return form($form);
642
643
}

Kjartan's avatar
Kjartan committed
644
function aggregator_save_feed($edit) {
Dries's avatar
   
Dries committed
645
  if ($edit['fid']) {
646
    // an existing feed is being modified, delete the category listings
Dries's avatar
   
Dries committed
647
    db_query('DELETE FROM {aggregator_category_feed} WHERE fid = %d', $edit['fid']);
648
  }
Dries's avatar
   
Dries committed
649
650
  if ($edit['fid'] && $edit['title']) {
    db_query('UPDATE {aggregator_feed} SET title = \'%s\', url = \'%s\', refresh = %d, block = %d WHERE fid = %d', $edit['title'], $edit['url'], $edit['refresh'], $edit['block'], $edit['fid']);
651
  }
Dries's avatar
   
Dries committed
652
653
654
655
656
657
658
659
660
661
  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']);
662
  }
Dries's avatar
   
Dries committed
663
664
665
666
667
668
669
  else if ($edit['title']) {
    // a single unique id for bundles and feeds, to use in blocks
    $edit['fid'] = db_next_id('{aggregator_feed}_fid');
    db_query('INSERT INTO {aggregator_feed} (fid, title, url, refresh, block) VALUES (%d, \'%s\', \'%s\', %d, %d)', $edit['fid'], $edit['title'], $edit['url'], $edit['refresh'], $edit['block']);
  }
  if ($edit['title']) {
    // the feed is being saved, save the categories as well
Dries's avatar
Dries committed
670
671
672
673
674
    if ($edit['category']) {
      foreach ($edit['category'] as $cid => $checked) {
        if ($checked) {
          db_query('INSERT INTO {aggregator_category_feed} (fid, cid) VALUES (%d, %d)', $edit['fid'], $cid);
        }
Dries's avatar
   
Dries committed
675
676
      }
    }
677
678
679
  }
}

Kjartan's avatar
Kjartan committed
680
function aggregator_get_feed($fid) {
Dries's avatar
   
Dries committed
681
  return db_fetch_array(db_query('SELECT * FROM {aggregator_feed} WHERE fid = %d', $fid));
682
683
}

Dries's avatar
   
Dries committed
684
function aggregator_get_category($cid) {
Dries's avatar
   
Dries committed
685
  return db_fetch_array(db_query('SELECT * FROM {aggregator_category} WHERE cid = %d', $cid));
686
687
}

Kjartan's avatar
Kjartan committed
688
function aggregator_view() {
Dries's avatar
   
Dries committed
689
  $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 ORDER BY f.title');
690

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

Dries's avatar
   
Dries committed
693
  $header = array(t('title'), t('items'), t('last update'), t('next update'), array('data' => t('operations'), 'colspan' => 3));
Dries's avatar
   
Dries committed
694
  $rows = array();
695
  while ($feed = db_fetch_object($result)) {
Dries's avatar
   
Dries committed
696
    $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"));
697
  }
Dries's avatar
   
Dries committed
698
  $output .= theme('table', $header, $rows);
699

Dries's avatar
   
Dries committed
700
  $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 ORDER BY title');
701

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

Dries's avatar
   
Dries committed
704
  $header = array(t('title'), t('items'), t('operations'));
Dries's avatar
   
Dries committed
705
  $rows = array();
Dries's avatar
   
Dries committed
706
  while ($category = db_fetch_object($result)) {
Dries's avatar
   
Dries committed
707
    $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"));
708
  }
Dries's avatar
   
Dries committed
709
  $output .= theme('table', $header, $rows);
710
711
712
713

  return $output;
}

Dries's avatar
   
Dries committed
714
715
716
717
718
719
720
721
722
723
724
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.'));
    }
725
726

    drupal_goto($_GET['q']);
Dries's avatar
   
Dries committed
727
728
729
730
731
732
733
734
735
736
737
738
739
740
  }
  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.'));
    }

741
    drupal_goto('aggregator/'. arg(1));
Dries's avatar
   
Dries committed
742
743
744
745
746
747
748
749
750
751
752
753
754
  }

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

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


Dries's avatar
   
Dries committed
755
/**
Dries's avatar
Dries committed
756
 * Menu callback; displays the category edit form, or saves changes and
757
 * redirects to the overview page.
Dries's avatar
   
Dries committed
758
759
760
761
762
763
764
765
766
767
768
 */
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);
769
770
771
      drupal_set_message($edit['title'] ? t('The category has been updated.') : t('The category has been deleted.'));
      drupal_goto('admin/aggregator');
      break;
Dries's avatar
   
Dries committed
772
773
774
    default:
      if ($category) {
        $output = aggregator_form_category(aggregator_get_category($category));
Dries's avatar
   
Dries committed
775
776
      }
      else {
Dries's avatar
   
Dries committed
777
        $output = aggregator_form_category();
Dries's avatar
   
Dries committed
778
      }
Dries's avatar
   
Dries committed
779
780
781
782
783
  }
  print theme('page', $output);
}

/**
Dries's avatar
Dries committed
784
785
 * Menu callback; displays the feed edit form.
 *
786
 * After editing, saves changes and redirects to the overview page.
Dries's avatar
   
Dries committed
787
788
789
790
791
792
793
794
795
796
797
 */
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);
798
799
800
      drupal_set_message($edit['title'] ? t('The feed has been updated.') : t('The feed has been deleted.'));
      drupal_goto('admin/aggregator');
      break;
Dries's avatar
   
Dries committed
801
802
803
    default:
      if ($feed) {
        $output = aggregator_form_feed(aggregator_get_feed($feed));
Dries's avatar
   
Dries committed
804
805
      }
      else {
Dries's avatar
   
Dries committed
806
        $output = aggregator_form_feed();
Dries's avatar
   
Dries committed
807
      }
808
  }
Dries's avatar
   
Dries committed
809
810
811
812
  print theme('page', $output);
}

/**
813
 * Menu callback; removes all items from a feed, then redirects to the overview page.
Dries's avatar
   
Dries committed
814
815
816
 */
function aggregator_admin_remove_feed($feed) {
  aggregator_remove(aggregator_get_feed($feed));
817
  drupal_goto('admin/aggregator');
Dries's avatar
   
Dries committed
818
819
820
}

/**
821
 * Menu callback; refreshes a feed, then redirects to the overview page.
Dries's avatar
   
Dries committed
822
823
824
 */
function aggregator_admin_refresh_feed($feed) {
  aggregator_refresh(aggregator_get_feed($feed));
825
  drupal_goto('admin/aggregator');
Dries's avatar
   
Dries committed
826
827
828
}

/**
Dries's avatar
Dries committed
829
 * Menu callback; displays the aggregator administration page.
Dries's avatar
   
Dries committed
830
831
832
 */
function aggregator_admin_overview() {
  print theme('page', aggregator_view());
833
834
}

Dries's avatar
   
Dries committed
835
/**
Dries's avatar
Dries committed
836
 * Menu callback; displays the most recent items gathered from any feed.
Dries's avatar
   
Dries committed
837
 */
838
function aggregator_page_last() {
Dries's avatar
   
Dries committed
839
  _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
840
841
}

Dries's avatar
   
Dries committed
842
/**
Dries's avatar
Dries committed
843
 * Menu callback; displays all the items captured from a particular feed.
Dries's avatar
   
Dries committed
844
 */
845
function aggregator_page_source() {
Dries's avatar
   
Dries committed
846
  $feed = db_fetch_object(db_query('SELECT * FROM {aggregator_feed} WHERE fid = %d', arg(2)));
Dries's avatar
   
Dries committed
847
  $info = theme('aggregator_feed', $feed);
Dries's avatar
   
Dries committed
848

849
  _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
850
851
}

Dries's avatar
   
Dries committed
852
/**
Dries's avatar
Dries committed
853
 * Menu callback; displays all the items aggregated in a particular category.
Dries's avatar
   
Dries committed
854
 */
855
function aggregator_page_category() {
Dries's avatar
   
Dries committed
856
  $category = db_fetch_object(db_query('SELECT cid, title FROM {aggregator_category} WHERE cid = %d', arg(2)));
Dries's avatar
   
Dries committed
857

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

Dries's avatar
   
Dries committed
861
862
863
864
/**
 * Prints an aggregator page listing a number of feed items. Various
 * menu callbacks use this function to print their feeds.
 */
Dries's avatar
   
Dries committed
865
function _aggregator_page_list($sql, $op, $header = '') {
Dries's avatar
   
Dries committed
866
867
868
869
870
871
872
873
874
875
  if (user_access('administer news feeds') && $op == 'categorize') {
    if ($edit = $_POST['edit']) {
      foreach ($edit['categories'] as $iid => $selection) {
        db_query('DELETE FROM {aggregator_category_item} WHERE iid = %d', $iid);
        foreach ($selection as $cid) {
          if ($cid) {
            db_query('INSERT INTO {aggregator_category_item} (cid, iid) VALUES (%d, %d)', $cid, $iid);
          }
        }
      }
876
877
      drupal_set_message(t('The categories have been saved.'));
      drupal_goto($_GET['q']);
Dries's avatar
   
Dries committed
878
879
880
881
882
    }
    else {
      $categorize = true;
    }
  }
Dries's avatar
   
Dries committed
883

Dries's avatar
   
Dries committed
884
885
886
887
888
889
890
  $output = '<div id="aggregator">';
  if ($header) {
    $output .= $header;
  }
  if ($links) {
    $output .= theme('links', $links);
  }
Dries's avatar
   
Dries committed
891
892
893

  $result = pager_query($sql, 20);

Dries's avatar
   
Dries committed
894
895
  $rows = array();
  $categories = array();
Dries's avatar
   
Dries committed
896
  while ($item = db_fetch_object($result)) {
Dries's avatar
   
Dries committed
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
    if ($categorize) {
      $categories_result = db_query('SELECT c.cid, c.title, ci.iid FROM {aggregator_category} c LEFT JOIN {aggregator_category_item} ci ON c.cid = ci.cid AND ci.iid = %d', $item->iid);
      if (variable_get('aggregator_category_selector', 'check') == 'select') {
        $selected = array();
        while ($category = db_fetch_object($categories_result)) {
          if (!$done) {
            $categories[$category->cid] = check_form($category->title);
          }
          if ($category->iid) {
            $selected[] = $category->cid;
          }
        }
        $done = true;
        $form = form_select(NULL, 'categories]['. $item->iid, $selected, $categories, NULL, 'size="10"', true);
      }
      else {
        $form = '';
        while ($category = db_fetch_object($categories_result)) {
          $form .= form_checkbox(check_form($category->title), 'categories]['. $item->iid .'][', $category->cid, !is_null($category->iid));
        }
      }
      $rows[] = array(theme('aggregator_page_item', $item), array('data' => $form, 'class' => 'categorize-item'));
    }
    else {
      $output .= theme('aggregator_page_item', $item);
    }
Dries's avatar
   
Dries committed
923
  }
Dries's avatar
   
Dries committed
924
925
926
927
  if ($categorize) {
    $output .= form(theme('table', array('', t('categorize')), $rows) . form_submit(t('Save categories')));
  }
  $output .= '</div>';
Dries's avatar
   
Dries committed
928
929
930
931
932

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

Dries's avatar
   
Dries committed
933
  print theme('page', $output);
Dries's avatar
   
Dries committed
934
935
}

Dries's avatar
   
Dries committed
936
/**
Dries's avatar
Dries committed
937
 * Menu callback; displays all the feeds used by the aggregator.
Dries's avatar
   
Dries committed
938
 */
Kjartan's avatar
Kjartan committed
939
function aggregator_page_sources() {
Dries's avatar
   
Dries committed
940
  $result = db_query('SELECT f.fid, f.title, f.description, f.image, MAX(i.timestamp) AS last FROM {aggregator_feed} f LEFT JOIN {aggregator_item} i ON f.fid = i.fid GROUP BY fid');
Dries's avatar
   
Dries committed
941
  $output = "<div id=\"aggregator\">\n";
Dries's avatar
   
Dries committed
942
  while ($feed = db_fetch_object($result)) {
Dries's avatar
   
Dries committed
943
    $output .= "<h2>$feed->title</h2>\n";
Dries's avatar
   
Dries committed
944
945
946
947
948
949

    // Most recent items:
    $list = array();
    if (variable_get('aggregator_summary_items', 3)) {
      $items = db_query_range('SELECT i.title, i.timestamp, i.link FROM {aggregator_item} i WHERE i.fid = %d ORDER BY i.timestamp DESC', $feed->fid, 0, variable_get('aggregator_summary_items', 3));
      while ($item = db_fetch_object($items)) {