modules/category_aggregator/category_aggregator.module

<?php

// $Id: category_aggregator.module,v 1.4.2.18 2007/04/28 21:32:13 mistknight Exp $

/**
 * A number of defs to ease naming
 */
define("FEEDS_ARENT_ASSIGNED_TERM_UNDER_ACTIVE_VOCABULARY", 1);
define("FTP_REQUEST_FAILED", 2);
define("HTTP_REQUEST_FAILED", 3);
define("MALFORMED_XML", 4);
define("category_aggregator_FAILED", 5);
define("EMPTY_IMAGE", 6);
define("COULD_NOT_WRITE_TO_FILE", 7);

// These two variables are needed to get the etag and/or last modified

static $etag;
static $last_modified;

/**
 * Implementation of hook_help
 */
function category_aggregator_help($section)
{
	switch ($section)
	{
		case 'admin/help#category_aggregator':
			$output = '<p>'. t('The category_aggregator module is a module that is responsible for aggregating any XML feed, custom feeds need a feed_handler. Check the accompanying readme file.') .'</p>';
			$output .= '<p>' .t('Visit the <a href="!admin-settings">settings</a> page to tweak its behavior', array('!admin-settings'=> url('admin/settings/category_aggregator')));
			return $output;
	}
}


/**
 * Implementation of hook_perm().
 */
function category_aggregator_perm()
{
	return array('manage category aggregator feeds', 'manage category aggregator items', 'view category aggregator items',
	  	'manage own feed items', 'manage feed items', 'specify feed categories');
}

/**
 * Implementation of hook_node_info().
 */
function category_aggregator_node_info()
{
	return array
	(
    	'category_aggregator_feed' => array('name' => t('Feed'), 'module' => 'category_aggregator_feed', 'description' => t('Represents the feed the site aggregates from. Items are generated from feeds during cron runs.'), 'has_title' => TRUE, 'title_label' => t('Feed name'), 'has_body' => TRUE, 'body_label' => t('Description')),
	    'category_aggregator_item' => array('name' => t('Feed Item'), 'module' => 'category_aggregator_item', 'description' => t('Items are usually auto-generated on cron runs, but this type exists in case you would like to manually add an item.'))
    );
}

/**
 * Implementation of hook_menu().
 *
 */
function category_aggregator_menu($may_cache)
{
	$items = array();

	if (!$may_cache)
	{
		$items[] = array(
		'path' => 'admin/settings/category_aggregator',
		'title' => t('Category Aggregator'),
		'description' => t('These options control the general behavior of the category aggregator module.'),
		'callback' => 'drupal_get_form',
		'callback arguments' => array('category_aggregator_admin_settings'),
		'access' => user_access('administer site configuration'),
		'type' => MENU_NORMAL_ITEM);
	}

	return $items;
}

/**
 * This is the function that will be called instead of the old hook_settings
 */

function category_aggregator_admin_settings()
{
	$form = array();

	$vocabs = taxonomy_get_vocabularies('category_aggregator_feed');

	foreach ($vocabs AS $vid => $vocab_object)
		$vocabs[$vid] = $vocab_object->name;

	$form['category_aggregator_current_vid'] = array(
		'#type' => 'select',
		'#title' => t('category aggregator feed types'),
		'#default_value' => variable_get('category_aggregator_current_vid', -1),
		'#options' => $vocabs,
		'#description' => t('This vocabulary contains the XML types -as terms- that the module can aggregate from.'),
		'#required' => TRUE
	);

	$form['category_aggregator_item_time_to_live'] = array(
		'#type' => 'textfield',
		'#default_value' => variable_get('category_aggregator_item_time_to_live', 30),
		'#required' => TRUE,
		'#title' => t('Please specify the number of DAYS an item will live'),
		'#description' => t('If feed is set to delete old items, this variable will determine the age after which an item will be deleted.')
	);

	$form['category_aggregator_enable_logging'] = array(
		'#type' => 'checkbox',
		'#default_value' => variable_get('category_aggregator_enable_logging', 1),
		'#title' => t('Log Operations'),
		'#description' => t('After moving to production, you may wish to disable this if you feel everything is stable enough. But it\'s recommended you keep it on. Fatal errors will ALWAYS be logged.')
	);

	$form['category_aggregator_image_to_display'] = array(
		'#type' => 'textfield',
		'#default_value' => variable_get('category_aggregator_image_to_display', 'preview'),
		'#required' => TRUE,
		'#title' => t('Image to display'),
		'#description' => t('This is the image size that will be displayed on aggregated items\' node page for feeds that aggregate images.')
	);

	$form['category_aggregator_enable_cron'] = array(
		'#type' => 'checkbox',
		'#default_value' => variable_get('category_aggregator_enable_cron', 1),
		'#title' => t('Enable Cron'),
		'#description' => t('Remove this check if you want to stop category aggregator cron temporarily.')
	);

	$form['category_aggregator_feeds_to_refresh_per_cron'] = array(
		'#type' => 'textfield',
		'#default_value' => variable_get('category_aggregator_feeds_to_refresh_per_cron', 7),
		'#required' => TRUE,
		'#title' => t('The number of feeds to refresh every cron'),
		'#description' => t('This is important if you have many feeds that may slow the site.').'<br />'.
		t('All feeds will eventually be processed, so this option will simply slow the process down to minimize effects on the site. But it will delay the time needed for all feeds to refresh.')
	);

	$form['category_aggregator_feed_refresh_cooldown'] = array(
		'#type' => 'textfield',
		'#default_value' => variable_get('category_aggregator_feed_refresh_cooldown', 0),
		'#required' => TRUE,
		'#title' => t('Time Between Feeds'),
		'#description' => t('Does your server die when a refresh occurs? Try setting this IN SECONDS.')
	);

	$form['category_aggregator_feed_global_categories'] = array(
		'#type' => 'textfield',
		'#default_value' => variable_get('category_aggregator_feed_global_categories', ''),
		'#title' => t('Feed Global Categotries/Tags'),
		'#description' => t('Specify the Global categories/Tags. '.
				     'You can enter multiple categories seprated by comma Ex.Social Tool, Startup')
	);

	return system_settings_form($form);
}

