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

Dries's avatar
   
Dries committed
4
5
6
/**
 * Implementation of hook_help().
 */
Dries's avatar
   
Dries committed
7
function aggregator_help($section) {
Dries's avatar
   
Dries committed
8
  switch ($section) {
Kjartan's avatar
Kjartan committed
9
    case 'admin/help#aggregator':
Dries's avatar
   
Dries committed
10
11
      return t('
      <p>Thousands of web sites, especially news sites and weblogs, syndicate their most recent site content for others to display. The syndicated content always includes titles, also known as headlines, for the newest published stories. Each headline acts as a direct link to the stories on the remote site. Along with the headline, most sites typically provide either the first few paragraphs of the story or a short summary. Many individuals use client-based news aggregators on their personal computer to aggregate content, such as <a href="http://www.disobey.com/amphetadesk/">Amphetadesk</a>.</p>
Dries's avatar
   
Dries committed
12
13
      <p>Drupal also has a news aggregator built in as a standard feature. With it, you can subscribe to feeds from other sites and display their content for your site users. Simply enable the aggregator module in site administration and enter the feeds that you choose.</p>
      <h3>What do I need to subscribe to a feed?</h3>
Dries's avatar
   
Dries committed
14
15
16
17
18
19
      <p>The standard method of syndication is using the XML-based <a href="http://blogs.law.harvard.edu/tech/rss">Rich Site Summary</a> (RSS). To syndicate a site\'s content, obtain the full URL of the RSS page providing syndication. Common file tags for RSS pages are .rss, .xml and .rdf. Example: <a href="http://slashdot.org/slashdot.rdf">Slashdot RSS</a>.</p>
      <p>Most weblog sites that offer syndication will have an obvious link on the main page. Often you need only look for a XML syndication button, such as the one Drupal uses for site syndication.</p>
      <p>But some sites do not make their RSS feeds as easy to find. Or maybe you want to find a number of feeds on a given topic, without extensively searching the web. In that case, try an RSS syndication directory such as <a href="http://www.syndic8.com/">Syndic8</a>.</p>
      <p>To learn much 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>.</p>
      <p>NOTE: Enable your site\'s XML syndication button by turning on the Syndicate block in block management.</p>
      <h3>Adding news feeds</h3>
Dries's avatar
   
Dries committed
20
21
      <p>To subscribe to an RSS feed on another site, use the <a href="%admin-news">aggregation page</a>.</p>
      <p>Once there, click the <a href="%new-feed">new feed</a> tab.  Drupal will then ask for the following:</p>
Dries's avatar
   
Dries committed
22
      <ul>
Dries's avatar
   
Dries committed
23
24
25
26
       <li><strong>Title</strong> -- The text entered here will be used in your news aggregator, within the administration configuration section, and as 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 URL for the feed for the site you want to subscribe to.</li>
       <li><strong>Update interval</strong> -- The update interval is how often Drupal will automatically access the RSS URL for the site for fresh content. The 1 hour default is typically the minimum you will want to use. Accessing another site\'s RSS page more frequently can be considered impolite. After all, it does require the other site\'s server handle your requests. To use this feature cron.php must be called regularly, otherwise, you\'ll have to manually update feeds one at a time within the news aggregation administration section by using <a href="%update-items">update items</a>.</li>
       <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>
27
       <li><strong>Automatically file items</strong> -- As items are received from a feed they will be put in the checked categories.</li>
Dries's avatar
   
Dries committed
28
      </ul>
Dries's avatar
   
Dries committed
29
      <p>Once you submit your new feed, check to see if it is working properly. Select <a href="%update-items">update items</a> on the <a href="%admin-news">aggregation page</a>. If you do not see any items listed for that feed, edit the feed and make sure that the URL was entered correctly.</p>
Dries's avatar
   
Dries committed
30
      <h3>Adding categories</h3>
Dries's avatar
   
Dries committed
31
      <p>News items can be filed into categories. To create a category, start at the <a href="%admin-news">aggregation page</a>.</p>
Dries's avatar
   
Dries committed
32
      <p>Once there, select <a href="%new-category">new category</a> from the menu. Drupal will then ask for the following:</p>
Dries's avatar
   
Dries committed
33
      <ul>
Dries's avatar
   
Dries committed
34
35
36
       <li><strong>Title</strong> -- The title will be used in the <i>news by topics</i> listing in your news aggregator and with the customized block created for the bundle.</li>
       <li><strong>Description</strong> -- A short description of the category to tell users more details about what they might find filed in the category.</li>
       <li><strong>Latest items block</strong> -- The number of items selected here will determine how many of the latest items from the category will appear in a block which may be enabled and placed in the <a href="%block">blocks</a> administration page.</li>
Dries's avatar
   
Dries committed
37
38
39
40
      </ul>
      <h3>Using the news aggregator</h3>
      <p>The news aggregator has a number of ways that it displays your subscribed content:</p>
      <ul>
Dries's avatar
   
Dries committed
41
42
43
       <li><strong><a href="%news-aggregator">News aggregator</a></strong> (latest news) -- Displays all incoming content in the order received.</li>
       <li><strong><a href="%sources">Sources</a></strong> -- Organizes incoming content by feed, displaying feed titles which link to a page of the latest items from the feed and item titles which link to the originating post.</li>
       <li><strong><a href="%categories">Categories</a></strong> -- Organizes incoming content by category, displaying category titles which link to a page of the latest items from the category and item titles which link to the originating post.</li>
Dries's avatar
   
Dries committed
44
      </ul>
Dries's avatar
   
Dries committed
45
46
47
48
49
50
51
      <p>Pages which show the latest items in either a source, category, or of all items contain the following information for each item:
      <ul>
       <li>The title of the original post.</li>
       <li>The categories which the item is filed in, which are links to view the category page with items from that category only.</li>
       <li>A description, the first few paragraphs or summary of the originating post (if any).</li>
       <li>The name of the source, which acts as a link to an individual feed page, listing information about that feed and incoming content for that feed only. This is not shown on feed pages.</li>
      </ul>
52
      <p>Additionally, users with the administer news feeds permission will see a link to categorize the news items. Clicking this will add a right hand column to select the categories which each news item is in.</p>
Dries's avatar
   
Dries committed
53
      <h3>Technical details</h3>
Dries's avatar
   
Dries committed
54
      <p>Drupal automatically generates an OPML feed file that is available by selecting the XML icon on the News Sources page.</p>
Dries's avatar
   
Dries committed
55
      <p>When fetching feeds Drupal supports conditional GETs, this reduces the bandwidth usage for feeds that have not been updated since the last check.</p>
Dries's avatar
   
Dries committed
56
57
      <p>If a feed is permanently moved to a new location Drupal will automatically update the feed URL to the new address.</p>', array('%block' => url('admin/block'), '%admin-news' => url('admin/aggregator'), '%new-feed' => url('admin/aggregator/add/feed'), '%new-category' => url('admin/aggregator/add/category'), '%update-items' => url('admin/aggregator'), '%news-aggregator' => url('aggregator'), '%sources' => url('aggregator/sources'), '%categories' => url('aggregator/categories')));
    case 'admin/modules#description':
Dries's avatar
   
Dries committed
58
      return t('Used to aggregate syndicated content (RSS and RDF).');
Dries's avatar
   
Dries committed
59
    case 'admin/aggregator':
60
      return t('Several web sites, especially news related sites, syndicate parts of their site\'s content for other web sites to display. Usually, the syndicated content includes the latest headlines with a direct link to that story on the remote site. Some syndicated content also includes a description of the headline. The standard method of syndication is using the XML based Rich Site Summary (RSS) or Resource Description Framework (RDF).  To get a feed to work you <strong>must</strong> have <a href=\"%cron\">cron</a> working. To display the feed or category in a block you must decide how many items to show by editing the feed or block and turn on the <a href="%block">feed\'s block</a>.', array('%block' => url('admin/block'), '%cron' => url('admin/help', NULL, 'cron')));
Dries's avatar
   
Dries committed
61
    case 'admin/aggregator/add/feed':
Dries's avatar
   
Dries committed
62
      return t('Add a site that has an RSS/RDF feed. The URL is the full path to the RSS feed file. For the feed to update automatically you must run "cron.php". If you already have a feed with the URL you are planning to use, the system will not accept another feed with the same URL.');
Dries's avatar
   
Dries committed
63
    case 'admin/aggregator/add/category':
64
      return t('Categories provide a generalized way of creating composite news pages or blocks. They allow you, for example, to combine various sport-related items into one category called <i>Sports</i>. News items can be added to a category automatically by setting a feed to automatically place items in a category or by using the categorize items link in any listing of news items.');
65
66
    case 'admin/aggregator/configure':
      return t('These settings control the display of aggregated content.');
Dries's avatar
   
Dries committed
67
  }
68
69
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  return $items;
196
197
}

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

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

Dries's avatar
   
Dries committed
253
254
255
256
function aggregator_remove($feed) {
  $result = db_query('SELECT iid FROM {aggregator_item} WHERE fid = %d', $feed['fid']);
  while ($item = db_fetch_object($result)) {
    $items[] = "iid = $item->iid";
Dries's avatar
   
Dries committed
257
  }
Dries's avatar
   
Dries committed
258
259
  if ($items) {
    db_query('DELETE FROM {aggregator_category_item} WHERE '. implode(' OR ', $items));
Dries's avatar
   
Dries committed
260
  }
Dries's avatar
   
Dries committed
261
  db_query('DELETE FROM {aggregator_item} WHERE fid = %d', $feed['fid']);
Kjartan's avatar
Kjartan committed
262
  db_query("UPDATE {aggregator_feed} SET checked = 0, etag = '', modified = 0 WHERE fid = %d", $feed['fid']);
Dries's avatar
   
Dries committed
263
  drupal_set_message(t('removed news items from \'%site\'.', array('%site' => $feed['title'])));
Dries's avatar
   
Dries committed
264
265
}

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

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

  $tag = $name;
}

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

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

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

  switch ($element) {
Dries's avatar
   
Dries committed
306
    case 'ITEM':
Dries's avatar
   
Dries committed
307
308
      $items[$item][$tag] .= $data;
      break;
Dries's avatar
   
Dries committed
309
    case 'IMAGE':
Dries's avatar
   
Dries committed
310
311
      $image[$tag] .= $data;
      break;
Dries's avatar
   
Dries committed
312
313
314
    case 'TEXTINPUT':
      // The sub-element is not supported. However, we must recognize
      // it or its contents will end up in the item array.
Dries's avatar
   
Dries committed
315
316
317
      break;
    default:
      $channel[$tag] .= $data;
318
319
320
  }
}

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

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

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

