aggregator.module 49.4 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
7
8
/**
 * @file
 * Used to aggregate syndicated content (RSS and RDF).
 */

Dries Buytaert's avatar
   
Dries Buytaert committed
9
10
11
/**
 * Implementation of hook_help().
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
12
function aggregator_help($section) {
Dries Buytaert's avatar
   
Dries Buytaert committed
13
  switch ($section) {
14
    case 'admin/help#aggregator':
Dries Buytaert's avatar
   
Dries Buytaert committed
15
      return t('
Dries Buytaert's avatar
   
Dries Buytaert committed
16
17
18
19
20
21
22
      <p>Thousands of sites (particularly news sites and weblogs) publish their latest headlines and/or stories in a machine-readable format so that other sites can easily link to them. This content is usually in the form of an <a href="http://blogs.law.harvard.edu/tech/rss">RSS</a> feed (which is an XML-based syndication standard).</p>
      <p>You can read aggregated content from many sites using RSS feed readers, such as <a href="http://www.disobey.com/amphetadesk/">Amphetadesk</a>.</p>
      <p>Drupal provides the means to aggregate feeds from many sites and display these aggregated feeds to your site\'s visitors. To do this, enable the aggregator module in site administration and then go to the aggregator configuration page, where you can subscribe to feeds and set up other options.</p>
      <h3>How do I find RSS feeds to aggregate?</h3>
      <p>Many web sites (especially weblogs) display small XML icons or other obvious links on their home page. You can follow these to obtain the web address for the RSS feed. Common extensions for RSS feeds are .rss, .xml and .rdf. For example: <a href="http://slashdot.org/slashdot.rdf">Slashdot RSS</a>.</p>
      <p>If you can\'t find a feed for a site, or you want to find several feeds on a given topic, try an RSS syndication directory such as <a href="http://www.syndic8.com/">Syndic8</a>.</p>
      <p>To learn more about RSS, read Mark Pilgrim\'s <a href="http://www.xml.com/pub/a/2002/12/18/dive-into-xml.html">What is RSS</a> and WebReference.com\'s <a href="http://www.webreference.com/authoring/languages/xml/rss/1/">The Evolution of RSS</a> articles.</p>
Dries Buytaert's avatar
   
Dries Buytaert committed
23
      <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
24
      <h3>How do I add a news feed?</h3>
Dries Buytaert's avatar
   
Dries Buytaert committed
25
26
      <p>To subscribe to an RSS feed on another site, use the <a href="%admin-news">aggregation page</a>.</p>
      <p>Once there, click the <a href="%new-feed">new feed</a> tab.  Drupal will then ask for the following:</p>
Dries Buytaert's avatar
   
Dries Buytaert committed
27
      <ul>
Dries Buytaert's avatar
   
Dries Buytaert committed
28
29
30
       <li><strong>Title</strong> -- The text entered here will be used in your news aggregator, within the administration configuration section, and as a title for the news feed block. As a general rule, use the web site name from which the feed originates.</li>
       <li><strong>URL</strong> -- Here you\'ll enter the fully-qualified web address for the feed you wish to subscribe to.</li>
       <li><strong>Update interval</strong> -- This is how often Drupal will scan the feed for new content. This defaults to every hour. Checking a feed more frequently that this is typically a waste of bandwidth and is considered somewhat impolite. For automatic updates to work, cron.php must be called regularly. If it is not, you\'ll have to manually update the feeds one at a time within the news aggregation administration page by using <a href="%update-items">update items</a>.</li>
Dries Buytaert's avatar
   
Dries Buytaert committed
31
       <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
32
       <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
33
      </ul>
Dries Buytaert's avatar
   
Dries Buytaert committed
34
      <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
35
      <h3>Adding categories</h3>
Dries Buytaert's avatar
   
Dries Buytaert committed
36
      <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
37
      <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
38
      <ul>
Dries Buytaert's avatar
   
Dries Buytaert committed
39
       <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 Buytaert's avatar
   
Dries Buytaert committed
40
       <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
41
       <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
42
43
44
45
      </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
46
47
48
       <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
49
      </ul>
Dries Buytaert's avatar
   
Dries Buytaert committed
50
      <p>Pages that display items (for sources, categories, etc.) display the following for each item:
Dries Buytaert's avatar
   
Dries Buytaert committed
51
      <ul>
Dries Buytaert's avatar
   
Dries Buytaert committed
52
53
54
55
       <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
56
      </ul>
Dries Buytaert's avatar
   
Dries Buytaert committed
57
      <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
58
      <h3>Technical details</h3>
Dries Buytaert's avatar
   
Dries Buytaert committed
59
      <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
60
      <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
61
62
      <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
63
      return t('Used to aggregate syndicated content (RSS and RDF).');
Dries Buytaert's avatar
   
Dries Buytaert committed
64
    case 'admin/aggregator':
Dries Buytaert's avatar
   
Dries Buytaert committed
65
      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>.', array('%block' => url('admin/block')));
Dries Buytaert's avatar
   
Dries Buytaert committed
66
    case 'admin/aggregator/add/feed':
Dries Buytaert's avatar
   
Dries Buytaert committed
67
      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
68
    case 'admin/aggregator/add/category':
Dries Buytaert's avatar
   
Dries Buytaert committed
69
      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.');
70
71
    case 'admin/aggregator/configure':
      return t('These settings control the display of aggregated content.');
Dries Buytaert's avatar
   
Dries Buytaert committed
72
  }
73
74
}

Dries Buytaert's avatar
   
Dries Buytaert committed
75
/**
76
 * Menu callback; displays the aggregator-specific information from admin/help.
Dries Buytaert's avatar
   
Dries Buytaert committed
77
 */
