/drupal7/sites/all/modules/feeds/plugins/FeedsProcessor.inc - Diff - Club Drupal - Forge Centrale Marseille

Révision a192dc0b

Ajouté par Assos Assos il y a environ 8 ans

ID a192dc0b6c0f545f539466f4862088c78cf9a61a
Parent 4f315dab
Enfant 134c7813

Weekly update of contrib modules

      * Contains FeedsProcessor and related classes.
      */
     // Insert mode for new items.
     define('FEEDS_SKIP_NEW', 0);
     define('FEEDS_INSERT_NEW', 1);
     // Update mode for existing items.
     define('FEEDS_SKIP_EXISTING', 0);
     define('FEEDS_REPLACE_EXISTING', 1);
-...
       /**
        * Create a new entity.
+       *
        * @param $source
        * @param FeedsSource $source
        *   The feeds source that spawns this entity.
+       *
        * @return
        * @return object
        *   A new entity object.
        */
       protected abstract function newEntity(FeedsSource $source);
       protected function newEntity(FeedsSource $source) {
         $entity = new stdClass();
         $info = $this->entityInfo();
         if (!empty($info['entity keys']['language'])) {
           $entity->{$info['entity keys']['language']} = $this->entityLanguage();
+        }
         return $entity;
+      }
       /**
        * Load an existing entity.
-...
        *   existing ids first.
        */
       protected function entityLoad(FeedsSource $source, $entity_id) {
         $info = $this->entityInfo();
         if ($this->config['update_existing'] == FEEDS_UPDATE_EXISTING) {
           $entities = entity_load($this->entityType(), array($entity_id));
           return reset($entities);
           $entity = reset($entities);
+        }
         else {
           $args = array(':entity_id' => $entity_id);
           $table = db_escape_table($info['base table']);
           $key = db_escape_field($info['entity keys']['id']);
           $entity = db_query("SELECT * FROM {" . $table . "} WHERE $key = :entity_id", $args)->fetchObject();
+        }
         $info = $this->entityInfo();
         $args = array(':entity_id' => $entity_id);
         $table = db_escape_table($info['base table']);
         $key = db_escape_field($info['entity keys']['id']);
         if ($entity && !empty($info['entity keys']['language'])) {
           $entity->{$info['entity keys']['language']} = $this->entityLanguage();
+        }
         return db_query("SELECT * FROM {" . $table . "} WHERE $key = :entity_id", $args)->fetchObject();
         return $entity;
+      }
       /**
        * Validate an entity.
        * Validates an entity.
+       *
        * @throws FeedsValidationException $e
        *   If validation fails.
        *   Thrown if validation fails.
        */
       protected function entityValidate($entity) {}
       protected function entityValidate($entity) {
         $info = $this->entityInfo();
         if (empty($info['entity keys']['language'])) {
           return;
+        }
         // Ensure that a valid language is always set.
         $key = $info['entity keys']['language'];
         $languages = language_list('enabled');
         if (empty($entity->$key) || !isset($languages[1][$entity->$key])) {
           $entity->$key = $this->entityLanguage();
+        }
+      }
       /**
        * Access check for saving an enity.
-...
        * 'label plural' ... the plural label of an entity type.
        */
       protected function entityInfo() {
         return entity_get_info($this->entityType());
         $info = entity_get_info($this->entityType());
         // Entity module has defined the plural label in "plural label" instead of
         // "label plural". So if "plural label" is defined, this will have priority
         // over "label plural".
         if (isset($info['plural label'])) {
           $info['label plural'] = $info['plural label'];
+        }
         return $info;
+      }
       /**
        * Returns the current language for entities.
+       *
        * This checks if the configuration value is valid.
+       *
        * @return string
        *   The current language code.
        */
       protected function entityLanguage() {
         if (!module_exists('locale')) {
           // language_list() may return languages even if the locale module is
           // disabled. See https://www.drupal.org/node/173227 why.
           // When the locale module is disabled, there are no selectable languages
           // in the UI, so the content should be imported in LANGUAGE_NONE.
           return LANGUAGE_NONE;
+        }
         $languages = language_list('enabled');
         return isset($languages[1][$this->config['language']]) ? $this->config['language'] : LANGUAGE_NONE;
+      }
       /**
-...
           $this->initEntitiesToBeRemoved($source, $state);
+        }
         $skip_new = $this->config['insert_new'] == FEEDS_SKIP_NEW;
         $skip_existing = $this->config['update_existing'] == FEEDS_SKIP_EXISTING;
         while ($item = $parser_result->shiftItem()) {
           // Check if this item already exists.
-...
           if ($entity_id) {
             unset($state->removeList[$entity_id]);
+          }
           $skip_existing = $this->config['update_existing'] == FEEDS_SKIP_EXISTING;
           module_invoke_all('feeds_before_update', $source, $item, $entity_id);
           // If it exists, and we are not updating, pass onto the next item.
           if ($entity_id && $skip_existing) {
           // If it exists, and we are not updating, or if it does not exist, and we
           // are not inserting, pass onto the next item.
           if (($entity_id && $skip_existing) || (!$entity_id && $skip_new)) {
             continue;
+          }
           try {
             $hash = $this->hash($item);
             $changed = ($hash !== $this->getHash($entity_id));
             $force_update = $this->config['skip_hash_check'];
             $changed = $hash !== $this->getHash($entity_id);
             // Do not proceed if the item exists, has not changed, and we're not
             // forcing the update.
             if ($entity_id && !$changed && !$force_update) {
             if ($entity_id && !$changed && !$this->config['skip_hash_check']) {
               continue;
+            }
-...
+      }
       /**
        * Initialize the array of entities to remove with all existing entities
        * previously imported from the source.
        * Initializes the list of entities to remove.
+       *
        * This populates $state->removeList with all existing entities previously
        * imported from the source.
+       *
        * @param FeedsSource $source
        *   Source information about this import.
-...
        */
       protected function initEntitiesToBeRemoved(FeedsSource $source, FeedsState $state) {
         $state->removeList = array();
         // We fill it only if needed.
         if (!isset($this->config['update_non_existent']) || $this->config['update_non_existent'] == FEEDS_SKIP_NON_EXISTENT) {
         if ($this->config['update_non_existent'] == FEEDS_SKIP_NON_EXISTENT) {
           return;
+        }
         // Build base select statement.
         $info = $this->entityInfo();
         $id_key = db_escape_field($info['entity keys']['id']);
         $select = db_select($info['base table'], 'e');
         $select->addField('e', $info['entity keys']['id'], 'entity_id');
         $select->join(
           'feeds_item',
           'fi',
           'e.' . $id_key . ' = fi.entity_id AND fi.entity_type = :entity_type', array(
             ':entity_type' => $this->entityType(),
         ));
         $select->condition('fi.id', $this->id);
         $select->condition('fi.feed_nid', $source->feed_nid);
         // No need to remove item again if same method of removal was already used.
         $select->condition('fi.hash', $this->config['update_non_existent'], '<>');
         $entities = $select->execute();
         // If not found on process, existing entities will be deleted.
         foreach ($entities as $entity) {
           // Obviously, items which are still included in the source feed will be
           // removed from this array when processed.
           $state->removeList[$entity->entity_id] = $entity->entity_id;
         // Get the full list of entities for this source.
         $entity_ids = db_select('feeds_item')
           ->fields('feeds_item', array('entity_id'))
           ->condition('entity_type', $this->entityType())
           ->condition('id', $this->id)
           ->condition('feed_nid', $source->feed_nid)
           ->condition('hash', $this->config['update_non_existent'], '<>')
           ->execute()
           ->fetchCol();
         if (!$entity_ids) {
           return;
+        }
         $state->removeList = array_combine($entity_ids, $entity_ids);
+      }
       /**
-...
        */
       protected function clean(FeedsState $state) {
         // We clean only if needed.
         if (!isset($this->config['update_non_existent']) || $this->config['update_non_existent'] == FEEDS_SKIP_NON_EXISTENT) {
         if ($this->config['update_non_existent'] == FEEDS_SKIP_NON_EXISTENT) {
           return;
+        }
         $total = count($state->removeList);
         if ($total) {
         if ($total = count($state->removeList)) {
           $this->entityDeleteMultiple($state->removeList);
           $state->deleted += $total;
+        }
-...
         $state = $source->state(FEEDS_PROCESS_CLEAR);
         // Build base select statement.
         $info = $this->entityInfo();
         $select = db_select($info['base table'], 'e');
         $select->addField('e', $info['entity keys']['id'], 'entity_id');
         $select->join(
           'feeds_item',
           'fi',
           "e.{$info['entity keys']['id']} = fi.entity_id AND fi.entity_type = '{$this->entityType()}'");
         $select->condition('fi.id', $this->id);
         $select->condition('fi.feed_nid', $source->feed_nid);
         $select = db_select('feeds_item')
           ->fields('feeds_item', array('entity_id'))
           ->condition('entity_type', $this->entityType())
           ->condition('id', $this->id)
           ->condition('feed_nid', $source->feed_nid);
         // If there is no total, query it.
         if (!$state->total) {
           $state->total = $select->countQuery()
             ->execute()
             ->fetchField();
           $state->total = $select->countQuery()->execute()->fetchField();
+        }
         // Delete a batch of entities.
         $entities = $select->range(0, $this->getLimit())->execute();
         $entity_ids = array();
         foreach ($entities as $entity) {
           $entity_ids[$entity->entity_id] = $entity->entity_id;
+        }
         $entity_ids = $select->range(0, $this->getLimit())->execute()->fetchCol();
         $this->entityDeleteMultiple($entity_ids);
         // Report progress, take into account that we may not have deleted as
         // many items as we have counted at first.
         if (count($entity_ids)) {
           $state->deleted += count($entity_ids);
         // Report progress, take into account that we may not have deleted as many
         // items as we have counted at first.
         if ($deleted_count = count($entity_ids)) {
           $state->deleted += $deleted_count;
           $state->progress($state->total, $state->deleted);
+        }
         else {
-...
         // Report results when done.
         if ($source->progressClearing() == FEEDS_BATCH_COMPLETE) {
           $info = $this->entityInfo();
           if ($state->deleted) {
             $message = format_plural(
               $state->deleted,
-...
       protected function expiryQuery(FeedsSource $source, $time) {
         // Build base select statement.
         $info = $this->entityInfo();
         $id_key = db_escape_field($info['entity keys']['id']);
         $id_key = $info['entity keys']['id'];
         $select = db_select($info['base table'], 'e');
         $select->addField('e', $info['entity keys']['id'], 'entity_id');
         $select->join(
           'feeds_item',
           'fi',
           "e.$id_key = fi.entity_id AND fi.entity_type = :entity_type", array(
             ':entity_type' => $this->entityType(),
         ));
         $select->addField('e', $id_key);
         $select->join('feeds_item', 'fi', "e.$id_key = fi.entity_id");
         $select->condition('fi.entity_type', $this->entityType());
         $select->condition('fi.id', $this->id);
         $select->condition('fi.feed_nid', $source->feed_nid);
-...
        */
       protected function map(FeedsSource $source, FeedsParserResult $result, $target_item = NULL) {
         $targets = $this->getCachedTargets();
         // Get fields for the entity type we are mapping to.
         $fields = field_info_instances($this->entityType(), $this->bundle());
         if (empty($target_item)) {
           $target_item = array();
-...
         // Many mappers add to existing fields rather than replacing them. Hence we
         // need to clear target elements of each item before mapping in case we are
         // mapping on a prepopulated item such as an existing node.
         foreach ($this->config['mappings'] as $mapping) {
         foreach ($this->getMappings() as $mapping) {
           if (isset($targets[$mapping['target']]['real_target'])) {
             $target_item->{$targets[$mapping['target']]['real_target']} = NULL;
             $target_name = $targets[$mapping['target']]['real_target'];
+          }
           else {
             $target_name = $mapping['target'];
+          }
           // If the target is a field empty the value for the targeted language
           // only.
           // In all other cases, just empty the target completely.
           if (isset($fields[$target_name])) {
             // Empty the target for the specified language.
             $target_item->{$target_name}[$mapping['language']] = array();
+          }
           else {
             $target_item->{$mapping['target']} = NULL;
             // Empty the whole target.
             $target_item->{$target_name} = NULL;
+          }
+        }
-...
         // the parser's getSourceElement() method to retrieve the value of the
         // source element and pass it to the processor's setTargetElement() to stick
         // it on the right place of the target item.
         foreach ($this->config['mappings'] as $mapping) {
         foreach ($this->getMappings() as $mapping) {
           $value = $this->getSourceValue($source, $result, $mapping['source']);
           $this->mapToTarget($source, $mapping['target'], $target_item, $value, $mapping);
-...
       protected function mapToTarget(FeedsSource $source, $target, &$target_item, $value, array $mapping) {
         $targets = $this->getCachedTargets();
         if (isset($targets[$target]['preprocess_callbacks'])) {
           foreach ($targets[$target]['preprocess_callbacks'] as $callback) {
             call_user_func_array($callback, array($source, $target_item, $target, &$mapping));
+          }
+        }
         // Map the source element's value to the target.
         // If the mapping specifies a callback method, use the callback instead of
         // setTargetElement().
-...
+        }
         return array(
           'mappings' => array(),
           'insert_new' => FEEDS_INSERT_NEW,
           'update_existing' => FEEDS_SKIP_EXISTING,
           'update_non_existent' => FEEDS_SKIP_NON_EXISTENT,
           'input_format' => NULL,
           'skip_hash_check' => FALSE,
           'bundle' => $bundle,
           'language' => LANGUAGE_NONE,
         );
+      }
-...
           );
+        }
         if (module_exists('locale') && !empty($info['entity keys']['language'])) {
           $form['language'] = array(
             '#type' => 'select',
             '#options' => array(LANGUAGE_NONE => t('Language neutral')) + locale_language_list('name'),
             '#title' => t('Language'),
             '#required' => TRUE,
             '#default_value' => $this->config['language'],
           );
+        }
         $tokens = array('@entities' => strtolower($info['label plural']));
         $form['insert_new'] = array(
           '#type' => 'radios',
           '#title' => t('Insert new @entities', $tokens),
           '#description' => t('New @entities will be determined using mappings that are a "unique target".', $tokens),
           '#options' => array(
             FEEDS_INSERT_NEW => t('Insert new @entities', $tokens),
             FEEDS_SKIP_NEW => t('Do not insert new @entities', $tokens),
           ),
           '#default_value' => $this->config['insert_new'],
         );
         $form['update_existing'] = array(
           '#type' => 'radios',
           '#title' => t('Update existing @entities', $tokens),
-...
        * Get mappings.
        */
       public function getMappings() {
         return isset($this->config['mappings']) ? $this->config['mappings'] : array();
         $cache = &drupal_static('FeedsProcessor::getMappings', array());
         if (!isset($cache[$this->id])) {
           $mappings = $this->config['mappings'];
           $targets = $this->getCachedTargets();
           $languages = language_list('enabled');
           foreach ($mappings as &$mapping) {
             if (isset($targets[$mapping['target']]['preprocess_callbacks'])) {
               foreach ($targets[$mapping['target']]['preprocess_callbacks'] as $callback) {
                 call_user_func_array($callback, array($targets[$mapping['target']], &$mapping));
+              }
+            }
             // Ensure there's always a language set.
             if (empty($mapping['language'])) {
               $mapping['language'] = LANGUAGE_NONE;
+            }
             else {
               // Check if the configured language is available. If not, fallback to
               // LANGUAGE_NONE.
               if (!isset($languages[1][$mapping['language']])) {
                 $mapping['language'] = LANGUAGE_NONE;
+              }
+            }
+          }
           $cache[$this->id] = $mappings;
+        }
         return $cache[$this->id];
+      }
       /**
-...
       protected function uniqueTargets(FeedsSource $source, FeedsParserResult $result) {
         $parser = feeds_importer($this->id)->parser;
         $targets = array();
         foreach ($this->config['mappings'] as $mapping) {
         foreach ($this->getMappings() as $mapping) {
           if (!empty($mapping['unique'])) {
             // Invoke the parser's getSourceElement to retrieve the value for this
             // mapping's source.
-...
        * Include mappings as a change in mappings may have an affect on the item
        * produced.
+       *
        * @return Always returns a hash, even with empty, NULL, FALSE:
        *  Empty arrays return 40cd750bba9870f18aada2478b24840a
        *  Empty/NULL/FALSE strings return d41d8cd98f00b204e9800998ecf8427e
        * @return string
        *   A hash is always returned, even when the item is empty, NULL or FALSE.
        */
       protected function hash($item) {
         return hash('md5', serialize($item) . serialize($this->config['mappings']));
         $sources = feeds_importer($this->id)->parser->getMappingSourceList();
         $mapped_item = array_intersect_key($item, array_flip($sources));
         return hash('md5', serialize($mapped_item) . serialize($this->getMappings()));
+      }
       /**
-...
+      }
       /**
        * Creates a log entry for when an exception occured during import.
        * Creates a log entry for when an exception occurred during import.
+       *
        * @param Exception $e
        *   The exception that was throwned during processing the item.

Formats disponibles : Unified diff

Projet

Général

Profil

Club Drupal

Révision a192dc0b

Ajouté par Assos Assos il y a environ 8 ans