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

[Henrik Lochmann]

[Sebastian Meyer (sebastian-meyer)]

review: Approve

=== modified file 'dlf/ext_autoload.php'
--- dlf/ext_autoload.php	2012-08-22 19:22:29 +0000
+++ dlf/ext_autoload.php	2012-09-25 14:14:21 +0000
@@ -47,6 +47,7 @@
 	'tx_dlf_metadata' => $extensionPath.'plugins/metadata/class.tx_dlf_metadata.php',
 	'tx_dlf_navigation' => $extensionPath.'plugins/navigation/class.tx_dlf_navigation.php',
 	'tx_dlf_oai' => $extensionPath.'plugins/oai/class.tx_dlf_oai.php',
+	'tx_dlf_pagegrid' => $extensionPath.'plugins/pagegrid/class.tx_dlf_pagegrid.php',
 	'tx_dlf_pageview' => $extensionPath.'plugins/pageview/class.tx_dlf_pageview.php',
 	'tx_dlf_search' => $extensionPath.'plugins/search/class.tx_dlf_search.php',
 	'tx_dlf_search_suggest' => $extensionPath.'plugins/search/class.tx_dlf_search_suggest.php',

=== modified file 'dlf/ext_localconf.php'
--- dlf/ext_localconf.php	2012-08-22 19:22:29 +0000
+++ dlf/ext_localconf.php	2012-09-25 14:14:21 +0000
@@ -37,6 +37,8 @@
 
 t3lib_extMgm::addPItoST43($_EXTKEY, 'plugins/oai/class.tx_dlf_oai.php', '_oai', 'list_type', FALSE);
 
+t3lib_extMgm::addPItoST43($_EXTKEY, 'plugins/pagegrid/class.tx_dlf_pagegrid.php', '_pagegrid', 'list_type', TRUE);
+
 t3lib_extMgm::addPItoST43($_EXTKEY, 'plugins/pageview/class.tx_dlf_pageview.php', '_pageview', 'list_type', TRUE);
 
 t3lib_extMgm::addPItoST43($_EXTKEY, 'plugins/search/class.tx_dlf_search.php', '_search', 'list_type', TRUE);

=== modified file 'dlf/ext_tables.php'
--- dlf/ext_tables.php	2012-09-15 16:05:08 +0000
+++ dlf/ext_tables.php	2012-09-25 14:14:21 +0000
@@ -276,6 +276,15 @@
 t3lib_extMgm::addPlugin(array('LLL:EXT:dlf/locallang.xml:tt_content.dlf_oai', $_EXTKEY.'_oai'), 'list_type');
 
 t3lib_extMgm::addPiFlexFormValue($_EXTKEY.'_oai', 'FILE:EXT:'.$_EXTKEY.'/plugins/oai/flexform.xml');
+
+// Plugin "pagegrid".
+$TCA['tt_content']['types']['list']['subtypes_excludelist'][$_EXTKEY.'_pagegrid'] = 'layout,select_key,pages,recursive';
+
+$TCA['tt_content']['types']['list']['subtypes_addlist'][$_EXTKEY.'_pagegrid'] = 'pi_flexform';
+
+t3lib_extMgm::addPlugin(array('LLL:EXT:dlf/locallang.xml:tt_content.dlf_pagegrid', $_EXTKEY.'_pagegrid'), 'list_type');
+
+t3lib_extMgm::addPiFlexFormValue($_EXTKEY.'_pagegrid', 'FILE:EXT:'.$_EXTKEY.'/plugins/pagegrid/flexform.xml');
 
 // Plugin "pageview".
 $TCA['tt_content']['types']['list']['subtypes_excludelist'][$_EXTKEY.'_pageview'] = 'layout,select_key,pages,recursive';

=== modified file 'dlf/locallang.xml'
--- dlf/locallang.xml	2012-09-17 08:23:30 +0000
+++ dlf/locallang.xml	2012-09-25 14:14:21 +0000
@@ -116,6 +116,7 @@
 			<label index="tt_content.dlf_metadata">DLF: Metadata</label>
 			<label index="tt_content.dlf_navigation">DLF: Navigation</label>
 			<label index="tt_content.dlf_oai">DLF: OAI-PMH Interface</label>
