[RELEASE] 11.5.6

This is a maintenance release for TYPO3 11.5 and the last release that supports Apache Solr 8.11. Next EXT:solr feature release for TYPO3 11.5 will be 11.6.0, it will contain support for Apache Solr 9 and some breaking improvements. This maintenance release for TYPO3 11.5 LTS contains: - [TASK] Remove unused field "cookie" in tx_solr_statistics - [BUGFIX:P:11.5] Broken IndexQueueModule.css asset path in backend - [BUGFIX:BP:11.5] Exception in CLI mode when using suggest TS example - [BUGFIX:BP:11.5] Ensure method return value of root-page-UID is an integer - [TASK:BP:11.5] Provide encryptionKey in unit tests - [DOCS] Make values of faceting.urlParameterStyle more clear - [BUGFIX] Handle if some tags are upper-case and strict-comparison - Update PageBrowserRangeViewHelper.php solves #3942 - [FEATURE:BP:11.5] Power up for magic filter `__pageSection` - [TASK] Add content stream check - [TASK:BP:11.5] Support several Apache Solr versions - [TASK] Remove scrutinizer static analyse fixes from sources Caution: Apache Solr 8.11.3 contains a breaking change, see security fix "SOLR-14853: Make enableRemoteStreaming option global; not configSet". EXT:solr relies on stream bodies which aren't enabled by default since 8.11.3. EXT:solr 11.5.6 contains all required settings, but if you're updating and not using our Docker image, you have to enabel "solr.enableRemoteStreaming" and "solr.enableStreamBody". TYPO3 reports module will print a warning if you have to reconfigure. Please read the release notes: https://github.com/TYPO3-Solr/ext-solr/releases/tag/11.5.6 --- How to Get Involved There are many ways to get involved with Apache Solr for TYPO3: * Submit bug reports and feature requests on GitHub * Ask or help or answer questions in our Slack channel * Provide patches through pull requests or review and comment on existing pull requests * Go to www.typo3-solr.com or call dkd to sponsor the ongoing development of Apache Solr for TYPO3 Support us by becoming an EB partner: https://shop.dkd.de/Produkte/Apache-Solr-fuer-TYPO3/ or call: +49 (0)69 - 2475218 0
TYPO3-Solr · Feb 29, 2024 · 9bb3d38 · 9bb3d38
1 parent c6f7935
commit 9bb3d38
Show file tree

Hide file tree

Showing 25 changed files with 996 additions and 678 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -24,10 +24,10 @@ A clear and concise description of what you expected to happen.
 If applicable, add screenshots to help explain your problem.
 
 **Used versions (please complete the following information):**
- - TYPO3 Version: [e.g. 11.5.26]
+ - TYPO3 Version: [e.g. 11.5.36]
  - Browser: [e.g. chrome, safari]
- - EXT:solr Version: [e.g. 12.0.0]
- - Used Apache Solr Version: [e.g. 9.3.1]
+ - EXT:solr Version: [e.g. 11.5.6]
+ - Used Apache Solr Version: [e.g. 8.11.3]
  - PHP Version: [e.g. 8.2.0]
  - MySQL Version: [e.g. 8.0.0]
 

diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
diff --git a/Documentation/Appendix/VersionMatrix.rst b/Documentation/Appendix/VersionMatrix.rst
@@ -10,7 +10,7 @@ Appendix - Version Matrix
 
 .. tip::
 
-   There is EXT:solr v11.6 for TYPO3 11.5 LTS.
+   See also EXT:solr v11.6 for TYPO3 11.5 LTS.
 
 
 Requirements for EXT:solr* 11.5 stack
@@ -24,9 +24,9 @@ TYPO3     EXT: solr  EXT:tika   EXT:solrfal EXT:solrconsole EXT:solrdebugtools E
 11.5      11.5       11.0       11.0        11.0            11.0               11.0                          11.0 (Ø)        8.11.3¹         ext_solr_11_5_0
 ========= ========== ========== =========== =============== ================== ============================= =============== =============== =================
 
