solrsearch: solrsearch.index.inc

author	Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de>
date	Mon, 08 Jun 2015 10:21:54 +0200
parents
children

rev	line source
0 a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	1 <?php
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	2
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	3 /**
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	4 * @file
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	5 * Functions related to Apache Solr indexing operations.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	6 */
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	7
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	8 /**
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	9 * Processes all index queues associated with the passed environment.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	10 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	11 * An environment usually indexes one or more entity types. Each entity type
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	12 * stores its queue in a database table that is defined in the entity type's
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	13 * info array. This function processes N number of items in each queue table,
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	14 * where N is the limit passed as the second argument.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	15 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	16 * The indexing routine allows developers to selectively bypass indexing on a
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	17 * per-entity basis by implementing the following hooks:
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	18 * - hook_solrsearch_exclude()
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	19 * - hook_solrsearch_ENTITY_TYPE_exclude()
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	20 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	21 * @param string $env_id
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	22 * The machine name of the environment.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	23 * @param int $limit
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	24 * The number of items to process per queue table. For example, if there are
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	25 * two entities that are being indexed in this environment and they each have
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	26 * their own queue table, setting a limit of 50 will send a maximum number of
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	27 * 100 documents to the Apache Solr server.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	28 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	29 * @return int
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	30 * The total number of documents sent to the Apache Solr server for indexing.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	31 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	32 * @see solrsearch_index_get_entities_to_index()
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	33 * @see solrsearch_index_entity_to_documents()
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	34 * @see solrsearch_index_send_to_solr()
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	35 */
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	36 function solrsearch_index_entities($env_id, $limit) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	37 $documents_submitted = 0;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	38 foreach (entity_get_info() as $entity_type => $info) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	39 // With each pass through the callback, retrieve the next group of nids.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	40 $rows = solrsearch_index_get_entities_to_index($env_id, $entity_type, $limit);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	41 $documents = array();
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	42 foreach ($rows as $row) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	43 $row_documents = solrsearch_index_entities_document($row, $entity_type, $env_id);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	44 $documents = array_merge($documents, $row_documents);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	45 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	46
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	47 $indexed = solrsearch_index_send_to_solr($env_id, $documents);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	48 if ($indexed !== FALSE) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	49 $documents_submitted += count($documents);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	50 $index_position = solrsearch_get_last_index_position($env_id, $entity_type);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	51 $max_changed = $index_position['last_changed'];
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	52 $max_entity_id = $index_position['last_entity_id'];
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	53 foreach ($rows as $row) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	54 if (!empty($row->status)) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	55 if ($row->changed > $max_changed) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	56 $max_changed = $row->changed;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	57 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	58 if ($row->entity_id > $max_entity_id) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	59 $max_entity_id = $row->entity_id;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	60 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	61 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	62 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	63 solrsearch_set_last_index_position($env_id, $entity_type, $max_changed, $max_entity_id);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	64 solrsearch_set_last_index_updated($env_id, REQUEST_TIME);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	65 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	66 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	67 return $documents_submitted;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	68 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	69
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	70 /**
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	71 * Convert a certain entity from the solrsearch index table to a set of documents. 1 entity
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	72 * can be converted in multiple documents if the solrsearch_index_entity_to_documents decides to do so.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	73 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	74 * @param array $row
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	75 * A row from the indexing table
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	76 * @param string $entity_type
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	77 * The type of the entity
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	78 * @param string $env_id
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	79 * The machine name of the environment.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	80 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	81 * @return array of solrsearchDocument(s)
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	82 */
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	83 function solrsearch_index_entities_document($row, $entity_type, $env_id) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	84 $documents = array();
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	85 if (!empty($row->status)) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	86 // Let any module exclude this entity from the index.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	87 $build_document = TRUE;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	88 foreach (module_implements('solrsearch_exclude') as $module) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	89 $exclude = module_invoke($module, 'solrsearch_exclude', $row->entity_id, $entity_type, $row, $env_id);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	90 // If the hook returns TRUE we should exclude the entity
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	91 if (!empty($exclude)) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	92 $build_document = FALSE;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	93 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	94 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	95 foreach (module_implements('solrsearch_' . $entity_type . '_exclude') as $module) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	96 $exclude = module_invoke($module, 'solrsearch_' . $entity_type . '_exclude', $row->entity_id, $row, $env_id);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	97 // If the hook returns TRUE we should exclude the entity
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	98 if (!empty($exclude)) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	99 $build_document = FALSE;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	100 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	101 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	102 if ($build_document) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	103 $documents = array_merge($documents, solrsearch_index_entity_to_documents($row, $env_id));
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	104 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	105 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	106 else {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	107 // Delete the entity from our index if the status callback returned 0
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	108 solrsearch_remove_entity($env_id, $row->entity_type, $row->entity_id);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	109 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	110 // Clear entity cache for this specific entity
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	111 entity_get_controller($row->entity_type)->resetCache(array($row->entity_id));
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	112 return $documents;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	113 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	114 /**
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	115 * Returns the total number of documents that are able to be indexed and the
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	116 * number of documents left to be indexed.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	117 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	118 * This is a helper function for modules that implement hook_search_status().
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	119 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	120 * @param string $env_id
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	121 * The machine name of the environment.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	122 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	123 * @return array
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	124 * An associative array with the key-value pairs:
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	125 * - remaining: The number of items left to index.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	126 * - total: The total number of items to index.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	127 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	128 * @see hook_search_status()
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	129 */
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	130 function solrsearch_index_status($env_id) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	131 $remaining = 0;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	132 $total = 0;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	133
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	134 foreach (entity_get_info() as $entity_type => $info) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	135 $bundles = solrsearch_get_index_bundles($env_id, $entity_type);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	136 if (empty($bundles)) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	137 continue;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	138 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	139
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	140 $table = solrsearch_get_indexer_table($entity_type);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	141 $query = db_select($table, 'asn')->condition('asn.status', 1)->condition('asn.bundle', $bundles);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	142 $total += $query->countQuery()->execute()->fetchField();
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	143
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	144 // Get $last_entity_id and $last_changed.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	145 $last_index_position = solrsearch_get_last_index_position($env_id, $entity_type);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	146 $last_entity_id = $last_index_position['last_entity_id'];
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	147 $last_changed = $last_index_position['last_changed'];
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	148
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	149 // Find the remaining entities to index for this entity type.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	150 $query = db_select($table, 'aie')
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	151 ->condition('aie.bundle', $bundles)
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	152 ->condition('aie.status', 1)
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	153 ->condition(db_or()
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	154 ->condition('aie.changed', $last_changed, '>')
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	155 ->condition(db_and()
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	156 ->condition('aie.changed', $last_changed, '<=')
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	157 ->condition('aie.entity_id', $last_entity_id, '>')))
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	158 ->addTag('solrsearch_index_' . $entity_type);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	159
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	160
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	161 if ($table == 'solrsearch_index_entities') {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	162 // Other, entity-specific tables don't need this condition.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	163 $query->condition('aie.entity_type', $entity_type);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	164 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	165 $remaining += $query->countQuery()->execute()->fetchField();
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	166 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	167 return array('remaining' => $remaining, 'total' => $total);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	168 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	169
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	170 /**
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	171 * Worker callback for solrsearch_index_entities().
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	172 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	173 * Loads and proccesses the entity queued for indexing and converts into one or
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	174 * more documents that are sent to the Apache Solr server for indexing.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	175 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	176 * The entity is loaded as the user specified in the "solrsearch_index_user"
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	177 * system variable in order to prevent sentive data from being indexed and
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	178 * displayed to underprivileged users in search results. The index user defaults
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	179 * to a user ID of "0", which is the anonymous user.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	180 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	181 * After the entity is loaded, it is converted to an array via the callback
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	182 * specified in the entity type's info array. The array that the entity is
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	183 * converted to is the model of the document sent to the Apache Solr server for
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	184 * indexing. This function allows develoeprs to modify the document by
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	185 * implementing the following hooks:
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	186 * - solrsearch_index_document_build()
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	187 * - solrsearch_index_document_build_ENTITY_TYPE()
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	188 * - solrsearch_index_documents_alter()
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	189 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	190 * @param stdClass $item
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	191 * The data returned by the queue table containing:
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	192 * - entity_id: An integer containing the unique identifier of the entity, for
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	193 * example a node ID or comment ID.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	194 * - entity_type: The unique identifier for the entity, i.e. "node", "file".
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	195 * - bundle: The machine-readable name of the bundle the passed entity is
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	196 * associated with.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	197 * - status: The "published" status of the entity. The status will also be set
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	198 * to "0" when entity is deleted but the Apache Solr server is unavailable.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	199 * - changed: A timestamp flagging when the entity was last modified.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	200 * @param string $env_id
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	201 * The machine name of the environment.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	202 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	203 * @return array
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	204 * An associative array of documents that are sent to the Apache Solr server
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	205 * for indexing.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	206 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	207 * @see solrsearch_index_nodes() for the old-skool version.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	208 */
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	209 function solrsearch_index_entity_to_documents($item, $env_id) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	210 global $user;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	211 drupal_save_session(FALSE);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	212 $saved_user = $user;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	213 // build the content for the index as an anonymous user to avoid exposing restricted fields and such.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	214 // By setting a variable, indexing can take place as a different user
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	215 $uid = variable_get('solrsearch_index_user', 0);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	216 if ($uid == 0) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	217 $user = drupal_anonymous_user();
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	218 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	219 else {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	220 $user = user_load($uid);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	221 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	222 // Pull out all of our pertinent data.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	223 $entity_type = $item->entity_type;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	224
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	225 // Entity cache will be reset at the end of the indexing algorithm, to use the cache properly whenever
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	226 // the code does another entity_load
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	227 $entity = entity_load($entity_type, array($item->entity_id));
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	228 $entity = $entity ? reset($entity) : FALSE;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	229
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	230 if (empty($entity)) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	231 // If the object failed to load, just stop.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	232 return FALSE;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	233 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	234
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	235 list($entity_id, $vid, $bundle) = entity_extract_ids($entity_type, $entity);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	236
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	237 // Create a new document, and do the bare minimum on it.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	238 $document = _solrsearch_index_process_entity_get_document($entity, $entity_type);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	239
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	240 //Get the callback array to add stuff to the document
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	241 $callbacks = solrsearch_entity_get_callback($entity_type, 'document callback', $bundle);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	242 $documents = array();
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	243 foreach ($callbacks as $callback) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	244 // Call a type-specific callback to add stuff to the document.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	245 $documents = array_merge($documents, $callback($document, $entity, $entity_type, $env_id));
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	246 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	247
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	248 //do this for all possible documents that were returned by the callbacks
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	249 foreach ($documents as $document) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	250 // Call an all-entity hook to add stuff to the document.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	251 module_invoke_all('solrsearch_index_document_build', $document, $entity, $entity_type, $env_id);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	252
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	253 // Call a type-specific hook to add stuff to the document.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	254 module_invoke_all('solrsearch_index_document_build_' . $entity_type, $document, $entity, $env_id);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	255
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	256 // Final processing to ensure that the document is properly structured.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	257 // All records must have a label field, which is used for user-friendly labeling.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	258 if (empty($document->label)) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	259 $document->label = '';
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	260 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	261
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	262 // All records must have a "content" field, which is used for fulltext indexing.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	263 // If we don't have one, enter an empty value. This does mean that the entity
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	264 // will not be fulltext searchable.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	265 if (empty($document->content)) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	266 $document->content = '';
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	267 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	268
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	269 // All records must have a "teaser" field, which is used for abbreviated
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	270 // displays when no highlighted text is available.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	271 if (empty($document->teaser)) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	272 $document->teaser = truncate_utf8($document->content, 300, TRUE);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	273 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	274
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	275 // Add additional indexing based on the body of each record.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	276 solrsearch_index_add_tags_to_document($document, $document->content);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	277 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	278
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	279 // Now allow modules to alter each other's additions for maximum flexibility.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	280
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	281 // Hook to allow modifications of the retrieved results
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	282 foreach (module_implements('solrsearch_index_documents_alter') as $module) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	283 $function = $module . '_solrsearch_index_documents_alter';
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	284 $function($documents, $entity, $entity_type, $env_id);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	285 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	286
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	287 // Restore the user.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	288 $user = $saved_user;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	289 drupal_save_session(TRUE);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	290
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	291 return $documents;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	292 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	293
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	294 /**
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	295 * Index an array of documents to solr.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	296 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	297 * @param $env_id
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	298 * @param array $documents
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	299 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	300 * @return bool\|int number indexed, or FALSE on failure.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	301 * @throws Exception
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	302 */
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	303 function solrsearch_index_send_to_solr($env_id, array $documents) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	304 try {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	305 // Get the $solr object
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	306 $solr = solrsearch_get_solr($env_id);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	307 // If there is no server available, don't continue.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	308 if (!$solr->ping(variable_get('solrsearch_ping_timeout', 4))) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	309 throw new Exception(t('No Solr instance available during indexing.'));
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	310 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	311 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	312 catch (Exception $e) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	313 watchdog('Apache Solr', nl2br(check_plain($e->getMessage())), NULL, WATCHDOG_ERROR);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	314 return FALSE;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	315 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	316 // Do not index when we do not have any documents to send
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	317 // Send TRUE because this is not an error
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	318 if (empty($documents)) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	319 return TRUE;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	320 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	321 // Send the document off to Solr.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	322 watchdog('Apache Solr', 'Adding @count documents.', array('@count' => count($documents)));
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	323 try {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	324 $docs_chunk = array_chunk($documents, 20);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	325 foreach ($docs_chunk as $docs) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	326 $solr->addDocuments($docs);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	327 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	328 watchdog('Apache Solr', 'Indexing succeeded on @count documents', array(
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	329 '@count' => count($documents),
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	330 ), WATCHDOG_INFO);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	331 return count($documents);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	332 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	333 catch (Exception $e) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	334 if (!empty($docs)) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	335 foreach ($docs as $doc) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	336 $eids[] = $doc->entity_type . '/' . $doc->entity_id;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	337 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	338 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	339 watchdog('Apache Solr', 'Indexing failed on one of the following entity ids: @eids <br /> !message', array(
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	340 '@eids' => implode(', ', $eids),
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	341 '!message' => nl2br(strip_tags($e->getMessage())),
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	342 ), WATCHDOG_ERROR);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	343 return FALSE;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	344 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	345 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	346
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	347 /**
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	348 * Extract HTML tag contents from $text and add to boost fields.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	349 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	350 * @param solrsearchDocument $document
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	351 * @param string $text
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	352 * must be stripped of control characters before hand.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	353 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	354 */
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	355 function solrsearch_index_add_tags_to_document(solrsearchDocument $document, $text) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	356 $tags_to_index = variable_get('solrsearch_tags_to_index', array(
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	357 'h1' => 'tags_h1',
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	358 'h2' => 'tags_h2_h3',
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	359 'h3' => 'tags_h2_h3',
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	360 'h4' => 'tags_h4_h5_h6',
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	361 'h5' => 'tags_h4_h5_h6',
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	362 'h6' => 'tags_h4_h5_h6',
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	363 'u' => 'tags_inline',
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	364 'b' => 'tags_inline',
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	365 'i' => 'tags_inline',
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	366 'strong' => 'tags_inline',
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	367 'em' => 'tags_inline',
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	368 'a' => 'tags_a'
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	369 ));
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	370
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	371 // Strip off all ignored tags.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	372 $text = strip_tags($text, '<' . implode('><', array_keys($tags_to_index)) . '>');
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	373
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	374 preg_match_all('@<(' . implode('\|', array_keys($tags_to_index)) . ')[^>]>(.)</\1>@Ui', $text, $matches);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	375 foreach ($matches[1] as $key => $tag) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	376 $tag = drupal_strtolower($tag);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	377 // We don't want to index links auto-generated by the url filter.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	378 if ($tag != 'a' \|\| !preg_match('@(?:http://\|https://\|ftp://\|mailto:\|smb://\|afp://\|file://\|gopher://\|news://\|ssl://\|sslv2://\|sslv3://\|tls://\|tcp://\|udp://\|www\.)[a-zA-Z0-9]+@', $matches[2][$key])) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	379 if (!isset($document->{$tags_to_index[$tag]})) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	380 $document->{$tags_to_index[$tag]} = '';
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	381 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	382 $document->{$tags_to_index[$tag]} .= ' ' . solrsearch_clean_text($matches[2][$key]);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	383 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	384 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	385 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	386
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	387 /**
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	388 * Returns a generic Solr document object for this entity.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	389 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	390 * This function will do the basic processing for the document that is common
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	391 * to all entities, but virtually all entities will need their own additional
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	392 * processing.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	393 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	394 * @param object $entity
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	395 * The entity for which we want a document.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	396 * @param string $entity_type
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	397 * The type of entity we're processing.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	398 * @return solrsearchDocument
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	399 */
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	400 function _solrsearch_index_process_entity_get_document($entity, $entity_type) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	401 list($entity_id, $vid, $bundle) = entity_extract_ids($entity_type, $entity);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	402
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	403 $document = new solrsearchDocument();
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	404
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	405 // Define our url options in advance. This differs depending on the
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	406 // language
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	407 $languages = language_list();
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	408 $url_options = array('absolute' => TRUE);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	409 if (isset($entity->language) && isset($languages[$entity->language])) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	410 $url_options = $url_options + array('language' => $languages[$entity->language]);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	411 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	412
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	413 $document->id = solrsearch_document_id($entity_id, $entity_type);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	414 $document->site = url(NULL, $url_options);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	415 $document->hash = solrsearch_site_hash();
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	416
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	417 $document->entity_id = $entity_id;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	418 $document->entity_type = $entity_type;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	419 $document->bundle = $bundle;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	420 $document->bundle_name = entity_bundle_label($entity_type, $bundle);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	421
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	422 if (empty($entity->language)) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	423 // 'und' is the language-neutral code in Drupal 7.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	424 $document->language = LANGUAGE_NONE;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	425 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	426 else {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	427 $document->language = $entity->language;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	428 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	429
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	430 $path = entity_uri($entity_type, $entity);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	431 // A path is not a requirement of an entity
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	432 if (!empty($path)) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	433 $document->path = $path['path'];
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	434 $document->url = url($path['path'], $path['options'] + $url_options);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	435 // Path aliases can have important information about the content.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	436 // Add them to the index as well.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	437 if (function_exists('drupal_get_path_alias')) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	438 // Add any path alias to the index, looking first for language specific
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	439 // aliases but using language neutral aliases otherwise.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	440 $output = drupal_get_path_alias($document->path, $document->language);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	441 if ($output && $output != $document->path) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	442 $document->path_alias = $output;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	443 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	444 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	445 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	446 return $document;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	447 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	448
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	449 /**
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	450 * Returns an array of rows from a query based on an indexing environment.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	451 * @todo Remove the read only because it is not environment specific
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	452 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	453 * @param $env_id
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	454 * @param $entity_type
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	455 * @param $limit
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	456 *
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	457 * @return array list of row to index
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	458 */
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	459 function solrsearch_index_get_entities_to_index($env_id, $entity_type, $limit) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	460 $rows = array();
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	461 if (variable_get('solrsearch_read_only', 0)) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	462 return $rows;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	463 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	464 $bundles = solrsearch_get_index_bundles($env_id, $entity_type);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	465 if (empty($bundles)) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	466 return $rows;
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	467 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	468
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	469 $table = solrsearch_get_indexer_table($entity_type);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	470 // Get $last_entity_id and $last_changed.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	471 $last_index_position = solrsearch_get_last_index_position($env_id, $entity_type);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	472 $last_entity_id = $last_index_position['last_entity_id'];
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	473 $last_changed = $last_index_position['last_changed'];
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	474
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	475 // Find the next batch of entities to index for this entity type. Note that
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	476 // for ordering we're grabbing the oldest first and then ordering by ID so
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	477 // that we get a definitive order.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	478 // Also note that we fetch ALL fields from the indexer table
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	479 $query = db_select($table, 'aie')
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	480 ->fields('aie')
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	481 ->condition('aie.bundle', $bundles)
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	482 ->condition(db_or()
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	483 ->condition('aie.changed', $last_changed, '>')
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	484 ->condition(db_and()
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	485 ->condition('aie.changed', $last_changed, '<=')
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	486 ->condition('aie.entity_id', $last_entity_id, '>')))
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	487 ->orderBy('aie.changed', 'ASC')
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	488 ->orderBy('aie.entity_id', 'ASC')
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	489 ->addTag('solrsearch_index_' . $entity_type);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	490
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	491 if ($table == 'solrsearch_index_entities') {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	492 // Other, entity-specific tables don't need this condition.
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	493 $query->condition('aie.entity_type', $entity_type);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	494 }
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	495 $query->range(0, $limit);
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	496 $records = $query->execute();
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	497
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	498 $status_callbacks = solrsearch_entity_get_callback($entity_type, 'status callback');
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	499 foreach ($records as $record) {
a2b4f67e73dc initial Dirk Wintergruen <dwinter@mpiwg-berlin.mpg.de> parents: diff changeset	500 // Check status and status callbacks before sending to the index

0

a2b4f67e73dc initial