Attachment 15118 Details for Bug 7740 – Bug 7740 - Highlight items in own library in search results/detail page in OPAC

[patch] Bug 7740 - Highlight items in own library in search results/detail page in OPAC

Bug-7740---Highlight-items-in-own-library-in-searc.patch (text/plain), 12.17 KB, created by Kyle M Hall (khall) on 2013-02-06 20:52:21 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Kyle M Hall (khall)

Created: 2013-02-06 20:52:21 UTC

Size: 12.17 KB

patch

obsolete

>From e4677c55712da3d4cfdf4bfd06102886ab4d4223 Mon Sep 17 00:00:00 2001
>From: Kyle M Hall <kyle@bywatersolutions.com>
>Date: Thu, 18 Oct 2012 12:40:02 -0400
>Subject: [PATCH] Bug 7740 - Highlight items in own library in search results/detail page in OPAC
>
>This feature enables a particular library's items to be emphasized and moved
>to the first position on the search results and details pages of the OPAC.
>
>It is enabled by the sytem preference HighlightOwnItemsOnOPAC.
>
>To choose which branches items are emphasized, use the system preference
>HighlightOwnItemsOnOPACWhich. It has two modes.
>
>If set to PatronBranch, the items emphasized will be those of the same
>library as the patron's library. If no one is logged into the opac, no
>items will be highlighted.
>
>If set to OpacURLBranch, the library is chosen based on the Apache
>environment variable BRANCHCODE.
>
>For example, this could be added to the OPAC section of koha-httpd.conf:
>SetEnv BRANCHCODE "CPL"
>
>The point of this feature is to allow each library on a given Koha server
>to have a specific subdomain for the opac where that library's items are
>empasized. That was http://branch1.opac.mylibrary.org will emphasize the
>items of branch1, while http://branch2.opac.mylibrary.org will emphasize
>the items of branch2.
>---
> installer/data/mysql/sysprefs.sql                  |    2 +
> installer/data/mysql/updatedatabase.pl             |    7 ++++
> .../prog/en/modules/admin/preferences/opac.pref    |   11 ++++++
> koha-tmpl/opac-tmpl/prog/en/css/opac.css           |    8 +++++
> koha-tmpl/opac-tmpl/prog/en/modules/opac-detail.tt |    3 +-
> .../opac-tmpl/prog/en/modules/opac-results.tt      |    2 +
> opac/opac-detail.pl                                |   32 ++++++++++++++++++
> opac/opac-search.pl                                |   34 ++++++++++++++++++++
> 8 files changed, 98 insertions(+), 1 deletions(-)
>
>diff --git a/installer/data/mysql/sysprefs.sql b/installer/data/mysql/sysprefs.sql
>index 9032bfa..6ba69ec 100644
>--- a/installer/data/mysql/sysprefs.sql
>+++ b/installer/data/mysql/sysprefs.sql
>@@ -411,3 +411,5 @@ INSERT INTO systempreferences (variable,value,options,explanation,type) VALUES (
> INSERT IGNORE INTO systempreferences (variable,value,explanation,options,type) VALUES('IDreamBooksReviews','0','Display book review snippets from IDreamBooks.com','','YesNo');
> INSERT IGNORE INTO systempreferences (variable,value,explanation,options,type) VALUES('IDreamBooksReadometer','0','Display Readometer from IDreamBooks.com','','YesNo');
> INSERT IGNORE INTO systempreferences (variable,value,explanation,options,type) VALUES('IDreamBooksResults','0','Display IDreamBooks.com rating in search results','','YesNo');
>+INSERT INTO systempreferences (variable,value,options,explanation,type) VALUES ('HighlightOwnItemsOnOPAC','0','','If on, and a patron is logged into the OPAC, items from his or her home library will be emphasized and shown first in search results and item details.','YesNo');
>+INSERT INTO systempreferences (variable,value,options,explanation,type) VALUES ('HighlightOwnItemsOnOPACWhich','PatronBranch','PatronBranch|OpacURLBranch','Decides which branch''s items to emphasize. If PatronBranch, emphasize the logged in user''s library''s items. If OpacURLBranch, highlight the items of the Apache var BRANCHCODE defined in Koha''s Apache configuration file.','Choice')
>diff --git a/installer/data/mysql/updatedatabase.pl b/installer/data/mysql/updatedatabase.pl
>index ed922b8..e0926f8 100755
>--- a/installer/data/mysql/updatedatabase.pl
>+++ b/installer/data/mysql/updatedatabase.pl
>@@ -6399,6 +6399,13 @@ if ( CheckVersion($DBversion) ) {
>     SetVersion($DBversion);
> }
> 
>+$DBversion = "3.11.00.XXX";
>+if (C4::Context->preference("Version") < TransformToNum($DBversion)) {
>+    $dbh->do("INSERT INTO systempreferences (variable,value,options,explanation,type) VALUES ('HighlightOwnItemsOnOPAC','0','','If on, and a patron is logged into the OPAC, items from his or her home library will be emphasized and shown first in search results and item details.','YesNo')");
>+    $dbh->do("INSERT INTO systempreferences (variable,value,options,explanation,type) VALUES ('HighlightOwnItemsOnOPACWhich','PatronBranch','PatronBranch|OpacURLBranch','Decides which branch''s items to emphasize. If PatronBranch, emphasize the logged in user''s library''s items. If OpacURLBranch, highlight the items of the Apache var BRANCHCODE defined in Koha''s Apache configuration file.','Choice')");
>+    print "Upgrade to $DBversion done (Add syspref HighlightOwnItemsOnOPAC)\n";
>+    SetVersion ($DBversion);
>+}
> 
> =head1 FUNCTIONS
> 
>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 300c6e1..444f43e 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
>@@ -22,6 +22,17 @@ OPAC:
>                   no: Disable
>             - "Koha OPAC as public. Private OPAC requires authentification before accessing the OPAC."
>         -
>+            - pref: HighlightOwnItemsOnOPAC
>+              choices:
>+                  yes: Emphasize
>+                  no: "Don't emphasize"
>+            - "results from the "
>+            - pref: HighlightOwnItemsOnOPACWhich
>+              choices:
>+                  PatronBranch: "patron's home branch"
>+                  OpacURLBranch: "OPAC's branch via the URL"
>+            - " by moving the results to the front and increasing the size or highlighting the rows for those results."
>+        -
>             - "Show star-ratings on"
>             - pref: OpacStarRatings
>               choices:
>diff --git a/koha-tmpl/opac-tmpl/prog/en/css/opac.css b/koha-tmpl/opac-tmpl/prog/en/css/opac.css
>index cdf7a4d..db63e49 100644
>--- a/koha-tmpl/opac-tmpl/prog/en/css/opac.css
>+++ b/koha-tmpl/opac-tmpl/prog/en/css/opac.css
>@@ -2890,3 +2890,11 @@ a.reviewlink,a.reviewlink:visited {
> .idbresult img {
>     padding-right: 6px;
> }
>+
>+.highlight-row-results {
>+    font-size: 120%;
>+}
>+
>+.highlight-row-detail {
>+    font-weight: bold;
>+}
>diff --git a/koha-tmpl/opac-tmpl/prog/en/modules/opac-detail.tt b/koha-tmpl/opac-tmpl/prog/en/modules/opac-detail.tt
>index 07d4f68..bf6c39f 100644
>--- a/koha-tmpl/opac-tmpl/prog/en/modules/opac-detail.tt
>+++ b/koha-tmpl/opac-tmpl/prog/en/modules/opac-detail.tt
>@@ -1278,7 +1278,8 @@ YAHOO.util.Event.onContentReady("furtherm", function () {
>         [% END %]
>         </tr></thead>
> 	    <tbody>[% FOREACH ITEM_RESULT IN items %]
>-      <tr>[% IF ( item_level_itypes ) %]<td class="itype">[% UNLESS ( noItemTypeImages ) %][% IF ( ITEM_RESULT.imageurl ) %]<img src="[% ITEM_RESULT.imageurl %]" title="[% ITEM_RESULT.description %]" alt="[% ITEM_RESULT.description %]" />[% END %][% END %] [% ITEM_RESULT.description %]</td>[% END %]
>+      [% IF ITEM_RESULT.this_branch %]<tr class="highlight-row-detail">[% ELSE %]<tr>[% END %]
>+      [% IF ( item_level_itypes ) %]<td class="itype">[% UNLESS ( noItemTypeImages ) %][% IF ( ITEM_RESULT.imageurl ) %]<img src="[% ITEM_RESULT.imageurl %]" title="[% ITEM_RESULT.description %]" alt="[% ITEM_RESULT.description %]" />[% END %][% END %] [% ITEM_RESULT.description %]</td>[% END %]
>              <td class="location">
>     [% UNLESS ( singleBranchMode ) %]
>         <span class="[% ITEM_RESULT.branch_opac_info ? 'branch-info-tooltip-trigger' : '' %]">
>diff --git a/koha-tmpl/opac-tmpl/prog/en/modules/opac-results.tt b/koha-tmpl/opac-tmpl/prog/en/modules/opac-results.tt
>index 30682c4..1b954f8 100644
>--- a/koha-tmpl/opac-tmpl/prog/en/modules/opac-results.tt
>+++ b/koha-tmpl/opac-tmpl/prog/en/modules/opac-results.tt
>@@ -528,6 +528,7 @@ $(document).ready(function(){
>                     [% IF ( SEARCH_RESULT.available_items_loop.size() ) %]
>                     <span class="available"><strong>Copies available:</strong>
>                     [% FOREACH available_items_loo IN SEARCH_RESULT.available_items_loop %]
>+                    [% IF available_items_loo.this_branch %]<span class="highlight-row-results">[% ELSE %]<span>[% END %]
>                     [% IF ( singleBranchMode ) %]
>                         [% available_items_loo.location %]
>                     [% ELSE %]
>@@ -539,6 +540,7 @@ $(document).ready(function(){
>                         [% IF ( available_items_loo.itemcallnumber ) %][<a href="/cgi-bin/koha/opac-search.pl?q=callnum:[% available_items_loo.itemcallnumber |url %]">[% available_items_loo.itemcallnumber %]</a>][% END %]
>                     [% END %]
>                     ([% available_items_loo.count %]),
>+                    </span>
>                     [% END %]
>                     </span>
>                     [% ELSE %]
>diff --git a/opac/opac-detail.pl b/opac/opac-detail.pl
>index 94edb35..9c1b28c 100755
>--- a/opac/opac-detail.pl
>+++ b/opac/opac-detail.pl
>@@ -441,6 +441,38 @@ if ($hideitems) {
>     @items = @all_items;
> }
> 
>+my $branches = GetBranches();
>+my $branch = C4::Context->userenv->{branch};
>+if ( C4::Context->preference('HighlightOwnItemsOnOPAC') ) {
>+    if (
>+        ( ( C4::Context->preference('HighlightOwnItemsOnOPACWhich') eq 'PatronBranch' ) && $branch )
>+        ||
>+        C4::Context->preference('HighlightOwnItemsOnOPACWhich') eq 'OpacURLBranch'
>+    ) {
>+        my $branchname;
>+        if ( C4::Context->preference('HighlightOwnItemsOnOPACWhich') eq 'PatronBranch' ) {
>+            $branchname = $branches->{$branch}->{'branchname'};
>+        }
>+        elsif (  C4::Context->preference('HighlightOwnItemsOnOPACWhich') eq 'OpacURLBranch' ) {
>+            $branchname = $branches->{ $ENV{'BRANCHCODE'} }->{'branchname'};
>+        }
>+
>+        my @our_items;
>+        my @other_items;
>+
>+        foreach my $item ( @items ) {
>+           if ( $item->{'branchname'} eq $branchname ) {
>+               $item->{'this_branch'} = 1;
>+               push( @our_items, $item );
>+           } else {
>+               push( @other_items, $item );
>+           }
>+        }
>+
>+        @items = ( @our_items, @other_items );
>+    }
>+}
>+
> my $dat = &GetBiblioData($biblionumber);
> 
> my $itemtypes = GetItemTypes();
>diff --git a/opac/opac-search.pl b/opac/opac-search.pl
>index 97a7bc4..b330b05 100755
>--- a/opac/opac-search.pl
>+++ b/opac/opac-search.pl
>@@ -693,6 +693,40 @@ for (my $i=0;$i<@servers;$i++) {
>             $template->param(results_per_page =>  $results_per_page);
>             my $hide = C4::Context->preference('OpacHiddenItems');
>             $hide = ($hide =~ m/\S/) if $hide; # Just in case it has some spaces/new lines
>+
>+            my $branch = C4::Context->userenv->{branch};
>+            if ( C4::Context->preference('HighlightOwnItemsOnOPAC') ) {
>+                if (
>+                    ( ( C4::Context->preference('HighlightOwnItemsOnOPACWhich') eq 'PatronBranch' ) && $branch )
>+                    ||
>+                    C4::Context->preference('HighlightOwnItemsOnOPACWhich') eq 'OpacURLBranch'
>+                ) {
>+                    my $branchname;
>+                    if ( C4::Context->preference('HighlightOwnItemsOnOPACWhich') eq 'PatronBranch' ) {
>+                        $branchname = $branches->{$branch}->{'branchname'};
>+                    }
>+                    elsif (  C4::Context->preference('HighlightOwnItemsOnOPACWhich') eq 'OpacURLBranch' ) {
>+                        $branchname = $branches->{ $ENV{'BRANCHCODE'} }->{'branchname'};
>+                    }
>+
>+                    foreach my $res ( @newresults ) {
>+                        my @new_loop;
>+                        my @top_loop;
>+                        my @old_loop = @{$res->{'available_items_loop'}};
>+                        foreach my $item ( @old_loop ) {
>+                            if ( $item->{'branchname'} eq $branchname ) {
>+                                $item->{'this_branch'} = 1;
>+                                push( @top_loop, $item );
>+                            } else {
>+                                push( @new_loop, $item );
>+                            }
>+                        }
>+                        my @complete_loop = ( @top_loop, @new_loop );
>+                        $res->{'available_items_loop'} = \@complete_loop;
>+                    }
>+                }
>+            }
>+
>             $template->param(
>                 SEARCH_RESULTS => \@newresults,
>                 OPACItemsResultsDisplay => (C4::Context->preference("OPACItemsResultsDisplay")),
>-- 
>1.7.2.5

Actions: View | Diff | Splinter Review

Attachments on bug 7740: 13135 | 13136 | 13140 | 15118 | 16036 | 16053 | 16741 | 16742 | 16743 | 16755 | 16756 | 16757 | 16758 | 16759 | 16760 | 16811 | 16812 | 16813 | 16814