aggregator.module 55.5 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
/**
 * @file
6
 * Used to aggregate syndicated content (RSS, RDF, and Atom).
Dries's avatar
 
Dries committed
7 8
 */

Dries's avatar
 
Dries committed
9 10 11
/**
 * Implementation of hook_help().
 */
Dries's avatar
 
Dries committed
12
function aggregator_help($section) {
Dries's avatar
 
Dries committed
13
  switch ($section) {
Kjartan's avatar
Kjartan committed
14
    case 'admin/help#aggregator':
15
      $output = '<p>'. t('The news aggregator is a powerful on-site RSS syndicator/news reader that can gather fresh content from news sites and weblogs around the web.') .'</p>';
16 17
      $output .= '<p>'. t('Users can view the latest news chronologically in the <a href="@aggregator">main news aggregator display</a> or by <a href="@aggregator-sources">source</a>. Administrators can add, edit and delete feeds and choose how often to check for newly updated news for each individual feed. Administrators can also tag individual feeds with categories, offering selective grouping of some feeds into separate displays. Listings of the latest news for individual sources or categorized sources can be enabled as blocks for display in the sidebar through the <a href="@admin-block">block administration page</a>. The news aggregator requires cron to check for the latest news from the sites to which you have subscribed. Drupal also provides a <a href="@aggregator-opml">machine-readable OPML file</a> of all of your subscribed feeds.', array('@aggregator' => url('aggregator'), '@aggregator-sources' => url('aggregator/sources'), '@admin-block' => url('admin/build/block'), '@aggregator-opml' => url('aggregator/opml'))) .'</p>';
      $output .= '<p>'. t('For more information please read the configuration and customization handbook <a href="@aggregator">Aggregator page</a>.', array('@aggregator' => 'http://drupal.org/handbook/modules/aggregator/')) .'</p>';
18
      return $output;
19
    case 'admin/content/aggregator':
20
      return '<p>'. t('Thousands of sites (particularly news sites and weblogs) publish their latest headlines and/or stories in a machine-readable format so that other sites can easily link to them. This content is usually in the form of an <a href="http://blogs.law.harvard.edu/tech/rss">RSS</a> feed (which is an XML-based syndication standard). To display the feed or category in a block you must decide how many items to show by editing the feed or block and turning on the <a href="@block">feed\'s block</a>.', array('@block' => url('admin/build/block'))) .'</p>';
21
    case 'admin/content/aggregator/add/feed':
22
      return '<p>'. t('Add a site that has an RSS/RDF/Atom feed. The URL is the full path to the feed file. For the feed to update automatically you must run "cron.php" on a regular basis. If you already have a feed with the URL you are planning to use, the system will not accept another feed with the same URL.') .'</p>';
23
    case 'admin/content/aggregator/add/category':
24
      return '<p>'. t('Categories provide a way to group items from different news feeds together. Each news category has its own feed page and block. For example, you could tag various sport-related feeds as belonging to a category called <em>Sports</em>. News items can be added to a category automatically by setting a feed to automatically place its item into that category, or by using the categorize items link in any listing of news items.') .'</p>';
Dries's avatar
 
Dries committed
25
  }
26 27
}

28 29 30 31 32 33 34 35 36
/**
 * Implementation of hook_menu().
 */