/**
 * This function validates the settings form
 */
function category_aggregator_validate_settings($form)
{
	if (!is_numeric($form['category_aggregator_item_time_to_live']))
		form_set_error('category_aggregator_item_time_to_live', t('This field must be numeric.'));

	if ($form['category_aggregator_item_time_to_live'] <= 0)
		form_set_error('category_aggregator_item_time_to_live', t('This field must be a positive number.'));

	if (!is_numeric($form['category_aggregator_feeds_to_refresh_per_cron']))
		form_set_error('category_aggregator_feeds_to_refresh_per_cron', t('This field must be numeric.'));

	if ($form['category_aggregator_feeds_to_refresh_per_cron'] <= 0)
		form_set_error('category_aggregator_feeds_to_refresh_per_cron', t('This field must be a positive number.'));

	if (!is_numeric($form['category_aggregator_feed_refresh_cooldown']))
		form_set_error('category_aggregator_feed_refresh_cooldown', t('This field must be numeric.'));

	if ($form['category_aggregator_feed_refresh_cooldown'] < 0)
		form_set_error('category_aggregator_feed_refresh_cooldown', t('This field must be positive or zero.'));
}

/**
 * Implementation of hook_cron().
 */
function category_aggregator_cron()
{
	if (!variable_get('category_aggregator_enable_cron', TRUE))
	{
		watchdog('category_aggregator', 'You seem to have disabled category_aggregator from category_aggregator settings.');
		return;
	}
	$vid = variable_get('category_aggregator_current_vid', -1);
	if ($vid == -1)
	{
		watchdog('category_aggregator', 'For some reason, category_aggregator\'s vocabulary is not set.'.
			'Try visiting category_aggregator\'s settings to set it!');
		return;
	}

	$max_exec_time = ini_get('max_execution_time');
	$max_exec_time = (int)$max_exec_time;

	if (!ini_get('safe_mode'))
		set_time_limit(20 * 60);

	$feeds = db_query_range("SELECT n.nid FROM {category_aggregator_feed} af, {node} n ".
		"WHERE af.nid = n.nid AND af.enabled = 'yes' AND (UNIX_TIMESTAMP() - af.last_refreshed) >= af.refresh_interval * 60 ORDER BY af.last_refreshed", 0, variable_get('category_aggregator_feeds_to_refresh_per_cron', 7));

	while ($feed_nid = db_fetch_object($feeds)->nid)
	{
		db_query("UPDATE {category_aggregator_feed} SET last_refreshed = %d WHERE nid = %d", time(), $feed_nid);

		$feed = node_load($feed_nid);
		category_aggregator_feed_prepare($feed);

		try {
			$success = _category_aggregator_parse($feed, $vid);

			if (is_null($success)) continue;

			if (!$success)
				throw new Exception('Something wrong occured during the category_aggregator process!', category_aggregator_FAILED);

			if (variable_get('category_aggregator_enable_logging', TRUE))
				watchdog('category_aggregator', 'category_aggregator has finished aggregating items from '.$feed->title);

			// using this instead of node_save for performance reasons
			db_query("UPDATE {category_aggregator_feed} SET etag = '%s', ".
				"last_modified = %d, last_refreshed = %d WHERE nid = %d", $feed->etag,
				$feed->last_modified, time(), $feed->nid);

			if ($feed->delete_old_items)
			{
				$items_to_be_deleted = db_query("SELECT n.nid FROM {node} n, ".
				"{category_aggregator_item} ai WHERE n.nid = ai.nid AND ai.fid = %d AND ".
				"(UNIX_TIMESTAMP() - n.created) >= %d", $feed->nid,
				variable_get('category_aggregator_item_time_to_live', 30) * 24 * 60 * 60);

				while ($item = db_fetch_object($items_to_be_deleted))
					node_delete($item->nid);
			}
		}
		catch (Exception $e) {
			watchdog('category_aggregator', $e->getMessage(), WATCHDOG_ERROR, l(t('view'), "node/$feed->nid"));
		}
	}

	if (!ini_get('safe_mode') && is_numeric($max_exec_time) && $max_exec_time > 0)
		set_time_limit($max_exec_time);
}

/* Following are the category_aggregator_feed hooks */