78
function aggregator_help_page() {
Dries Buytaert's avatar
   
Dries Buytaert committed
79
  print theme('page', aggregator_help('admin/help#aggregator'));
Dries Buytaert's avatar
   
Dries Buytaert committed
80
81
}

Dries Buytaert's avatar
   
Dries Buytaert committed
82
83
84
85
86
function aggregator_configure() {
  if ($_POST) {
    system_settings_save();
  }

Dries Buytaert's avatar
   
Dries Buytaert committed
87
  $output = '';
88
  $items = array(0 => t('none')) + drupal_map_assoc(array(3, 5, 10, 15, 20, 25), '_aggregator_items');
Dries Buytaert's avatar
   
Dries Buytaert committed
89

Dries Buytaert's avatar
   
Dries Buytaert committed
90
91
  $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
92

Dries Buytaert's avatar
   
Dries Buytaert committed
93
  print theme('page', system_settings_form($output));
Dries Buytaert's avatar
   
Dries Buytaert committed
94
95
}

96
97
98
99
100
101
102
/**
 * Helper function for drupal_map_assoc.
 */
function _aggregator_items($count) {
  return format_plural($count, '1 item', '%count items');
}

Dries Buytaert's avatar
   
Dries Buytaert committed
103
104
105
/**
 * Implementation of hook_perm().
 */
106
function aggregator_perm() {
Dries Buytaert's avatar
   
Dries Buytaert committed
107
  return array('administer news feeds', 'access news feeds');
Dries Buytaert's avatar
   
Dries Buytaert committed
108
109
}

Dries Buytaert's avatar
   
Dries Buytaert committed
110
111
112
/**
 * Implementation of hook_link().
 */
113
function aggregator_link($type) {
Dries Buytaert's avatar
   
Dries Buytaert committed
114
115
116
  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
117
}
Dries Buytaert's avatar
   
Dries Buytaert committed
118

Dries Buytaert's avatar
   