function aggregator_menu($may_cache) {
  $items = array();
  $edit = user_access('administer news feeds');
  $view = user_access('access news feeds');

  if ($may_cache) {
37
    $items[] = array('path' => 'admin/content/aggregator',
38
      'title' => t('News aggregator'),
39
      'description' => t("Configure which content your site aggregates from other sites, how often it polls them, and how they're categorized."),
40 41
      'callback' => 'aggregator_admin_overview',
      'access' => $edit);
42
    $items[] = array('path' => 'admin/content/aggregator/add/feed',
43
      'title' => t('Add feed'),
44 45
      'callback' => 'drupal_get_form',
      'callback arguments' => array('aggregator_form_feed'),
46 47
      'access' => $edit,
      'type' => MENU_LOCAL_TASK);
48
    $items[] = array('path' => 'admin/content/aggregator/add/category',
49
      'title' => t('Add category'),
50 51
      'callback' => 'drupal_get_form',
      'callback arguments' => array('aggregator_form_category'),
52 53
      'access' => $edit,
      'type' => MENU_LOCAL_TASK);
54
    $items[] = array('path' => 'admin/content/aggregator/remove',
55
      'title' => t('Remove items'),
56 57 58
      'callback' => 'aggregator_admin_remove_feed',
      'access' => $edit,
      'type' => MENU_CALLBACK);
59
    $items[] = array('path' => 'admin/content/aggregator/update',
60
      'title' => t('Update items'),
61 62 63
      'callback' => 'aggregator_admin_refresh_feed',
      'access' => $edit,
      'type' => MENU_CALLBACK);
64
    $items[] = array('path' => 'admin/content/aggregator/list',
65
      'title' => t('List'),
66 67
      'type' => MENU_DEFAULT_LOCAL_TASK,
      'weight' => -10);
68
    $items[] = array('path' => 'admin/content/aggregator/settings',
69
      'title' => t('Settings'),
70 71
      'callback' => 'drupal_get_form',
      'callback arguments' => array('aggregator_admin_settings'),
72 73
      'type' => MENU_LOCAL_TASK,
      'weight' => 10,
Dries's avatar
Dries committed
74
      'access' => $edit);
75

76
    $items[] = array('path' => 'aggregator',
77
      'title' => t('News aggregator'),
78 79 80 81
      'callback' => 'aggregator_page_last',
      'access' => $view,
      'weight' => 5);
    $items[] = array('path' => 'aggregator/sources',
82
      'title' => t('Sources'),
83 84 85
      'callback' => 'aggregator_page_sources',
      'access' => $view);
    $items[] = array('path' => 'aggregator/categories',
86
      'title' => t('Categories'),
87 88 89 90 91 92 93 94 95 96 97 98 99
      'callback' => 'aggregator_page_categories',
      'access' => $view,
      'type' => MENU_ITEM_GROUPING);
    $items[] = array('path' => 'aggregator/rss',
      'title' => t('RSS feed'),
      'callback' => 'aggregator_page_rss',
      'access' => $view,
      'type' => MENU_CALLBACK);
    $items[] = array('path' => 'aggregator/opml',
      'title' => t('OPML feed'),
      'callback' => 'aggregator_page_opml',
      'access' => $view,
      'type' => MENU_CALLBACK);
100

101 102 103 104 105 106 107
    $result = db_query('SELECT title, cid FROM {aggregator_category} ORDER BY title');
    while ($category = db_fetch_array($result)) {
      $items[] = array('path' => 'aggregator/categories/'. $category['cid'],
        'title' => $category['title'],
        'callback' => 'aggregator_page_category',
        'access' => $view);
    }
108 109
  }
  else {
110 111 112 113
    // Add the CSS for this module
    // We put this in !$may_cache so it's only added once per request
    drupal_add_css(drupal_get_path('module', 'aggregator') .'/aggregator.css');

114 115 116 117 118
    if (arg(0) == 'aggregator' && is_numeric(arg(2))) {
      if (arg(1) == 'sources') {
        $feed = aggregator_get_feed(arg(2));
        if ($feed) {
          $items[] = array('path' => 'aggregator/sources/'. $feed['fid'],
119
            'title' => $feed['title'],
120
            'callback' => 'aggregator_page_source',
121 122
            'access' => $view,
            'type' => MENU_CALLBACK);
123
          $items[] = array('path' => 'aggregator/sources/'. $feed['fid'] .'/view',
124
            'title' => t('View'),
125 126 127
            'type' => MENU_DEFAULT_LOCAL_TASK,
            'weight' => -10);
          $items[] = array('path' => 'aggregator/sources/'. $feed['fid'] .'/categorize',
128
            'title' => t('Categorize'),
Kjartan's avatar
 
Kjartan committed
129 130
            'callback' => 'drupal_get_form',
            'callback arguments' => array('aggregator_page_source'),
131 132 133
            'access' => $edit,
            'type' => MENU_LOCAL_TASK);
          $items[] = array('path' => 'aggregator/sources/'. $feed['fid'] .'/configure',
134
            'title' => t('Configure'),
Kjartan's avatar
 
Kjartan committed
135 136
            'callback' => 'drupal_get_form',
            'callback arguments' => array('aggregator_form_feed', $feed),
137 138 139 140 141 142 143 144 145
            'access' => $edit,
            'type' => MENU_LOCAL_TASK,
            'weight' => 1);
        }
      }
      else if (arg(1) == 'categories') {
        $category = aggregator_get_category(arg(2));
        if ($category) {
          $items[] = array('path' => 'aggregator/categories/'. $category['cid'] .'/view',
146
            'title' => t('View'),
147 148 149
            'type' => MENU_DEFAULT_LOCAL_TASK,
            'weight' => -10);
          $items[] = array('path' => 'aggregator/categories/'. $category['cid'] .'/categorize',
150
            'title' => t('Categorize'),
Kjartan's avatar
 
Kjartan committed
151 152
            'callback' => 'drupal_get_form',
            'callback arguments' => array('aggregator_page_category'),
153 154 155
            'access' => $edit,
            'type' => MENU_LOCAL_TASK);
          $items[] = array('path' => 'aggregator/categories/'. $category['cid'] .'/configure',
156
            'title' => t('Configure'),
Kjartan's avatar
 
Kjartan committed
157 158
            'callback' => 'drupal_get_form',
            'callback arguments' => array('aggregator_form_category', $category),
159 160 161 162 163 164
            'access' => $edit,
            'type' => MENU_LOCAL_TASK,
            'weight' => 1);
        }
      }
    }
165 166 167
    else if (arg(2) == 'aggregator' && is_numeric(arg(5))) {
      if (arg(4) == 'feed') {
        $feed = aggregator_get_feed(arg(5));
168
        if ($feed) {
169
          $items[] = array('path' => 'admin/content/aggregator/edit/feed/'. $feed['fid'],
170
            'title' => t('Edit feed'),
171 172
            'callback' => 'drupal_get_form',
            'callback arguments' => array('aggregator_form_feed', $feed),
173 174 175 176 177
            'access' => $edit,
            'type' => MENU_CALLBACK);
        }
      }
      else {
178
        $category = aggregator_get_category(arg(5));
179
        if ($category) {
180
          $items[] = array('path' => 'admin/content/aggregator/edit/category/'. $category['cid'],
181
            'title' => t('Edit category'),
182 183
            'callback' => 'drupal_get_form',
            'callback arguments' => array('aggregator_form_category', $category),
184 185 186 187 188 189 190 191 192 193
            'access' => $edit,
            'type' => MENU_CALLBACK);
        }
      }
    }
  }

  return $items;
}

