Attachment 157920 Details for Bug 35063 – Bug 35063: Convert SelfCheckInMainUserBlock system preference to HTML customization

[patch] Bug 35063: Convert SelfCheckInMainUserBlock system preference to HTML customization

Bug-35063-Convert-SelfCheckInMainUserBlock-system-.patch (text/plain), 9.25 KB, created by Owen Leonard on 2023-10-26 12:37:10 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Owen Leonard

Created: 2023-10-26 12:37:10 UTC

Size: 9.25 KB

patch

obsolete

>From b18159fa1e79c72cbb9afddbc4403e1e5b1b0001 Mon Sep 17 00:00:00 2001
>From: Owen Leonard <oleonard@myacpl.org>
>Date: Mon, 16 Oct 2023 15:16:22 +0000
>Subject: [PATCH] Bug 35063: Convert SelfCheckInMainUserBlock system preference
> to HTML customization
>
>This patch moves the SelfCheckInMainUserBlock system preference into
>HTML customizations, making it possible to have language- and
>library-specific content.
>
>To test you should have some content in the SelfCheckInMainUserBlock
>system preference before applying the patch. Apply the patch, run the
>database update process, and rebuild the OPAC CSS.
>
>- In the staff client, go to Tools -> HTML customizations and verify
>  that the content from SelfCheckInMainUserBlock is now stored there.
>- The HTML customization entry form should offer
>  SelfCheckInMainUserBlock as a choice under "Display location."
>- Update and reinstall active translations (for instance fr-FR):
>  - perl misc/translator/translate update fr-FR
>  - perl misc/translator/translate install fr-FR
>- Enable the translation if necessary under Administration -> System
>  preferences -> language.
>- Enable the "opaclanguagesdisplay" preference if necessary.
>- Edit the SelfCheckInMainUserBlock HTML customization and add unique
>  content to the "fr-FR" tab.
>
>- Log into the self check-in system and confirm that the
>  SelfCheckInMainUserBlock content is shown there.
>- Switch to your updated translation and confirm that the content you
>  added for your translation shows up correctly.
>- Go to Administration -> System preferences and search for
>  "SelfCheckInMainUserBlock." It should return no results.
>---
> ...kInMainUserBlock-to-additional-contents.pl | 37 +++++++++++++++++++
> installer/data/mysql/mandatory/sysprefs.sql   |  1 -
> .../admin/preferences/circulation.pref        |  6 ---
> .../en/modules/tools/additional-contents.tt   |  2 +-
> .../bootstrap/en/modules/sci/sci-main.tt      | 10 +++--
> 5 files changed, 45 insertions(+), 11 deletions(-)
> create mode 100755 installer/data/mysql/atomicupdate/bug-35063-move-SelfCheckInMainUserBlock-to-additional-contents.pl
>
>diff --git a/installer/data/mysql/atomicupdate/bug-35063-move-SelfCheckInMainUserBlock-to-additional-contents.pl b/installer/data/mysql/atomicupdate/bug-35063-move-SelfCheckInMainUserBlock-to-additional-contents.pl
>new file mode 100755
>index 0000000000..fe0f81c429
>--- /dev/null
>+++ b/installer/data/mysql/atomicupdate/bug-35063-move-SelfCheckInMainUserBlock-to-additional-contents.pl
>@@ -0,0 +1,37 @@
>+use Modern::Perl;
>+
>+return {
>+    bug_number  => "35063",
>+    description => "Move SelfCheckInMainUserBlock to additional contents",
>+    up          => sub {
>+        my ($args) = @_;
>+        my ( $dbh, $out ) = @$args{qw(dbh out)};
>+
>+        # Get any existing value from the SelfCheckInMainUserBlock system preference
>+        my ($scimainuserblock) = $dbh->selectrow_array(
>+            q|
>+            SELECT value FROM systempreferences WHERE variable='SelfCheckInMainUserBlock';
>+        |
>+        );
>+        if ($scimainuserblock) {
>+
>+            $dbh->do(
>+                "INSERT INTO additional_contents ( category, code, location, branchcode, published_on ) VALUES ('html_customizations', 'SelfCheckInMainUserBlock', 'SelfCheckInMainUserBlock', NULL, CAST(NOW() AS date) )"
>+            );
>+
>+            my ($insert_id) = $dbh->selectrow_array(
>+                "SELECT id FROM additional_contents WHERE category = 'html_customizations' AND code = 'SelfCheckInMainUserBlock' AND location = 'SelfCheckInMainUserBlock' LIMIT 1",
>+                {}
>+            );
>+
>+            $dbh->do(
>+                "INSERT INTO additional_contents_localizations ( additional_content_id, title, content, lang ) VALUES ( ?, 'SelfCheckInMainUserBlock default', ?, 'default' )",
>+                undef, $insert_id, $scimainuserblock
>+            );
>+
>+            # Remove old system preference
>+            $dbh->do("DELETE FROM systempreferences WHERE variable='SelfCheckInMainUserBlock'");
>+            say $out "Bug 35063 update done";
>+        }
>+    }
>+    }
>diff --git a/installer/data/mysql/mandatory/sysprefs.sql b/installer/data/mysql/mandatory/sysprefs.sql
>index 76dbb89110..85f3e5968f 100644
>--- a/installer/data/mysql/mandatory/sysprefs.sql
>+++ b/installer/data/mysql/mandatory/sysprefs.sql
>@@ -657,7 +657,6 @@ INSERT INTO systempreferences ( `variable`, `value`, `options`, `explanation`, `
> ('SearchWithISSNVariations','0',NULL,'If enabled, search on all variations of the ISSN','YesNo'),
> ('SelfCheckAllowByIPRanges','',NULL,'(Leave blank if not used. Use ranges or simple ip addresses separated by spaces, like <code>192.168.1.1 192.168.0.0/24</code>.)','Short'),
> ('SelfCheckHelpMessage','','70|10','Enter HTML to include under the basic Web-based Self Checkout instructions on the Help page','Textarea'),
>-('SelfCheckInMainUserBlock','','70|10','Add a block of HTML that will display on the self check-in screen.','Textarea'),
> ('SelfCheckInModule', 0, NULL, 'Enable the standalone self-checkin module.', 'YesNo'),
> ('SelfCheckInTimeout','120','','Define the number of seconds before the self check-in module times out.','Integer'),
> ('SelfCheckInUserCSS','',NULL,'Add CSS to be included in the self check-in module in an embedded <style> tag.','free'),
>diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/circulation.pref b/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/circulation.pref
>index 8141b0539a..c752bf661a 100644
>--- a/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/circulation.pref
>+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/circulation.pref
>@@ -1091,12 +1091,6 @@ Circulation:
>               type: textarea
>               class: code
>     Self check-in module:
>-        -
>-            - "Include the following HTML on the self check-in screen:"
>-            - pref: SelfCheckInMainUserBlock
>-              type: textarea
>-              syntax: text/html
>-              class: code
>         -
>             - pref: SelfCheckInModule
>               choices:
>diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/tools/additional-contents.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/tools/additional-contents.tt
>index d2e5b591d2..7815e0af2d 100644
>--- a/koha-tmpl/intranet-tmpl/prog/en/modules/tools/additional-contents.tt
>+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/tools/additional-contents.tt
>@@ -524,7 +524,7 @@
>             [% END %]
>         [% END %]
>     [% ELSE %]
>-        [% SET opac_available_options = [ 'OpacNavRight', 'opacheader', 'OpacCustomSearch', 'OpacMainUserBlock', 'opaccredits', 'OpacLoginInstructions', 'OpacNav', 'OpacNavBottom', 'OpacSuggestionInstructions', 'ArticleRequestsDisclaimerText', 'OpacMoreSearches', 'OpacMySummaryNote', 'OpacLibraryInfo', 'OpacMaintenanceNotice', 'OPACResultsSidebar', 'OpacSuppressionMessage', 'SCOMainUserBlock', 'CatalogConcernHelp', 'CatalogConcernTemplate', 'CookieConsentBar', 'CookieConsentPopup', 'PatronSelfRegistrationAdditionalInstructions' ] %]
>+        [% SET opac_available_options = [ 'OpacNavRight', 'opacheader', 'OpacCustomSearch', 'OpacMainUserBlock', 'opaccredits', 'OpacLoginInstructions', 'OpacNav', 'OpacNavBottom', 'OpacSuggestionInstructions', 'ArticleRequestsDisclaimerText', 'OpacMoreSearches', 'OpacMySummaryNote', 'OpacLibraryInfo', 'OpacMaintenanceNotice', 'OPACResultsSidebar', 'OpacSuppressionMessage', 'SCOMainUserBlock', 'SelfCheckInMainUserBlock', 'CatalogConcernHelp', 'CatalogConcernTemplate', 'CookieConsentBar', 'CookieConsentPopup', 'PatronSelfRegistrationAdditionalInstructions' ] %]
>         <optgroup label="OPAC">
>             [% FOREACH l IN opac_available_options.sort %]
>                 [% IF l == location %]
>diff --git a/koha-tmpl/opac-tmpl/bootstrap/en/modules/sci/sci-main.tt b/koha-tmpl/opac-tmpl/bootstrap/en/modules/sci/sci-main.tt
>index 11c961f3c9..af596568f2 100644
>--- a/koha-tmpl/opac-tmpl/bootstrap/en/modules/sci/sci-main.tt
>+++ b/koha-tmpl/opac-tmpl/bootstrap/en/modules/sci/sci-main.tt
>@@ -22,6 +22,7 @@
> [% END %]
> [% PROCESS 'html_helpers.inc' %]
> [% SET OpacHeader = AdditionalContents.get( location => "opacheader", lang => lang, library => logged_in_user.branchcode || default_branch, blocktitle => 0 ) %]
>+[% SET SelfCheckInMainUserBlock = AdditionalContents.get( location => "SelfCheckInMainUserBlock", lang => lang, library => logged_in_user.branchcode || default_branch, blocktitle => 0 ) %]
> [% INCLUDE 'doc-head-open.inc' %]
> [% SET OpacLangSelectorMode = Koha.Preference('OpacLangSelectorMode') %]
> <title>Self check-in &rsaquo; [% IF ( LibraryNameTitle ) %][% LibraryNameTitle | html %][% ELSE %]Koha [% END %]</title>
>@@ -163,13 +164,16 @@
>                             </form> 
>                         </div> 
>                     [% END # /IF ( nopermission ) %]
>+
>+                    [% IF ( SelfCheckInMainUserBlock ) %]
>+                        <div id="scimainuserblock">
>+                            [% PROCESS koha_news_block news => SelfCheckInMainUserBlock %]
>+                        </div>
>+                    [% END %]
>                 </div> 
>             </div> 
>         </div> 
> 
>-    [% IF ( Koha.Preference('SelfCheckInMainUserBlock') ) %]
>-        <div id="SelfCheckInMainUserBlock">[% Koha.Preference('SelfCheckInMainUserBlock' ) | $raw %]</div>
>-    [% END %]
> </div> 
> 
> [% # Help modal %]
>-- 
>2.30.2

Actions: View | Diff | Splinter Review

Attachments on bug 35063: 157203 | 157833 | 157834 | 157835 | 157920 | 157921 | 158000 | 158001 | 158455 | 158456 | 158735 | 158736 | 158737