Dries Buytaert committed
119
120
121
/**
 * Implementation of hook_menu().
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
122
function aggregator_menu($may_cache) {
Dries Buytaert's avatar
   
Dries Buytaert committed
123
  $items = array();
Dries Buytaert's avatar
   
Dries Buytaert committed
124

Dries Buytaert's avatar
   
Dries Buytaert committed
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
  if ($may_cache) {
    $edit = user_access('administer news feeds');
    $view = user_access('access news feeds');

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

    $items[] = array('path' => 'admin/aggregator/list', 'title' => t('list'),
      'type' => MENU_DEFAULT_LOCAL_TASK, 'weight' => -10);
    $items[] = array('path' => 'admin/aggregator/add/feed', 'title' => t('add feed'),
      'callback' => 'aggregator_admin_edit_feed', 'access' => $edit,
      'type' => MENU_LOCAL_TASK);
    $items[] = array('path' => 'admin/aggregator/add/category', 'title' => t('add category'),
      'callback' => 'aggregator_admin_edit_category', 'access' => $edit,
      'type' => MENU_LOCAL_TASK);
    $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);

Dries Buytaert's avatar
   
Dries Buytaert committed
165
166
167
168
169
    // 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
170
171
      $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
172
173
174
175
176
177
178
      $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
179
    }
180

Dries Buytaert's avatar
   
Dries Buytaert committed
181
182
183
184
185
    // 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
186
187
      $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
188
189
190
191
192
193
194
195
196
      $items[] = array('path' => 'aggregator/categories/'. $category->cid .'/categorize', 'title' => t('categorize'),
        'callback' => 'aggregator_page_category', 'access' => $edit,
        'type' => MENU_LOCAL_TASK);
      $items[] = array('path' => 'aggregator/categories/'. $category->cid .'/configure', 'title' => t('configure'),
        'callback' => 'aggregator_edit', 'access' => $edit,
        'type' => MENU_LOCAL_TASK,
        'weight' => 1);
    }

Dries Buytaert's avatar
   
Dries Buytaert committed
197
198
199
200
    $items[] = array('path' => 'aggregator/opml', 'title' => t('opml'),
      'callback' => 'aggregator_page_opml', 'access' => $view,
      'type' => MENU_CALLBACK);
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
201
202

  return $items;
203
204
}

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

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

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

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

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

  $tag = $name;
}

Dries Buytaert's avatar
   
Dries Buytaert committed
292
293
294
/**
 * Call-back function used by the XML parser.
 */
295
function aggregator_element_end($parser, $name) {
Dries Buytaert's avatar
   
Dries Buytaert committed
296
297
  global $element;

Dries Buytaert's avatar
   
Dries Buytaert committed
298
  switch ($name) {
Dries Buytaert's avatar
   
Dries Buytaert committed
299
300
301
302
    case 'IMAGE':
    case 'TEXTINPUT':
    case 'ITEM':
      $element = '';
Dries Buytaert's avatar
   
Dries Buytaert committed
303
  }
304
305
}

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

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

Dries Buytaert's avatar
   
Dries Buytaert committed
328
329
330
/**
 * Checks a news feed for new items.
 */