Dries's avatar
Dries committed
194
function aggregator_admin_settings() {
195
  $items = array(0 => t('none')) + drupal_map_assoc(array(3, 5, 10, 15, 20, 25), '_aggregator_items');
196
  $period = drupal_map_assoc(array(3600, 10800, 21600, 32400, 43200, 86400, 172800, 259200, 604800, 1209600, 2419200, 4838400, 9676800), 'format_interval');
Dries's avatar
 
Dries committed
197

198
  $form['aggregator_allowed_html_tags'] = array(
199 200 201
    '#type' => 'textfield', '#title' => t('Allowed HTML tags'), '#size' => 80, '#maxlength' => 255,
    '#default_value' => variable_get('aggregator_allowed_html_tags', '<a> <b> <br> <dd> <dl> <dt> <em> <i> <li> <ol> <p> <strong> <u> <ul>'),
    '#description' => t('The list of tags which are allowed in feeds, i.e., which will not be removed by Drupal.')
202 203 204
  );

  $form['aggregator_summary_items'] = array(
205 206 207
    '#type' => 'select', '#title' => t('Items shown in sources and categories pages') ,
    '#default_value' => variable_get('aggregator_summary_items', 3), '#options' => $items,
    '#description' =>  t('The number of items which will be shown with each feed or category in the feed and category summary pages.')
208 209 210
  );

  $form['aggregator_clear'] = array(
211 212
    '#type' => 'select', '#title' => t('Discard news items older than'),
    '#default_value' => variable_get('aggregator_clear', 9676800), '#options' => $period,
213
    '#description' => t('Older news items will be automatically discarded. Requires crontab.')
214
  );
215

216
  $form['aggregator_category_selector'] = array(
217
    '#type' => 'radios', '#title' => t('Category selection type'), '#default_value' => variable_get('aggregator_category_selector', 'checkboxes'),
218
    '#options' => array('checkboxes' => t('checkboxes'), 'select' => t('multiple selector')),
219
    '#description' => 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.')
220
  );
Dries's avatar
Dries committed
221

222
  return system_settings_form($form);
Dries's avatar
 
Dries committed
223 224
}

Dries's avatar
 
Dries committed
225 226 227
/**
 * Implementation of hook_perm().
 */
Kjartan's avatar
Kjartan committed
228
function aggregator_perm() {
Dries's avatar
 
Dries committed
229
  return array('administer news feeds', 'access news feeds');
Dries's avatar
 
Dries committed
230 231
}

Dries's avatar
 
Dries committed
232 233 234 235 236
/**
 * Implementation of hook_cron().
 *
 * Checks news feeds for updates once their refresh interval has elapsed.
 */
Dries's avatar
 
Dries committed
237
function aggregator_cron() {
Dries's avatar
 
Dries committed
238
  $result = db_query('SELECT * FROM {aggregator_feed} WHERE checked + refresh < %d', time());
Dries's avatar
 
Dries committed
239 240
  while ($feed = db_fetch_array($result)) {
    aggregator_refresh($feed);
Dries's avatar
 
Dries committed
241 242 243
  }
}

Dries's avatar
 
Dries committed
244 245 246 247 248
/**
 * Implementation of hook_block().
 *
 * Generates blocks for the latest news items in each category and feed.
 */
