From 81850e06fe0e07c5f3ddfdeb6c2fb0a069c98727 Mon Sep 17 00:00:00 2001 From: Owen Leonard Date: Tue, 10 Jun 2025 14:08:24 +0000 Subject: [PATCH] Bug 34563: Move IntranetCirculationHomeHTML to HTML customizations This patch moves the IntranetCirculationHomeHTML system preference into HTML customizations, making it possible to have language- and library-specific content. To test you should have some content in the IntranetCirculationHomeHTML system preference before applying the patch. Apply the patch and run the database update process. - In the staff client, go to Tools -> HTML customizations and verify that the content from IntranetCirculationHomeHTML is now stored there. - The HTML customization entry form should offer IntranetCirculationHomeHTML 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. - Edit the IntranetCirculationHomeHTML HTML customization and add unique content to the "fr-FR" tab. - Go to the circulation home page. You should see the content you added to the IntranetCirculationHomeHTML HTML customization. - 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 "IntranetCirculationHomeHTML." It should return no results. Sponsored-by: Athens County Public Libraries Signed-off-by: Lucas Gass --- ...tCirculationHome-to-additional-contents.pl | 40 +++++++++++++++++++ installer/data/mysql/mandatory/sysprefs.sql | 1 - .../en/includes/html-customization-help.inc | 2 + .../admin/preferences/staff_interface.pref | 6 +++ .../prog/en/modules/circ/circulation-home.tt | 24 +++++++++-- .../en/modules/tools/additional-contents.tt | 2 +- 6 files changed, 70 insertions(+), 5 deletions(-) create mode 100755 installer/data/mysql/atomicupdate/bug-34563-move-IntranetCirculationHome-to-additional-contents.pl diff --git a/installer/data/mysql/atomicupdate/bug-34563-move-IntranetCirculationHome-to-additional-contents.pl b/installer/data/mysql/atomicupdate/bug-34563-move-IntranetCirculationHome-to-additional-contents.pl new file mode 100755 index 00000000000..0e9a6d8b0f0 --- /dev/null +++ b/installer/data/mysql/atomicupdate/bug-34563-move-IntranetCirculationHome-to-additional-contents.pl @@ -0,0 +1,40 @@ +use Modern::Perl; + +return { + bug_number => "34563", + description => "Move IntranetCirculationHomeHTML to HTML customizations", + up => sub { + my ($args) = @_; + my ( $dbh, $out ) = @$args{qw(dbh out)}; + + # Get any existing value from the IntranetCirculationHomeHTML system preference + my ($intranetcirculationhomehtml) = $dbh->selectrow_array( + q| + SELECT value FROM systempreferences WHERE variable='IntranetCirculationHomeHTML'; + | + ); + if ($intranetcirculationhomehtml) { + + $dbh->do( + "INSERT INTO additional_contents ( category, code, location, branchcode, published_on ) VALUES ('html_customizations', 'IntranetCirculationHomeHTML', 'IntranetCirculationHomeHTML', NULL, CAST(NOW() AS date) )" + ); + + my ($insert_id) = $dbh->selectrow_array( + "SELECT id FROM additional_contents WHERE category = 'html_customizations' AND code = 'IntranetCirculationHomeHTML' AND location = 'IntranetCirculationHomeHTML' LIMIT 1", + {} + ); + + $dbh->do( + "INSERT INTO additional_contents_localizations ( additional_content_id, title, content, lang ) VALUES ( ?, 'IntranetCirculationHomeHTML default', ?, 'default' )", + undef, $insert_id, $intranetcirculationhomehtml + ); + + say $out "Added 'IntranetCirculationHomeHTML' HTML customization"; + } + + # Remove old system preference + $dbh->do("DELETE FROM systempreferences WHERE variable='IntranetCirculationHomeHTML'"); + say $out "Removed system preference 'IntranetCirculationHomeHTML'"; + + }, +}; diff --git a/installer/data/mysql/mandatory/sysprefs.sql b/installer/data/mysql/mandatory/sysprefs.sql index f2b6d940cc0..18eda5153ac 100644 --- a/installer/data/mysql/mandatory/sysprefs.sql +++ b/installer/data/mysql/mandatory/sysprefs.sql @@ -350,7 +350,6 @@ INSERT INTO systempreferences ( `variable`, `value`, `options`, `explanation`, ` ('IntranetBiblioDefaultView','normal','normal|marc|isbd|labeled_marc','Choose the default detail view in the staff interface; choose between normal, labeled_marc, marc or isbd','Choice'), ('intranetbookbag','1','','If ON, enables display of Cart feature in the intranet','YesNo'), ('IntranetCatalogSearchPulldown','0', NULL, 'Show a search field pulldown for \"Search the catalog\" boxes','YesNo'), -('IntranetCirculationHomeHTML', '', NULL, 'Show the following HTML in a div on the bottom of the reports home page', 'Free'), ('IntranetCoce','0', NULL, 'If on, enables cover retrieval from the configured Coce server in the staff interface', 'YesNo'), ('intranetcolorstylesheet','','50','Define the color stylesheet to use in the staff interface','free'), ('IntranetFavicon','','','Enter a complete URL to an image to replace the default Koha favicon on the staff interface','free'), diff --git a/koha-tmpl/intranet-tmpl/prog/en/includes/html-customization-help.inc b/koha-tmpl/intranet-tmpl/prog/en/includes/html-customization-help.inc index 1faec6c9fa1..ecc9084d103 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/includes/html-customization-help.inc +++ b/koha-tmpl/intranet-tmpl/prog/en/includes/html-customization-help.inc @@ -14,6 +14,8 @@ Adding content to this region will enable the copyright clearance stage in request creation. The content will appear on the OPAC during the process of placing an ILL request. +
Include this content in its own section on the circulation home page
+
Include this content in its own section on the main page of the staff interface
Include this content in its own section on the reports home page
diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/staff_interface.pref b/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/staff_interface.pref index 00b1b06912f..f9fc5140fe1 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/staff_interface.pref +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/staff_interface.pref @@ -113,6 +113,12 @@ Staff interface: type: textarea syntax: text/html class: code + + - "Show the following HTML in its own div on the bottom of the home page of the reports module:" + - pref: IntranetReportsHomeHTML + type: textarea + syntax: text/html + class: code - - pref: StaffHighlightedWords type: boolean diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/circ/circulation-home.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/circ/circulation-home.tt index ee5dbc7c765..e20c00cc126 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/circ/circulation-home.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/circ/circulation-home.tt @@ -1,6 +1,7 @@ [% USE raw %] [% USE Koha %] [% USE Branches %] +[% USE AdditionalContents %] [% PROCESS 'i18n.inc' %] [% INCLUDE 'doc-head-open.inc' %] </div> - <div class="row" id="intranet-circulation-home-html"> - <div class="col-md-12"> [% Koha.Preference('IntranetCirculationHomeHTML') | $raw %] </div> - </div> + + [% SET IntranetCirculationHomeHTML = AdditionalContents.get( location => "IntranetCirculationHomeHTML", lang => lang, library => Branches.GetLoggedInBranchcode || default_branch ) %] + + [% IF ( IntranetCirculationHomeHTML.content && IntranetCirculationHomeHTML.content.count > 0 ) %] + <div class="row"> + <div class="col-sm-12"> + <div id="[% IntranetCirculationHomeHTML.location | html %]" class="page-section"> + [% FOREACH n IN IntranetCirculationHomeHTML.content %] + <div class="[% n.lang | html %]_item"> + <div class="[% n.lang | html %]_body">[% n.content | $raw %]</div> + </div> + [% END %] + </div> + <!-- /#IntranetCirculationHomeHTML --> + </div> + <!-- /.col-sm-12 --> + </div> + <!-- /.row --> + [% END # /IF IntranetCirculationHomeHTML %] + <div class="row" id="offline-circulation"> <div class="col-md-12"> <h4>Offline circulation</h4> 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 f62690eb20a..35124698239 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 @@ -542,7 +542,7 @@ [% END %] [% END %] </optgroup> - [% SET staff_available_options = [ 'IntranetmainUserblock', 'StaffReportsHome', 'RoutingListNote', 'StaffAcquisitionsHome', 'StaffAuthoritiesHome', 'StaffCataloguingHome', 'StaffListsHome', 'StaffLoginInstructions', 'StaffPatronsHome', 'StaffPOSHome', 'StaffSerialsHome' ] %] + [% SET staff_available_options = [ 'IntranetCirculationHomeHTML', 'IntranetmainUserblock', 'StaffReportsHome', 'RoutingListNote', 'StaffAcquisitionsHome', 'StaffAuthoritiesHome', 'StaffCataloguingHome', 'StaffListsHome', 'StaffLoginInstructions', 'StaffPatronsHome', 'StaffPOSHome', 'StaffSerialsHome' ] %] <optgroup label="Staff interface"> [% FOREACH l IN staff_available_options.sort %] [% IF l == location %] -- 2.39.5