aggregator.module 43.8 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
20
21
      <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>
      <p>To subscribe to an RSS feed on another site, use the <a href="%admin-news">RSS/RDF</a> administration page.</p>
      <p>Once there, select <a href="%new-feed">new feed</a> from the menu. Drupal will then ask for the following:</p>
Dries's avatar
   
Dries committed
22
      <ul>
Dries's avatar
   
Dries committed
23
24
25
26
27
       <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>
       <li><strong>Automatically file items</strong> -- As items are recieved 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
30
31
32
      <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">RSS/RDF</a> page. If you do not see any items listed for that feed, edit the feed and make sure that the URL was entered correctly.</p>
      <h3>Adding categories</h3>
      <p>News items can be filed into categories. To create a category, start at the <a href="%admin-news">RSS/RDF</a> administration page.</p>
      <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
52
      <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>
      <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 slect 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
      <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/system/block'), '%admin-news' => url('admin/syndication/news'), '%new-feed' => url('admin/syndication/news/add/feed'), '%new-category' => url('admin/syndication/news/add/category'), '%update-items' => url('admin/syndication/news'), '%news-aggregator' => url('aggregator'), '%sources' => url('aggregator/sources'), '%categories' => url('aggregator/categories')));
Dries's avatar
   
Dries committed
57
    case 'admin/system/modules#description':
Dries's avatar
   
Dries committed
58
      return t('Used to aggregate syndicated content (RSS and RDF).');
Kjartan's avatar
Kjartan committed
59
    case 'admin/system/modules/aggregator':
Dries's avatar
   
Dries committed
60
      return t('These settings control the display of aggregated content.');
Dries's avatar
   
Dries committed
61
    case 'admin/syndication/news':
Dries's avatar
   
Dries committed
62
      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 categoty 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/system/block'), '%cron' => url('admin/help', NULL, 'cron')));
Dries's avatar
   
Dries committed
63
    case 'admin/syndication/news/add/feed':
Dries's avatar
   
Dries committed
64
65
66
      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.');
    case 'admin/syndication/news/add/category':
      return t('Categoriess 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.');
Dries's avatar
   
Dries committed
67
  }
68
69
}

Dries's avatar
   
Dries committed
70
71
72
/**
 * Menu callback. Displays the aggregator-specific information from admin/help.
 */
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
/**
 * Implementation of hook_settings().
 */
Kjartan's avatar
Kjartan committed
80
function aggregator_settings() {
Dries's avatar
   
Dries committed
81
  $output = '';
Dries's avatar
   
Dries committed
82
  $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
83
  $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
84

Dries's avatar
   
Dries committed
85
86
  $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
87

Dries's avatar
   
Dries committed
88
89
90
  return $output;
}

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

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

  if ($type == 'system') {
Dries's avatar
   
Dries committed
107
108
    $access = user_access('administer news feeds');
    menu('admin/syndication', t('syndication'), $access ? 'aggregator_help_page' : MENU_DENIED, 5);
Dries's avatar
   
Dries committed
109
110
111
112
113
    menu('admin/syndication/news', t('RSS/RDF'), $access ? 'aggregator_admin_overview' : MENU_DENIED);
    menu('admin/syndication/news/add/feed', t('new feed'), $access ? 'aggregator_admin_edit_feed' : MENU_DENIED, 2);
    menu('admin/syndication/news/add/category', t('new category'), $access ? 'aggregator_admin_edit_category' : MENU_DENIED, 3);
    menu('admin/syndication/news/remove', t('remove items'), $access ? 'aggregator_admin_remove_feed' : MENU_DENIED, 0, MENU_HIDE, MENU_LOCKED);
    menu('admin/syndication/news/update', t('update items'), $access ? 'aggregator_admin_refresh_feed' : MENU_DENIED, 0, MENU_HIDE, MENU_LOCKED);
Dries's avatar
   
Dries committed
114
    menu('admin/syndication/news/help', t('help'), $access ? 'aggregator_help_page' : MENU_DENIED, 9);
Dries's avatar
   
Dries committed
115

Dries's avatar
   
Dries committed
116
    $access = user_access('access news feeds');
Dries's avatar
   
Dries committed
117
118
119
120
121
122
    menu('aggregator', t('news aggregator'), $access ? 'aggregator_page_last' : MENU_DENIED, 5);
    menu('aggregator/sources', t('sources'), $access ? 'aggregator_page_sources' : MENU_DENIED, 0);
    menu('aggregator/categories', t('categories'), $access ? 'aggregator_page_categories' : MENU_DENIED, 1, MENU_HIDE_NOCHILD);

    // To reduce the number of SQL queries, we don't query the database when
    // not on an aggregator page.
Dries's avatar
   
Dries committed
123
124
    // If caching of the menu is implemented, this check should be removed
    // so that DHTML menu presentation can be used correctly.
Dries's avatar
   
Dries committed
125
126
127
128
129
130
    if (arg(0) == 'aggregator') {
      // Sources:
      $result = db_query('SELECT title, fid FROM {aggregator_feed} ORDER BY title');
      while ($feed = db_fetch_object($result)) {
        menu('aggregator/sources/'. $feed->fid, $feed->title, $access ? 'aggregator_page_source' : MENU_DENIED);
      }
Dries's avatar
   
Dries committed
131

Dries's avatar
   
Dries committed
132
133
134
135
136
      // Categories:
      $result = db_query('SELECT title, cid FROM {aggregator_category} ORDER BY title');
      while ($category = db_fetch_object($result)) {
        menu('aggregator/categories/'. $category->cid, $category->title, $access ? 'aggregator_page_category' : MENU_DENIED);
      }
Dries's avatar
   
Dries committed
137
    }
138

Dries's avatar
   
Dries committed
139
    menu('aggregator/opml', t('opml'), $access ? 'aggregator_page_opml' : MENU_DENIED, '', MENU_HIDE);
140
141
142
  }
}

