Bug 23463: Replace new occurrence of AddItem
[srvgit] / Koha / Patrons.pm
index 4a5f63c..2a28945 100644 (file)
@@ -5,18 +5,18 @@ package Koha::Patrons;
 #
 # 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 3 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>.
 
 use Modern::Perl;
 
@@ -29,6 +29,8 @@ use Koha::ArticleRequests;
 use Koha::ArticleRequest::Status;
 use Koha::Patron;
 use Koha::Exceptions::Patron;
+use Koha::Patron::Categories;
+use Date::Calc qw( Today Add_Delta_YMD );
 
 use base qw(Koha::Objects);
 
@@ -200,7 +202,7 @@ sub anonymise_issue_history {
 
 =head3 delete
 
-    Koha::Patrons->search({ some filters here })->delete({ move => 1, verbose => 1 });
+    Koha::Patrons->search({ some filters here })->delete({ move => 1 });
 
     Delete passed set of patron objects.
     Wrapper for Koha::Patron->delete. (We do not want to bypass Koha::Patron
@@ -218,12 +220,15 @@ sub delete {
     $self->_resultset->result_source->schema->txn_do( sub {
         my ( $set, $params ) = @_;
         my $count = $set->count;
-        while( my $patron = $set->next ) {
+        while ( my $patron = $set->next ) {
+
+            next unless $patron->in_storage;
+
             $patron->move_to_deleted if $params->{move};
-            $patron->delete == 1 || Koha::Exceptions::Patron::FailedDelete->throw;
+            $patron->delete;
+
             $patrons_deleted++;
         }
-        warn "Deleted $count patrons\n" if $params->{verbose};
     }, $self, $params );
     return $patrons_deleted;
 }
@@ -285,7 +290,7 @@ sub search_anonymize_candidates {
     $cond->{dateexpiry} = { '<=' => $str };
     $cond->{anonymized} = 0; # not yet done
     if( $params->{locked} ) {
-        my $fails = C4::Context->preference('FailedLoginAttempts');
+        my $fails = C4::Context->preference('FailedLoginAttempts') || 0;
         $cond->{login_attempts} = [ -and => { '!=' => undef }, { -not_in => [0, 1..$fails-1 ] } ]; # -not_in does not like undef
     }
     return $class->search( $cond );
@@ -320,10 +325,9 @@ sub search_anonymized {
 
 =head3 lock
 
-    Koha::Patrons->search({ some filters })->lock({ expire => 1, remove => 1, verbose => 1 })
+    Koha::Patrons->search({ some filters })->lock({ expire => 1, remove => 1 })
 
     Lock the passed set of patron objects. Optionally expire and remove holds.
-    Optional verbose flag is used in cron job.
     Wrapper around Koha::Patron->lock.
 
 =cut
@@ -334,30 +338,93 @@ sub lock {
     while( my $patron = $self->next ) {
         $patron->lock($params);
     }
-    if( $params->{verbose} ) {
-        warn "Locked $count patrons\n";
-    }
 }
 
 =head3 anonymize
 
-    Koha::Patrons->search({ some filters })->anonymize({ verbose => 1 });
+    Koha::Patrons->search({ some filters })->anonymize();
 
     Anonymize passed set of patron objects.
-    Optional verbose flag is used in cron job.
     Wrapper around Koha::Patron->anonymize.
 
 =cut
 
 sub anonymize {
-    my ( $self, $params ) = @_;
+    my ( $self ) = @_;
     my $count = $self->count;
     while( my $patron = $self->next ) {
         $patron->anonymize;
     }
-    if( $params->{verbose} ) {
-        warn "Anonymized $count patrons\n";
+}
+
+=head3 search_patrons_to_update_category
+
+    my $patrons = Koha::Patrons->search_patrons_to_update_category( {
+                      from          => $from_category,
+                      fine_max      => $fine_max,
+                      fine_min      => $fin_min,
+                      too_young     => $too_young,
+                      too_old      => $too_old,
+                  });
+
+This method returns all patron who should be updated from one category to another meeting criteria:
+
+from          - borrower categorycode
+fine_min      - with fines totaling at least this amount
+fine_max      - with fines above this amount
+too_young     - if passed, select patrons who are under the age limit for the current category
+too_old       - if passed, select patrons who are over the age limit for the current category
+
+=cut
+
+sub search_patrons_to_update_category {
+    my ( $self, $params ) = @_;
+    my %query;
+    my $search_params;
+
+    my $cat_from = Koha::Patron::Categories->find($params->{from});
+    $search_params->{categorycode}=$params->{from};
+    if ($params->{too_young} || $params->{too_old}){
+        my $dtf = Koha::Database->new->schema->storage->datetime_parser;
+        if( $cat_from->dateofbirthrequired && $params->{too_young} ) {
+            my $date_after = dt_from_string()->subtract( years => $cat_from->dateofbirthrequired);
+            $search_params->{dateofbirth}{'>'} = $dtf->format_datetime( $date_after );
+        }
+        if( $cat_from->upperagelimit && $params->{too_old} ) {
+            my $date_before = dt_from_string()->subtract( years => $cat_from->upperagelimit);
+            $search_params->{dateofbirth}{'<'} = $dtf->format_datetime( $date_before );
+        }
+    }
+    if ($params->{fine_min} || $params->{fine_max}) {
+        $query{join} = ["accountlines"];
+        $query{select} = ["borrowernumber", "accountlines.amountoutstanding" ];
+        $query{group_by} = ["borrowernumber"];
+        $query{having} = \['sum(accountlines.amountoutstanding) <= ?',$params->{fine_max}] if defined $params->{fine_max};
+        $query{having} = \['sum(accountlines.amountoutstanding) >= ?',$params->{fine_min}] if defined $params->{fine_min};
+    }
+    return $self->search($search_params,\%query);
+}
+
+=head3 update_category_to
+
+    Koha::Patrons->search->update_category_to( {
+            category   => $to_category,
+        });
+
+Update supplied patrons from current category to another and take care of guarantor info.
+To make sure all the conditions are met, the caller has the responsibility to
+call search_patrons_to_update to filter the Koha::Patrons set
+
+=cut
+
+sub update_category_to {
+    my ( $self, $params ) = @_;
+    my $counter = 0;
+    while( my $patron = $self->next ) {
+        $counter++;
+        $patron->categorycode($params->{category})->store();
     }
+    return $counter;
 }
 
 =head3 _type