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

Dries Buytaert's avatar
   
Dries Buytaert committed
4
5
6
/**
 * Implementation of hook_help().
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
7
function aggregator_help($section) {
Dries Buytaert's avatar
   
Dries Buytaert committed
8
  switch ($section) {
9
    case 'admin/help#aggregator':
Dries Buytaert's avatar
   
Dries Buytaert committed
10
      return t('
Dries Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert committed
18
      <p>NOTE: Enable your site\'s XML syndication button by turning on the Syndicate block in block management.</p>
Dries Buytaert's avatar
   
Dries Buytaert committed
19
      <h3>How do I add a news feed?</h3>
Dries Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert committed
22
      <ul>
Dries Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert committed
28
      </ul>
Dries Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert committed
30
      <h3>Adding categories</h3>
Dries Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert committed
33
      <ul>
Dries Buytaert's avatar
   
Dries Buytaert committed
34
35
       <li><strong>Title</strong> -- The title will be used in the <i>news by topics</i> listing in your news aggregator and for the block created for the bundle.</li>
       <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 Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert committed
44
      </ul>
Dries Buytaert's avatar
   
Dries Buytaert committed
45
      <p>Pages that display items (for sources, categories, etc.) display the following for each item:
Dries Buytaert's avatar
   
Dries Buytaert committed
46
      <ul>
Dries Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert committed
51
      </ul>
Dries Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert committed
53
      <h3>Technical details</h3>
Dries Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert committed
58
      return t('Used to aggregate syndicated content (RSS and RDF).');
Dries Buytaert's avatar
   
Dries Buytaert committed
59
    case 'admin/aggregator':
Dries Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert committed
61
    case 'admin/aggregator/add/feed':
Dries Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert committed
63
    case 'admin/aggregator/add/category':
Dries Buytaert's avatar
   
Dries Buytaert 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 <i>Sports</i>. 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 Buytaert's avatar
   
Dries Buytaert committed
67
  }
68
69
}

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

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

Dries Buytaert's avatar
   
Dries Buytaert committed
82
  $output = '';
Dries Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert committed
85

Dries Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert committed
88

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

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

Dries Buytaert's avatar
   
Dries Buytaert committed
99
100
101
/**
 * Implementation of hook_link().
 */
102
function aggregator_link($type) {
Dries Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert committed
106
}
Dries Buytaert's avatar
   
Dries Buytaert committed
107

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

Dries Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert committed
132
133
  $items[] = array('path' => 'admin/aggregator/list', 'title' => t('list'),
    'type' => MENU_DEFAULT_LOCAL_TASK, 'weight' => -10);
Dries Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert committed
163
164
      $items[] = array('path' => 'aggregator/sources/'. $feed->fid .'/view', 'title' => t('view'),
        'type' => MENU_DEFAULT_LOCAL_TASK, 'weight' => -10);
Dries Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert committed
172
    }
173

Dries Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert committed
179
180
      $items[] = array('path' => 'aggregator/categories/'. $category->cid .'/view', 'title' => t('view'),
        'type' => MENU_DEFAULT_LOCAL_TASK, 'weight' => -10);
Dries Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert committed
198
199
200
201
202
/**
 * Implementation of hook_cron().
 *
 * Checks news feeds for updates once their refresh interval has elapsed.
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
203
function aggregator_cron() {
Dries Buytaert's avatar
   
Dries Buytaert committed
204
  $result = db_query('SELECT * FROM {aggregator_feed} WHERE checked + refresh < %d', time());
Dries Buytaert's avatar
   
Dries Buytaert committed
205
206
  while ($feed = db_fetch_array($result)) {
    aggregator_refresh($feed);
Dries Buytaert's avatar
   
Dries Buytaert committed
207
208
209
  }
}

Dries Buytaert's avatar
   
Dries Buytaert committed
210
211
212
213
214
/**
 * Implementation of hook_block().
 *
 * Generates blocks for the latest news items in each category and feed.
 */
215
function aggregator_block($op, $delta) {
Dries Buytaert's avatar
   
Dries Buytaert committed
216
  if (user_access('access news feeds')) {
Dries Buytaert's avatar
   
Dries Buytaert 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));
221
      }
Dries Buytaert's avatar
   
Dries Buytaert committed
222
      $result = db_query('SELECT fid, title FROM {aggregator_feed} WHERE block != 0 ORDER BY fid');
223
      while ($feed = db_fetch_object($result)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
224
        $block['feed:'. $feed->fid]['info'] = t('%title feed latest items', array('%title' => $feed->title));
225
      }
Dries Buytaert's avatar
   
Dries Buytaert committed
226
    }