-|¹ - recommended Apache Solr version, check version matrix in composer.json (composer info:solr-versions) for full list
+| ¹ - recommended Apache Solr version, check version matrix in composer.json (composer info:solr-versions) for full list
 
 ..  warning::
    Apache Solr 8.11.3 contains a breaking change, see security fix "SOLR-14853: Make enableRemoteStreaming option global; not configSet". EXT:solr relies on stream bodies
    which aren't enabled by default since 8.11.3. EXT:solr 11.5.6 contains all required settings, but if you're updating and not using our Docker image, you have to
-   set "enableRemoteStreaming=true" and "solr.enableStreamBody=true". TYPO3 reports module will print a warning if you have to reconfigure.
+   set `solr.enableRemoteStreaming=true` and `solr.enableStreamBody=true`. TYPO3 reports module will print a warning if you have to reconfigure.
diff --git a/Documentation/Releases/Archive/Index.rst b/Documentation/Releases/Archive/Index.rst
@@ -0,0 +1,28 @@
+..  include:: /Includes.rst.txt
+..  index:: Archive
+.. _releases-archive:
+
+*******
+Archive
+*******
+
+
+|
+
+.. toctree::
+    :titlesonly:
+    :glob:
+
+    solr-release-11-1.rst
+    solr-release-10-0.rst
+    solr-release-9-0.rst
+    solr-release-8-1.rst
+    solr-release-8-0.rst
+    solr-release-7-0.rst
+    solr-release-6-1.rst
+    solr-release-6-0.rst
+    solr-release-5-1.rst
+    solr-release-5-0.rst
+    solr-release-4-0.rst
+    solr_release-3-1.rst
+    solr-release-3-0.rst
diff --git a/Documentation/Releases/solr-release-10-0.rst → ...on/Releases/Archive/solr-release-10-0.rst b/Documentation/Releases/solr-release-10-0.rst → ...on/Releases/Archive/solr-release-10-0.rst
@@ -1,13 +1,14 @@
 .. include:: /Includes.rst.txt
-..  index:: Archive
-.. _releases-10:
+.. _releases-archive-10:
 
 =============
 Releases 10.0
 =============
 
-..  include:: HintAboutOutdatedChangelog.rst.txt
+..  include:: ../HintAboutOutdatedChangelog.rst.txt
 
+Release 10.0.0
+==============
 
 We are happy to release EXT:solr 10.0.0.
 The focus of EXT:solr 10.0.0 was, to support the `site handling <https://docs.typo3.org/m/typo3/reference-coreapi/9.5/en-us/ApiOverview/SiteHandling/Index.html />`_ that was introduced in TYPO3 9 LTS .
@@ -18,48 +19,48 @@ Since the development budget is limited at one side and we have other project re
 If you want to support us please consider to sponsor us.
 
 New in this release
-===================
+-------------------
 
 TYPO3 9 LTS site handling support
----------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 The major new feature of EXT:solr 10 is the support of the TYPO3 site handling. You can now configure the Apache Solr connections along with your TYPO3 site.
-To get a typical solr site running you now need only a few settings and can use the site handling user interface for that.
+To get a typical Solr site running you now need only a few settings and can use the site handling user interface for that.
 
 Apache Solr 8.2 support
------------------------
+~~~~~~~~~~~~~~~~~~~~~~~
 
 EXT:solr 10 ships Apache Solr 8.2.
 
 Note: The data volume of the Apache Solr Docker container was changed from ```/opt/solr/server/solr/data``` to ```/var/solr/data/data``` this might require changes in your infrastructure configuration.
 
 Extensionscanner cleanup
-------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~
 
 Most (not all) of the extension scanner violations have been fixed. We hope to get the extension scanner violations cleaned in the next releases.
 
 Drop TYPO3 8 compatibility
---------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 To simplify the development we've dropped the compatibility for TYPO3 8 LTS. If you need to use TYPO3 8 please use the 9.0.x branch.
 
 
 Add default field for image and price
--------------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 To allow external applications to index common information for product's we've added a field for price and image. Along with that we've changed the suggest to render the content of the "image" field instead of "previewImage_stringS", this might require changes in  your index configuration.
 
 
 Migration from EXT:solr 9 to EXT:solr 10
