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

Dries Buytaert's avatar
   
Dries Buytaert committed
4
5
6
/**
 * Implementation of hook_help().
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
7
function aggregator_help($section) {
Dries Buytaert's avatar
   
Dries Buytaert committed
8
  switch ($section) {
9
    case 'admin/help#aggregator':
Dries Buytaert's avatar
   
Dries Buytaert committed
10
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 Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert committed
20
21
      <p>To subscribe to an RSS feed on another site, use the <a href="%admin-news">aggregation page</a>.</p>
      <p>Once there, click the <a href="%new-feed">new feed</a> tab.  Drupal will then ask for the following:</p>
Dries Buytaert's avatar
   
Dries Buytaert committed
22
      <ul>
Dries Buytaert's avatar
   
Dries Buytaert committed
23
24
25
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 Buytaert's avatar
   
Dries Buytaert committed
28
      </ul>
Dries Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert committed
30
      <h3>Adding categories</h3>
Dries Buytaert's avatar
   
Dries Buytaert committed
31
      <p>News items can be filed into categories. To create a category, start at the <a href="%admin-news">aggregation page</a>.</p>
Dries Buytaert's avatar
   
Dries Buytaert committed
32
      <p>Once there, select <a href="%new-category">new category</a> from the menu. Drupal will then ask for the following:</p>
Dries Buytaert's avatar
   
Dries Buytaert committed
33
      <ul>
Dries Buytaert's avatar
   
Dries Buytaert committed
34
35
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 Buytaert's avatar
   
Dries Buytaert committed
37
38
39
40
      </ul>
      <h3>Using the news aggregator</h3>
      <p>The news aggregator has a number of ways that it displays your subscribed content:</p>
      <ul>
Dries Buytaert's avatar
   
Dries Buytaert committed
41
42
43
       <li><strong><a href="%news-aggregator">News aggregator</a></strong> (latest news) -- Displays all incoming 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 Buytaert's avatar
   
Dries Buytaert committed
44
      </ul>
Dries Buytaert's avatar
   
Dries Buytaert 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 Buytaert's avatar
   
Dries Buytaert committed
53
      <h3>Technical details</h3>
Dries Buytaert's avatar
   
Dries Buytaert committed
54
      <p>Drupal automatically generates an OPML feed file that is available by selecting the XML icon on the News Sources page.</p>
Dries Buytaert's avatar
   
Dries Buytaert committed
55
      <p>When fetching feeds Drupal supports conditional GETs, this reduces the bandwidth usage for feeds that have not been updated since the last check.</p>
Dries Buytaert's avatar
   
Dries Buytaert committed
56
57
      <p>If a feed is permanently moved to a new location Drupal will automatically update the feed URL to the new address.</p>', array('%block' => url('admin/block'), '%admin-news' => url('admin/aggregator'), '%new-feed' => url('admin/aggregator/add/feed'), '%new-category' => url('admin/aggregator/add/category'), '%update-items' => url('admin/aggregator'), '%news-aggregator' => url('aggregator'), '%sources' => url('aggregator/sources'), '%categories' => url('aggregator/categories')));
    case 'admin/modules#description':
Dries Buytaert's avatar
   
Dries Buytaert committed
58
      return t('Used to aggregate syndicated content (RSS and RDF).');
Dries Buytaert's avatar
   
Dries Buytaert committed
59
    case 'admin/settings/aggregator':
Dries Buytaert's avatar
   
Dries Buytaert committed
60
      return t('These settings control the display of aggregated content.');
Dries Buytaert's avatar
   
Dries Buytaert committed
61
    case 'admin/aggregator':
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 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 Buytaert's avatar
   
Dries Buytaert committed
63
    case 'admin/aggregator/add/feed':
Dries Buytaert's avatar
   
Dries Buytaert committed
64
      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 Buytaert's avatar
   
Dries Buytaert committed
65
    case 'admin/aggregator/add/category':
Dries Buytaert's avatar
   
Dries Buytaert committed
66
      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 Buytaert's avatar
   
Dries Buytaert committed
67
  }
68
69
}

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

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

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

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

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

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

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

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

Dries Buytaert's avatar
   
Dries Buytaert committed
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
  $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);

  // Tabs:
  $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);
      $items[] = array('path' => 'aggregator/sources/'. $feed->fid .'/categorize', 'title' => t('categorize'),
        'callback' => 'aggregator_page_source', 'access' => $edit,
        'type' => MENU_LOCAL_TASK);
      $items[] = array('path' => 'aggregator/sources/'. $feed->fid .'/configure', 'title' => t('configure'),
        'callback' => 'aggregator_edit', 'access' => $edit,
        'type' => MENU_LOCAL_TASK,
        'weight' => 1);
Dries Buytaert's avatar
   
Dries Buytaert committed
169
    }
170

Dries Buytaert's avatar
   
Dries Buytaert committed
171
172
173
174
175
176
177
178
179
180
181
182
183
    // 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);
      $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);
    }
184
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
185
186
187
188
189
190

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

  return $items;
191
192
}

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

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

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

Dries Buytaert's avatar
   
Dries Buytaert committed
261
262
263
/**
 * Call-back function used by the XML parser.
 */
