Bug 28606: Remove $DEBUG and $ENV{DEBUG}
[srvgit] / C4 / CourseReserves.pm
index 2b1ef02..2a6e554 100644 (file)
@@ -20,10 +20,14 @@ use Modern::Perl;
 use List::MoreUtils qw(any);
 
 use C4::Context;
-use C4::Items qw(GetItem ModItem);
 use C4::Circulation qw(GetOpenIssue);
 
-use vars qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS $DEBUG @FIELDS);
+use Koha::Courses;
+use Koha::Course::Instructors;
+use Koha::Course::Items;
+use Koha::Course::Reserves;
+
+use vars qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS @FIELDS);
 
 BEGIN {
     require Exporter;
@@ -51,8 +55,7 @@ BEGIN {
     );
     %EXPORT_TAGS = ( 'all' => \@EXPORT_OK );
 
-    $DEBUG = 0;
-    @FIELDS = ( 'itype', 'ccode', 'holdingbranch', 'location' );
+    @FIELDS = ( 'itype', 'ccode', 'homebranch', 'holdingbranch', 'location' );
 }
 
 =head1 NAME
@@ -77,21 +80,18 @@ This module deals with course reserves.
 
 sub GetCourse {
     my ($course_id) = @_;
-    warn whoami() . "( $course_id )" if $DEBUG;
 
-    my $query = "SELECT * FROM courses WHERE course_id = ?";
-    my $dbh   = C4::Context->dbh;
-    my $sth   = $dbh->prepare($query);
-    $sth->execute($course_id);
+    my $course = Koha::Courses->find( $course_id );
+    return unless $course;
+    $course = $course->unblessed;
 
-    my $course = $sth->fetchrow_hashref();
-
-    $query = "
+    my $dbh = C4::Context->dbh;
+    my $query = "
         SELECT b.* FROM course_instructors ci
         LEFT JOIN borrowers b ON ( ci.borrowernumber = b.borrowernumber )
         WHERE course_id =  ?
     ";
-    $sth = $dbh->prepare($query);
+    my $sth = $dbh->prepare($query);
     $sth->execute($course_id);
     $course->{'instructors'} = $sth->fetchall_arrayref( {} );
 
@@ -106,7 +106,6 @@ sub GetCourse {
 
 sub ModCourse {
     my (%params) = @_;
-    warn identify_myself(%params) if $DEBUG;
 
     my $dbh = C4::Context->dbh;
 
@@ -156,7 +155,6 @@ sub ModCourse {
 
 sub GetCourses {
     my (%params) = @_;
-    warn identify_myself(%params) if $DEBUG;
 
     my @query_keys;
     my @query_values;
@@ -239,7 +237,6 @@ sub DelCourse {
 
 sub EnableOrDisableCourseItems {
     my (%params) = @_;
-    warn identify_myself(%params) if $DEBUG;
 
     my $course_id = $params{'course_id'};
     my $enabled = $params{'enabled'} || 0;
@@ -288,7 +285,6 @@ sub EnableOrDisableCourseItems {
 
 sub EnableOrDisableCourseItem {
     my (%params) = @_;
-    warn identify_myself(%params) if $DEBUG;
 
     my $ci_id   = $params{'ci_id'};
 
@@ -305,7 +301,7 @@ sub EnableOrDisableCourseItem {
     ## or disable and already disabled item,
     ## as that would cause the fields to swap
     if ( $course_item->{'enabled'} ne $enabled ) {
-        _SwapAllFields($ci_id);
+        _SwapAllFields($ci_id, $enabled );
 
         my $query = "
             UPDATE course_items
@@ -327,8 +323,6 @@ sub EnableOrDisableCourseItem {
 
 sub GetCourseInstructors {
     my ($course_id) = @_;
-    warn "C4::CourseReserves::GetCourseInstructors( $course_id )"
-      if $DEBUG;
 
     my $query = "
         SELECT * FROM borrowers
@@ -357,7 +351,6 @@ sub GetCourseInstructors {
 
 sub ModCourseInstructors {
     my (%params) = @_;
-    warn identify_myself(%params) if $DEBUG;
 
     my $course_id       = $params{'course_id'};
     my $mode            = $params{'mode'};
@@ -418,7 +411,6 @@ sub ModCourseInstructors {
 
 sub GetCourseItem {
     my (%params) = @_;
-    warn identify_myself(%params) if $DEBUG;
 
     my $ci_id      = $params{'ci_id'};
     my $itemnumber = $params{'itemnumber'};
@@ -457,13 +449,8 @@ sub GetCourseItem {
 
 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);
 
@@ -495,27 +482,22 @@ sub ModCourseItem {
 
 sub _AddCourseItem {
     my (%params) = @_;
-    warn identify_myself(%params) if $DEBUG;
 
-    my ( @fields, @values );
+    $params{homebranch} ||= undef; # Can't be empty string, FK constraint
+    $params{holdingbranch} ||= undef; # Can't be empty string, FK constraint
 
-    push( @fields, 'itemnumber = ?' );
-    push( @values, $params{'itemnumber'} );
+    my %data = map { $_ => $params{$_} } @FIELDS;
+    my %enabled = map { $_ . "_enabled" => $params{ $_ . "_enabled" } } @FIELDS;
 
-    foreach (@FIELDS) {
-        if ( $params{$_} ) {
-            push( @fields, "$_ = ?" );
-            push( @values, $params{$_} );
+    my $ci = Koha::Course::Item->new(
+        {
+            itemnumber => $params{itemnumber},
+            %data,
+            %enabled,
         }
-    }
-
-    my $query = "INSERT INTO course_items SET " . join( ',', @fields );
-    my $dbh = C4::Context->dbh;
-    $dbh->do( $query, undef, @values );
-
-    my $ci_id = $dbh->last_insert_id( undef, undef, 'course_items', 'ci_id' );
+    )->store();
 
-    return $ci_id;
+    return $ci->id;
 }
 
 =head2 _UpdateCourseItem
@@ -526,94 +508,53 @@ sub _AddCourseItem {
 
 sub _UpdateCourseItem {
     my (%params) = @_;
-    warn identify_myself(%params) if $DEBUG;
 
     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 );
+    $params{homebranch} ||= undef; # Can't be empty string, FK constraint
+    $params{holdingbranch} ||= undef; # Can't be empty string, FK constraint
 
-    $course_item = GetCourseItem( ci_id => $ci_id )
-      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'} ) if %mod_params;
-
-    ## 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;
-    foreach (@FIELDS) {
-        if ( $params{$_} && !$course_item->{$_} ) {
-            $mod_params_new{$_} = $params{$_};
-            $mod_params_old{$_} = $item->{$_};
-        }
-    }
-    _ModStoredFields( 'ci_id' => $params{'ci_id'}, %mod_params_old );
-    ModItem( \%mod_params_new, undef, $course_item->{'itemnumber'} ) if %mod_params_new;
-
-}
+    return unless ( $ci_id || $course_item );
 
-=head2 _ModStoredFields
+    $course_item = Koha::Course::Items->find( $ci_id || $course_item->{ci_id} );
 
-    _ModStoredFields( %params );
+    my %data = map { $_ => $params{$_} } @FIELDS;
+    my %enabled = map { $_ . "_enabled" => $params{ $_ . "_enabled" } } @FIELDS;
 
-    Updates the values for the 'original' fields in course_items
-    for a given ci_id
+    my $item = Koha::Items->find( $course_item->itemnumber );
 
-=cut
+    # Handle updates to changed fields for a course item, both adding and removing
+    if ( $course_item->is_enabled ) {
+        my $item_fields = {};
 
-sub _ModStoredFields {
-    my (%params) = @_;
-    warn identify_myself(%params) if $DEBUG;
+        for my $field ( @FIELDS ) {
 
-    return unless ( $params{'ci_id'} );
+            my $field_enabled = $field . '_enabled';
+            my $field_storage = $field . '_storage';
 
-    my ( @fields_to_update, @values_to_update );
-
-    foreach (@FIELDS) {
-        if ( $params{$_} ) {
-            push( @fields_to_update, $_ );
-            push( @values_to_update, $params{$_} );
+            # Find newly enabled field and add item value to storage
+            if ( $params{$field_enabled} && !$course_item->$field_enabled ) {
+                $enabled{$field_storage} = $item->$field;
+                $item_fields->{$field}   = $params{$field};
+            }
+            # Find newly disabled field and copy the storage value to the item, unset storage value
+            elsif ( !$params{$field_enabled} && $course_item->$field_enabled ) {
+                $item_fields->{$field}   = $course_item->$field_storage;
+                $enabled{$field_storage} = undef;
+            }
+            # The field was already enabled, copy the incoming value to the item.
+            # The "original" ( when not on course reserve ) value is already in the storage field
+            elsif ( $course_item->$field_enabled) {
+                $item_fields->{$field} = $params{$field};
+            }
         }
-    }
 
-    my $query = "UPDATE course_items SET " . join( ',', map { "$_=?" } @fields_to_update ) . " WHERE ci_id = ?";
+        $item->set( $item_fields )->store
+            if keys %$item_fields;
+    }
 
-    C4::Context->dbh->do( $query, undef, @values_to_update, $params{'ci_id'} )
-      if (@values_to_update);
+    $course_item->update( { %data, %enabled } );
 
 }
 
@@ -621,37 +562,37 @@ sub _ModStoredFields {
 
     _RevertFields( ci_id => $ci_id, fields => \@fields_to_revert );
 
+    Copies fields from course item storage back to the actual item
+
 =cut
 
 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);
+    return unless $ci_id;
 
-    $course_item = GetCourseItem( ci_id => $params{'ci_id'} )
-      unless ($course_item);
+    my $course_item = Koha::Course::Items->find( $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, $_ );
-            }
-        }
-    }
-    ModItem( $mod_item_params, undef, $course_item->{'itemnumber'} ) if $mod_item_params && %$mod_item_params;
+    my $item_fields = {};
+    $item_fields->{itype}         = $course_item->itype_storage         if $course_item->itype_enabled;
+    $item_fields->{ccode}         = $course_item->ccode_storage         if $course_item->ccode_enabled;
+    $item_fields->{location}      = $course_item->location_storage      if $course_item->location_enabled;
+    $item_fields->{homebranch} = $course_item->homebranch_storage if $course_item->homebranch_enabled;
+    $item_fields->{holdingbranch} = $course_item->holdingbranch_storage if $course_item->holdingbranch_enabled;
 
-    my $query = "UPDATE course_items SET " . join( ',', map { "$_=NULL" } @fields_to_null ) . " WHERE ci_id = ?";
+    Koha::Items->find( $course_item->itemnumber )
+               ->set( $item_fields )
+               ->store
+        if keys %$item_fields;
 
-    C4::Context->dbh->do( $query, undef, $ci_id ) if (@fields_to_null);
+    $course_item->itype_storage(undef);
+    $course_item->ccode_storage(undef);
+    $course_item->location_storage(undef);
+    $course_item->homebranch_storage(undef);
+    $course_item->holdingbranch_storage(undef);
+    $course_item->store();
 }
 
 =head2 _SwapAllFields
@@ -661,23 +602,51 @@ sub _RevertFields {
 =cut
 
 sub _SwapAllFields {
-    my ($ci_id) = @_;
-    warn "C4::CourseReserves::_SwapFields( $ci_id )" if $DEBUG;
-
-    my $course_item = GetCourseItem( ci_id => $ci_id );
-    my $item = GetItem( $course_item->{'itemnumber'} );
-
-    my %course_item_fields;
-    my %item_fields;
-    foreach (@FIELDS) {
-        if ( $course_item->{$_} ) {
-            $course_item_fields{$_} = $course_item->{$_};
-            $item_fields{$_}        = $item->{$_};
-        }
+    my ( $ci_id, $enabled ) = @_;
+
+    my $course_item = Koha::Course::Items->find( $ci_id );
+    my $item = Koha::Items->find( $course_item->itemnumber );
+
+    if ( $enabled eq 'yes' ) { # Copy item fields to course item storage, course item fields to item
+        $course_item->itype_storage( $item->effective_itemtype )    if $course_item->itype_enabled;
+        $course_item->ccode_storage( $item->ccode )                 if $course_item->ccode_enabled;
+        $course_item->location_storage( $item->location )           if $course_item->location_enabled;
+        $course_item->homebranch_storage( $item->homebranch )       if $course_item->homebranch_enabled;
+        $course_item->holdingbranch_storage( $item->holdingbranch ) if $course_item->holdingbranch_enabled;
+        $course_item->store();
+
+        my $item_fields = {};
+        $item_fields->{itype}         = $course_item->itype         if $course_item->itype_enabled;
+        $item_fields->{ccode}         = $course_item->ccode         if $course_item->ccode_enabled;
+        $item_fields->{location}      = $course_item->location      if $course_item->location_enabled;
+        $item_fields->{homebranch}    = $course_item->homebranch    if $course_item->homebranch_enabled;
+        $item_fields->{holdingbranch} = $course_item->holdingbranch if $course_item->holdingbranch_enabled;
+
+        Koha::Items->find( $course_item->itemnumber )
+                   ->set( $item_fields )
+                   ->store
+            if keys %$item_fields;
+
+    } else { # Copy course item storage to item
+        my $item_fields = {};
+        $item_fields->{itype}         = $course_item->itype_storage         if $course_item->itype_enabled;
+        $item_fields->{ccode}         = $course_item->ccode_storage         if $course_item->ccode_enabled;
+        $item_fields->{location}      = $course_item->location_storage      if $course_item->location_enabled;
+        $item_fields->{homebranch}    = $course_item->homebranch_storage    if $course_item->homebranch_enabled;
+        $item_fields->{holdingbranch} = $course_item->holdingbranch_storage if $course_item->holdingbranch_enabled;
+
+        Koha::Items->find( $course_item->itemnumber )
+                   ->set( $item_fields )
+                   ->store
+            if keys %$item_fields;
+
+        $course_item->itype_storage(undef);
+        $course_item->ccode_storage(undef);
+        $course_item->location_storage(undef);
+        $course_item->homebranch_storage(undef);
+        $course_item->holdingbranch_storage(undef);
+        $course_item->store();
     }
-
-    ModItem( \%course_item_fields, undef, $course_item->{'itemnumber'} ) if %course_item_fields;
-    _ModStoredFields( %item_fields, ci_id => $ci_id );
 }
 
 =head2 GetCourseItems {
@@ -691,7 +660,6 @@ sub _SwapAllFields {
 
 sub GetCourseItems {
     my (%params) = @_;
-    warn identify_myself(%params) if $DEBUG;
 
     my $course_id  = $params{'course_id'};
     my $itemnumber = $params{'itemnumber'};
@@ -730,13 +698,15 @@ sub GetCourseItems {
 
 sub DelCourseItem {
     my (%params) = @_;
-    warn identify_myself(%params) if $DEBUG;
 
     my $ci_id = $params{'ci_id'};
 
     return unless ($ci_id);
 
-    _RevertFields( ci_id => $ci_id, fields => \@FIELDS );
+    my $course_item = Koha::Course::Items->find( $ci_id );
+    return unless $course_item;
+
+    _RevertFields( ci_id => $ci_id ) if $course_item->enabled eq 'yes';
 
     my $query = "
         DELETE FROM course_items
@@ -753,7 +723,6 @@ sub DelCourseItem {
 
 sub GetCourseReserve {
     my (%params) = @_;
-    warn identify_myself(%params) if $DEBUG;
 
     my $cr_id     = $params{'cr_id'};
     my $course_id = $params{'course_id'};
@@ -792,7 +761,6 @@ sub GetCourseReserve {
 
 sub ModCourseReserve {
     my (%params) = @_;
-    warn identify_myself(%params) if $DEBUG;
 
     my $course_id   = $params{'course_id'};
     my $ci_id       = $params{'ci_id'};
@@ -849,7 +817,6 @@ sub ModCourseReserve {
 
 sub GetCourseReserves {
     my (%params) = @_;
-    warn identify_myself(%params) if $DEBUG;
 
     my $course_id       = $params{'course_id'};
     my $ci_id           = $params{'ci_id'};
@@ -910,7 +877,6 @@ sub GetCourseReserves {
 
 sub DelCourseReserve {
     my (%params) = @_;
-    warn identify_myself(%params) if $DEBUG;
 
     my $cr_id = $params{'cr_id'};
 
@@ -945,7 +911,6 @@ sub DelCourseReserve {
 
 sub GetItemCourseReservesInfo {
     my (%params) = @_;
-    warn identify_myself(%params) if $DEBUG;
 
     my $itemnumber = $params{'itemnumber'};
 
@@ -980,7 +945,6 @@ sub GetItemCourseReservesInfo {
 
 sub CountCourseReservesForItem {
     my (%params) = @_;
-    warn identify_myself(%params) if $DEBUG;
 
     my $ci_id      = $params{'ci_id'};
     my $itemnumber = $params{'itemnumber'};
@@ -1018,16 +982,15 @@ sub CountCourseReservesForItem {
 
 sub SearchCourses {
     my (%params) = @_;
-    warn identify_myself(%params) if $DEBUG;
 
     my $term = $params{'term'};
 
     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
@@ -1051,7 +1014,7 @@ 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 //= '';
@@ -1089,12 +1052,6 @@ sub stringify_params {
     return "( $string )";
 }
 
-sub identify_myself {
-    my (%params) = @_;
-
-    return whowasi() . stringify_params(%params);
-}
-
 1;
 
 =head1 AUTHOR