227
    else {
Dries Buytaert's avatar
   
Dries Buytaert committed
228
      list($type, $id) = split(':', $delta);
229
      switch ($type) {
Dries Buytaert's avatar
   
Dries Buytaert 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>';
235
          break;
Dries Buytaert's avatar
   
Dries Buytaert 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>';
241
242
          break;
      }
Dries Buytaert's avatar
   
Dries Buytaert committed
243
244
      $items = array();
      while ($item = db_fetch_object($result)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
245
        $items[] = theme('aggregator_block_item', $item);
Dries Buytaert's avatar
   
Dries Buytaert committed
246
      }
Dries Buytaert's avatar
   
Dries Buytaert committed
247
      $block['content'] = theme('item_list', $items) . $block['content'];
Dries Buytaert's avatar
   
Dries Buytaert committed
248
    }
Dries Buytaert's avatar
   
Dries Buytaert committed
249
    return $block;
Dries Buytaert's avatar
   
Dries Buytaert committed
250
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
251
252
}

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

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

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

  $tag = $name;
}

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

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

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

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

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

Dries Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert committed
333
    $headers['If-Modified-Since'] = gmdate('D, d M Y H:i:s', $feed['modified']) .' GMT';
Dries Buytaert's avatar
   
Dries Buytaert committed
334
335
336
337
338
  }

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

339
  // Process HTTP response code.
Dries Buytaert's avatar
   
Dries Buytaert committed
340
341
  switch ($result->code) {
    case 304:
Dries Buytaert's avatar
   
Dries Buytaert committed
342
343
      db_query('UPDATE {aggregator_feed} SET checked = %d WHERE fid = %d', time(), $feed['fid']);
      drupal_set_message(t('no new syndicated content from "%site".', array('%site' => $feed['title'])));
Dries Buytaert's avatar
   
Dries Buytaert committed
344
      break;
Dries Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert committed
354
355
356
        if ($result->headers['Last-Modified']) {
          $modified = strtotime($result->headers['Last-Modified']);
        }
Dries Buytaert's avatar
Dries Buytaert committed
357

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

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

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

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

Dries Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert committed
378

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

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

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

Dries Buytaert's avatar
   
Dries Buytaert committed
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
432
433
/**
 * 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 Buytaert's avatar
   
Dries Buytaert committed
434
function aggregator_parse_feed(&$data, $feed) {
Dries Buytaert's avatar
   
Dries Buytaert committed
435
  global $items, $image, $channel;
Dries Buytaert's avatar
   
Dries Buytaert committed
436

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

Dries Buytaert's avatar
   
Dries Buytaert committed
443
444
  // parse the data:
  $xml_parser = drupal_xml_parser_create($data);
Dries Buytaert's avatar
   
Dries Buytaert committed
445
446
  xml_set_element_handler($xml_parser, 'aggregator_element_start', 'aggregator_element_end');
  xml_set_character_data_handler($xml_parser, 'aggregator_element_data');
Dries Buytaert's avatar
   
Dries Buytaert committed
447

Dries Buytaert's avatar
   
Dries Buytaert committed
448
  if (!xml_parse($xml_parser, $data, 1)) {
449
    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 Buytaert's avatar
   
Dries Buytaert committed
450
    $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)));
Dries Buytaert's avatar
   
Dries Buytaert committed
451
452
    drupal_set_message($message, 'error');
    return 0;
Dries Buytaert's avatar
   
Dries Buytaert committed
453
454
  }
  xml_parser_free($xml_parser);
Dries Buytaert's avatar
   
Dries Buytaert committed
455

Dries Buytaert's avatar
   
Dries Buytaert committed
456
  // initialize the translation table:
457
  $tt = array_flip(get_html_translation_table(HTML_SPECIALCHARS));
Dries Buytaert's avatar
   
Dries Buytaert committed
458
  $tt['&apos;'] = "'";
Dries Buytaert's avatar
   
Dries Buytaert committed
459

Dries Buytaert's avatar
   
Dries Buytaert committed
460
461
462
463
464
  /*
  ** 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 Buytaert's avatar
   
Dries Buytaert committed
465

Dries Buytaert's avatar
   
Dries Buytaert committed
466
  $items = array_reverse($items);
Dries Buytaert's avatar
   
Dries Buytaert committed
467

Dries Buytaert's avatar
   
Dries Buytaert committed
468
469
  foreach ($items as $item) {
    unset($title, $link, $author, $description);
470

Dries Buytaert's avatar
   
Dries Buytaert committed
471
472
    // Prepare the item:
    foreach ($item as $key => $value) {
473
474
475
476
477
478
      // 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 Buytaert's avatar
   
Dries Buytaert committed
479
    }
Dries Buytaert's avatar
Dries Buytaert committed
480

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

Dries Buytaert's avatar
   
Dries Buytaert committed
494
495
496
497
    /*
    ** Resolve the items link.
    */

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

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

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

    /*
Dries Buytaert's avatar
   
Dries Buytaert committed
529
530
531
    ** 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 Buytaert's avatar
   
Dries Buytaert committed
532
533
    */

Dries Buytaert's avatar
   
Dries Buytaert committed
534
535
    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 Buytaert's avatar
   
Dries Buytaert committed
536
537
    }
    else {
Dries Buytaert's avatar
   
Dries Buytaert committed
538
      $entry = db_fetch_object(db_query("SELECT iid FROM {aggregator_item} WHERE fid = %d AND title = '%s'", $feed['fid'], $title));
Dries Buytaert's avatar
   
Dries Buytaert committed
539
    }
