/**
* 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);
// Disable caching for this plugin.
$this->setCache(FALSE);
// Quit without doing anything if required variables are not set.
if (empty($this->conf['solrcore'])) {
if (TYPO3_DLOG) {
\TYPO3\CMS\Core\Utility\GeneralUtility::devLog('[tx_dlf_search->main(' . $content . ', [data])] Incomplete plugin configuration', $this->extKey, SYSLOG_SEVERITY_WARNING, $conf);
}
return $content;
}
if (!isset($this->piVars['query']) && empty($this->piVars['extQuery'])) {
// Add javascript for search suggestions if enabled and jQuery autocompletion is available.
if (!empty($this->conf['suggest'])) {
$this->addAutocompleteJS();
}
// 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/search/template.tmpl'), '###TEMPLATE###');
}
// Configure @action URL for form.
$linkConf = array('parameter' => $GLOBALS['TSFE']->id, 'forceAbsoluteUrl' => 1);
// Fill markers.
$markerArray = array('###ACTION_URL###' => $this->cObj->typoLink_URL($linkConf), '###LABEL_QUERY###' => $this->pi_getLL('label.query'), '###LABEL_SUBMIT###' => $this->pi_getLL('label.submit'), '###FIELD_QUERY###' => $this->prefixId . '[query]', '###QUERY###' => '', '###FULLTEXTSWITCH###' => $this->addFulltextSwitch(), '###FIELD_DOC###' => $this->conf['searchIn'] == 'document' || $this->conf['searchIn'] == 'all' ? $this->addCurrentDocument() : '', '###FIELD_COLL###' => $this->conf['searchIn'] == 'collection' || $this->conf['searchIn'] == 'all' ? $this->addCurrentCollection() : '', '###ADDITIONAL_INPUTS###' => $this->addEncryptedCoreName(), '###FACETS_MENU###' => $this->addFacetsMenu());
// Get additional fields for extended search.
$extendedSearch = $this->addExtendedSearch();
// Display search form.
$content .= $this->cObj->substituteSubpart($this->cObj->substituteMarkerArray($this->template, $markerArray), '###EXT_SEARCH_ENTRY###', $extendedSearch);
return $this->pi_wrapInBaseClass($content);
} else {
// Instantiate search object.
$solr = tx_dlf_solr::getInstance($this->conf['solrcore']);
if (!$solr->ready) {
if (TYPO3_DLOG) {
\TYPO3\CMS\Core\Utility\GeneralUtility::devLog('[tx_dlf_search->main(' . $content . ', [data])] Apache Solr not available', $this->extKey, SYSLOG_SEVERITY_ERROR, $conf);
}
return $content;
}
// Build label for result list.
$label = $this->pi_getLL('search', '', TRUE);
if (!empty($this->piVars['query'])) {
$label .= htmlspecialchars(sprintf($this->pi_getLL('for', ''), $this->piVars['query']));
}
// Prepare query parameters.
$params = array();
// Set search query.
if (!empty($this->conf['fulltext']) && !empty($this->piVars['fulltext'])) {
// Search in fulltext field if applicable.
$query = 'fulltext:(' . tx_dlf_solr::escapeQuery($this->piVars['query']) . ')';
// Add highlighting for fulltext.
$params['hl'] = 'true';
$params['hl.fl'] = 'fulltext';
} else {
// Retain given search field if valid.
$query = tx_dlf_solr::escapeQueryKeepField($this->piVars['query'], $this->conf['pages']);
}
// Add extended search query.
if (!empty($this->piVars['extQuery']) && is_array($this->piVars['extQuery'])) {
$allowedOperators = array('AND', 'OR', 'NOT');
$allowedFields = \TYPO3\CMS\Core\Utility\GeneralUtility::trimExplode(',', $this->conf['extendedFields'], TRUE);
for ($i = 0; $i < count($this->piVars['extQuery']); $i++) {
if (!empty($this->piVars['extQuery'][$i])) {
if (in_array($this->piVars['extOperator'][$i], $allowedOperators) && in_array($this->piVars['extField'][$i], $allowedFields)) {
if (!empty($query)) {
$query .= ' ' . $this->piVars['extOperator'][$i] . ' ';
}
$query .= tx_dlf_indexing::getIndexFieldName($this->piVars['extField'][$i], $this->conf['pages']) . ':(' . tx_dlf_solr::escapeQuery($this->piVars['extQuery'][$i]) . ')';
}
}
}
}
// Add filter query for faceting.
if (!empty($this->piVars['fq'])) {
$params['fq'] = $this->piVars['fq'];
}
// Add filter query for in-document searching.
if ($this->conf['searchIn'] == 'document' || $this->conf['searchIn'] == 'all') {
if (!empty($this->piVars['id']) && \TYPO3\CMS\Core\Utility\MathUtility::canBeInterpretedAsInteger($this->piVars['id'])) {
$params['fq'][] = 'uid:(' . $this->piVars['id'] . ') OR partof:(' . $this->piVars['id'] . ')';
$label .= htmlspecialchars(sprintf($this->pi_getLL('in', ''), tx_dlf_document::getTitle($this->piVars['id'])));
}
}
// Add filter query for in-collection searching.
if ($this->conf['searchIn'] == 'collection' || $this->conf['searchIn'] == 'all') {
if (!empty($this->piVars['collection']) && \TYPO3\CMS\Core\Utility\MathUtility::canBeInterpretedAsInteger($this->piVars['collection'])) {
$index_name = tx_dlf_helper::getIndexName($this->piVars['collection'], 'tx_dlf_collections', $this->conf['pages']);
$params['fq'][] = 'collection_faceting:("' . tx_dlf_solr::escapeQuery($index_name) . '")';
$label .= sprintf($this->pi_getLL('in', '', TRUE), tx_dlf_helper::translate($index_name, 'tx_dlf_collections', $this->conf['pages']));
}
}
// Add filter query for collection restrictions.
if ($this->conf['collections']) {
$collIds = explode(',', $this->conf['collections']);
$collIndexNames = array();
foreach ($collIds as $collId) {
$collIndexNames[] = tx_dlf_solr::escapeQuery(tx_dlf_helper::getIndexName(intval($collId), 'tx_dlf_collections', $this->conf['pages']));
}
// Last value is fake and used for distinction in $this->addCurrentCollection()
$params['fq'][] = 'collection_faceting:("' . implode('" OR "', $collIndexNames) . '" OR "FakeValueForDistinction")';
}
// Set search parameters.
$solr->limit = max(intval($this->conf['limit']), 1);
$solr->cPid = $this->conf['pages'];
$solr->params = $params;
// Perform search.
$results = $solr->search($query);
$results->metadata = array('label' => $label, 'description' => '<p class="tx-dlf-search-numHits">' . htmlspecialchars(sprintf($this->pi_getLL('hits', ''), $solr->numberOfHits, count($results))) . '</p>', 'thumbnail' => '', 'options' => $results->metadata['options']);
$results->save();
// Clean output buffer.
\TYPO3\CMS\Core\Utility\GeneralUtility::cleanOutputBuffers();
// Keep some plugin variables.
$linkConf['parameter'] = $this->conf['targetPid'];
if (!empty($this->piVars['order'])) {
$linkConf['additionalParams'] = \TYPO3\CMS\Core\Utility\GeneralUtility::implodeArrayForUrl($this->prefixId, array('order' => $this->piVars['order'], 'asc' => !empty($this->piVars['asc']) ? '1' : '0'), '', TRUE, FALSE);
}
// Send headers.
header('Location: ' . \TYPO3\CMS\Core\Utility\GeneralUtility::locationHeaderUrl($this->cObj->typoLink_URL($linkConf)));
// Flush output buffer and end script processing.
ob_end_flush();
exit;
}
}
/**
* The main method of the PlugIn
*
* @access public
*
* @param string $content: The PlugIn content
* @param array $conf: The PlugIn configuration
*
* @return void
*/
public function main($content, $conf)
{
$this->init($conf);
// Don't cache the output.
$this->setCache(FALSE);
// Create XML document.
$rss = new DOMDocument('1.0', 'utf-8');
// Add mandatory root element.
$root = $rss->createElement('rss');
$root->setAttribute('version', '2.0');
// Add channel element.
$channel = $rss->createElement('channel');
$channel->appendChild($rss->createElement('title', htmlspecialchars($this->conf['title'], ENT_NOQUOTES, 'UTF-8')));
$channel->appendChild($rss->createElement('link', htmlspecialchars(t3lib_div::locationHeaderUrl($this->pi_linkTP_keepPIvars_url()), ENT_NOQUOTES, 'UTF-8')));
if (!empty($this->conf['description'])) {
$channel->appendChild($rss->createElement('description', htmlspecialchars($this->conf['description'], ENT_QUOTES, 'UTF-8')));
}
$result = $GLOBALS['TYPO3_DB']->exec_SELECTquery('tx_dlf_libraries.label AS label', 'tx_dlf_libraries', 'tx_dlf_libraries.pid=' . intval($this->conf['pages']) . ' AND tx_dlf_libraries.uid=' . intval($this->conf['library']) . tx_dlf_helper::whereClause('tx_dlf_libraries'), '', '', '1');
if ($GLOBALS['TYPO3_DB']->sql_num_rows($result)) {
$resArray = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($result);
$channel->appendChild($rss->createElement('copyright', htmlspecialchars($resArray['label'], ENT_NOQUOTES, 'UTF-8')));
}
$channel->appendChild($rss->createElement('pubDate', date('r', $GLOBALS['EXEC_TIME'])));
$channel->appendChild($rss->createElement('generator', htmlspecialchars($this->conf['useragent'], ENT_NOQUOTES, 'UTF-8')));
// Add item elements.
if (!$this->conf['excludeOther'] || empty($this->piVars['collection']) || t3lib_div::inList($this->conf['collections'], $this->piVars['collection'])) {
$additionalWhere = '';
// Check for pre-selected collections.
if (!empty($this->piVars['collection'])) {
$additionalWhere = ' AND tx_dlf_collections.uid=' . intval($this->piVars['collection']);
} elseif (!empty($this->conf['collections'])) {
$additionalWhere = ' AND tx_dlf_collections.uid IN (' . $GLOBALS['TYPO3_DB']->cleanIntList($this->conf['collections']) . ')';
}
$result = $GLOBALS['TYPO3_DB']->exec_SELECT_mm_query('tx_dlf_documents.uid AS uid,tx_dlf_documents.partof AS partof,tx_dlf_documents.title AS title,tx_dlf_documents.volume AS volume,tx_dlf_documents.author AS author,tx_dlf_documents.record_id AS guid,tx_dlf_documents.tstamp AS tstamp,tx_dlf_documents.crdate AS crdate', 'tx_dlf_documents', 'tx_dlf_relations', 'tx_dlf_collections', 'AND tx_dlf_documents.pid=' . intval($this->conf['pages']) . ' AND tx_dlf_relations.ident=' . $GLOBALS['TYPO3_DB']->fullQuoteStr('docs_colls', 'tx_dlf_relations') . ' AND tx_dlf_collections.pid=' . intval($this->conf['pages']) . $additionalWhere . tx_dlf_helper::whereClause('tx_dlf_documents') . tx_dlf_helper::whereClause('tx_dlf_collections'), 'tx_dlf_documents.uid', 'tx_dlf_documents.tstamp DESC', intval($this->conf['limit']));
if ($GLOBALS['TYPO3_DB']->sql_num_rows($result)) {
// Add each record as item element.
while ($resArray = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($result)) {
$item = $rss->createElement('item');
$title = '';
// Get title of superior document.
if ((empty($resArray['title']) || !empty($this->conf['prependSuperiorTitle'])) && !empty($resArray['partof'])) {
$superiorTitle = tx_dlf_document::getTitle($resArray['partof'], TRUE);
if (!empty($superiorTitle)) {
$title .= '[' . $superiorTitle . ']';
}
}
// Get title of document.
if (!empty($resArray['title'])) {
$title .= ' ' . $resArray['title'];
}
// Set default title if empty.
if (empty($title)) {
$title = $this->pi_getLL('noTitle');
}
// Append volume information.
if (!empty($resArray['volume'])) {
$title .= ', ' . $this->pi_getLL('volume') . ' ' . $resArray['volume'];
}
// Is this document new or updated?
if ($resArray['crdate'] == $resArray['tstamp']) {
$title = $this->pi_getLL('new') . ' ' . trim($title);
} else {
$title = $this->pi_getLL('update') . ' ' . trim($title);
}
$item->appendChild($rss->createElement('title', htmlspecialchars($title, ENT_NOQUOTES, 'UTF-8')));
// Add link.
$linkConf = array('parameter' => $this->conf['targetPid'], 'forceAbsoluteUrl' => 1, 'additionalParams' => t3lib_div::implodeArrayForUrl($this->prefixId, array('id' => $resArray['uid']), '', TRUE, FALSE));
$item->appendChild($rss->createElement('link', htmlspecialchars($this->cObj->typoLink_URL($linkConf), ENT_NOQUOTES, 'UTF-8')));
// Add author if applicable.
if (!empty($resArray['author'])) {
$item->appendChild($rss->createElement('author', htmlspecialchars($resArray['author'], ENT_NOQUOTES, 'UTF-8')));
}
// Add online publication date.
$item->appendChild($rss->createElement('pubDate', date('r', $resArray['crdate'])));
// Add internal record identifier.
$item->appendChild($rss->createElement('guid', htmlspecialchars($resArray['guid'], ENT_NOQUOTES, 'UTF-8')));
$channel->appendChild($item);
}
}
}
$root->appendChild($channel);
// Build XML output.
$rss->appendChild($root);
$content = $rss->saveXML();
// Clean output buffer.
t3lib_div::cleanOutputBuffers();
// Send headers.
header('HTTP/1.1 200 OK');
header('Cache-Control: no-cache');
header('Content-Length: ' . strlen($content));
header('Content-Type: application/rss+xml; charset=utf-8');
header('Date: ' . date('r', $GLOBALS['EXEC_TIME']));
header('Expires: ' . date('r', $GLOBALS['EXEC_TIME']));
echo $content;
// Flush output buffer and end script processing.
ob_end_flush();
exit;
}
/**
* Renders all sub-entries of one entry
*
* @access protected
*
* @param integer $number: The number of the entry
* @param string $template: Parsed template subpart
*
* @return string The rendered entries ready for output
*/
protected function getSubEntries($number, $template)
{
$content = '';
foreach ($this->list[$number]['subparts'] as $subpart) {
$markerArray['###SUBMETADATA###'] = '';
$markerArray['###SUBTHUMBNAIL###'] = '';
$markerArray['###SUBPREVIEW###'] = '';
$imgAlt = '';
foreach ($this->metadata as $index_name => $metaConf) {
$parsedValue = '';
$fieldwrap = $this->parseTS($metaConf['wrap']);
do {
$value = @array_shift($subpart['metadata'][$index_name]);
// Link title to pageview.
if ($index_name == 'title') {
// Get title of parent document if needed.
if (empty($value) && $this->conf['getTitle']) {
$superiorTitle = tx_dlf_document::getTitle($subpart['uid'], TRUE);
if (!empty($superiorTitle)) {
$value = '[' . $superiorTitle . ']';
}
}
// Set fake title if still not present.
if (empty($value)) {
$value = $this->pi_getLL('noTitle');
}
$imgAlt = htmlspecialchars($value);
$additionalParams = array('id' => $subpart['uid'], 'page' => $subpart['page']);
$conf = array('useCacheHash' => 1, 'parameter' => $this->conf['targetPid'], 'additionalParams' => \TYPO3\CMS\Core\Utility\GeneralUtility::implodeArrayForUrl($this->prefixId, $additionalParams, '', TRUE, FALSE));
$value = $this->cObj->typoLink(htmlspecialchars($value), $conf);
// Translate name of holding library.
} elseif ($index_name == 'owner' && !empty($value)) {
$value = htmlspecialchars(tx_dlf_helper::translate($value, 'tx_dlf_libraries', $this->conf['pages']));
// Translate document type.
} elseif ($index_name == 'type' && !empty($value)) {
$_value = $value;
$value = htmlspecialchars(tx_dlf_helper::translate($value, 'tx_dlf_structures', $this->conf['pages']));
// Add page number for single pages.
if ($_value == 'page') {
$value .= ' ' . intval($subpart['page']);
}
// Translate ISO 639 language code.
} elseif ($index_name == 'language' && !empty($value)) {
$value = htmlspecialchars(tx_dlf_helper::getLanguageName($value));
} elseif (!empty($value)) {
$value = htmlspecialchars($value);
}
$value = $this->cObj->stdWrap($value, $fieldwrap['value.']);
if (!empty($value)) {
$parsedValue .= $value;
}
} while (count($subpart['metadata'][$index_name]));
if (!empty($parsedValue)) {
$field = $this->cObj->stdWrap(htmlspecialchars($metaConf['label']), $fieldwrap['key.']);
$field .= $parsedValue;
$markerArray['###SUBMETADATA###'] .= $this->cObj->stdWrap($field, $fieldwrap['all.']);
}
}
// Add thumbnail.
if (!empty($subpart['thumbnail'])) {
$markerArray['###SUBTHUMBNAIL###'] = '<img alt="' . $imgAlt . '" src="' . $subpart['thumbnail'] . '" />';
}
// Add preview.
if (!empty($subpart['preview'])) {
$markerArray['###SUBPREVIEW###'] = $subpart['preview'];
}
$content .= $this->cObj->substituteMarkerArray($template['subentry'], $markerArray);
}
return $this->cObj->substituteSubpart($this->cObj->getSubpart($this->template, '###SUBTEMPLATE###'), '###SUBENTRY###', $content, TRUE);
}
/**
* Prepares the metadata array for output
*
* @access protected
*
* @param array $metadataArray: The metadata array
*
* @return string The metadata array ready for output
*/
protected function printMetadata(array $metadataArray)
{
// 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/metadata/template.tmpl'), '###TEMPLATE###');
}
$output = '';
$subpart['block'] = $this->cObj->getSubpart($this->template, '###BLOCK###');
// Get list of metadata to show.
$metaList = array();
$result = $GLOBALS['TYPO3_DB']->exec_SELECTquery('tx_dlf_metadata.index_name AS index_name,tx_dlf_metadata.is_listed AS is_listed,tx_dlf_metadata.wrap AS wrap', 'tx_dlf_metadata', 'tx_dlf_metadata.pid=' . intval($this->conf['pages']) . tx_dlf_helper::whereClause('tx_dlf_metadata'), '', 'tx_dlf_metadata.sorting', '');
while ($resArray = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($result)) {
if ($this->conf['showFull'] || $resArray['is_listed']) {
$metaList[$resArray['index_name']] = array('wrap' => $resArray['wrap'], 'label' => tx_dlf_helper::translate($resArray['index_name'], 'tx_dlf_metadata', $this->conf['pages']));
}
}
// Save original data array.
$cObjData = $this->cObj->data;
// Parse the metadata arrays.
foreach ($metadataArray as $metadata) {
$markerArray['###METADATA###'] = '';
// Reset content object's data array.
$this->cObj->data = $cObjData;
// Load all the metadata values into the content object's data array.
foreach ($metadata as $index_name => $value) {
if (is_array($value)) {
$this->cObj->data[$index_name] = implode($this->conf['separator'], $value);
} else {
$this->cObj->data[$index_name] = $value;
}
}
// Process each metadate.
foreach ($metaList as $index_name => $metaConf) {
$parsedValue = '';
$fieldwrap = $this->parseTS($metaConf['wrap']);
do {
$value = @array_shift($metadata[$index_name]);
if ($index_name == 'title') {
// Get title of parent document if needed.
if (empty($value) && $this->conf['getTitle'] && $this->doc->parentId) {
$superiorTitle = tx_dlf_document::getTitle($this->doc->parentId, TRUE);
if (!empty($superiorTitle)) {
$value = '[' . $superiorTitle . ']';
}
}
if (!empty($value)) {
$value = htmlspecialchars($value);
// Link title to pageview.
if ($this->conf['linkTitle'] && $metadata['_id']) {
$details = $this->doc->getLogicalStructure($metadata['_id']);
$value = $this->pi_linkTP($value, array($this->prefixId => array('id' => $this->doc->uid, 'page' => !empty($details['points']) ? intval($details['points']) : 1)), TRUE, $this->conf['targetPid']);
}
}
} elseif ($index_name == 'owner' && !empty($value)) {
// Translate name of holding library.
$value = htmlspecialchars(tx_dlf_helper::translate($value, 'tx_dlf_libraries', $this->conf['pages']));
} elseif ($index_name == 'type' && !empty($value)) {
// Translate document type.
$value = htmlspecialchars(tx_dlf_helper::translate($value, 'tx_dlf_structures', $this->conf['pages']));
} elseif ($index_name == 'collection' && !empty($value)) {
// Translate collection.
$value = htmlspecialchars(tx_dlf_helper::translate($value, 'tx_dlf_collections', $this->conf['pages']));
} elseif ($index_name == 'language' && !empty($value)) {
// Translate ISO 639 language code.
$value = htmlspecialchars(tx_dlf_helper::getLanguageName($value));
} elseif (!empty($value)) {
// Sanitize value for output.
$value = htmlspecialchars($value);
}
// Hook for getting a customized value (requested by SBB).
foreach ($this->hookObjects as $hookObj) {
if (method_exists($hookObj, 'printMetadata_customizeMetadata')) {
$hookObj->printMetadata_customizeMetadata($value);
}
}
$value = $this->cObj->stdWrap($value, $fieldwrap['value.']);
if (!empty($value)) {
$parsedValue .= $value;
}
} while (count($metadata[$index_name]));
if (!empty($parsedValue)) {
$field = $this->cObj->stdWrap(htmlspecialchars($metaConf['label']), $fieldwrap['key.']);
$field .= $parsedValue;
$markerArray['###METADATA###'] .= $this->cObj->stdWrap($field, $fieldwrap['all.']);
}
}
$output .= $this->cObj->substituteMarkerArray($subpart['block'], $markerArray);
}
return $this->cObj->substituteSubpart($this->template, '###BLOCK###', $output, TRUE);
}