249
function aggregator_block($op = 'list', $delta = 0, $edit = array()) {
Dries's avatar
 
Dries committed
250
  if (user_access('access news feeds')) {
Dries's avatar
 
Dries committed
251
    if ($op == 'list') {
Dries's avatar
Dries committed
252
      $result = db_query('SELECT cid, title FROM {aggregator_category} ORDER BY title');
Dries's avatar
 
Dries committed
253
      while ($category = db_fetch_object($result)) {
254
        $block['category-'. $category->cid]['info'] = t('!title category latest items', array('!title' => $category->title));
Kjartan's avatar
Kjartan committed
255
      }
Dries's avatar
Dries committed
256
      $result = db_query('SELECT fid, title FROM {aggregator_feed} ORDER BY fid');
Kjartan's avatar
Kjartan committed
257
      while ($feed = db_fetch_object($result)) {
258
        $block['feed-'. $feed->fid]['info'] = t('!title feed latest items', array('!title' => $feed->title));
Kjartan's avatar
Kjartan committed
259
      }
Dries's avatar
 
Dries committed
260
    }
Dries's avatar
Dries committed
261
    else if ($op == 'configure') {
262
      list($type, $id) = explode('-', $delta);
Dries's avatar
Dries committed
263 264 265 266 267 268
      if ($type == 'category') {
        $value = db_result(db_query('SELECT block FROM {aggregator_category} WHERE cid = %d', $id));
      }
      else {
        $value = db_result(db_query('SELECT block FROM {aggregator_feed} WHERE fid = %d', $id));
      }
269
      $form['block'] = array('#type' => 'select', '#title' => t('Number of news items in block'), '#default_value' => $value, '#options' => drupal_map_assoc(array(2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20)));
270
      return $form;
Dries's avatar
Dries committed
271 272
    }
    else if ($op == 'save') {
273
      list($type, $id) = explode('-', $delta);
Dries's avatar
Dries committed
274 275 276 277 278 279 280
      if ($type == 'category') {
        $value = db_query('UPDATE {aggregator_category} SET block = %d WHERE cid = %d', $edit['block'], $id);
      }
      else {
        $value = db_query('UPDATE {aggregator_feed} SET block = %d WHERE fid = %d', $edit['block'], $id);
      }
    }
281
    else if ($op == 'view') {
282
      list($type, $id) = explode('-', $delta);
Kjartan's avatar
Kjartan committed
283
      switch ($type) {
Dries's avatar
 
Dries committed
284
        case 'feed':
285
          if ($feed = db_fetch_object(db_query('SELECT fid, title, block FROM {aggregator_feed} WHERE fid = %d', $id))) {
286
            $block['subject'] = check_plain($feed->title);
287
            $result = db_query_range('SELECT * FROM {aggregator_item} WHERE fid = %d ORDER BY timestamp DESC, iid DESC', $feed->fid, 0, $feed->block);
288
            $read_more = '<div class="more-link">'. l(t('more'), 'aggregator/sources/'. $feed->fid, array('title' => t("View this feed's recent news."))) .'</div>';
289
          }
Kjartan's avatar
Kjartan committed
290
          break;
291

Dries's avatar
 
Dries committed
292
        case 'category':
293
          if ($category = db_fetch_object(db_query('SELECT cid, title, block FROM {aggregator_category} WHERE cid = %d', $id))) {
294
            $block['subject'] = check_plain($category->title);
295
            $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);
296
            $read_more = '<div class="more-link">'. l(t('more'), 'aggregator/categories/'. $category->cid, array('title' => t("View this category's recent news."))) .'</div>';
297
          }
Kjartan's avatar
Kjartan committed
298 299
          break;
      }
Dries's avatar
 
Dries committed
300 301
      $items = array();
      while ($item = db_fetch_object($result)) {
Dries's avatar
 
Dries committed
302
        $items[] = theme('aggregator_block_item', $item);
Dries's avatar
 
Dries committed
303
      }
304 305 306 307 308

      // Only display the block if there are items to show.
      if (count($items) > 0) {
        $block['content'] = theme('item_list', $items) . $read_more;
      }
Dries's avatar
 
Dries committed
309
    }
Dries's avatar
 
Dries committed
310
    return $block;
Dries's avatar
 
Dries committed
311
  }
Dries's avatar
 
Dries committed
312 313
}

314 315 316 317 318 319 320 321 322 323 324 325 326 327
/**
 * Generate a form to add/edit/delete aggregator categories.
 */
 function aggregator_form_category($edit = array()) {
  $form['title'] = array('#type' => 'textfield',
    '#title' => t('Title'),
    '#default_value' => $edit['title'],
    '#maxlength' => 64,
    '#required' => TRUE,
  );
  $form['description'] = array('#type' => 'textarea',
    '#title' => t('Description'),
    '#default_value' => $edit['description'],
  );
328
  $form['submit'] = array('#type' => 'submit', '#value' => t('Submit'));
329 330

  if ($edit['cid']) {
331
    $form['delete'] = array('#type' => 'submit', '#value' => t('Delete'));
332 333 334
    $form['cid'] = array('#type' => 'hidden', '#value' => $edit['cid']);
  }

335
  return $form;
336 337 338 339 340 341
}

/**
 * Validate aggregator_form_feed form submissions.
 */
function aggregator_form_category_validate($form_id, $form_values) {
342
  if ($form_values['op'] == t('Submit')) {
343 344 345 346 347 348 349 350
    // Check for duplicate titles
    if (isset($form_values['cid'])) {
      $category = db_fetch_object(db_query("SELECT cid FROM {aggregator_category} WHERE title = '%s' AND cid != %d", $form_values['title'], $form_values['cid']));
    }
    else {
      $category = db_fetch_object(db_query("SELECT cid FROM {aggregator_category} WHERE title = '%s'", $form_values['title']));
    }
    if ($category) {
351
      form_set_error('title', t('A category named %category already exists. Please enter a unique title.', array('%category' => $form_values['title'])));
352 353 354 355 356 357 358 359 360
    }
  }
}

/**
 * Process aggregator_form_category form submissions.
 * @todo Add delete confirmation dialog.
 */
function aggregator_form_category_submit($form_id, $form_values) {
361
  if ($form_values['op'] == t('Delete')) {
362 363 364 365 366 367 368 369
    $title = $form_values['title'];
    // Unset the title:
    unset($form_values['title']);
  }
  aggregator_save_category($form_values);
  menu_rebuild();
  if (isset($form_values['cid'])) {
    if (isset($form_values['title'])) {
370
      drupal_set_message(t('The category %category has been updated.', array('%category' => $form_values['title'])));
371
      if (arg(0) == 'admin') {
372
        return 'admin/content/aggregator/';
373 374 375 376 377 378
      }
      else {
        return 'aggregator/categories/'. $form_values['cid'];
      }
    }
    else {
379 380
      watchdog('aggregator', t('Category %category deleted.', array('%category' => $title)));
      drupal_set_message(t('The category %category has been deleted.', array('%category' => $title)));
381
      if (arg(0) == 'admin') {
382
        return 'admin/content/aggregator/';
383 384 385 386 387 388 389
      }
      else {
        return 'aggregator/categories/';
      }
    }
  }
  else {
390 391
    watchdog('aggregator', t('Category %category added.', array('%category' => $form_values['title'])), WATCHDOG_NOTICE, l(t('view'), 'admin/content/aggregator'));
    drupal_set_message(t('The category %category has been added.', array('%category' => $form_values['title'])));
392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425
  }
}