Dries's avatar
   
Dries committed
143
144
145
146
147
/**
 * Implementation of hook_cron().
 *
 * Checks news feeds for updates once their refresh interval has elapsed.
 */
Dries's avatar
   
Dries committed
148
function aggregator_cron() {
Dries's avatar
   
Dries committed
149
  $result = db_query('SELECT * FROM {aggregator_feed} WHERE checked + refresh < %d', time());
Dries's avatar
   
Dries committed
150
151
  while ($feed = db_fetch_array($result)) {
    aggregator_refresh($feed);
Dries's avatar
   
Dries committed
152
153
154
  }
}

Dries's avatar
   
Dries committed
155
156
157
158
159
/**
 * Implementation of hook_block().
 *
 * Generates blocks for the latest news items in each category and feed.
 */
Kjartan's avatar
Kjartan committed
160
function aggregator_block($op, $delta) {
Dries's avatar
   
Dries committed
161
  if (user_access('access news feeds')) {
Dries's avatar
   
Dries committed
162
163
164
165
    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
166
      }
Dries's avatar
   
Dries committed
167
      $result = db_query('SELECT fid, title FROM {aggregator_feed} WHERE block != 0 ORDER BY fid');
Kjartan's avatar
Kjartan committed
168
      while ($feed = db_fetch_object($result)) {
Dries's avatar
   
Dries committed
169
        $block['feed:'. $feed->fid]['info'] = t('%title feed latest items', array('%title' => $feed->title));
Kjartan's avatar
Kjartan committed
170
      }
Dries's avatar
   
Dries committed
171
    }
Kjartan's avatar
Kjartan committed
172
    else {
Dries's avatar
   
Dries committed
173
      list($type, $id) = split(':', $delta);
Kjartan's avatar
Kjartan committed
174
      switch ($type) {
Dries's avatar
   
Dries committed
175
176
177
178
179
        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
180
          break;
Dries's avatar
   
Dries committed
181
182
183
184
185
        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
186
187
          break;
      }
Dries's avatar
   
Dries committed
188
189
      $items = array();
      while ($item = db_fetch_object($result)) {
Dries's avatar
   
Dries committed
190
        $items[] = theme('aggregator_block_item', $item);
Dries's avatar
   
Dries committed
191
      }
Dries's avatar
   
Dries committed
192
      $block['content'] = theme('item_list', $items) . $block['content'];
Dries's avatar
   
Dries committed
193
    }
Dries's avatar
   
Dries committed
194
    return $block;
Dries's avatar
   
Dries committed
195
  }
Dries's avatar
   
Dries committed
196
197
}

Dries's avatar
   
Dries committed
198
199
200
201
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
202
  }
Dries's avatar
   
Dries committed
203
204
  if ($items) {
    db_query('DELETE FROM {aggregator_category_item} WHERE '. implode(' OR ', $items));
Dries's avatar
   
Dries committed
205
  }
Dries's avatar
   
Dries committed
206
  db_query('DELETE FROM {aggregator_item} WHERE fid = %d', $feed['fid']);
Kjartan's avatar
Kjartan committed
207
  db_query("UPDATE {aggregator_feed} SET checked = 0, etag = '', modified = 0 WHERE fid = %d", $feed['fid']);
Dries's avatar
   
Dries committed
208
  drupal_set_message(t('removed news items from \'%site\'.', array('%site' => $feed['title'])));
Dries's avatar
   
Dries committed
209
210
}

Dries's avatar
   
Dries committed
211
212
213
/**
 * Call-back function used by the XML parser.
 */
