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

[Henrik Lochmann]

- fixing after internal review

[Sebastian Meyer (sebastian-meyer)]

review: Approve

=== modified file 'dlf/common/class.tx_dlf_document.php'
--- dlf/common/class.tx_dlf_document.php	2012-05-15 07:43:50 +0000
+++ dlf/common/class.tx_dlf_document.php	2012-07-27 10:23:21 +0000
@@ -29,7 +29,7 @@
 /**
  * Document class 'tx_dlf_document' for the 'dlf' extension.
  *
- * @author	Sebastian Meyer <[e-mail]>
+ * @author	Sebastian Meyer <[e-mail]>, Henrik Lochmann <[e-mail]>
  * @copyright	Copyright (c) 2011, Sebastian Meyer, SLUB Dresden
  * @package	TYPO3
  * @subpackage	tx_dlf
@@ -248,6 +248,23 @@
 	 */
 	protected $tableOfContentsLoaded = FALSE;
 
+	/**
+	 * This holds the document's thumbnail.
+	 *
+	 * @var	string
+	 * @access protected
+	 */
+	protected $thumbnail = NULL;
+
+	/**
+	 * Is the thumbnail loaded?
+	 * @see $thumbnail
+	 *
+	 * @var	boolean
+	 * @access protected
+	 */
+	protected $thumbnailLoaded = FALSE;
+
 	/**
 	 * This holds the UID or the URL of the document
 	 *
@@ -798,6 +815,146 @@
 
 	}
 
+	/**
+	 * Returns a document thumbnail depending on ext configuration and structure element settings.
+	 *
+	 * @access	public
+	 *
+	 * @param	integer		$pid: The PID for the metadata definitions
+	 *
+	 * @return	mixed		The thumbnail url or FALSE, if none could be found.
+	 */
+	public function getThumbnail($pid = -1) {
+
+		if (!$this->thumbnailLoaded) {
+
+			if ($pid === -1) {
+
+				$pid = $this->pid;
+
+			}
+
+			$logicalUnitId = $this->getToplevelId();
+
+			$metadata = $this->getMetadata($logicalUnitId, $pid);
+
+			$structureType = $metadata['type'][0];
+
+			// Check if for this structure/document type thumbnails shall be rendered.
+			$result = $GLOBALS['TYPO3_DB']->exec_SELECTquery(
+					'tx_dlf_structures.thumbnail AS thumbnail, tx_dlf_structures.thumbnail_source AS thumbnail_source',
+					'tx_dlf_structures',
+					'tx_dlf_structures.pid='.intval($pid).' AND tx_dlf_structures.index_name='.$GLOBALS['TYPO3_DB']->fullQuoteStr($structureType, 'tx_dlf_structures').tx_dlf_helper::whereClause('tx_dlf_structures'),
+					'',
+					'',
+					'1'
+			);
+
+			$resArray = array();
+
+			if (!($resArray = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($result))) {
+
+				t3lib_div::devLog('[tx_dlf_document.getThumbnail]   could not get thumbnail settings from DB', 'dlf', t3lib_div::SYSLOG_SEVERITY_ERROR);
+
+				return FALSE;
+
+			}
+
+			if ($resArray['thumbnail'] != '1') {
+
+				t3lib_div::devLog('[tx_dlf_document.getThumbnail]   no thumbnail generation for '.$logicalUnitId, 'dlf', t3lib_div::SYSLOG_SEVERITY_NOTICE);
+
+				return FALSE;
+
+			}
+
+			// Check desired thumbnail source.
+			if (!empty($resArray['thumbnail_source'])) {
+
+				$result = $GLOBALS['TYPO3_DB']->exec_SELECTquery(
+						'tx_dlf_structures.index_name AS index_name',
+						'tx_dlf_structures',
+						'tx_dlf_structures.uid='.intval($resArray['thumbnail_source']).tx_dlf_helper::whereClause('tx_dlf_structures'),
+						'',
+						'',
+						'1'
+				);
+
+				if (!($resArray = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($result))) {
+
+					t3lib_div::devLog('[tx_dlf_document.getThumbnail]   could not get thumbnail source index name from DB', 'dlf', t3lib_div::SYSLOG_SEVERITY_ERROR);
+
+					return FALSE;
+
+				}
+
+				// Check if this document has a sub element of the desired type.
+				$nodes = $this->mets->xpath('./mets:structMap[@TYPE="LOGICAL"]//mets:div[@TYPE="'.$resArray['index_name'].'"]/@ID');
+
+				if (is_array($nodes) && count($nodes) > 0) {
+
+					$subId = (string) $nodes[0];
+
+					t3lib_div::devLog('[tx_dlf_document.getThumbnail]   thumb source element changed: oldId='.$logicalUnitId.', newId='.$subId, 'dlf', t3lib_div::SYSLOG_SEVERITY_NOTICE);
+
+					$logicalUnitId = $subId;
+
+				} else {
+
+					t3lib_div::devLog('[tx_dlf_document.getThumbnail]   no sub element found, taking toplevel element as thumb source', 'dlf', t3lib_div::SYSLOG_SEVERITY_NOTICE);
+
+				}
+
+			}
+
+			// Extract and set thumbnail, if desired.
+			t3lib_div::devLog('[tx_dlf_document.getThumbnail]   thumbnails desired for '.$logicalUnitId, 'dlf', t3lib_div::SYSLOG_SEVERITY_NOTICE);
+
+			$extConf = unserialize($GLOBALS['TYPO3_CONF_VARS']['EXT']['extConf']['dlf']);
+
+			$fileGrp = $extConf['thumbFileGrp'];
+
+			$this->thumbnail = 'not found';
+
+			$firstPageNode = $this->mets->xpath('./mets:structLink/mets:smLink[@xlink:from="'.$logicalUnitId.'"][1]/@xlink:to');
+
+			if (is_array($firstPageNode) && count($firstPageNode) > 0) {
+
+				$firstPageId = $firstPageNode[0];
+
+				// den rest via physical pages
+				t3lib_div::devLog('[tx_dlf_document.getThumbnail]   first page='.$firstPageId, 'dlf', t3lib_div::SYSLOG_SEVERITY_NOTICE);
+
+				$thumbnailNode = $this->mets->xpath('./mets:structMap[@TYPE="PHYSICAL"]/mets:div[@TYPE="physSequence"]/mets:div[@ID="'.$firstPageId.'"]/mets:fptr[substring(@FILEID, string-length(@FILEID) - '.(strlen($fileGrp) - 1).') = "'.$fileGrp.'"]/@FILEID');
+
+				if (is_array($firstPageNode) && count($thumbnailNode) > 0) {
+
+					$thumbnailFileId = (string) $thumbnailNode[0];
+
+					$this->thumbnail = $this->getFileLocation($thumbnailFileId);
+
+					t3lib_div::devLog('[tx_dlf_document.getThumbnail]   thumbnail found, logicalUnit='.$logicalUnitId.', page='.$firstPageId.', thumb='.$thumbnailFileId.', thumb_url='.$this->thumbnail, 'dlf', t3lib_div::SYSLOG_SEVERITY_NOTICE);
+
+				} else {
+
+					t3lib_div::devLog('[tx_dlf_document.getThumbnail]   no thumbnail found on first page (fileGrp='.$fileGrp.')', 'dlf', t3lib_div::SYSLOG_SEVERITY_NOTICE);
+
+				}
+
+			} else  {
+
+				t3lib_div::devLog('[tx_dlf_document.getThumbnail]   no first page found', 'dlf', t3lib_div::SYSLOG_SEVERITY_NOTICE);
+
+			}
+
+			$this->thumbnailLoaded = TRUE;
+
+		}
+
+		return $this->thumbnail;
+
+	}
+
 	/**
 	 * This returns the ID of the toplevel logical structure node
 	 *
@@ -1343,6 +1500,7 @@
 			'owner' => $owner,
 			'solrcore' => $core,
 			'status' => 0,
+			'thumbnail' => $this->getThumbnail($pid),
 		);
 
 		if ($location) {
 
=== modified file 'dlf/common/class.tx_dlf_indexing.php'
--- dlf/common/class.tx_dlf_indexing.php	2012-04-30 16:05:21 +0000
+++ dlf/common/class.tx_dlf_indexing.php	2012-07-27 10:23:21 +0000
@@ -500,6 +500,13 @@
 
 			$solrDoc->setField('type', $logicalUnit['type'], self::$fieldboost['type']);
 
+			// Index thumbnails for toplevel elements.
+			if (in_array($logicalUnit['type'], self::$toplevel)) {
+
+				$solrDoc->setField('thumbnail', $doc->getThumbnail($doc->pid));
+
+			}
+
 			$solrDoc->setField('title', $metadata['title'][0], self::$fieldboost['title']);
 
 			$solrDoc->setField('author', $metadata['author'], self::$fieldboost['author']);
 
=== modified file 'dlf/ext_conf_template.txt'
--- dlf/ext_conf_template.txt	2012-03-29 08:32:14 +0000
+++ dlf/ext_conf_template.txt	2012-07-27 10:23:21 +0000
@@ -10,6 +10,9 @@
 # cat=Basic; type=string; label=LLL:EXT:dlf/locallang.xml:config.fileGrps
 fileGrps = DEFAULT,MIN,MAX,THUMBS
 
+# cat=Basic; type=string; label=LLL:EXT:dlf/locallang.xml:config.thumbFileGrp 
+thumbFileGrp = THUMBS
+
 # cat=Basic; type=boolean; label=LLL:EXT:dlf/locallang.xml:config.caching
 caching = 0
 
 
=== modified file 'dlf/ext_tables.sql'
--- dlf/ext_tables.sql	2012-03-24 12:06:31 +0000
+++ dlf/ext_tables.sql	2012-07-27 10:23:21 +0000
@@ -34,7 +34,8 @@
     owner int(11) DEFAULT '0' NOT NULL,
     solrcore int(11) DEFAULT '0' NOT NULL,
     status tinyint(4) unsigned DEFAULT '0' NOT NULL,
-
+    thumbnail tinytext NOT NULL,
+    
     PRIMARY KEY (uid),
     KEY parent (pid),
     INDEX partof (partof)
@@ -58,6 +59,8 @@
     label tinytext NOT NULL,
     index_name tinytext NOT NULL,
     oai_name tinytext NOT NULL,
+    thumbnail tinyint(4) DEFAULT '0' NOT NULL,
+    thumbnail_source int(11) DEFAULT '0' NOT NULL,
     status tinyint(4) unsigned DEFAULT '0' NOT NULL,
 
     PRIMARY KEY (uid),
 
=== modified file 'dlf/locallang.xml'
--- dlf/locallang.xml	2012-04-20 08:23:36 +0000
+++ dlf/locallang.xml	2012-07-27 10:23:21 +0000
@@ -21,7 +21,7 @@
 			<label index="tx_dlf_documents.year">Year of Publication</label>
 			<label index="tx_dlf_documents.year_sorting">Year of Publication (Sorting)</label>
 			<label index="tx_dlf_documents.place">Place of Publication</label>
-			<label index="tx_dlf_documents.place_sorting">Place of Publication</label>
+			<label index="tx_dlf_documents.place_sorting">Place of Publication (Sorting)</label>
 			<label index="tx_dlf_documents.structure">Typ of Document</label>
 			<label index="tx_dlf_documents.partof">Part of ...</label>
 			<label index="tx_dlf_documents.partof.none">none</label>
@@ -39,6 +39,8 @@
 			<label index="tx_dlf_structures.label">Display Label</label>
 			<label index="tx_dlf_structures.index_name">Index Name</label>
 			<label index="tx_dlf_structures.oai_name">OAI Mapping</label>
+			<label index="tx_dlf_structures.thumbnail">Show Thumbnail</label>
+			<label index="tx_dlf_structures.thumbnail_source">Thumbnail Source</label>
 			<label index="tx_dlf_structures.status">Status</label>
 			<label index="tx_dlf_structures.status.default">default</label>
 			<label index="tx_dlf_structures.tab1">General</label>
@@ -124,6 +126,7 @@
 			<label index="config.makeCliUserGroup">Create and configure CLI user/group automatically?: (default is "FALSE")</label>
 			<label index="config.useragent">DLF User-Agent: (default is "Goobi.Presentation")</label>
 			<label index="config.fileGrps">Additional METS fileGrps: comma-separated list of @USE attribute values (default is "DEFAULT,MIN,MAX,THUMBS")</label>
+			<label index="config.thumbFileGrp">Thumbnails METS fileGrp: selects the fileGrp with by this @USE attribute value for thumbnail extraction</label>
 			<label index="config.caching">Cache parsed METS files: caching improves performance a little bit but can result in a very large "fe_session_data" table (default is "FALSE")</label>
 			<label index="config.solrConnect">Solr Connection</label>
 			<label index="config.solrHost">Solr Server Host: (default is "localhost")</label>
@@ -196,6 +199,8 @@
 			<label index="tx_dlf_structures.label">Anzeigeform</label>
 			<label index="tx_dlf_structures.index_name">Index-Bezeichnung</label>
 			<label index="tx_dlf_structures.oai_name">OAI-Mapping</label>
+			<label index="tx_dlf_structures.thumbnail">Vorschau zeigen</label>
+			<label index="tx_dlf_structures.thumbnail_source">Vorschau-Quelle</label>
 			<label index="tx_dlf_structures.status">Status</label>
 			<label index="tx_dlf_structures.status.default">Standard</label>
 			<label index="tx_dlf_structures.tab1">Allgemein</label>
@@ -281,6 +286,7 @@
 			<label index="config.makeCliUserGroup">CLI Benutzer/Gruppe automatisch anlegen?: (Standard ist "FALSE")</label>
 			<label index="config.useragent">DLF User-Agent: (Standard ist "Goobi.Presentation")</label>
 			<label index="config.fileGrps">Zusätzliche METS fileGrps: Komma-getrennte Liste von @USE Attributwerten (Standard ist "DEFAULT,MIN,MAX,THUMBS")</label>
+			<label index="config.thumbFileGrp">Vorschau METS fileGrp: wählt die fileGrp mit diesem @USE Attributwert für die Thumbnail-Extraktion aus</label>
 			<label index="config.caching">Eingelesene METS Dateien zwischenspeichern: Dies kann die Geschwindigkeit geringfügig verbessern, führt aber zu einer sehr großen "fe_session_data" Tabelle (Standard ist "FALSE")</label>
 			<label index="config.solrConnect">Solr Verbindung</label>
 			<label index="config.solrHost">Solr Server Host: (Standard ist "localhost")</label>
 
=== modified file 'dlf/plugins/collection/class.tx_dlf_collection.php'
--- dlf/plugins/collection/class.tx_dlf_collection.php	2012-05-15 07:51:09 +0000
+++ dlf/plugins/collection/class.tx_dlf_collection.php	2012-07-27 10:23:21 +0000
@@ -254,7 +254,7 @@
 
 		// Get all documents in collection.
 		$result = $GLOBALS['TYPO3_DB']->exec_SELECT_mm_query(
-			'tx_dlf_collections.label AS collLabel,tx_dlf_collections.description AS collDesc,tx_dlf_documents.uid AS uid,tx_dlf_documents.title AS title,tx_dlf_documents.volume AS volume,tx_dlf_documents.volume_sorting AS volume_sorting,tx_dlf_documents.author AS author,tx_dlf_documents.place AS place,tx_dlf_documents.year AS year,tx_dlf_documents.structure AS type,tx_dlf_documents.partof AS partof',
+			'tx_dlf_collections.label AS collLabel,tx_dlf_collections.description AS collDesc,tx_dlf_documents.uid AS uid,tx_dlf_documents.title AS title,tx_dlf_documents.volume AS volume,tx_dlf_documents.volume_sorting AS volume_sorting,tx_dlf_documents.author AS author,tx_dlf_documents.place AS place,tx_dlf_documents.year AS year,tx_dlf_documents.structure AS type,tx_dlf_documents.partof AS partof,tx_dlf_documents.thumbnail AS thumbnail',
 			'tx_dlf_documents',
 			'tx_dlf_relations',
 			'tx_dlf_collections',
@@ -297,7 +297,8 @@
 					'year' => array ($resArray['year']),
 					'place' => array ($resArray['place']),
 					'type' => array (tx_dlf_helper::getIndexName($resArray['type'], 'tx_dlf_structures', $this->conf['pages'])),
-					'subparts' => array ()
+					'subparts' => array (),
+					'thumbnail' => $resArray['thumbnail']
 				);
 
 			} else {
 
=== modified file 'dlf/plugins/listview/class.tx_dlf_listview.php'
--- dlf/plugins/listview/class.tx_dlf_listview.php	2012-05-15 07:51:09 +0000
+++ dlf/plugins/listview/class.tx_dlf_listview.php	2012-07-27 10:23:21 +0000
@@ -29,7 +29,7 @@
 /**
  * Plugin 'DLF: List View' for the 'dlf' extension.
  *
- * @author	Sebastian Meyer <[e-mail]>
+ * @author	Sebastian Meyer <[e-mail]>, Henrik Lochmann <[e-mail]>
  * @copyright	Copyright (c) 2011, Sebastian Meyer, SLUB Dresden
  * @package	TYPO3
  * @subpackage	tx_dlf
@@ -232,6 +232,17 @@
 
 		}
 
+		// Add thumbnail.
+		if (!empty($this->list->elements[$number]['thumbnail'])) {
+
+			$markerArray['###THUMBNAIL###'] = '<img title="" alt="" src="'.$this->list->elements[$number]['thumbnail'].'"/>';
+
+		} else {
+
+			$markerArray['###THUMBNAIL###'] = '';
+
+		}
+
 		if (!empty($this->list->elements[$number]['subparts'])) {
 
 			$subpart = $this->getSubEntries($number, $template);
 
=== modified file 'dlf/plugins/listview/template.tmpl'
--- dlf/plugins/listview/template.tmpl	2012-03-16 09:06:25 +0000
+++ dlf/plugins/listview/template.tmpl	2012-07-27 10:23:21 +0000
@@ -6,6 +6,7 @@
 <ol class="tx-dlf-listview-list">
 	<!-- ###ENTRY### -->
 	<li value="###NUMBER###">
+		<span>###THUMBNAIL###</span>
 		<dl>
 			###METADATA###
 		</dl>
 
=== modified file 'dlf/plugins/search/class.tx_dlf_search.php'
--- dlf/plugins/search/class.tx_dlf_search.php	2012-05-05 11:10:37 +0000
+++ dlf/plugins/search/class.tx_dlf_search.php	2012-07-27 10:23:21 +0000
@@ -142,7 +142,8 @@
 						'year' => (is_array($doc->year) ? $doc->year : array ($doc->year)),
 						'place' => (is_array($doc->place) ? $doc->place : array ($doc->place)),
 						'type' => (is_array($doc->type) ? $doc->type : array ($doc->type)),
-						'subparts' => (!empty($toplevel[$doc->uid]['subparts']) ? $toplevel[$doc->uid]['subparts'] : array ())
+						'subparts' => (!empty($toplevel[$doc->uid]['subparts']) ? $toplevel[$doc->uid]['subparts'] : array ()),
+						'thumbnail' => $doc->thumbnail
 					);
 
 				} else {
@@ -175,7 +176,7 @@
 
 					// Get information for toplevel document.
 					$result = $GLOBALS['TYPO3_DB']->exec_SELECTquery(
-						'tx_dlf_documents.uid AS uid,tx_dlf_documents.title AS title,tx_dlf_documents.volume AS volume,tx_dlf_documents.author AS author,tx_dlf_documents.place AS place,tx_dlf_documents.year AS year,tx_dlf_documents.structure AS type',
+						'tx_dlf_documents.uid AS uid,tx_dlf_documents.title AS title,tx_dlf_documents.volume AS volume,tx_dlf_documents.author AS author,tx_dlf_documents.place AS place,tx_dlf_documents.year AS year,tx_dlf_documents.structure AS type,tx_dlf_documents.thumbnail AS thumbnail',
 						'tx_dlf_documents',
 						'tx_dlf_documents.uid='.intval($_check).tx_dlf_helper::whereClause('tx_dlf_documents'),
 						'',
@@ -197,7 +198,8 @@
 							'year' => array ($resArray['year']),
 							'place' => array ($resArray['place']),
 							'type' => array (tx_dlf_helper::getIndexName($resArray['type'], 'tx_dlf_structures', $this->conf['pages'])),
-							'subparts' => $toplevel[$_check]['subparts']
+							'subparts' => $toplevel[$_check]['subparts'],
+							'thumbnail' => $resArray['thumbnail']
 						);
 
 					} else {
 
=== modified file 'dlf/tca.php'
--- dlf/tca.php	2012-04-30 16:11:07 +0000
+++ dlf/tca.php	2012-07-27 10:23:21 +0000
@@ -314,6 +314,12 @@
 				'default' => 0,
 			),
 		),
+		'thumbnail' => array (
+				'exclude' => 1,
+				'config' => array (
+						'type' => 'passthrough',
+				),
+		),
 	),
 	'types' => array (
 		'0' => array ('showitem' => '--div--;LLL:EXT:dlf/locallang.xml:tx_dlf_documents.tab1, title;;1;;1-1-1, author;;2, year;;3, place;;4, structure;;5;;2-2-2, collections;;;;3-3-3, --div--;LLL:EXT:dlf/locallang.xml:tx_dlf_documents.tab2, location;;;;1-1-1, record_id, prod_id;;;;2-2-2, oai_id;;;;3-3-3, opac_id, union_id, urn, purl;;;;4-4-4, --div--;LLL:EXT:dlf/locallang.xml:tx_dlf_documents.tab3, hidden;;;;1-1-1, fe_group;;;;2-2-2, status;;;;3-3-3, owner;;;;4-4-4'),
@@ -411,6 +417,29 @@
 				'eval' => 'trim',
 			),
 		),
+		'thumbnail' => array (
+				'exclude' => 1,
+				'label' => 'LLL:EXT:dlf/locallang.xml:tx_dlf_structures.thumbnail',
+				'config' => array (
+						'type' => 'check',
+						'default' => 0,
+				),
+		),
+		'thumbnail_source' => array (
+				'exclude' => 1,
+				'label' => 'LLL:EXT:dlf/locallang.xml:tx_dlf_structures.thumbnail_source',
+				'config' => array (
+						'type' => 'select',
+						'items' => array (
+							array ('[This Element]', 0),
+						),
+						'foreign_table' => 'tx_dlf_structures',
+						'foreign_table_where' => 'AND tx_dlf_structures.pid=###CURRENT_PID### AND tx_dlf_structures.toplevel=0 AND tx_dlf_structures.sys_language_uid IN (-1,0) ORDER BY tx_dlf_structures.label ',
+				),
+				'minitems' => 0,
+				'maxitems' => 1,
+				'default' => 0,
+		),
 		'status' => array (
 			'exclude' => 1,
 			'label' => 'LLL:EXT:dlf/locallang.xml:tx_dlf_structures.status',
@@ -427,10 +456,11 @@
 		),
 	),
 	'types' => array (
-		'0' => array ('showitem' => '--div--;LLL:EXT:dlf/locallang.xml:tx_dlf_structures.tab1, toplevel;;;;1-1-1, label;;1, --div--;LLL:EXT:dlf/locallang.xml:tx_dlf_structures.tab2, sys_language_uid;;;;1-1-1, l18n_parent, l18n_diffsource, --div--;LLL:EXT:dlf/locallang.xml:tx_dlf_structures.tab3, hidden;;;;1-1-1, status;;;;2-2-2'),
+		'0' => array ('showitem' => '--div--;LLL:EXT:dlf/locallang.xml:tx_dlf_structures.tab1, toplevel;;;;1-1-1, label;;1, thumbnail;;2, --div--;LLL:EXT:dlf/locallang.xml:tx_dlf_structures.tab2, sys_language_uid;;;;1-1-1, l18n_parent, l18n_diffsource, --div--;LLL:EXT:dlf/locallang.xml:tx_dlf_structures.tab3, hidden;;;;1-1-1, status;;;;2-2-2'),
 	),
 	'palettes' => array (
 		'1' => array ('showitem' => 'index_name, --linebreak--, oai_name', 'canNotCollapse' => 1),
+		'2' => array ('showitem' => 'thumbnail_source'),
 	),
 );