339
  // Process HTTP response code.
Dries's avatar
   
Dries committed
340
341
  switch ($result->code) {
    case 304:
Dries's avatar
   
Dries committed
342
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's avatar
   
Dries committed
344
      break;
Dries's avatar
   
Dries committed
345
346
    case 301:
      $feed['url'] = $result->redirect_url;
347
      watchdog('special', t('aggregator: updated URL for feed "%title" to %url', array('%title' => $feed[title], '%url' => $feed[url])));
Dries's avatar
   
Dries committed
348
349
350
351
    case 200:
    case 302:
    case 307:
      // Filter the input data:
352
     if (aggregator_parse_feed($result->data, $feed)) {
353

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

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

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

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

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

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

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

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

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

Dries's avatar
   
Dries committed
397
function aggregator_parse_feed(&$data, $feed) {
Dries's avatar
   
Dries committed
398
  global $items, $image, $channel;
Dries's avatar
   
Dries committed
399

Dries's avatar
   
Dries committed
400
  // Unset the global variables before we use them:
Dries's avatar
   
Dries committed
401
  unset($GLOBALS['element'], $GLOBALS['item'], $GLOBALS['tag']);
Dries's avatar
   
Dries committed
402
  $items = array();
Dries's avatar
   
Dries committed
403
  $image = array();
Dries's avatar
   
Dries committed
404
  $channel = array();
405

Dries's avatar
   
Dries committed
406
407
  // parse the data:
  $xml_parser = drupal_xml_parser_create($data);
Dries's avatar
   
Dries committed
408
409
  xml_set_element_handler($xml_parser, 'aggregator_element_start', 'aggregator_element_end');
  xml_set_character_data_handler($xml_parser, 'aggregator_element_data');
Dries's avatar
   
Dries committed
410

Dries's avatar
   
Dries committed
411
  if (!xml_parse($xml_parser, $data, 1)) {
412
    watchdog('error', t('aggregator: failed to parse RSS feed "%site": %error at line %line.', array('%site' => $feed['title'], '%error' => xml_error_string(xml_get_error_code($xml_parser)), '%line' => xml_get_current_line_number($xml_parser))));
Dries's avatar
   
Dries committed
413
    $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's avatar
   
Dries committed
414
415
    drupal_set_message($message, 'error');
    return 0;
Dries's avatar
   
Dries committed
416
417
  }
  xml_parser_free($xml_parser);
Dries's avatar
   
Dries committed
418

Dries's avatar
   
Dries committed
419
  // initialize the translation table:
420
  $tt = array_flip(get_html_translation_table(HTML_SPECIALCHARS));
Dries's avatar
   
Dries committed
421
  $tt['&apos;'] = "'";
Dries's avatar
   
Dries committed
422

Dries's avatar
   
Dries committed
423
424
425
426
427
  /*
  ** We reverse the array such that we store the first item last,
  ** and the last item first.  In the database, the newest item
  ** should be at the top.
  */
Dries's avatar
   
Dries committed
428

Dries's avatar
   
Dries committed
429
  $items = array_reverse($items);
Dries's avatar
   
Dries committed
430

Dries's avatar
   
Dries committed
431
432
  foreach ($items as $item) {
    unset($title, $link, $author, $description);
433

Dries's avatar
   
Dries committed
434
435
436
437
    // Prepare the item:
    foreach ($item as $key => $value) {
      $item[$key] = filter_default(strtr(trim($value), $tt));
    }
Dries's avatar
Dries committed
438

Dries's avatar
   
Dries committed
439
440
441
442
443
444
    /*
    ** Resolve the item's title.  If no title is found, we use
    ** up to 40 characters of the description ending at a word
    ** boundary but not splitting potential entities.
    */

Dries's avatar
   
Dries committed
445
446
    if ($item['TITLE']) {
      $title = $item['TITLE'];
Dries's avatar
   
Dries committed
447
448
    }
    else {
Dries's avatar
   
Dries committed
449
      $title = preg_replace('/^(.*)[^\w;&].*?$/', "\\1", truncate_utf8($item['DESCRIPTION'], 40));
Dries's avatar
   
Dries committed
450
    }
Dries's avatar
   
Dries committed
451

Dries's avatar
   
Dries committed
452
453
454
455
    /*
    ** Resolve the items link.
    */

Dries's avatar
   
Dries committed
456
457
    if ($item['LINK']) {
      $link = $item['LINK'];
Dries's avatar
   
Dries committed
458
    }
Dries's avatar
   
Dries committed
459
460
    elseif ($item['GUID'] && (strncmp($item['GUID'], 'http://', 7) == 0)) {
      $link = $item['GUID'];
Dries's avatar
   
Dries committed
461
462
    }
    else {
Dries's avatar
   
Dries committed
463
      $link = $feed['link'];
Dries's avatar
   
Dries committed
464
    }
465

Dries's avatar
   
Dries committed
466
467
468
469
470
471
472
473
474
475
    /*
    ** Try to resolve and parse the item's publication date.  If no
    ** date is found, we use the current date instead.
    */

    if ($item['PUBDATE']) $date = $item['PUBDATE'];                        // RSS 2.0
    else if ($item['DC:DATE']) $date = $item['DC:DATE'];                   // Dublin core
    else if ($item['DCTERMS:ISSUED']) $date = $item['DCTERMS:ISSUED'];     // Dublin core
    else if ($item['DCTERMS:CREATED']) $date = $item['DCTERMS:CREATED'];   // Dublin core
    else if ($item['DCTERMS:MODIFIED']) $date = $item['DCTERMS:MODIFIED']; // Dublin core
Dries's avatar
   
Dries committed
476
    else $date = 'now';
Dries's avatar
   
Dries committed
477
478
479
480
481
482
483
484
485

    $timestamp = strtotime($date);  // strtotime() returns -1 on failure

    if ($timestamp < 0) {
      /*
      ** The Dublin core's default data format uses ISO 8601 which can't
      ** be parsed directly using PHP's strtotime().  It is not the only
      ** valid format so this might fail nonetheless ...
      */
Dries's avatar
   
Dries committed
486
      list($year, $month, $day, $hour, $minute, $second) = sscanf($date, '%4d-%2d-%2dT%2d:%2d:%2d');
Dries's avatar
   
Dries committed
487
488
489
490
      $timestamp = strtotime("$year-$month-$day $hour:$minute:$second");
    }

    if ($timestamp < 0) {
Dries's avatar
   
Dries committed
491
      $timestamp = time();
492
    }
Dries's avatar
   
Dries committed
493
494

    /*
Dries's avatar
   
Dries committed
495
496
497
    ** Save this item.  Try to avoid duplicate entries as much as
    ** possible.  If we find a duplicate entry, we resolve it and
    ** pass along it's ID such that we can update it if needed.
Dries's avatar
   
Dries committed
498
499
    */

Dries's avatar
   
Dries committed
500
501
    if ($link && $link != $feed['link'] && $link != $feed['url']) {
      $entry = db_fetch_object(db_query("SELECT iid FROM {aggregator_item} WHERE fid = %d AND link = '%s'", $feed['fid'], $link));
Dries's avatar
   
Dries committed
502
503
    }
    else {
Dries's avatar
   
Dries committed
504
      $entry = db_fetch_object(db_query("SELECT iid FROM {aggregator_item} WHERE fid = %d AND title = '%s'", $feed['fid'], $title));
Dries's avatar
   
Dries committed
505
    }
Dries's avatar
   
Dries committed
506

507
508
509
510
511
512
    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's avatar
   
Dries committed
513
  }
Dries's avatar
   
Dries committed
514

Dries's avatar
   
Dries committed
515
  /*
Dries's avatar
   
Dries committed
516
  ** Remove all items that are older than 3 months:
Dries's avatar
   
Dries committed
517
  */
Dries's avatar
   
Dries committed
518

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

522
523
524
525
526
527
528
  if (db_num_rows($result)) {
    $items = array();
    while ($item = db_fetch_object($result)) {
      $items[] = $item->iid;
    }
    db_query('DELETE FROM {aggregator_category_item} WHERE iid IN ('. implode(', ', $items) .')');
    db_query('DELETE FROM {aggregator_item} WHERE fid = %d AND timestamp < %d', $feed['fid'], $age);
Dries's avatar
   
Dries committed
529
  }
Dries's avatar
   
Dries committed
530
531

  return 1;
532
533
}

Kjartan's avatar
Kjartan committed
534
function aggregator_save_item($edit) {
Dries's avatar
   
Dries committed
535
536
  if ($edit['iid'] && $edit['title']) {
    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']);
537
  }
Dries's avatar
   
Dries committed
538
539
540
  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']);
541
  }
Dries's avatar
   
Dries committed
542
543
544
  else if ($edit['title'] && $edit['link']) {
    $next_id = 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)", $next_id, $edit['fid'], $edit['title'], $edit['link'], $edit['author'], $edit['description'], $edit['timestamp']);
Dries's avatar
   
Dries committed
545
546
547
548
549
    // 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)) {
      db_query('INSERT INTO {aggregator_category_item} (cid, iid) VALUES (%d, %d)', $category->cid, $next_id);
    }
550
551
552
  }
}