Kjartan's avatar
Kjartan committed
214
function aggregator_element_start($parser, $name, $attributes) {
Dries's avatar
   
Dries committed
215
216
217
  global $item, $element, $tag;

  switch ($name) {
Dries's avatar
   
Dries committed
218
219
    case 'IMAGE':
    case 'TEXTINPUT':
Dries's avatar
   
Dries committed
220
221
      $element = $name;
      break;
Dries's avatar
   
Dries committed
222
    case 'ITEM':
Dries's avatar
   
Dries committed
223
224
      $element = $name;
      $item += 1;
225
226
227
228
229
  }

  $tag = $name;
}

Dries's avatar
   
Dries committed
230
231
232
/**
 * Call-back function used by the XML parser.
 */
Kjartan's avatar
Kjartan committed
233
function aggregator_element_end($parser, $name) {
Dries's avatar
   
Dries committed
234
235
  global $element;

Dries's avatar
   
Dries committed
236
  switch ($name) {
Dries's avatar
   
Dries committed
237
238
239
240
    case 'IMAGE':
    case 'TEXTINPUT':
    case 'ITEM':
      $element = '';
Dries's avatar
   
Dries committed
241
  }
242
243
}

Dries's avatar
   
Dries committed
244
245
246
/**
 * Call-back function used by the XML parser.
 */
Kjartan's avatar
Kjartan committed
247
function aggregator_element_data($parser, $data) {
Dries's avatar
   
Dries committed
248
  global $channel, $element, $items, $item, $image, $tag;
Dries's avatar
   
Dries committed
249
250

  switch ($element) {
Dries's avatar
   
Dries committed
251
    case 'ITEM':
Dries's avatar
   
Dries committed
252
253
      $items[$item][$tag] .= $data;
      break;
Dries's avatar
   
Dries committed
254
    case 'IMAGE':
Dries's avatar
   
Dries committed
255
256
      $image[$tag] .= $data;
      break;
Dries's avatar
   
Dries committed
257
258
259
    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
260
261
262
      break;
    default:
      $channel[$tag] .= $data;
263
264
265
  }
}

Dries's avatar
   
Dries committed
266
267
268
/**
 * Checks a news feed for new items.
 */
Kjartan's avatar
Kjartan committed
269
function aggregator_refresh($feed) {
Dries's avatar
   
Dries committed
270
271
  global $channel, $image;

Dries's avatar
   
Dries committed
272
273
274
275
276
277
  // Generate conditional GET headers.
  $headers = array();
  if ($feed['etag']) {
    $headers['If-None-Match'] = $feed['etag'];
  }
  if ($feed['modified']) {
Dries's avatar
   
Dries committed
278
    $headers['If-Modified-Since'] = gmdate('D, d M Y H:i:s', $feed['modified']) .' GMT';
Dries's avatar
   
Dries committed
279
280
281
282
283
284
285
286
  }

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

  // Process HTTP reponse code.
  switch ($result->code) {
    case 304:
Dries's avatar
   
Dries committed
287
288
      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
289
      break;
Dries's avatar
   
Dries committed
290
291
    case 301:
      $feed['url'] = $result->redirect_url;
Dries's avatar
   
Dries committed
292
      watchdog('special', "aggregator: updated URL for feed \"$feed[title]\" to $feed[url]");
Dries's avatar
   
Dries committed
293
294
295
296
297
    case 200:
    case 302:
    case 307:
      // Filter the input data:
      if (!valid_input_data($result->data)) {
Dries's avatar
   
Dries committed
298
        drupal_set_message(t('failed to parse RSS feed "%site": suspicious input data.', array('%site' => $feed['title'])), 'error');
Dries's avatar
   
Dries committed
299
      }
Dries's avatar
   
Dries committed
300
      else if (aggregator_parse_feed($result->data, $feed)) {
301

Dries's avatar
   
Dries committed
302
303
304
        if ($result->headers['Last-Modified']) {
          $modified = strtotime($result->headers['Last-Modified']);
        }
Dries's avatar
Dries committed
305

Dries's avatar
   
Dries committed
306
307
308
        /*
        ** Prepare the image data (if any):
        */
Dries's avatar
   
Dries committed
309

Dries's avatar
   
Dries committed
310
311
312
        foreach ($image as $key => $value) {
          $image[$key] = trim($value);
        }
Dries's avatar
   
Dries committed
313

Dries's avatar
   
Dries committed
314
        if ($image['LINK'] && $image['URL'] && $image['TITLE']) {
Dries's avatar
   
Dries committed
315
          $image = '<a href="'. $image['LINK'] .'"><img src="'. $image['URL'] .'" alt="'. $image['TITLE'] .'" /></a>';
Dries's avatar
   
Dries committed
316
        }
Dries's avatar
   
Dries committed
317
318
319
        else {
          $image = NULL;
        }
Dries's avatar
   
Dries committed
320

Dries's avatar
   
Dries committed
321
322
323
        /*
        ** Update the feed data:
        */
Dries's avatar
   
Dries committed
324

Dries's avatar
   
Dries committed
325
        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
326

Dries's avatar
   
Dries committed
327
328
329
        /*
        ** Clear the cache:
        */
Dries's avatar
   
Dries committed
330

Dries's avatar
   
Dries committed
331
        cache_clear_all();
Dries's avatar
   
Dries committed
332

Dries's avatar
   
Dries committed
333
        $message = t('syndicated content from "%site".', array('%site' => $feed['title']));
Dries's avatar
   
Dries committed
334
335
336
337
        watchdog('regular', "aggregator: $message");
        drupal_set_message($message);
      }
      break;
Dries's avatar
   
Dries committed
338
    default:
Dries's avatar
   
Dries committed
339
      $message = t('failed to parse RSS feed "%site": %error.', array('%site' => $feed['title'], '%error' => $result->code .' '. $result->error));
Dries's avatar
   
Dries committed
340
341
      watchdog('error', "aggregator: $message");
      drupal_set_message($message);
Dries's avatar
   
Dries committed
342
  }
Dries's avatar
   
Dries committed
343
}
Dries's avatar
   
