modules/feedparser/feedmanager.module

<?php
// $Id: feedmanager.module,v 1.46 2007/01/01 14:32:23 budda Exp $

/**
 * Feed Manager
 * @description: Provides a standard interface to manage RSS feeds
 *
 * @author: Mike Carter <mike @ www.ixis.co.uk/contact>
 *
 * @todo: link feedmanager_opml() sources page
 */

/**
 * Implementation of hook_help().
 */
function feedmanager_help($section) {
  switch ($section) {
    case 'admin/help#aggregator':
      $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>';
      $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/block'), '%aggregator-opml' => url('aggregator/opml'))) .'</p>';
      $output .= t('<p>You can</p>
<ul>
<li>administer your list of news feeds <a href="%admin-aggregator">administer &gt;&gt;  aggregator</a>.</li>
<li>add a new feed <a href="%admin-aggregator-add-feed">administer &gt;&gt; aggregator &gt;&gt; add feed</a>.</li>
<li>add a new category <a href="%admin-aggregator-add-category">administer &gt;&gt; aggregator &gt;&gt; add category</a>.</li>
<li>configure global settings for the news aggregator <a href="%admin-settings-aggregator">administer &gt;&gt; settings &gt;&gt; aggregator</a>.</li>
<li>control access to the aggregator module through access permissions <a href="%admin-access">administer &gt;&gt; access control &gt;&gt; permissions</a>.</li>
<li>set permissions to access new feeds for user roles such as anonymous users at <a href="%admin-access">administer &gt;&gt; access control</a>.</li>
<li>view the <a href="%aggregator">aggregator page</a>.</li>
</ul>
', array('%admin-aggregator' => url('admin/aggregator'), '%admin-aggregator-add-feed' => url('admin/aggregator/add/feed'), '%admin-aggregator-add-category' => url('admin/aggregator/add/category'), '%admin-settings-aggregator' => url('admin/settings/feedmanager'), '%admin-access' => url('admin/access'), '%aggregator' => url('aggregator')));
      $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>';
      return $output;
    case 'admin/modules#description':
      return t('Provides a management interface for RSS/RDF/Atom feeds.');
    case 'admin/aggregator':
      return t('<p>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>.</p>', array('%block' => url('admin/block')));
    case 'admin/aggregator/add/feed':
      return t('<p>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>');
    case 'admin/aggregator/add/category':
      return t('<p>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>');
  }
}


/**
 * Implementation of hook_menu().
 */
function feedmanager_menu($may_cache) {
  $items = array();
  $edit = user_access('administer news feeds');
  $view = user_access('access news feeds');

  if ($may_cache) {
    $items[] = array('path' => 'aggregator/sources',
      'title' => t('sources'),
      'callback' => 'feedmanager_page_sources',
      'access' => $view);
    $items[] = array('path' => 'admin/aggregator',
      'title' => t('aggregator'),
      'callback' => 'feedmanager_admin_overview',
      'access' => $edit);
    $items[] = array('path' => 'admin/aggregator/add/feed',
      'title' => t('add feed'),
      'callback' => 'feedmanager_form_feed',
      'access' => $edit,
      'type' => MENU_LOCAL_TASK);
    $items[] = array('path' => 'admin/aggregator/remove',
      'title' => t('remove items'),
      'callback' => 'feedmanager_remove_confirm',
      'access' => $edit,
      'type' => MENU_CALLBACK);
    $items[] = array('path' => 'admin/aggregator/update',
      'title' => t('update items'),
      'callback' => 'feedmanager_admin_refresh_feed',
      'access' => $edit,
      'type' => MENU_CALLBACK);
    $items[] = array('path' => 'admin/aggregator/list',
      'title' => t('list'),
      'type' => MENU_DEFAULT_LOCAL_TASK,
      'weight' => -10);
    $items[] = array('path' => 'admin/settings/feedmanager',
      'title' => t('FeedManager'),
      'callback' => 'feedmanager_admin_settings_dispatcher',
      'access' => user_access('administer site configuration'),
      'type' => MENU_NORMAL_ITEM,
      );
  }
  else if (arg(1) == 'aggregator' && is_numeric(arg(4))) {
    if (arg(3) == 'feed') {
      $feed = feedmanager_get_feed(arg(4));
      if ($feed) {
        $items[] = array('path' => 'admin/aggregator/edit/feed/'. $feed['fid'],
          'title' => t('edit feed'),
          'callback' => 'feedmanager_form_feed',
          'callback arguments' => array($feed),
          'access' => $edit,
          'type' => MENU_CALLBACK);
      }
    }
  }

  return $items;
}


/**
 * Admin settings
 */
function feedmanager_admin_settings_dispatcher() {
  if (strncmp(VERSION, '4', 1) == 0) {
    $form_html = feedmanager_admin_settings();
  } else {
    $form_html = drupal_get_form('feedmanager_admin_settings');
  }

  return $form_html;
}

function feedmanager_admin_settings() {
  $form['feedprocessing'] = array(
    '#type' => 'fieldset',
    '#title' => t('Feed Parsing')
  );

  $feedmanager_count['0'] = t('None');
  $feedmanager_count += drupal_map_assoc(array(1, 2, 3, 4, 5, 10, 15, 20, 25, 50, 100));
  $feedmanager_count['9999999'] = t('All');
  $form['feedprocessing']['feedmanager_cron_count'] = array (
    '#type' => 'select',
    '#title' => t('Update count'),
    '#default_value' => variable_get('feedmanager_cron_count', 5),
    '#options' => $feedmanager_count,
    '#description' => t('Select how many feeds can be updated in one cron run.')
  );

  $form['feedprocessing']['feedmanager_timeout'] = array(
    '#type' => 'select',
    '#options' => drupal_map_assoc(array(10,20,30,40,50,60)),
    '#title' => t('Feed Timeout'),
    '#description' => t('Define how many seconds to wait before giving up when attempting to load a feed.'),
    '#default_value' => variable_get('feedmanager_timeout', 20)
  );

  $vocabularies = taxonomy_get_vocabularies();
  $vocabularies_list = array();
  foreach($vocabularies as $vocabulary) {
    $vocabularies_list[$vocabulary->vid] = check_plain($vocabulary->name);
  }

  $form['feedprocessing']['feedmanager_vocabulary'] = array(
    '#type' => 'select',
    '#multiple' => FALSE,
  	'#title' => t('Vocabulary'),
  	'#default_value' => variable_get('feedmanager_vocabulary', FALSE),
  	'#description' => t('Used to store taxonomy terms in for feeds.'),
    '#options' => $vocabularies_list,
  );

  $form['feedsources'] = array(
    '#type' => 'fieldset',
    '#title' => t('Feed Sources'),
    '#description' => t('Control the layout of feed items on the %url pages.', array('%url' => l('aggregator sources', 'aggregator/sources')))
  );

  $items = array(0 => t('none')) + drupal_map_assoc(array(3, 5, 10, 15, 20, 25), '_feedmanager_items');
  $form['feedsources']['aggregator_summary_items'] = array(
    '#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.')
  );

  $form['fullstory'] = array(
    '#type' => 'fieldset',
    '#title' => t('Full Story links')
  );

  $form['fullstory']['feedmanager_showfullstory'] = array(
    '#type' => 'checkbox',
    '#title' => t('Show a full story link'),
    '#description' => t('When available in the feed item, a link back to the original post will be displayed at the end of a node.'),
    '#default_value' => variable_get('feedmanager_showfullstory', true),
  );

  $options = array(
    'default' => t('Default (no target attribute)'),
    '_top' => t('Open link in window root'),
    '_blank' => t('Open link in new window'),
  );
  $form['fullstory']['feedmanager_target'] = array(
    '#type' => 'radios',
    '#title' => t('Link Target'),
    '#default_value' => variable_get('feedmanager_target', 'default'),
    '#options' => $options,
  );
  $form['fullstory']['feedmanager_rel'] = array(
    '#type' => 'checkbox',
    '#return_value' => 'nofollow',
    '#prefix' => '<div class="form-item"><label>Nofollow Value: </label>',
    '#suffix' => '</div>',
    '#title' => t('Add rel=&quot;nofollow&quot; Attribute'),
    '#description' => t('The <a href="http://en.wikipedia.org/wiki/Nofollow#rel.3D.22nofollow.22">rel=&quot;nofollow&quot; attribute</a> prevents some search engines from spidering entered links.'),
    '#default_value' => variable_get('feedmanager_rel',  false),
  );

  if (strncmp(VERSION, '4', 1) == 0) {
    return system_settings_form('feedmanager_admin_settings', $form);
  } else {
    return system_settings_form($form);
  }
}