Dries's avatar
   
Dries committed
553
554
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'));
555

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

Dries's avatar
   
Dries committed
561
562
563
  if ($edit['cid']) {
    $form .= form_submit(t('Delete'));
    $form .= form_hidden('cid', $edit['cid']);
564
565
  }

Dries's avatar
   
Dries committed
566
  return form($form);
567
568
}

Dries's avatar
   
Dries committed
569
570
571
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']);
572
  }
Dries's avatar
   
Dries committed
573
574
  else if ($edit['cid']) {
    db_query('DELETE FROM {aggregator_category} WHERE cid = %d', $edit['cid']);
575
  }
Dries's avatar
   
Dries committed
576
  else if ($edit['title']) {
Dries's avatar
   
Dries committed
577
    // a single unique id for bundles and feeds, to use in blocks
Dries's avatar
   
Dries committed
578
579
    $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']);
580
581
582
  }
}

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

Dries's avatar
   
Dries committed
587
588
  if ($edit['refresh'] == '') {
    $edit['refresh'] = 3600;
Dries's avatar
   
Dries committed
589
  }
Dries's avatar
   
Dries committed
590

Dries's avatar
   
Dries committed
591
  $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.'));
592
  $form .= form_textfield(t('URL'), 'url', $edit['url'], 50, 255, t('The fully-qualified URL of the feed.'));