Dries committed
344

Dries's avatar
   
Dries committed
345
function aggregator_parse_feed(&$data, $feed) {
Dries's avatar
   
Dries committed
346
  global $items, $image, $channel;
Dries's avatar
   
Dries committed
347

Dries's avatar
   
Dries committed
348
  // Unset the global variables before we use them:
Dries's avatar
   
Dries committed
349
  unset($GLOBALS['element'], $GLOBALS['item'], $GLOBALS['tag']);
Dries's avatar
   
Dries committed
350
  $items = array();
Dries's avatar
   
Dries committed
351
  $image = array();
Dries's avatar
   
Dries committed
352
  $channel = array();
353

Dries's avatar
   
Dries committed
354
355
  // parse the data:
  $xml_parser = drupal_xml_parser_create($data);
Dries's avatar
   
Dries committed
356
357
  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
358

Dries's avatar
   
Dries committed
359
  if (!xml_parse($xml_parser, $data, 1)) {
Dries's avatar
   
Dries committed
360
    $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
361
362
363
    watchdog('error', "aggregator: $message");
    drupal_set_message($message, 'error');
    return 0;
Dries's avatar
   
Dries committed
364
365
  }
  xml_parser_free($xml_parser);
Dries's avatar
   
Dries committed
366

Dries's avatar
   
Dries committed
367
  // initialize the translation table:
368
  $tt = array_flip(get_html_translation_table(HTML_SPECIALCHARS));
Dries's avatar
   
Dries committed
369
  $tt['&apos;'] = "'";
Dries's avatar
   
Dries committed
370

Dries's avatar
   
Dries committed
371
372
373
374
375
  /*
  ** 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
376

Dries's avatar
   
Dries committed
377
  $items = array_reverse($items);
Dries's avatar
   
Dries committed
378

Dries's avatar
   
Dries committed
379
380
  foreach ($items as $item) {
    unset($title, $link, $author, $description);
381

Dries's avatar
   
Dries committed
382
383
384
385
    // Prepare the item:
    foreach ($item as $key => $value) {
      $item[$key] = filter_default(strtr(trim($value), $tt));
    }
Dries's avatar
Dries committed
386

Dries's avatar
   
Dries committed
387
388
389
390
391
392
    /*
    ** 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
393
394
    if ($item['TITLE']) {
      $title = $item['TITLE'];
Dries's avatar
   
Dries committed
395
396
    }
    else {
Dries's avatar
   
Dries committed
397
      $title = preg_replace('/^(.*)[^\w;&].*?$/', "\\1", truncate_utf8($item['DESCRIPTION'], 40));
Dries's avatar
   
Dries committed
398
    }
Dries's avatar
   
Dries committed
399

Dries's avatar
   
Dries committed
400
401
402
403
    /*
    ** Resolve the items link.
    */

Dries's avatar
   
Dries committed
404
405
    if ($item['LINK']) {
      $link = $item['LINK'];
Dries's avatar
   
Dries committed
406
    }
Dries's avatar
   
Dries committed
407
408
    elseif ($item['GUID'] && (strncmp($item['GUID'], 'http://', 7) == 0)) {
      $link = $item['GUID'];
Dries's avatar
   
Dries committed
409
410
    }
    else {
Dries's avatar
   
Dries committed
411
      $link = $feed['link'];
Dries's avatar
   
Dries committed
412
    }
413

Dries's avatar
   
Dries committed
414
415
416
417
418
419
420
421
422
423
    /*
    ** 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
424
    else $date = 'now';
Dries's avatar
   
Dries committed
425
426
427
428
429
430
431
432
433

    $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
434
      list($year, $month, $day, $hour, $minute, $second) = sscanf($date, '%4d-%2d-%2dT%2d:%2d:%2d');
Dries's avatar
   
Dries committed
435
436
437
438
      $timestamp = strtotime("$year-$month-$day $hour:$minute:$second");
    }

    if ($timestamp < 0) {
Dries's avatar
   
Dries committed
439
      $timestamp = time();
440
    }
Dries's avatar
   
Dries committed
441
442

    /*
Dries's avatar
   
Dries committed
443
444
445
    ** 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
446
447
    */

Dries's avatar
   
Dries committed
448
449
    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
450
451
    }
    else {
Dries's avatar
   
Dries committed
452
      $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
453
    }
