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

Dries's avatar
 
Dries committed
4 5
/**
 * @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 37 38 39 40 41 42 43 44 45 46 47 48
/**
 * Implementation of hook_theme()
 */
function aggregator_theme() {
  return array(
    'aggregator_page_list' => array(
      'arguments' => array('form' => NULL),
    ),
    'aggregator_feed' => array(
      'arguments' => array('feed' => NULL),
    ),
    'aggregator_block_item' => array(
      'arguments' => array('item' => NULL, 'feed' => 0),
    ),
    'aggregator_summary_item' => array(
      'arguments' => array('item' => NULL),
    ),
    'aggregator_page_item' => array(
      'arguments' => array('item' => NULL),
    ),
  );
49
}
50

51 52 53
/**
 * Implementation of hook_menu().
 */
54 55 56 57 58 59 60 61 62 63 64 65 66
function aggregator_menu() {
  $items['admin/content/aggregator'] = array(
    'title' => t('News aggregator'),
    'description' => t("Configure which content your site aggregates from other sites, how often it polls them, and how they're categorized."),
    'page callback' => 'aggregator_admin_overview',
    'access arguments' => array('administer news feeds'),
  );
  $items['admin/content/aggregator/add/feed'] = array(
    'title' => t('Add feed'),
    'page callback' => 'drupal_get_form',
    'page arguments' => array('aggregator_form_feed'),
    'access arguments' => array('administer news feeds'),
    'type' => MENU_LOCAL_TASK,
67
    'parent' => 'admin/content/aggregator',
68 69 70 71 72 73 74
  );
  $items['admin/content/aggregator/add/category'] = array(
    'title' => t('Add category'),
    'page callback' => 'drupal_get_form',
    'page arguments' => array('aggregator_form_category'),
    'access arguments' => array('administer news feeds'),
    'type' => MENU_LOCAL_TASK,
75
    'parent' => 'admin/content/aggregator',
76
  );
77
  $items['admin/content/aggregator/remove/%aggregator_feed'] = array(
78 79 80 81 82 83
    'title' => t('Remove items'),
    'page callback' => 'aggregator_admin_remove_feed',
    'page arguments' => array(4),
    'access arguments' => array('administer news feeds'),
    'type' => MENU_CALLBACK,
  );
84
  $items['admin/content/aggregator/update/%aggregator_feed'] = array(
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116
    'title' => t('Update items'),
    'page callback' => 'aggregator_admin_refresh_feed',
    'page arguments' => array(4),
    'access arguments' => array('administer news feeds'),
    'type' => MENU_CALLBACK,
  );
  $items['admin/content/aggregator/list'] = array(
    'title' => t('List'),
    'type' => MENU_DEFAULT_LOCAL_TASK,
    'weight' => -10,
  );
  $items['admin/content/aggregator/settings'] = array(
    'title' => t('Settings'),
    'page callback' => 'drupal_get_form',
    'page arguments' => array('aggregator_admin_settings'),
    'type' => MENU_LOCAL_TASK,
    'weight' => 10,
    'access arguments' => array('administer news feeds'),
  );
  $items['aggregator'] = array(
    'title' => t('News aggregator'),
    'page callback' => 'aggregator_page_last',
    'access arguments' => array('access news feeds'),
    'weight' => 5,
  );
  $items['aggregator/sources'] = array(
    'title' => t('Sources'),
    'page callback' => 'aggregator_page_sources',
    'access arguments' => array('access news feeds'));
  $items['aggregator/categories'] = array(
    'title' => t('Categories'),
    'page callback' => 'aggregator_page_categories',
117
    'access callback' => '_aggregator_has_categories',
118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136
  );
  $items['aggregator/rss'] = array(
    'title' => t('RSS feed'),
    'page callback' => 'aggregator_page_rss',
    'access arguments' => array('access news feeds'),
    'type' => MENU_CALLBACK,
  );
  $items['aggregator/opml'] = array(
    'title' => t('OPML feed'),
    'page callback' => 'aggregator_page_opml',
    'access arguments' => array('access news feeds'),
    'type' => MENU_CALLBACK,
  );
  $result = db_query('SELECT title, cid FROM {aggregator_category} ORDER BY title');
  while ($category = db_fetch_array($result)) {
    $path = 'aggregator/categories/'. $category['cid'];
    $items[$path] = array(
      'title' => $category['title'],
      'page callback' => 'aggregator_page_category',
137
      'access callback' => 'user_access',
138 139 140 141
      'access arguments' => array('access news feeds'),
    );
    $items[$path .'/view'] = array(
      'title' => t('View'),
142
      'type' => MENU_DEFAULT_LOCAL_TASK,
143 144 145 146 147 148 149
      'weight' => -10,
    );
    $items[$path .'/categorize'] = array(
      'title' => t('Categorize'),
      'page callback' => 'drupal_get_form',
      'page arguments' => array('aggregator_page_category'),
      'access arguments' => array('administer news feeds', 2),
150
      'type' => MENU_LOCAL_TASK,
151 152 153 154 155 156 157 158 159
    );
    $items[$path .'/configure'] = array(
      'title' => t('Configure'),
      'page callback' => 'drupal_get_form',
      'page arguments' => array('aggregator_form_category', 2),
      'access arguments' => array('administer news feeds', 2),
      'type' => MENU_LOCAL_TASK,
      'weight' => 1,
    );
160
  }
161
  $items['aggregator/sources/%aggregator_feed'] = array(
162 163 164
    'page callback' => 'aggregator_page_source',
    'type' => MENU_CALLBACK,
  );
165
  $items['aggregator/sources/%aggregator_feed/view'] = array(
166 167 168 169
    'title' => t('View'),
    'type' => MENU_DEFAULT_LOCAL_TASK,
    'weight' => -10,
  );
170
  $items['aggregator/sources/%aggregator_feed/categorize'] = array(
171 172 173 174 175 176
    'title' => t('Categorize'),
    'page callback' => 'drupal_get_form',
    'page arguments' => array('aggregator_page_source'),
    'access arguments' => array('administer news feeds'),
    'type' => MENU_LOCAL_TASK,
  );
177
  $items['aggregator/sources/%aggregator_feed/configure'] = array(
178 179 180 181 182 183 184
    'title' => t('Configure'),
    'page callback' => 'drupal_get_form',
    'page arguments' => array('aggregator_form_feed', 2),
    'access arguments' => array('administer news feeds'),
    'type' => MENU_LOCAL_TASK,
    'weight' => 1,
  );
185
  $items['admin/content/aggregator/edit/feed/%aggregator_feed'] = array(
186 187 188 189 190 191
    'title' => t('Edit feed'),
    'page callback' => 'drupal_get_form',
    'page arguments' => array('aggregator_form_feed', 5),
    'access arguments' => array('administer news feeds'),
    'type' => MENU_CALLBACK,
  );
192
  $items['admin/content/aggregator/edit/category/%aggregator_category'] = array(
193 194 195 196 197 198
    'title' => t('Edit category'),
    'page callback' => 'drupal_get_form',
    'page arguments' => array('aggregator_form_category', 5),
    'access arguments' => array('administer news feeds'),
    'type' => MENU_CALLBACK,
  );
199 200 201 202

  return $items;
}