Dries's avatar
   
Dries committed
593
  $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.'));
594
  $form .= form_select(t('Latest items block'), 'block', $edit['block'], $block_items, t('If enabled, a block containing the latest items from this feed will be available for placement on the <a href="%url">block configuration</a> page.', array('%url' => url('admin/block'))));
Dries's avatar
   
Dries committed
595
  $categories = db_query('SELECT c.cid, c.title, f.fid FROM {aggregator_category} c LEFT JOIN {aggregator_category_feed} f ON c.cid = f.cid AND f.fid = %d ORDER BY title', $edit['fid']);
Dries's avatar
   
Dries committed
596
597
598
599
  while ($category = db_fetch_object($categories)) {
    $checkboxes .= form_checkbox($category->title, "category][$category->cid", 1, $category->fid ? 1 : 0);
  }
  if ($checkboxes) {
600
    $form .= form_group(t('Automatically file items'), $checkboxes, t('New items in this feed will be automatically filed in the the checked categories as they are received.'));
Dries's avatar
   
Dries committed
601
  }
602

Dries's avatar
   
Dries committed
603
  $form .= form_submit(t('Submit'));
604

Dries's avatar
   
Dries committed
605
606
607
  if ($edit['fid']) {
    $form .= form_submit(t('Delete'));
    $form .= form_hidden('fid', $edit['fid']);
608
609
  }