264
function aggregator_element_start($parser, $name, $attributes) {
Dries Buytaert's avatar
   
Dries Buytaert committed
265
266
267
  global $item, $element, $tag;

  switch ($name) {
Dries Buytaert's avatar
   
Dries Buytaert committed
268
269
    case 'IMAGE':
    case 'TEXTINPUT':
Dries Buytaert's avatar
   
Dries Buytaert committed
270
271
      $element = $name;
      break;
Dries Buytaert's avatar
   
Dries Buytaert committed
272
    case 'ITEM':
Dries Buytaert's avatar
   
Dries Buytaert committed
273
274
      $element = $name;
      $item += 1;
275
276
277
278
279
  }

  $tag = $name;
}

Dries Buytaert's avatar
   
Dries Buytaert committed
280
281
282
/**
 * Call-back function used by the XML parser.
 */
283
function aggregator_element_end($parser, $name) {
Dries Buytaert's avatar
   
Dries Buytaert committed
284
285
  global $element;

Dries Buytaert's avatar
   
Dries Buytaert committed
286
  switch ($name) {
Dries Buytaert's avatar
   
Dries Buytaert committed
287
288
289
290
    case 'IMAGE':
    case 'TEXTINPUT':
    case 'ITEM':
      $element = '';
Dries Buytaert's avatar
   
Dries Buytaert committed
291
  }
292
293
}

Dries Buytaert's avatar
   
Dries Buytaert committed
294
295
296
/**
 * Call-back function used by the XML parser.
 */