/**
 * Implementation of hook_access().
 */

function category_aggregator_feed_access($op, $node)
{	
		
	return user_access('manage category aggregator feeds');

}

/**
 * Implementation of hook_form().
 */

function category_aggregator_feed_form(&$node, &$param)
{	
	global $category_perm;

	$form = array();

	$form['title'] = array (
		'#type' => 'textfield',
		'#default_value' => $node->title,
		'#required' => TRUE,
		'#title' => t(node_get_types('type', 'category_aggregator_feed')->title_label),
		'#description' => t('Enter something descriptive to identify your feed.')
	);

	$form['body_filter']['body'] = array (
		'#type' => 'textarea',
		'#default_value' => $node->body,
		'#required' => FALSE,
		'#title' => t(node_get_types('type', 'category_aggregator_feed')->body_label),
		'#description' => t('Any description for your feed.')
	);

	$form['body_filter']['format'] = filter_form($node->format);

	$form['original_author'] = array(
		'#type' => 'textfield',
		'#default_value' => $node->original_author,
		'#required' => TRUE,
		'#title' => t('Original Author'),
		'#description' => t('Please specify the original author for the items of this feed. '.
			'This is used when none is present in the feed itself.')
	);

	
	if (user_access('specify feed categories'))
	{
		$form['categories'] = array (
			'#type' => 'textfield',
			'#default_value' => $node->categories,	
			'#title' => t('User Specified Categories/Tags.'),
			'#description' => t('Specify the Tag/Categories for which you want your feed items to be aggregated. '.
				'You can enter multiple categories seprated by comma. Ex: Social Tools,Startup.')
		);
	
	$form ['global_categories'] = array (
		'#type' => 'textfield',
		'#disabled' => 'yes',
		'#title'=> 'Global Tags/Categories',
		'#default_value' => variable_get('category_aggregator_feed_global_categories',''),
		'#description' => t('Feeds will be aggreagted based on these global categories in addition to User Specified Categories/Tags. '. 
				'If user does not specify a category, feeds will be aggregated on the basis of Global Tags/Categories. '.
				'A blank field indicates no global categories has been defined. '.
				'If User Specified Categories/Tags field and Global Tags/Categories both are empty then the feeds will be '.
				'aggregated irrespective of the Categories/Tags.')
	);
	
	}

	else {
		
		$form ['global_categories'] = array (
			'#type' => 'textfield',
			'#disabled' => 'yes',
			'#title'=> 'Global Tags/Categories',
			'#default_value' => variable_get('category_aggregator_feed_global_categories',''),
			'#description' => t('Feeds will be aggreagted based on these global categories. '. 
					'A blank field indicates no global categories has been defined and the feeds will be '.
					'aggregated irrespective of the Categories/Tags.')
	);
	
	}

	$form['url'] = array (
		'#type' => 'textfield',
		'#default_value' => $node->url,
		'#required' => TRUE,
		'#title' => t('Feed URL'),
		'#description' => t('Please provide the feed URL.')
	);

	$form['authentication'] = array (
		'#type' => 'fieldset',
		'#title' => t('Authentication Settings'),
		'#collapsible' => TRUE,
		'#collapsed' => FALSE,
		'#tree' => FALSE
	);

	$form['authentication']['username'] = array(
		'#type' => 'textfield',
		'#default_value' => $node->username,
		'#required' => FALSE,
		'#description' => t('If your site uses authentication, please specify the username here.'),
		'#title' => t('Enter Username')
	);

	$description = t('If your site uses authentication, please specify the password here.');

	// This indicates we're in edit mode, in which case I'd like to add an additional directive
	if ($node->password)
		$description .= '<br />'.
			t('(leave empty to preserve value)');

	$form['authentication']['password'] = array(
		'#type' => 'password',
		'#default_value' => $node->password,
		'#required' => FALSE,
		'#description' => $description,
		'#title' => 'Enter Password'
	);

	$description = t('If your site uses authentication, please retype your password here.');

	// This indicates we're in edit mode, in which case I'd like to add an additional directive
	if ($node->password)
		$description .= '<br />'.
			t('(leave empty to preserve value)');

	$form['authentication']['repeat_password'] = array(
		'#type' => 'password',
		'#default_value' => $node->password,
		'#required' => FALSE,
		'#description' => $description,
		'#title' => t('Retype Your Password')
	);

	$form['refresh_interval'] = array(
		'#type' => 'textfield',
		'#default_value' => $node->refresh_interval,
		'#required' => TRUE,
		'#title' => t('Refresh Interval'),
		'#description' => t('Please specify the refresh interval IN MINUTES.')
	);

	$form['title_as_guid_interval'] = array(
		'#type' => 'textfield',
		'#default_value' => $node->title_as_guid_interval ? $node->title_as_guid_interval : 0,
		'#required' => TRUE,
		'#title' => t('Title as GUID interval'),
		'#description' => t('When a feed contains no GUID or image URL, then the title is it\'s guid. This field '.
			'specifies the time period the title is considered as a GUID. If you provide a GUID or image URL then '.
			'this field value is irrelevant. If not, then you can set this to 0 which would prevent any new article '.
			'with the same title from ever entering (unless the old one is deleted) - this could also be achieved by sending '.
			'the title as the GUID - , or you can set it to the time IN HOURS the title will act as a GUID, after which '.
			'any other article still in the feed with the same title will enter the system.')
	);

	$form['enabled'] = array(
		'#type' => 'checkbox',
		'#default_value' => $node->enabled,
		'#title' => t('Enabled'),
		'#description' => t('Use this checkbox to enable/disable refreshing this feed.')
	);

	$form['publish_new_items'] = array(
		'#type' => 'checkbox',
		'#default_value' => $node->publish_new_items,
		'#description' => t('Use this checkbox to publish all aggregated feed items.'),
		'#title' => t('Publish items')
	);

	$form['link_items_to_original_urls'] = array(
		'#type' => 'checkbox',
		'#default_value' => $node->link_items_to_original_urls,
		'#description' => t('Link items generated from this feed to original URLs.'),
		'#title' => t('Link items to URLs')
	);

	$form['aggregate_to_moderation_queue'] = array(
		'#type' => 'checkbox',
		'#default_value' => $node->aggregate_to_moderation_queue,
		'#description' => t('Use this checkbox to send aggregated items to the moderation queue. Weather they appear on the site or not depends on the \'publish items\', not weather they are on the moderation queue.'),
		'#title' => t('Add aggregated items to moderation queue')
	);

	$form['sticky_items'] = array(
		'#type' => 'checkbox',
		'#default_value' => $node->sticky_items,
		'#description' => t('All items aggregated from this feed will be sticky.'),
		'#title' => t('Sticky items')
	);

	$form['enable_comments_on_articles'] = array(
		'#type' => 'checkbox',
		'#default_value' => $node->enable_comments_on_articles,
		'#description' => t('All aggregated articles will have commenting set to read/write.'),
		'#title' => t('Aggregated article comments')
	);

	$form['enable_comments_on_images'] = array(
		'#type' => 'checkbox',
		'#default_value' => $node->enable_comments_on_images,
		'#description' => t('All aggregated images will have commenting set to read/write.'),
		'#title' => t('Aggregated images\' comments')
	);

	$form['delete_old_items'] = array(
		'#type' => 'checkbox',
		'#default_value' => $node->delete_old_items,
		'#description' => t('Use this checkbox to delete items older than (n) days, change this value from the settings. Uncheck and items under this feed will never be deleted until this option is turned on.'),
		'#title' => t('Delete Old Items')
	);

	$form['promote_to_frontpage'] = array(
		'#type' => 'textfield',
		'#default_value' => $node->promote_to_frontpage ? $node->promote_to_frontpage : 0,
		'#required' => TRUE,
		'#title' => t('Promote to frontpage'),
		'#description' => t('Please specify the number of articles to promote to the frontpage.')
	);

	$form['item_taxonomies'] = array (
		'#type' => 'fieldset',
		'#title' => t('Item Taxonomies'),
		'#collapsible' => TRUE,
		'#collapsed' => FALSE,
		'#tree' => FALSE,
		'#description' => t('These taxonomies will be assigned to all items under this feed.')
	);

	$fakeform = array();
	$fakeform['#node'] = new stdClass();

	if ($node->item_categories)
		$fakeform['#node']->taxonomy = $node->item_categories;

	// This part will trick taxonomy into believing it's dealing with an category_aggregator_item
	$fakeform['type']['#value'] = 'category_aggregator_item';
	$fakeform['#node']->type = 'category_aggregator_item';

	taxonomy_form_alter('category_aggregator_item_node_form', $fakeform);

	$form['item_taxonomies']['item_categories'] = $fakeform['taxonomy'];

	return $form;
}