203 204 205
function aggregator_init() {
  drupal_add_css(drupal_get_path('module', 'aggregator') .'/aggregator.css');
}
206 207 208 209

function _aggregator_has_categories() {
  return user_access('access news feeds') && db_result(db_query('SELECT COUNT(*) FROM {aggregator_category}'));
}
210

Dries's avatar
Dries committed
211
function aggregator_admin_settings() {
212
  $items = array(0 => t('none')) + drupal_map_assoc(array(3, 5, 10, 15, 20, 25), '_aggregator_items');
213
  $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
214

215
  $form['aggregator_allowed_html_tags'] = array(
216 217 218
    '#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.')
219 220 221
  );

  $form['aggregator_summary_items'] = array(
222 223 224
    '#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.')
225 226 227
  );

  $form['aggregator_clear'] = array(
228 229
    '#type' => 'select', '#title' => t('Discard news items older than'),
    '#default_value' => variable_get('aggregator_clear', 9676800), '#options' => $period,
230
    '#description' => t('Older news items will be automatically discarded. Requires crontab.')
231
  );
232

233
  $form['aggregator_category_selector'] = array(
234
    '#type' => 'radios', '#title' => t('Category selection type'), '#default_value' => variable_get('aggregator_category_selector', 'checkboxes'),
235
    '#options' => array('checkboxes' => t('checkboxes'), 'select' => t('multiple selector')),
236
    '#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.')