Dries's avatar
   
Dries committed
610
  return form($form);
611
612
}

Kjartan's avatar
Kjartan committed
613
function aggregator_save_feed($edit) {
Dries's avatar
   
Dries committed
614
  if ($edit['fid']) {
615
    // an existing feed is being modified, delete the category listings
Dries's avatar
   
Dries committed
616
    db_query('DELETE FROM {aggregator_category_feed} WHERE fid = %d', $edit['fid']);
617
  }
Dries's avatar
   
Dries committed
618
619
  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']);
620
  }
Dries's avatar
   
Dries committed
621
622
623
624
625
626
627
628
629
630
  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']);
631
  }
Dries's avatar
   
Dries committed
632
633
634
635
636
637
638
  else if ($edit['title']) {
    // a single unique id for bundles and feeds, to use in blocks
    $edit['fid'] = db_next_id('{aggregator_feed}_fid');
    db_query('INSERT INTO {aggregator_feed} (fid, title, url, refresh, block) VALUES (%d, \'%s\', \'%s\', %d, %d)', $edit['fid'], $edit['title'], $edit['url'], $edit['refresh'], $edit['block']);
  }
  if ($edit['title']) {
    // the feed is being saved, save the categories as well
Dries's avatar
Dries committed
639
640
641
642
643
    if ($edit['category']) {
      foreach ($edit['category'] as $cid => $checked) {
        if ($checked) {
          db_query('INSERT INTO {aggregator_category_feed} (fid, cid) VALUES (%d, %d)', $edit['fid'], $cid);
        }
Dries's avatar
   
Dries committed
644
645
      }
    }
646
647
648
  }
}