/**
 * Implementation of hook_validate().
 */

function category_aggregator_feed_validate(&$node)
{
	if (!is_numeric($node->refresh_interval) || $node->refresh_interval < 0)
		form_set_error('refresh_interval', 'The refresh interval is a numeric value greater than or equal to 0.');
	else if (!is_numeric($node->title_as_guid_interval) || $node->title_as_guid_interval < 0)
		form_set_error('title_as_guid_interval', 'The title as GUID interval is a positive numeric or 0.');
	else if (!is_numeric($node->promote_to_frontpage) || $node->promote_to_frontpage < 0)
		form_set_error('promote_to_frontpage', 'The number of items to promote to the frontpage is a positive numeric or 0.');
	else if ($node->password != $node->repeat_password)
		form_set_error('password', 'Your passwords did not match.');
}

/**
 * Implementation of hook_submit().
 */

function category_aggregator_feed_submit(&$node)
{
    $node->title = check_plain($node->title);
    $node->original_author = check_plain($node->original_author);
    $node->categories = check_plain($node->categories);

	$node->enabled = $node->enabled ? 'yes' : 'no';
	$node->publish_new_items = $node->publish_new_items ? 'yes' : 'no';
	$node->delete_old_items = $node->delete_old_items ? 'yes' : 'no';
	$node->link_items_to_original_urls = $node->link_items_to_original_urls ? 'yes' : 'no';
	$node->aggregate_to_moderation_queue = $node->aggregate_to_moderation_queue ? 'yes' : 'no';
	$node->sticky_items = $node->sticky_items ? 'yes' : 'no';
	$node->enable_comments_on_articles = $node->enable_comments_on_articles ? 'yes' : 'no';
	$node->enable_comments_on_images = $node->enable_comments_on_images ? 'yes' : 'no';
	$node->etag = '';
	$node->last_modified = 0;

	$node->title = trim($node->title);
	$node->original_author = trim($node->original_author);
	$node->categories = trim($node->categories);
	$node->url = trim($node->url);
	$node->username = trim($node->username);
	$node->password = trim($node->password);

	$node->item_categories = serialize($node->item_categories);
}