331
function aggregator_refresh($feed) {
Dries Buytaert's avatar
   
Dries Buytaert committed
332
333
  global $channel, $image;

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

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

346
  // Process HTTP response code.
Dries Buytaert's avatar
   
Dries Buytaert committed
347
348
  switch ($result->code) {
    case 304:
Dries Buytaert's avatar
   
Dries Buytaert committed
349
      db_query('UPDATE {aggregator_feed} SET checked = %d WHERE fid = %d', time(), $feed['fid']);
Dries Buytaert's avatar
   
Dries Buytaert committed
350
      drupal_set_message(t('No new syndicated content from %site.', array('%site' => '<em>'. $feed['title'] .'</em>')));
Dries Buytaert's avatar
   
Dries Buytaert committed
351
      break;
Dries Buytaert's avatar
   
Dries Buytaert committed
352
353
    case 301:
      $feed['url'] = $result->redirect_url;
Dries Buytaert's avatar
   
Dries Buytaert committed
354
      watchdog('special', t('Aggregator: updated URL for feed %title to %url.', array('%title' => '<em>'. $feed[title] .'</em>', '%url' => '<em>'. $feed[url] .'</em>')));
Dries Buytaert's avatar
   
Dries Buytaert committed
355
356
357
358
    case 200:
    case 302:
    case 307:
      // Filter the input data:
359
     if (aggregator_parse_feed($result->data, $feed)) {
360

Dries Buytaert's avatar
   
Dries Buytaert committed
361
362
363
        if ($result->headers['Last-Modified']) {
          $modified = strtotime($result->headers['Last-Modified']);
        }
Dries Buytaert's avatar
Dries Buytaert committed
364

365
366
367
368
369
370
371
372
        /*
        ** Prepare the channel data:
        */

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

Dries Buytaert's avatar
   
Dries Buytaert committed
373
374
375
        /*
        ** Prepare the image data (if any):
        */
Dries Buytaert's avatar
   
Dries Buytaert committed
376

Dries Buytaert's avatar
   
Dries Buytaert committed
377
378
379
        foreach ($image as $key => $value) {
          $image[$key] = trim($value);
        }
Dries Buytaert's avatar
   
Dries Buytaert committed
380

Dries Buytaert's avatar
   
Dries Buytaert committed
381
        if ($image['LINK'] && $image['URL'] && $image['TITLE']) {
Dries Buytaert's avatar
   
Dries Buytaert committed
382
          $image = '<a href="'. $image['LINK'] .'"><img src="'. $image['URL'] .'" alt="'. $image['TITLE'] .'" /></a>';
Dries Buytaert's avatar
   
Dries Buytaert committed
383
        }
Dries Buytaert's avatar
   
Dries Buytaert committed
384
385
386
        else {
          $image = NULL;
        }
Dries Buytaert's avatar
   
Dries Buytaert committed
387

Dries Buytaert's avatar
   
Dries Buytaert committed
388
389
390
        /*
        ** Update the feed data:
        */
Dries Buytaert's avatar
   
Dries Buytaert committed
391

392
        db_query("UPDATE {aggregator_feed} SET url = '%s', checked = %d, link = '%s', description = '%s', image = '%s', etag = '%s', modified = %d WHERE fid = %d", $feed['url'], time(), $channel['LINK'], $channel['DESCRIPTION'], $image, $result->headers['ETag'], $modified, $feed['fid']);
Dries Buytaert's avatar
   
Dries Buytaert committed
393

Dries Buytaert's avatar
   
Dries Buytaert committed
394
395
396
        /*
        ** Clear the cache:
        */
Dries Buytaert's avatar
   
Dries Buytaert committed
397

Dries Buytaert's avatar
   
Dries Buytaert committed
398
        cache_clear_all();
Dries Buytaert's avatar
   
Dries Buytaert committed
399

Dries Buytaert's avatar
   
Dries Buytaert committed
400
401
        watchdog('regular', t('Aggregator: syndicated content from %site.', array('%site' => '<em>'. $feed[title] .'</em>')));
        drupal_set_message(t('Syndicated content from %site.', array('%site' => '<em>'. $feed['title'] .'</em>')));
Dries Buytaert's avatar
   
Dries Buytaert committed
402
403
      }
      break;
Dries Buytaert's avatar
   
Dries Buytaert committed
404
    default:
Dries Buytaert's avatar
   
Dries Buytaert committed
405
406
      watchdog('error', t('Aggregator: failed to parse RSS feed %site: %error.', array('%site' => '<em>'. $feed['title'] .'</em>', '%error' => "<em>$result->code $result->error</em>")));
      drupal_set_message(t('Failed to parse RSS feed %site: %error.', array('%site' => '<em>'. $feed['title'] .'</em>', '%error' => "<em>$result->code $result->error</em>")));
Dries Buytaert's avatar
   
Dries Buytaert committed
407
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
408
}
Dries Buytaert's avatar
   
Dries Buytaert committed
409

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

Dries Buytaert's avatar
   
Dries Buytaert committed
450
  // Unset the global variables before we use them:
Dries Buytaert's avatar
   
Dries Buytaert committed
451
  unset($GLOBALS['element'], $GLOBALS['item'], $GLOBALS['tag']);
Dries Buytaert's avatar
   
Dries Buytaert committed
452
  $items = array();
Dries Buytaert's avatar
   
Dries Buytaert committed
453
  $image = array();
Dries Buytaert's avatar
   
Dries Buytaert committed
454
  $channel = array();
455

Dries Buytaert's avatar
   
Dries Buytaert committed
456
457
  // parse the data:
  $xml_parser = drupal_xml_parser_create($data);
Dries Buytaert's avatar
   
Dries Buytaert committed
458
459
  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
460

Dries Buytaert's avatar
   
Dries Buytaert committed
461
  if (!xml_parse($xml_parser, $data, 1)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
462
463
    watchdog('error', t('Aggregator: failed to parse RSS feed %site: %error at line %line.', array('%site' => '<em>'. $feed['title'] .'</em>', '%error' => xml_error_string(xml_get_error_code($xml_parser)), '%line' => xml_get_current_line_number($xml_parser))));
    drupal_set_message(t('Failed to parse RSS feed %site: %error at line %line.', array('%site' => '<em>'. $feed['title'] .'</em>', '%error' => xml_error_string(xml_get_error_code($xml_parser)), '%line' => xml_get_current_line_number($xml_parser))), 'error');
Dries Buytaert's avatar
   
Dries Buytaert committed
464
    return 0;
Dries Buytaert's avatar
   
Dries Buytaert committed
465
466
  }
  xml_parser_free($xml_parser);
Dries Buytaert's avatar
   
Dries Buytaert committed
467

Dries Buytaert's avatar
   
Dries Buytaert committed
468
  // initialize the translation table:
469
  $tt = array_flip(get_html_translation_table(HTML_SPECIALCHARS));
Dries Buytaert's avatar
   
Dries Buytaert committed
470
  $tt['&apos;'] = "'";
Dries Buytaert's avatar
   
Dries Buytaert committed
471

Dries Buytaert's avatar
   
Dries Buytaert committed
472
473
474
475
476
  /*
  ** 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
477

Dries Buytaert's avatar
   
Dries Buytaert committed
478
  $items = array_reverse($items);
Dries Buytaert's avatar
   
Dries Buytaert committed
479

Dries Buytaert's avatar
   
Dries Buytaert committed
480
481
  foreach ($items as $item) {
    unset($title, $link, $author, $description);
482

Dries Buytaert's avatar
   
Dries Buytaert committed
483
484
    // Prepare the item:
    foreach ($item as $key => $value) {
485
486
487
488
489
490
      // 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
491
    }
Dries Buytaert's avatar
Dries Buytaert committed
492

Dries Buytaert's avatar
   
Dries Buytaert committed
493
494
495
496
497
498
    /*
    ** 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
499
500
    if ($item['TITLE']) {
      $title = $item['TITLE'];
Dries Buytaert's avatar
   
Dries Buytaert committed
501
502
    }
    else {
Dries Buytaert's avatar
   
Dries Buytaert committed
503
      $title = preg_replace('/^(.*)[^\w;&].*?$/', "\\1", truncate_utf8($item['DESCRIPTION'], 40));
Dries Buytaert's avatar
   
Dries Buytaert committed
504
    }
Dries Buytaert's avatar
   
Dries Buytaert committed
505

Dries Buytaert's avatar
   
Dries Buytaert committed
506
507
508
509
    /*
    ** Resolve the items link.
    */

Dries Buytaert's avatar
   
Dries Buytaert committed
510
511
    if ($item['LINK']) {
      $link = $item['LINK'];
Dries Buytaert's avatar
   
Dries Buytaert committed
512
    }
Dries Buytaert's avatar
   
Dries Buytaert committed
513
514
    elseif ($item['GUID'] && (strncmp($item['GUID'], 'http://', 7) == 0)) {
      $link = $item['GUID'];
Dries Buytaert's avatar
   
Dries Buytaert committed
515
516
    }
    else {
Dries Buytaert's avatar
   
Dries Buytaert committed
517
      $link = $feed['link'];
Dries Buytaert's avatar
   
Dries Buytaert committed
518
    }
519

Dries Buytaert's avatar
   
Dries Buytaert committed
520
521
522
523
524
525
526
527
528
529
    /*
    ** 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
530
    else $date = 'now';
Dries Buytaert's avatar
   
Dries Buytaert committed
531

Dries Buytaert's avatar
   
Dries Buytaert committed
532
    $timestamp = strtotime($date); // strtotime() returns -1 on failure
Dries Buytaert's avatar
   
Dries Buytaert committed
533
    if ($timestamp < 0) {
Dries Buytaert's avatar
   
Dries Buytaert committed
534
535
536
537
      $timestamp = aggregator_parse_w3cdtf($date); // also returns -1 on failure
      if ($timestamp < 0) {
        $timestamp = time(); // better than nothing
      }
538
    }
Dries Buytaert's avatar
   
Dries Buytaert committed
539
540

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

Dries Buytaert's avatar
   
Dries Buytaert committed
546
547
    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
548
549
    }
    else {
Dries Buytaert's avatar
   
Dries Buytaert committed
550
      $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
551
    }
Dries Buytaert's avatar
   
Dries Buytaert committed
552

553
    if (!valid_input_data($item['DESCRIPTION'])) {
Dries Buytaert's avatar
   
Dries Buytaert committed
554
      drupal_set_message(t('Failed to parse entry from %site feed: suspicious input data.', array('%site' => '<em>'. $feed['title'] .'</em>')), 'error');
555
556
557
558
    }
    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
559
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
560

Dries Buytaert's avatar
   
Dries Buytaert committed
561
  /*
Dries Buytaert's avatar
   
Dries Buytaert committed
562
  ** Remove all items that are older than 3 months:
Dries Buytaert's avatar
   
Dries Buytaert committed
563
  */
Dries Buytaert's avatar
   
Dries Buytaert committed
564

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

568
569
570
571
572
573
574
  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
575
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
576
577

  return 1;
578
579
}