Dries's avatar
   
Dries committed
454

Dries's avatar
   
Dries committed
455
    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
456
  }
Dries's avatar
   
Dries committed
457

Dries's avatar
   
Dries committed
458
  /*
Dries's avatar
   
Dries committed
459
  ** Remove all items that are older than 3 months:
Dries's avatar
   
Dries committed
460
  */
Dries's avatar
   
Dries committed
461

Dries's avatar
   
Dries committed
462
463
  $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
464

Dries's avatar
   
Dries committed
465
  $items = array();
Dries's avatar
   
Dries committed
466
467
  while ($item = db_fetch_object($result)) {
    $items[] = "iid = '$item->iid'";
Dries's avatar
   
Dries committed
468
  }
Dries's avatar
   
Dries committed
469
470
471
  $where = implode(' OR ', $items);
  db_query('DELETE FROM {aggregator_category_item} WHERE '. implode(' OR ', $items));
  db_query('DELETE FROM {aggregator_item} WHERE fid = %d AND timestamp < %d', $feed['fid'], $age);
Dries's avatar
   
Dries committed
472
473

  return 1;
474
475
}

Kjartan's avatar
Kjartan committed
476
function aggregator_save_item($edit) {
Dries's avatar
   
Dries committed
477
478
  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']);
479
  }
Dries's avatar
   
Dries committed
480
481
482
  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']);
483
  }
Dries's avatar
   
Dries committed
484
485
486
  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
487
488
489
490
491
    // 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);
    }
492
493
494
  }
}

Dries's avatar
   
Dries committed
495
496
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'));
497

Dries's avatar
   
Dries committed
498
499
500
501
  $form = form_textfield(t('Title'), 'title', $edit['title'], 50, 64);
  $form .= form_textarea(t('Description'), 'description', $edit['description'], 60, 5);
  $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 availiable for placement on the <a href="%url">block configuration</a> page.', array('%url' => url('admin/system/block'))));
  $form .= form_submit(t('Submit'));
502

Dries's avatar
   
Dries committed
503
504
505
  if ($edit['cid']) {
    $form .= form_submit(t('Delete'));
    $form .= form_hidden('cid', $edit['cid']);
506
507
  }

Dries's avatar
   
Dries committed
508
  return form($form);
509
510
}

Dries's avatar
   
Dries committed
511
512
513
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']);
514
  }
Dries's avatar
   
Dries committed
515
516
  else if ($edit['cid']) {
    db_query('DELETE FROM {aggregator_category} WHERE cid = %d', $edit['cid']);
517
  }
Dries's avatar
   
Dries committed
518
  else if ($edit['title']) {
Dries's avatar
   
Dries committed
519
    // a single unique id for bundles and feeds, to use in blocks
Dries's avatar
   
Dries committed
520
521
    $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']);
522
523
524
  }
}

Kjartan's avatar
Kjartan committed
525
function aggregator_form_feed($edit = array()) {
Dries's avatar
   
Dries committed
526
  $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
527
  $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'));
528

Dries's avatar
   
Dries committed
529
530
  if ($edit['refresh'] == '') {
    $edit['refresh'] = 3600;
Dries's avatar
   
Dries committed
531
  }
Dries's avatar
   
Dries committed
532

Dries's avatar
   
Dries committed
533
534
535
  $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.'));
  $form .= form_textfield(t('URL'), 'url', $edit['url'], 50, 128, t('The fully-qualified URL of the feed.'));
  $form .= form_select(t('Update interval'), 'refresh', $edit['refresh'], $period, t('The refresh interval indicating how often you want to update this feed.  Requires crontab.'));
Dries's avatar
   
Dries committed
536
  $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 availiable for placement on the <a href="%url">block configuration</a> page.', array('%url' => url('admin/system/block'))));
Dries's avatar
   
Dries committed
537
  $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
538
539
540
541
542
543
  while ($category = db_fetch_object($categories)) {
    $checkboxes .= form_checkbox($category->title, "category][$category->cid", 1, $category->fid ? 1 : 0);
  }
  if ($checkboxes) {
    $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 recieved.'));
  }
544

Dries's avatar
   
Dries committed
545
  $form .= form_submit(t('Submit'));
546

Dries's avatar
   
Dries committed
547
548
549
  if ($edit['fid']) {
    $form .= form_submit(t('Delete'));
    $form .= form_hidden('fid', $edit['fid']);
550
551
  }

Dries's avatar
   
Dries committed
552
  return form($form);
553
554
}

