Bug 14544: Move HandleDelBorrower to C4::Members
[srvgit] / C4 / VirtualShelves / Page.pm
index 8620d7d..47efb14 100644 (file)
@@ -5,18 +5,18 @@ package C4::VirtualShelves::Page;
 #
 # This file is part of Koha.
 #
-# Koha is free software; you can redistribute it and/or modify it under the
-# terms of the GNU General Public License as published by the Free Software
-# Foundation; either version 2 of the License, or (at your option) any later
-# version.
+# Koha is free software; you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 3 of the License, or
+# (at your option) any later version.
 #
-# Koha is distributed in the hope that it will be useful, but WITHOUT ANY
-# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
-# A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
+# Koha is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
 #
-# You should have received a copy of the GNU General Public License along
-# with Koha; if not, write to the Free Software Foundation, Inc.,
-# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+# You should have received a copy of the GNU General Public License
+# along with Koha; if not, see <http://www.gnu.org/licenses>.
 
 # perldoc at the end of the file, per convention.
 
@@ -40,6 +40,8 @@ use C4::Tags qw(get_tags);
 use C4::Csv;
 use C4::XSLT;
 
+use Koha::Virtualshelves;
+
 use constant VIRTUALSHELVES_COUNT => 20;
 
 use vars qw($debug @EXPORT @ISA $VERSION);
@@ -51,6 +53,7 @@ BEGIN {
     $debug   = $ENV{DEBUG} || 0;
 }
 