-========================================
+----------------------------------------
 
 Important things on sites with activated Site Handling
-------------------------------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-By default EXT:solr 10 expects the configuration of solr connections and cores in the site handling module, along with your TYPO3 site.
-The configuration of the solr connections with your site are available immediatly, so now initialization of connections is required anymore.
+By default EXT:solr 10 expects the configuration of Solr connections and cores in the site handling module, along with your TYPO3 site.
+The configuration of the Solr connections with your site are available immediatly, so now initialization of connections is required anymore.
 
-The old fashioned setup (domain records and solr connections in TypoScript) are now the *legacy mode*. If you want or need to use that still, you can enable the legacy mode,
+The old fashioned setup (domain records and Solr connections in TypoScript) are now the *legacy mode*. If you want or need to use that still, you can enable the legacy mode,
 with your extension configuration by setting ```allowLegacySiteMode = 1```.
 
 The following things will become standard, and should be preferred and activated/configured as close as possible and in some cases immediately,
@@ -77,7 +78,7 @@ All Apache Solr connections must be stored in Site Handling "config.yaml" file f
 config.absRefPrefix
 """""""""""""""""""
 
-The `"config.absRefPrefix" <https://docs.typo3.org/m/typo3/reference-typoscript/master/en-us/Setup/Config/Index.html#absrefprefix />`_ is `obsolete <https://docs.typo3.org/c/typo3/cms-core/9.5/en-us/Changelog/9.4/Feature-86057-ImprovedTypolinkURLLinkGeneration.html />`_ and must be replaced with
+The `"config.absRefPrefix" <https://docs.typo3.org/m/typo3/reference-typoscript/main/en-us/Setup/Config/Index.html#absrefprefix />`_ is `obsolete <https://docs.typo3.org/c/typo3/cms-core/9.5/en-us/Changelog/9.4/Feature-86057-ImprovedTypolinkURLLinkGeneration.html />`_ and must be replaced with
 Site Handlings `"base" <https://docs.typo3.org/m/typo3/reference-coreapi/9.5/en-us/ApiOverview/SiteHandling/Basics.html#base />`_ or `"baseVariants" <https://docs.typo3.org/m/typo3/reference-coreapi/9.5/en-us/ApiOverview/SiteHandling/BaseVariants.html />`_ settings.
 
 
@@ -95,7 +96,7 @@ There are the following known and wanted limitations:
    variables. To configure a username the setting ``solr_username_read`` or
    ``solr_password_read`` can be used in the yaml file.
 
-*  It is **not** possible to configure a different solr hostname with the UI.
+*  It is **not** possible to configure a different Solr hostname with the UI.
    If you need that you can still configured that in the yaml file, by using the
    fallback mechanism.
 
@@ -152,12 +153,6 @@ The example above shows that you are able to define the setting
 configuration and the user interface should be kept simple, this can only be
 configured in the yaml.
 
-Removed Code
-============
-
-The following code parts have been removed as announced in previous versions of EXT:solr:
-
-TBD
 
 Contributors
 ============
@@ -280,10 +275,10 @@ How to Get Involved
 
 There are many ways to get involved with Apache Solr for TYPO3:
 
