drupalISMI: relation_processor/FeedsProcessor.inc annotate

annotate relation_processor/FeedsProcessor.inc @ 38:9ab136f412a1

new first version of check_ismi_log analyser.

author	casties
date	Fri, 21 Oct 2016 19:20:17 +0200
parents	1c73c660c2f2
children

rev	line source
0 124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	1 <?php
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	2
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	3 /**
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	4 * @file
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	5 * Contains FeedsProcessor and related classes.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	6 */
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	7
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	8 // Update mode for existing items.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	9 define('FEEDS_SKIP_EXISTING', 0);
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	10 define('FEEDS_REPLACE_EXISTING', 1);
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	11 define('FEEDS_UPDATE_EXISTING', 2);
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	12
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	13 // Default limit for creating items on a page load, not respected by all
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	14 // processors.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	15 define('FEEDS_PROCESS_LIMIT', 50);
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	16
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	17 /**
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	18 * Thrown if a validation fails.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	19 */
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	20 class FeedsValidationException extends Exception {}
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	21
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	22 /**
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	23 * Thrown if a an access check fails.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	24 */
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	25 class FeedsAccessException extends Exception {}
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	26
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	27 /**
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	28 * Abstract class, defines interface for processors.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	29 */
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	30 abstract class FeedsProcessor extends FeedsPlugin {
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	31
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	32 /**
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	33 * Implements FeedsPlugin::pluginType().
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	34 */
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	35 public function pluginType() {
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	36 return 'processor';
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	37 }
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	38
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	39 /**
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	40 * @defgroup entity_api_wrapper Entity API wrapper.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	41 */
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	42
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	43 /**
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	44 * Entity type this processor operates on.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	45 */
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	46 public abstract function entityType();
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	47
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	48 /**
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	49 * Bundle type this processor operates on.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	50 *
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	51 * Defaults to the entity type for entities that do not define bundles.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	52 *
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	53 * @return string\|NULL
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	54 * The bundle type this processor operates on, or NULL if it is undefined.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	55 */
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	56 public function bundle() {
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	57 return $this->config['bundle'];
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	58 }
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	59
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	60 /**
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	61 * Provides a list of bundle options for use in select lists.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	62 *
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	63 * @return array
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	64 * A keyed array of bundle => label.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	65 */
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	66 public function bundleOptions() {
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	67 $options = array();
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	68 foreach (field_info_bundles($this->entityType()) as $bundle => $info) {
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	69 if (!empty($info['label'])) {
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	70 $options[$bundle] = $info['label'];
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	71 }
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	72 else {
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	73 $options[$bundle] = $bundle;
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	74 }
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	75 }
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	76 return $options;
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	77 }
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	78
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	79 /**
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	80 * Create a new entity.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	81 *
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	82 * @param $source
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	83 * The feeds source that spawns this entity.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	84 *
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	85 * @return
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	86 * A new entity object.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	87 */
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	88 protected abstract function newEntity(FeedsSource $source);
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	89
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	90 /**
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	91 * Load an existing entity.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	92 *
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	93 * @param $source
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	94 * The feeds source that spawns this entity.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	95 * @param $entity_id
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	96 * The unique id of the entity that should be loaded.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	97 *
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	98 * @return
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	99 * A new entity object.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	100 *
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	101 * @todo We should be able to batch load these, if we found all of the
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	102 * existing ids first.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	103 */
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	104 protected function entityLoad(FeedsSource $source, $entity_id) {
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	105 if ($this->config['update_existing'] == FEEDS_UPDATE_EXISTING) {
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	106 $entities = entity_load($this->entityType(), array($entity_id));
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	107 return reset($entities);
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	108 }
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	109
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	110 $info = $this->entityInfo();
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	111
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	112 $args = array(':entity_id' => $entity_id);
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	113
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	114 $table = db_escape_table($info['base table']);
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	115 $key = db_escape_field($info['entity keys']['id']);
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	116
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	117 return db_query("SELECT * FROM {" . $table . "} WHERE $key = :entity_id", $args)->fetchObject();
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	118 }
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	119
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	120 /**
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	121 * Validate an entity.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	122 *
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	123 * @throws FeedsValidationException $e
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	124 * If validation fails.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	125 */
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	126 protected function entityValidate($entity) {}
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	127
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	128 /**
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	129 * Access check for saving an enity.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	130 *
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	131 * @param $entity
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	132 * Entity to be saved.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	133 *
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	134 * @throws FeedsAccessException $e
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	135 * If the access check fails.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	136 */
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	137 protected function entitySaveAccess($entity) {}
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	138
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	139 /**
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	140 * Save an entity.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	141 *
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	142 * @param $entity
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	143 * Entity to be saved.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	144 */
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	145 protected abstract function entitySave($entity);
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	146
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	147 /**
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	148 * Delete a series of entities.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	149 *
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	150 * @param $entity_ids
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	151 * Array of unique identity ids to be deleted.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	152 */
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	153 protected abstract function entityDeleteMultiple($entity_ids);
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	154
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	155 /**
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	156 * Wrap entity_get_info() into a method so that extending classes can override
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	157 * it and more entity information. Allowed additional keys:
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	158 *
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	159 * 'label plural' ... the plural label of an entity type.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	160 */
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	161 protected function entityInfo() {
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	162 return entity_get_info($this->entityType());
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	163 }
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	164
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	165 /**
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	166 * @}
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	167 */
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	168
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	169 /**
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	170 * Process the result of the parsing stage.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	171 *
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	172 * @param FeedsSource $source
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	173 * Source information about this import.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	174 * @param FeedsParserResult $parser_result
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	175 * The result of the parsing stage.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	176 */
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	177 public function process(FeedsSource $source, FeedsParserResult $parser_result) {
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	178 $state = $source->state(FEEDS_PROCESS);
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	179
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	180 while ($item = $parser_result->shiftItem()) {
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	181
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	182 // Check if this item already exists.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	183 $entity_id = $this->existingEntityId($source, $parser_result);
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	184 $skip_existing = $this->config['update_existing'] == FEEDS_SKIP_EXISTING;
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	185
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	186 module_invoke_all('feeds_before_update', $source, $item, $entity_id);
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	187
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	188 // If it exists, and we are not updating, pass onto the next item.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	189 if ($entity_id && $skip_existing) {
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	190 continue;
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	191 }
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	192
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	193 $hash = $this->hash($item);
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	194 $changed = ($hash !== $this->getHash($entity_id));
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	195 $force_update = $this->config['skip_hash_check'];
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	196
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	197 // Do not proceed if the item exists, has not changed, and we're not
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	198 // forcing the update.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	199 if ($entity_id && !$changed && !$force_update) {
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	200 continue;
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	201 }
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	202
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	203 try {
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	204
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	205 // Load an existing entity.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	206 if ($entity_id) {
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	207 $entity = $this->entityLoad($source, $entity_id);
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	208
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	209 // The feeds_item table is always updated with the info for the most
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	210 // recently processed entity. The only carryover is the entity_id.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	211 $this->newItemInfo($entity, $source->feed_nid, $hash);
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	212 $entity->feeds_item->entity_id = $entity_id;
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	213 $entity->feeds_item->is_new = FALSE;
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	214 }
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	215
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	216 // Build a new entity.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	217 else {
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	218
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	219 $entity = $this->newEntity($source);
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	220 $this->newItemInfo($entity, $source->feed_nid, $hash);
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	221 }
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	222
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	223 // Set property and field values.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	224 $this->map($source, $parser_result, $entity);
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	225 $this->entityValidate($entity);
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	226
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	227 // Allow modules to alter the entity before saving.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	228 module_invoke_all('feeds_presave', $source, $entity, $item, $entity_id);
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	229 if (module_exists('rules')) {
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	230 rules_invoke_event('feeds_import_'. $source->importer()->id, $entity);
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	231 }
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	232
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	233 // Enable modules to skip saving at all.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	234 if (!empty($entity->feeds_item->skip)) {
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	235 continue;
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	236 }
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	237
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	238 // This will throw an exception on failure.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	239 $this->entitySaveAccess($entity);
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	240 $this->entitySave($entity);
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	241
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	242 // Allow modules to perform operations using the saved entity data.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	243 // $entity contains the updated entity after saving.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	244 module_invoke_all('feeds_after_save', $source, $entity, $item, $entity_id);
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	245
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	246 // Track progress.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	247 if (empty($entity_id)) {
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	248 $state->created++;
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	249 }
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	250 else {
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	251 $state->updated++;
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	252 }
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	253 }
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	254
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	255 // Something bad happened, log it.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	256 catch (Exception $e) {
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	257 $state->failed++;
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	258 drupal_set_message($e->getMessage(), 'warning');
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	259 $message = $this->createLogMessage($e, $entity, $item);
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	260 $source->log('import', $message, array(), WATCHDOG_ERROR);
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	261 }
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	262 }
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	263
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	264 // Set messages if we're done.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	265 if ($source->progressImporting() != FEEDS_BATCH_COMPLETE) {
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	266 return;
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	267 }
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	268 $info = $this->entityInfo();
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	269 $tokens = array(
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	270 '@entity' => strtolower($info['label']),
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	271 '@entities' => strtolower($info['label plural']),
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	272 );
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	273 $messages = array();
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	274 if ($state->created) {
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	275 $messages[] = array(
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	276 'message' => format_plural(
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	277 $state->created,
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	278 'Created @number @entity.',
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	279 'Created @number @entities.',
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	280 array('@number' => $state->created) + $tokens
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	281 ),
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	282 );
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	283 }
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	284 if ($state->updated) {
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	285 $messages[] = array(
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	286 'message' => format_plural(
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	287 $state->updated,
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	288 'Updated @number @entity.',
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	289 'Updated @number @entities.',
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	290 array('@number' => $state->updated) + $tokens
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	291 ),
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	292 );
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	293 }
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	294 if ($state->failed) {
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	295 $messages[] = array(
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	296 'message' => format_plural(
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	297 $state->failed,
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	298 'Failed importing @number @entity.',
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	299 'Failed importing @number @entities.',
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	300 array('@number' => $state->failed) + $tokens
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	301 ),
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	302 'level' => WATCHDOG_ERROR,
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	303 );
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	304 }
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	305 if (empty($messages)) {
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	306 $messages[] = array(
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	307 'message' => t('There are no new @entities.', array('@entities' => strtolower($info['label plural']))),
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	308 );
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	309 }
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	310 foreach ($messages as $message) {
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	311 drupal_set_message($message['message']);
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	312 $source->log('import', $message['message'], array(), isset($message['level']) ? $message['level'] : WATCHDOG_INFO);
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	313 }
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	314 }
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	315
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	316 /**
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	317 * Remove all stored results or stored results up to a certain time for a
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	318 * source.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	319 *
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	320 * @param FeedsSource $source
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	321 * Source information for this expiry. Implementers should only delete items
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	322 * pertaining to this source. The preferred way of determining whether an
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	323 * item pertains to a certain souce is by using $source->feed_nid. It is the
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	324 * processor's responsibility to store the feed_nid of an imported item in
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	325 * the processing stage.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	326 */
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	327 public function clear(FeedsSource $source) {
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	328 $state = $source->state(FEEDS_PROCESS_CLEAR);
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	329
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	330 // Build base select statement.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	331 $info = $this->entityInfo();
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	332 $select = db_select($info['base table'], 'e');
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	333 $select->addField('e', $info['entity keys']['id'], 'entity_id');
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	334 $select->join(
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	335 'feeds_item',
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	336 'fi',
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	337 "e.{$info['entity keys']['id']} = fi.entity_id AND fi.entity_type = '{$this->entityType()}'");
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	338 $select->condition('fi.id', $this->id);
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	339 $select->condition('fi.feed_nid', $source->feed_nid);
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	340
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	341 // If there is no total, query it.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	342 if (!$state->total) {
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	343 $state->total = $select->countQuery()
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	344 ->execute()
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	345 ->fetchField();
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	346 }
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	347
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	348 // Delete a batch of entities.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	349 $entities = $select->range(0, $this->getLimit())->execute();
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	350 $entity_ids = array();
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	351 foreach ($entities as $entity) {
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	352 $entity_ids[$entity->entity_id] = $entity->entity_id;
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	353 }
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	354 $this->entityDeleteMultiple($entity_ids);
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	355
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	356 // Report progress, take into account that we may not have deleted as
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	357 // many items as we have counted at first.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	358 if (count($entity_ids)) {
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	359 $state->deleted += count($entity_ids);
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	360 $state->progress($state->total, $state->deleted);
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	361 }
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	362 else {
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	363 $state->progress($state->total, $state->total);
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	364 }
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	365
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	366 // Report results when done.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	367 if ($source->progressClearing() == FEEDS_BATCH_COMPLETE) {
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	368 if ($state->deleted) {
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	369 $message = format_plural(
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	370 $state->deleted,
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	371 'Deleted @number @entity',
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	372 'Deleted @number @entities',
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	373 array(
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	374 '@number' => $state->deleted,
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	375 '@entity' => strtolower($info['label']),
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	376 '@entities' => strtolower($info['label plural']),
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	377 )
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	378 );
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	379 $source->log('clear', $message, array(), WATCHDOG_INFO);
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	380 drupal_set_message($message);
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	381 }
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	382 else {
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	383 drupal_set_message(t('There are no @entities to be deleted.', array('@entities' => $info['label plural'])));
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	384 }
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	385 }
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	386 }
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	387
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	388 /*
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	389 * Report number of items that can be processed per call.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	390 *
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	391 * 0 means 'unlimited'.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	392 *
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	393 * If a number other than 0 is given, Feeds parsers that support batching
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	394 * will only deliver this limit to the processor.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	395 *
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	396 * @see FeedsSource::getLimit()
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	397 * @see FeedsCSVParser::parse()
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	398 */
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	399 public function getLimit() {
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	400 return variable_get('feeds_process_limit', FEEDS_PROCESS_LIMIT);
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	401 }
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	402
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	403 /**
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	404 * Delete feed items younger than now - $time. Do not invoke expire on a
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	405 * processor directly, but use FeedsImporter::expire() instead.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	406 *
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	407 * @see FeedsImporter::expire().
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	408 * @see FeedsDataProcessor::expire().
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	409 *
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	410 * @param $time
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	411 * If implemented, all items produced by this configuration that are older
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	412 * than REQUEST_TIME - $time should be deleted.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	413 * If $time === NULL processor should use internal configuration.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	414 *
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	415 * @return
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	416 * FEEDS_BATCH_COMPLETE if all items have been processed, a float between 0
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	417 * and 0.99* indicating progress otherwise.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	418 */
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	419 public function expire($time = NULL) {
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	420 return FEEDS_BATCH_COMPLETE;
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	421 }
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	422
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	423 /**
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	424 * Counts the number of items imported by this processor.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	425 */
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	426 public function itemCount(FeedsSource $source) {
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	427 return db_query("SELECT count(*) FROM {feeds_item} WHERE id = :id AND entity_type = :entity_type AND feed_nid = :feed_nid", array(':id' => $this->id, ':entity_type' => $this->entityType(), ':feed_nid' => $source->feed_nid))->fetchField();
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	428 }
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	429
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	430 /**
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	431 * Execute mapping on an item.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	432 *
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	433 * This method encapsulates the central mapping functionality. When an item is
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	434 * processed, it is passed through map() where the properties of $source_item
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	435 * are mapped onto $target_item following the processor's mapping
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	436 * configuration.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	437 *
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	438 * For each mapping FeedsParser::getSourceElement() is executed to retrieve
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	439 * the source element, then FeedsProcessor::setTargetElement() is invoked
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	440 * to populate the target item properly. Alternatively a
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	441 * hook_x_targets_alter() may have specified a callback for a mapping target
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	442 * in which case the callback is asked to populate the target item instead of
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	443 * FeedsProcessor::setTargetElement().
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	444 *
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	445 * @ingroup mappingapi
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	446 *
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	447 * @see hook_feeds_parser_sources_alter()
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	448 * @see hook_feeds_data_processor_targets_alter()
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	449 * @see hook_feeds_node_processor_targets_alter()
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	450 * @see hook_feeds_term_processor_targets_alter()
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	451 * @see hook_feeds_user_processor_targets_alter()
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	452 */
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	453 protected function map(FeedsSource $source, FeedsParserResult $result, $target_item = NULL) {
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	454
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	455 // Static cache $targets as getMappingTargets() may be an expensive method.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	456 static $sources;
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	457 if (!isset($sources[$this->id])) {
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	458 $sources[$this->id] = feeds_importer($this->id)->parser->getMappingSources();
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	459 }
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	460 static $targets;
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	461 if (!isset($targets[$this->id])) {
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	462 $targets[$this->id] = $this->getMappingTargets();
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	463 }
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	464 $parser = feeds_importer($this->id)->parser;
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	465 if (empty($target_item)) {
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	466 $target_item = array();
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	467 }
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	468
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	469 // Many mappers add to existing fields rather than replacing them. Hence we
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	470 // need to clear target elements of each item before mapping in case we are
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	471 // mapping on a prepopulated item such as an existing node.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	472 foreach ($this->config['mappings'] as $mapping) {
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	473 if (isset($targets[$this->id][$mapping['target']]['real_target'])) {
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	474 unset($target_item->{$targets[$this->id][$mapping['target']]['real_target']});
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	475 }
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	476 elseif (isset($target_item->{$mapping['target']})) {
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	477 unset($target_item->{$mapping['target']});
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	478 }
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	479 }
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	480
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	481 /*
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	482 This is where the actual mapping happens: For every mapping we envoke
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	483 the parser's getSourceElement() method to retrieve the value of the source
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	484 element and pass it to the processor's setTargetElement() to stick it
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	485 on the right place of the target item.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	486
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	487 If the mapping specifies a callback method, use the callback instead of
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	488 setTargetElement().
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	489 */
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	490 self::loadMappers();
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	491 foreach ($this->config['mappings'] as $mapping) {
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	492 // Retrieve source element's value from parser.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	493 if (isset($sources[$this->id][$mapping['source']]) &&
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	494 is_array($sources[$this->id][$mapping['source']]) &&
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	495 isset($sources[$this->id][$mapping['source']]['callback']) &&
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	496 function_exists($sources[$this->id][$mapping['source']]['callback'])) {
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	497 $callback = $sources[$this->id][$mapping['source']]['callback'];
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	498 $value = $callback($source, $result, $mapping['source']);
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	499 }
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	500 else {
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	501 $value = $parser->getSourceElement($source, $result, $mapping['source']);
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	502 }
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	503
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	504 // Map the source element's value to the target.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	505 if (isset($targets[$this->id][$mapping['target']]) &&
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	506 is_array($targets[$this->id][$mapping['target']]) &&
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	507 isset($targets[$this->id][$mapping['target']]['callback']) &&
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	508 function_exists($targets[$this->id][$mapping['target']]['callback'])) {
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	509 $callback = $targets[$this->id][$mapping['target']]['callback'];
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	510 $callback($source, $target_item, $mapping['target'], $value, $mapping);
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	511 }
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	512 else {
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	513 $this->setTargetElement($source, $target_item, $mapping['target'], $value, $mapping);
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	514 }
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	515 }
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	516 return $target_item;
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	517 }
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	518
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	519 /**
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	520 * Per default, don't support expiry. If processor supports expiry of imported
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	521 * items, return the time after which items should be removed.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	522 */
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	523 public function expiryTime() {
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	524 return FEEDS_EXPIRE_NEVER;
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	525 }
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	526
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	527 /**
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	528 * Declare default configuration.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	529 */
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	530 public function configDefaults() {
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	531 $info = $this->entityInfo();
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	532 $bundle = NULL;
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	533 if (empty($info['entity keys']['bundle'])) {
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	534 $bundle = $this->entityType();
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	535 }
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	536 return array(
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	537 'mappings' => array(),
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	538 'update_existing' => FEEDS_SKIP_EXISTING,
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	539 'input_format' => NULL,
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	540 'skip_hash_check' => FALSE,
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	541 'bundle' => $bundle,
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	542 );
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	543 }
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	544
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	545 /**
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	546 * Overrides parent::configForm().
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	547 */
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	548 public function configForm(&$form_state) {
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	549 $info = $this->entityInfo();
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	550 $form = array();
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	551
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	552 if (!empty($info['entity keys']['bundle'])) {
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	553 $form['bundle'] = array(
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	554 '#type' => 'select',
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	555 '#options' => $this->bundleOptions(),
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	556 '#title' => !empty($info['bundle name']) ? $info['bundle name'] : t('Bundle'),
5 1c73c660c2f2 new relation_processor Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: 0 diff changeset	557 '#required' => false,
1c73c660c2f2 new relation_processor Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: 0 diff changeset	558 '#description' => t('if not set, relation_name has to be one of the mappings'),
1c73c660c2f2 new relation_processor Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: 0 diff changeset	559 '#default_value' => "generic",
0 124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	560 );
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	561 }
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	562 else {
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	563 $form['bundle'] = array(
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	564 '#type' => 'value',
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	565 '#value' => $this->entityType(),
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	566 );
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	567 }
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	568
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	569 $tokens = array('@entities' => strtolower($info['label plural']));
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	570
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	571 $form['update_existing'] = array(
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	572 '#type' => 'radios',
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	573 '#title' => t('Update existing @entities', $tokens),
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	574 '#description' =>
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	575 t('Existing @entities will be determined using mappings that are a "unique target".', $tokens),
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	576 '#options' => array(
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	577 FEEDS_SKIP_EXISTING => t('Do not update existing @entities', $tokens),
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	578 FEEDS_REPLACE_EXISTING => t('Replace existing @entities', $tokens),
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	579 FEEDS_UPDATE_EXISTING => t('Update existing @entities', $tokens),
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	580 ),
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	581 '#default_value' => $this->config['update_existing'],
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	582 );
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	583 global $user;
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	584 $formats = filter_formats($user);
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	585 foreach ($formats as $format) {
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	586 $format_options[$format->format] = $format->name;
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	587 }
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	588 $form['skip_hash_check'] = array(
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	589 '#type' => 'checkbox',
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	590 '#title' => t('Skip hash check'),
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	591 '#description' => t('Force update of items even if item source data did not change.'),
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	592 '#default_value' => $this->config['skip_hash_check'],
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	593 );
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	594 $form['input_format'] = array(
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	595 '#type' => 'select',
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	596 '#title' => t('Text format'),
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	597 '#description' => t('Select the input format for the body field of the nodes to be created.'),
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	598 '#options' => $format_options,
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	599 '#default_value' => isset($this->config['input_format']) ? $this->config['input_format'] : 'plain_text',
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	600 '#required' => TRUE,
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	601 );
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	602
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	603 return $form;
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	604 }
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	605
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	606 /**
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	607 * Get mappings.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	608 */
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	609 public function getMappings() {
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	610 return isset($this->config['mappings']) ? $this->config['mappings'] : array();
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	611 }
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	612
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	613 /**
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	614 * Declare possible mapping targets that this processor exposes.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	615 *
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	616 * @ingroup mappingapi
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	617 *
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	618 * @return
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	619 * An array of mapping targets. Keys are paths to targets
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	620 * separated by ->, values are TRUE if target can be unique,
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	621 * FALSE otherwise.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	622 */
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	623 public function getMappingTargets() {
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	624
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	625 // The bundle has not been selected.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	626 if (!$this->bundle()) {
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	627 $info = $this->entityInfo();
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	628 $bundle_name = !empty($info['bundle name']) ? drupal_strtolower($info['bundle name']) : t('bundle');
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	629 $plugin_key = feeds_importer($this->id)->config['processor']['plugin_key'];
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	630 $url = url('admin/structure/feeds/' . $this->id . '/settings/' . $plugin_key);
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	631 drupal_set_message(t('Please <a href="@url">select a @bundle_name</a>.', array('@url' => $url, '@bundle_name' => $bundle_name)), 'warning', FALSE);
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	632 }
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	633
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	634 return array(
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	635 'url' => array(
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	636 'name' => t('URL'),
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	637 'description' => t('The external URL of the item. E. g. the feed item URL in the case of a syndication feed. May be unique.'),
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	638 'optional_unique' => TRUE,
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	639 ),
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	640 'guid' => array(
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	641 'name' => t('GUID'),
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	642 'description' => t('The globally unique identifier of the item. E. g. the feed item GUID in the case of a syndication feed. May be unique.'),
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	643 'optional_unique' => TRUE,
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	644 ),
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	645 );
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	646 }
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	647
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	648 /**
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	649 * Set a concrete target element. Invoked from FeedsProcessor::map().
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	650 *
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	651 * @ingroup mappingapi
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	652 */
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	653 public function setTargetElement(FeedsSource $source, $target_item, $target_element, $value) {
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	654 switch ($target_element) {
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	655 case 'url':
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	656 case 'guid':
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	657 $target_item->feeds_item->$target_element = $value;
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	658 break;
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	659 default:
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	660 $target_item->$target_element = $value;
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	661 break;
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	662 }
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	663 }
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	664
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	665 /**
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	666 * Retrieve the target entity's existing id if available. Otherwise return 0.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	667 *
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	668 * @ingroup mappingapi
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	669 *
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	670 * @param FeedsSource $source
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	671 * The source information about this import.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	672 * @param $result
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	673 * A FeedsParserResult object.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	674 *
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	675 * @return
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	676 * The serial id of an entity if found, 0 otherwise.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	677 */
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	678 protected function existingEntityId(FeedsSource $source, FeedsParserResult $result) {
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	679 $query = db_select('feeds_item')
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	680 ->fields('feeds_item', array('entity_id'))
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	681 ->condition('feed_nid', $source->feed_nid)
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	682 ->condition('entity_type', $this->entityType())
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	683 ->condition('id', $source->id);
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	684
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	685 // Iterate through all unique targets and test whether they do already
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	686 // exist in the database.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	687 foreach ($this->uniqueTargets($source, $result) as $target => $value) {
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	688 switch ($target) {
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	689 case 'url':
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	690 $entity_id = $query->condition('url', $value)->execute()->fetchField();
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	691 break;
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	692 case 'guid':
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	693 $entity_id = $query->condition('guid', $value)->execute()->fetchField();
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	694 break;
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	695 }
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	696 if (isset($entity_id)) {
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	697 // Return with the content id found.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	698 return $entity_id;
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	699 }
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	700 }
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	701 return 0;
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	702 }
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	703
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	704
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	705 /**
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	706 * Utility function that iterates over a target array and retrieves all
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	707 * sources that are unique.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	708 *
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	709 * @param $batch
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	710 * A FeedsImportBatch.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	711 *
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	712 * @return
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	713 * An array where the keys are target field names and the values are the
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	714 * elements from the source item mapped to these targets.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	715 */
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	716 protected function uniqueTargets(FeedsSource $source, FeedsParserResult $result) {
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	717 $parser = feeds_importer($this->id)->parser;
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	718 $targets = array();
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	719 foreach ($this->config['mappings'] as $mapping) {
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	720 if (!empty($mapping['unique'])) {
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	721 // Invoke the parser's getSourceElement to retrieve the value for this
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	722 // mapping's source.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	723 $targets[$mapping['target']] = $parser->getSourceElement($source, $result, $mapping['source']);
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	724 }
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	725 }
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	726 return $targets;
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	727 }
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	728
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	729 /**
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	730 * Adds Feeds specific information on $entity->feeds_item.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	731 *
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	732 * @param $entity
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	733 * The entity object to be populated with new item info.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	734 * @param $feed_nid
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	735 * The feed nid of the source that produces this entity.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	736 * @param $hash
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	737 * The fingerprint of the source item.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	738 */
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	739 protected function newItemInfo($entity, $feed_nid, $hash = '') {
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	740 $entity->feeds_item = new stdClass();
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	741 $entity->feeds_item->is_new = TRUE;
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	742 $entity->feeds_item->entity_id = 0;
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	743 $entity->feeds_item->entity_type = $this->entityType();
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	744 $entity->feeds_item->id = $this->id;
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	745 $entity->feeds_item->feed_nid = $feed_nid;
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	746 $entity->feeds_item->imported = REQUEST_TIME;
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	747 $entity->feeds_item->hash = $hash;
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	748 $entity->feeds_item->url = '';
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	749 $entity->feeds_item->guid = '';
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	750 }
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	751
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	752 /**
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	753 * Loads existing entity information and places it on $entity->feeds_item.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	754 *
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	755 * @param $entity
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	756 * The entity object to load item info for. Id key must be present.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	757 *
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	758 * @return
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	759 * TRUE if item info could be loaded, false if not.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	760 */
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	761 protected function loadItemInfo($entity) {
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	762 $entity_info = entity_get_info($this->entityType());
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	763 $key = $entity_info['entity keys']['id'];
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	764 if ($item_info = feeds_item_info_load($this->entityType(), $entity->$key)) {
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	765 $entity->feeds_item = $item_info;
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	766 return TRUE;
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	767 }
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	768 return FALSE;
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	769 }
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	770
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	771 /**
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	772 * Create MD5 hash of item and mappings array.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	773 *
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	774 * Include mappings as a change in mappings may have an affect on the item
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	775 * produced.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	776 *
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	777 * @return Always returns a hash, even with empty, NULL, FALSE:
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	778 * Empty arrays return 40cd750bba9870f18aada2478b24840a
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	779 * Empty/NULL/FALSE strings return d41d8cd98f00b204e9800998ecf8427e
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	780 */
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	781 protected function hash($item) {
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	782 return hash('md5', serialize($item) . serialize($this->config['mappings']));
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	783 }
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	784
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	785 /**
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	786 * Retrieves the MD5 hash of $entity_id from the database.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	787 *
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	788 * @return string
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	789 * Empty string if no item is found, hash otherwise.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	790 */
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	791 protected function getHash($entity_id) {
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	792
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	793 if ($hash = db_query("SELECT hash FROM {feeds_item} WHERE entity_type = :type AND entity_id = :id", array(':type' => $this->entityType(), ':id' => $entity_id))->fetchField()) {
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	794 // Return with the hash.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	795 return $hash;
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	796 }
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	797 return '';
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	798 }
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	799
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	800 /**
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	801 * Creates a log message for when an exception occured during import.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	802 *
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	803 * @param Exception $e
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	804 * The exception that was throwned during processing the item.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	805 * @param $entity
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	806 * The entity object.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	807 * @param $item
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	808 * The parser result for this entity.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	809 *
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	810 * @return string
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	811 * The message to log.
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	812 */
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	813 protected function createLogMessage(Exception $e, $entity, $item) {
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	814 include_once DRUPAL_ROOT . '/includes/utility.inc';
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	815 $message = $e->getMessage();
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	816 $message .= '<h3>Original item</h3>';
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	817 $message .= '<pre>' . drupal_var_export($item). '</pre>';
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	818 $message .= '<h3>Entity</h3>';
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	819 $message .= '<pre>' . drupal_var_export($entity) . '</pre>';
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	820 return $message;
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	821 }
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	822
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	823 }
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	824
124ef8f3b22d initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	825 class FeedsProcessorBundleNotDefined extends Exception {}

Mercurial > hg > drupalISMI

annotate relation_processor/FeedsProcessor.inc @ 38:9ab136f412a1