From b576b08972d6631d95125f57bb7666bc89162887 Mon Sep 17 00:00:00 2001 From: Owen Leonard Date: Wed, 11 Dec 2019 17:03:01 +0000 Subject: [PATCH] Bug 23795: Convert opaccredits system preference to news block This patch builds on Bug 22318 to move the opaccredits system preference into the Koha news system, making it possible to have language- and library-specific content. To test you should have some content in the opaccredits system preference. Apply the patch and run the database update process. - Go to the OPAC and confirm that the content which was previously in the opaccredits system preference now displays correctly where it was before. - In the staff client, go to Tools -> News and verify that the content from opaccredits is now stored in news items. There should be one entry for each of the enabled translations in your system, for instance 'opaccredits_en', 'opaccredits_fr-FR', 'opaccredits_cs-CZ' - Go to Administration -> System preferences and confirm that the opaccredits preference has been removed. Signed-off-by: Sally --- C4/Auth.pm | 2 -- .../bug_23795-move-opaccredits-to-news.perl | 30 ++++++++++++++++++++++ installer/data/mysql/sysprefs.sql | 1 - .../prog/en/modules/admin/preferences/opac.pref | 6 ----- .../prog/en/modules/tools/koha-news.tt | 2 +- .../bootstrap/en/includes/opac-bottom.inc | 9 ++++--- 6 files changed, 36 insertions(+), 14 deletions(-) create mode 100644 installer/data/mysql/atomicupdate/bug_23795-move-opaccredits-to-news.perl diff --git a/C4/Auth.pm b/C4/Auth.pm index 6889c2532c..5ed26c807a 100644 --- a/C4/Auth.pm +++ b/C4/Auth.pm @@ -584,7 +584,6 @@ sub get_template_and_user { hidelostitems => C4::Context->preference("hidelostitems"), mylibraryfirst => ( C4::Context->preference("SearchMyLibraryFirst") && C4::Context->userenv ) ? C4::Context->userenv->{'branch'} : '', opacbookbag => "" . C4::Context->preference("opacbookbag"), - opaccredits => "" . C4::Context->preference("opaccredits"), OpacFavicon => C4::Context->preference("OpacFavicon"), opaclanguagesdisplay => "" . C4::Context->preference("opaclanguagesdisplay"), opacreadinghistory => C4::Context->preference("opacreadinghistory"), @@ -1259,7 +1258,6 @@ sub checkauth { opacuserlogin => C4::Context->preference("opacuserlogin"), OpacNav => C4::Context->preference("OpacNav"), OpacNavBottom => C4::Context->preference("OpacNavBottom"), - opaccredits => C4::Context->preference("opaccredits"), OpacFavicon => C4::Context->preference("OpacFavicon"), opacreadinghistory => C4::Context->preference("opacreadinghistory"), opaclanguagesdisplay => C4::Context->preference("opaclanguagesdisplay"), diff --git a/installer/data/mysql/atomicupdate/bug_23795-move-opaccredits-to-news.perl b/installer/data/mysql/atomicupdate/bug_23795-move-opaccredits-to-news.perl new file mode 100644 index 0000000000..225820b0ac --- /dev/null +++ b/installer/data/mysql/atomicupdate/bug_23795-move-opaccredits-to-news.perl @@ -0,0 +1,30 @@ +$DBversion = 'XXX'; # will be replaced by the RM +if( CheckVersion( $DBversion ) ) { + + # get list of installed translations + require C4::Languages; + my @langs; + my $tlangs = C4::Languages::getTranslatedLanguages(); + + foreach my $language ( @$tlangs ) { + foreach my $sublanguage ( @{$language->{'sublanguages_loop'}} ) { + push @langs, $sublanguage->{'rfc4646_subtag'}; + } + } + + # Get any existing value from the opaccredits system preference + my ($opaccredits) = $dbh->selectrow_array( q| + SELECT value FROM systempreferences WHERE variable='opaccredits'; + |); + if( $opaccredits ){ + foreach my $lang ( @langs ) { + print "Inserting opaccredits contents into $lang news item...\n"; + # If there is a value in the opaccredits preference, insert it into opac_news + $dbh->do("INSERT INTO opac_news (branchcode, lang, title, content ) VALUES (NULL, ?, '', ?)", undef, "opaccredits_$lang", $opaccredits); + } + } + # Remove the opaccredits system preference + $dbh->do("DELETE FROM systempreferences WHERE variable='opaccredits'"); + SetVersion ($DBversion); + print "Upgrade to $DBversion done (Bug 23795: Convert OpacCredits system preference to news block)\n"; +} diff --git a/installer/data/mysql/sysprefs.sql b/installer/data/mysql/sysprefs.sql index 4ad73ef827..e1045c7bf9 100644 --- a/installer/data/mysql/sysprefs.sql +++ b/installer/data/mysql/sysprefs.sql @@ -377,7 +377,6 @@ INSERT INTO systempreferences ( `variable`, `value`, `options`, `explanation`, ` ('OpacCoce','0', NULL, 'If on, enables cover retrieval from the configured Coce server in the OPAC', 'YesNo'), ('OPACCustomCoverImages','0',NULL,'If enabled, the custom cover images will be displayed at the OPAC. CustomCoverImagesURL must be defined.','YesNo'), ('OpacCustomSearch','','70|10','Replace the search box on the OPAC with the provided HTML','Textarea'), -('opaccredits','','70|10','Define HTML Credits at the bottom of the OPAC page','Textarea'), ('OPACdefaultSortField','relevance','relevance|popularity|call_number|pubdate|acqdate|title|author','Specify the default field used for sorting','Choice'), ('OPACdefaultSortOrder','dsc','asc|dsc|za|az','Specify the default sort order','Choice'), ('OPACdidyoumean','',NULL,'Did you mean? configuration for the OPAC. Do not change, as this is controlled by /cgi-bin/koha/admin/didyoumean.pl.','Free'), diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/opac.pref b/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/opac.pref index 9abfbb7cee..dc0893ac1a 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/opac.pref +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/opac.pref @@ -253,12 +253,6 @@ OPAC: syntax: text/html class: code - - - "Include the following HTML in the footer of all pages in the OPAC:" - - pref: opaccredits - type: textarea - syntax: text/html - class: code - - - 'Include a "More Searches" box on the detail pages of items on the OPAC, with the following HTML (leave blank to disable):' - '
Note: The placeholders {BIBLIONUMBER}, {CONTROLNUMBER}, {TITLE}, {ISBN}, {ISSN} and {AUTHOR} will be replaced with information from the displayed record.' - pref: OPACSearchForTitleIn diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/tools/koha-news.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/tools/koha-news.tt index 062f0e1642..e251f9357e 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/tools/koha-news.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/tools/koha-news.tt @@ -331,7 +331,7 @@ Edit news item[% ELSE %]Add news item[% END %][% ELSE %]News[% END %] [% END %] [% FOREACH lang_lis IN lang_list %] - [% FOREACH location IN [ '', 'OpacNavRight', 'opacheader', 'OpacMainUserBlock' ] %] + [% FOREACH location IN [ '', 'OpacNavRight', 'opacheader', 'OpacMainUserBlock', 'opaccredits' ] %] [% IF ( location == '' ) %] [% SET location_lang = lang_lis.language %] [% location = BLOCK %]OPAC news[% END %] diff --git a/koha-tmpl/opac-tmpl/bootstrap/en/includes/opac-bottom.inc b/koha-tmpl/opac-tmpl/bootstrap/en/includes/opac-bottom.inc index a32e7a56ee..9c4649ea88 100644 --- a/koha-tmpl/opac-tmpl/bootstrap/en/includes/opac-bottom.inc +++ b/koha-tmpl/opac-tmpl/bootstrap/en/includes/opac-bottom.inc @@ -1,16 +1,17 @@ [% USE raw %] [% USE Koha %] +[% USE KohaNews %] [%- USE KohaPlugins -%] [% USE Asset %] +[% SET opaccredits = KohaNews.get( location => "opaccredits", lang => lang, library => branchcode ) %] +[% PROCESS 'html_helpers.inc' %] [% UNLESS ( is_popup ) %] [% SET OpacLangSelectorMode = Koha.Preference('OpacLangSelectorMode') %] [% IF ( opaccredits ) %]
-
-
- [% opaccredits | $raw %] -
+
+ [% PROCESS koha_news_block news => opaccredits %]
-- 2.11.0