-* Submit bug reports and feature requests on [GitHub](https://github.com/TYPO3-Solr/ext-solr)
-* Ask or help or answer questions in our [Slack channel](https://typo3.slack.com/messages/ext-solr/)
-* Provide patches through Pull Request or review and comment on existing [Pull Requests](https://github.com/TYPO3-Solr/ext-solr/pulls)
-* Go to [www.typo3-solr.com](http://www.typo3-solr.com) or call [dkd](http://www.dkd.de) to sponsor the ongoing development of Apache Solr for TYPO3
+* Submit bug reports and feature requests on `GitHub <https://github.com/TYPO3-Solr/ext-solr>`__
+* Ask or help or answer questions in our `Slack channel <https://typo3.slack.com/messages/ext-solr/>`__
+* Provide patches through Pull Request or review and comment on existing `Pull Requests <https://github.com/TYPO3-Solr/ext-solr/pulls>`__
+* Go to `www.typo3-solr.com <https://www.typo3-solr.com>`__ or call `dkd <http://www.dkd.de>`__ to sponsor the ongoing development of Apache Solr for TYPO3
 
 Support us by becoming an EB partner:
 

diff --git a/Documentation/Releases/solr-release-11-1.rst → ...on/Releases/Archive/solr-release-11-1.rst b/Documentation/Releases/solr-release-11-1.rst → ...on/Releases/Archive/solr-release-11-1.rst
@@ -1,15 +1,20 @@
 .. include:: /Includes.rst.txt
-..  index:: Archive
-.. _releases-11-1:
+.. _releases-archive-11-1:
+
+=============
+Releases 11.1
+=============
+
+..  include:: ../HintAboutOutdatedChangelog.rst.txt
 
-==============
 Release 11.1.0
 ==============
 
 We are happy to release EXT:solr 11.1.0.
 The focus of this release has been on URL and SEO optimizations.
 
-**Important**: This version is installable with TYPO3 10 LTS only and contains some breaking changes, see details below.
+..  attention::
+    This version is installable with TYPO3 10 LTS only and contains some breaking changes, see details below.
 
 New in this release
 ===================
@@ -21,6 +26,7 @@ Introduce the TYPO3s route enhancer functionality for facets.
 This feature allows to mask facets inside the query string or as part of the path segment.
 
 See:
+
 * https://github.com/TYPO3-Solr/ext-solr/pull/2755
 * https://docs.typo3.org/m/typo3/reference-coreapi/10.4/en-us/ApiOverview/Routing/AdvancedRoutingConfiguration.html
 * https://docs.typo3.org/p/apache-solr-for-typo3/solr/11.1/en-us/Routing/Index.html
@@ -45,19 +51,19 @@ ASCII and Scandinavian Folding Filter
 To improve the search behaviour we introduce folding filters, e.g. allowing to skip accents in search terms. The following languages are
 now using the ASCII folding filter:
 
-* dutch
-* english
-* finish
-* french
-* german
-* hungarian
-* irish
-* italian
-* polish
-* portuguese
-* serbian (for fields that don't include the Serbian Normalization Filter)
-* spanish
-* turkish
+*    dutch
+*    english
+*    finish
+*    french
+*    german
+*    hungarian
+*    irish
+*    italian
+*    polish
+*    portuguese
+*    serbian (for fields that don't include the Serbian Normalization Filter)
+*    spanish
+*    turkish
 
 For the Scandinavian languages, Norwegian, Swedish and Danish, a similiar approach is used, but we're using the more specialized Scandinavian Normalization
 and Scandinavian Folding Filters.
@@ -79,23 +85,25 @@ TYPO3_CONF_VARS/FE/cacheHash/excludedParameters. This setting makes it impossibl
 Please follow the following migration instructions
 
 Plugin namespaces:
-Needed only if other as default (tx_solr) plugin namespace is used in instance. Add the used namespace[s] to $GLOBALS['TYPO3_CONF_VARS']['EXTENSIONS']['solr']['pluginNamespaces'] or via backend
+Needed only if other as default (tx_solr) plugin namespace is used in instance. Add the used namespace[s] to :php:`$GLOBALS['TYPO3_CONF_VARS']['EXTENSIONS']['solr']['pluginNamespaces']` or via backend
 "Settings" -> "Extension Configuration" -> "solr" -> "A list of white listed plugin namespaces"
 
 Global q parameter:
-Needed only if global "q" parameter without plugin namespace is used and wants to be included in cache hash calculation. Set the setting $GLOBALS['TYPO3_CONF_VARS']['EXTENSIONS']['solr']['pluginNamespaces'] = '1'
+Needed only if global "q" parameter without plugin namespace is used and wants to be included in cache hash calculation. Set the setting :php:`$GLOBALS['TYPO3_CONF_VARS']['EXTENSIONS']['solr']['pluginNamespaces'] = '1'`
 or enable it via backend "Settings" -> "Extension Configuration" -> "solr" -> "Include/Exclude global q parameter in/from cacheHash"
 
 See:
+
 * https://github.com/TYPO3-Solr/ext-solr/commit/7b0e77c2680d9dea7861f7bcd33abc1e8664f289
 * https://github.com/TYPO3-Solr/ext-solr/pull/2972
 
-Scheduler task to optimize solr cores
+Scheduler task to optimize Solr cores
 -------------------------------------
 
 This task allows you to optimize the indexes of given cores for a site at a planned time.
 
 See:
+
 * https://github.com/TYPO3-Solr/ext-solr/issues/2649
 * https://github.com/TYPO3-Solr/ext-solr/pull/2666
 * https://docs.typo3.org/p/apache-solr-for-typo3/solr/11.1/en-us/Backend/Scheduler.html#optimizing-cores-of-a-site
@@ -199,7 +207,7 @@ Beside the major changes we did several small improvements and bugfixes:
 * [TASK] Make sure HtmlContentExtractor::cleanContent() is UTF-8 safe .. __: https://github.com/TYPO3-Solr/ext-solr/issues/2513
 * [BUGFIX] Fix #2511: database exception in RecordMonitor .. __: https://github.com/TYPO3-Solr/ext-solr/issues/2511
 * [BUGFIX] Indexing of records fails with solr 10.x+  .. __: https://github.com/TYPO3-Solr/ext-solr/issues/2520
-* [DOCS] Fix path of suggest in typoscript settings .. __: https://github.com/TYPO3-Solr/ext-solr/pull/2678
+* [DOCS] Fix path of suggest in TypoScript settings .. __: https://github.com/TYPO3-Solr/ext-solr/pull/2678
 * [DOCS] Fix links in docs and CONTRIBUTING.md .. __: https://github.com/TYPO3-Solr/ext-solr/pull/2697
 * [BUGFIX] Hard codes plugin namespace .. __: https://github.com/TYPO3-Solr/ext-solr/issues/2691
 * [BUGFIX] Restricted pages are not being indexed in Typo3 10 .. __: https://github.com/TYPO3-Solr/ext-solr/issues/2634
@@ -218,7 +226,6 @@ Beside the major changes we did several small improvements and bugfixes:
 * [BUGFIX] Prevent SiteNotFoundException in reports module .. __: https://github.com/TYPO3-Solr/ext-solr/issues/2624
 * [FEATURE] Change FileWriter configuration to use logFileInfix .. __: https://github.com/TYPO3-Solr/ext-solr/issues/2626
 * [BUGFIX] Ensure to hand in PSR-7 Request to TSFE->getPageAndRootlineWithDomain .. __: https://github.com/TYPO3-Solr/ext-solr/issues/2640
-* ... See older commits, which are a part of prevous releases: https://github.com/TYPO3-Solr/ext-solr/commits/master?after=ec72de7f14c16ee985ab26b5b6791518e348de96+139&branch=master
 
 
 Contributors
@@ -313,10 +320,10 @@ How to Get Involved
 
 There are many ways to get involved with Apache Solr for TYPO3:
 
-* Submit bug reports and feature requests on [GitHub](https://github.com/TYPO3-Solr/ext-solr)
-* Ask or help or answer questions in our [Slack channel](https://typo3.slack.com/messages/ext-solr/)
-* Provide patches through Pull Request or review and comment on existing [Pull Requests](https://github.com/TYPO3-Solr/ext-solr/pulls)
-* Go to [www.typo3-solr.com](http://www.typo3-solr.com) or call [dkd](http://www.dkd.de) to sponsor the ongoing development of Apache Solr for TYPO3
+* Submit bug reports and feature requests on `GitHub <https://github.com/TYPO3-Solr/ext-solr>`__
+* Ask or help or answer questions in our `Slack channel <https://typo3.slack.com/messages/ext-solr/>`__
+* Provide patches through Pull Request or review and comment on existing `Pull Requests <https://github.com/TYPO3-Solr/ext-solr/pulls>`__
+* Go to `www.typo3-solr.com <https://www.typo3-solr.com>`__ or call `dkd <http://www.dkd.de>`__ to sponsor the ongoing development of Apache Solr for TYPO3
 
 Support us by becoming an EB partner: