Attachment 10454 Details for Bug 8301 – Bug 8301 - Display additional system information (preferences) on About page to minimize support cases

[patch] Bug 8301 - Display additional system information (preferences) on About page to minimize support cases

Bug-8301---Display-additional-system-information-p.patch (text/plain), 4.21 KB, created by Marc Véron on 2012-06-25 07:28:53 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Marc Véron

Created: 2012-06-25 07:28:53 UTC

Size: 4.21 KB

patch

obsolete

>From d7abb1a188d51ad6afae0684baaf1891e4be9781 Mon Sep 17 00:00:00 2001
>From: Marc Veron <veron@veron.ch>
>Date: Sun, 24 Jun 2012 21:29:12 +0200
>Subject: [PATCH] Bug 8301 - Display additional system information (preferences) on About page to minimize support cases
>Content-Type: text/plain; charset="utf-8"
>
>To minimize support questions regarding common mistakes, the About
>page should have an additional tab that displays warnings if depractated
>and/or mutual excluding system preferences are used.
>
>To test patch use values as displayed on screenshot attached.
>
>New: Shows error message in Tab Server Information if Zebra server is not started
>
>Suggestions for other values to add are welcome.
>---
> about.pl                                         |   15 +++++++++++++++
> koha-tmpl/intranet-tmpl/prog/en/modules/about.tt |   22 ++++++++++++++++++++++
> 2 files changed, 37 insertions(+), 0 deletions(-)
>
>diff --git a/about.pl b/about.pl
>index 7189a22..a0e2020 100755
>--- a/about.pl
>+++ b/about.pl
>@@ -60,6 +60,16 @@ $apacheVersion = `httpd2 -v` unless $apacheVersion;
> $apacheVersion = (`/usr/sbin/apache2 -V`)[0] unless $apacheVersion;
> my $zebraVersion = `zebraidx -V`;
> 
>+# Additional system information for warnings
>+my $prefNoZebra = C4::Context->preference('nozebra');
>+my $prefAutoCreateAuthorities = C4::Context->preference('AutoCreateAuthorities');
>+my $prefBiblioAddsAuthorities = C4::Context->preference('BiblioAddsAuthorities');
>+my $warnPrefBiblioAddsAuthorities = ( $prefAutoCreateAuthorities && ( !$prefBiblioAddsAuthorities) );
>+
>+my $prefEasyAnalyticalRecords  = C4::Context->preference('EasyAnalyticalRecords');
>+my $prefUseControlNumber  = C4::Context->preference('UseControlNumber');
>+my $warnPrefEasyAnalyticalRecords  = ( $prefEasyAnalyticalRecords  && $prefUseControlNumber );
>+
> $template->param(
>     kohaVersion   => $kohaVersion,
>     osVersion     => $osVersion,
>@@ -69,6 +79,11 @@ $template->param(
>     mysqlVersion  => $mysqlVersion,
>     apacheVersion => $apacheVersion,
>     zebraVersion  => $zebraVersion,
>+    prefNoZebra   => $prefNoZebra,
>+    prefBiblioAddsAuthorities => $prefBiblioAddsAuthorities,
>+    prefAutoCreateAuthorities => $prefAutoCreateAuthorities,
>+    warnPrefBiblioAddsAuthorities => $warnPrefBiblioAddsAuthorities,
>+    warnPrefEasyAnalyticalRecords  => $warnPrefEasyAnalyticalRecords,
> );
> 
> my @components = ();
>diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/about.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/about.tt
>index 2fd6655..842d3ea 100644
>--- a/koha-tmpl/intranet-tmpl/prog/en/modules/about.tt
>+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/about.tt
>@@ -26,6 +26,7 @@
>         <ul>
>         <li><a href="#about">Server Information</a></li>
>         <li><a href="#perl">Perl modules</a></li>
>+        <li><a href="#sysinfo">System information</a></li>
>         <li><a href="#team">Koha Team</a></li>
>         <li><a href="#licenses">Licenses</a></li>
>         <li><a href="#translations">Translations</a></li>
>@@ -83,6 +84,27 @@
>                 [% END %]
>             </table>
>         </div>
>+
>+        <div id="sysinfo">
>+            <h2>Warnings regarding the system configuration</h2>
>+        [% IF ( (prefNoZebra) || (warnPrefBiblioAddsAuthorities) || warnPrefEasyAnalyticalRecords ) %]
>+        <table>
>+            <caption>Preferences</caption>
>+            [% IF (prefNoZebra) %]
>+            <tr><th scope="row"><b>Warning</b> </th><td>System preference 'nozebra' set. Deprectated!</td></tr>
>+            [% END %]
>+            [% IF (warnPrefBiblioAddsAuthorities) %]
>+            <tr><th scope="row"><b>Warning</b> </th><td>System preference 'AutoCreateAuthorities' set, but needs 'BiblioAddsAuthorities' set as well.</td></tr>
>+            [% END %]
>+            [% IF (warnPrefEasyAnalyticalRecords) %]
>+            <tr><th scope="row"><b>Warning</b> </th><td>System preference 'EasyAnalyticalRecords' set, but UseControlNumber preference is set to 'Use'. Set it to 'Don't use' or else the 'Show analytics' links in the staff client and the OPAC will be broken.</td></tr>
>+            [% END %]
>+        </table>
>+        [% ELSE %]
>+            <p>No warnings</p>
>+        [% END %]
>+        </div>
>+
>         <div id="team">
>             <h2>Special thanks to the following organizations</h2>
>             <ul>
>-- 
>1.7.2.5

Actions: View | Diff | Splinter Review

Attachments on bug 8301: 10450 | 10451 | 10454 | 10455 | 10461