Dries Buytaert's avatar
   
Dries Buytaert committed
540

541
542
543
544
545
546
    if (!valid_input_data($item['DESCRIPTION'])) {
      drupal_set_message(t('failed to parse entry from "%site" feed: suspicious input data.', array('%site' => $feed['title'])), 'error');
    }
    else {
      aggregator_save_item(array('iid' => $entry->iid, 'fid' => $feed['fid'], 'timestamp' => $timestamp, 'title' => $title, 'link' => $link, 'author' => $item['AUTHOR'], 'description' => $item['DESCRIPTION']));
    }
Dries Buytaert's avatar
   
Dries Buytaert committed
547
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
548

Dries Buytaert's avatar
   
Dries Buytaert committed
549
  /*
Dries Buytaert's avatar
   
Dries Buytaert committed
550
  ** Remove all items that are older than 3 months:
Dries Buytaert's avatar
   
Dries Buytaert committed
551
  */
Dries Buytaert's avatar
   
Dries Buytaert committed
552

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

556
557
558
559
560
561
562
  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 Buytaert's avatar
   
Dries Buytaert committed
563
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
564
565

  return 1;
566
567
}

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

Dries Buytaert's avatar
   
Dries Buytaert committed
587
588
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'));
589

Dries Buytaert's avatar
   
Dries Buytaert committed
590
591
  $form = form_textfield(t('Title'), 'title', $edit['title'], 50, 64);
  $form .= form_textarea(t('Description'), 'description', $edit['description'], 60, 5);
592
  $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 Buytaert's avatar
   
Dries Buytaert committed
593
  $form .= form_submit(t('Submit'));
594

Dries Buytaert's avatar
   
Dries Buytaert committed
595
596
597
  if ($edit['cid']) {
    $form .= form_submit(t('Delete'));
    $form .= form_hidden('cid', $edit['cid']);
598
599
  }

Dries Buytaert's avatar
   
Dries Buytaert committed
600
  return form($form);
601
602
}

Dries Buytaert's avatar
   
Dries Buytaert committed
603
604
605
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']);
606
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
607
608
  else if ($edit['cid']) {
    db_query('DELETE FROM {aggregator_category} WHERE cid = %d', $edit['cid']);
609
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
610
  else if ($edit['title']) {
Dries Buytaert's avatar
   
Dries Buytaert committed
611
    // a single unique id for bundles and feeds, to use in blocks
Dries Buytaert's avatar
   
Dries Buytaert committed
612
613
    $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']);
614
615
616
  }
}

617
function aggregator_form_feed($edit = array()) {
Dries Buytaert's avatar
   
Dries Buytaert committed
618
  $period = drupal_map_assoc(array(900, 1800, 3600, 7200, 10800, 21600, 32400, 43200, 64800, 86400, 172800, 259200, 604800, 1209600, 2419200), 'format_interval');
Dries Buytaert's avatar
   
Dries Buytaert committed
619
  $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'));
620

Dries Buytaert's avatar
   
Dries Buytaert committed
621
622
  if ($edit['refresh'] == '') {
    $edit['refresh'] = 3600;
Dries Buytaert's avatar
   
Dries Buytaert committed
623
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
624

Dries Buytaert's avatar
   
Dries Buytaert committed
625
  $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.'));
626
  $form .= form_textfield(t('URL'), 'url', $edit['url'], 50, 255, t('The fully-qualified URL of the feed.'));
Dries Buytaert's avatar
   
Dries Buytaert committed
627
  $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.'));
628
  $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 Buytaert's avatar
   
Dries Buytaert committed
629
  $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 Buytaert's avatar
   
Dries Buytaert committed
630
631
632
633
  while ($category = db_fetch_object($categories)) {
    $checkboxes .= form_checkbox($category->title, "category][$category->cid", 1, $category->fid ? 1 : 0);
  }
  if ($checkboxes) {
634
    $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 Buytaert's avatar
   
Dries Buytaert committed
635
  }
636

Dries Buytaert's avatar
   
Dries Buytaert committed
637
  $form .= form_submit(t('Submit'));
638

Dries Buytaert's avatar
   
Dries Buytaert committed
639
640
641
  if ($edit['fid']) {
    $form .= form_submit(t('Delete'));
    $form .= form_hidden('fid', $edit['fid']);
642
643
  }

Dries Buytaert's avatar
   
Dries Buytaert committed
644
  return form($form);
645
646
}

647
function aggregator_save_feed($edit) {
Dries Buytaert's avatar
   
Dries Buytaert committed
648
  if ($edit['fid']) {
649
    // an existing feed is being modified, delete the category listings
Dries Buytaert's avatar
   
Dries Buytaert committed
650
    db_query('DELETE FROM {aggregator_category_feed} WHERE fid = %d', $edit['fid']);
651
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
652
653
  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']);
654
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
655
656
657
658
659
660
661
662
663
664
  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']);
665
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
666
667
668
669
670
671
672
  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
673
674
675
676
677
    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 Buytaert's avatar
   
Dries Buytaert committed
678
679
      }
    }
680
681
682
  }
}