/**
 * Implementation of hook_perm().
 */
function feedmanager_perm() {
  return array('administer news feeds', 'access news feeds');
}


/**
 * Generate a form to add/edit feed sources.
 */
function feedmanager_form_feed($edit = array()) {
  $op = arg(2);
    
  switch($op) {
    case 'edit':
      $form['title'] = array('#type' => 'textfield',
        '#title' => t('Title'),
        '#default_value' => $edit['title'],
        '#maxlength' => 64,
        '#description' => t('The name of the feed; typically the name of the web site you syndicate content from.'),
        '#required' => TRUE,
      );
    
      $form['url'] = array('#type' => 'textfield',
        '#title' => t('URL'),
        '#default_value' => $edit['url'],
        '#size' => 100,
        '#description' => t('The fully-qualified URL of the feed.'),
        '#attributes' => array('readonly' => 'readonly')
      );
      
      $form['description'] = array('#type' => 'textarea',
        '#title' => t('Description'),
        '#default_value' => $edit['description'],
        '#rows' => 5,
        '#description' => t('As supplied by the RSS feed.'),
      );
    
      $period = array(0 => t('never')) + drupal_map_assoc(array(300, 900, 1800, 3600, 7200, 10800, 21600, 32400, 43200, 64800, 86400, 172800, 259200, 604800, 1209600, 2419200), 'format_interval');
      if ($edit['refresh'] == -1) {
        $edit['refresh'] = 3600;
      }
      $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 %cron.', array('%cron' => l('crontab', 'admin/settings') )),
      );
    
      $period = array(0 => t('never')) + drupal_map_assoc(array(3600, 10800, 21600, 32400, 43200, 86400, 172800, 259200, 604800, 1209600, 2419200, 4838400, 9676800), 'format_interval');
      $form['expires'] = array(
        '#type' => 'select',
        '#title' => t('Discard news items older than'),
        '#default_value' => $edit['expires'],
        '#options' => $period,
        '#description' => t('Older news items will be automatically discarded.  Requires %cron.', array('%cron' => l('crontab', 'admin/settings') ))
      );
   
      // Handling of categories:
      $form += feedmanager_freetag($edit);
    
      $form['advanced'] = array(
        '#type' => 'fieldset',
        '#title' => t('Advanced'),
        '#description' => t('These settings are specific to the type of feed processor you have selected.'),
        '#collapsible' => TRUE,
        '#collapsed' => FALSE,
        '#tree' => TRUE
      );
    
      $form['advanced']['update_items'] = array(
        '#type' => 'checkbox',
        '#title' => t('Update news items'),
        '#description' => t('If the same news item is found in the feed on the next update the contents will overwrite the previous version stored here.'),
        '#default_value' => $edit['update_items'] ? $edit['update_items'] : FALSE,
      );
    
      $form['advanced']['processor'] = array('#type' => 'value', '#value' => $edit['processor']);
    
      $form['advanced']['stripads'] = array(
        '#type' => 'checkbox',
        '#title' => t('Strip Adverts'),
        '#description' => t('Strip out ads from certain advertisers, namely Pheedo, Google AdSense, and certain types of Doubleclick ads.'),
        '#default_value' => $edit['stripads'] ? $edit['stripads'] : TRUE,
      );
      break;
      
    case 'add':
      $form['url'] = array('#type' => 'textfield',
        '#title' => t('URL'),
        '#default_value' => $edit['url'],
        '#size' => 100,
        '#description' => t('The fully-qualified URL of the feed.'),
        '#required' => TRUE,
      );
      
      // We set feeds to not update until they have been edited
      $form['refresh'] = array('#type' => 'value', '#value' => -1);
      
      $processors = module_invoke_all('feedapi', $feed, 'processor_name');
      $form['processor'] = array(
        '#type' => 'select',
        '#title' => t('Processor'),
        '#description' => t("Each feed can have it's items generated by a different processor. This allows you to generate different types of content per feed - such as nodes or traditional aggregator items. Re-edit the feed to see processor specific settings."),
        '#options' => $processors,
        '#default_value' => $edit['processor'],
        '#size' => 1,
        '#required' => TRUE,
      );
      break;
  }
  
  $form['submit'] = array(
    '#type'          => 'submit',
    '#value'         => t('Submit'),
    '#weight'        => 35,
  );
  
  if ($edit['fid']) {
    $form['delete'] = array('#type' => 'submit', '#value' => t('Delete'), '#weight' => 19);
    $form['fid'] = array('#type' => 'value', '#value' => $edit['fid']);
  }

  return drupal_get_form('feedmanager_form_feed_'.$op, $form);
}