+			<label index="tt_content.dlf_pagegrid">DLF: Page Grid</label>
 			<label index="tt_content.dlf_pageview">DLF: Page View</label>
 			<label index="tt_content.dlf_search">DLF: Search</label>
 			<label index="tt_content.dlf_statistics">DLF: Statistics</label>
@@ -277,6 +278,7 @@
 			<label index="tt_content.dlf_metadata">DLF: Metadaten</label>
 			<label index="tt_content.dlf_navigation">DLF: Navigation</label>
 			<label index="tt_content.dlf_oai">DLF: OAI-PMH-Schnittstelle</label>
+			<label index="tt_content.dlf_pagegrid">DLF: Seiten-Raster</label>
 			<label index="tt_content.dlf_pageview">DLF: Seitenansicht</label>
 			<label index="tt_content.dlf_search">DLF: Suche</label>
 			<label index="tt_content.dlf_statistics">DLF: Statistik</label>

=== added directory 'dlf/plugins/pagegrid'
=== added file 'dlf/plugins/pagegrid/class.tx_dlf_pagegrid.php'
--- dlf/plugins/pagegrid/class.tx_dlf_pagegrid.php	1970-01-01 00:00:00 +0000
+++ dlf/plugins/pagegrid/class.tx_dlf_pagegrid.php	2012-09-25 14:14:21 +0000
@@ -0,0 +1,252 @@
+<?php
+/***************************************************************
+*  Copyright notice
+*
+*  (c) 2012 Henrik Lochmann <[e-mail]>
+*  All rights reserved
+*
+*  This script is part of the TYPO3 project. The TYPO3 project is
+*  free software; you can redistribute it and/or modify
+*  it under the terms of the GNU General Public License as published by
+*  the Free Software Foundation; either version 2 of the License, or
+*  (at your option) any later version.
+*
+*  The GNU General Public License can be found at
+*  http://www.gnu.org/copyleft/gpl.html.
+*
+*  This script is distributed in the hope that it will be useful,
+*  but WITHOUT ANY WARRANTY; without even the implied warranty of
+*  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+*  GNU General Public License for more details.
+*
+*  This copyright notice MUST APPEAR in all copies of the script!
+***************************************************************/
+
+/**
+ * [CLASS/FUNCTION INDEX of SCRIPT]
+ */
+
+/**
+ * Plugin 'DLF: Page Grid' for the 'dlf' extension.
+ *
+ * @author	Henrik Lochmann <[e-mail]>
+ * @copyright	Copyright (c) 2012, Zeutschel GmbH
+ * @package	TYPO3
+ * @subpackage	tx_dlf
+ * @access	public
+ */
+class tx_dlf_pagegrid extends tx_dlf_plugin {
+
+	public $scriptRelPath = 'plugins/pagegrid/class.tx_dlf_pagegrid.php';
+
+	/**
+	 * Renders thumbnail and page number for one page of the currently shown document.
+	 *
+	 * @access	protected
+	 *
+	 * @param	integer		$number: The page to render
+	 * @param	string		$template: Parsed template subpart
+	 *
+	 * @return	string		The rendered entry ready for output
+	 */
+	protected function getEntry($number, $template) {
+	
+		$markerArray = array();
+
+		$thumbnailFile = $this->doc->getFileLocation($this->doc->physicalPagesInfo[$this->doc->physicalPages[$number]]['files'][strtolower($this->conf['fileGrpThumbs'])]);
+		 
+		$markerArray['###THUMBNAIL###'] = '<a href="'.$this->pi_linkTP_keepPIvars_url(array (
+				'page' => $number, 
+				'pointer' => NULL // reset pointer: page has priority on page change
+				), TRUE, FALSE, $this->conf['targetPid']).'"><img src="'.$thumbnailFile.'" /></a>';
+	
+		$markerArray['###PAGE###'] = sprintf($this->pi_getLL('page'), $number);
+	
+		return $this->cObj->substituteMarkerArray($template, $markerArray);
+	
+	}
+	
+	/**
+	 * Renders the page browser, which shows itemCount pages beside the current page.
+	 *
+	 * @access	protected
+	 *
+	 * @param	integer		$itemCount: The number of page links to be shown beside the currently selected page
+	 * 
+	 * @return	string		The rendered page browser ready for output
+	 */
+	protected function getPagebrowser($itemCount = 3) {
+
+		// Get overall number of pages.
+		$maxPages = intval(ceil($this->doc->numPages / $this->conf['limit']));
+
+		// Return empty pagebrowser if there is just one page.
+		if ($maxPages < 2) {
+
+			return '';
+
+		}
+
+		// Get separator.
+		$separator = $this->pi_getLL('separator');
+
+		// Add link to previous page.
+		if ($this->piVars['pointer'] > 0) {
+
+			$output = $this->pi_linkTP_keepPIvars($this->pi_getLL('firstPage'), array ('pointer' => 0), TRUE);
+			
+			$output .= $this->pi_linkTP_keepPIvars($this->pi_getLL('prevPage'), array ('pointer' => $this->piVars['pointer'] - 1), TRUE).$separator;
+
+		} else {
+
+			$output = $this->pi_getLL('firstPage');
+
+			$output .= $this->pi_getLL('prevPage').$separator;
+
+		}
+
+		$lowerLimit = max($this->piVars['pointer'] - $itemCount, 0);
+		
+		if ($this->piVars['pointer'] + $itemCount >= $maxPages) {
+			
+			$lowerLimit -= max(($this->piVars['pointer'] + $itemCount) - ($maxPages - 1), 0);
+			
+		}
+		
+		
+		for ($i = $lowerLimit; $i < ($lowerLimit + 2 * $itemCount + 1) && $i < $maxPages; $i++) {
+			
+			if ($this->piVars['pointer'] != $i) {
+			
+				$output .= $this->pi_linkTP_keepPIvars(sprintf('%d', $i + 1), array ('pointer' => $i), TRUE).$separator;
+			
+			} else {
+			
+				$output .= '<strong>'.sprintf('%d', $i + 1).'</strong>'.$separator;
+			
+			}
+			
+		}
+		
+		// Add link to next page.
+		if ($this->piVars['pointer'] < $maxPages - 1) {
+
+			$output .= $this->pi_linkTP_keepPIvars($this->pi_getLL('nextPage'), array ('pointer' => $this->piVars['pointer'] + 1), TRUE);
+			
+			$output .= $this->pi_linkTP_keepPIvars($this->pi_getLL('lastPage'), array ('pointer' => $maxPages - 1), TRUE);
+
+		} else {
+
+			$output .= $this->pi_getLL('nextPage');
+			
+			$output .= $this->pi_getLL('lastPage');
+
+		}
+
+		return $output;
+
+	}
+
+	/**
+	 * The main method of the PlugIn
+	 *
+	 * @access	public
+	 *
+	 * @param	string		$content: The PlugIn content
+	 * @param	array		$conf: The PlugIn configuration
+	 *
+	 * @return	string		The content that is displayed on the website
+	 */
+	public function main($content, $conf) {
+
+		$this->init($conf);
+
+		// Don't cache the output.
+		$this->setCache(FALSE);
+
+		$this->loadDocument();
+		
+		if ($this->doc === NULL || $this->doc->numPages < 1) {
+		
+			// Quit without doing anything if required variables are not set.
+			return $content;
+		
+		} else {
+		
+			// Set default values for page if not set.
+			$this->piVars['pointer'] = t3lib_div::intInRange($this->piVars['pointer'], 0, $this->doc->numPages, 0);
+		
+		}
+		
+		// Load template file.
+		if (!empty($this->conf['templateFile'])) {
+
+			$this->template = $this->cObj->getSubpart($this->cObj->fileResource($this->conf['templateFile']), '###TEMPLATE###');
+
+		} else {
+
+			$this->template = $this->cObj->getSubpart($this->cObj->fileResource('EXT:dlf/plugins/pagegrid/template.tmpl'), '###TEMPLATE###');
+
+		}
+
+		$entryTemplate = $this->cObj->getSubpart($this->template, '###ENTRY###');
+		
+		if (empty($entryTemplate)) {
+		
+			if (TYPO3_DLOG) {
+			
+				t3lib_div::devLog('[tx_dlf_pagegrid->main('.$content.', [data])] Incomplete plugin configuration: entry template missing.', $this->extKey, SYSLOG_SEVERITY_WARNING, $conf);
+			
+			}
+			
+			// Quit without doing anything if required variables are not set.
+			return $content;
+		
+		}
+		
+		$actEntryTemplate = $this->cObj->getSubpart($this->template, '###ACT_ENTRY###');
+		
+		// Set some variable defaults.
+		if (!empty($this->piVars['pointer']) && (($this->piVars['pointer'] * $this->conf['limit']) + 1) <= $this->doc->numPages) {
+
+			$this->piVars['pointer'] = max(intval($this->piVars['pointer']), 0);
+
+		} else if (!empty($this->piVars['page'])) {
+			
+			$page = max(intval($this->piVars['page']), 0);
+			
+			$this->piVars['pointer'] = intval(floor($page / $this->conf['limit']));
+
+		} else {
+
+			$this->piVars['pointer'] = 0;
+
+		}
+
+		// Iterate through visible page set and display thumbnails.
+		for ($i = max($this->piVars['pointer'] * $this->conf['limit'], 1); $i < ($this->piVars['pointer'] + 1) * $this->conf['limit']; $i++) {
+			
+			$content .= $this->getEntry($i, $i == intval($this->piVars['page']) && !empty($actEntryTemplate) ?  $actEntryTemplate : $entryTemplate);
+
+		}
+
+		// Render page browser.
+		$markerArray['###PAGEBROWSER###'] = $this->getPageBrowser();
+
+		// Render entries into entry template.
+		$content = $this->cObj->substituteMarkerArray($this->cObj->substituteSubpart($this->template, '###ENTRY###', $content, TRUE), $markerArray);
+
+		// Remove act-entry template from result.
+		$content = $this->cObj->substituteSubpart($content, '###ACT_ENTRY###', '', TRUE);
+		
+		return $this->pi_wrapInBaseClass($content);
+
+	}
+
+}
+
+if (defined('TYPO3_MODE') && $TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['ext/dlf/plugins/pagegrid/class.tx_dlf_pagegrid.php'])	{
+	include_once($TYPO3_CONF_VARS[TYPO3_MODE]['XCLASS']['ext/dlf/plugins/pagegrid/class.tx_dlf_pagegrid.php']);
+}
+
+?>
\ No newline at end of file

