Bug 17600: Standardize our EXPORT_OK
[srvgit] / Koha / Patron / Modification.pm
index a06aec9..3c92a62 100644 (file)
@@ -4,37 +4,161 @@ package Koha::Patron::Modification;
 #
 # 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;
 
-use Carp;
 
 use Koha::Database;
+use Koha::Exceptions::Patron::Modification;
+use Koha::Patron::Attribute;
+use Koha::Patron::Attributes;
+use Koha::Patron::Modifications;
+
+use JSON qw( from_json );
+use List::MoreUtils qw( any uniq );
+use Try::Tiny qw( catch try );
 
 use base qw(Koha::Object);
 
 =head1 NAME
 
-Koha::Item - Koha Item object class
-
-=head1 API
+Koha::Patron::Modification - Class represents a request to modify or create a patron
 
 =head2 Class Methods
 
 =cut
 
+=head2 store
+
+=cut
+
+sub store {
+    my ($self) = @_;
+
+    if ( $self->verification_token ) {
+        if (Koha::Patron::Modifications->search(
+                { verification_token => $self->verification_token }
+            )->count()
+            )
+        {
+            Koha::Exceptions::Patron::Modification::DuplicateVerificationToken->throw(
+                "Duplicate verification token " . $self->verification_token );
+        }
+    }
+
+    if ( $self->extended_attributes ) {
+        try {
+            my $json_parser = JSON->new;
+            $json_parser->decode( $self->extended_attributes );
+        }
+        catch {
+            Koha::Exceptions::Patron::Modification::InvalidData->throw(
+                'The passed extended_attributes is not valid JSON');
+        };
+    }
+
+    return $self->SUPER::store();
+}
+
+=head2 approve
+
+$m->approve();
+
+Commits the pending modifications to the borrower record and removes
+them from the modifications table.
+
+=cut
+
+sub approve {
+    my ($self) = @_;
+
+    my $data = $self->unblessed();
+    my $extended_attributes;
+
+    delete $data->{timestamp};
+    delete $data->{verification_token};
+    delete $data->{extended_attributes};
+    my $changed_fields = $data->{changed_fields};
+    delete $data->{changed_fields};
+
+    my $patron = Koha::Patrons->find( $self->borrowernumber );
+    return unless $patron;
+
+    my @keep_keys = split /,/, $changed_fields;
+    my @all_keys = keys %$data;
+    foreach my $key ( @all_keys ) {
+        next if (any { $_ eq $key } @keep_keys);
+        delete $data->{$key};
+    }
+
+    $patron->set($data);
+
+    # Take care of extended attributes
+    if ( $self->extended_attributes ) {
+        $extended_attributes = try { from_json( $self->extended_attributes ) }
+        catch {
+            Koha::Exceptions::Patron::Modification::InvalidData->throw(
+                'The passed extended_attributes is not valid JSON');
+        };
+    }
+
+    $self->_result->result_source->schema->txn_do(
+        sub {
+            try {
+                $patron->store();
+
+                # Deal with attributes
+                my @codes
+                    = uniq( map { $_->{code} } @{$extended_attributes} );
+                foreach my $code (@codes) {
+                    map { $_->delete } Koha::Patron::Attributes->search(
+                        {   borrowernumber => $patron->borrowernumber,
+                            code           => $code
+                        }
+                    );
+                }
+                foreach my $attr ( @{$extended_attributes} ) {
+                    $attr->{attribute} = exists $attr->{attribute} ? $attr->{attribute} : $attr->{value};
+                    Koha::Patron::Attribute->new(
+                        {   borrowernumber => $patron->borrowernumber,
+                            code           => $attr->{code},
+                            attribute      => $attr->{attribute},
+                        }
+                    )->store
+                        if $attr->{attribute} # there's a value
+                           or
+                          (    defined $attr->{attribute} # there's a value that is 0, and not
+                            && $attr->{attribute} ne ""   # the empty string which means delete
+                            && $attr->{attribute} == 0
+                          );
+                }
+            }
+            catch {
+                if ( $_->isa('DBIx::Class::Exception') ) {
+                    Koha::Exceptions::Patron::Modification->throw( $_->{msg} );
+                }
+                else {
+                    Koha::Exceptions::Patron::Modification->throw($_);
+                }
+            };
+        }
+    );
+
+    return $self->delete();
+}
+
 =head3 type
 
 =cut