/**
 * Implementation of hook_prepare().
 */

function category_aggregator_feed_prepare(&$node)
{
	$node->refresh_interval = $node->refresh_interval ? $node->refresh_interval : 15;

	$node->enabled = $node->enabled ? ($node->enabled == 'yes' ? TRUE : FALSE) : TRUE;

	$node->publish_new_items = $node->publish_new_items ?
		($node->publish_new_items == 'yes' ? TRUE : FALSE) : TRUE;

	$node->delete_old_items = $node->delete_old_items ?
		($node->delete_old_items == 'yes' ? TRUE : FALSE) : FALSE;

	$node->link_items_to_original_urls = $node->link_items_to_original_urls ?
		($node->link_items_to_original_urls == 'yes' ? TRUE : FALSE) : TRUE;

	$node->aggregate_to_moderation_queue = $node->aggregate_to_moderation_queue ?
		($node->aggregate_to_moderation_queue == 'yes' ? TRUE : FALSE) : FALSE;

	$node->sticky_items = $node->sticky_items ? ($node->sticky_items == 'yes' ? TRUE : FALSE) : FALSE;

	$node->enable_comments_on_articles = $node->enable_comments_on_articles ?
		($node->enable_comments_on_articles == 'yes' ? TRUE : FALSE) : FALSE;

	$node->enable_comments_on_images = $node->enable_comments_on_images ?
		($node->enable_comments_on_images == 'yes' ? TRUE : FALSE) : FALSE;

	if ($node->item_categories && $node->item_categories != '')
		$node->item_categories = unserialize($node->item_categories);

	// There's a specific format needed to reconstruct a form, we're creating it now
	if ($node->item_categories)
	{
		$formatted_item_categories = array();
		if (is_array($node->item_categories))
		{
			foreach ($node->item_categories AS $vid => $tids)
			{
				if (is_array($tids) && count($tids) > 0)
				{
					foreach ($tids AS $tid => $tid)
						if ($tid > 0)
							$formatted_item_categories[$tid] = taxonomy_get_term($tid);
				}
				else if (is_string($tids))
				{
					if ($tids > 0)
						$formatted_item_categories[$tids] = taxonomy_get_term($tids);
				}
			}
		}

		$node->item_categories = $formatted_item_categories;
	}
}

/**
 * Implementation of hook_load().
 */

function category_aggregator_feed_load($node)
{
	return db_fetch_object(db_query("SELECT * FROM {category_aggregator_feed} WHERE nid = %d", $node->nid));
}

/**
 * Implementation of hook_insert().
 */

function category_aggregator_feed_insert($node)
{
	db_query("INSERT INTO {category_aggregator_feed} VALUES ".
		"(%d, '%s', '%s', '%s', '%s', '%s', %d, %d, '%s', '%s', '%s', '%s', '%s', '%s', %d ,'%s', '%s', '%s', '%s', %d, %d)",
		$node->nid, $node->original_author, $node->categories, $node->url, $node->username, $node->password,
		$node->refresh_interval, $node->title_as_guid_interval, $node->enabled, $node->publish_new_items,
		$node->aggregate_to_moderation_queue, $node->sticky_items, $node->enable_comments_on_articles,
		$node->enable_comments_on_images, $node->promote_to_frontpage, $node->delete_old_items,
		$node->link_items_to_original_urls, $node->item_categories,
		'', 0, 0);
}

/**
 * Implementation of hook_update().
 */