/**
 * Add/edit/delete aggregator categories.
 */
function aggregator_save_category($edit) {
  if ($edit['cid'] && $edit['title']) {
    db_query("UPDATE {aggregator_category} SET title = '%s', description = '%s' WHERE cid = %d", $edit['title'], $edit['description'], $edit['cid']);
  }
  else if ($edit['cid']) {
    db_query('DELETE FROM {aggregator_category} WHERE cid = %d', $edit['cid']);
  }
  else if ($edit['title']) {
    // A single unique id for bundles and feeds, to use in blocks
    $next_id = db_next_id('{aggregator_category}_cid');
    db_query("INSERT INTO {aggregator_category} (cid, title, description, block) VALUES (%d, '%s', '%s', 5)", $next_id, $edit['title'], $edit['description']);
  }
}

/**
 * Generate a form to add/edit feed sources.
 */
function aggregator_form_feed($edit = array()) {
  $period = drupal_map_assoc(array(900, 1800, 3600, 7200, 10800, 21600, 32400, 43200, 64800, 86400, 172800, 259200, 604800, 1209600, 2419200), 'format_interval');

  if ($edit['refresh'] == '') {
    $edit['refresh'] = 3600;
  }

  $form['title'] = array('#type' => 'textfield',
    '#title' => t('Title'),
    '#default_value' => $edit['title'],
    '#maxlength' => 64,
426
    '#description' => t('The name of the feed; typically the name of the web site you syndicate content from.'),
427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447
    '#required' => TRUE,
  );
  $form['url'] = array('#type' => 'textfield',
    '#title' => t('URL'),
    '#default_value' => $edit['url'],
    '#maxlength' => 255,
    '#description' => t('The fully-qualified URL of the feed.'),
    '#required' => TRUE,
  );
  $form['refresh'] = array('#type' => 'select',
    '#title' => t('Update interval'),
    '#default_value' => $edit['refresh'],
    '#options' => $period,
    '#description' => t('The refresh interval indicating how often you want to update this feed. Requires crontab.'),
  );

  // Handling of categories:
  $options = array();
  $values = array();
  $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']);
  while ($category = db_fetch_object($categories)) {
448 449
    $options[$category->cid] = check_plain($category->title);
    if ($category->fid) $values[] = $category->cid;
450 451 452 453 454 455 456 457 458
  }
  if ($options) {
    $form['category'] = array('#type' => 'checkboxes',
      '#title' => t('Categorize news items'),
      '#default_value' => $values,
      '#options' => $options,
      '#description' => t('New items in this feed will be automatically filed in the checked categories as they are received.'),
    );
  }
459
  $form['submit'] = array('#type' => 'submit', '#value' => t('Submit'));
460 461

  if ($edit['fid']) {
462
    $form['delete'] = array('#type' => 'submit', '#value' => t('Delete'));
463 464 465
    $form['fid'] = array('#type' => 'hidden', '#value' => $edit['fid']);
  }

466
  return $form;
467 468 469 470 471 472
}

/**
 * Validate aggregator_form_feed form submissions.
 */
function aggregator_form_feed_validate($form_id, $form_values) {
473
  if ($form_values['op'] == t('Submit')) {
474 475 476 477 478 479 480 481 482
    // Check for duplicate titles
    if (isset($form_values['fid'])) {
      $result = db_query("SELECT title, url FROM {aggregator_feed} WHERE (title = '%s' OR url='%s') AND fid != %d", $form_values['title'], $form_values['url'], $form_values['fid']);
    }
    else {
      $result = db_query("SELECT title, url FROM {aggregator_feed} WHERE title = '%s' OR url='%s'", $form_values['title'], $form_values['url']);
    }
    while ($feed = db_fetch_object($result)) {
      if (strcasecmp($feed->title, $form_values['title']) == 0) {
483
        form_set_error('title', t('A feed named %feed already exists. Please enter a unique title.', array('%feed' => $form_values['title'])));
484
      }
485 486 487
      if (strcasecmp($feed->url, $form_values['url']) == 0) {
        form_set_error('url', t('A feed with this URL %url already exists. Please enter a unique URL.', array('%url' => $form_values['url'])));
      }
488 489 490 491 492 493 494 495 496
    }
  }
}

/**
 * Process aggregator_form_feed form submissions.
 * @todo Add delete confirmation dialog.
 */
function aggregator_form_feed_submit($form_id, $form_values) {
497
  if ($form_values['op'] == t('Delete')) {
498 499 500 501 502 503 504 505
    $title = $form_values['title'];
    // Unset the title:
    unset($form_values['title']);
  }
  aggregator_save_feed($form_values);
  menu_rebuild();
  if (isset($form_values['fid'])) {
    if (isset($form_values['title'])) {
506
      drupal_set_message(t('The feed %feed has been updated.', array('%feed' => $form_values['title'])));
507
      if (arg(0) == 'admin') {
508
        return 'admin/content/aggregator/';
509 510 511 512 513 514
      }
      else {
        return 'aggregator/sources/'. $form_values['fid'];
      }
    }
    else {
515 516
      watchdog('aggregator', t('Feed %feed deleted.', array('%feed' => $title)));
      drupal_set_message(t('The feed %feed has been deleted.', array('%feed' => $title)));
517
      if (arg(0) == 'admin') {
518
        return 'admin/content/aggregator/';
519 520 521 522 523 524 525
      }
      else {
        return 'aggregator/sources/';
      }
    }
  }
  else {
526 527
    watchdog('aggregator', t('Feed %feed added.', array('%feed' => $form_values['title'])), WATCHDOG_NOTICE, l(t('view'), 'admin/content/aggregator'));
    drupal_set_message(t('The feed %feed has been added.', array('%feed' => $form_values['title'])));
528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569
  }
}

