package C4::Suggestions;

# Copyright 2000-2002 Katipo Communications
# Parts Copyright Biblibre 2011
#
# 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 <https://www.gnu.org/licenses>.

use Modern::Perl;
use base 'Exporter';

BEGIN {
    our @EXPORT = qw(
        DelSuggestion
        GetSuggestion
        ModStatus
        ModSuggestion
        GetUnprocessedSuggestions
        MarcRecordFromNewSuggestion
    );
}

use CGI qw ( -utf8 );

use C4::Context;
use C4::Output;
use C4::Letters;
use C4::Biblio      qw( GetMarcFromKohaField );
use Koha::DateUtils qw( dt_from_string );
use Koha::Suggestions;
use C4::Log qw(logaction);

=head1 NAME

C4::Suggestions - Some useful functions for dealings with aqorders.

=head1 SYNOPSIS

use C4::Suggestions;

=head1 DESCRIPTION

The functions in this module deal with the aqorders in OPAC and in staff interface

A suggestion is done in the OPAC. It has the status "ASKED"

When a librarian manages the suggestion, they can set the status to "REJECTED" or "ACCEPTED".

When the book is ordered, the suggestion status becomes "ORDERED"

When a book is ordered and arrived in the library, the status becomes "AVAILABLE"

All aqorders of a borrower can be seen by the borrower itself.
Suggestions done by other borrowers can be seen when not "AVAILABLE"

=head1 FUNCTIONS

=head2 ModSuggestion

&ModSuggestion($suggestion)

Modify the suggestion according to the hash passed by ref.
The hash HAS to contain suggestionid
Data not defined is not updated unless it is a note or sort1
Send a mail to notify the user that did the suggestion.

Note that there is no function to modify a suggestion.

=cut

sub ModSuggestion {
    my ($suggestion) = @_;
    return unless ( $suggestion and defined( $suggestion->{suggestionid} ) );

    my $suggestion_object = Koha::Suggestions->find( $suggestion->{suggestionid} );
    my $previous_suggestion_status;
    $previous_suggestion_status = $suggestion_object->STATUS if $suggestion_object;
    eval {    # FIXME Must raise an exception instead
        $suggestion_object->set($suggestion)->store;
    };
    return 0 if $@;

    # now send a notification but only if STATUS has been changed
    if (   $suggestion->{STATUS}
        && $suggestion->{STATUS} ne $previous_suggestion_status
        && $suggestion_object->suggestedby )
    {

        # fetch the entire updated suggestion so that we can populate the letter
        my $full_suggestion = Koha::Suggestions->find( $suggestion->{suggestionid} )->unblessed();

        my $patron = Koha::Patrons->find( $full_suggestion->{suggestedby} );

        my $transport =
               ( C4::Context->preference("FallbackToSMSIfNoEmail") )
            && ( $patron->smsalertnumber )
            && ( !$patron->notice_email_address ) ? 'sms' : 'email';

        if (
            my $letter = C4::Letters::GetPreparedLetter(
                module      => 'suggestions',
                letter_code => $full_suggestion->{STATUS},
                branchcode  => $full_suggestion->{branchcode},
                lang        => $patron->lang,
                tables      => {
                    'branches'    => $full_suggestion->{branchcode},
                    'borrowers'   => $full_suggestion->{suggestedby},
                    'suggestions' => $full_suggestion,
                    'biblio'      => $full_suggestion->{biblionumber},
                },
            )
            )
        {
            C4::Letters::EnqueueLetter(
                {
                    letter                 => $letter,
                    borrowernumber         => $full_suggestion->{suggestedby},
                    suggestionid           => $full_suggestion->{suggestionid},
                    LibraryName            => C4::Context->preference("LibraryName"),
                    message_transport_type => $transport,
                }
            ) or warn "can't enqueue letter $letter";
        }
    }

    return 1;    # No useful if the exception is raised earlier
}

=head2 DelSuggestion

&DelSuggestion($borrowernumber,$ordernumber)

Delete a suggestion. A borrower can delete a suggestion only if they are its owner.

=cut

sub DelSuggestion {
    my ( $borrowernumber, $suggestionid, $type ) = @_;
    my $dbh = C4::Context->dbh;

    # check that the suggestion comes from the suggestor
    my $query = q{
        SELECT suggestedby
        FROM   suggestions
        WHERE  suggestionid=?
    };
    my $sth = $dbh->prepare($query);
    $sth->execute($suggestionid);
    my ($suggestedby) = $sth->fetchrow;
    $suggestedby    //= '';
    $borrowernumber //= '';

    if ( defined $type && $type eq 'intranet' || $suggestedby eq $borrowernumber ) {
        my $suggestion = Koha::Suggestions->find($suggestionid);
        if ( C4::Context->preference("SuggestionsLog") ) {
            logaction( 'SUGGESTION', 'DELETE', $suggestionid, $suggestion, undef, $suggestion );
        }
        my $queryDelete = q{
            DELETE FROM suggestions
            WHERE suggestionid=?
        };
        $sth = $dbh->prepare($queryDelete);
        my $suggestiondeleted = $sth->execute($suggestionid);
        return $suggestiondeleted;
    }
}

=head2 GetUnprocessedSuggestions

Missing POD for GetUnprocessedSuggestions.

=cut

sub GetUnprocessedSuggestions {
    my ($number_of_days_since_the_last_modification) = @_;

    $number_of_days_since_the_last_modification ||= 0;

    my $dbh = C4::Context->dbh;

    my $s = $dbh->selectall_arrayref(
        q|
        SELECT *
        FROM suggestions
        WHERE STATUS = 'ASKED'
            AND budgetid IS NOT NULL
            AND CAST(NOW() AS DATE) - INTERVAL ? DAY = CAST(suggesteddate AS DATE)
    |, { Slice => {} }, $number_of_days_since_the_last_modification
    );
    return $s;
}

=head2 MarcRecordFromNewSuggestion

    $record = MarcRecordFromNewSuggestion ( $suggestion )

This function build a marc record object from a suggestion

=cut

sub MarcRecordFromNewSuggestion {
    my ($suggestion) = @_;
    my $record = MARC::Record->new();

    if ( my $isbn = $suggestion->{isbn} ) {
        for my $field (qw(biblioitems.isbn biblioitems.issn)) {
            my ( $tag, $subfield ) = GetMarcFromKohaField($field);
            $record->append_fields( MARC::Field->new( $tag, ' ', ' ', $subfield => $isbn ) );
        }
    } else {
        my ( $title_tag, $title_subfield ) = GetMarcFromKohaField('biblio.title');
        $record->append_fields( MARC::Field->new( $title_tag, ' ', ' ', $title_subfield => $suggestion->{title} ) );

        my ( $author_tag, $author_subfield ) = GetMarcFromKohaField('biblio.author');
        if ( $record->field($author_tag) ) {
            $record->field($author_tag)->add_subfields( $author_subfield => $suggestion->{author} );
        } else {
            $record->append_fields(
                MARC::Field->new( $author_tag, ' ', ' ', $author_subfield => $suggestion->{author} ) );
        }
    }

    my ( $it_tag, $it_subfield ) = GetMarcFromKohaField('biblioitems.itemtype');
    if ( $record->field($it_tag) ) {
        $record->field($it_tag)->add_subfields( $it_subfield => $suggestion->{itemtype} );
    } else {
        $record->append_fields( MARC::Field->new( $it_tag, ' ', ' ', $it_subfield => $suggestion->{itemtype} ) );
    }

    return $record;
}

1;
__END__


=head1 AUTHOR

Koha Development Team <https://koha-community.org/>

=cut