Kjartan's avatar
Kjartan committed
649
function aggregator_get_feed($fid) {
Dries's avatar
   
Dries committed
650
  return db_fetch_array(db_query('SELECT * FROM {aggregator_feed} WHERE fid = %d', $fid));
651
652
}

Dries's avatar
   
Dries committed
653
function aggregator_get_category($cid) {
Dries's avatar
   
Dries committed
654
  return db_fetch_array(db_query('SELECT * FROM {aggregator_category} WHERE cid = %d', $cid));
655
656
}

Kjartan's avatar
Kjartan committed
657
function aggregator_view() {
Dries's avatar
   
Dries committed
658
  $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');
659

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

Dries's avatar
   
Dries committed
662
  $header = array(t('title'), t('items'), t('last update'), t('next update'), array('data' => t('operations'), 'colspan' => 3));
Dries's avatar
   
Dries committed
663
  $rows = array();
664
  while ($feed = db_fetch_object($result)) {
Dries's avatar
   
Dries committed
665
    $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 feed'), "admin/aggregator/edit/feed/$feed->fid"), l(t('remove items'), "admin/aggregator/remove/$feed->fid"), l(t('update items'), "admin/aggregator/update/$feed->fid"));
666
  }
Dries's avatar
   
Dries committed
667
  $output .= theme('table', $header, $rows);
668

Dries's avatar
   
Dries committed
669
  $result = db_query('SELECT * FROM {aggregator_category} ORDER BY title');
670

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

Dries's avatar
   
Dries committed
673
  $header = array(t('title'), t('operations'));
Dries's avatar
   
Dries committed
674
  $rows = array();
Dries's avatar
   
Dries committed
675
  while ($category = db_fetch_object($result)) {
Dries's avatar
   
Dries committed
676
    $rows[] = array(l($category->title, "aggregator/categories/$category->cid"), l(t('edit category'), "admin/aggregator/edit/category/$category->cid"));
677
  }
Dries's avatar
   
Dries committed
678
  $output .= theme('table', $header, $rows);
679
680
681
682

  return $output;
}

Dries's avatar
   
Dries committed
683
684
685
686
687
688
689
690
691
692
693
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.'));
    }
694
695

    drupal_goto($_GET['q']);
Dries's avatar
   
Dries committed
696
697
698
699
700
701
702
703
704
705
706
707
708
709
  }
  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.'));
    }

710
    drupal_goto('aggregator/'. arg(1));
Dries's avatar
   
Dries committed
711
712
713
714
715
716
717
718
719
720
721
722
723
  }

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

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


Dries's avatar
   
Dries committed
724
/**
Dries's avatar
Dries committed
725
 * Menu callback; displays the category edit form, or saves changes and
726
 * redirects to the overview page.
Dries's avatar
   
Dries committed
727
728
729
730
731
732
733
734
735
736
737
 */
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);
738
739
740
      drupal_set_message($edit['title'] ? t('The category has been updated.') : t('The category has been deleted.'));
      drupal_goto('admin/aggregator');
      break;
Dries's avatar
   
Dries committed
741
742
743
    default:
      if ($category) {
        $output = aggregator_form_category(aggregator_get_category($category));
Dries's avatar
   
Dries committed
744
745
      }
      else {
Dries's avatar
   
Dries committed
746
        $output = aggregator_form_category();
Dries's avatar
   
Dries committed
747
      }
Dries's avatar
   
Dries committed
748
749
750
751
752
  }
  print theme('page', $output);
}

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

/**
782
 * Menu callback; removes all items from a feed, then redirects to the overview page.
Dries's avatar
   
Dries committed
783
784
785
 */
function aggregator_admin_remove_feed($feed) {
  aggregator_remove(aggregator_get_feed($feed));
786
  drupal_goto('admin/aggregator');
Dries's avatar
   
Dries committed
787
788
789
}

/**
790
 * Menu callback; refreshes a feed, then redirects to the overview page.
Dries's avatar
   
Dries committed
791
792
793
 */
function aggregator_admin_refresh_feed($feed) {
  aggregator_refresh(aggregator_get_feed($feed));
794
  drupal_goto('admin/aggregator');
Dries's avatar
   
Dries committed
795
796
797
}

/**
Dries's avatar
Dries committed
798
 * Menu callback; displays the aggregator administration page.
Dries's avatar
   
Dries committed
799
800
801
 */
function aggregator_admin_overview() {
  print theme('page', aggregator_view());
802
803
}

Dries's avatar
   
Dries committed
804
/**
Dries's avatar
Dries committed
805
 * Menu callback; displays the most recent items gathered from any feed.
Dries's avatar
   
Dries committed
806
 */
