Merge lp:~henrik-lochmann/goobi-presentation/bug-855608 into lp:~slub.team/goobi-presentation/old-bzr-trunk

[Henrik Lochmann]

- implementation of advanced search feature (Bug #855608)

[lp:~henrik-lochmann/goobi-presentation/bug-855608]

101. By Henrik Lochmann on 2012-09-07

- code comments and t3jquery dependency

102. By Henrik Lochmann on 2012-09-07

- trunk fix
- jquery loading improved

[Sebastian Meyer (sebastian-meyer)]

review: Approve

=== modified file 'dlf/common/class.tx_dlf_indexing.php'
--- dlf/common/class.tx_dlf_indexing.php	2012-09-07 10:55:51 +0000
+++ dlf/common/class.tx_dlf_indexing.php	2012-09-07 14:53:18 +0000
@@ -358,6 +358,50 @@
 	}
 
 	/**
+	 * Returns the dynamic index field title for the given index metadata.
+	 * 
+	 * @param string $index_name the "index_name" to request the index field title
+	 * 
+	 * @return string the index field title for the passed "index_name"
+	 */
+	public static function getIndexField($pid, $core = 0, $index_name) {
+		
+		if (empty($index_name)) {
+			
+			return $index_name;
+			
+		}
+		
+		if (!self::solrConnect($core, $pid)) {
+			
+			if (TYPO3_DLOG) {
+			
+				t3lib_div::devLog('[tx_dlf_indexing->getIndexField(] Could not connect to Apache Solr server', $this->extKey, SYSLOG_SEVERITY_ERROR);
+				
+				return $index_name;
+			
+			}
+				
+		}
+		
+		
+		if (substr($index_name, -8) !== '_sorting') {
+		
+			$suffix = (in_array($index_name, self::$fields['tokenized']) ? 't' : 'u');
+		
+			$suffix .= (in_array($index_name, self::$fields['stored']) ? 's' : 'u');
+		
+			$suffix .= (in_array($index_name, self::$fields['indexed']) ? 'i' : 'u');
+		
+			$index_name .= '_'.$suffix;
+			
+		}
+		
+		return $index_name;
+
+	}
+	
+	/**
 	 * Load indexing configuration
 	 *
 	 * @access	protected

=== modified file 'dlf/common/class.tx_dlf_solr.php'
=== modified file 'dlf/hooks/class.tx_dlf_tceforms.php'
--- dlf/hooks/class.tx_dlf_tceforms.php	2012-08-22 19:22:29 +0000
+++ dlf/hooks/class.tx_dlf_tceforms.php	2012-09-07 14:53:18 +0000
@@ -91,6 +91,51 @@
 		}
 
 	}
+	
+	public function itemsProcFunc_extendedSearchList(&$params, &$pObj) {
+		
+		if ($params['row']['pi_flexform']) {
+		
+			$pi_flexform = t3lib_div::xml2array($params['row']['pi_flexform']);
+		
+			$pages = $pi_flexform['data']['sDEF']['lDEF']['pages']['vDEF'];
+		
+			// There is a strange behavior where the uid from the flexform is prepended by the table's name and appended by its title.
+			// i.e. instead of "18" it reads "pages_18|Title"
+			if (!t3lib_div::testInt($pages)) {
+		
+				$_parts = explode('|', $pages);
+		
+				$pages = array_pop(explode('_', $_parts[0]));
+		
+			}
+		
+			if ($pages > 0) {
+		
+				$result = $GLOBALS['TYPO3_DB']->exec_SELECTquery(
+						'label,index_name',
+						'tx_dlf_metadata',
+						'indexed=1 AND pid='.intval($pages).' AND (sys_language_uid IN (-1,0) OR l18n_parent=0)'.tx_dlf_helper::whereClause('tx_dlf_metadata'),
+						'',
+						'sorting',
+						''
+				);
+		
+				if ($GLOBALS['TYPO3_DB']->sql_num_rows($result) > 0) {
+		
+					while ($resArray = $GLOBALS['TYPO3_DB']->sql_fetch_row($result)) {
+		
+						$params['items'][] = $resArray;
+		
+					}
+		
+				}
+		
+			}
+		
+		}
+		
+	}
 
 	/**
 	 * Helper to get flexform's items array for plugin "tx_dlf_search"

=== modified file 'dlf/plugins/pageview/class.tx_dlf_pageview.php'
--- dlf/plugins/pageview/class.tx_dlf_pageview.php	2012-09-06 16:28:39 +0000
+++ dlf/plugins/pageview/class.tx_dlf_pageview.php	2012-09-07 14:53:18 +0000
@@ -237,9 +237,10 @@
 
 		}
 
+		// !!!ATTENTION PLEASE: THE ID WITHIN THE SCRIPT ELEMENT IS IMPORTANT ANDSHOULD STAY IN FUTURE RELEASES!!! 
 		$viewer .= '
-		<script type="text/javascript">
-		/* <![CDATA[ */
+		<script id="tx-dlf-initViewer" type="text/javascript">
+		///* <![CDATA[ */
 		dlfViewer = new Viewer();
 		'.implode("\n", $addImages).'
 		dlfViewer.run();