function category_aggregator_feed_update($node)
{
	if (trim($node->password) != '')
	{
		db_query("UPDATE {category_aggregator_feed} SET original_author = '%s', categories = '%s', url = '%s', ".
			"username = '%s', password = '%s', refresh_interval = %d, title_as_guid_interval = %d, enabled = '%s', ".
			"publish_new_items = '%s', aggregate_to_moderation_queue = '%s', sticky_items = '%s', enable_comments_on_articles = '%s', enable_comments_on_images = '%s', promote_to_frontpage = %d, delete_old_items = '%s', item_categories = '%s', ".
			"last_modified = %d, last_refreshed = %d, link_items_to_original_urls = '%s' WHERE nid = %d",
			$node->original_author, $node->categories, $node->url, $node->username, $node->password,
			$node->refresh_interval, $node->title_as_guid_interval, $node->enabled, $node->publish_new_items,
			$node->aggregate_to_moderation_queue, $node->sticky_items, $node->enable_comments_on_articles,
			$node->enable_comments_on_images, $node->promote_to_frontpage,
			$node->delete_old_items, $node->item_categories,
			($node->etag && $node->etag != '') ? $node->etag : '',
			($node->last_modified && $node->last_modified != 0) ? $node->last_modified : 0,
			0, $node->link_items_to_original_urls, $node->nid);
	}
	else
	{
		db_query("UPDATE {category_aggregator_feed} SET original_author = '%s', categories = '%s', url = '%s', ".
			"username = '%s', refresh_interval = %d, title_as_guid_interval = %d, enabled = '%s', ".
			"publish_new_items = '%s', aggregate_to_moderation_queue = '%s', sticky_items = '%s', enable_comments_on_articles = '%s', enable_comments_on_images = '%s', promote_to_frontpage = %d, delete_old_items = '%s', item_categories = '%s', ".
			"etag = '%s', last_modified = %d, last_refreshed = %d, link_items_to_original_urls = '%s' WHERE nid = %d",
			$node->original_author, $node->categories, $node->url, $node->username,
			$node->refresh_interval, $node->title_as_guid_interval, $node->enabled, $node->publish_new_items,
			$node->aggregate_to_moderation_queue, $node->sticky_items, $node->enable_comments_on_articles,
			$node->enable_comments_on_images, $node->promote_to_frontpage,
			$node->delete_old_items, $node->item_categories,
			($node->etag && $node->etag != '') ? $node->etag : '',
			($node->last_modified && $node->last_modified != 0) ? $node->last_modified : 0,
			0, $node->link_items_to_original_urls, $node->nid);
	}

}

/**
 * Implementation of hook_delete().
 */

function category_aggregator_feed_delete(&$node)
{
	$items = _category_aggregator_get_feed_items($node->nid);

	while ($item = db_fetch_object($items))
		node_delete($item->nid);

	db_query("DELETE FROM {category_aggregator_feed} WHERE nid = %d", $node->nid);
}

/* Following are the category_aggregator_item hooks */

/**
 * Implementation of hook_access().
 */

function category_aggregator_item_access($op, $node)
{
	global $user;

	if ($op == 'create') return user_access('manage category aggregator items');
	if ($op == 'update' || $op == 'delete')
	{
	   if (user_access('manage feed items')) return TRUE;
	   return (user_access('manage own feed items') && ($user->uid == $node->uid));
	}
	if ($op == 'view') return user_access('view category aggregator items');
}

/**
 * Implementation of hook_form().
 */

function category_aggregator_item_form(&$node, &$param)
{
	$form = array();

	$form['title'] = array (
		'#type' => 'textfield',
		'#default_value' => $node->title,
		'#required' => TRUE,
		'#title' => t(node_get_types('type', 'category_aggregator_item')->title_label),
		'#description' => t('The title of your feed item.')
	);

	$form['teaser'] = array (
		'#type' => 'textarea',
		'#default_value' => $node->teaser,
		'#required' => FALSE,
		'#title' => t('Teaser'),
		'#description' => t('This is the article\'s teaser.')
	);

	$form['body_filter']['body'] = array (
		'#type' => 'textarea',
		'#default_value' => $node->body,
		'#required' => FALSE,
		'#title' => t(node_get_types('type', 'category_aggregator_item')->body_label),
		'#description' => t('This is the main body of your article.')
	);

	$form['body_filter']['format'] = filter_form($node->format);

	$form['original_author'] = array(
		'#type' => 'textfield',
		'#default_value' => $node->original_author,
		'#required' => TRUE,
		'#title' => t('Original Author'),
		'#description' => t('Specify the author of this feed item.'),
	);

	$form['url'] = array (
		'#type' => 'textfield',
		'#default_value' => $node->url,
		'#required' => FALSE,
		'#title' => t('Original URL'),
		'#description' => t('Provide the URL of the original article if needed.')
	);

	$form['link_to_original_url'] = array(
		'#type' => 'checkbox',
		'#default_value' => $node->link_to_original_url,
		'#description' => t('Link this item to its original URL (if available).'),
		'#title' => t('Link to URL')
	);

	$form['image_id'] = array (
		'#type' => 'textfield',
		'#default_value' => $node->image_id,
		'#required' => FALSE,
		'#title' => t('Image ID'),
		'#description' => t('Provide an image id to attach an image.')
	);

	$description = t('The GUID is a unique string that distingishes your article from '.
			'all others and prevents a second category_aggregator. Please provide it if available.');

	// This indicates we're in edit mode, in which case I'd like to add an additional directive
	if ($node->story_guid)
		$description .= '<br />'.
			t('(leave empty to preserve value)');

	$form['story_guid'] = array (
		'#type' => 'textfield',
		'#default_value' => '',
		'#required' => FALSE,
		'#title' => t('GUID'),
		'#description' => $description
	);

	$feeds = db_query('SELECT n.nid, n.title FROM {node} n, {category_aggregator_feed} af '.
		'WHERE n.nid = af.nid');

	if (db_num_rows($feeds) != 0)
	{
		$feed_array = array();

		$feed_array[0] = '<none>';

		while ($feed = db_fetch_object($feeds))
			$feed_array[$feed->nid] = $feed->title;

		$form['fid'] = array (
			'#type' => 'select',
			'#default_value' => $node->fid,
			'#required' => TRUE,
			'#title' => t('Source Feed'),
			'#description' => t('Provide the source feed if valid for this item.'),
			'#options' => $feed_array
		);
	}

	return $form;
}