Kjartan's avatar
Kjartan committed
555
function aggregator_save_feed($edit) {
Dries's avatar
   
Dries committed
556
557
558
  if ($edit['fid']) {
    // an exisitng feed is being modified, delete the category listings
    db_query('DELETE FROM {aggregator_category_feed} WHERE fid = %d', $edit['fid']);
559
  }
Dries's avatar
   
Dries committed
560
561
  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']);
562
  }
Dries's avatar
   
Dries committed
563
564
565
566
567
568
569
570
571
572
  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']);
573
  }
Dries's avatar
   
Dries committed
574
575
576
577
578
579
580
581
582
583
584
585
  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
    foreach ($edit['category'] as $cid => $checked) {
      if ($checked) {
        db_query('INSERT INTO {aggregator_category_feed} (fid, cid) VALUES (%d, %d)', $edit['fid'], $cid);
      }
    }
586
587
588
  }
}

Kjartan's avatar
Kjartan committed
589
function aggregator_get_feed($fid) {
Dries's avatar
   
Dries committed
590
  return db_fetch_array(db_query('SELECT * FROM {aggregator_feed} WHERE fid = %d', $fid));
591
592
}

Dries's avatar
   
Dries committed
593
function aggregator_get_category($cid) {
Dries's avatar
   
Dries committed
594
  return db_fetch_array(db_query('SELECT * FROM {aggregator_category} WHERE cid = %d', $cid));
595
596
}

Kjartan's avatar
Kjartan committed
597
function aggregator_view() {
Dries's avatar
   
Dries committed
598
  $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');
599

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

Dries's avatar
   
Dries committed
602
  $header = array(t('title'), t('items'), t('last update'), t('next update'), array('data' => t('operations'), 'colspan' => 3));
Dries's avatar
   
Dries committed
603
  $rows = array();
604
  while ($feed = db_fetch_object($result)) {
Dries's avatar
   
Dries committed
605
    $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/syndication/news/edit/feed/$feed->fid"), l(t('remove items'), "admin/syndication/news/remove/$feed->fid"), l(t('update items'), "admin/syndication/news/update/$feed->fid"));
606
  }
Dries's avatar
   
Dries committed
607
  $output .= theme('table', $header, $rows);
608

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

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

Dries's avatar
   
Dries committed
613
  $header = array(t('title'), t('operations'));
Dries's avatar
   
Dries committed
614
  $rows = array();
Dries's avatar
   
Dries committed
615
  while ($category = db_fetch_object($result)) {
Dries's avatar
   
Dries committed
616
    $rows[] = array(l($category->title, "aggregator/categories/$category->cid"), l(t('edit category'), "admin/syndication/news/edit/category/$category->cid"));
617
  }
Dries's avatar
   
Dries committed
618
  $output .= theme('table', $header, $rows);
619
620
621
622

  return $output;
}

Dries's avatar
   
Dries committed
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
/**
 * Menu callback. Displays the category edit form, or saves changes and
 * displays the overview page.
 */
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);
      $output = aggregator_view();
    default:
      if ($category) {
        $output = aggregator_form_category(aggregator_get_category($category));
Dries's avatar
   
Dries committed
641
642
      }
      else {
Dries's avatar
   
Dries committed
643
        $output = aggregator_form_category();
Dries's avatar
   
Dries committed
644
      }
Dries's avatar
   
Dries committed
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
  }
  print theme('page', $output);
}

/**
 * Menu callback. Displays the feed edit form, or saves changes and
 * displays the overview page.
 */
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);
      $output = aggregator_view();
    default:
      if ($feed) {
        $output = aggregator_form_feed(aggregator_get_feed($feed));
Dries's avatar
   
Dries committed
667
668
      }
      else {
Dries's avatar
   
Dries committed
669
        $output = aggregator_form_feed();
Dries's avatar
   
Dries committed
670
      }
671
  }
Dries's avatar
   
Dries committed
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
  print theme('page', $output);
}

/**
 * Menu callback. Removes all items from a feed, then displays the overview page.
 */
function aggregator_admin_remove_feed($feed) {
  aggregator_remove(aggregator_get_feed($feed));
  print theme('page', aggregator_view());
}

/**
 * Menu callback. Refreshes a feed, then displays the overview page.
 */
function aggregator_admin_refresh_feed($feed) {
  aggregator_refresh(aggregator_get_feed($feed));
  print theme('page', aggregator_view());
}

/**
 * Menu callback. Displays the aggregator administration page.
 */
function aggregator_admin_overview() {
  print theme('page', aggregator_view());
696
697
}

Dries's avatar
   
Dries committed
698
699
700
/**
 * Menu callback. Displays the most recent items gathered from any feed.
 */
701
function aggregator_page_last() {
Dries's avatar
   
Dries committed
702
  _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
703
704
}

Dries's avatar
   