580
function aggregator_save_item($edit) {
Dries Buytaert's avatar
   
Dries Buytaert committed
581
  if ($edit['iid'] && $edit['title']) {
Dries Buytaert's avatar
   
Dries Buytaert committed
582
    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']);
583
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
584
585
586
  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']);
587
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
588
  else if ($edit['title'] && $edit['link']) {
Dries Buytaert's avatar
   
Dries Buytaert committed
589
590
    $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
591
592
593
    // 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
594
      db_query('INSERT INTO {aggregator_category_item} (cid, iid) VALUES (%d, %d)', $category->cid, $edit['iid']);
Dries Buytaert's avatar
   
Dries Buytaert committed
595
    }
596
597
598
  }
}

Dries Buytaert's avatar
   
Dries Buytaert committed
599
600
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'));
601

Dries Buytaert's avatar
   
Dries Buytaert committed
602
603
  $form = form_textfield(t('Title'), 'title', $edit['title'], 50, 64);
  $form .= form_textarea(t('Description'), 'description', $edit['description'], 60, 5);
604
  $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
605
  $form .= form_submit(t('Submit'));
606

Dries Buytaert's avatar
   
Dries Buytaert committed
607
608
609
  if ($edit['cid']) {
    $form .= form_submit(t('Delete'));
    $form .= form_hidden('cid', $edit['cid']);
610
611
  }