297
function aggregator_element_data($parser, $data) {
Dries Buytaert's avatar
   
Dries Buytaert committed
298
  global $channel, $element, $items, $item, $image, $tag;
Dries Buytaert's avatar
   
Dries Buytaert committed
299
300

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

Dries Buytaert's avatar
   
Dries Buytaert committed
316
317
318
/**
 * Checks a news feed for new items.
 */
319
function aggregator_refresh($feed) {
Dries Buytaert's avatar
   
Dries Buytaert committed
320
321
  global $channel, $image;

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

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

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

Dries Buytaert's avatar
   
Dries Buytaert committed
349
350
351
        if ($result->headers['Last-Modified']) {
          $modified = strtotime($result->headers['Last-Modified']);
        }
Dries Buytaert's avatar
Dries Buytaert committed
352

Dries Buytaert's avatar
   
Dries Buytaert committed
353
354
355
        /*
        ** Prepare the image data (if any):
        */
Dries Buytaert's avatar
   
Dries Buytaert committed
356

Dries Buytaert's avatar
   
Dries Buytaert committed
357
358
359
        foreach ($image as $key => $value) {
          $image[$key] = trim($value);
        }
Dries Buytaert's avatar
   
Dries Buytaert committed
360

Dries Buytaert's avatar
   
Dries Buytaert committed
361
        if ($image['LINK'] && $image['URL'] && $image['TITLE']) {
Dries Buytaert's avatar
   
Dries Buytaert committed
362
          $image = '<a href="'. $image['LINK'] .'"><img src="'. $image['URL'] .'" alt="'. $image['TITLE'] .'" /></a>';
Dries Buytaert's avatar
   
Dries Buytaert committed
363
        }
Dries Buytaert's avatar
   
Dries Buytaert committed
364
365
366
        else {
          $image = NULL;
        }
Dries Buytaert's avatar
   
Dries Buytaert committed
367

Dries Buytaert's avatar
   
Dries Buytaert committed
368
369
370
        /*
        ** Update the feed data:
        */
Dries Buytaert's avatar
   
Dries Buytaert committed
371

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

Dries Buytaert's avatar
   
Dries Buytaert committed
374
375
376
        /*
        ** Clear the cache:
        */
Dries Buytaert's avatar
   
Dries Buytaert committed
377

Dries Buytaert's avatar
   
Dries Buytaert committed
378
        cache_clear_all();
Dries Buytaert's avatar
   
Dries Buytaert committed
379

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

Dries Buytaert's avatar
   
Dries Buytaert committed
392
function aggregator_parse_feed(&$data, $feed) {
Dries Buytaert's avatar
   
Dries Buytaert committed
393
  global $items, $image, $channel;
Dries Buytaert's avatar
   
Dries Buytaert committed
394

Dries Buytaert's avatar
   
Dries Buytaert committed
395
  // Unset the global variables before we use them:
Dries Buytaert's avatar
   
Dries Buytaert committed
396
  unset($GLOBALS['element'], $GLOBALS['item'], $GLOBALS['tag']);
Dries Buytaert's avatar
   
Dries Buytaert committed
397
  $items = array();
Dries Buytaert's avatar
   
Dries Buytaert committed
398
  $image = array();
Dries Buytaert's avatar
   
Dries Buytaert committed
399
  $channel = array();
400

Dries Buytaert's avatar
   
Dries Buytaert committed
401
402
  // parse the data:
  $xml_parser = drupal_xml_parser_create($data);
Dries Buytaert's avatar
   
Dries Buytaert committed
403
404
  xml_set_element_handler($xml_parser, 'aggregator_element_start', 'aggregator_element_end');
  xml_set_character_data_handler($xml_parser, 'aggregator_element_data');
Dries Buytaert's avatar
   
Dries Buytaert committed
405

Dries Buytaert's avatar
   
Dries Buytaert committed
406
  if (!xml_parse($xml_parser, $data, 1)) {
407
    watchdog('error', t('aggregator: failed to parse RSS feed "%site": %error at line %line.', array('%site' => $feed['title'], '%error' => xml_error_string(xml_get_error_code($xml_parser)), '%line' => xml_get_current_line_number($xml_parser))));
Dries Buytaert's avatar
   
Dries Buytaert committed
408
    $message = t('failed to parse RSS feed "%site": %error at line %line.', array('%site' => $feed['title'], '%error' => xml_error_string(xml_get_error_code($xml_parser)), '%line' => xml_get_current_line_number($xml_parser)));
Dries Buytaert's avatar
   
Dries Buytaert committed
409
410
    drupal_set_message($message, 'error');
    return 0;
Dries Buytaert's avatar
   
Dries Buytaert committed
411
412
  }
  xml_parser_free($xml_parser);
Dries Buytaert's avatar
   
Dries Buytaert committed
413

Dries Buytaert's avatar
   
Dries Buytaert committed
414
  // initialize the translation table:
415
  $tt = array_flip(get_html_translation_table(HTML_SPECIALCHARS));
Dries Buytaert's avatar
   
Dries Buytaert committed
416
  $tt['&apos;'] = "'";
Dries Buytaert's avatar
   
Dries Buytaert committed
417

Dries Buytaert's avatar
   
Dries Buytaert committed
418
419
420
421
422
  /*
  ** We reverse the array such that we store the first item last,
  ** and the last item first.  In the database, the newest item
  ** should be at the top.
  */
Dries Buytaert's avatar
   
Dries Buytaert committed
423

Dries Buytaert's avatar
   
Dries Buytaert committed
424
  $items = array_reverse($items);
Dries Buytaert's avatar
   
Dries Buytaert committed
425

Dries Buytaert's avatar
   
Dries Buytaert committed
426
427
  foreach ($items as $item) {
    unset($title, $link, $author, $description);
428

Dries Buytaert's avatar
   
Dries Buytaert committed
429
430
431
432
    // Prepare the item:
    foreach ($item as $key => $value) {
      $item[$key] = filter_default(strtr(trim($value), $tt));
    }
Dries Buytaert's avatar
Dries Buytaert committed
433

Dries Buytaert's avatar
   
Dries Buytaert committed
434
435
436
437
438
439
    /*
    ** Resolve the item's title.  If no title is found, we use
    ** up to 40 characters of the description ending at a word
    ** boundary but not splitting potential entities.
    */

Dries Buytaert's avatar
   
Dries Buytaert committed
440
441
    if ($item['TITLE']) {
      $title = $item['TITLE'];
Dries Buytaert's avatar
   
Dries Buytaert committed
442
443
    }
    else {
Dries Buytaert's avatar
   
Dries Buytaert committed
444
      $title = preg_replace('/^(.*)[^\w;&].*?$/', "\\1", truncate_utf8($item['DESCRIPTION'], 40));
Dries Buytaert's avatar
   
Dries Buytaert committed
445
    }
Dries Buytaert's avatar
   
Dries Buytaert committed
446

Dries Buytaert's avatar
   
Dries Buytaert committed
447
448
449
450
    /*
    ** Resolve the items link.
    */

Dries Buytaert's avatar
   
Dries Buytaert committed
451
452
    if ($item['LINK']) {
      $link = $item['LINK'];
Dries Buytaert's avatar
   
Dries Buytaert committed
453
    }
Dries Buytaert's avatar
   
Dries Buytaert committed
454
455
    elseif ($item['GUID'] && (strncmp($item['GUID'], 'http://', 7) == 0)) {
      $link = $item['GUID'];
Dries Buytaert's avatar
   
Dries Buytaert committed
456
457
    }
    else {
Dries Buytaert's avatar
   
Dries Buytaert committed
458
      $link = $feed['link'];
Dries Buytaert's avatar
   
Dries Buytaert committed
459
    }
460

Dries Buytaert's avatar
   
Dries Buytaert committed
461
462
463
464
465
466
467
468
469
470
    /*
    ** Try to resolve and parse the item's publication date.  If no
    ** date is found, we use the current date instead.
    */

    if ($item['PUBDATE']) $date = $item['PUBDATE'];                        // RSS 2.0
    else if ($item['DC:DATE']) $date = $item['DC:DATE'];                   // Dublin core
    else if ($item['DCTERMS:ISSUED']) $date = $item['DCTERMS:ISSUED'];     // Dublin core
    else if ($item['DCTERMS:CREATED']) $date = $item['DCTERMS:CREATED'];   // Dublin core
    else if ($item['DCTERMS:MODIFIED']) $date = $item['DCTERMS:MODIFIED']; // Dublin core
Dries Buytaert's avatar
   
Dries Buytaert committed
471
    else $date = 'now';
Dries Buytaert's avatar
   
Dries Buytaert committed
472
473
474
475
476
477
478
479
480

    $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 Buytaert's avatar
   
Dries Buytaert committed
481
      list($year, $month, $day, $hour, $minute, $second) = sscanf($date, '%4d-%2d-%2dT%2d:%2d:%2d');
Dries Buytaert's avatar
   
Dries Buytaert committed
482
483
484
485
      $timestamp = strtotime("$year-$month-$day $hour:$minute:$second");
    }

    if ($timestamp < 0) {
Dries Buytaert's avatar
   
Dries Buytaert committed
486
      $timestamp = time();
487
    }
Dries Buytaert's avatar
   
Dries Buytaert committed
488
489

    /*
Dries Buytaert's avatar
   
Dries Buytaert committed
490
491
492
    ** Save this item.  Try to avoid duplicate entries as much as
    ** possible.  If we find a duplicate entry, we resolve it and
    ** pass along it's ID such that we can update it if needed.
Dries Buytaert's avatar
   
Dries Buytaert committed
493
494
    */

Dries Buytaert's avatar
   
Dries Buytaert committed
495
496
    if ($link && $link != $feed['link'] && $link != $feed['url']) {
      $entry = db_fetch_object(db_query("SELECT iid FROM {aggregator_item} WHERE fid = %d AND link = '%s'", $feed['fid'], $link));
Dries Buytaert's avatar
   
Dries Buytaert committed
497
498
    }
    else {
Dries Buytaert's avatar
   
Dries Buytaert committed
499
      $entry = db_fetch_object(db_query("SELECT iid FROM {aggregator_item} WHERE fid = %d AND title = '%s'", $feed['fid'], $title));
Dries Buytaert's avatar
   
Dries Buytaert committed
500
    }
Dries Buytaert's avatar
   
Dries Buytaert committed
501

502
503
504
505
506
507
    if (!valid_input_data($item['DESCRIPTION'])) {
      drupal_set_message(t('failed to parse entry from "%site" feed: suspicious input data.', array('%site' => $feed['title'])), 'error');
    }
    else {
      aggregator_save_item(array('iid' => $entry->iid, 'fid' => $feed['fid'], 'timestamp' => $timestamp, 'title' => $title, 'link' => $link, 'author' => $item['AUTHOR'], 'description' => $item['DESCRIPTION']));
    }
Dries Buytaert's avatar
   
Dries Buytaert committed
508
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
509

Dries Buytaert's avatar
   
Dries Buytaert committed
510
  /*
Dries Buytaert's avatar
   
Dries Buytaert committed
511
  ** Remove all items that are older than 3 months:
Dries Buytaert's avatar
   
Dries Buytaert committed
512
  */
Dries Buytaert's avatar
   
Dries Buytaert committed
513

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

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

  return 1;
527
528
}

529
function aggregator_save_item($edit) {
Dries Buytaert's avatar
   
Dries Buytaert committed
530
531
  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']);
532
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
533
534
535
  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']);
536
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
537
538
539
  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 Buytaert's avatar
   
Dries Buytaert committed
540
541
542
543
544
    // 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);
    }
545
546
547
  }
}