/**
 * Add/edit/delete an aggregator feed.
 */
function aggregator_save_feed($edit) {
  if ($edit['fid']) {
    // An existing feed is being modified, delete the category listings.
    db_query('DELETE FROM {aggregator_category_feed} WHERE fid = %d', $edit['fid']);
  }
  if ($edit['fid'] && $edit['title']) {
    db_query("UPDATE {aggregator_feed} SET title = '%s', url = '%s', refresh = %d WHERE fid = %d", $edit['title'], $edit['url'], $edit['refresh'], $edit['fid']);
  }
  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']);
  }
  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, 5)", $edit['fid'], $edit['title'], $edit['url'], $edit['refresh']);
  }
  if ($edit['title']) {
    // The feed is being saved, save the categories as well.
    if ($edit['category']) {
      foreach ($edit['category'] as $cid => $value) {
        if ($value) {
          db_query('INSERT INTO {aggregator_category_feed} (fid, cid) VALUES (%d, %d)', $edit['fid'], $cid);
        }
      }
    }
  }
}

Dries's avatar
 
Dries committed
570 571 572 573
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
574
  }
Dries's avatar
 
Dries committed
575 576
  if ($items) {
    db_query('DELETE FROM {aggregator_category_item} WHERE '. implode(' OR ', $items));
Dries's avatar
 
Dries committed
577
  }
Dries's avatar
 
Dries committed
578
  db_query('DELETE FROM {aggregator_item} WHERE fid = %d', $feed['fid']);
Kjartan's avatar
Kjartan committed
579
  db_query("UPDATE {aggregator_feed} SET checked = 0, etag = '', modified = 0 WHERE fid = %d", $feed['fid']);
580
  drupal_set_message(t('The news items from %site have been removed.', array('%site' => $feed['title'])));
Dries's avatar
 
Dries committed
581 582
}

Dries's avatar
 
Dries committed
583 584 585
/**
 * Call-back function used by the XML parser.
 */
Kjartan's avatar
Kjartan committed
586
function aggregator_element_start($parser, $name, $attributes) {
587
  global $item, $element, $tag, $items, $channel;
Dries's avatar
 
Dries committed
588 589

  switch ($name) {
Dries's avatar
 
Dries committed
590 591
    case 'IMAGE':
    case 'TEXTINPUT':
592 593 594 595 596 597
    case 'CONTENT':
    case 'SUMMARY':
    case 'TAGLINE':
    case 'SUBTITLE':
    case 'LOGO':
    case 'INFO':
Dries's avatar
 
Dries committed
598 599
      $element = $name;
      break;
600 601 602 603
    case 'ID':
      if ($element != 'ITEM') {
        $element = $name;
      }
604 605 606 607 608 609 610 611 612 613
    case 'LINK':
      if ($attributes['REL'] == 'alternate') {
        if ($element == 'ITEM') {
          $items[$item]['LINK'] = $attributes['HREF'];
        }
        else {
          $channel['LINK'] = $attributes['HREF'];
        }
      }
      break;
Dries's avatar
 
Dries committed
614
    case 'ITEM':
Dries's avatar
 
Dries committed
615 616
      $element = $name;
      $item += 1;
617 618 619 620 621
      break;
    case 'ENTRY':
      $element = 'ITEM';
      $item += 1;
      break;
622 623 624 625 626
  }

  $tag = $name;
}

Dries's avatar
 
Dries committed
627 628 629
/**
 * Call-back function used by the XML parser.
 */
Kjartan's avatar
Kjartan committed
630
function aggregator_element_end($parser, $name) {
Dries's avatar
 
Dries committed
631 632
  global $element;

Dries's avatar
 
Dries committed
633
  switch ($name) {
Dries's avatar
 
Dries committed
634 635 636
    case 'IMAGE':
    case 'TEXTINPUT':
    case 'ITEM':
637 638 639
    case 'ENTRY':
    case 'CONTENT':
    case 'INFO':
640 641
      $element = '';
      break;
642
    case 'ID':
643
      if ($element == 'ID') {
644 645
        $element = '';
      }
Dries's avatar
 
Dries committed
646
  }
647 648
}

Dries's avatar
 
Dries committed
649 650 651
/**
 * Call-back function used by the XML parser.
 */
Kjartan's avatar
Kjartan committed
652
function aggregator_element_data($parser, $data) {
Dries's avatar
 
Dries committed
653
  global $channel, $element, $items, $item, $image, $tag;
Dries's avatar
 
Dries committed
654
  switch ($element) {
Dries's avatar
 
Dries committed
655
    case 'ITEM':
Dries's avatar
 
Dries committed
656 657
      $items[$item][$tag] .= $data;
      break;
Dries's avatar
 
Dries committed
658
    case 'IMAGE':
659
    case 'LOGO':
Dries's avatar
 
Dries committed
660 661
      $image[$tag] .= $data;
      break;
662 663 664 665 666 667
    case 'LINK':
      if ($data) {
        $items[$item][$tag] .= $data;
      }
      break;
    case 'CONTENT':
668
      $items[$item]['CONTENT'] .= $data;
669 670
      break;
    case 'SUMMARY':
671
      $items[$item]['SUMMARY'] .= $data;
672 673 674 675 676 677 678
      break;
    case 'TAGLINE':
    case 'SUBTITLE':
      $channel['DESCRIPTION'] .= $data;
      break;
    case 'INFO':
    case 'ID':
Dries's avatar
 
Dries committed
679 680 681
    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
682 683 684
      break;
    default:
      $channel[$tag] .= $data;
685 686 687
  }
}

