From e8ee00d40f0ca5c559e2a2a91e8e083901d33f5f Mon Sep 17 00:00:00 2001 From: Andriy Oprysko Date: Tue, 5 Mar 2019 15:21:34 +0200 Subject: [PATCH] [FEATURE] add ext. Solr support (#485) * [WIP] require composer * [TASK] implement solr url modifier * [TASK] make header template compatible with new solr * [TASK] add special configuration file for solr * [TASK] make suggest script compatible with new solr suggest * [TASK] remove url modifier for solr * [TASK] new TypoScript solr configuration * [TASK] changes in solr templates according to changes in solr 9 * [TASK] add backward compatibility template for document results * [TASK] remove comma and semicolon in suggest.js * [TASK] compile less and css * [TASK] mvoe suggest solr configuration --- .../development.docker.setupts | 7 +- .../Partials/Search/Form.html | 6 +- .../HeaderTopSearch/Partials/Search/Form.html | 8 +- .../Private/Extensions/Solr/Layouts/Main.html | 4 + .../Solr/Partials/Result/Document.html | 44 +++++++++ .../Solr/Templates/Search/Form.html | 9 ++ .../Solr/Templates/Search/Results.html | 4 +- .../TypoScript/Includes/suggest.typoscript | 32 ++++++ .../IndexConfiguration/solr_news.typoscript | 97 +++++++++++++++++++ .../Extensions/Solr/TypoScript/setup.ts | 35 ++++--- Resources/Public/css/main.js | 14 ++- Resources/Public/less/main.js | 14 ++- composer.json | 5 +- felayout_t3kit/dev/js/main/suggest.js | 14 ++- 14 files changed, 252 insertions(+), 41 deletions(-) create mode 100644 Resources/Private/Extensions/Solr/Layouts/Main.html create mode 100644 Resources/Private/Extensions/Solr/Partials/Result/Document.html create mode 100644 Resources/Private/Extensions/Solr/Templates/Search/Form.html create mode 100644 Resources/Private/Extensions/Solr/TypoScript/Includes/suggest.typoscript create mode 100644 Resources/Private/Extensions/Solr/TypoScript/IndexConfiguration/solr_news.typoscript diff --git a/Configuration/TypoScript/ApplicationContext/development.docker.setupts b/Configuration/TypoScript/ApplicationContext/development.docker.setupts index 63d193a9..a54eb5d9 100644 --- a/Configuration/TypoScript/ApplicationContext/development.docker.setupts +++ b/Configuration/TypoScript/ApplicationContext/development.docker.setupts @@ -1,6 +1,3 @@ -[applicationContext = Development/Docker] +#[applicationContext = Development/Docker] - # set solr host to t3kit_solr - plugin.tx_solr.solr.host = t3kit_solr - -[global] \ No newline at end of file +#[global] \ No newline at end of file diff --git a/Resources/Private/Extensions/Solr/HeaderMiddleSearch/Partials/Search/Form.html b/Resources/Private/Extensions/Solr/HeaderMiddleSearch/Partials/Search/Form.html index 6e8df22c..748c4aea 100644 --- a/Resources/Private/Extensions/Solr/HeaderMiddleSearch/Partials/Search/Form.html +++ b/Resources/Private/Extensions/Solr/HeaderMiddleSearch/Partials/Search/Form.html @@ -8,8 +8,10 @@
- - + + + +
diff --git a/Resources/Private/Extensions/Solr/HeaderTopSearch/Partials/Search/Form.html b/Resources/Private/Extensions/Solr/HeaderTopSearch/Partials/Search/Form.html index 05cb0d70..7cb5ae76 100644 --- a/Resources/Private/Extensions/Solr/HeaderTopSearch/Partials/Search/Form.html +++ b/Resources/Private/Extensions/Solr/HeaderTopSearch/Partials/Search/Form.html @@ -7,9 +7,11 @@
- - - + + + + +
{s:translate(key:'submit',default:'Search')}
diff --git a/Resources/Private/Extensions/Solr/Layouts/Main.html b/Resources/Private/Extensions/Solr/Layouts/Main.html new file mode 100644 index 00000000..33f1d0e6 --- /dev/null +++ b/Resources/Private/Extensions/Solr/Layouts/Main.html @@ -0,0 +1,4 @@ + +
+ +
\ No newline at end of file diff --git a/Resources/Private/Extensions/Solr/Partials/Result/Document.html b/Resources/Private/Extensions/Solr/Partials/Result/Document.html new file mode 100644 index 00000000..e3be43dd --- /dev/null +++ b/Resources/Private/Extensions/Solr/Partials/Result/Document.html @@ -0,0 +1,44 @@ + + + + +
  • + +
    +     + +
    {document.title}
    + +
    + + +

    {s:document.highlightResult(resultSet:resultSet, document:document, fieldName:'content')}

    + + +

    + : {document.fileMimeType}
    + : + +

      + +
    • {document.fileReferenceTitle}
      • +       + + +
    • {variant.fileReferenceTitle}
      • +       +       +
    +

    +     + +
    +
    • + +     diff --git a/Resources/Private/Extensions/Solr/Templates/Search/Form.html b/Resources/Private/Extensions/Solr/Templates/Search/Form.html new file mode 100644 index 00000000..ea8ea150 --- /dev/null +++ b/Resources/Private/Extensions/Solr/Templates/Search/Form.html @@ -0,0 +1,9 @@ + + + + + + + \ No newline at end of file diff --git a/Resources/Private/Extensions/Solr/Templates/Search/Results.html b/Resources/Private/Extensions/Solr/Templates/Search/Results.html index e70e4400..c6de9c8d 100644 --- a/Resources/Private/Extensions/Solr/Templates/Search/Results.html +++ b/Resources/Private/Extensions/Solr/Templates/Search/Results.html @@ -49,7 +49,7 @@

    - + @@ -65,7 +65,7 @@
    - + diff --git a/Resources/Private/Extensions/Solr/TypoScript/Includes/suggest.typoscript b/Resources/Private/Extensions/Solr/TypoScript/Includes/suggest.typoscript new file mode 100644 index 00000000..be5f4d45 --- /dev/null +++ b/Resources/Private/Extensions/Solr/TypoScript/Includes/suggest.typoscript @@ -0,0 +1,32 @@ +# Enable search field autocomplete/suggest +# Ajaxify the suggest/results +tx_solr_suggest = PAGE +tx_solr_suggest { + typeNum = 7384 + config { + disableAllHeaderCode = 1 + xhtml_cleaning = 0 + admPanel = 0 + additionalHeaders = Content-type: text/plain + no_cache = 0 + } + + 10 = USER + 10 { + userFunc = TYPO3\CMS\Extbase\Core\Bootstrap->run + extensionName = Solr + pluginName = pi_suggest + vendorName = ApacheSolrForTypo3 + controller = Suggest + action = suggest + } +} + +# Enable suggest +plugin.tx_solr.search { + suggest = 1 + suggest { + numberOfSuggestions = 10 + suggestField = spell + } +} diff --git a/Resources/Private/Extensions/Solr/TypoScript/IndexConfiguration/solr_news.typoscript b/Resources/Private/Extensions/Solr/TypoScript/IndexConfiguration/solr_news.typoscript new file mode 100644 index 00000000..c9cc03b6 --- /dev/null +++ b/Resources/Private/Extensions/Solr/TypoScript/IndexConfiguration/solr_news.typoscript @@ -0,0 +1,97 @@ + +plugin.tx_solr.index.queue { + + news = 1 + news { + table = tx_news_domain_model_news + + fields { + abstract = teaser + + author = author + authorEmail_stringS = author_email + + title = title + + datetime_stringS = TEXT + datetime_stringS { + field = datetime + date = d.m.Y H:i + } + + datetime_dateS = TEXT + datetime_dateS { + field = datetime + date = Y-m-d\TH:i:s\Z + } + + content = SOLR_CONTENT + content { + cObject = COA + cObject { + 10 = TEXT + 10 { + field = bodytext + noTrimWrap = || | + } + } + } + + category_stringM = SOLR_RELATION + category_stringM { + localField = categories + multiValue = 1 + } + + keywords = SOLR_MULTIVALUE + keywords { + field = keywords + } + + tags_stringM = SOLR_RELATION + tags_stringM { + localField = tags + multiValue = 1 + } + + url = CASE + url { + key.field = type + + # Internal + 1 = TEXT + 1 { + if.isTrue.field = internalurl + typolink.parameter.field = internalurl + typolink.useCacheHash = 1 + typolink.returnLast = url + } + + # External + 2 = TEXT + 2 { + if.isTrue.field = externalurl + field = externalurl + } + + default = TEXT + default { + typolink.parameter = {$themes.configuration.features.newsDefaultDetailPid} + typolink.additionalParams = &tx_news_pi1[controller]=News&tx_news_pi1[action]=detail&tx_news_pi1[news]={field:uid}&L={field:__solr_index_language} + typolink.additionalParams.insertData = 1 + typolink.useCacheHash = 1 + typolink.returnLast = url + } + } + } + + attachments = 1 + attachments { + fields = fal_related_files + fileExtensions = * + } + } + +} + +plugin.tx_solr.logging.indexing.queue.news = 1 diff --git a/Resources/Private/Extensions/Solr/TypoScript/setup.ts b/Resources/Private/Extensions/Solr/TypoScript/setup.ts index dea1fdb9..9b6773e6 100644 --- a/Resources/Private/Extensions/Solr/TypoScript/setup.ts +++ b/Resources/Private/Extensions/Solr/TypoScript/setup.ts @@ -7,7 +7,6 @@ plugin.tx_solr.enabled = {$themes.configuration.features.enableSolr} # Solr default ts setup -plugin.tx_solr.suggest = 1 plugin.tx_solr.search.faceting = 1 plugin.tx_solr.search.spellchecking = 1 @@ -15,7 +14,19 @@ plugin.tx_solr.search.results.resultsHighlighting = 1 plugin.tx_solr.search.results.resultsHighlighting.wrap = | plugin.tx_solr.search.sorting = 1 plugin.tx_solr.search.targetPage = {$themes.configuration.features.searchTargetPage} -plugin.tx_solr.solr.path = /solr/{$themes.configuration.features.solrBaseCoreName}_{$themes.languages.default.isoCode}/ + + +plugin.tx_solr.solr { + read.path = /solr/{$themes.configuration.features.solrBaseCoreName}_{$themes.languages.default.isoCodeShort}/ + write.path < .read.path +} + +[globalVar = GP:L > 0] + plugin.tx_solr.solr { + read.path = /solr/{$themes.configuration.features.solrBaseCoreName}_{$themes.languages.current.isoCodeShort}/ + write.path < .read.path + } +[end] # Add teaser to search query plugin.tx_solr.search.query.queryFields := addToList(abstract^39.0) @@ -78,7 +89,7 @@ plugin.tx_solr.search.faceting.facets.type { key.field = optionValue # pages pages = TEXT - pages.value = {LLL:EXT:lang/locallang_common.xlf:pages} + pages.value = {LLL:EXT:core/Resources/Private/Language/locallang_common.xlf:pages} pages.insertData = 1 # tx_news tx_news_domain_model_news = TEXT @@ -93,10 +104,6 @@ plugin.tx_solr.index.queue.pages.fields.category_stringM { multiValue = 1 } -# Change solr core if language other than default -[globalVar = GP:L > 0] - plugin.tx_solr.solr.path = /solr/{$themes.configuration.features.solrBaseCoreName}_{$themes.languages.current.isoCode}/ -[global] # Additional when solr is enabled [globalVar = LIT:1 = {$themes.configuration.features.enableSolr}] @@ -107,11 +114,11 @@ plugin.tx_solr.index.queue.pages.fields.category_stringM { ## Docker configuration [applicationContext = Development/Docker, Production/Docker] - plugin.tx_solr.solr.path = /solr/{$themes.configuration.features.solrBaseCoreName}_{$themes.languages.default.isoCodeShort}/ -[global] - -[globalVar = GP:L > 0] && [applicationContext = Development/Docker, Production/Docker] - plugin.tx_solr.solr.path = /solr/{$themes.configuration.features.solrBaseCoreName}_{$themes.languages.current.isoCodeShort}/ + # set solr host to t3kit_solr + plugin.tx_solr.solr { + read.host = t3kit_solr + write.host = t3kit_solr + } [global] # enable suggest on devices with touch support @@ -119,3 +126,7 @@ plugin.tx_solr.index.queue.pages.fields.category_stringM { # 1910 = TEXT # 1910.value = var forceEnableSuggest = false; #} + + + + \ No newline at end of file diff --git a/Resources/Public/css/main.js b/Resources/Public/css/main.js index 4f75a6fa..d70a1525 100644 --- a/Resources/Public/css/main.js +++ b/Resources/Public/css/main.js @@ -705,6 +705,7 @@ var mainSearchInputList = {} autoFirst: true }) var req = false + $(this).on('keyup.search.suggest', function (e) { var c = e.keyCode if (c === 13 || c === 27 || c === 38 || c === 40) { @@ -716,16 +717,19 @@ var mainSearchInputList = {} req = true $.ajax({ url: that.closest('form').data('suggest'), - dataType: 'json', + dataType: 'jsonp', + jsonp: 'tx_solr[callback]', data: { - termLowercase: that.val().toLowerCase(), - termOriginal: that.val(), - L: that.closest('form').find('input[name="L"]').val() + tx_solr: { + queryString: that.val().toLowerCase() + } }, success: function (data) { + var suggestions = data.suggestions || [] + req = false var arrr = [] - $.each(data, function (term) { + $.each(suggestions, function (term) { arrr.push(term) }) mainSearchInputList['searchItem' + index]._list = arrr diff --git a/Resources/Public/less/main.js b/Resources/Public/less/main.js index 4f75a6fa..d70a1525 100644 --- a/Resources/Public/less/main.js +++ b/Resources/Public/less/main.js @@ -705,6 +705,7 @@ var mainSearchInputList = {} autoFirst: true }) var req = false + $(this).on('keyup.search.suggest', function (e) { var c = e.keyCode if (c === 13 || c === 27 || c === 38 || c === 40) { @@ -716,16 +717,19 @@ var mainSearchInputList = {} req = true $.ajax({ url: that.closest('form').data('suggest'), - dataType: 'json', + dataType: 'jsonp', + jsonp: 'tx_solr[callback]', data: { - termLowercase: that.val().toLowerCase(), - termOriginal: that.val(), - L: that.closest('form').find('input[name="L"]').val() + tx_solr: { + queryString: that.val().toLowerCase() + } }, success: function (data) { + var suggestions = data.suggestions || [] + req = false var arrr = [] - $.each(data, function (term) { + $.each(suggestions, function (term) { arrr.push(term) }) mainSearchInputList['searchItem' + index]._list = arrr diff --git a/composer.json b/composer.json index 91523088..f2688d78 100644 --- a/composer.json +++ b/composer.json @@ -52,6 +52,7 @@ "pixelant/pxa-form-enhancement": "dev-master", "pixelant/pxa-cookie-bar": "~2.1.1", "friendsoftypo3/frontend-editing": "~1.4.3", - "clickstorm/cs_seo": "~4.0.0" - } + "clickstorm/cs_seo": "~4.0.0", + "apache-solr-for-typo3/solr": "^9.0" + } } diff --git a/felayout_t3kit/dev/js/main/suggest.js b/felayout_t3kit/dev/js/main/suggest.js index 5afa9bfc..65fe2c9f 100644 --- a/felayout_t3kit/dev/js/main/suggest.js +++ b/felayout_t3kit/dev/js/main/suggest.js @@ -19,6 +19,7 @@ var mainSearchInputList = {} autoFirst: true }) var req = false + $(this).on('keyup.search.suggest', function (e) { var c = e.keyCode if (c === 13 || c === 27 || c === 38 || c === 40) { @@ -30,16 +31,19 @@ var mainSearchInputList = {} req = true $.ajax({ url: that.closest('form').data('suggest'), - dataType: 'json', + dataType: 'jsonp', + jsonp: 'tx_solr[callback]', data: { - termLowercase: that.val().toLowerCase(), - termOriginal: that.val(), - L: that.closest('form').find('input[name="L"]').val() + tx_solr: { + queryString: that.val().toLowerCase() + } }, success: function (data) { + var suggestions = data.suggestions || [] + req = false var arrr = [] - $.each(data, function (term) { + $.each(suggestions, function (term) { arrr.push(term) }) mainSearchInputList['searchItem' + index]._list = arrr