683
function aggregator_get_feed($fid) {
Dries Buytaert's avatar
   
Dries Buytaert committed
684
  return db_fetch_array(db_query('SELECT * FROM {aggregator_feed} WHERE fid = %d', $fid));
685
686
}

Dries Buytaert's avatar
   
Dries Buytaert committed
687
function aggregator_get_category($cid) {
Dries Buytaert's avatar
   
Dries Buytaert committed
688
  return db_fetch_array(db_query('SELECT * FROM {aggregator_category} WHERE cid = %d', $cid));
689
690
}

691
function aggregator_view() {
Dries Buytaert's avatar
   
Dries Buytaert committed
692
  $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');
693

Dries Buytaert's avatar
   
Dries Buytaert committed
694
  $output .= '<h3>'. t('Feed overview') .'</h3>';
Dries Buytaert's avatar
   
Dries Buytaert committed
695

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

Dries Buytaert's avatar
   
Dries Buytaert committed
703
  $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');
704

Dries Buytaert's avatar
   
Dries Buytaert committed
705
  $output .= '<h3>'. t('Category overview') .'</h3>';
Dries Buytaert's avatar
   
Dries Buytaert committed
706

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

  return $output;
}

Dries Buytaert's avatar
   
Dries Buytaert committed
717
718
719
720
721
722
723
724
725
726
727
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.'));
    }
728
729

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

744
    drupal_goto('aggregator/'. arg(1));
Dries Buytaert's avatar
   
Dries Buytaert committed
745
746
747
748
749
750
751
752
753
754
755
756
757
  }

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

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

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

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

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

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

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

852
  _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 Buytaert's avatar
   
Dries Buytaert committed
853
854
}

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

861
  _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 Buytaert's avatar
   
Dries Buytaert committed
862
}
Dries Buytaert's avatar
   
Dries Buytaert committed
863

Dries Buytaert's avatar
   
Dries Buytaert committed
864
865
866
867
/**
 * Prints an aggregator page listing a number of feed items. Various
 * menu callbacks use this function to print their feeds.
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
868
function _aggregator_page_list($sql, $op, $header = '') {
Dries Buytaert's avatar
   
Dries Buytaert committed
869
870
871
872
873
874
875
876
877
878
  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);
          }
        }
      }
879
880
      drupal_set_message(t('The categories have been saved.'));
      drupal_goto($_GET['q']);
Dries Buytaert's avatar
   
Dries Buytaert committed
881
882
883
884
885
    }
    else {
      $categorize = true;
    }
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
886

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

  $result = pager_query($sql, 20);

Dries Buytaert's avatar
   
Dries Buytaert committed
897
898
  $rows = array();
  $categories = array();
Dries Buytaert's avatar
   
Dries Buytaert committed
899
  while ($item = db_fetch_object($result)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
    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 Buytaert's avatar
   
Dries Buytaert committed
926
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
927
928
929
930
  if ($categorize) {
    $output .= form(theme('table', array('', t('categorize')), $rows) . form_submit(t('Save categories')));
  }
  $output .= '</div>';
Dries Buytaert's avatar
   
Dries Buytaert committed
931
932
933
934
935

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

Dries Buytaert's avatar
   
Dries Buytaert committed
936
  print theme('page', $output);
Dries Buytaert's avatar
   
Dries Buytaert committed
937
938
}

Dries Buytaert's avatar
   
Dries Buytaert committed
939
/**
940
 * Menu callback; displays all the feeds used by the aggregator.
Dries Buytaert's avatar
   
Dries Buytaert committed
941
 */
942
function aggregator_page_sources() {
Dries Buytaert's avatar
   
Dries Buytaert committed
943
  $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 Buytaert's avatar