=== added file 'dlf/plugins/pagegrid/flexform.xml'
--- dlf/plugins/pagegrid/flexform.xml	1970-01-01 00:00:00 +0000
+++ dlf/plugins/pagegrid/flexform.xml	2012-09-25 14:14:21 +0000
@@ -0,0 +1,72 @@
+<?xml version="1.0" encoding="utf-8" standalone="yes" ?>
+<T3DataStructure>
+	<meta>
+		<langDisable>1</langDisable>
+	</meta>
+	<sheets>
+		<sDEF>
+			<ROOT>
+				<TCEforms>
+					<sheetTitle>LLL:EXT:dlf/plugins/pagegrid/locallang.xml:tt_content.pi_flexform.sheet_general</sheetTitle>
+				</TCEforms>
+				<type>array</type>
+				<el>
+					<pages>
+						<TCEforms>
+							<exclude>1</exclude>
+							<label>LLL:EXT:lang/locallang_general.xml:LGL.startingpoint</label>
+							<config>
+								<type>group</type>
+								<internal_type>db</internal_type>
+								<allowed>pages</allowed>
+								<size>1</size>
+								<maxitems>1</maxitems>
+								<minitems>1</minitems>
+							</config>
+						</TCEforms>
+					</pages>
+					<limit>
+						<TCEforms>
+							<exclude>1</exclude>
+							<label>LLL:EXT:dlf/plugins/pagegrid/locallang.xml:tt_content.pi_flexform.limit</label>
+							<config>
+								<type>input</type>
+								<eval>required,num,int</eval>
+								<default>24</default>
+							</config>
+						</TCEforms>
+					</limit>
+					<targetPid>
+						<TCEforms>
+							<exclude>1</exclude>
+							<label>LLL:EXT:dlf/plugins/pagegrid/locallang.xml:tt_content.pi_flexform.targetPid</label>
+							<config>
+								<type>group</type>
+								<internal_type>db</internal_type>
+								<allowed>pages</allowed>
+								<size>1</size>
+								<maxitems>1</maxitems>
+								<minitems>1</minitems>
+							</config>
+						</TCEforms>
+					</targetPid>
+					<templateFile>
+						<TCEforms>
+							<exclude>1</exclude>
+							<label>LLL:EXT:dlf/plugins/pagegrid/locallang.xml:tt_content.pi_flexform.templateFile</label>
+							<config>
+								<type>group</type>
+								<internal_type>file_reference</internal_type>
+								<allowed>tmpl,tpl,html,htm,txt</allowed>
+								<size>1</size>
+								<maxitems>1</maxitems>
+								<minitems>0</minitems>
+								<disable_controls>upload</disable_controls>
+							</config>
+						</TCEforms>
+					</templateFile>
+				</el>
+			</ROOT>
+		</sDEF>
+	</sheets>
+</T3DataStructure>
\ No newline at end of file