Dries Buytaert's avatar
   
Dries Buytaert committed
548
549
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'));
550

Dries Buytaert's avatar
   
Dries Buytaert committed
551
552
  $form = form_textfield(t('Title'), 'title', $edit['title'], 50, 64);
  $form .= form_textarea(t('Description'), 'description', $edit['description'], 60, 5);
Dries Buytaert's avatar
   
Dries Buytaert committed
553
  $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/block'))));
Dries Buytaert's avatar
   
Dries Buytaert committed
554
  $form .= form_submit(t('Submit'));
555

Dries Buytaert's avatar
   
Dries Buytaert committed
556
557
558
  if ($edit['cid']) {
    $form .= form_submit(t('Delete'));
    $form .= form_hidden('cid', $edit['cid']);
559
560
  }

Dries Buytaert's avatar
   
Dries Buytaert committed
561
  return form($form);
562
563
}

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

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

Dries Buytaert's avatar
   
Dries Buytaert committed
582
583
  if ($edit['refresh'] == '') {
    $edit['refresh'] = 3600;
Dries Buytaert's avatar
   
Dries Buytaert committed
584
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
585

Dries Buytaert's avatar
   
Dries Buytaert committed
586
587
588
  $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 Buytaert's avatar
   
Dries Buytaert committed
589
  $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/block'))));
Dries Buytaert's avatar
   
Dries Buytaert committed
590
  $categories = db_query('SELECT c.cid, c.title, f.fid FROM {aggregator_category} c LEFT JOIN {aggregator_category_feed} f ON c.cid = f.cid AND f.fid = %d ORDER BY title', $edit['fid']);
Dries Buytaert's avatar
   
Dries Buytaert committed
591
592
593
594
595
596
  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.'));
  }