=== modified file 'dlf/plugins/search/class.tx_dlf_search.php'
--- dlf/plugins/search/class.tx_dlf_search.php	2012-09-06 14:41:02 +0000
+++ dlf/plugins/search/class.tx_dlf_search.php	2012-09-07 14:53:18 +0000
@@ -210,7 +210,125 @@
 		return $this->cObj->HMENU($TSconfig);
 
 	}
-
+	
+	/**
+	 * Returns the extended search form and adds the JS files necessary for extended search.
+	 *
+	 * @access	protected
+	 *
+	 * @return	string		the extended search form HTML content or an empty string if extended search is not desired or not possible
+	 */
+	protected function addExtendedSearch($template) {
+		
+		if (!$this->ensureJquery()) {
+			
+			return '';
+			
+		}
+		
+		// Add JS for client side query construction.
+		$GLOBALS['TSFE']->additionalHeaderData[$this->prefixId.'_search_extended'] = '<script type="text/javascript" src="'.t3lib_extMgm::siteRelPath($this->extKey).'plugins/search/tx_dlf_search_extended.js"></script>';
+
+		// Quit without doing anything if no fields for extended search are selected.
+		if (empty($this->conf['extSearchSlotCount']) || empty($this->conf['extSearchFields'])) {
+		
+			return '';
+		
+		}
+		
+		$searchFields = t3lib_div::trimExplode(',', $this->conf['extSearchFields'], TRUE);
+		
+		if (array_count_values($searchFields) == 0) {
+			
+			t3lib_div::devLog('[tx_dlf_search.addExtendedSearch]   empty array', 'dlf', t3lib_div::SYSLOG_SEVERITY_INFO);
+			
+			return '';
+			
+		}
+		
+		$operatorOptions = '';
+		
+		foreach (array("AND", "OR", "NOT") as $operator) {
+
+			$operatorOptions .= '<option value="'.$operator.'" '.$this->conf['extendedSearch.']['operator.']['option.']['parameters'].'>'.$this->pi_getLL('tt_content.pi_flexform.extSearch.operator.'.$operator).'</option>';
+			
+		}
+		
+		$fieldSelectorOptions = '';
+		
+		// create field selector options
+		foreach ($searchFields as $searchField) {
+				
+			$fieldSelectorOptions .= '<option value="'.tx_dlf_indexing::getIndexField($this->conf['pages'], $this->conf['solrcore'], $searchField).'"  '.$this->conf['extendedSearch.']['fieldSelector.']['option.']['parameters'].'>'.tx_dlf_helper::translate($searchField, 'tx_dlf_metadata', $this->conf['pages']).'</option>';
+				
+		}
+				
+		// create content
+		$result = '';
+		
+		$markerArray = array();
+		
+		for ($i = 0; $i < $this->conf['extSearchSlotCount']; $i++) {
+				
+			if ($i == 0) {
+		
+				$markerArray['###EXT_SEARCH_OPERATOR###'] = $this->conf['extendedSearch.']['operator.']['first'];
+		
+			} else {
+		
+				$markerArray['###EXT_SEARCH_OPERATOR###'] = '<select name="tx_dlf[operator_'.$i.']" '.$this->conf['extendedSearch.']['operator.']['select.']['parameters'].'>'.$operatorOptions.'</select>';
+		
+			}
+				
+			$markerArray['###EXT_SEARCH_FIELD_SELECTOR###'] = '<select name="tx_dlf[fieldSelector_'.$i.']" '.$this->conf['extendedSearch.']['fieldSelector.']['select.']['parameters'].'>'.$fieldSelectorOptions.'</select>';
+				
+			$markerArray['###EXT_SEARCH_FIELD_INPUT###'] = '<input type="text" name="tx_dlf[field_'.$i.']" '.$this->conf['extendedSearch.']['field.']['parameters'].'>';
+				
+			$result .= $this->cObj->substituteMarkerArray($template, $markerArray);
+				
+		}
+		
+		return $result;
+		
+	}
+	
+	/**
+	 * Tries to load t3jquery extension and returns success.
+	 *
+	 * @access	protected
+	 *
+	 * @return	boolean		TRUE on success or FALSE on error
+	 */
+	private function ensureJquery() {
+	
+		if (T3JQUERY === TRUE) {
+			
+			return TRUE;
+			
+		}
+		
+		// Ensure extension "t3jquery" is available.
+		if (t3lib_extMgm::isLoaded('t3jquery')) {
+	
+			require_once(t3lib_extMgm::extPath('t3jquery').'class.tx_t3jquery.php');
+	
+		}
+	
+		// Is "t3jquery" loaded?
+		if (T3JQUERY === TRUE) {
+
+			tx_t3jquery::addJqJS();
+			
+			return TRUE;
+			
+		} else {
+			
+			return FALSE;
+			
+		}
+	
+	}
+	
 	/**
 	 * Creates an array for a HMENU entry of a facet value.
 	 *
@@ -357,7 +475,7 @@
 			);
 
 			// Display search form.
-			$content .= $this->cObj->substituteMarkerArray($this->template, $markerArray);
+			$content .= $this->cObj->substituteSubpart($this->cObj->substituteMarkerArray($this->template, $markerArray), '###EXT_SEARCH_ENTRY###', $this->addExtendedSearch($this->cObj->getSubpart($this->template, '###EXT_SEARCH_ENTRY###')));
 
 			return $this->pi_wrapInBaseClass($content);
 

=== modified file 'dlf/plugins/search/flexform.xml'
--- dlf/plugins/search/flexform.xml	2012-09-06 09:17:11 +0000
+++ dlf/plugins/search/flexform.xml	2012-09-07 14:53:18 +0000
@@ -54,6 +54,7 @@
 							</config>
 						</TCEforms>
 					</limit>
+<<<<<<< TREE
 					<searchIn>
 						<TCEforms>
 							<exclude>1</exclude>
@@ -84,6 +85,40 @@
 							</config>
 						</TCEforms>
 					</searchIn>
+=======
+					<extSearchSlotCount>
+						<TCEforms>
+							<displayCond>FIELD:pages:REQ:true</displayCond>
+							<exclude>1</exclude>
+							<label>LLL:EXT:dlf/plugins/search/locallang.xml:tt_content.pi_flexform.extSearch.slotCount</label>
+							<config>
+								<type>input</type>
+								<eval>num,int</eval>
+								<range>
+     								<lower>-1</lower>
+     								<upper>10</upper>
+   								</range>
+								<default>0</default>
+							</config>
+						</TCEforms>
+					</extSearchSlotCount>
+					<extSearchFields>
+						<TCEforms>
+							<displayCond>FIELD:pages:REQ:true</displayCond>
+							<exclude>1</exclude>
+							<label>LLL:EXT:dlf/plugins/search/locallang.xml:tt_content.pi_flexform.extSearch.fields</label>
+							<config>
+								<type>select</type>
+								<items type="array"></items>
+								<itemsProcFunc>tx_dlf_tceforms->itemsProcFunc_extendedSearchList</itemsProcFunc>
+								<size>5</size>
+								<autoSizeMax>15</autoSizeMax>
+								<maxitems>1024</maxitems>
+								<minitems>0</minitems>
+							</config>
+						</TCEforms>
+					</extSearchFields>
+>>>>>>> MERGE-SOURCE
 					<facets>
 						<TCEforms>
 							<displayCond>FIELD:pages:REQ:true</displayCond>

=== modified file 'dlf/plugins/search/locallang.xml'
--- dlf/plugins/search/locallang.xml	2012-09-06 09:17:11 +0000
+++ dlf/plugins/search/locallang.xml	2012-09-07 14:53:18 +0000
@@ -9,11 +9,19 @@
 			<label index="tt_content.pi_flexform.sheet_general">Options</label>
 			<label index="tt_content.pi_flexform.solrcore">Solr Core</label>
 			<label index="tt_content.pi_flexform.limit">Maximum results</label>
+<<<<<<< TREE
 			<label index="tt_content.pi_flexform.searchIn">Allow searching in current document or collection?</label>
 			<label index="tt_content.pi_flexform.searchIn.none">none</label>
 			<label index="tt_content.pi_flexform.searchIn.document">document only</label>
 			<label index="tt_content.pi_flexform.searchIn.collection">collection only</label>
 			<label index="tt_content.pi_flexform.searchIn.all">both</label>
+=======
+			<label index="tt_content.pi_flexform.extSearch.slotCount">Number of search slots</label>
+			<label index="tt_content.pi_flexform.extSearch.fields">Show these fields in extended search</label>
+			<label index="tt_content.pi_flexform.extSearch.operator.AND">and</label>
+			<label index="tt_content.pi_flexform.extSearch.operator.OR">or</label>
+			<label index="tt_content.pi_flexform.extSearch.operator.NOT">not</label>
+>>>>>>> MERGE-SOURCE
 			<label index="tt_content.pi_flexform.facets">Show these facets</label>
 			<label index="tt_content.pi_flexform.limitFacets">Maximum facet values</label>
 			<label index="tt_content.pi_flexform.targetPid">Target page (with "DLF: List View" plugin)</label>
@@ -30,11 +38,19 @@
 			<label index="tt_content.pi_flexform.sheet_general">Einstellungen</label>
 			<label index="tt_content.pi_flexform.solrcore">Solr Kern</label>
 			<label index="tt_content.pi_flexform.limit">Maximale Ergebnismenge</label>
+<<<<<<< TREE
 			<label index="tt_content.pi_flexform.searchIn">Erlaube Suche in aktuellem Dokument oder Kollektion?</label>
 			<label index="tt_content.pi_flexform.searchIn.none">nein</label>
 			<label index="tt_content.pi_flexform.searchIn.document">nur Dokument</label>
 			<label index="tt_content.pi_flexform.searchIn.collection">nur Kollektion</label>
 			<label index="tt_content.pi_flexform.searchIn.all">beides</label>
+=======
+			<label index="tt_content.pi_flexform.extSearch.slotCount">Anzahl an Suchfeldern</label>
+			<label index="tt_content.pi_flexform.extSearch.fields">Diese Felder in der erweiterten Suche anzeigen</label>
+			<label index="tt_content.pi_flexform.extSearch.operator.AND">und</label>
+			<label index="tt_content.pi_flexform.extSearch.operator.OR">oder</label>
+			<label index="tt_content.pi_flexform.extSearch.operator.NOT">nicht</label>
+>>>>>>> MERGE-SOURCE
 			<label index="tt_content.pi_flexform.facets">Diese Facetten anzeigen</label>
 			<label index="tt_content.pi_flexform.limitFacets">Maximale Facettenwerte</label>
 			<label index="tt_content.pi_flexform.targetPid">Zielseite (mit Plugin "DLF: Listenansicht")</label>

=== modified file 'dlf/plugins/search/setup.txt'
--- dlf/plugins/search/setup.txt	2012-08-24 13:15:53 +0000
+++ dlf/plugins/search/setup.txt	2012-09-07 14:53:18 +0000
@@ -32,4 +32,13 @@
 		CUR < .NO
 		CUR.wrapItemAndSub = <li class="tx-dlf-search-cur">|</li>
 	}
-}
\ No newline at end of file
+}
+
+plugin.tx_dlf_search.extendedSearch {
+	operator.first = <span class="span1" style="padding: 0 2px;">&nbsp;</span>
+	operator.select.parameters = class="span1"
+	#operator.option.parameters =
+	fieldSelector.select.parameters = class="span2"
+	#fieldSelector.option.parameters =
+	field.parameters = class="span5"
+}

=== added file 'dlf/plugins/search/tx_dlf_search_extended.js'
--- dlf/plugins/search/tx_dlf_search_extended.js	1970-01-01 00:00:00 +0000
+++ dlf/plugins/search/tx_dlf_search_extended.js	2012-09-07 14:53:18 +0000
@@ -0,0 +1,50 @@
+$(
+	function() {
+		var parentForms = $('input[name^="tx_dlf[field"]').parents('form');
+		if (parentForms.length == 0) {
+			return;
+		}
+		
+		var extendedSearchForm = parentForms.get(0); 
+		if (extendedSearchForm == null) {
+			return;
+		}
+		
+		var queryInput = $(extendedSearchForm).find('input[name="tx_dlf[query]"]');
+		if (queryInput == null) {
+			return;
+		}
+		
+		$(extendedSearchForm).submit(function() {
+			var query = "";
+			
+			var filledSearchFields = $(extendedSearchForm).find('input[name^="tx_dlf[field"][value!=""]');
+			filledSearchFields.each(function(index, element){
+				var indexer = /[a-z]+_([0-9]+)/g;
+				var match = indexer.exec(element.name); 
+				if (match == null) {
+					return false;
+				}
+				
+				var fieldIndex = match[1];
+				
+				// get operator
+				var operator = $('select[name="tx_dlf[operator_' + fieldIndex + ']"]').val();
+				if (index > 0 || operator == "NOT") {
+					if (!query) {
+						query = "*";
+					} 
+					
+					query += " " + operator;
+				}
+				
+				// get search field selector
+				var fieldSelector = $('select[name="tx_dlf[fieldSelector_' + fieldIndex + ']"]').val();
+				query += " " + fieldSelector + ":" + element.value;
+			});
+			
+			$(queryInput).val(query.replace(/^\s\s*/, '').replace(/\s\s*$/, ''));
+			return true;
+		});	
+	}
+);
\ No newline at end of file