237
  );
Dries's avatar
Dries committed
238

239
  return system_settings_form($form);
Dries's avatar
 
Dries committed
240 241
}

Dries's avatar
 
Dries committed
242 243 244
/**
 * Implementation of hook_perm().
 */
Kjartan's avatar
Kjartan committed
245
function aggregator_perm() {
Dries's avatar
 
Dries committed
246
  return array('administer news feeds', 'access news feeds');
Dries's avatar
 
Dries committed
247 248
}

Dries's avatar
 
Dries committed
249 250 251 252 253
/**
 * Implementation of hook_cron().
 *
 * Checks news feeds for updates once their refresh interval has elapsed.
 */
Dries's avatar
 
Dries committed
254
function aggregator_cron() {
Dries's avatar
 
Dries committed
255
  $result = db_query('SELECT * FROM {aggregator_feed} WHERE checked + refresh < %d', time());
Dries's avatar
 
Dries committed
256 257
  while ($feed = db_fetch_array($result)) {
    aggregator_refresh($feed);
Dries's avatar
 
Dries committed
258 259 260
  }
}

Dries's avatar
 
Dries committed
261 262 263 264 265
/**
 * Implementation of hook_block().
 *
 * Generates blocks for the latest news items in each category and feed.
 */
266
function aggregator_block($op = 'list', $delta = 0, $edit = array()) {
Dries's avatar
 
Dries committed
267
  if (user_access('access news feeds')) {
Dries's avatar
 
Dries committed
268
    if ($op == 'list') {
Dries's avatar
Dries committed
269
      $result = db_query('SELECT cid, title FROM {aggregator_category} ORDER BY title');
Dries's avatar
 
Dries committed
270
      while ($category = db_fetch_object($result)) {
271
        $block['category-'. $category->cid]['info'] = t('!title category latest items', array('!title' => $category->title));
Kjartan's avatar
Kjartan committed
272
      }
Dries's avatar
Dries committed
273
      $result = db_query('SELECT fid, title FROM {aggregator_feed} ORDER BY fid');
Kjartan's avatar
Kjartan committed
274
      while ($feed = db_fetch_object($result)) {
275
        $block['feed-'. $feed->fid]['info'] = t('!title feed latest items', array('!title' => $feed->title));
Kjartan's avatar
Kjartan committed
276
      }
Dries's avatar
 
Dries committed
277
    }
Dries's avatar
Dries committed
278
    else if ($op == 'configure') {
279
      list($type, $id) = explode('-', $delta);
Dries's avatar
Dries committed
280 281 282 283 284 285
      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));
      }
286
      $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)));
287
      return $form;
Dries's avatar
Dries committed
288 289
    }
    else if ($op == 'save') {
290
      list($type, $id) = explode('-', $delta);
Dries's avatar
Dries committed
291 292 293 294 295 296 297
      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);
      }
    }
298
    else if ($op == 'view') {
299
      list($type, $id) = explode('-', $delta);
Kjartan's avatar
Kjartan committed
300
      switch ($type) {
Dries's avatar
 
Dries committed
301
        case 'feed':
302
          if ($feed = db_fetch_object(db_query('SELECT fid, title, block FROM {aggregator_feed} WHERE fid = %d', $id))) {
303
            $block['subject'] = check_plain($feed->title);
304
            $result = db_query_range('SELECT * FROM {aggregator_item} WHERE fid = %d ORDER BY timestamp DESC, iid DESC', $feed->fid, 0, $feed->block);
305
            $read_more = '<div class="more-link">'. l(t('more'), 'aggregator/sources/'. $feed->fid, array('title' => t("View this feed's recent news."))) .'</div>';
306
          }
Kjartan's avatar
Kjartan committed
307
          break;
308

Dries's avatar
 
Dries committed
309
        case 'category':
310
          if ($category = db_fetch_object(db_query('SELECT cid, title, block FROM {aggregator_category} WHERE cid = %d', $id))) {
311
            $block['subject'] = check_plain($category->title);
312
            $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);
313
            $read_more = '<div class="more-link">'. l(t('more'), 'aggregator/categories/'. $category->cid, array('title' => t("View this category's recent news."))) .'</div>';
314
          }
Kjartan's avatar
Kjartan committed
315 316
          break;
      }