597

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

Dries Buytaert's avatar
   
Dries Buytaert committed
600
601
602
  if ($edit['fid']) {
    $form .= form_submit(t('Delete'));
    $form .= form_hidden('fid', $edit['fid']);
603
604
  }

Dries Buytaert's avatar
   
Dries Buytaert committed
605
  return form($form);
606
607
}

608
function aggregator_save_feed($edit) {
Dries Buytaert's avatar
   
Dries Buytaert committed
609
610
611
  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']);
612
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
613
614
  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']);
615
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
616
617
618
619
620
621
622
623
624
625
  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']);
626
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
627
628
629
630
631
632
633
  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
634
635
636
637
638
    if ($edit['category']) {
      foreach ($edit['category'] as $cid => $checked) {
        if ($checked) {
          db_query('INSERT INTO {aggregator_category_feed} (fid, cid) VALUES (%d, %d)', $edit['fid'], $cid);
        }
Dries Buytaert's avatar
   
Dries Buytaert committed
639
640
      }
    }
641
642
643
  }
}

644
function aggregator_get_feed($fid) {
Dries Buytaert's avatar
   
Dries Buytaert committed
645
  return db_fetch_array(db_query('SELECT * FROM {aggregator_feed} WHERE fid = %d', $fid));
646
647
}