Dries Buytaert's avatar
   
Dries Buytaert committed
612
  return form($form);
613
614
}

Dries Buytaert's avatar
   
Dries Buytaert committed
615
616
617
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']);
618
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
619
620
  else if ($edit['cid']) {
    db_query('DELETE FROM {aggregator_category} WHERE cid = %d', $edit['cid']);
621
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
622
  else if ($edit['title']) {
Dries Buytaert's avatar
   
Dries Buytaert committed
623
    // a single unique id for bundles and feeds, to use in blocks
Dries Buytaert's avatar
   
Dries Buytaert committed
624
625
    $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']);
626
627
628
  }
}

629
function aggregator_form_feed($edit = array()) {
Dries Buytaert's avatar
   
Dries Buytaert committed
630
  $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
631
  $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'));
632

Dries Buytaert's avatar
   
Dries Buytaert committed
633
634
  if ($edit['refresh'] == '') {
    $edit['refresh'] = 3600;
Dries Buytaert's avatar
   
Dries Buytaert committed
635
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
636

Dries Buytaert's avatar
   
Dries Buytaert committed
637
  $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.'));
638
  $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
639
  $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.'));
640
  $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
641
  $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
642
643
644
645
  while ($category = db_fetch_object($categories)) {
    $checkboxes .= form_checkbox($category->title, "category][$category->cid", 1, $category->fid ? 1 : 0);
  }
  if ($checkboxes) {
646
    $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
647
  }
648

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

Dries Buytaert's avatar
   
Dries Buytaert committed
651
652
653
  if ($edit['fid']) {
    $form .= form_submit(t('Delete'));
    $form .= form_hidden('fid', $edit['fid']);
654
655
  }

Dries Buytaert's avatar
   
Dries Buytaert committed
656
  return form($form);
657
658
}

659
function aggregator_save_feed($edit) {
Dries Buytaert's avatar
   
Dries Buytaert committed
660
  if ($edit['fid']) {
661
    // an existing feed is being modified, delete the category listings
Dries Buytaert's avatar
   
Dries Buytaert committed
662
    db_query('DELETE FROM {aggregator_category_feed} WHERE fid = %d', $edit['fid']);
663
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
664
665
  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']);
666
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
667
668
669
670
671
672
673
674
675
676
  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']);
677
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
678
679
680
681
682
683
684
  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
685
686
687
688
689
    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
690
691
      }
    }
692
693
694
  }
}

