Bug 23797: Convert OpacLoginInstructions system preference to news block
authorOwen Leonard <oleonard@myacpl.org>
Tue, 24 Mar 2020 15:06:30 +0000 (15:06 +0000)
committerJonathan Druart <jonathan.druart@bugs.koha-community.org>
Thu, 23 Jul 2020 09:33:08 +0000 (11:33 +0200)
This patch builds on Bug 22318 to move the OpacLoginInstructions 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 OpacLoginInstructions system
preference. Apply the patch and run the database update process.

 - Go to the OPAC and click the login link.
 - In the login modal, confirm that the content which was previously in
   the OpacLoginInstructions system preference displays correctly
   below the login form.
 - While not logged in to the OPAC, navigate directly to
   /cgi-bin/koha/opac-user.pl. The OpacLoginInstructions content should
   display correctly here as well.
 - In the staff client, go to Tools -> News and verify that the content
   from OpacLoginInstructions is now stored in news items. There
   should be one entry for each of the enabled translations in your
   system, for instance 'OpacLoginInstructions_en',
   'OpacLoginInstructions_fr-FR', 'OpacLoginInstructions_cs-CZ'
 - Go to Administration -> System preferences and confirm that the
   OpacLoginInstructions preference has been removed.
 - To test the correct selection of language-specific content you must
   run the translation update/install process for the languages you're
   updating.

Signed-off-by: Sally <sally.healey@cheshiresharedservices.gov.uk>
Signed-off-by: Alex Arnaud <alex.arnaud@biblibre.com>

Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>

installer/data/mysql/atomicupdate/bug_23797-move-OpacLoginInstructions-to-news.perl [new file with mode: 0644]
installer/data/mysql/sysprefs.sql
koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/opac.pref
koha-tmpl/intranet-tmpl/prog/en/modules/tools/koha-news.tt
koha-tmpl/opac-tmpl/bootstrap/en/modules/opac-auth.tt
koha-tmpl/opac-tmpl/bootstrap/en/modules/opac-main.tt