/**
 * Provides a freetagging form element.
 *
 * Code lifted from the taxonomy.module hook_form_alter()
 */
function feedmanager_freetag(&$feed) {
  $form = array();
  $terms = $feed['taxonomy'];

  // Find the vocabulary (if any) to use
  $vid = variable_get('feedmanager_vocabulary', FALSE);

  if($vid && $vocabulary = taxonomy_get_vocabulary($vid)) {
		if($terms) {
			$typed_terms = array();
			foreach ($terms as $term) {
				// Extract terms belonging to the vocabulary in question.
				if ($term->vid == $vocabulary->vid) {
	
					// Commas and quotes in terms are special cases, so encode 'em.
					if (preg_match('/,/', $term->name) || preg_match('/"/', $term->name)) {
						$term->name = '"'.preg_replace('/"/', '""', $term->name).'"';
					}
	
					$typed_terms[] = $term->name;
				}
			}
			
    	$typed_string = implode(', ', $typed_terms) . (array_key_exists('tags', $terms) ? $terms['tags'][$vocabulary->vid] : NULL);
		}

    if ($vocabulary->help) {
      $help = $vocabulary->help;
    }
    else {
      $help = t('A comma-separated list of terms describing this content.  Example: funny, bungee jumping, "Company, Inc.".');
    }

    $form['taxonomy']['tags'] = array('#type' => 'textfield',
      '#title' => $vocabulary->name,
      '#description' => $help,
      '#required' => $vocabulary->required,
      '#default_value' => $typed_string,
      '#autocomplete_path' => 'taxonomy/autocomplete/'. $vocabulary->vid,
      '#weight' => $vocabulary->weight,
      '#maxlength' => 255,
    );
  } else {
		$form['taxonomy_help'] = array(
			'#value' => t('You can automatically use tags defined in this feed to categories your nodes as they are created. To do this you need to %url to the %type content-type.', array('%url' => l(t('create a vocabulary and assign it'), 'admin/taxonomy'), '%type' => theme('placeholder', 'aggregator-item')))
		);
  }

  return $form;
}