Dries committed
705
706
707
/**
 * Menu callback. Displays all the items captured from a particular feed.
 */
708
function aggregator_page_source() {
Dries's avatar
   
Dries committed
709
  $feed = db_fetch_object(db_query('SELECT * FROM {aggregator_feed} WHERE fid = %d', arg(2)));
Dries's avatar
   
Dries committed
710
  $info = theme('aggregator_feed', $feed);
Dries's avatar
   
Dries committed
711

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

Dries's avatar
   
Dries committed
715
716
717
/**
 * Menu callback. Displays all the items aggregated in a particular category.
 */
718
function aggregator_page_category() {
Dries's avatar
   
Dries committed
719
  $category = db_fetch_object(db_query('SELECT cid, title FROM {aggregator_category} WHERE cid = %d', arg(2)));
Dries's avatar
   
Dries committed
720

Dries's avatar
   
Dries committed
721
  _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(1));
Dries's avatar
   
Dries committed
722
}
Dries's avatar
   
Dries committed
723

Dries's avatar
   
Dries committed
724
725
726
727
/**
 * 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
728
function _aggregator_page_list($sql, $op, $header = '') {
Dries's avatar
   
Dries committed
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
  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);
          }
        }
      }
      $links[] = l(t('categorize news items'), $_GET['q']);
    }
    else {
      $categorize = true;
    }
  }
  if (user_access('administer news feeds') && $op != 'categorize') {
    $links[] = l(t('categorize news items'), $_GET['q'] .'/categorize');
  }
Dries's avatar
   
Dries committed
748

Dries's avatar
   
Dries committed
749
750
751
752
753
754
755
  $output = '<div id="aggregator">';
  if ($header) {
    $output .= $header;
  }
  if ($links) {
    $output .= theme('links', $links);
  }
Dries's avatar
   
Dries committed
756
757
758

  $result = pager_query($sql, 20);

Dries's avatar
   
Dries committed
759
760
  $rows = array();
  $categories = array();
Dries's avatar
   
Dries committed
761
  while ($item = db_fetch_object($result)) {
Dries's avatar
   
Dries committed
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
    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
788
  }
Dries's avatar
   
Dries committed
789
790
791
792
  if ($categorize) {
    $output .= form(theme('table', array('', t('categorize')), $rows) . form_submit(t('Save categories')));
  }
  $output .= '</div>';
Dries's avatar
   
Dries committed
793
794
795
796
797

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

Dries's avatar
   
Dries committed
798
  print theme('page', $output);
Dries's avatar
   
Dries committed
799
800
}

Dries's avatar
   
Dries committed
801
802
803
/**
 * Menu callback. Displays all the feeds used by the aggregator.
 */
Kjartan's avatar
Kjartan committed
804
function aggregator_page_sources() {
Dries's avatar
   
Dries committed
805
806
  $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
807
  while ($feed = db_fetch_object($result)) {
Dries's avatar
   
Dries committed
808
809
810
811
812
813
814
815
816
817
818
819
    $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
820
  }
Dries's avatar
   
Dries committed
821
  $output .= theme('xml_icon', url('aggregator/opml'));
Dries's avatar
   
Dries committed
822
823
  $output .= '</div>';
  print theme('page', $output);
Dries's avatar
   
Dries committed
824
825
}

Dries's avatar
   
Dries committed
826
827
828
/**
 * Menu callback. Generates an OPML representation of all feeds.
 */
Dries's avatar
   
Dries committed
829
function aggregator_page_opml() {
Dries's avatar
   
Dries committed
830
  $result = db_query('SELECT * FROM {aggregator_feed} ORDER BY title');
Dries's avatar
   
Dries committed
831

Dries's avatar
   
Dries committed
832
833
834
  $output = "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n";
  $output .= "<opml version=\"1.1\">\n";
  $output .= "<head>\n";
Dries's avatar
   
Dries committed
835
836
  $output .= '<title>'. drupal_specialchars(variable_get('site_name', 'Drupal')) ."</title>\n";
  $output .= '<dateModified>'. gmdate('r') ."</dateModified>\n";
Dries's avatar
   
Dries committed
837
838
  $output .= "</head>\n";
  $output .= "<body>\n";
Dries's avatar
   
Dries committed
839
840

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

Dries's avatar
   
Dries committed
844
845
  $output .= "</body>\n";
  $output .= "</opml>\n";
Dries's avatar
   
Dries committed
846

Dries's avatar
   
Dries committed
847
  drupal_set_header('Content-Type: text/xml; charset=utf-8');
Dries's avatar
   
Dries committed
848
849
850
  print $output;
}

Dries's avatar
   
Dries committed
851
852
853
/**
 * Menu callback. Displays all the categories used by the aggregator.
 */
Dries's avatar
   
Dries committed
854
855
856
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
857

Dries's avatar
   
Dries committed
858
859
860
861
862
863
  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