695
function aggregator_get_feed($fid) {
Dries Buytaert's avatar
   
Dries Buytaert committed
696
  return db_fetch_array(db_query('SELECT * FROM {aggregator_feed} WHERE fid = %d', $fid));
697
698
}

Dries Buytaert's avatar
   
Dries Buytaert committed
699
function aggregator_get_category($cid) {
Dries Buytaert's avatar
   
Dries Buytaert committed
700
  return db_fetch_array(db_query('SELECT * FROM {aggregator_category} WHERE cid = %d', $cid));
701
702
}

703
function aggregator_view() {
Dries Buytaert's avatar
   
Dries Buytaert committed
704
  $result = db_query('SELECT f.*, COUNT(i.iid) AS items FROM {aggregator_feed} f LEFT JOIN {aggregator_item} i ON f.fid = i.fid GROUP BY f.fid, f.title, f.url, f.refresh, f.checked, f.link, f.description, f.etag, f.modified, f.image, f.block ORDER BY f.title');
705

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

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

Dries Buytaert's avatar
   
Dries Buytaert committed
715
  $result = db_query('SELECT c.cid, c.title, count(ci.iid) as items FROM {aggregator_category} c LEFT JOIN {aggregator_category_item} ci ON c.cid = ci.cid GROUP BY c.cid, c.title ORDER BY title');
716

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

Dries Buytaert's avatar
   
Dries Buytaert committed
719
  $header = array(t('Title'), t('Items'), t('Operations'));
Dries Buytaert's avatar
   
Dries Buytaert committed
720
  $rows = array();
Dries Buytaert's avatar
   
Dries Buytaert committed
721
  while ($category = db_fetch_object($result)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
722
    $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"));
723
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
724
  $output .= theme('table', $header, $rows);
725
726
727
728

  return $output;
}

Dries Buytaert's avatar
   
Dries Buytaert committed
729
730
731
732
733
734
735
736
737
738
739
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.'));
    }