/**
 * Validate feedmanager_form_feed form submissions.
 */
function feedmanager_form_feed_add_validate($form_id, $form_values) {
  // Check for duplicate feed urls
  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_array($result)) {
    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'])));
    }
  }
}


function feedmanager_form_feed_add_submit($form_id, $form_values) { 
  $feed = feedmanager_query_feed($form_values['url']);
  
  // Create a Feed title if none is available
  if(!$feed_title = $feed->get_feed_title()) {
    $urlinfo = parse_url($form_values['url']);
    $feed_title = $urlinfo['host'];
  }
  
  $form_values['title'] = $feed_title;
  $form_values['description'] = $feed->get_feed_description();
  $form_values['advanced']['processor'] = $form_values['processor'];
  feedmanager_save_feed($form_values);
  
  // Allow editing of further details
  drupal_goto('admin/aggregator/edit/feed/'.$form_values['fid']);
}


/**
 * Process feedmanager_form_feed form submissions.
 * @todo Add delete confirmation dialog.
 */
function feedmanager_form_feed_edit_submit($form_id, $form_values) { 
  if ($_POST['op'] == t('Delete')) {
    $title = $form_values['title'];
    // Unset the title:
    unset($form_values['title']);
  }

  feedmanager_save_feed($form_values);

  menu_rebuild();
  if (isset($form_values['fid'])) {
    if (isset($form_values['title'])) {
      drupal_set_message(t('The feed %feed has been updated.', array('%feed' => theme('placeholder', $form_values['title']))));
      if (arg(0) == 'admin') {
        return 'admin/aggregator/';
      }
      else {
        return 'aggregator/sources/'. $form_values['fid'];
      }
    }
    else {
      watchdog('aggregator', t('Feed %feed deleted.', array('%feed' => theme('placeholder', $title))));
      drupal_set_message(t('The feed %feed has been deleted.', array('%feed' => theme('placeholder', $title))));

      module_invoke($form_values['processor'], 'delete_feed', $form_values);

      if (arg(0) == 'admin') {
        return 'admin/aggregator/';
      }
      else {
        return 'aggregator/sources/';
      }
    }
  }
  else {
    watchdog('aggregator', t('Feed %feed added.', array('%feed' => theme('placeholder', $form_values['title']))), WATCHDOG_NOTICE, l(t('view'), 'admin/aggregator'));
    drupal_set_message(t('The feed %feed has been added.', array('%feed' => theme('placeholder', $form_values['title']))));
  }
}


/**
 * Add/edit/delete an aggregator feed.
 */