=== added file 'dlf/plugins/pagegrid/locallang.xml'
--- dlf/plugins/pagegrid/locallang.xml	1970-01-01 00:00:00 +0000
+++ dlf/plugins/pagegrid/locallang.xml	2012-09-25 14:14:21 +0000
@@ -0,0 +1,33 @@
+<?xml version="1.0" encoding="utf-8" standalone="yes" ?>
+<T3locallang>
+	<meta type="array">
+		<type>module</type>
+		<description>Language labels for plugin tx_dlf_pagegrid</description>
+	</meta>
+	<data type="array">
+		<languageKey index="default" type="array">
+			<label index="tt_content.pi_flexform.sheet_general">Options</label>
+			<label index="tt_content.pi_flexform.limit">Previews per page</label>
+			<label index="tt_content.pi_flexform.targetPid">Target page (with "DLF: Page View" plugin)</label>
+			<label index="tt_content.pi_flexform.templateFile">Template file</label>
+			<label index="firstPage">&#171;</label>
+			<label index="prevPage">&#8592;</label>
+			<label index="nextPage">&#8594;</label>
+			<label index="lastPage">&#187;</label>
+			<label index="page">Page %d</label>
+			<label index="separator"> - </label>
+		</languageKey>
+		<languageKey index="de" type="array">
+			<label index="tt_content.pi_flexform.sheet_general">Einstellungen</label>
+			<label index="tt_content.pi_flexform.limit">Vorschaubilder pro Seite</label>
+			<label index="tt_content.pi_flexform.targetPid">Zielseite (mit Plugin "DLF: Seitenansicht")</label>
+			<label index="tt_content.pi_flexform.templateFile">HTML-Template</label>
+			<label index="firstPage">&#171;</label>
+			<label index="prevPage">&#8592;</label>
+			<label index="nextPage">&#8594;</label>
+			<label index="lastPage">&#187;</label>
+			<label index="page">Seite %d</label>
+			<label index="separator"> - </label>
+		</languageKey>
+	</data>
+</T3locallang>
\ No newline at end of file

=== added file 'dlf/plugins/pagegrid/template.tmpl'
--- dlf/plugins/pagegrid/template.tmpl	1970-01-01 00:00:00 +0000
+++ dlf/plugins/pagegrid/template.tmpl	2012-09-25 14:14:21 +0000
@@ -0,0 +1,17 @@
+<!-- ###TEMPLATE### -->
+<div class="tx-dlf-pagegrid-pagebrowser">###PAGEBROWSER###</div>
+<div class="tx-dlf-pagegrid-grid">
+	<!-- ###ENTRY### -->
+	<div class="tx-dlf-pagegrid-item" style="float:left;">
+		<div>###THUMBNAIL###</div>
+		<div>###PAGE###</div>
+	</div>
+	<!-- ###ENTRY### -->
+	<!-- ###ACT_ENTRY### -->
+	<div class="tx-dlf-pagegrid-item-act" style="float:left;">
+		<div>###THUMBNAIL###</div>
+		<div>###PAGE###</div>
+	</div>
+	<!-- ###ACT_ENTRY### -->
+</div>
+<!-- ###TEMPLATE### -->
\ No newline at end of file