740

741
    menu_rebuild();
742
    drupal_goto($_GET['q']);
Dries Buytaert's avatar
   
Dries Buytaert committed
743
744
745
746
747
748
749
750
751
752
753
754
755
756
  }
  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.'));
    }

757
    menu_rebuild();
758
    drupal_goto('aggregator/'. arg(1));
Dries Buytaert's avatar
   
Dries Buytaert committed
759
760
761
762
763
764
765
766
767
768
769
770
771
  }

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

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

/**
832
 * Menu callback; removes all items from a feed, then redirects to the overview page.
Dries Buytaert's avatar
   
Dries Buytaert committed
833
834
835
 */
function aggregator_admin_remove_feed($feed) {
  aggregator_remove(aggregator_get_feed($feed));
836
  drupal_goto('admin/aggregator');
Dries Buytaert's avatar
   
Dries Buytaert committed
837
838
839
}

/**
840
 * Menu callback; refreshes a feed, then redirects to the overview page.
Dries Buytaert's avatar
   
Dries Buytaert committed
841
842
843
 */
function aggregator_admin_refresh_feed($feed) {
  aggregator_refresh(aggregator_get_feed($feed));
844
  drupal_goto('admin/aggregator');
Dries Buytaert's avatar
   
Dries Buytaert committed
845
846
847
}

/**
848
 * Menu callback; displays the aggregator administration page.
Dries Buytaert's avatar
   
Dries Buytaert committed
849
850
851
 */
function aggregator_admin_overview() {
  print theme('page', aggregator_view());
852
853
}

Dries Buytaert's avatar
   
Dries Buytaert committed
854
/**
855
 * Menu callback; displays the most recent items gathered from any feed.
Dries Buytaert's avatar
   
Dries Buytaert committed
856
 */
857
function aggregator_page_last() {
Dries Buytaert's avatar
   
Dries Buytaert committed
858
  _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
859
860
}

Dries Buytaert's avatar
   
Dries Buytaert committed
861
/**
862
 * Menu callback; displays all the items captured from a particular feed.
Dries Buytaert's avatar
   
Dries Buytaert committed
863
 */
864
function aggregator_page_source() {
Dries Buytaert's avatar
   
Dries Buytaert committed
865
  $feed = db_fetch_object(db_query('SELECT * FROM {aggregator_feed} WHERE fid = %d', arg(2)));
Dries Buytaert's avatar
   
Dries Buytaert committed
866
  $info = theme('aggregator_feed', $feed);
Dries Buytaert's avatar
   
Dries Buytaert committed
867

868
  _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
869
870
}

Dries Buytaert's avatar
   
Dries Buytaert committed
871
/**
872
 * Menu callback; displays all the items aggregated in a particular category.
Dries Buytaert's avatar
   
Dries Buytaert committed
873
 */
874
function aggregator_page_category() {
Dries Buytaert's avatar
   
Dries Buytaert committed
875
  $category = db_fetch_object(db_query('SELECT cid, title FROM {aggregator_category} WHERE cid = %d', arg(2)));
Dries Buytaert's avatar
   
Dries Buytaert committed
876

877
  _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
878
}
Dries Buytaert's avatar
   
Dries Buytaert committed
879

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

Dries Buytaert's avatar
   
Dries Buytaert committed
903
904
905
906
907
908
909
  $output = '<div id="aggregator">';
  if ($header) {
    $output .= $header;
  }
  if ($links) {
    $output .= theme('links', $links);
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
910
911
912

  $result = pager_query($sql, 20);

Dries Buytaert's avatar
   
Dries Buytaert committed
913
914
  $rows = array();
  $categories = array();
Dries Buytaert's avatar
   
Dries Buytaert committed
915
  while ($item = db_fetch_object($result)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
    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);