/**
 * Implementation of hook_validate().
 */

function category_aggregator_item_validate(&$node)
{
	if (trim($node->image_id) != '')
	{
		if (!is_numeric($node->image_id))
			form_set_error('image_id', 'The image id must be numeric.');
		// A node load is simply too costly, so I'm going to directly query instead.
		else if ($node->image_id != 0 && db_fetch_object(db_query("SELECT COUNT(n.nid) AS image_count FROM {node} n ".
			"WHERE n.nid = %d AND n.type = 'image'", $node->image_id))->image_count == 0)
				form_set_error('image_id', 'This image ID seems to be incorrect!');
	}
}

/**
 * Implementation of hook_submit().
 */

function category_aggregator_item_submit(&$node)
{
    $node->title = check_plain($node->title);
    $node->teaser = check_plain($node->teaser);
    $node->original_author = check_plain($node->original_author);

	$node->link_to_original_url = $node->link_to_original_url ? 'yes' : 'no';

	if (!$node->fid)
		$node->fid = 0;

	if ($node->image_id == '')
		$node->image_id = 0;

	if (trim($node->story_guid) != '')
		$node->story_guid = sprintf('%u', crc32($node->story_guid));
	else
		$node->story_guid = '';
}

/**
 * Implementation of hook_prepare().
 */

function category_aggregator_item_prepare(&$node)
{
	$node->link_to_original_url = $node->link_to_original_url ?
		($node->link_to_original_url == 'yes' ? TRUE : FALSE) : TRUE;
}

/**
 * Implementation of hook_load().
 */

function category_aggregator_item_load($node)
{
	return db_fetch_object(db_query('SELECT * FROM {category_aggregator_item} WHERE nid = %d', $node->nid));
}

/**
 * Implementation of hook_insert().
 */

function category_aggregator_item_insert($node)
{
	db_query("INSERT INTO {category_aggregator_item} (nid, url, link_to_original_url, original_author, ".
		"story_guid, fid, image_id, image_guid) VALUES (%d, '%s', '%s', '%s', %s, %d, ".
		"%d, %s)", $node->nid, $node->url, $node->link_to_original_url, $node->original_author, $node->story_guid, $node->fid, $node->image_id, $node->image_guid ? $node->image_guid : 0);
}

/**
 * Implementation of hook_update().
 */

function category_aggregator_item_update($node)
{
	if ($node->story_guid === '')
		db_query("UPDATE {category_aggregator_item} SET url = '%s', original_author = '%s', ".
			"fid = %d, image_id = %d, image_guid = %s, link_to_original_url = '%s' ".
			"WHERE nid = %d", $node->url, $node->original_author, $node->fid, $node->image_id,
			$node->image_guid ? $node->image_guid : 0, $node->link_to_original_url, $node->nid);
	else
		db_query("UPDATE {category_aggregator_item} SET url = '%s', original_author = '%s', ".
			"story_guid = %s, fid = %d, image_id = %d, image_guid = %s, link_to_original_url = '%s' ".
			"WHERE nid = %d", $node->url, $node->original_author, $node->story_guid, $node->fid,
			$node->image_id, $node->image_guid ? $node->image_guid : 0, $node->link_to_original_url, $node->nid);
}

/**
 * Implementation of hook_delete().
 */

function category_aggregator_item_delete(&$node)
{
	if (db_fetch_object(db_query(
		"SELECT count(nid) AS image_count FROM {category_aggregator_item} WHERE image_id = %d", $node->image_id))
		->image_count == 1) node_delete($node->image_id);

	db_query("UPDATE {category_aggregator_feed} SET etag = '', last_modified = 0 WHERE nid = %d", $node->fid);

	db_query('DELETE FROM {category_aggregator_item} WHERE nid = %d', $node->nid);
}

/**
 * This function is the implementation of hook_view
 */

function category_aggregator_item_view(&$node, $teaser = FALSE, $page = FALSE)
{
	if (!$teaser)
	{
		if ($node->image_id > 0)
		{
			$image = node_load($node->image_id);
			$node->image = $image;

			// theme image
			$image_render = theme('category_aggregator_image_render', $image);
		}
		else
		{
			$node->image_nid = NULL;
			$node->image = NULL;

			$image_render = '';
		}

		// theme body
		$body_render = theme('category_aggregator_body_render', $node->body);

		// theme the final item
		$node->content['body']['#value'] = theme('category_aggregator_item_render', $image_render, $body_render);

		return $node;
	}

	return node_prepare($node, $teaser);
}

/**
 * Implementation of hook_link
 *
 */
function category_aggregator_link($type, $node = NULL, $teaser = FALSE)
{
	$links = array();
	if (!$teaser && $type == 'node' && $node->type == 'category_aggregator_item')
		if ($node->link_to_original_url == 'yes' && valid_url($node->url, TRUE))
			$links[] = array(
				'href' => $node->url,
				'title' => t('Original article'),
				'attributes' => array('class' => 'category_aggregator-link')
			);

	return $links;
}

function theme_category_aggregator_item_render($image_render, $body_render)
{
	return "<div class=\"category_aggregator_item\">{$image_render}{$body_render}</div>";
}

