class FeedsNodeProcessor in Feeds 6
Same name and namespace in other branches
- 7.2 plugins/FeedsNodeProcessor.inc \FeedsNodeProcessor
- 7 plugins/FeedsNodeProcessor.inc \FeedsNodeProcessor
Creates nodes from feed items.
Hierarchy
- class \FeedsConfigurable
- class \FeedsPlugin implements FeedsSourceInterface
- class \FeedsProcessor
- class \FeedsNodeProcessor
- class \FeedsProcessor
- class \FeedsPlugin implements FeedsSourceInterface
Expanded class hierarchy of FeedsNodeProcessor
15 string references to 'FeedsNodeProcessor'
- FeedsImporter::configDefaults in includes/
FeedsImporter.inc - Return defaults for feed configuration.
- FeedsMapperContentTaxonomyTestCase::test in tests/
feeds_mapper_content_taxonomy.test - Basic test loading a single entry CSV file.
- FeedsMapperContentTestCase::test in tests/
feeds_mapper_content.test - Basic test loading a doulbe entry CSV file.
- FeedsMapperDateTestCase::test in tests/
feeds_mapper_date.test - Basic test loading a single entry CSV file.
- FeedsMapperEmailTestCase::test in tests/
feeds_mapper_email.test - Basic test loading a doulbe entry CSV file.
File
- plugins/
FeedsNodeProcessor.inc, line 20 - Class definition of FeedsNodeProcessor.
View source
class FeedsNodeProcessor extends FeedsProcessor {
/**
* Implementation of FeedsProcessor::process().
*/
public function process(FeedsImportBatch $batch, FeedsSource $source) {
// Keep track of processed items in this pass, set total number of items.
$processed = 0;
$batch_size = variable_get('feeds_node_batch_size', FEEDS_NODE_BATCH_SIZE);
if (!$batch
->getTotal(FEEDS_PROCESSING)) {
$batch
->setTotal(FEEDS_PROCESSING, count($batch->items));
}
while ($item = $batch
->shiftItem()) {
// Create/update if item does not exist or update existing is enabled.
if (!($nid = $this
->existingItemId($batch, $source)) || $this->config['update_existing'] != FEEDS_SKIP_EXISTING) {
// Only proceed if item has actually changed.
$hash = $this
->hash($item);
if (!empty($nid) && $hash == $this
->getHash($nid)) {
continue;
}
$node = $this
->buildNode($nid, $source->feed_nid);
$node->feeds_node_item->hash = $hash;
// Map and save node. If errors occur don't stop but report them.
try {
$this
->map($batch, $node);
if ($this->config['authorize']) {
if (empty($node->nid)) {
$op = 'create';
}
else {
$op = 'update';
}
$account = user_load($node->uid);
if (!node_access($op, $node, $account)) {
throw new Exception('User ' . $account->uid . ' not authorized to ' . $op . ' content type ' . $node->type);
}
}
node_save($node);
if (!empty($nid)) {
$batch->updated++;
}
else {
$batch->created++;
}
} catch (Exception $e) {
drupal_set_message($e
->getMessage(), 'warning');
watchdog('feeds', $e
->getMessage(), array(), WATCHDOG_WARNING);
}
}
$processed++;
if ($processed >= $batch_size) {
$total = $batch
->getTotal(FEEDS_PROCESSING);
$batch
->setProgress(FEEDS_PROCESSING, $total - count($batch->items));
return;
}
}
// Set messages.
if ($batch->created) {
drupal_set_message(format_plural($batch->created, 'Created @number @type node.', 'Created @number @type nodes.', array(
'@number' => $batch->created,
'@type' => node_get_types('name', $this->config['content_type']),
)));
}
if ($batch->updated) {
drupal_set_message(format_plural($batch->updated, 'Updated @number @type node.', 'Updated @number @type nodes.', array(
'@number' => $batch->updated,
'@type' => node_get_types('name', $this->config['content_type']),
)));
}
if (!$batch->created && !$batch->updated) {
drupal_set_message(t('There is no new content.'));
}
$batch
->setProgress(FEEDS_PROCESSING, FEEDS_BATCH_COMPLETE);
}
/**
* Implementation of FeedsProcessor::clear().
*/
public function clear(FeedsBatch $batch, FeedsSource $source) {
if (!$batch
->getTotal(FEEDS_CLEARING)) {
$total = db_result(db_query("SELECT COUNT(nid) FROM {feeds_node_item} WHERE id = '%s' AND feed_nid = %d", $source->id, $source->feed_nid));
$batch
->setTotal(FEEDS_CLEARING, $total);
}
$result = db_query_range("SELECT nid FROM {feeds_node_item} WHERE id = '%s' AND feed_nid = %d", $source->id, $source->feed_nid, 0, variable_get('feeds_node_batch_size', FEEDS_NODE_BATCH_SIZE));
while ($node = db_fetch_object($result)) {
_feeds_node_delete($node->nid);
$batch->deleted++;
}
if (db_result(db_query_range("SELECT nid FROM {feeds_node_item} WHERE id = '%s' AND feed_nid = %d", $source->id, $source->feed_nid, 0, 1))) {
$batch
->setProgress(FEEDS_CLEARING, $batch->deleted);
return;
}
// Set message.
drupal_get_messages('status');
if ($batch->deleted) {
drupal_set_message(format_plural($batch->deleted, 'Deleted @number node.', 'Deleted @number nodes.', array(
'@number' => $batch->deleted,
)));
}
else {
drupal_set_message(t('There is no content to be deleted.'));
}
$batch
->setProgress(FEEDS_CLEARING, FEEDS_BATCH_COMPLETE);
}
/**
* Implement expire().
*/
public function expire($time = NULL) {
if ($time === NULL) {
$time = $this
->expiryTime();
}
if ($time == FEEDS_EXPIRE_NEVER) {
return;
}
$result = db_query_range("SELECT n.nid FROM {node} n JOIN {feeds_node_item} fni ON n.nid = fni.nid WHERE fni.id = '%s' AND n.created < %d", $this->id, FEEDS_REQUEST_TIME - $time, 0, variable_get('feeds_node_batch_size', FEEDS_NODE_BATCH_SIZE));
while ($node = db_fetch_object($result)) {
_feeds_node_delete($node->nid);
}
if (db_result(db_query_range("SELECT n.nid FROM {node} n JOIN {feeds_node_item} fni ON n.nid = fni.nid WHERE fni.id = '%s' AND n.created < %d", $this->id, FEEDS_REQUEST_TIME - $time, 0, 1))) {
return FEEDS_BATCH_ACTIVE;
}
return FEEDS_BATCH_COMPLETE;
}
/**
* Return expiry time.
*/
public function expiryTime() {
return $this->config['expire'];
}
/**
* Override parent::configDefaults().
*/
public function configDefaults() {
$types = node_get_types('names');
$type = isset($types['story']) ? 'story' : key($types);
return array(
'content_type' => $type,
'input_format' => FILTER_FORMAT_DEFAULT,
'update_existing' => FEEDS_SKIP_EXISTING,
'expire' => FEEDS_EXPIRE_NEVER,
'mappings' => array(),
'author' => 0,
'authorize' => 0,
'skip_hash_check' => FALSE,
);
}
/**
* Override parent::configForm().
*/
public function configForm(&$form_state) {
$types = node_get_types('names');
$form = array();
$form['content_type'] = array(
'#type' => 'select',
'#title' => t('Content type'),
'#description' => t('Select the content type for the nodes to be created. <strong>Note:</strong> Users with "import !feed_id feeds" permissions will be able to <strong>import</strong> nodes of the content type selected here regardless of the node level permissions. Further, users with "clear !feed_id permissions" will be able to <strong>delete</strong> imported nodes regardless of their node level permissions.', array(
'!feed_id' => $this->id,
)),
'#options' => $types,
'#default_value' => $this->config['content_type'],
);
$format_options = array(
FILTER_FORMAT_DEFAULT => t('Default format'),
);
$formats = filter_formats();
foreach ($formats as $format) {
$format_options[$format->format] = $format->name;
}
$form['input_format'] = array(
'#type' => 'select',
'#title' => t('Input format'),
'#description' => t('Select the input format for the body field of the nodes to be created.'),
'#options' => $format_options,
'#default_value' => $this->config['input_format'],
);
$author = user_load(array(
'uid' => $this->config['author'],
));
$form['author'] = array(
'#type' => 'textfield',
'#title' => t('Author'),
'#description' => t('Select the author of the nodes to be created - leave empty to assign "anonymous".'),
'#autocomplete_path' => 'user/autocomplete',
'#default_value' => empty($author->name) ? 'anonymous' : check_plain($author->name),
);
$form['authorize'] = array(
'#type' => 'checkbox',
'#title' => t('Authorize'),
'#description' => t('Check that the author has permission to create the node.'),
'#default_value' => $this->config['authorize'],
);
$period = drupal_map_assoc(array(
FEEDS_EXPIRE_NEVER,
3600,
10800,
21600,
43200,
86400,
259200,
604800,
604800 * 4,
604800 * 12,
604800 * 24,
31536000,
), 'feeds_format_expire');
$form['expire'] = array(
'#type' => 'select',
'#title' => t('Expire nodes'),
'#options' => $period,
'#description' => t('Select after how much time nodes should be deleted. The node\'s published date will be used for determining the node\'s age, see Mapping settings.'),
'#default_value' => $this->config['expire'],
);
$form['update_existing'] = array(
'#type' => 'radios',
'#title' => t('Update existing nodes'),
'#description' => t('Select how existing nodes should be updated. Existing nodes will be determined using mappings that are a "unique target".'),
'#options' => array(
FEEDS_SKIP_EXISTING => 'Do not update existing nodes',
FEEDS_REPLACE_EXISTING => 'Replace existing nodes',
FEEDS_UPDATE_EXISTING => 'Update existing nodes (slower than replacing them)',
),
'#default_value' => $this->config['update_existing'],
);
$form['skip_hash_check'] = array(
'#type' => 'checkbox',
'#title' => t('Skip hash check'),
'#description' => t('Force update of items even if item source data did not change.'),
'#default_value' => $this->config['skip_hash_check'],
);
return $form;
}
/**
* Override parent::configFormValidate().
*/
public function configFormValidate(&$values) {
if ($author = user_load(array(
'name' => $values['author'],
))) {
$values['author'] = $author->uid;
}
else {
$values['author'] = 0;
}
}
/**
* Reschedule if expiry time changes.
*/
public function configFormSubmit(&$values) {
if ($this->config['expire'] != $values['expire']) {
feeds_reschedule($this->id);
}
parent::configFormSubmit($values);
}
/**
* Override setTargetElement to operate on a target item that is a node.
*/
public function setTargetElement(&$target_node, $target_element, $value) {
switch ($target_element) {
case 'url':
case 'guid':
$target_node->feeds_node_item->{$target_element} = $value;
break;
case 'body':
$target_node->teaser = node_teaser($value);
$target_node->body = $value;
break;
case 'title':
case 'status':
case 'created':
case 'nid':
case 'uid':
$target_node->{$target_element} = $value;
break;
case 'user_name':
if ($user = user_load(array(
'name' => $value,
))) {
$target_node->uid = $user->uid;
}
break;
case 'user_mail':
if ($user = user_load(array(
'mail' => $value,
))) {
$target_node->uid = $user->uid;
}
break;
}
}
/**
* Return available mapping targets.
*/
public function getMappingTargets() {
$targets = array(
'title' => array(
'name' => t('Title'),
'description' => t('The title of the node.'),
),
);
// Include body field only if available.
$type = node_get_types('type', $this->config['content_type']);
if ($type->has_body) {
// Using 'teaser' instead of 'body' forces entire content above the break.
$targets['body'] = array(
'name' => t('Body'),
'description' => t('The body of the node. The teaser will be the same as the entire body.'),
);
}
$targets += array(
'nid' => array(
'name' => t('Node ID'),
'description' => t('The nid of the node. NOTE: use this feature with care, node ids are usually assigned by Drupal.'),
'optional_unique' => TRUE,
),
'uid' => array(
'name' => t('User ID'),
'description' => t('The Drupal user ID of the node author.'),
),
'user_name' => array(
'name' => t('Username'),
'description' => t('The Drupal username of the node author.'),
),
'user_mail' => array(
'name' => t('User email'),
'description' => t('The email address of the node author.'),
),
'status' => array(
'name' => t('Published status'),
'description' => t('Whether a node is published or not. 1 stands for published, 0 for not published.'),
),
'created' => array(
'name' => t('Published date'),
'description' => t('The UNIX time when a node has been published.'),
),
'url' => array(
'name' => t('URL'),
'description' => t('The external URL of the node. E. g. the feed item URL in the case of a syndication feed. May be unique.'),
'optional_unique' => TRUE,
),
'guid' => array(
'name' => t('GUID'),
'description' => t('The external GUID of the node. E. g. the feed item GUID in the case of a syndication feed. May be unique.'),
'optional_unique' => TRUE,
),
);
// Let other modules expose mapping targets.
self::loadMappers();
drupal_alter('feeds_node_processor_targets', $targets, $this->config['content_type']);
return $targets;
}
/**
* Get nid of an existing feed item node if available.
*/
protected function existingItemId(FeedsImportBatch $batch, FeedsSource $source) {
// Iterate through all unique targets and test whether they do already
// exist in the database.
foreach ($this
->uniqueTargets($batch) as $target => $value) {
switch ($target) {
case 'nid':
$nid = db_result(db_query("SELECT nid FROM {node} WHERE nid = %d", $value));
break;
case 'url':
$nid = db_result(db_query("SELECT nid FROM {feeds_node_item} WHERE feed_nid = %d AND id = '%s' AND url = '%s'", $source->feed_nid, $source->id, $value));
break;
case 'guid':
$nid = db_result(db_query("SELECT nid FROM {feeds_node_item} WHERE feed_nid = %d AND id = '%s' AND guid = '%s'", $source->feed_nid, $source->id, $value));
break;
}
if ($nid) {
// Return with the first nid found.
return $nid;
}
}
return 0;
}
/**
* Creates a new node object in memory and returns it.
*/
protected function buildNode($nid, $feed_nid) {
$populate = FALSE;
if (empty($nid)) {
$node = new stdClass();
$node->created = FEEDS_REQUEST_TIME;
$populate = TRUE;
}
else {
if ($this->config['update_existing'] == FEEDS_UPDATE_EXISTING) {
$node = node_load($nid, NULL, TRUE);
}
else {
$node = db_fetch_object(db_query("SELECT created, nid, vid, status FROM {node} WHERE nid = %d", $nid));
$populate = TRUE;
}
}
if ($populate) {
$node->type = $this->config['content_type'];
$node->changed = FEEDS_REQUEST_TIME;
$node->format = $this->config['input_format'];
$node->feeds_node_item = new stdClass();
$node->feeds_node_item->id = $this->id;
$node->feeds_node_item->imported = FEEDS_REQUEST_TIME;
$node->feeds_node_item->feed_nid = $feed_nid;
$node->feeds_node_item->url = '';
$node->feeds_node_item->guid = '';
}
static $included;
if (!$included) {
module_load_include('inc', 'node', 'node.pages');
$included = TRUE;
}
node_object_prepare($node);
// Populate properties that are set by node_object_prepare().
$node->log = 'Created/updated by FeedsNodeProcessor';
if ($populate) {
$node->uid = $this->config['author'];
}
return $node;
}
/**
* Create MD5 hash of item and mappings array.
*
* Include mappings as a change in mappings may have an affect on the item
* produced.
*
* @return Always returns a hash, even with empty, NULL, FALSE:
* Empty arrays return 40cd750bba9870f18aada2478b24840a
* Empty/NULL/FALSE strings return d41d8cd98f00b204e9800998ecf8427e
*/
protected function hash($item) {
static $serialized_mappings;
if (!$serialized_mappings) {
$serialized_mappings = serialize($this->config['mappings']);
}
return hash('md5', serialize($item) . $serialized_mappings);
}
/**
* Retrieves the MD5 hash of $entity_id from the database.
*
* When "skip hash check" is set to TRUE, returns dummy md5.
*
* @return string
* Empty string if no item is found, hash otherwise.
*/
protected function getHash($nid) {
if ($this->config['skip_hash_check']) {
return '00000000000000000000000000000000';
}
$hash = db_result(db_query("SELECT hash FROM {feeds_node_item} WHERE nid = %d", $nid));
if ($hash) {
// Return with the hash.
return $hash;
}
return '';
}
}Members
Name |
Modifiers | Type | Description | Overrides |
|---|---|---|---|---|
|
FeedsConfigurable:: |
protected | property | ||
|
FeedsConfigurable:: |
protected | property | CTools export enabled status of this object. | |
|
FeedsConfigurable:: |
protected | property | ||
|
FeedsConfigurable:: |
protected | property | ||
|
FeedsConfigurable:: |
public | function | Similar to setConfig but adds to existing configuration. | 1 |
|
FeedsConfigurable:: |
public | function | Copy a configuration. | 1 |
|
FeedsConfigurable:: |
public | function | Determine whether this object is persistent and enabled. I. e. it is defined either in code or in the database and it is enabled. | 1 |
|
FeedsConfigurable:: |
public | function | Implementation of getConfig(). | 1 |
|
FeedsConfigurable:: |
public static | function | Instantiate a FeedsConfigurable object. | 1 |
|
FeedsConfigurable:: |
public | function | Set configuration. | 1 |
|
FeedsConfigurable:: |
public | function | Override magic method __get(). Make sure that $this->config goes through getConfig() | |
|
FeedsConfigurable:: |
public | function | Override magic method __isset(). This is needed due to overriding __get(). | |
|
FeedsNodeProcessor:: |
protected | function | Creates a new node object in memory and returns it. | |
|
FeedsNodeProcessor:: |
public | function |
Implementation of FeedsProcessor::clear(). Overrides FeedsProcessor:: |
|
|
FeedsNodeProcessor:: |
public | function |
Override parent::configDefaults(). Overrides FeedsProcessor:: |
|
|
FeedsNodeProcessor:: |
public | function |
Override parent::configForm(). Overrides FeedsConfigurable:: |
|
|
FeedsNodeProcessor:: |
public | function |
Reschedule if expiry time changes. Overrides FeedsConfigurable:: |
|
|
FeedsNodeProcessor:: |
public | function |
Override parent::configFormValidate(). Overrides FeedsConfigurable:: |
|
|
FeedsNodeProcessor:: |
protected | function |
Get nid of an existing feed item node if available. Overrides FeedsProcessor:: |
|
|
FeedsNodeProcessor:: |
public | function |
Implement expire(). Overrides FeedsProcessor:: |
|
|
FeedsNodeProcessor:: |
public | function |
Return expiry time. Overrides FeedsProcessor:: |
|
|
FeedsNodeProcessor:: |
protected | function | Retrieves the MD5 hash of $entity_id from the database. | |
|
FeedsNodeProcessor:: |
public | function |
Return available mapping targets. Overrides FeedsProcessor:: |
|
|
FeedsNodeProcessor:: |
protected | function | Create MD5 hash of item and mappings array. | |
|
FeedsNodeProcessor:: |
public | function |
Implementation of FeedsProcessor::process(). Overrides FeedsProcessor:: |
|
|
FeedsNodeProcessor:: |
public | function |
Override setTargetElement to operate on a target item that is a node. Overrides FeedsProcessor:: |
|
|
FeedsPlugin:: |
public | function |
Returns TRUE if $this->sourceForm() returns a form. Overrides FeedsSourceInterface:: |
|
|
FeedsPlugin:: |
protected static | function | Loads on-behalf implementations from mappers/ directory. | |
|
FeedsPlugin:: |
public | function |
Save changes to the configuration of this object.
Delegate saving to parent (= Feed) which will collect
information from this object by way of getConfig() and store it. Overrides FeedsConfigurable:: |
|
|
FeedsPlugin:: |
public | function |
Implementation of FeedsSourceInterface::sourceDefaults(). Overrides FeedsSourceInterface:: |
1 |
|
FeedsPlugin:: |
public | function |
A source is being deleted. Overrides FeedsSourceInterface:: |
1 |
|
FeedsPlugin:: |
public | function |
Callback methods, exposes source form. Overrides FeedsSourceInterface:: |
3 |
|
FeedsPlugin:: |
public | function |
Validation handler for sourceForm. Overrides FeedsSourceInterface:: |
2 |
|
FeedsPlugin:: |
public | function |
A source is being saved. Overrides FeedsSourceInterface:: |
1 |
|
FeedsPlugin:: |
protected | function |
Constructor. Overrides FeedsConfigurable:: |
|
|
FeedsProcessor:: |
public | function | Get mappings. | |
|
FeedsProcessor:: |
protected | function | Execute mapping on an item. | 3 |
|
FeedsProcessor:: |
protected | function | Utility function that iterates over a target array and retrieves all sources that are unique. |