Bug 18736: (follow-up) Add tests and FIXME for GetbudgetsPlanCell
[koha.git] / C4 / CourseReserves.pm
index f8ebb26..428d7e9 100644 (file)
@@ -2,33 +2,33 @@ package C4::CourseReserves;
 
 # 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., 59 Temple Place,
-# Suite 330, Boston, MA  02111-1307 USA
+# You should have received a copy of the GNU General Public License
+# along with Koha; if not, see <http://www.gnu.org/licenses>.
 
 use Modern::Perl;
 
-require Exporter;
+use List::MoreUtils qw(any);
 
 use C4::Context;
-use C4::Items qw(GetItem ModItem);
-use C4::Biblio qw(GetBiblioFromItemNumber);
+use C4::Items qw(ModItem);
 use C4::Circulation qw(GetOpenIssue);
 
-use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS $DEBUG @FIELDS);
+use vars qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS $DEBUG @FIELDS);
 
 BEGIN {
-    @ISA    = qw(Exporter);
-    @EXPORT = qw(
+    require Exporter;
+    @ISA       = qw(Exporter);
+    @EXPORT_OK = qw(
       &GetCourse
       &ModCourse
       &GetCourses
@@ -47,8 +47,9 @@ BEGIN {
 
       &SearchCourses
 
-      &GetItemReservesInfo
+      &GetItemCourseReservesInfo
     );
+    %EXPORT_TAGS = ( 'all' => \@EXPORT_OK );
 
     $DEBUG = 0;
     @FIELDS = ( 'itype', 'ccode', 'holdingbranch', 'location' );
@@ -161,9 +162,9 @@ sub GetCourses {
     my @query_values;
 
     my $query = "
-        SELECT courses.*
-        FROM courses
-        LEFT JOIN course_reserves ON course_reserves.course_id = courses.course_id
+        SELECT c.course_id, c.department, c.course_number, c.section, c.course_name, c.term, c.staff_note, c.public_note, c.students_count, c.enabled, c.timestamp
+        FROM courses c
+        LEFT JOIN course_reserves ON course_reserves.course_id = c.course_id
         LEFT JOIN course_items ON course_items.ci_id = course_reserves.ci_id
     ";
 
@@ -179,7 +180,7 @@ sub GetCourses {
         $query .= join( ' AND ', @query_keys );
     }
 
-    $query .= " GROUP BY courses.course_id ";
+    $query .= " GROUP BY c.course_id, c.department, c.course_number, c.section, c.course_name, c.term, c.staff_note, c.public_note, c.students_count, c.enabled, c.timestamp ";
 
     my $dbh = C4::Context->dbh;
     my $sth = $dbh->prepare($query);
@@ -241,7 +242,7 @@ sub EnableOrDisableCourseItems {
     warn identify_myself(%params) if $DEBUG;
 
     my $course_id = $params{'course_id'};
-    my $enabled   = $params{'enabled'} || 0;
+    my $enabled = $params{'enabled'} || 0;
 
     my $lookfor = ( $enabled eq 'yes' ) ? 'no' : 'yes';
 
@@ -252,16 +253,13 @@ sub EnableOrDisableCourseItems {
 
     if ( $enabled eq 'yes' ) {
         foreach my $course_reserve (@$course_reserves) {
-            if (
-                CountCourseReservesForItem(
+            if (CountCourseReservesForItem(
                     ci_id   => $course_reserve->{'ci_id'},
                     enabled => 'yes'
                 )
-              )
-            {
+              ) {
                 EnableOrDisableCourseItem(
                     ci_id   => $course_reserve->{'ci_id'},
-                    enabled => 'yes',
                 );
             }
         }
@@ -273,11 +271,9 @@ sub EnableOrDisableCourseItems {
                     ci_id   => $course_reserve->{'ci_id'},
                     enabled => 'yes'
                 )
-              )
-            {
+              ) {
                 EnableOrDisableCourseItem(
                     ci_id   => $course_reserve->{'ci_id'},
-                    enabled => 'no',
                 );
             }
         }
@@ -286,10 +282,7 @@ sub EnableOrDisableCourseItems {
 
 =head2 EnableOrDisableCourseItem
 
-    EnableOrDisableCourseItem( ci_id => $ci_id, enabled => $enabled );
-
-    enabled => 'yes' to enable course items
-    enabled => 'no' to disable course items
+    EnableOrDisableCourseItem( ci_id => $ci_id );
 
 =cut
 
@@ -298,13 +291,16 @@ sub EnableOrDisableCourseItem {
     warn identify_myself(%params) if $DEBUG;
 
     my $ci_id   = $params{'ci_id'};
-    my $enabled = $params{'enabled'};
 
-    return unless ( $ci_id && $enabled );
-    return unless ( $enabled eq 'yes' || $enabled eq 'no' );
+    return unless ( $ci_id );
 
     my $course_item = GetCourseItem( ci_id => $ci_id );
 
+    my $info = GetItemCourseReservesInfo( itemnumber => $course_item->{itemnumber} );
+
+    my $enabled = any { $_->{course}->{enabled} eq 'yes' } @$info;
+    $enabled = $enabled ? 'yes' : 'no';
+
     ## We don't want to 'enable' an already enabled item,
     ## or disable and already disabled item,
     ## as that would cause the fields to swap
@@ -376,8 +372,9 @@ sub ModCourseInstructors {
     return unless ( $cardnumbers || $borrowernumbers );
     return if ( $cardnumbers && $borrowernumbers );
 
-    my @cardnumbers = @$cardnumbers if ( ref($cardnumbers) eq 'ARRAY' );
-    my @borrowernumbers = @$borrowernumbers
+    my ( @cardnumbers, @borrowernumbers );
+    @cardnumbers = @$cardnumbers if ( ref($cardnumbers) eq 'ARRAY' );
+    @borrowernumbers = @$borrowernumbers
       if ( ref($borrowernumbers) eq 'ARRAY' );
 
     my $field  = (@cardnumbers) ? 'cardnumber' : 'borrowernumber';
@@ -386,8 +383,7 @@ sub ModCourseInstructors {
 
     my $dbh = C4::Context->dbh;
 
-    $dbh->do( "DELETE FROM course_instructors WHERE course_id = ?",
-        undef, $course_id )
+    $dbh->do( "DELETE FROM course_instructors WHERE course_id = ?", undef, $course_id )
       if ( $mode eq 'replace' );
 
     my $query;
@@ -399,8 +395,7 @@ sub ModCourseInstructors {
             FROM borrowers
             WHERE $field IN ( $placeholders )
         ";
-    }
-    else {
+    } else {
         $query = "
             DELETE FROM course_instructors
             WHERE course_id = ?
@@ -464,11 +459,7 @@ sub ModCourseItem {
     my (%params) = @_;
     warn identify_myself(%params) if $DEBUG;
 
-    my $itemnumber    = $params{'itemnumber'};
-    my $itype         = $params{'itype'};
-    my $ccode         = $params{'ccode'};
-    my $holdingbranch = $params{'holdingbranch'};
-    my $location      = $params{'location'};
+    my $itemnumber = $params{'itemnumber'};
 
     return unless ($itemnumber);
 
@@ -484,8 +475,7 @@ sub ModCourseItem {
             course_item => $course_item,
             %params
         );
-    }
-    else {
+    } else {
         $ci_id = _AddCourseItem(%params);
     }
 
@@ -509,10 +499,8 @@ sub _AddCourseItem {
     push( @values, $params{'itemnumber'} );
 
     foreach (@FIELDS) {
-        if ( $params{$_} ) {
-            push( @fields, "$_ = ?" );
-            push( @values, $params{$_} );
-        }
+        push( @fields, "$_ = ?" );
+        push( @values, $params{$_} || undef );
     }
 
     my $query = "INSERT INTO course_items SET " . join( ',', @fields );
@@ -536,10 +524,6 @@ sub _UpdateCourseItem {
 
     my $ci_id         = $params{'ci_id'};
     my $course_item   = $params{'course_item'};
-    my $itype         = $params{'itype'};
-    my $ccode         = $params{'ccode'};
-    my $holdingbranch = $params{'holdingbranch'};
-    my $location      = $params{'location'};
 
     return unless ( $ci_id || $course_item );
 
@@ -547,50 +531,13 @@ sub _UpdateCourseItem {
       unless ($course_item);
     $ci_id = $course_item->{'ci_id'} unless ($ci_id);
 
-    ## Revert fields that had an 'original' value, but now don't
-    ## Update the item fields to the stored values from course_items
-    ## and then set those fields in course_items to NULL
-    my @fields_to_revert;
-    foreach (@FIELDS) {
-        if ( !$params{$_} && $course_item->{$_} ) {
-            push( @fields_to_revert, $_ );
-        }
-    }
-    _RevertFields(
-        ci_id       => $ci_id,
-        fields      => \@fields_to_revert,
-        course_item => $course_item
-    ) if (@fields_to_revert);
-
-    ## Update fields that still have an original value, but it has changed
-    ## This necessitates only changing the current item values, as we still
-    ## have the original values stored in course_items
-    my %mod_params;
-    foreach (@FIELDS) {
-        if (   $params{$_}
-            && $course_item->{$_}
-            && $params{$_} ne $course_item->{$_} )
-        {
-            $mod_params{$_} = $params{$_};
-        }
-    }
-    ModItem( \%mod_params, undef, $course_item->{'itemnumber'} );
 
-    ## Update fields that didn't have an original value, but now do
-    ## We must save the original value in course_items, and also
-    ## update the item fields to the new value
-    my $item = GetItem( $course_item->{'itemnumber'} );
-    my %mod_params_new;
-    my %mod_params_old;
+    my %mod_params;
     foreach (@FIELDS) {
-        if ( $params{$_} && !$course_item->{$_} ) {
-            $mod_params_new{$_} = $params{$_};
-            $mod_params_old{$_} = $item->{$_};
-        }
+        $mod_params{$_} = $params{$_};
     }
-    _ModStoredFields( 'ci_id' => $params{'ci_id'}, %mod_params_old );
-    ModItem( \%mod_params_new, undef, $course_item->{'itemnumber'} );
 
+    ModItem( \%mod_params, undef, $course_item->{'itemnumber'} );
 }
 
 =head2 _ModStoredFields
@@ -611,16 +558,13 @@ sub _ModStoredFields {
     my ( @fields_to_update, @values_to_update );
 
     foreach (@FIELDS) {
-        if ( $params{$_} ) {
+        if ( defined($params{$_}) ) {
             push( @fields_to_update, $_ );
             push( @values_to_update, $params{$_} );
         }
     }
 
-    my $query =
-        "UPDATE course_items SET "
-      . join( ',', map { "$_=?" } @fields_to_update )
-      . " WHERE ci_id = ?";
+    my $query = "UPDATE course_items SET " . join( ',', map { "$_=?" } @fields_to_update ) . " WHERE ci_id = ?";
 
     C4::Context->dbh->do( $query, undef, @values_to_update, $params{'ci_id'} )
       if (@values_to_update);
@@ -637,34 +581,18 @@ sub _RevertFields {
     my (%params) = @_;
     warn identify_myself(%params) if $DEBUG;
 
-    my $ci_id       = $params{'ci_id'};
-    my $course_item = $params{'course_item'};
-    my $fields      = $params{'fields'};
-    my @fields      = @$fields;
+    my $ci_id = $params{'ci_id'};
 
     return unless ($ci_id);
 
-    $course_item = GetCourseItem( ci_id => $params{'ci_id'} )
-      unless ($course_item);
+    my $course_item = GetCourseItem( ci_id => $params{'ci_id'} );
 
     my $mod_item_params;
-    my @fields_to_null;
-    foreach my $field (@fields) {
-        foreach (@FIELDS) {
-            if ( $field eq $_ && $course_item->{$_} ) {
-                $mod_item_params->{$_} = $course_item->{$_};
-                push( @fields_to_null, $_ );
-            }
-        }
+    foreach my $field ( @FIELDS ) {
+        $mod_item_params->{$field} = $course_item->{$field};
     }
-    ModItem( $mod_item_params, undef, $course_item->{'itemnumber'} );
-
-    my $query =
-        "UPDATE course_items SET "
-      . join( ',', map { "$_=NULL" } @fields_to_null )
-      . " WHERE ci_id = ?";
 
-    C4::Context->dbh->do( $query, undef, $ci_id ) if (@fields_to_null);
+    ModItem( $mod_item_params, undef, $course_item->{'itemnumber'} ) if $mod_item_params && %$mod_item_params;
 }
 
 =head2 _SwapAllFields
@@ -678,18 +606,18 @@ sub _SwapAllFields {
     warn "C4::CourseReserves::_SwapFields( $ci_id )" if $DEBUG;
 
     my $course_item = GetCourseItem( ci_id => $ci_id );
-    my $item = GetItem( $course_item->{'itemnumber'} );
+    my $item = Koha::Items->find($course_item->{'itemnumber'});
 
     my %course_item_fields;
     my %item_fields;
     foreach (@FIELDS) {
-        if ( $course_item->{$_} ) {
+        if ( defined( $course_item->{$_} ) ) {
             $course_item_fields{$_} = $course_item->{$_};
-            $item_fields{$_}        = $item->{$_};
+            $item_fields{$_}        = $item->$_ || q{};
         }
     }
 
-    ModItem( \%course_item_fields, undef, $course_item->{'itemnumber'} );
+    ModItem( \%course_item_fields, undef, $course_item->{'itemnumber'} ) if %course_item_fields;
     _ModStoredFields( %item_fields, ci_id => $ci_id );
 }
 
@@ -749,7 +677,7 @@ sub DelCourseItem {
 
     return unless ($ci_id);
 
-    _RevertFields( ci_id => $ci_id, fields => \@FIELDS );
+    _RevertFields( ci_id => $ci_id );
 
     my $query = "
         DELETE FROM course_items
@@ -784,8 +712,7 @@ sub GetCourseReserve {
         ";
         $sth = $dbh->prepare($query);
         $sth->execute($cr_id);
-    }
-    else {
+    } else {
         my $query = "
             SELECT * FROM course_reserves
             WHERE course_id = ? AND ci_id = ?
@@ -815,8 +742,7 @@ sub ModCourseReserve {
 
     return unless ( $course_id && $ci_id );
 
-    my $course_reserve =
-      GetCourseReserve( course_id => $course_id, ci_id => $ci_id );
+    my $course_reserve = GetCourseReserve( course_id => $course_id, ci_id => $ci_id );
     my $cr_id;
 
     my $dbh = C4::Context->dbh;
@@ -830,8 +756,7 @@ sub ModCourseReserve {
             WHERE cr_id = ?
         ";
         $dbh->do( $query, undef, $staff_note, $public_note, $cr_id );
-    }
-    else {
+    } else {
         my $query = "
             INSERT INTO course_reserves SET
             course_id = ?,
@@ -839,16 +764,12 @@ sub ModCourseReserve {
             staff_note = ?,
             public_note = ?
         ";
-        $dbh->do( $query, undef, $course_id, $ci_id, $staff_note,
-            $public_note );
-        $cr_id =
-          $dbh->last_insert_id( undef, undef, 'course_reserves', 'cr_id' );
+        $dbh->do( $query, undef, $course_id, $ci_id, $staff_note, $public_note );
+        $cr_id = $dbh->last_insert_id( undef, undef, 'course_reserves', 'cr_id' );
     }
 
-    my $course = GetCourse($course_id);
     EnableOrDisableCourseItem(
         ci_id   => $params{'ci_id'},
-        enabled => $course->{'enabled'}
     );
 
     return $cr_id;
@@ -871,10 +792,10 @@ sub GetCourseReserves {
     my (%params) = @_;
     warn identify_myself(%params) if $DEBUG;
 
-    my $course_id     = $params{'course_id'};
-    my $ci_id         = $params{'ci_id'};
-    my $include_items = $params{'include_items'};
-    my $include_count = $params{'include_count'};
+    my $course_id       = $params{'course_id'};
+    my $ci_id           = $params{'ci_id'};
+    my $include_items   = $params{'include_items'};
+    my $include_count   = $params{'include_count'};
     my $include_courses = $params{'include_courses'};
 
     return unless ( $course_id || $ci_id );
@@ -896,23 +817,26 @@ sub GetCourseReserves {
 
     if ($include_items) {
         foreach my $cr (@$course_reserves) {
+            my $item = Koha::Items->find( $cr->{itemnumber} );
+            my $biblio = $item->biblio;
+            my $biblioitem = $biblio->biblioitem;
             $cr->{'course_item'} = GetCourseItem( ci_id => $cr->{'ci_id'} );
-            $cr->{'item'} = GetBiblioFromItemNumber( $cr->{'itemnumber'} );
-            $cr->{'issue'} = GetOpenIssue( $cr->{'itemnumber'} );
+            $cr->{'item'}        = $item;
+            $cr->{'biblio'}      = $biblio;
+            $cr->{'biblioitem'}  = $biblioitem;
+            $cr->{'issue'}       = GetOpenIssue( $cr->{'itemnumber'} );
         }
     }
 
     if ($include_count) {
         foreach my $cr (@$course_reserves) {
-            $cr->{'reserves_count'} =
-              CountCourseReservesForItem( ci_id => $cr->{'ci_id'} );
+            $cr->{'reserves_count'} = CountCourseReservesForItem( ci_id => $cr->{'ci_id'} );
         }
     }
 
     if ($include_courses) {
         foreach my $cr (@$course_reserves) {
-            $cr->{'courses'} =
-              GetCourses( itemnumber => $cr->{'itemnumber'} );
+            $cr->{'courses'} = GetCourses( itemnumber => $cr->{'itemnumber'} );
         }
     }
 
@@ -945,23 +869,22 @@ sub DelCourseReserve {
 
     ## If there are no other course reserves for this item
     ## delete the course_item as well
-    unless ( CountCourseReservesForItem( ci_id => $course_reserve->{'ci_id'} ) )
-    {
+    unless ( CountCourseReservesForItem( ci_id => $course_reserve->{'ci_id'} ) ) {
         DelCourseItem( ci_id => $course_reserve->{'ci_id'} );
     }
 
 }
 
-=head2 GetReservesInfo
+=head2 GetItemCourseReservesInfo
 
-    my $arrayref = GetItemReservesInfo( itemnumber => $itemnumber );
+    my $arrayref = GetItemCourseReservesInfo( itemnumber => $itemnumber );
 
     For a given item, returns an arrayref of reserves hashrefs,
     with a course hashref under the key 'course'
 
 =cut
 
-sub GetItemReservesInfo {
+sub GetItemCourseReservesInfo {
     my (%params) = @_;
     warn identify_myself(%params) if $DEBUG;
 
@@ -1006,8 +929,7 @@ sub CountCourseReservesForItem {
 
     return unless ( $ci_id || $itemnumber );
 
-    my $course_item =
-      GetCourseItem( ci_id => $ci_id, itemnumber => $itemnumber );
+    my $course_item = GetCourseItem( ci_id => $ci_id, itemnumber => $itemnumber );
 
     my @params = ( $course_item->{'ci_id'} );
     push( @params, $enabled ) if ($enabled);
@@ -1044,9 +966,9 @@ sub SearchCourses {
     my $enabled = $params{'enabled'} || '%';
 
     my @params;
-    my $query = "SELECT c.* FROM courses c";
-
-    $query .= "
+    my $query = "
+        SELECT c.course_id, c.department, c.course_number, c.section, c.course_name, c.term, c.staff_note, c.public_note, c.students_count, c.enabled, c.timestamp
+        FROM courses c
         LEFT JOIN course_instructors ci
             ON ( c.course_id = ci.course_id )
         LEFT JOIN borrowers b
@@ -1070,9 +992,10 @@ sub SearchCourses {
            )
            AND
            c.enabled LIKE ?
-        GROUP BY c.course_id
+        GROUP BY c.course_id, c.department, c.course_number, c.section, c.course_name, c.term, c.staff_note, c.public_note, c.students_count, c.enabled, c.timestamp
     ";
 
+    $term //= '';
     $term   = "%$term%";
     @params = ($term) x 10;
 
@@ -1081,7 +1004,7 @@ sub SearchCourses {
     my $dbh = C4::Context->dbh;
     my $sth = $dbh->prepare($query);
 
-    $sth->execute(@params, $enabled);
+    $sth->execute( @params, $enabled );
 
     my $courses = $sth->fetchall_arrayref( {} );