Dries's avatar
 
Dries committed
688 689 690
/**
 * Checks a news feed for new items.
 */
Kjartan's avatar
Kjartan committed
691
function aggregator_refresh($feed) {
Dries's avatar
 
Dries committed
692 693
  global $channel, $image;

Dries's avatar
 
Dries committed
694 695 696 697 698 699
  // Generate conditional GET headers.
  $headers = array();
  if ($feed['etag']) {
    $headers['If-None-Match'] = $feed['etag'];
  }
  if ($feed['modified']) {
Dries's avatar
 
Dries committed
700
    $headers['If-Modified-Since'] = gmdate('D, d M Y H:i:s', $feed['modified']) .' GMT';
Dries's avatar
 
Dries committed
701 702 703 704 705
  }

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

706
  // Process HTTP response code.
Dries's avatar
 
Dries committed
707 708
  switch ($result->code) {
    case 304:
Dries's avatar
 
Dries committed
709
      db_query('UPDATE {aggregator_feed} SET checked = %d WHERE fid = %d', time(), $feed['fid']);
710
      drupal_set_message(t('There is no new syndicated content from %site.', array('%site' => $feed['title'])));
Dries's avatar
 
Dries committed
711
      break;
Dries's avatar
 
Dries committed
712 713
    case 301:
      $feed['url'] = $result->redirect_url;
714
      watchdog('aggregator', t('Updated URL for feed %title to %url.', array('%title' => $feed['title'], '%url' => $feed['url'])));
715

Dries's avatar
 
Dries committed
716 717 718 719
    case 200:
    case 302:
    case 307:
      // Filter the input data:
720
     if (aggregator_parse_feed($result->data, $feed)) {
721

Dries's avatar
 
Dries committed
722 723 724
        if ($result->headers['Last-Modified']) {
          $modified = strtotime($result->headers['Last-Modified']);
        }
Dries's avatar
Dries committed
725

726 727 728 729 730
        /*
        ** Prepare the channel data:
        */

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

Dries's avatar
 
Dries committed
734 735 736
        /*
        ** Prepare the image data (if any):
        */
Dries's avatar
 
Dries committed
737

Dries's avatar
 
Dries committed
738 739 740
        foreach ($image as $key => $value) {
          $image[$key] = trim($value);
        }
Dries's avatar
 
Dries committed
741

Dries's avatar
 
Dries committed
742
        if ($image['LINK'] && $image['URL'] && $image['TITLE']) {
743 744
          // Note, we should really use theme_image() here but that only works with local images it won't work with images fetched with a URL unless PHP version > 5
          $image = '<a href="'. check_url($image['LINK']) .'" class="feed-image"><img src="'. check_url($image['URL']) .'" alt="'. check_plain($image['TITLE']) .'" /></a>';
Dries's avatar
 
Dries committed
745
        }
Dries's avatar
 
Dries committed
746 747 748
        else {
          $image = NULL;
        }
Dries's avatar
 
Dries committed
749

Dries's avatar
 
Dries committed
750 751 752
        /*
        ** Update the feed data:
        */
Dries's avatar
 
Dries committed
753

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

Dries's avatar
 
Dries committed
756 757 758
        /*
        ** Clear the cache:
        */
Dries's avatar
 
Dries committed
759

Dries's avatar
 
Dries committed
760
        cache_clear_all();
Dries's avatar
 
Dries committed
761

762 763
        watchdog('aggregator', t('There is new syndicated content from %site.', array('%site' => $feed['title'])));
        drupal_set_message(t('There is new syndicated content from %site.', array('%site' => $feed['title'])));
Dries's avatar
 
Dries committed
764 765
      }
      break;
Dries's avatar
 
Dries committed
766
    default:
767 768
      watchdog('aggregator', t('The feed from %site seems to be broken, due to "%error".', array('%site' => $feed['title'], '%error' => $result->code .' '. $result->error)), WATCHDOG_WARNING);
      drupal_set_message(t('The feed from %site seems to be broken, because of error "%error".', array('%site' => $feed['title'], '%error' => $result->code .' '. $result->error)));
Dries's avatar
 
Dries committed
769
  }
Dries's avatar
 
Dries committed
770
}
Dries's avatar
 
Dries committed
771

Dries's avatar
 
Dries committed
772 773 774 775
/**
 * Parse the W3C date/time format, a subset of ISO 8601. PHP date parsing
 * functions do not handle this format.
 * See http://www.w3.org/TR/NOTE-datetime for more information.
776
 * Originally from MagpieRSS (http://magpierss.sourceforge.net/).
Dries's avatar
 
Dries committed
777 778
 *
 * @param $date_str A string with a potentially W3C DTF date.
779
 * @return A timestamp if parsed successfully or -1 if not.
Dries's avatar
 
Dries committed
780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804
 */