function theme_category_aggregator_body_render($body)
{
	return '<div class="category_aggregator_item_body">'.$body.'</div>';
}

function theme_category_aggregator_image_render($image)
{
	return '<div class="category_aggregator_item_image">'.'<img src="'.base_path().file_directory_path().'/'.$image->images[variable_get('category_aggregator_image_to_display', 'preview')].'" />'.
		'</div>';
}

/* Following are the module's private methods */

/**
 * This function returns the feed items for a particular feed
 */

function _category_aggregator_get_feed_items($fid)
{
	return db_query("SELECT n.nid FROM {node} n, {category_aggregator_item} ai WHERE n.nid = ai.nid AND ai.fid = %d", $fid);
}

/**
 * This method retrieved the etag and last_modified tags
 */

function read_etag_and_modified($ch, $header)
{
   global $etag;
   global $last_modified;

   $length = strlen($header);
   if(strstr($header, "Last-Modified:"))
   {
       $last_modified = strtotime(substr($header, 15));
   }
   if (strstr($header, "ETag:"))
   {
   		$etag = substr($header, 6);
   }
   return $length;
}

/**
 * This function returns the data in a URL (XML, image, etc...)
 */
function category_aggregator_get_URL($url, $username = NULL, $password = NULL, $feed = NULL,
	$feed_etag = NULL, $feed_last_modified = NULL)
{
	global $etag;
	global $last_modified;

	if (trim($username) == '') $username = NULL;
	if (trim($password) == '') $password = NULL;

	$headers = array();

	if (!is_null($feed_etag) && $feed_etag != '')
		$headers['If-None-Match'] = $feed_etag;

	if (!is_null($feed_last_modified) && $feed_last_modified != 0)
		$headers['If-Modified-Since'] = gmdate('D, d M Y H:i:s', $feed_last_modified) .' GMT';

	if(count($headers) > 0)
	{
		$temp = array();

		foreach ($headers as $header => $value)
			$temp[] = $header .': '. $value;

		$headers = $temp;
	}

	$ch = curl_init();

	$is_ftp = FALSE;

	if (stripos($url, 'ftp://') !== FALSE)
		$is_ftp = TRUE;

	if (!$is_ftp)
		curl_setopt($ch, CURLOPT_USERAGENT, "Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1; SV1; .NET CLR 1.1.4322)");

	if (is_array($headers) && count($headers) > 0 && !$is_ftp)
		curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

	if (!$is_ftp)
		curl_setopt($ch, CURLOPT_HEADERFUNCTION, 'read_etag_and_modified');

	if (!$is_ftp)
	{
		curl_setopt($ch, CURLOPT_FOLLOWLOCATION, 1);
		curl_setopt($ch, CURLOPT_MAXREDIRS, 5);
	}

	if (!is_null($username) && !is_null($password))
	{
		curl_setopt($ch, CURLOPT_USERPWD, "$username:$password");
		if (!$is_ftp)
			curl_setopt($ch, CURLOPT_HTTPAUTH, CURLAUTH_ANY);
	}
	curl_setopt($ch, CURLOPT_URL, $url);
	curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
	if ($is_ftp)
		curl_setopt($ch, CURLOPT_FTP_USE_EPSV, FALSE);
	curl_setopt($ch, CURLOPT_TIMEOUT, 15);
	$data = curl_exec($ch);

	$return_code = curl_getinfo($ch);
	$return_code = $return_code['http_code'];

	$error = curl_error($ch);

	curl_close($ch);
	unset($ch);

	if ($return_code != 304)
	{
		// It was an FTP request but failed
		if ($is_ftp && $return_code != 226)
		{
			$fragment = '';

			if (!is_null($feed))
				$fragment = " while processing feed \"$feed->title\"";

			throw new Exception("FTP request returned error code \"$return_code\"".
				"$fragment on \"$url\"", FTP_REQUEST_FAILED);
		}

		// It was an HTTP request but failed
		if (!$is_ftp && $return_code != 200)
		{
			$fragment = '';

			if (!is_null($feed))
				$fragment = " while processing feed \"$feed->title\"";

			throw new Exception("HTTP request returned error code \"$return_code\"".
				"$fragment on \"$url\"", HTTP_REQUEST_FAILED);
		}
	}
	else
		return FALSE;

	if (!is_null($feed_etag) && !is_null($feed_last_modified))
		return array($data, $etag, $last_modified);

	return $data;
}

/**
 * This function returns the simpleXML object of a given string, or throws an exception
 * if the string is in an invalid XML format
 */
function category_aggregator_get_XML($string, $feed = NULL)
{
	// PHP versions earlier than 5.1 have different argument counts for simplexml_load_string,
	// this condition was added to check against this case

	if (!defined('LIBXML_VERSION') || (version_compare(phpversion(), '5.1.0', '<')))
		@ $xml = simplexml_load_string($string, NULL);
	else
		@ $xml = simplexml_load_string($string, NULL, LIBXML_NOERROR | LIBXML_NOWARNING);

	// We got a malformed XML
	if ($xml === FALSE)
	{
		$fragment = '';

		if (!is_null($feed))
			$fragment = " while processing feed \"$feed->title\"";