807
function aggregator_page_last() {
Dries's avatar
   
Dries committed
808
  _aggregator_page_list('SELECT i.*, f.title AS ftitle, f.link AS flink FROM {aggregator_item} i INNER JOIN {aggregator_feed} f ON i.fid = f.fid ORDER BY i.timestamp DESC, i.iid DESC', arg(1));
Dries's avatar
   
Dries committed
809
810
}

Dries's avatar
   
Dries committed
811
/**
Dries's avatar
Dries committed
812
 * Menu callback; displays all the items captured from a particular feed.
Dries's avatar
   
Dries committed
813
 */
814
function aggregator_page_source() {
Dries's avatar
   
Dries committed
815
  $feed = db_fetch_object(db_query('SELECT * FROM {aggregator_feed} WHERE fid = %d', arg(2)));
Dries's avatar
   
Dries committed
816
  $info = theme('aggregator_feed', $feed);
Dries's avatar
   
Dries committed
817

818
  _aggregator_page_list('SELECT * FROM {aggregator_item} WHERE fid = '. $feed->fid .' ORDER BY timestamp DESC, iid DESC', arg(3), "<div class=\"feed\">$info</div>");
Dries's avatar
   
Dries committed
819
820
}

Dries's avatar
   
Dries committed
821
/**
Dries's avatar
Dries committed
822
 * Menu callback; displays all the items aggregated in a particular category.
Dries's avatar
   
Dries committed
823
 */
824
function aggregator_page_category() {
Dries's avatar
   
Dries committed
825
  $category = db_fetch_object(db_query('SELECT cid, title FROM {aggregator_category} WHERE cid = %d', arg(2)));
Dries's avatar
   
Dries committed
826

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

Dries's avatar
   
Dries committed
830
831
832
833
/**
 * Prints an aggregator page listing a number of feed items. Various
 * menu callbacks use this function to print their feeds.
 */
Dries's avatar
   
Dries committed
834
function _aggregator_page_list($sql, $op, $header = '') {
Dries's avatar
   
Dries committed
835
836
837
838
839
840
841
842
843
844
  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);
          }
        }
      }
845
846
      drupal_set_message(t('The categories have been saved.'));
      drupal_goto($_GET['q']);
Dries's avatar
   
Dries committed
847
848
849
850
851
    }
    else {
      $categorize = true;
    }
  }
Dries's avatar
   
Dries committed
852

Dries's avatar
   
Dries committed
853
854
855
856
857
858
859
  $output = '<div id="aggregator">';
  if ($header) {
    $output .= $header;
  }
  if ($links) {
    $output .= theme('links', $links);
  }
Dries's avatar
   
Dries committed
860
861
862

  $result = pager_query($sql, 20);

Dries's avatar
   
Dries committed
863
864
  $rows = array();
  $categories = array();
Dries's avatar
   
Dries committed
865
  while ($item = db_fetch_object($result)) {
Dries's avatar
   
Dries committed
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
    if ($categorize) {
      $categories_result = db_query('SELECT c.cid, c.title, ci.iid FROM {aggregator_category} c LEFT JOIN {aggregator_category_item} ci ON c.cid = ci.cid AND ci.iid = %d', $item->iid);
      if (variable_get('aggregator_category_selector', 'check') == 'select') {
        $selected = array();
        while ($category = db_fetch_object($categories_result)) {
          if (!$done) {
            $categories[$category->cid] = check_form($category->title);
          }
          if ($category->iid) {
            $selected[] = $category->cid;
          }
        }
        $done = true;
        $form = form_select(NULL, 'categories]['. $item->iid, $selected, $categories, NULL, 'size="10"', true);
      }
      else {
        $form = '';
        while ($category = db_fetch_object($categories_result)) {
          $form .= form_checkbox(check_form($category->title), 'categories]['. $item->iid .'][', $category->cid, !is_null($category->iid));
        }
      }
      $rows[] = array(theme('aggregator_page_item', $item), array('data' => $form, 'class' => 'categorize-item'));
    }
    else {
      $output .= theme('aggregator_page_item', $item);
    }
Dries's avatar
   
Dries committed
892
  }
Dries's avatar
   
Dries committed
893
894
895
896
  if ($categorize) {
    $output .= form(theme('table', array('', t('categorize')), $rows) . form_submit(t('Save categories')));
  }
  $output .= '</div>';
Dries's avatar
   
Dries committed
897
898
899
900
901

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

Dries's avatar
   
Dries committed
902
  print theme('page', $output);
Dries's avatar
   
Dries committed
903
904
}

Dries's avatar
   
Dries committed
905
/**
Dries's avatar
Dries committed
906
 * Menu callback; displays all the feeds used by the aggregator.
Dries's avatar
   
Dries committed
907
 */