Dries's avatar
 
Dries committed
317 318
      $items = array();
      while ($item = db_fetch_object($result)) {
Dries's avatar
 
Dries committed
319
        $items[] = theme('aggregator_block_item', $item);
Dries's avatar
 
Dries committed
320
      }
321 322 323 324 325

      // 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
326
    }
327 328 329
    if (isset($block)) {
      return $block;
    }
Dries's avatar
 
Dries committed
330
  }
Dries's avatar
 
Dries committed
331 332
}

333 334 335
/**
 * Generate a form to add/edit/delete aggregator categories.
 */
336
function aggregator_form_category($edit = array('title' => '', 'description' => '', 'cid' => NULL)) {
337 338 339 340 341 342 343 344 345 346
  $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'],
  );
347
  $form['submit'] = array('#type' => 'submit', '#value' => t('Submit'));
348 349

  if ($edit['cid']) {
350
    $form['delete'] = array('#type' => 'submit', '#value' => t('Delete'));
351 352 353
    $form['cid'] = array('#type' => 'hidden', '#value' => $edit['cid']);
  }

354
  return $form;
355 356 357 358 359 360
}

/**
 * Validate aggregator_form_feed form submissions.
 */
function aggregator_form_category_validate($form_id, $form_values) {
361
  if ($form_values['op'] == t('Submit')) {
362 363 364 365 366 367 368 369
    // 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) {
370
      form_set_error('title', t('A category named %category already exists. Please enter a unique title.', array('%category' => $form_values['title'])));
371 372 373 374 375 376 377 378 379
    }
  }
}

/**
 * Process aggregator_form_category form submissions.
 * @todo Add delete confirmation dialog.
 */
function aggregator_form_category_submit($form_id, $form_values) {
380
  if ($form_values['op'] == t('Delete')) {
381 382 383 384 385 386 387 388
    $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'])) {
389
      drupal_set_message(t('The category %category has been updated.', array('%category' => $form_values['title'])));
390
      if (arg(0) == 'admin') {
391
        return 'admin/content/aggregator/';
392 393 394 395 396 397
      }
      else {
        return 'aggregator/categories/'. $form_values['cid'];
      }
    }
    else {
398
      watchdog('aggregator', 'Category %category deleted.', array('%category' => $title));
399
      drupal_set_message(t('The category %category has been deleted.', array('%category' => $title)));
400
      if (arg(0) == 'admin') {
401
        return 'admin/content/aggregator/';
402 403 404 405 406 407 408
      }
      else {
        return 'aggregator/categories/';
      }
    }
  }
  else {
409
    watchdog('aggregator', 'Category %category added.', array('%category' => $form_values['title']), WATCHDOG_NOTICE, l(t('view'), 'admin/content/aggregator'));
410
    drupal_set_message(t('The category %category has been added.', array('%category' => $form_values['title'])));
411 412 413 414 415 416 417
  }
}

/**
 * Add/edit/delete aggregator categories.
 */
function aggregator_save_category($edit) {
418
  if (!empty($edit['cid']) && !empty($edit['title'])) {
419 420
    db_query("UPDATE {aggregator_category} SET title = '%s', description = '%s' WHERE cid = %d", $edit['title'], $edit['description'], $edit['cid']);
  }
421
  else if (!empty($edit['cid'])) {
422 423
    db_query('DELETE FROM {aggregator_category} WHERE cid = %d', $edit['cid']);
  }
424
  else if (!empty($edit['title'])) {
425 426 427 428 429 430 431 432 433
    // 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.
 */
434
function aggregator_form_feed($edit = array('refresh' => 900, 'title' => '', 'url' => '', 'fid' => NULL)) {
435 436 437 438 439 440 441 442 443
  $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'],
444
    '#maxlength' => 255,
445
    '#description' => t('The name of the feed; typically the name of the website you syndicate content from.'),
446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466
    '#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)) {
467 468
    $options[$category->cid] = check_plain($category->title);
    if ($category->fid) $values[] = $category->cid;
469 470 471 472 473 474 475 476 477
  }
  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.'),
    );
  }
