# 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 Mojo::Base 'Mojolicious::Controller';
-use C4::Members qw( AddMember ModMember );
+use Koha::Database;
use Koha::Patrons;
-use Scalar::Util qw(blessed);
-use Try::Tiny;
+use Scalar::Util qw( blessed );
+use Try::Tiny qw( catch try );
=head1 NAME
my $c = shift->openapi->valid_input or return;
return try {
- my $patrons_set = Koha::Patrons->new;
- my @patrons = $c->objects->search( $patrons_set )->as_list;
- return $c->render( status => 200, openapi => \@patrons );
+
+ my $query = {};
+ my $restricted = delete $c->validation->output->{restricted};
+ $query->{debarred} = { '!=' => undef }
+ if $restricted;
+
+ my $patrons_rs = Koha::Patrons->search($query);
+ my $patrons = $c->objects->search( $patrons_rs );
+
+ return $c->render(
+ status => 200,
+ openapi => $patrons
+ );
}
catch {
- if ( $_->isa('DBIx::Class::Exception') ) {
- return $c->render( status => 500,
- openapi => { error => $_->{msg} } );
- }
- else {
- return $c->render(
- status => 500,
- openapi => { error => "Something went wrong, check the logs." }
- );
- }
+ $c->unhandled_exception($_);
};
}
sub get {
my $c = shift->openapi->valid_input or return;
- my $borrowernumber = $c->validation->param('borrowernumber');
- my $patron = Koha::Patrons->find($borrowernumber);
+ return try {
+ my $patron_id = $c->validation->param('patron_id');
+ my $patron = $c->objects->find( Koha::Patrons->new, $patron_id );
- unless ($patron) {
- return $c->render(status => 404, openapi => { error => "Patron not found." });
- }
+ unless ($patron) {
+ return $c->render(
+ status => 404,
+ openapi => { error => "Patron not found." }
+ );
+ }
- return $c->render(status => 200, openapi => $patron);
+ return $c->render(
+ status => 200,
+ openapi => $patron
+ );
+ }
+ catch {
+ $c->unhandled_exception($_);
+ };
}
=head3 add
my $c = shift->openapi->valid_input or return;
return try {
- my $body = $c->validation->param('body');
- Koha::Patron->new($body)->_validate;
+ Koha::Database->new->schema->txn_do(
+ sub {
+
+ my $body = $c->validation->param('body');
- # TODO: Use AddMember until it has been moved to Koha-namespace
- my $borrowernumber = AddMember(%$body);
- my $patron = Koha::Patrons->find($borrowernumber);
+ my $extended_attributes = delete $body->{extended_attributes} // [];
- return $c->render( status => 201, openapi => $patron );
+ my $patron = Koha::Patron->new_from_api($body)->store;
+ $patron->extended_attributes(
+ [
+ map { { code => $_->{type}, attribute => $_->{value} } }
+ @$extended_attributes
+ ]
+ );
+
+ $c->res->headers->location($c->req->url->to_string . '/' . $patron->borrowernumber);
+ return $c->render(
+ status => 201,
+ openapi => $patron->to_api
+ );
+ }
+ );
}
catch {
- unless ( blessed $_ && $_->can('rethrow') ) {
- return $c->render(
- status => 500,
- openapi => {
- error => "Something went wrong, check Koha logs for details."
- }
- );
- }
- if ( $_->isa('Koha::Exceptions::Patron::DuplicateObject') ) {
- return $c->render(
- status => 409,
- openapi => { error => $_->error, conflict => $_->conflict }
- );
- }
- elsif ( $_->isa('Koha::Exceptions::Library::BranchcodeNotFound') ) {
- return $c->render(
- status => 400,
- openapi => { error => "Given branchcode does not exist" }
- );
- }
- elsif ( $_->isa('Koha::Exceptions::Category::CategorycodeNotFound') ) {
- return $c->render(
- status => 400,
- openapi => { error => "Given categorycode does not exist" }
- );
- }
- else {
- return $c->render(
- status => 500,
- openapi => {
- error => "Something went wrong, check Koha logs for details."
- }
- );
+
+ my $to_api_mapping = Koha::Patron->new->to_api_mapping;
+
+ if ( blessed $_ ) {
+ if ( $_->isa('Koha::Exceptions::Object::DuplicateID') ) {
+ return $c->render(
+ status => 409,
+ openapi => { error => $_->error, conflict => $_->duplicate_id }
+ );
+ }
+ elsif ( $_->isa('Koha::Exceptions::Object::FKConstraint') ) {
+ return $c->render(
+ status => 400,
+ openapi => {
+ error => "Given "
+ . $to_api_mapping->{ $_->broken_fk }
+ . " does not exist"
+ }
+ );
+ }
+ elsif ( $_->isa('Koha::Exceptions::BadParameter') ) {
+ return $c->render(
+ status => 400,
+ openapi => {
+ error => "Given "
+ . $to_api_mapping->{ $_->parameter }
+ . " does not exist"
+ }
+ );
+ }
+ elsif (
+ $_->isa('Koha::Exceptions::Patron::MissingMandatoryExtendedAttribute')
+ )
+ {
+ return $c->render(
+ status => 400,
+ openapi => { error => "$_" }
+ );
+ }
+ elsif (
+ $_->isa('Koha::Exceptions::Patron::Attribute::InvalidType')
+ )
+ {
+ return $c->render(
+ status => 400,
+ openapi => { error => "$_" }
+ );
+ }
+ elsif (
+ $_->isa('Koha::Exceptions::Patron::Attribute::NonRepeatable')
+ )
+ {
+ return $c->render(
+ status => 400,
+ openapi => { error => "$_" }
+ );
+ }
+ elsif (
+ $_->isa('Koha::Exceptions::Patron::Attribute::UniqueIDConstraint')
+ )
+ {
+ return $c->render(
+ status => 400,
+ openapi => { error => "$_" }
+ );
+ }
}
+
+ $c->unhandled_exception($_);
};
}
+
=head3 update
Controller function that handles updating a Koha::Patron object
sub update {
my $c = shift->openapi->valid_input or return;
- my $patron = Koha::Patrons->find( $c->validation->param('borrowernumber') );
+ my $patron_id = $c->validation->param('patron_id');
+ my $patron = Koha::Patrons->find( $patron_id );
+
+ unless ($patron) {
+ return $c->render(
+ status => 404,
+ openapi => { error => "Patron not found" }
+ );
+ }
return try {
my $body = $c->validation->param('body');
-
- $patron->set( _to_model($body) )->_validate;
-
- ## TODO: Use ModMember until it has been moved to Koha-namespace
- # Add borrowernumber to $body, as required by ModMember
- $body->{borrowernumber} = $patron->borrowernumber;
-
- if ( ModMember(%$body) ) {
- return $c->render( status => 200, openapi => $patron );
- }
- else {
- return $c->render(
- status => 500,
- openapi => {
- error => 'Something went wrong, check Koha logs for details.'
- }
- );
+ my $user = $c->stash('koha.user');
+
+ if (
+ $patron->is_superlibrarian
+ and !$user->is_superlibrarian
+ and ( exists $body->{email}
+ or exists $body->{secondary_email}
+ or exists $body->{altaddress_email} )
+ )
+ {
+ foreach my $email_field ( qw(email secondary_email altaddress_email) ) {
+ my $exists_email = exists $body->{$email_field};
+ next unless $exists_email;
+
+ # exists, verify if we are asked to change it
+ my $put_email = $body->{$email_field};
+ # As of writing this patch, 'email' is the only unmapped field
+ # (i.e. it preserves its name, hence this fallback)
+ my $db_email_field = $patron->to_api_mapping->{$email_field} // 'email';
+ my $db_email = $patron->$db_email_field;
+
+ return $c->render(
+ status => 403,
+ openapi => { error => "Not enough privileges to change a superlibrarian's email" }
+ )
+ unless ( !defined $put_email and !defined $db_email )
+ or ( defined $put_email
+ and defined $db_email
+ and $put_email eq $db_email );
+ }
}
+
+ $patron->set_from_api($c->validation->param('body'))->store;
+ $patron->discard_changes;
+ return $c->render( status => 200, openapi => $patron->to_api );
}
catch {
- unless ($patron) {
- return $c->render(
- status => 404,
- openapi => { error => "Patron not found" }
- );
- }
unless ( blessed $_ && $_->can('rethrow') ) {
return $c->render(
status => 500,
}
);
}
- if ( $_->isa('Koha::Exceptions::Patron::DuplicateObject') ) {
+ if ( $_->isa('Koha::Exceptions::Object::DuplicateID') ) {
return $c->render(
status => 409,
- openapi => { error => $_->error, conflict => $_->conflict }
- );
- }
- elsif ( $_->isa('Koha::Exceptions::Library::BranchcodeNotFound') ) {
- return $c->render(
- status => 400,
- openapi => { error => "Given branchcode does not exist" }
+ openapi => { error => $_->error, conflict => $_->duplicate_id }
);
}
- elsif ( $_->isa('Koha::Exceptions::Category::CategorycodeNotFound') ) {
+ elsif ( $_->isa('Koha::Exceptions::Object::FKConstraint') ) {
return $c->render(
status => 400,
- openapi => { error => "Given categorycode does not exist" }
+ openapi => { error => "Given " .
+ $patron->to_api_mapping->{$_->broken_fk}
+ . " does not exist" }
);
}
elsif ( $_->isa('Koha::Exceptions::MissingParameter') ) {
);
}
else {
- return $c->render(
- status => 500,
- openapi => {
- error =>
- "Something went wrong, check Koha logs for details."
- }
- );
+ $c->unhandled_exception($_);
}
};
}
sub delete {
my $c = shift->openapi->valid_input or return;
- my $patron;
+ my $patron = Koha::Patrons->find( $c->validation->param('patron_id') );
+
+ unless ( $patron ) {
+ return $c->render(
+ status => 404,
+ openapi => { error => "Patron not found" }
+ );
+ }
return try {
- $patron = Koha::Patrons->find( $c->validation->param('borrowernumber') );
- # check if loans, reservations, debarrment, etc. before deletion!
- my $res = $patron->delete;
- return $c->render( status => 200, openapi => {} );
- }
- catch {
- unless ($patron) {
+ $patron->delete;
+ return $c->render(
+ status => 204,
+ openapi => q{}
+ );
+ } catch {
+ if ( blessed $_ && $_->isa('Koha::Exceptions::Patron::FailedDeleteAnonymousPatron') ) {
return $c->render(
- status => 404,
- openapi => { error => "Patron not found" }
+ status => 403,
+ openapi => { error => "Anonymous patron cannot be deleted" }
+ );
+ }
+
+ $c->unhandled_exception($_);
+ };
+}
+
+=head3 guarantors_can_see_charges
+
+Method for setting whether guarantors can see the patron's charges.
+
+=cut
+
+sub guarantors_can_see_charges {
+ my $c = shift->openapi->valid_input or return;
+
+ return try {
+ if ( C4::Context->preference('AllowPatronToSetFinesVisibilityForGuarantor') ) {
+ my $patron = $c->stash( 'koha.user' );
+ my $privacy_setting = ($c->req->json->{allowed}) ? 1 : 0;
+
+ $patron->privacy_guarantor_fines( $privacy_setting )->store;
+
+ return $c->render(
+ status => 200,
+ openapi => {}
);
}
else {
return $c->render(
- status => 500,
+ status => 403,
openapi => {
error =>
- "Something went wrong, check Koha logs for details."
+ 'The current configuration doesn\'t allow the requested action.'
}
);
}
+ }
+ catch {
+ $c->unhandled_exception($_);
};
}
-=head3 _to_model
+=head3 guarantors_can_see_checkouts
-Helper function that maps REST api objects into Koha::Patron
-attribute names.
+Method for setting whether guarantors can see the patron's checkouts.
=cut
-sub _to_model {
- my $params = shift;
+sub guarantors_can_see_checkouts {
+ my $c = shift->openapi->valid_input or return;
+
+ return try {
+ if ( C4::Context->preference('AllowPatronToSetCheckoutsVisibilityForGuarantor') ) {
+ my $patron = $c->stash( 'koha.user' );
+ my $privacy_setting = ( $c->req->json->{allowed} ) ? 1 : 0;
- $params->{lost} = ($params->{lost}) ? 1 : 0;
- $params->{gonenoaddress} = ($params->{gonenoaddress}) ? 1 : 0;
+ $patron->privacy_guarantor_checkouts( $privacy_setting )->store;
- return $params;
+ return $c->render(
+ status => 200,
+ openapi => {}
+ );
+ }
+ else {
+ return $c->render(
+ status => 403,
+ openapi => {
+ error =>
+ 'The current configuration doesn\'t allow the requested action.'
+ }
+ );
+ }
+ }
+ catch {
+ $c->unhandled_exception($_);
+ };
}
1;
projects / srvgit / blobdiff