function feedmanager_save_feed(&$edit) {
  if ($edit['fid']) {
    // An existing feed is being modified, delete the existing category listings.
    db_query('DELETE FROM {aggregator_category_feed} WHERE fid = %d', $edit['fid']);
  }
  $data = serialize($edit['advanced']);

  if ($edit['fid'] && $edit['title']) {
    db_query("UPDATE {aggregator_feed} SET title = '%s', url = '%s', refresh = %d, description = '%s', expires = %d, data = '%s' WHERE fid = %d", $edit['title'], $edit['url'], $edit['refresh'], $edit['description'], $edit['expires'], $data, $edit['fid']);
  }
  else if ($edit['fid']) {

  	// Delete all feed category items
    $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, description, expires, data) VALUES (%d, '%s', '%s', %d, '%s', %d, '%s')", $edit['fid'], $edit['title'], $edit['url'], $edit['refresh'], $edit['description'], $edit['expires'], $data);
  }

  if ($edit['title']) {
    // The feed is being saved, save the categories as well.

    $vid = variable_get('feedmanager_vocabulary', FALSE);
    if ($edit['tags'] && $vid) {

      $vid_value = $edit['tags'];

      // This regexp allows the following types of user input:
      // this, "somecmpany, llc", "and ""this"" w,o.rks", foo bar
      $regexp = '%(?:^|,\ *)("(?>[^"]*)(?>""[^"]* )*"|(?: [^",]*))%x';
      preg_match_all($regexp, $vid_value, $matches);
      $typed_terms = array_unique($matches[1]);

      $inserted = array();
      foreach ($typed_terms as $typed_term) {
        // If a user has escaped a term (to demonstrate that it is a group,
        // or includes a comma or quote character), we remove the escape
        // formatting so to save the term into the DB as the user intends.
        $typed_term = str_replace('""', '"', preg_replace('/^"(.*)"$/', '\1', $typed_term));
        $typed_term = trim($typed_term);
        if ($typed_term == "") { continue; }

        // See if the term exists in the chosen vocabulary
        // and return the tid, otherwise, add a new record.
        $possibilities = taxonomy_get_term_by_name($typed_term);
        $typed_term_tid = NULL; // tid match if any.
        foreach ($possibilities as $possibility) {
          if ($possibility->vid == $vid) {
            $typed_term_tid = $possibility->tid;
          }
        }

        // if the term does not already exist, add it to the feedmanager vocabulary
        if (!$typed_term_tid) {
          $term = array('vid' => $vid, 'name' => $typed_term);
          $status = taxonomy_save_term($term);
          $typed_term_tid = $term['tid'];
        }

        // defend against duplicate, different cased tags
        if (!isset($inserted[$typed_term_tid])) {
          db_query('INSERT INTO {aggregator_category_feed} (fid, cid) VALUES (%d, %d)', $edit['fid'], $typed_term_tid);
          $inserted[$typed_term_tid] = TRUE;
        }
      }
    }
  } else {
    drupal_set_message(t('Unable to add the feed due to incomplete details being provided.'));
  }
}

function feedmanager_remove_confirm() {
  $feed_id = arg(3);
  $edit = $_POST['edit'];

  $feed = feedmanager_get_feed($feed_id);
  
  $form['feed_id'] = array('#type' => 'hidden', '#value' => $feed_id);
  $form['operation'] = array('#type' => 'hidden', '#value' => 'remove');

  $counter = module_invoke($feed['processor'], 'feedapi', $feed, 'item_count');
  return confirm_form('feedmanager_remove_confirm', $form,
                      t('Are you sure you want to delete all %count?', array('%count' => format_plural($counter['item_count'], '1 item', '%count items'))),
                      'admin/node', t('This action cannot be undone.'),
                      t('Delete all'), t('Cancel'));
}


/**
 * Removes all items (and associated data) from a feed
 */
function feedmanager_remove_confirm_submit($form_id, $form_values) {
  if ($form_values['confirm']) {
    $feed = feedmanager_get_feed($form_values['feed_id']);
    module_invoke_all('feedapi', $feed, 'remove');
  
    db_query("UPDATE {aggregator_feed} SET checked = 0, etag = '', modified = 0 WHERE fid = %d", $feed['fid']);
    drupal_set_message(t('The news items from %site have been removed.', array('%site' => theme('placeholder', $feed['title']))));
  }
  return 'admin/aggregator';
}


function feedmanager_query_feed($url) {
    include_once 'simplepie.inc';
  
    $pie_feed = new SimplePie();

    $pie_feed->enable_caching(false);
    $pie_feed->timeout = variable_get('feedmanager_timeout', 20);
    $pie_feed->cache_max_minutes(240); // configuration option
    $pie_feed->feed_url($url); // process the feed URL
    $pie_feed->init(); // process the feed
    $pie_feed->handle_content_type(); // set content type and character encoding
    
    // Check if there's any problems loading the feed
    $feed_error = $pie_feed->error;
    if (isset($feed_error)) {
        watchdog('aggregator', t('The RSS-feed from %site seems to be broken, due to "%error".', array('%site' => theme('placeholder', $pie_feed->get_feed_title()), '%error' => $feed_error)), WATCHDOG_WARNING);
        drupal_set_message(t('The RSS-feed from %site seems to be broken, because of error "%error".', array('%site' => theme('placeholder', $pie_feed->get_feed_title()), '%error' => $feed_error)));
        return FALSE;
    }
    
    return $pie_feed;
}