478
  $form['submit'] = array('#type' => 'submit', '#value' => t('Submit'));
479 480

  if ($edit['fid']) {
481
    $form['delete'] = array('#type' => 'submit', '#value' => t('Delete'));
482 483 484
    $form['fid'] = array('#type' => 'hidden', '#value' => $edit['fid']);
  }

485
  return $form;
486 487 488 489 490 491
}

/**
 * Validate aggregator_form_feed form submissions.
 */
function aggregator_form_feed_validate($form_id, $form_values) {
492
  if ($form_values['op'] == t('Submit')) {
493 494 495 496 497 498 499 500 501
    // 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) {
502
        form_set_error('title', t('A feed named %feed already exists. Please enter a unique title.', array('%feed' => $form_values['title'])));
503
      }
504 505 506
      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'])));
      }
507 508 509 510 511 512 513 514 515
    }
  }
}

/**
 * Process aggregator_form_feed form submissions.
 * @todo Add delete confirmation dialog.
 */
function aggregator_form_feed_submit($form_id, $form_values) {
516
  if ($form_values['op'] == t('Delete')) {
517 518 519 520 521 522 523 524
    $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'])) {
525
      drupal_set_message(t('The feed %feed has been updated.', array('%feed' => $form_values['title'])));
526
      if (arg(0) == 'admin') {
527
        return 'admin/content/aggregator/';
528 529 530 531 532 533
      }
      else {
        return 'aggregator/sources/'. $form_values['fid'];
      }
    }
    else {
534
      watchdog('aggregator', 'Feed %feed deleted.', array('%feed' => $title));
535
      drupal_set_message(t('The feed %feed has been deleted.', array('%feed' => $title)));
536
      if (arg(0) == 'admin') {
537
        return 'admin/content/aggregator/';
538 539 540 541 542 543 544
      }
      else {
        return 'aggregator/sources/';
      }
    }
  }
  else {
545
    watchdog('aggregator', 'Feed %feed added.', array('%feed' => $form_values['title']), WATCHDOG_NOTICE, l(t('view'), 'admin/content/aggregator'));
546
    drupal_set_message(t('The feed %feed has been added.', array('%feed' => $form_values['title'])));
547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588
  }
}

/**
 * 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
589 590 591 592
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
593
  }
594
  if (!empty($items)) {
Dries's avatar
 
Dries committed
595
    db_query('DELETE FROM {aggregator_category_item} WHERE '. implode(' OR ', $items));
Dries's avatar
 
Dries committed
596
  }
Dries's avatar
 
Dries committed
597
  db_query('DELETE FROM {aggregator_item} WHERE fid = %d', $feed['fid']);
Kjartan's avatar
Kjartan committed
598
  db_query("UPDATE {aggregator_feed} SET checked = 0, etag = '', modified = 0 WHERE fid = %d", $feed['fid']);
599
  drupal_set_message(t('The news items from %site have been removed.', array('%site' => $feed['title'])));
Dries's avatar
 
Dries committed
600 601
}

Dries's avatar
 
Dries committed
602 603 604
/**
 * Call-back function used by the XML parser.
 */
Kjartan's avatar
Kjartan committed
605
function aggregator_element_start($parser, $name, $attributes) {
606
  global $item, $element, $tag, $items, $channel;
Dries's avatar
 
Dries committed
607 608

  switch ($name) {
Dries's avatar
 
Dries committed
609 610
    case 'IMAGE':
    case 'TEXTINPUT':
611 612 613 614 615 616
    case 'CONTENT':
    case 'SUMMARY':
    case 'TAGLINE':
    case 'SUBTITLE':
    case 'LOGO':
    case 'INFO':
Dries's avatar
 
Dries committed
617 618
      $element = $name;
      break;
619 620 621 622
    case 'ID':
      if ($element != 'ITEM') {
        $element = $name;
      }
623 624 625 626 627 628 629 630 631 632
    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
633
    case 'ITEM':
Dries's avatar
 
Dries committed
634 635
      $element = $name;
      $item += 1;
636 637 638 639 640
      break;
    case 'ENTRY':
      $element = 'ITEM';
      $item += 1;
      break;
641 642 643 644 645
  }

  $tag = $name;
}

Dries's avatar
 
Dries committed
646 647 648
/**
 * Call-back function used by the XML parser.
 */
Kjartan's avatar
Kjartan committed
649
function aggregator_element_end($parser, $name) {
Dries's avatar
 
Dries committed
650 651
  global $element;

Dries's avatar
 
Dries committed
652
  switch ($name) {
Dries's avatar
 
Dries committed
653 654 655
    case 'IMAGE':
    case 'TEXTINPUT':
    case 'ITEM':
656 657 658
    case 'ENTRY':
    case 'CONTENT':
    case 'INFO':
659 660
      $element = '';
      break;
661
    case 'ID':
662
      if ($element == 'ID') {
663 664
        $element = '';
      }
Dries's avatar
 
Dries committed
665
  }
666 667
}

Dries's avatar
 
Dries committed
668 669 670
/**
 * Call-back function used by the XML parser.
 */
Kjartan's avatar
Kjartan committed
671
function aggregator_element_data($parser, $data) {
Dries's avatar
 
Dries committed
672
  global $channel, $element, $items, $item, $image, $tag;
Dries's avatar
 
Dries committed
673
  switch ($element) {
Dries's avatar
 
Dries committed
674
    case 'ITEM':
Dries's avatar
 
Dries committed
675 676
      $items[$item][$tag] .= $data;
      break;
Dries's avatar
 
Dries committed
677
    case 'IMAGE':
678
    case 'LOGO':
Dries's avatar
 
Dries committed
679 680
      $image[$tag] .= $data;
      break;
681 682 683 684 685 686
    case 'LINK':
      if ($data) {
        $items[$item][$tag] .= $data;
      }
      break;
    case 'CONTENT':
687
      $items[$item]['CONTENT'] .= $data;
688 689
      break;
    case 'SUMMARY':
690
      $items[$item]['SUMMARY'] .= $data;
691 692 693 694 695 696 697
      break;
    case 'TAGLINE':
    case 'SUBTITLE':
      $channel['DESCRIPTION'] .= $data;
      break;
    case 'INFO':
    case 'ID':
Dries's avatar
 
Dries committed
698 699 700
    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
701 702
      break;
    default:
703
      $channel += array($tag => '');
Dries's avatar
 
Dries committed
704
      $channel[$tag] .= $data;
705 706 707
  }
}

Dries's avatar
 
Dries committed
708 709 710
/**
 * Checks a news feed for new items.
 */
Kjartan's avatar
Kjartan committed
711
function aggregator_refresh($feed) {
Dries's avatar
 
Dries committed
712 713
  global $channel, $image;

Dries's avatar
 
Dries committed
714 715 716 717 718 719
  // Generate conditional GET headers.
  $headers = array();
  if ($feed['etag']) {
    $headers['If-None-Match'] = $feed['etag'];
  }
  if ($feed['modified']) {
Dries's avatar
 
Dries committed
720
    $headers['If-Modified-Since'] = gmdate('D, d M Y H:i:s', $feed['modified']) .' GMT';
Dries's avatar
 
Dries committed
721 722 723 724 725
  }

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

726
  // Process HTTP response code.
Dries's avatar
 
Dries committed
727 728
  switch ($result->code) {
    case 304:
Dries's avatar
 
Dries committed
729
      db_query('UPDATE {aggregator_feed} SET checked = %d WHERE fid = %d', time(), $feed['fid']);
730
      drupal_set_message(t('There is no new syndicated content from %site.', array('%site' => $feed['title'])));
Dries's avatar
 
Dries committed
731
      break;
Dries's avatar
 
Dries committed
732 733
    case 301:
      $feed['url'] = $result->redirect_url;
734
      watchdog('aggregator', 'Updated URL for feed %title to %url.', array('%title' => $feed['title'], '%url' => $feed['url']));
735

Dries's avatar
 
Dries committed
736 737 738 739
    case 200:
    case 302:
    case 307:
      // Filter the input data:
740
     if (aggregator_parse_feed($result->data, $feed)) {
741

Dries's avatar
 
Dries committed
742 743 744
        if ($result->headers['Last-Modified']) {
          $modified = strtotime($result->headers['Last-Modified']);
        }
Dries's avatar
Dries committed
745

746 747 748 749 750
        /*
        ** Prepare the channel data:
        */

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

Dries's avatar
 
Dries committed
754 755 756
        /*
        ** Prepare the image data (if any):
        */
Dries's avatar
 
Dries committed
757

Dries's avatar
 
Dries committed
758 759 760
        foreach ($image as $key => $value) {
          $image[$key] = trim($value);
        }
Dries's avatar
 
Dries committed
761

Dries's avatar
 
Dries committed
762
        if ($image['LINK'] && $image['URL'] && $image['TITLE']) {
763 764
          // 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
765
        }
Dries's avatar
 
Dries committed
766 767 768
        else {
          $image = NULL;
        }
Dries's avatar
 
Dries committed
769

Dries's avatar
 
Dries committed
770 771 772
        /*
        ** Update the feed data:
        */
Dries's avatar
 
Dries committed
773

774
        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
775

Dries's avatar
 
Dries committed
776 777 778
        /*
        ** Clear the cache:
        */
Dries's avatar
 
Dries committed
779

Dries's avatar
 
Dries committed
780
        cache_clear_all();
Dries's avatar
 
Dries committed
781

782
        watchdog('aggregator', 'There is new syndicated content from %site.', array('%site' => $feed['title']));
783
        drupal_set_message(t('There is new syndicated content from %site.', array('%site' => $feed['title'])));
Dries's avatar
 
Dries committed
784 785
      }
      break;
Dries's avatar
 
Dries committed
786
    default:
787
      watchdog('aggregator', 'The feed from %site seems to be broken, due to "%error".', array('%site' => $feed['title'], '%error' => $result->code .' '. $result->error), WATCHDOG_WARNING);
788
      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
789
  }
Dries's avatar
 
Dries committed
790
}
Dries's avatar
 
Dries committed
791

Dries's avatar
 
Dries committed
792 793 794 795
/**
 * 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.
796
 * Originally from MagpieRSS (http://magpierss.sourceforge.net/).
Dries's avatar
 
Dries committed
797 798
 *
 * @param $date_str A string with a potentially W3C DTF date.
799
 * @return A timestamp if parsed successfully or -1 if not.
Dries's avatar
 
Dries committed
800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824
 */
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 {
825
    return FALSE;
Dries's avatar
 
Dries committed
826 827 828
  }
}

Dries's avatar
 
Dries committed
829
function aggregator_parse_feed(&$data, $feed) {
Dries's avatar
 
Dries committed
830
  global $items, $image, $channel;
Dries's avatar
 
Dries committed
831

Dries's avatar
 
Dries committed
832
  // Unset the global variables before we use them:
Dries's avatar
 
Dries committed
833
  unset($GLOBALS['element'], $GLOBALS['item'], $GLOBALS['tag']);
Dries's avatar
 
Dries committed
834
  $items = array();
Dries's avatar
 
Dries committed
835
  $image = array();
Dries's avatar
 
Dries committed
836
  $channel = array();
837

Dries's avatar
 
Dries committed
838 839
  // parse the data:
  $xml_parser = drupal_xml_parser_create($data);
Dries's avatar
 
Dries committed
840 841
  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
842

Dries's avatar
 
Dries committed
843
  if (!xml_parse($xml_parser, $data, 1)) {
844
    watchdog('aggregator', '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);
845
    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
846
    return 0;
Dries's avatar
 
Dries committed
847 848
  }
  xml_parser_free($xml_parser);
Dries's avatar
 
Dries committed
849

Dries's avatar
 
Dries committed
850 851
  /*
  ** We reverse the array such that we store the first item last,
852
  ** and the last item first. In the database, the newest item
Dries's avatar
 
Dries committed
853 854
  ** should be at the top.
  */
Dries's avatar
 
Dries committed
855

Dries's avatar
 
Dries committed
856
  $items = array_reverse($items);
Dries's avatar
 
Dries committed
857

858 859
  // Initialize variables
  $title = $link = $author = $description = $guid = NULL;
Dries's avatar
 
Dries committed
860
  foreach ($items as $item) {
861
    unset($title, $link, $author, $description, $guid);
862

Dries's avatar
 
Dries committed
863 864
    // Prepare the item:
    foreach ($item as $key => $value) {
865
      $item[$key] = trim($value);
Dries's avatar
 
Dries committed
866
    }
Dries's avatar
Dries committed
867

Dries's avatar
 
Dries committed
868
    /*
869
    ** Resolve the item's title. If no title is found, we use
Dries's avatar
 
Dries committed
870 871 872 873
    ** up to 40 characters of the description ending at a word
    ** boundary but not splitting potential entities.
    */

Dries's avatar
 
Dries committed
874 875
    if ($item['TITLE']) {
      $title = $item['TITLE'];
Dries's avatar
 
Dries committed
876 877
    }
    else {
Dries's avatar
 
Dries committed
878
      $title = preg_replace('/^(.*)[^\w;&].*?$/', "\\1", truncate_utf8($item['DESCRIPTION'], 40));
Dries's avatar
 
Dries committed
879
    }
Dries's avatar
 
Dries committed
880

Dries's avatar
 
Dries committed
881 882 883 884
    /*
    ** Resolve the items link.
    */

Dries's avatar
 
Dries committed
885 886
    if ($item['LINK']) {
      $link = $item['LINK'];
Dries's avatar
 
Dries committed
887 888
    }
    else {
Dries's avatar
 
Dries committed
889
      $link = $feed['link'];
Dries's avatar
 
Dries committed
890
    }
891 892 893
    if ($item['GUID']) {
      $guid = $item['GUID'];
    }
894

895 896 897
    /**
     * Atom feeds have a CONTENT and/or SUMMARY tag instead of a DESCRIPTION tag
     */
898 899
    if ($item['CONTENT:ENCODED']) {
      $item['DESCRIPTION'] = $item['CONTENT:ENCODED'];
900 901 902 903
    }
    else if ($item['SUMMARY']) {
      $item['DESCRIPTION'] = $item['SUMMARY'];
    }
904 905 906
    else if ($item['CONTENT']) {
      $item['DESCRIPTION'] = $item['CONTENT'];
    }
907

Dries's avatar
 
Dries committed
908
    /*
909
    ** Try to resolve and parse the item's publication date. If no
Dries's avatar
 
Dries committed
910 911 912 913 914 915 916 917
    ** 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
918 919 920
    else if ($item['ISSUED']) $date = $item['ISSUED'];                     // Atom XML
    else if ($item['CREATED']) $date = $item['CREATED'];                   // Atom XML
    else if ($item['MODIFIED']) $date = $item['MODIFIED'];                 // Atom XML
921 922
    else if ($item['PUBLISHED']) $date = $item['PUBLISHED'];               // Atom XML
    else if ($item['UPDATED']) $date = $item['UPDATED'];                   // Atom XML
Dries's avatar
 
Dries committed
923
    else $date = 'now';
Dries's avatar
 
Dries committed
924

925 926 927 928
    $timestamp = strtotime($date); // As of PHP 5.1.0, strtotime returns FALSE on failure instead of -1.
    if ($timestamp <= 0) {
      $timestamp = aggregator_parse_w3cdtf($date); // Returns FALSE on failure
      if (!$timestamp) {
Dries's avatar
 
Dries committed
929 930
        $timestamp = time(); // better than nothing
      }
931
    }
Dries's avatar
 
Dries committed
932 933

    /*
934 935
    ** Save this item. Try to avoid duplicate entries as much as
    ** possible. If we find a duplicate entry, we resolve it and
Dries's avatar
 
Dries committed
936
    ** pass along it's ID such that we can update it if needed.
Dries's avatar
 
Dries committed
937 938
    */

939 940 941 942
    if ($guid) {
      $entry = db_fetch_object(db_query("SELECT iid FROM {aggregator_item} WHERE fid = %d AND guid = '%s'", $feed['fid'], $guid));
    }
    else if ($link && $link != $feed['link'] && $link != $feed['url']) {
Dries's avatar
 
Dries committed
943
      $entry = db_fetch_object(db_query("SELECT iid FROM {aggregator_item} WHERE fid = %d AND link = '%s'", $feed['fid'], $link));
Dries's avatar
 
Dries committed
944 945
    }
    else {
Dries's avatar
 
Dries committed
946
      $entry = db_fetch_object(db_query("SELECT iid FROM {aggregator_item} WHERE fid = %d AND title = '%s'", $feed['fid'], $title));
Dries's avatar
 
Dries committed
947