diff --git a/installer/data/mysql/atomicupdate/bug_23797-move-OpacLoginInstructions-to-news.perl b/installer/data/mysql/atomicupdate/bug_23797-move-OpacLoginInstructions-to-news.perl
new file mode 100644 (file)
index 0000000..49d33f9
--- /dev/null
@@ -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 OpacLoginInstructions system preference
+    my ($opaclogininstructions) = $dbh->selectrow_array( q|
+        SELECT value FROM systempreferences WHERE variable='OpacLoginInstructions';
+    |);
+    if( $opaclogininstructions ){
+        foreach my $lang ( @langs ) {
+            print "Inserting OpacLoginInstructions contents into $lang news item...\n";
+            # If there is a value in the OpacLoginInstructions preference, insert it into opac_news
+            $dbh->do("INSERT INTO opac_news (branchcode, lang, title, content ) VALUES (NULL, ?, '', ?)", undef, "OpacLoginInstructions_$lang", $opaclogininstructions);
+        }
+    }
+    # Remove the OpacLoginInstructions system preference
+    $dbh->do("DELETE FROM systempreferences WHERE variable='OpacLoginInstructions'");
+    SetVersion ($DBversion);
+    print "Upgrade to $DBversion done (Bug 23797: Convert OpacLoginInstructions system preference to news block)\n";
+}
\ No newline at end of file
index 5c6969d..dbb1393 100644 (file)
@@ -406,7 +406,6 @@ INSERT INTO systempreferences ( `variable`, `value`, `options`, `explanation`, `
 ('OPACLocalCoverImages','0','1','Display local cover images on OPAC search and details pages.','YesNo'),
 ('OpacLocationBranchToDisplay','holding','holding|home|both','In the OPAC, under location show which branch for Location in the record details.','Choice'),
 ('OpacLocationOnDetail','holding','holding|home|both|column','In the OPAC detail, display the shelving location on its own column or under a library columns.',  'Choice'),
-('OpacLoginInstructions', '', '60|10', 'Instructions to display on the OPAC login form when a patron is not logged in', 'Textarea'),
 ('OpacMaintenance','0','','If ON, enables maintenance warning in OPAC','YesNo'),
 ('OpacMaintenanceNotice','','','A user-defined block of HTML to appear on screen when OpacMaintenace is enabled','Textarea'),
 ('OpacMaxItemsToDisplay','50','','Max items to display at the OPAC on a biblio detail','Integer'),
index ebb2dc5..6f6e549 100644 (file)
@@ -346,12 +346,6 @@ OPAC:
               class: integer
             - items on the bibliographic record detail page (if the bibliographic record has more items than this, a link is displayed instead that allows the user to choose to display all items).
         -
-            - "Show the following HTML on the OPAC login form when a patron is not logged in:"
-            - pref: OpacLoginInstructions
-              type: textarea
-              syntax: text/html
-              class: code
-        -
             - "Display language selector on "
             - pref: OpacLangSelectorMode
               choices:
index f321e6b..a42aea5 100644 (file)
@@ -332,7 +332,7 @@ Edit news item[% ELSE %]Add news item[% END %][% ELSE %]News[% END %]</div>
     [% END %]
     [% FOREACH lang_lis IN lang_list %]
         <optgroup label="[% lang_lis.language | html %]">
-            [% FOREACH location IN [ '', 'OpacNavRight', 'opacheader', 'OpacCustomSearch', 'OpacMainUserBlock', 'opaccredits' ] %]
+            [% FOREACH location IN [ '', 'OpacNavRight', 'opacheader', 'OpacCustomSearch', 'OpacMainUserBlock', 'opaccredits', 'OpacLoginInstructions'] %]
                 [% IF ( location == '' ) %]
                     [% SET location_lang = lang_lis.language %]
                     [% location = BLOCK %]OPAC news[% END %]
index 7f56900..e35f83c 100644 (file)
@@ -1,6 +1,9 @@
 [% USE raw %]
 [% USE Koha %]
 [% USE Categories %]
+[% USE KohaNews %]
+[% PROCESS 'html_helpers.inc' %]
+[% SET OpacLoginInstructions = KohaNews.get( location => "OpacLoginInstructions", lang => lang, library => branchcode ) %]
 [% INCLUDE 'doc-head-open.inc' %]
 <title>[% IF ( LibraryNameTitle ) %][% LibraryNameTitle | html %][% ELSE %]Koha online[% END %] catalog &rsaquo;
 [% IF Koha.Preference( 'opacuserlogin' ) == 1 %]
                                 </div>
                             [% END %]
                             <div id="nologininstructions">
-                            [% IF Koha.Preference('OpacLoginInstructions') %]
-                                [% Koha.Preference('OpacLoginInstructions') | $raw %]
+                            [% IF ( OpacLoginInstructions ) %]
+                                [% PROCESS koha_news_block news => OpacLoginInstructions %]
                             [% ELSE %]
                                 <h3>Don't have a password yet?</h3>
                                 <p>If you don't have a password yet, stop by the circulation desk the next time you're in the library. We'll happily set one up for you.</p>
index 70ac981..af3e8e4 100644 (file)
@@ -7,6 +7,7 @@
 [% USE KohaNews %]
 [% SET OpacNavRight = KohaNews.get( location => "OpacNavRight", lang => lang, library => branchcode ) %]
 [% SET OpacMainUserBlock = KohaNews.get( location => "OpacMainUserBlock", lang => lang, library => branchcode ) %]
+[% SET OpacLoginInstructions = KohaNews.get( location => "OpacLoginInstructions", lang => lang, library => branchcode ) %]
 [% INCLUDE 'doc-head-open.inc' %]
 <title>[% IF ( LibraryNameTitle ) %][% LibraryNameTitle | html %][% ELSE %]Koha online[% END %] catalog</title>
 [% INCLUDE 'doc-head-close.inc' %]
                                         <fieldset class="action">
                                             <input type="submit" value="Log in" class="btn" />
                                         </fieldset>
-                                        [% IF Koha.Preference( 'OpacLoginInstructions' ) %]
+                                        [% IF ( OpacLoginInstructions ) %]
                                             <div id="nologininstructions-main" class="nologininstructions">
-                                                [% Koha.Preference( 'OpacLoginInstructions' ) | $raw %]
+                                                [% PROCESS koha_news_block news => OpacLoginInstructions %]
                                             </div>
                                         [% END %]
                                         [% IF Koha.Preference('OpacPasswordChange') && Categories.can_any_reset_password %]