864
        $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
865
      }
Dries's avatar
   
Dries committed
866
      $output .= theme('item_list', $list);
Dries's avatar
   
Dries committed
867
    }
Dries's avatar
   
Dries committed
868
    $output .= '<div class="more-link">'. l(t('more'), 'aggregator/categories/'. $category->cid) .'</div>';
Dries's avatar
   
Dries committed
869
  }
Dries's avatar
   
Dries committed
870
  $output .= '</div>';
Dries's avatar
   
Dries committed
871

Dries's avatar
   
Dries committed
872
  print theme('page', $output);
Dries's avatar
   
Dries committed
873
}
Dries's avatar
   
Dries committed
874

Dries's avatar
Dries committed
875
876
877
878
879
/**
 * @addtogroup themeable
 * @{
 */

Dries's avatar
   
Dries committed
880
881
function theme_aggregator_feed($feed) {

Dries's avatar
   
Dries committed
882
  $output  = '';
Dries's avatar
   
Dries committed
883
884
885
886
887
888

  if ($feed->image) {
    $output .= $feed->image;
  }

  $output .= $feed->description;
Dries's avatar
   
Dries committed
889
  $output .= '<h3>'. t('URL') ."</h3>\n";
Dries's avatar
   
Dries committed
890
891
  $output .= theme('xml_icon', $feed->url);
  $output .= "<a href=\"$feed->link\">$feed->link</a>\n";
Dries's avatar
   
Dries committed
892
893
  $output .= '<h3>'. t('Last update') ."</h3>\n";
  $updated = t('%time ago', array('%time' => format_interval(time() - $feed->checked)));
Dries's avatar
   
Dries committed
894
895
896
897
898
899
900
901
902
903
904

  if (user_access('administer news feeds')) {
    $output .= l($updated, 'admin/syndication/news');
  }
  else {
    $output .= $updated;
  }

  return $output;
}

Dries's avatar
Dries committed
905
906
907
function theme_aggregator_block_item($item, $feed = 0) {
  global $user;

Dries's avatar
   
Dries committed
908
909
  if ($user->uid && module_exist('blog') && user_access('maintain personal blog')) {
    $output .= '<div class="icon">'. l('<img src="'. theme('image', 'blog.gif') .'" alt="'. t('blog it') .'" title="'. t('blog it') .'" />', 'node/add/blog', array('title' => t('Comment on this news item in your personal blog.'), 'class' => 'blog-it'), "iid=$item->iid") .'</div>';
Dries's avatar
Dries committed
910
911
912
913
914
915
916
917
918
919
920
  }

  // external link
  $output .= "<a href=\"$item->link\">$item->title</a>";

  return $output;
}

function theme_aggregator_page_item($item) {
  static $last;

Dries's avatar
   
Dries committed
921
  $date = date('Ymd', $item->timestamp);
Dries's avatar
Dries committed
922
923
  if ($date != $last) {
    $last = $date;
Dries's avatar
   
Dries committed
924
    $output .= '<h3>'. date('F j, Y', $item->timestamp) ."</h3>\n";
Dries's avatar
Dries committed
925
926
927
  }

  $output .= "<div class=\"news-item\">\n";
Dries's avatar
   
Dries committed
928
  $output .= ' <div class="date">'. date('H:i', $item->timestamp) ."</div>\n";
Dries's avatar
Dries committed
929
930
931
932
933
934
  $output .= " <div class=\"body\">\n";
  $output .= "  <div class=\"title\"><a href=\"$item->link\">$item->title</a></div>\n";
  if ($item->description) {
    $output .= "  <div class=\"description\">$item->description</div>\n";
  }
  if ($item->ftitle && $item->fid) {
Dries's avatar
   
Dries committed
935
    $output .= '  <div class="source">'. t('Source') .': '. l($item->ftitle, "aggregator/sources/$item->fid") ."</div>\n";
Dries's avatar
Dries committed
936
  }
Dries's avatar
   
Dries committed
937
938
939
940
941
942
943

  $result = db_query('SELECT c.title, c.cid FROM {aggregator_category_item} ci LEFT JOIN {aggregator_category} c ON ci.cid = c.cid WHERE ci.iid = %d ORDER BY c.title', $item->iid);
  $categories = array();
  while ($category = db_fetch_object($result)) {
    $categories[] = l($category->title, 'aggregator/categories/'. $category->cid);
  }
  if ($categories) {
Dries's avatar
   
Dries committed
944
    $output .= '  <div class="categories">'. t('Categories') .': '. implode(', ', $categories) ."</div>\n";
Dries's avatar
   
Dries committed
945
946
  }

Dries's avatar
Dries committed
947
948
949
950
951
952
953
954
  $output .= " </div>\n";
  $output .= "</div>\n";

  return $output;
}

/** @} End of addtogroup themeable */

Dries's avatar
   
Dries committed
955
?>