function aggregator_parse_w3cdtf($date_str) {
  if (preg_match('/(\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2})(:(\d{2}))?(?:([-+])(\d{2}):?(\d{2})|(Z))?/', $date_str, $match)) {
    list($year, $month, $day, $hours, $minutes, $seconds) = array($match[1], $match[2], $match[3], $match[4], $match[5], $match[6]);
    // calc epoch for current date assuming GMT
    $epoch = gmmktime($hours, $minutes, $seconds, $month, $day, $year);
    if ($match[10] != 'Z') { // Z is zulu time, aka GMT
      list($tz_mod, $tz_hour, $tz_min) = array($match[8], $match[9], $match[10]);
      // zero out the variables
      if (!$tz_hour) {
        $tz_hour = 0;
      }
      if (!$tz_min) {
        $tz_min = 0;
      }
      $offset_secs = (($tz_hour * 60) + $tz_min) * 60;
      // is timezone ahead of GMT?  then subtract offset
      if ($tz_mod == '+') {
        $offset_secs *= -1;
      }
      $epoch += $offset_secs;
    }
    return $epoch;
  }
  else {
805
    return FALSE;
Dries's avatar
 
Dries committed
806 807 808
  }
}

Dries's avatar
 
Dries committed
809
function aggregator_parse_feed(&$data, $feed) {
Dries's avatar
 
Dries committed
810
  global $items, $image, $channel;
Dries's avatar
 
Dries committed
811

Dries's avatar
 
Dries committed
812
  // Unset the global variables before we use them:
Dries's avatar
 
Dries committed
813
  unset($GLOBALS['element'], $GLOBALS['item'], $GLOBALS['tag']);
Dries's avatar
 
Dries committed
814
  $items = array();
Dries's avatar
 
Dries committed
815
  $image = array();
Dries's avatar
 
Dries committed
816
  $channel = array();
817

Dries's avatar
 
Dries committed
818 819
  // parse the data:
  $xml_parser = drupal_xml_parser_create($data);
Dries's avatar
 
Dries committed
820 821
  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
822

Dries's avatar
 
Dries committed
823
  if (!xml_parse($xml_parser, $data, 1)) {
824 825
    watchdog('aggregator', t('The feed from %site seems to be broken, due to an error "%error" on line %line.', array('%site' => $feed['title'], '%error' => xml_error_string(xml_get_error_code($xml_parser)), '%line' => xml_get_current_line_number($xml_parser))), WATCHDOG_WARNING);
    drupal_set_message(t('The feed from %site seems to be broken, because of error "%error" on line %line.', array('%site' => $feed['title'], '%error' => xml_error_string(xml_get_error_code($xml_parser)), '%line' => xml_get_current_line_number($xml_parser))), 'error');
Dries's avatar
 
Dries committed
826
    return 0;
Dries's avatar
 
Dries committed
827 828
  }
  xml_parser_free($xml_parser);
Dries's avatar
 
Dries committed
829

Dries's avatar
 
Dries committed
830 831
  /*
  ** We reverse the array such that we store the first item last,
832
  ** and the last item first. In the database, the newest item
Dries's avatar
 
Dries committed
833 834
  ** should be at the top.
  */
Dries's avatar
 
Dries committed
835

Dries's avatar
 
Dries committed
836
  $items = array_reverse($items);
Dries's avatar
 
Dries committed
837

838 839
  // Initialize variables
  $title = $link = $author = $description = $guid = NULL;
Dries's avatar
 
Dries committed
840
  foreach ($items as $item) {
841
    unset($title, $link, $author, $description, $guid);
842

Dries's avatar
 
Dries committed
843 844
    // Prepare the item:
    foreach ($item as $key => $value) {
845
      $item[$key] = trim($value);
Dries's avatar
 
Dries committed
846
    }
Dries's avatar
Dries committed
847

Dries's avatar
 
Dries committed
848
    /*
849
    ** Resolve the item's title. If no title is found, we use
Dries's avatar
 
Dries committed
850 851 852 853
    ** up to 40 characters of the description ending at a word
    ** boundary but not splitting potential entities.
    */

Dries's avatar
 
Dries committed
854 855
    if ($item['TITLE']) {
      $title = $item['TITLE'];
Dries's avatar
 
Dries committed
856 857
    }
    else {
Dries's avatar
 
Dries committed
858
      $title = preg_replace('/^(.*)[^\w;&].*?$/', "\\1", truncate_utf8($item['DESCRIPTION'], 40));
Dries's avatar
 
Dries committed
859
    }
Dries's avatar
 
Dries committed
860

Dries's avatar
 
Dries committed
861 862 863 864
    /*
    ** Resolve the items link.
    */

Dries's avatar
 
Dries committed
865 866
    if ($item['LINK']) {
      $link = $item['LINK'];
Dries's avatar
 
Dries committed
867 868
    }
    else {
Dries's avatar
 
Dries committed
869
      $link = $feed['link'];
Dries's avatar
 
Dries committed
870
    }
871 872 873
    if ($item['GUID']) {
      $guid = $item['GUID'];
    }
874

875 876 877
    /**
     * Atom feeds have a CONTENT and/or SUMMARY tag instead of a DESCRIPTION tag
     */
878 879
    if ($item['CONTENT:ENCODED']) {
      $item['DESCRIPTION'] = $item['CONTENT:ENCODED'];
880 881 882 883
    }
    else if ($item['SUMMARY']) {
      $item['DESCRIPTION'] = $item['SUMMARY'];
    }
884