Kjartan's avatar
Kjartan committed
908
function aggregator_page_sources() {
Dries's avatar
   
Dries committed
909
910
  $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');
  $output = '<div id="aggregator">';
Dries's avatar
   
Dries committed
911
  while ($feed = db_fetch_object($result)) {
Dries's avatar
   
Dries committed
912
913
914
915
916
917
918
919
920
921
922
923
    $output .= "<h2>$feed->title</h2>";

    // Most recent items:
    $list = array();
    if (variable_get('aggregator_summary_items', 3)) {
      $items = db_query_range('SELECT i.title, i.timestamp, i.link FROM {aggregator_item} i WHERE i.fid = %d ORDER BY i.timestamp DESC', $feed->fid, 0, variable_get('aggregator_summary_items', 3));
      while ($item = db_fetch_object($items)) {
        $list[] = '<a href="'. check_url($item->link) .'">'. $item->title .'</a> <span class="age">'. t('%age old', array('%age' => format_interval(time() - $item->timestamp))) .'</span>';
      }
    }
    $output .= theme('item_list', $list);
    $output .= '<div class="more-link">'. l(t('more'), 'aggregator/sources/'. $feed->fid) .'</div>';
Dries's avatar
   
Dries committed
924
  }
Dries's avatar
   
Dries committed
925
  $output .= theme('xml_icon', url('aggregator/opml'));
Dries's avatar
   
Dries committed
926
927
  $output .= '</div>';
  print theme('page', $output);
Dries's avatar
   
Dries committed
928
929
}

Dries's avatar
   
Dries committed
930
/**
Dries's avatar
Dries committed
931
 * Menu callback; generates an OPML representation of all feeds.
Dries's avatar
   
Dries committed
932
 */
Dries's avatar
   
Dries committed
933
function aggregator_page_opml() {
Dries's avatar
   
Dries committed
934
  $result = db_query('SELECT * FROM {aggregator_feed} ORDER BY title');
Dries's avatar
   
Dries committed
935

Dries's avatar
   
Dries committed
936
937
938
  $output = "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n";
  $output .= "<opml version=\"1.1\">\n";
  $output .= "<head>\n";
Dries's avatar
   
Dries committed
939
940
  $output .= '<title>'. drupal_specialchars(variable_get('site_name', 'Drupal')) ."</title>\n";
  $output .= '<dateModified>'. gmdate('r') ."</dateModified>\n";
Dries's avatar
   
Dries committed
941
942
  $output .= "</head>\n";
  $output .= "<body>\n";
Dries's avatar
   
Dries committed
943
944

  while ($feed = db_fetch_object($result)) {
Dries's avatar
   
Dries committed
945
    $output .= '<outline text="'. drupal_specialchars($feed->title) .'" xmlUrl="'. drupal_specialchars($feed->url) ."\" />\n";
Dries's avatar
   
Dries committed
946
947
  }

Dries's avatar
   
Dries committed
948
949
  $output .= "</body>\n";
  $output .= "</opml>\n";
Dries's avatar
   
Dries committed
950

Dries's avatar
   
Dries committed
951
  drupal_set_header('Content-Type: text/xml; charset=utf-8');
Dries's avatar
   
Dries committed
952
953
954
  print $output;
}

Dries's avatar
   
Dries committed
955
/**
Dries's avatar
Dries committed
956
 * Menu callback; displays all the categories used by the aggregator.
Dries's avatar
   
Dries committed
957
 */
Dries's avatar
   
Dries committed
958
959
960
function aggregator_page_categories() {
  $result = db_query('SELECT c.cid, c.title, c.description FROM {aggregator_category} c LEFT JOIN {aggregator_category_item} ci ON c.cid = ci.cid LEFT JOIN {aggregator_item} i ON ci.iid = i.iid GROUP BY cid');
  $output = "<div id=\"aggregator\">\n";
Dries's avatar
   
Dries committed
961

Dries's avatar
   
Dries committed
962
963
964
965
966
967
  while ($category = db_fetch_object($result)) {
    $output .= "<h2>$category->title</h2>\n";
    if (variable_get('aggregator_summary_items', 3)) {
      $list = array();
      $items = db_query_range('SELECT i.title, i.timestamp, i.link, f.title as feed_title, f.link as feed_link FROM {aggregator_category_item} ci LEFT JOIN {aggregator_item} i ON i.iid = ci.iid LEFT JOIN {aggregator_feed} f ON i.fid = f.fid WHERE ci.cid = %d ORDER BY i.timestamp DESC', $category->cid, 0, variable_get('aggregator_summary_items', 3));
      while ($item = db_fetch_object($items)) {
Dries's avatar
   
Dries committed
968
        $list[] = '<a href="'. check_url($item->link) ."\">$item->title</a> <span class=\"age\">". t('%age ago', array('%age' => format_interval(time() - $item->timestamp))) ."</span>, <span class=\"source\"><a href=\"$item->feed_link\">$item->feed_title</a></span>\n";
Dries's avatar
   
Dries committed
969
      }
Dries's avatar
   
Dries committed
970
      $output .= theme('item_list', $list);
Dries's avatar