# 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 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, see <http://www.gnu.org/licenses>.

    },

    'Koha::Exceptions::Item::Transfer::Transit' => {

        isa         => 'Koha::Exceptions::Item::Transfer',

        description => "Transfer item is currently in transit"

=head1 NAME

Koha::Exceptions::Item::Transfer - Base class for Transfer exceptions

=head1 Exceptions

=head2 Koha::Exceptions::Item::Transfer

Generic Item::Transfer exception

=head2 Koha::Exceptions::Item::Transfer::Found

Exception to be used when an active item transfer prevents a transfer action.

=head2 Koha::Exceptions::Item::Transfer::Limit

Exception to be used when transfer limits prevent a transfer action.

=head2 Koha::Exceptions::Item::Transfer::Out

Exception to be used when an active checkout prevents a transfer action.

=head2 Koha::Exceptions::Item::Transfer::Transit

Exception to be used when an in transit transfer prevents a transfer action.

=cut

=head3 cancel

  $transfer->cancel($reason);

Cancel the transfer by setting the datecancelled time and recording the reason.

=cut

sub cancel {

    my ( $self, $reason ) = @_;

    Koha::Exceptions::MissingParameter->throw(

        error => "The 'reason' parameter is mandatory" )

      unless defined($reason);

    # Throw exception if item is in transit already

    Koha::Exceptions::Item::Transfer::Transit->throw() if ( $self->in_transit );

    # Update the cancelled date

    $self->set(

        { datecancelled => dt_from_string, cancellation_reason => $reason } )

      ->store;

    return $self;

}

    $schema->storage->txn_rollback;

};

subtest 'cancel tests' => sub {

    plan tests => 6;

    $schema->storage->txn_begin;

    my $library1 = $builder->build_object( { class => 'Koha::Libraries' } );

    my $library2 = $builder->build_object( { class => 'Koha::Libraries' } );

    my $item     = $builder->build_sample_item(

        {

            homebranch    => $library1->branchcode,

            holdingbranch => $library2->branchcode,

            datelastseen  => undef

        }

    );

    my $cancellation_reason = 'Manual';

    my $transfer = $builder->build_object(

        {

            class => 'Koha::Item::Transfers',

            value => {

                itemnumber          => $item->itemnumber,

                frombranch          => $library2->branchcode,

                tobranch            => $library1->branchcode,

                datesent            => \'NOW()',

                datearrived         => undef,

                datecancelled       => undef,

                reason              => 'Manual',

                cancellation_reason => undef

            }

        }

    );

    is( ref($transfer), 'Koha::Item::Transfer', 'Mock transfer added' );

    # Missing mandatory parameter

    throws_ok { $transfer->cancel() } 'Koha::Exceptions::MissingParameter',

      'Exception thrown if a reason is not passed to cancel';

    # Item in transit should result in failure

    throws_ok { $transfer->cancel($cancellation_reason) }

    'Koha::Exceptions::Item::Transfer::Transit',

      'Exception thrown if item is in transit';

    $transfer->datesent(undef)->store();

    # Transit state unset

    $transfer->discard_changes;

    $transfer->cancel($cancellation_reason);

    ok( $transfer->datecancelled, 'Cancellation date set upon call to cancel' );

    is( $transfer->cancellation_reason, 'Manual', 'Cancellation reason is set');

    is( $transfer->reason, 'Manual', 'Reason is not updated by cancelling the transfer' );

                datecancelled => undef,

    $transfer_1->datecancelled(\'NOW()')->store;

    $transfer = $new_item_1->get_transfer();

    is( $transfer->branchtransfer_id, $transfer_3->branchtransfer_id, 'Koha::Item->get_transfer ignores cancelled transfers');