Dries Buytaert's avatar
   
Dries Buytaert committed
648
function aggregator_get_category($cid) {
Dries Buytaert's avatar
   
Dries Buytaert committed
649
  return db_fetch_array(db_query('SELECT * FROM {aggregator_category} WHERE cid = %d', $cid));
650
651
}

652
function aggregator_view() {
Dries Buytaert's avatar
   
Dries Buytaert committed
653
  $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');
654

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

Dries Buytaert's avatar
   
Dries Buytaert committed
657
  $header = array(t('title'), t('items'), t('last update'), t('next update'), array('data' => t('operations'), 'colspan' => 3));
Dries Buytaert's avatar
   
Dries Buytaert committed
658
  $rows = array();
659
  while ($feed = db_fetch_object($result)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
660
    $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"));
661
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
662
  $output .= theme('table', $header, $rows);
663

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

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

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

  return $output;
}

Dries Buytaert's avatar
   
Dries Buytaert committed
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
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.'));
    }
  }
  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.'));
    }

    drupal_goto('aggregator');
  }

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

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


Dries Buytaert's avatar
   
Dries Buytaert committed
717
/**
718
 * Menu callback; displays the category edit form, or saves changes and
Dries Buytaert's avatar
   
Dries Buytaert committed
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
 * 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 Buytaert's avatar
   
Dries Buytaert committed
735
736
      }
      else {
Dries Buytaert's avatar
   
Dries Buytaert committed
737
        $output = aggregator_form_category();
Dries Buytaert's avatar
   
Dries Buytaert committed
738
      }
Dries Buytaert's avatar
   
Dries Buytaert committed
739
740
741
742
743
  }
  print theme('page', $output);
}

/**
744
745
746
 * Menu callback; displays the feed edit form.
 *
 * After editing, saves changes and displays the overview page.
Dries Buytaert's avatar
   
Dries Buytaert committed
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
 */
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 Buytaert's avatar
   
Dries Buytaert committed
762
763
      }
      else {
Dries Buytaert's avatar
   
Dries Buytaert committed
764
        $output = aggregator_form_feed();
Dries Buytaert's avatar
   
Dries Buytaert committed
765
      }
766
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
767
768
769
770
  print theme('page', $output);
}

/**
771
 * Menu callback; removes all items from a feed, then displays the overview page.
Dries Buytaert's avatar
   
Dries Buytaert committed
772
773
774
775
776
777
778
 */
function aggregator_admin_remove_feed($feed) {
  aggregator_remove(aggregator_get_feed($feed));
  print theme('page', aggregator_view());
}

/**
779
 * Menu callback; refreshes a feed, then displays the overview page.
Dries Buytaert's avatar
   
Dries Buytaert committed
780
781
782
783
784
785
786
 */
function aggregator_admin_refresh_feed($feed) {
  aggregator_refresh(aggregator_get_feed($feed));
  print theme('page', aggregator_view());
}

/**
787
 * Menu callback; displays the aggregator administration page.
Dries Buytaert's avatar
   
Dries Buytaert committed
788
789
790
 */
function aggregator_admin_overview() {
  print theme('page', aggregator_view());
791
792
}

Dries Buytaert's avatar
   
Dries Buytaert committed
793
/**
794
 * Menu callback; displays the most recent items gathered from any feed.
Dries Buytaert's avatar
   
Dries Buytaert committed
795
 */
