From 38dcf94bb0b7e13cf12b4278da9e3293b4695ec3 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?R=C3=A9mi=20Dubois?=
 <100987383+remdub@users.noreply.github.com>
Date: Wed, 7 Feb 2024 09:57:15 +0100
Subject: [PATCH] fix: add upgrade step for missing stopwords registry entries
 (#372)

---
 CHANGES.rst                                       |  2 +-
 src/collective/solr/profiles/default/metadata.xml |  2 +-
 src/collective/solr/setuphandlers.py              | 14 ++++++++++++++
 src/collective/solr/upgrades.zcml                 | 10 ++++++++++
 4 files changed, 26 insertions(+), 2 deletions(-)

diff --git a/CHANGES.rst b/CHANGES.rst
index 28a58f27..90407c73 100644
--- a/CHANGES.rst
+++ b/CHANGES.rst
@@ -4,7 +4,7 @@ Changelog
 9.2.3 (unreleased)
 ------------------
 
-- Nothing changed yet.
+- Add upgrade step for missing stopwords registry entries [remdub]
 
 
 9.2.2 (2024-02-06)
diff --git a/src/collective/solr/profiles/default/metadata.xml b/src/collective/solr/profiles/default/metadata.xml
index a279645b..afeb3fcc 100644
--- a/src/collective/solr/profiles/default/metadata.xml
+++ b/src/collective/solr/profiles/default/metadata.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0"?>
 <metadata>
-  <version>7</version>
+  <version>8</version>
   <dependencies>
     <dependency>profile-plone.app.registry:default</dependency>
     <dependency>profile-plone.restapi:default</dependency>
diff --git a/src/collective/solr/setuphandlers.py b/src/collective/solr/setuphandlers.py
index b3ec010c..8a959e81 100644
--- a/src/collective/solr/setuphandlers.py
+++ b/src/collective/solr/setuphandlers.py
@@ -128,3 +128,17 @@ def migrate_to_7(context):
         registry_record.value = "content"
         registry.records["collective.solr.tika_default_field"] = registry_record
     logger.info("Migrated to version 7")
+
+def migrate_to_8(context):
+    registry = getUtility(IRegistry)
+    if "collective.solr.stopwords_case_insensitive" not in registry.records:
+        registry_field = field.Bool(title=u"Stopwords are case insensitive")
+        registry_record = Record(registry_field)
+        registry_record.value = False
+        registry.records["collective.solr.stopwords_case_insensitive"] = registry_record
+    if "collective.solr.stopwords" not in registry.records:
+        registry_field = field.Text(title=u"Stopwords in the format of stopwords.txt")
+        registry_record = Record(registry_field)
+        registry_record.value = ""
+        registry.records["collective.solr.stopwords"] = registry_record
+    logger.info("Migrated to version 8")
diff --git a/src/collective/solr/upgrades.zcml b/src/collective/solr/upgrades.zcml
index 88c87e9b..0084386b 100644
--- a/src/collective/solr/upgrades.zcml
+++ b/src/collective/solr/upgrades.zcml
@@ -63,4 +63,14 @@
     profile="collective.solr:default"
     />
 
+  <genericsetup:upgradeStep
+    title="Upgrade to collective.solr 8"
+    description="Add stopwords registry entries"
+    source="7"
+    destination="8"
+    handler=".setuphandlers.migrate_to_8"
+    sortkey="1"
+    profile="collective.solr:default"
+    />
+
 </configure>