/**
 * Checks a news feed for new items.
 */
function feedmanager_refresh($feed) {
    // Load The Feed
    $pie_feed = feedmanager_query_feed($feed['url']);
    if(!$pie_feed) return FALSE;

    if (!$feed['data'] = $pie_feed->data) return FALSE;

    $pie_feed->strip_ads($feed['stripads']); // configuration option
    
    $feed['items'] = $pie_feed->get_items();

    $feed_links = $pie_feed->get_feed_links();
    $feed['link'] = array();
    $feed['link']['self'] = $feed_links['self'] ? $feed_links['self'][0] : $feed['url'];
    $feed['link']['alternate'] = $feed_links['alternate'] ? $feed_links['alternate'][0] : $feed['link']['self'];

    $feed['description'] = $pie_feed->get_feed_description();

    $feed['expires'] = 0;
    $feed['modified'] = 0;
    $feed['etag'] = 0;
    // end simplepie specific

    if ($pie_feed->get_image_link() && $pie_feed->get_image_url()) { // FIXME: use theme_image
        $feed['image_html'] = '<a href="'. $pie_feed->get_image_link() .'" class="feed-image"><img src="'. check_url($pie_feed->get_image_url()) .'" alt="'. check_plain($pie_feed->get_image_title()) .'" /></a>';
    }
    else {
        $feed['image_html'] = NULL;
    }

    // update feed information in database
    db_query("UPDATE {aggregator_feed} SET url = '%s', checked = %d, link = '%s', description = '%s', image = '%s', etag = '%s', modified = %d WHERE fid = %d", $feed['link']['self'], time(), $feed['link']['alternate'], $feed['description'], $feed['image_html'], $feed['etag'], $feed['modified'], $feed['fid']);

    // process all feed items
    $processed_items = 0;
    foreach($feed['items'] as $item) {
        $item->data['iid'] = db_next_id('{feedparser}_iid');
        $r = module_invoke_all('feedapi', $feed, 'item_save', $item);

        // if an item is saved, increase counter
        if($r['item_save']) {
          $processed_items++;
        }
    }

    // Log how many items were added and/or updated from a feed
    if($processed_items > 0) {
      watchdog('aggregator', t('There is %items new syndicated items from %site.', array('%items' => $processed_items, '%site' => theme('placeholder', $feed['title']))));
    }

    // Clear out any old feed items
    if($feed['expires'] != 0) {
        module_invoke($feed['processor'], 'feedapi', $feed, 'expire_items');
    }
}


/**
 * Gets information about a feed, either from the dbase or a temp cache
 */
function feedmanager_get_feed($fid) {
  static $feeds;

  if(!$feeds[$fid] && $fid) {
    $feed = db_fetch_array(db_query('SELECT * FROM {aggregator_feed} WHERE fid = %d', $fid));
    $data = unserialize($feed['data']);
    $feed += (array)$data;
    unset($feed['data']);

    $feed['taxonomy'] = array();

    $terms = db_query('SELECT cid, fid FROM {aggregator_category_feed} WHERE fid = %d', $feed['fid']);
    while ($term = db_fetch_object($terms)) {
      if ($term->fid) $feed['taxonomy'][] = taxonomy_get_term($term->cid);
    }

    $feeds[$fid] = $feed;
  }

  return $feeds[$fid];
}


function feedmanager_view() {
  $output .= '<h3>'. t('Feed overview') .'</h3>';

  $header = array(t('Title'), t('Items'), t('Last update'), t('Next update'), array('data' => t('Operations'), 'colspan' => '3'));
  $rows = array();

  $result = db_query('SELECT fid FROM {aggregator_feed} ORDER BY title');
  while ($feed = db_fetch_array($result)) {
    $feed = feedmanager_get_feed($feed['fid']);

    $item_count = module_invoke($feed['processor'], 'feedapi', $feed, 'item_count');

    // If A Feed Processor Implements Listing of Items Provide A Link
    if(module_hook($feed['processor'], 'list_items')) {
      $item_list_link = l($feed['title'], "aggregator/sources/{$feed['fid']}");
    } else {
      $item_list_link = check_plain($feed['title']);
    }

    $rows[] = array(
      $item_list_link,
      format_plural($item_count['item_count'], '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'), "admin/aggregator/edit/feed/{$feed['fid']}"),
      l(t('remove items'), "admin/aggregator/remove/{$feed['fid']}"),
      l(t('update items'), "admin/aggregator/update/{$feed['fid']}"));
  }
  $output .= theme('table', $header, $rows);

  return $output;
}


/**
 * Menu callback; removes all items from a feed, then redirects to the overview page.
 */
function feedmanager_admin_remove_feed($feed) {
  feedmanager_remove(feedmanager_get_feed($feed));
  drupal_goto('admin/aggregator');
}


/**
 * Menu callback; refreshes a feed, then redirects to the overview page.
 */
function feedmanager_admin_refresh_feed($feed) {
  feedmanager_refresh(feedmanager_get_feed($feed));
  drupal_goto('admin/aggregator');
}


/**
 * Menu callback; displays the aggregator administration page.
 */
function feedmanager_admin_overview() {
  return feedmanager_view();
}


/**
 * Display items from a feed source
 */
function feedmanager_page_sources() {
  $fid = arg(2);

  $output  = '<div id="aggregator">';

  // If A feed id is provided only show items from that feed
  if(is_numeric($fid)) {
    if($feed = feedmanager_get_feed($fid)) {
      drupal_set_breadcrumb(array( l(t('Home'), NULL), l('Aggregator','aggregator/sources'), l($feed['title'], 'aggregator/sources/'.$feed['fid'] ) )); 
      $output .= theme('feedmanager_feed', $feed);
      $output .= module_invoke($feed['processor'], 'list_items', $feed);
    }
  } else {
    $result = db_query('SELECT fid FROM {aggregator_feed} ORDER BY title');
    while ($fid = db_fetch_array($result)) {
      $feed = feedmanager_get_feed($fid['fid']);
      if(module_hook($feed['processor'], 'list_items')) {
        $output .= '<h2>'. check_plain($feed['title']) ."</h2>\n";
        $output .= module_invoke($feed['processor'], 'list_items', $feed, variable_get('aggregator_summary_items', 3));
        //add more link to full page
      }
    }

    // Add OPML XML link
  }

  $output .= '</div>';

  return $output;
}


/**
 * Generates an OPML representation of all feeds.
 */
function feedmanager_opml() {
  $result = db_query(db_rewrite_sql('SELECT title, url FROM {aggregator_feed} ORDER BY title ASC'));

  $output = "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n";
  $output .= "<opml version=\"1.1\">\n";
  $output .= "<head>\n";
  $output .= '<title>'. variable_get('site_name', 'drupal') .' - '. variable_get('site_slogan', '') ."</title>\n";
  $output .= '<dateModified>'. gmdate('r') ."</dateModified>\n";
  $output .= "</head>\n";
  $output .= "<body>\n";

  while ($feed = db_fetch_object($result)) {
    $output .= '<outline text="'. check_plain($feed->title) .'" xmlUrl="'. check_plain($feed->url) .'" />'."\n";
  }

  $output .= "</body>\n";
  $output .= "</opml>\n";

  drupal_set_header('Content-Type: text/xml; charset=utf-8');
  print $output;
}


/**
 * Implementation of hook_cron().
 *
 * Checks news feeds for updates once their refresh interval has elapsed.
 */
function feedmanager_cron() {
  // check how many feeds we can update at a time
  $limit = variable_get('feedmanager_cron_count', 5);
  if (is_numeric($limit) && $limit > -1) {
    $limit = 'LIMIT '. $limit;
  }
  else {
    $limit = '';
  }

  $result = db_query('SELECT fid FROM {aggregator_feed} WHERE refresh != 0 AND checked + refresh < %d ORDER BY checked ASC '. $limit, time());
  while ($fid = db_fetch_array($result)) {
    $feed = feedmanager_get_feed($fid['fid']);
    feedmanager_refresh($feed);
  }
}


/**
 * Helper function for drupal_map_assoc.
 */
function _feedmanager_items($count) {
  return format_plural($count, '1 item', '%count items');
}


/**
 * Safely render HTML content, as allowed.
 */
function feedmanager_filter_xss($value) {
  return filter_xss($value, preg_split('/\s+|<|>/', variable_get("feedmanager_allowed_html_tags", '<a> <b> <br> <dd> <dl> <dt> <em> <i> <li> <ol> <p> <strong> <u> <ul>'), -1, PREG_SPLIT_NO_EMPTY));
}


/**
 * Private function;
 * from: http://uk2.php.net/manual/en/function.html-entity-decode.php#51055
 * Used as callback function for preg_replace_all() to decode numeric entities to UTF-8 chars
 *
 * @param $ord Number
 * @return UTF-8 string
 */
function _parse_num_entity($ord) {
  $ord = $ord[1];
  if (preg_match('/^x([0-9a-f]+)$/i', $ord, $match)) {
    $ord = hexdec($match[1]);
  }
  else {
    $ord = intval($ord);
  }

  $no_bytes = 0;
  $byte = array();

  if ($ord == 128) {
    return chr(226).chr(130).chr(172);
  }
  else if($ord == 129) {
    return chr(239).chr(191).chr(189);
  }
  else if($ord == 130) {
    return chr(226).chr(128).chr(154);
  }
  else if($ord == 131) {
    return chr(198).chr(146);
  }
  else if($ord == 132) {
    return chr(226).chr(128).chr(158);
  }
  else if($ord == 133) {
    return chr(226).chr(128).chr(166);
  }
  else if($ord == 134) {
    return chr(226).chr(128).chr(160);
  }
  else if($ord == 135) {
    return chr(226).chr(128).chr(161);
  }
  else if($ord == 136) {
    return chr(203).chr(134);
  }
  else if($ord == 137) {
    return chr(226).chr(128).chr(176);
  }
  else if($ord == 138) {
    return chr(197).chr(160);
  }
  else if($ord == 139) {
    return chr(226).chr(128).chr(185);
  }
  else if($ord == 140) {
    return chr(197).chr(146);
  }
  else if($ord == 141) {
    return chr(239).chr(191).chr(189);
  }
  else if($ord == 142) {
    return chr(197).chr(189);
  }
  else if($ord == 143) {
    return chr(239).chr(191).chr(189);
  }
  else if($ord == 144) {
    return chr(239).chr(191).chr(189);
  }
  else if($ord == 145) {
    return chr(226).chr(128).chr(152);
  }
  else if($ord == 146) {
    return chr(226).chr(128).chr(153);
  }
  else if($ord == 147) {
    return chr(226).chr(128).chr(156);
  }
  else if($ord == 148) {
    return chr(226).chr(128).chr(157);
  }
  else if($ord == 149) {
    return chr(226).chr(128).chr(162);
  }
  else if($ord == 150) {
    return chr(226).chr(128).chr(147);
  }
  else if($ord == 151) {
    return chr(226).chr(128).chr(148);
  }
  else if($ord == 152) {
    return chr(203).chr(156);
  }
  else if($ord == 153) {
    return chr(226).chr(132).chr(162);
  }
  else if($ord == 154) {
    return chr(197).chr(161);
  }
  else if($ord == 155) {
    return chr(226).chr(128).chr(186);
  }
  else if($ord == 156) {
    return chr(197).chr(147);
  }
  else if($ord == 157) {
    return chr(239).chr(191).chr(189);
  }
  else if($ord == 158) {
    return chr(197).chr(190);
  }
  else if($ord == 159) {
    return chr(197).chr(184);
  }
  else if($ord == 160) {
    return chr(194).chr(160);
  }

  if ($ord < 128) {
    return chr($ord);
  }
  else if ($ord < 2048) {
    $no_bytes = 2;
  }
  else if ($ord < 65536) {
    $no_bytes = 3;
  }
  else if ($ord < 1114112) {
    $no_bytes = 4;
  }
  else {
    return;
  }

  switch ($no_bytes) {
    case 2:
      $prefix = array(31, 192);
      break;

    case 3:
      $prefix = array(15, 224);
      break;

    case 4:
      $prefix = array(7, 240);
      break;
  }

  for ($i = 0; $i < $no_bytes; $i++) {
    $byte[$no_bytes - $i - 1] = (($ord & (63 * pow(2, 6 * $i))) / pow(2, 6 * $i)) & 63 | 128;
  }

  $byte[0] = ($byte[0] & $prefix[0]) | $prefix[1];

  $ret = '';
  for ($i = 0; $i < $no_bytes; $i++) {
    $ret .= chr($byte[$i]);
  }

  return $ret;
}

/**
 * Private function; Convert named entities to UTF-8 characters
 * from: http://pl2.php.net/manual/en/function.html-entity-decode.php#51722
 */
function _parse_name_entities(&$data) {
  static $ttr;
  if (!$ttr) {
    $trans_tbl = get_html_translation_table(HTML_ENTITIES);
    foreach ($trans_tbl as $k => $v) {
      $ttr[$v] = utf8_encode($k);
    }
    $ttr['&apos;'] = "'";
  }
  return strtr($data, $ttr);
}