796
function aggregator_page_last() {
Dries Buytaert's avatar
   
Dries Buytaert committed
797
  _aggregator_page_list('SELECT i.*, f.title AS ftitle, f.link AS flink FROM {aggregator_item} i INNER JOIN {aggregator_feed} f ON i.fid = f.fid ORDER BY i.timestamp DESC, i.iid DESC', arg(1));
Dries Buytaert's avatar
   
Dries Buytaert committed
798
799
}

Dries Buytaert's avatar
   
Dries Buytaert committed
800
/**
801
 * Menu callback; displays all the items captured from a particular feed.
Dries Buytaert's avatar
   
Dries Buytaert committed
802
 */
803
function aggregator_page_source() {
Dries Buytaert's avatar
   
Dries Buytaert committed
804
  $feed = db_fetch_object(db_query('SELECT * FROM {aggregator_feed} WHERE fid = %d', arg(2)));
Dries Buytaert's avatar
   
Dries Buytaert committed
805
  $info = theme('aggregator_feed', $feed);
Dries Buytaert's avatar
   
Dries Buytaert committed
806

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

Dries Buytaert's avatar
   
Dries Buytaert committed
810
/**
811
 * Menu callback; displays all the items aggregated in a particular category.
Dries Buytaert's avatar
   
Dries Buytaert committed
812
 */
813
function aggregator_page_category() {
Dries Buytaert's avatar
   
Dries Buytaert committed
814
  $category = db_fetch_object(db_query('SELECT cid, title FROM {aggregator_category} WHERE cid = %d', arg(2)));
Dries Buytaert's avatar
   
Dries Buytaert committed
815

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

Dries Buytaert's avatar
   
Dries Buytaert committed
819
820
821
822
/**
 * Prints an aggregator page listing a number of feed items. Various
 * menu callbacks use this function to print their feeds.
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
823
function _aggregator_page_list($sql, $op, $header = '') {
Dries Buytaert's avatar
   
Dries Buytaert committed
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
  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);
          }
        }
      }
    }
    else {
      $categorize = true;
    }
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
839

Dries Buytaert's avatar
   
Dries Buytaert committed
840
841
842
843
844
845
846
  $output = '<div id="aggregator">';
  if ($header) {
    $output .= $header;
  }
  if ($links) {
    $output .= theme('links', $links);
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
847
848
849

  $result = pager_query($sql, 20);

Dries Buytaert's avatar
   
Dries Buytaert committed
850
851
  $rows = array();
  $categories = array();
Dries Buytaert's avatar
   
Dries Buytaert committed
852
  while ($item = db_fetch_object($result)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
    if ($categorize) {
      $categories_result = db_query('SELECT c.cid, c.title, ci.iid FROM {aggregator_category} c LEFT JOIN {aggregator_category_item} ci ON c.cid = ci.cid AND ci.iid = %d', $item->iid);
      if (variable_get('aggregator_category_selector', 'check') == 'select') {
        $selected = array();
        while ($category = db_fetch_object($categories_result)) {
          if (!$done) {
            $categories[$category->cid] = check_form($category->title);
          }
          if ($category->iid) {
            $selected[] = $category->cid;
          }
        }
        $done = true;
        $form = form_select(NULL, 'categories]['. $item->iid, $selected, $categories, NULL, 'size="10"', true);
      }
      else {
        $form = '';
        while ($category = db_fetch_object($categories_result)) {
          $form .= form_checkbox(check_form($category->title), 'categories]['. $item->iid .'][', $category->cid, !is_null($category->iid));
        }
      }
      $rows[] = array(theme('aggregator_page_item', $item), array('data' => $form, 'class' => 'categorize-item'));
    }
    else {
      $output .= theme('aggregator_page_item', $item);
    }
Dries Buytaert's avatar
   
Dries Buytaert committed
879
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
880
881
882
883
  if ($categorize) {
    $output .= form(theme('table', array('', t('categorize')), $rows) . form_submit(t('Save categories')));
  }
  $output .= '</div>';
Dries Buytaert's avatar
   
Dries Buytaert committed
884
885
886
887
888

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

Dries Buytaert's avatar
   
Dries Buytaert committed
889
  print theme('page', $output);
Dries Buytaert's avatar
   
Dries Buytaert committed
890
891
}

Dries Buytaert's avatar
   
Dries Buytaert committed
892
/**
893
 * Menu callback; displays all the feeds used by the aggregator.
Dries Buytaert's avatar
   
Dries Buytaert committed
894
 */
895
function aggregator_page_sources() {
Dries Buytaert's avatar
   
Dries Buytaert committed
896
897
  $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 Buytaert's avatar
   
Dries Buytaert committed
898
  while ($feed = db_fetch_object($result)) {
Dries Buytaert's avatar
   
Dries Buytaert committed
899
900
901
902
903
904
905
906
907
908
909
910
    $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 Buytaert's avatar
   
Dries Buytaert committed
911
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
912
  $output .= theme('xml_icon', url('aggregator/opml'));
Dries Buytaert's avatar
   
Dries Buytaert committed
913
914
  $output .= '</div>';
  print theme('page', $output);
Dries Buytaert's avatar
   
Dries Buytaert committed
915
916
}

Dries Buytaert's avatar
   
Dries Buytaert committed
917
/**
918
 * Menu callback; generates an OPML representation of all feeds.
Dries Buytaert's avatar
   
Dries Buytaert committed
919
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
920
function aggregator_page_opml() {
Dries Buytaert's avatar
   
Dries Buytaert committed
921
  $result = db_query('SELECT * FROM {aggregator_feed} ORDER BY title');
Dries Buytaert's avatar
   
Dries Buytaert committed
922

Dries Buytaert's avatar
   
Dries Buytaert committed
923
924
925
  $output = "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n";
  $output .= "<opml version=\"1.1\">\n";
  $output .= "<head>\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
926
927
  $output .= '<title>'. drupal_specialchars(variable_get('site_name', 'Drupal')) ."</title>\n";
  $output .= '<dateModified>'. gmdate('r') ."</dateModified>\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
928
929
  $output .= "</head>\n";
  $output .= "<body>\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
930
931

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

Dries Buytaert's avatar
   
Dries Buytaert committed
935
936
  $output .= "</body>\n";
  $output .= "</opml>\n";
Dries Buytaert's avatar
   
Dries Buytaert committed
937

Dries Buytaert's avatar
   
Dries Buytaert committed
938
  drupal_set_header('Content-Type: text/xml; charset=utf-8');
Dries Buytaert's avatar
   
Dries Buytaert committed
939
940
941
  print $output;
}

Dries Buytaert's avatar
   
Dries Buytaert committed
942
/**
943
 * Menu callback; displays all the categories used by the aggregator.
Dries Buytaert's avatar
   
Dries Buytaert committed
944
 */
Dries Buytaert's avatar
   
Dries Buytaert committed
945
946
947
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 Buytaert's avatar
   
Dries Buytaert committed
948

Dries Buytaert's avatar
   
Dries Buytaert committed
949
950
951
952
953
954
  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 Buytaert's avatar
   
Dries Buytaert committed
955
        $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 Buytaert's avatar
   
Dries Buytaert committed
956
      }
Dries Buytaert's avatar
   
Dries Buytaert committed
957
      $output .= theme('item_list', $list);
Dries Buytaert's avatar
   
Dries Buytaert committed
958
    }
Dries Buytaert's avatar
   
Dries Buytaert committed
959
    $output .= '<div class="more-link">'. l(t('more'), 'aggregator/categories/'. $category->cid) .'</div>';
Dries Buytaert's avatar
   
Dries Buytaert committed
960
  }
Dries Buytaert's avatar
   
Dries Buytaert committed
961
  $output .= '</div>';
Dries Buytaert's avatar
   
Dries Buytaert committed
962

Dries Buytaert's avatar
   
Dries Buytaert committed
963
  print theme('page', $output);
Dries Buytaert's avatar
   
Dries Buytaert committed
964
}
Dries Buytaert's avatar
   
Dries Buytaert committed
965

966
967
968
969
970
/**
 * @addtogroup themeable
 * @{
 */