+my @messages;
 our %pages = (
     intranet => { redirect => '/cgi-bin/koha/virtualshelves/shelves.pl', },
     opac     => { redirect => '/cgi-bin/koha/opac-shelves.pl', },
@@ -65,7 +68,6 @@ sub shelfpage {
     loggedinuser => $loggedinuser,
     OpacAllowPublicListCreation => C4::Context->preference('OpacAllowPublicListCreation'),
     );
-    my $edit;
     my $shelves;
     my @paramsloop;
     my $totitems;
@@ -76,14 +78,24 @@ sub shelfpage {
     my ( $shelflimit, $shelfoffset, $shelveslimit, $shelvesoffset );
     my $marcflavour = C4::Context->preference("marcflavour");
 
-    $shelflimit = ( $type eq 'opac' ? C4::Context->preference('OPACnumSearchResults') : C4::Context->preference('numSearchResults') );
-    $shelflimit = $shelflimit || ShelvesMax('MGRPAGE');
-    $shelfoffset   = ( $itemoff - 1 ) * $shelflimit;     # Sets the offset to begin retrieving items at
-    $shelveslimit  = $shelflimit;                        # Limits number of shelves returned for a given query (row_count)
-    $shelvesoffset = ( $shelfoff - 1 ) * $shelflimit;    # Sets the offset to begin retrieving shelves at (offset)
-                                                # getting the Shelves list
+    unless ( $query->param('print') ) {
+        $shelflimit = ( $type eq 'opac' ? C4::Context->preference('OPACnumSearchResults') : C4::Context->preference('numSearchResults') );
+        $shelflimit = $shelflimit || ShelvesMax('MGRPAGE');
+        $shelflimit = undef if $query->param('rss');
+        $shelfoffset   = ( $itemoff - 1 ) * $shelflimit;     # Sets the offset to begin retrieving items at
+        $shelveslimit  = $shelflimit;                        # Limits number of shelves returned for a given query (row_count)
+        $shelvesoffset = ( $shelfoff - 1 ) * $shelflimit;    # Sets the offset to begin retrieving shelves at (offset)
+    }
+
+    # getting the Shelves list
     my $category = ( ( $displaymode eq 'privateshelves' ) ? 1 : 2 );
-    my $shelflist = GetShelves( $category, $shelveslimit, $shelvesoffset, $loggedinuser );
+
+    my $shelflist;
+    if ( $category == 2 ) {
+        $shelflist = Koha::Virtualshelves->get_public_shelves({ limit => $shelveslimit, offset => $shelvesoffset });
+    } else {
+        $shelflist = Koha::Virtualshelves->get_private_shelves({ limit => $shelveslimit, offset => $shelvesoffset, borrowernumber => $loggedinuser });
+    }
     my $totshelves = C4::VirtualShelves::GetShelfCount( $loggedinuser, $category );
 
     my $op = $query->param('op');
@@ -99,7 +111,7 @@ sub shelfpage {
                     $item = GetItem( 0, $barcode);
                     if (defined $item && $item->{'itemnumber'}) {
                         $biblio = GetBiblioFromItemNumber( $item->{'itemnumber'} );
-                        AddToShelf( $biblio->{'biblionumber'}, $shelfnumber, $loggedinuser)
+                        Koha::Virtualshelves->find( $shelfnumber )->add_biblio( $biblio->{biblionumber}, $loggedinuser )
                           or push @paramsloop, { duplicatebiblio => $barcode };
                     }
                     else {
@@ -113,17 +125,17 @@ sub shelfpage {
             elsif(grep { /REM-(\d+)/ } $query->param) {
             #remove item(s) from shelf
                 if(ShelfPossibleAction($loggedinuser, $shelfnumber, 'delete')) {
-                #This is just a general okay; DelFromShelf checks further
                     my @bib;
                     foreach($query->param) {
                         /REM-(\d+)/ or next;
                         push @bib, $1; #$1 is biblionumber
                     }
-                    my $t= DelFromShelf(\@bib, $shelfnumber, $loggedinuser);
-                    if($t==0) {
+                    my $shelf = Koha::Virtualshelves->find( $shelfnumber );
+                    my $number_of_biblios_removed = $shelf->remove_biblios( { biblionumbers => \@bib, borrowernumber => $loggedinuser } );
+                    if( $number_of_biblios_removed == 0) {
                         push @paramsloop, {nothingdeleted => $shelfnumber};
                     }
-                    elsif($t<@bib) {
+                    elsif( $number_of_biblios_removed < @bib ) {
                         push @paramsloop, {somedeleted => $shelfnumber};
                     }
                 }
@@ -173,17 +185,17 @@ sub shelfpage {
                         push @paramsloop, { nopermission => $shelfnumber };
                         last SWITCH;
                 }
-                my $shelf = {
-                    shelfname          => $query->param('shelfname'),
-                    sortfield          => $query->param('sortfield'),
-                    allow_add          => $query->param('allow_add'),
-                    allow_delete_own   => $query->param('allow_delete_own'),
-                    allow_delete_other => $query->param('allow_delete_other'),
-                };
-                if($query->param('category')) { #optional
-                    $shelf->{category}= $query->param('category');
+                my $shelf = Koha::Virtualshelves->find( $shelfnumber );
+                $shelf->shelfname($query->param('shelfname'));
+                $shelf->sortfield($query->param('sortfield'));
+                $shelf->allow_add($query->param('allow_add'));
+                $shelf->allow_delete_own($query->param('allow_delete_own'));
+                $shelf->allow_delete_other($query->param('allow_delete_other'));
+                if( my $category = $query->param('category')) { #optional
+                    $shelf->category($category);
                 }
-                unless(ModShelf($shelfnumber, $shelf )) {
+                eval { $shelf->store };
+                if ( $@ ) {
                   push @paramsloop, {modifyfailure => $shelf->{shelfname}};
                   last SWITCH;
                 }
@@ -199,23 +211,22 @@ sub shelfpage {
             }
         #Editing a shelf
         elsif ( $op eq 'modif' ) {
-                my ( $shelfnumber2, $shelfname, $owner, $category, $sortfield, $allow_add, $allow_delete_own, $allow_delete_other) = GetShelf($shelfnumber);
-                my $member = GetMember( 'borrowernumber' => $owner );
+                my $shelf = Koha::Virtualshelves->find( $shelfnumber );
+                my $member = GetMember( 'borrowernumber' => $shelf->owner );
                 my $ownername = defined($member) ? $member->{firstname} . " " . $member->{surname} : '';
-                $edit = 1;
                 $template->param(
                     edit                => 1,
                     display             => $displaymode,
-                    shelfnumber         => $shelfnumber2,
-                    shelfname           => $shelfname,
-                    owner               => $owner,
+                    shelfnumber         => $shelf->shelfnumber,
+                    shelfname           => $shelf->shelfname,
+                    owner               => $shelf->owner,
                     ownername           => $ownername,
-                    "category$category" => 1,
-                    category            => $category,
-                    sortfield           => $sortfield,
-                    allow_add           => $allow_add,
-                    allow_delete_own    => $allow_delete_own,
-                    allow_delete_other  => $allow_delete_other,
+                    "category".$shelf->category => 1,
+                    category            => $shelf->category,
+                    sortfield           => $shelf->sortfield,
+                    allow_add           => $shelf->allow_add,
+                    allow_delete_own    => $shelf->allow_delete_own,
+                    allow_delete_other  => $shelf->allow_delete_other,
                 );
             }
             last SWITCH;
@@ -223,12 +234,7 @@ sub shelfpage {
 
         #View a shelf
         if ( $shelfnumber = $query->param('viewshelf') ) {
-            # explicitly fetch this shelf
-            my ($shelfnumber2,$shelfname,$owner,$category,$sorton) = GetShelf($shelfnumber);
-
-            $template->param(
-                'DisplayMultiPlaceHold' => C4::Context->preference('DisplayMultiPlaceHold'),
-            );
+            my $shelf = Koha::Virtualshelves->find( $shelfnumber );
             if (C4::Context->preference('TagsEnabled')) {
                 $template->param(TagsEnabled => 1);
                     foreach (qw(TagsShowOnList TagsInputOnList)) {
@@ -239,7 +245,7 @@ sub shelfpage {
             if ( ShelfPossibleAction( $loggedinuser, $shelfnumber, 'view' ) ) {
                 my $items;
                 my $tag_quantity;
-                my $sortfield = ( $sorton ? $sorton : 'title' );
+                my $sortfield = ( $shelf->sortfield ? $shelf->sortfield : 'title' );
                 $sortfield = $query->param('sort') || $sortfield; ## Passed in sorting overrides default sorting
                 my $direction = $query->param('direction') || 'asc';
                 $template->param(
@@ -309,13 +315,13 @@ sub shelfpage {
                         addpubshelvesloop => $pubshelves,
                     );
                 }
-                push @paramsloop, { display => 'privateshelves' } if $category == 1;
+                push @paramsloop, { display => 'privateshelves' } if $shelf->category == 1;
                 $showadd = 1;
                 my $i = 0;
                 my $manageshelf = ShelfPossibleAction( $loggedinuser, $shelfnumber, 'manage' );
                 my $can_delete_shelf = ShelfPossibleAction( $loggedinuser, $shelfnumber, 'delete_shelf' );
                 $template->param(
-                    shelfname           => $shelfname,
+                    shelfname           => $shelf->shelfname,
                     shelfnumber         => $shelfnumber,
                     viewshelf           => $shelfnumber,
                     sortfield           => $sortfield,
@@ -323,10 +329,10 @@ sub shelfpage {
                     allowremovingitems  => ShelfPossibleAction( $loggedinuser, $shelfnumber, 'delete'),
                     allowaddingitem     => ShelfPossibleAction( $loggedinuser, $shelfnumber, 'add'),
                     allowdeletingshelf  => $can_delete_shelf,
-                    "category$category" => 1,
-                    category            => $category,
+                    "category".$shelf->category => 1,
+                    category            => $shelf->category,
                     itemsloop           => $items,
-                    showprivateshelves  => $category==1,
+                    showprivateshelves  => $shelf->category==1,
                 );
             } else {
                 push @paramsloop, { nopermission => $shelfnumber };
@@ -337,30 +343,40 @@ sub shelfpage {
         if ( $query->param('shelves') ) {
             my $stay = 1;
 
-        #Add a shelf
-            if ( my $newshelf = $query->param('addshelf') ) {
+            #Add a shelf
+            my $shelfname = $query->param('addshelf');
+
+            if ( $shelfname ) {
 
                 # note: a user can always add a new shelf (except database administrator account)
-                my $shelfnumber = AddShelf( {
-                    shelfname => $newshelf,
-                    sortfield => $query->param('sortfield'),
-                    category => $query->param('category'),
-                    allow_add => $query->param('allow_add'),
-                    allow_delete_own => $query->param('allow_delete_own'),
-                    allow_delete_other => $query->param('allow_delete_other'),
-                    },
-                    $query->param('owner') );
-                $stay = 1;
-                if( !$shelfnumber ) {
-                    push @paramsloop, { addshelf_failed => 1 };
-                } elsif ( $shelfnumber == -1 ) {    #shelf already exists.
+                my $shelf = eval {
+                    Koha::Virtualshelf->new(
+                        {
+                            shelfname          => $shelfname,
+                            sortfield          => $query->param('sortfield'),
+                            category           => $query->param('category'),
+                            allow_add          => $query->param('allow_add'),
+                            allow_delete_own   => $query->param('allow_delete_own'),
+                            allow_delete_other => $query->param('allow_delete_other'),
+                            owner              => $query->param('owner'),
+                        }
+                    )->store;
+                };
+                if ( $@ ) {
                     $showadd = 1;
-                    push @paramsloop, { already => $newshelf };
-                    $template->param( shelfnumber => $shelfnumber );
+                    push @messages, { type => 'error', code => ref($@) };
+                } elsif ( not $shelf ) {
+                    $showadd = 1;
+                    push @messages, { type => 'error', 'error_on_insert' };
                 } else {
                     print $query->redirect( $pages{$type}->{redirect} . "?viewshelf=$shelfnumber" );
                     exit;
                 }
+
+                $template->param(
+                    shelfname => $shelfname,
+                );
+                $stay = 1;
             }
 
         #Deleting a shelf (asking for confirmation if it has entries)
@@ -374,7 +390,8 @@ sub shelfpage {
                 }
                 #remove a share
                 if(/REMSHR/) {
-                    RemoveShare($loggedinuser, $number);
+                    my $shelf = Koha::Virtualshelves->find( $number );
+                    $shelf->delete_share( $loggedinuser );
                     delete $shelflist->{$number} if exists $shelflist->{$number};
                     $stay=0;
                     next;
@@ -403,7 +420,7 @@ sub shelfpage {
                     $name = $shelflist->{$number}->{'shelfname'};
                     delete $shelflist->{$number};
                 }
-                unless ( DelShelf($number) ) {
+                unless( Koha::Virtualshelves->find($number)->delete ) {
                     push( @paramsloop, { delete_fail => $name } );
                     last;
                 }
@@ -427,7 +444,14 @@ sub shelfpage {
     my $numberCanManage = 0;
 
     # rebuild shelflist in case a shelf has been added
-    $shelflist = GetShelves( $category, $shelveslimit, $shelvesoffset, $loggedinuser ) unless $delflag;
+    unless ( $delflag ) {
+        if ( $category == 2 ) {
+            $shelflist = Koha::Virtualshelves->get_public_shelves({ limit => $shelveslimit, offset => $shelvesoffset });
+        } else {
+            $shelflist = Koha::Virtualshelves->get_private_shelves({ limit => $shelveslimit, offset => $shelvesoffset, borrowernumber => $loggedinuser });
+        }
+    }
+
     $totshelves = C4::VirtualShelves::GetShelfCount( $loggedinuser, $category ) unless $delflag;
     foreach my $element ( sort { lc( $shelflist->{$a}->{'shelfname'} ) cmp lc( $shelflist->{$b}->{'shelfname'} ) } keys %$shelflist ) {
         my %line;
@@ -446,7 +470,8 @@ sub shelfpage {
         $shelflist->{$element}->{ownername} = defined($member) ? $member->{firstname} . " " . $member->{surname} : '';
         $numberCanManage++ if $canmanage;    # possibly outmoded
         if ( $shelflist->{$element}->{'category'} eq '1' ) {
-            $shelflist->{$element}->{shares} = IsSharedList($element);
+            my $shelf = Koha::Virtualshelves->find( $element );
+            $shelflist->{$element}->{shares} = $shelf->is_shared;
             push( @shelveslooppriv, $shelflist->{$element} );
         } else {
             push( @shelvesloop, $shelflist->{$element} );
@@ -459,12 +484,15 @@ sub shelfpage {
         $qhash{$_} = $query->param($_) if $query->param($_);
     }
     ( scalar keys %qhash ) and $url .= '?' . join '&', map { "$_=$qhash{$_}" } keys %qhash;
-    if ( $shelfnumber && $totitems ) {
-        $template->param(  pagination_bar => pagination_bar( $url, ( int( $totitems / $shelflimit ) ) + ( ( $totitems % $shelflimit ) > 0 ? 1 : 0 ), $itemoff, "itemoff" )  );
-    } elsif ( $totshelves ) {
-        $template->param(
-             pagination_bar => pagination_bar( $url, ( int( $totshelves / $shelveslimit ) ) + ( ( $totshelves % $shelveslimit ) > 0 ? 1 : 0 ), $shelfoff, "shelfoff" )  );
+    if ( $shelflimit ) {
+        if ( $shelfnumber && $totitems ) {
+            $template->param(  pagination_bar => pagination_bar( $url, ( int( $totitems / $shelflimit ) ) + ( ( $totitems % $shelflimit ) > 0 ? 1 : 0 ), $itemoff, "itemoff" )  );
+        } elsif ( $totshelves ) {
+            $template->param(
+                 pagination_bar => pagination_bar( $url, ( int( $totshelves / $shelveslimit ) ) + ( ( $totshelves % $shelveslimit ) > 0 ? 1 : 0 ), $shelfoff, "shelfoff" )  );
+        }
     }
+
     $template->param(
         shelveslooppriv                                                    => \@shelveslooppriv,
         shelvesloop                                                        => \@shelvesloop,
@@ -473,19 +501,6 @@ sub shelfpage {
         "BiblioDefaultView" . C4::Context->preference("BiblioDefaultView") => 1,
         csv_profiles                                                       => GetCsvProfilesLoop('marc')
     );
-    if (   $shelfnumber
-        or $shelves
-        or $edit ) {
-        $template->param( vseflag => 1 );
-    }
-    if ($shelves or    # note: this part looks duplicative, but is intentional
-        $edit
-      ) {
-        $template->param( seflag => 1 );
-        #This hack is just another argument for refactoring this script one day
-        #At this point you are adding or editing a list; if you add, then you add a private list (by default) with permissions as below; if you edit, do not pass these permissions, they must come from the database
-        $template->param( allow_add => 0, allow_delete_own => 1, allow_delete_other => 0) unless $shelfnumber;
-    }
 
 #Next call updates the shelves for the Lists button.
 #May not always be needed (when nothing changed), but doesn't take much.
@@ -495,6 +510,7 @@ sub shelfpage {
             barshelvesloop => $barshelves,
             pubshelves     => $total->{pubtotal},
             pubshelvesloop => $pubshelves,
+            messages       => \@messages,
     );
 
     output_html_with_http_headers $query, $cookie, $template->output;