use vars qw(@ISA @EXPORT);

BEGIN {

    require Exporter;

    @ISA = qw(Exporter);

    push @EXPORT, qw(

        &GetIssue

        &SetIssueNote

        &SendIssueNote

        &GetPatronNote

    );

}

=head2 GetIssue

    $issue = GetIssue({ issue_id => $issue_id });

Returns issue with provided issue_id

=cut

sub GetIssue {

    my ($criteria) = @_;

    # Build filters

    my @filters;

    my @allowed = qw(borrowernumber biblionumber itemnumber issue_id);

    foreach (@allowed) {

        if (defined $criteria->{$_}) {

            push @filters, {

               field => $_,

               value => $criteria->{$_},

            };

        }

    }

    # Build SQL query

    my $where = '';

    if (@filters) {

        $where = "WHERE " . join(' AND ', map { "$_->{field} = ?" } @filters);

    }

    my $query = q{

        SELECT issues.*

        FROM issues

    };

    $query .= $where;

    # Execute SQL query

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

    my $sth = $dbh->prepare($query);

    $sth->execute(map { $_->{value} } @filters);

    my $issue = $sth->fetchrow_hashref;

    return $issue;

}

=head2 SetIssueNote

    &SetIssueNote($issue_id, $note);

Sets a note to the issuenotes table for the given issue.

=over 4

=item C<$issue_id> is the id of the issue for which to set the note

=item C<$note> is the note to set

=back

Returns:

True on success

False on failure

=cut

sub SetIssueNote {

    my ( $issue_id, $note) = @_;

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

    unless ( $issue_id =~ /\d+/ ) {

        return;

    }

    my $query = "UPDATE issues SET notedate=NOW(),note=? WHERE issue_id=?";

    my $sth = $dbh->prepare($query);

    return $sth->execute( $note, $issue_id );

}

=head2 SendIssueNote

    &SendIssueNote($biblio, $borrower, $branch);

Sends the issue note to the library (adds it to the message queue).

=cut

sub SendIssueNote {

    my $biblio = shift;

    my $borrower = shift;

    my $branch = shift;

    my $letter = C4::Letters::GetPreparedLetter (

        module => 'circulation',

        letter_code => 'PATRON_NOTE',

        branchcode => $branch,

        tables => {

            'biblio' => $biblio->{biblionumber},

            'borrowers' => $borrower->{borrowernumber},

        },

    );

    C4::Message->enqueue($letter, $borrower, 'email');

}

=head2 GetPatronNote

    &GetPatronNote($itemnumber);

Gets the patron note of an issue upon checkin using itemnumber

=cut

sub GetPatronNote {

    my $itemnumber = shift;

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

    my $query = "SELECT note FROM issues WHERE itemnumber = ?";

    my $sth = $dbh->prepare($query);

    $sth->execute($itemnumber);

    my $patronnote = $sth->fetchrow_hashref;

    return $patronnote->{note};

}

    my $issue = GetItemIssue($itemnumber);

        issue            => $issue,

ALTER IGNORE TABLE issues ADD `note` mediumtext default NULL;

ALTER IGNORE TABLE issues ADD `notedate` datetime default NULL;

INSERT IGNORE INTO letter (`module`, `code`, `branchcode`, `name`, `is_html`, `title`, `content`, `message_transport_type`) VALUES ('circulation', 'PATRON_NOTE', '', 'Patron note on item', '0', 'Patron issue note', '<<borrowers.firstname>> <<borrowers.surname>> has added a note to the item <<biblio.item>> - <<biblio.author>> (<<biblio.biblionumber>>).','email');

INSERT IGNORE INTO systempreferences (`variable`, `value`, `options`, `explanation`,`type`) VALUES ('AllowIssueNotes', '0', NULL, 'Allow patrons to submit notes about checked out items.','YesNo');

-- Table structure for table `issues`

--

DROP TABLE IF EXISTS `issues`;

CREATE TABLE `issues` ( -- information related to check outs or issues

  `issue_id` int(11) NOT NULL AUTO_INCREMENT, -- primary key for issues table

  `borrowernumber` int(11), -- foreign key, linking this to the borrowers table for the patron this item was checked out to

  `itemnumber` int(11), -- foreign key, linking this to the items table for the item that was checked out

  `date_due` datetime default NULL, -- datetime the item is due (yyyy-mm-dd hh:mm::ss)

  `branchcode` varchar(10) default NULL, -- foreign key, linking to the branches table for the location the item was checked out

  `returndate` datetime default NULL, -- date the item was returned, will be NULL until moved to old_issues

  `lastreneweddate` datetime default NULL, -- date the item was last renewed

  `return` varchar(4) default NULL,

  `renewals` tinyint(4) default NULL, -- lists the number of times the item was renewed

  `auto_renew` BOOLEAN default FALSE, -- automatic renewal

  `timestamp` timestamp NOT NULL default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP, -- the date and time this record was last touched

  `issuedate` datetime default NULL, -- date the item was checked out or issued

  `onsite_checkout` int(1) NOT NULL default 0, -- in house use flag

  `note` mediumtext default NULL, -- issue note text

  `notedate` datetime default NULL, -- datetime of issue note (yyyy-mm-dd hh:mm::ss)

  PRIMARY KEY (`issue_id`),

  KEY `issuesborridx` (`borrowernumber`),

  KEY `itemnumber_idx` (`itemnumber`),

  KEY `branchcode_idx` (`branchcode`),

  KEY `bordate` (`borrowernumber`,`timestamp`),

  CONSTRAINT `issues_ibfk_1` FOREIGN KEY (`borrowernumber`) REFERENCES `borrowers` (`borrowernumber`) ON DELETE RESTRICT ON UPDATE CASCADE,

  CONSTRAINT `issues_ibfk_2` FOREIGN KEY (`itemnumber`) REFERENCES `items` (`itemnumber`) ON DELETE RESTRICT ON UPDATE CASCADE

) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci;

--

('AllowIssueNotes', '0', NULL, 'Allow patrons to submit notes about checked out items.','YesNo'),

        -

            - pref: AllowIssueNotes

              choices:

                  yes: Allow

                  no: "Don't allow"

            - patrons to submit notes about checked out items.

<!-- Patron has added an issue note -->

[% IF ( issue.note) %]

    <div class="dialog message">

        <h1>Patron note</h1>

        <p>[% issue.notedate %]</p>

        <p><a href="/cgi-bin/koha/catalogue/detail.pl?biblionumber=[% itembiblionumber %]"> [% title |html %]</a> [% author %]</p>

        <p>[% issue.note %]</p>

    </div>

[% END %]

                    $('#patron_note_' + data.itemnumber).html("Patron note: " + data.patronnote);

                        var patron_note = " <span id='patron_note_" + oObj.itemnumber + "'></span>";

[% USE Koha %]

[% USE KohaDates %]

[% USE Branches %]

[% INCLUDE 'doc-head-open.inc' %]

<title>[% IF ( LibraryNameTitle ) %][% LibraryNameTitle %][% ELSE %]Koha online[% END %] catalog &rsaquo; Your library home</title>

[% INCLUDE 'doc-head-close.inc' %]

[% BLOCK cssinclude %][% END %]

</head>

[% INCLUDE 'bodytag.inc' bodyid='opac-issue-note' %]

[% INCLUDE 'masthead.inc' %]

<div class="main">

    <ul class="breadcrumb">

        <li><a href="/cgi-bin/koha/opac-main.pl">Home</a> <span class="divider">&rsaquo;</span></li>

        <li><a href="/cgi-bin/koha/opac-user.pl">[% firstname %] [% surname %]</a><span class="divider">&rsaquo;</span></li>

        <li><a href="#">Editing issue note for [% ISSUE.title %] - [% ISSUE.author %]</a></li>

    </ul>

    <div class="container-fluid">

        <div class="row-fluid">

            <div class="span2">

                <div id="navigation">

                    [% INCLUDE 'navigation.inc' IsPatronPage=1 %]

                </div>

            </div>

            <div class="span10">

                <div id="issuenote" class="maincontent">

                    <h3>Editing issue note for [% title %] [% author %]</h3>

                        [% IF not(Koha.Preference("AllowIssueNotes")) %]

                            Issue notes have not been enabled. Please contact the library.

                        [% ELSE %]

                            <form id="issue-note" action="/cgi-bin/koha/opac-issue-note.pl" method="post">

                                <fieldset>

                                    <label for="note" class="required">Note:</label>

                                    <input type="text" name="note" value="[% note %]">

                                    <input type="hidden" name="borrowernumber" value="[% borrowernumber %]">

                                    <input type="hidden" name="itemnumber" value="[% itemnumber %]">

                                    <input type="hidden" name="issue_id" value="[% issue_id %]">

                                    <input type="hidden" name="action" value="issuenote">

                                </fieldset>

                                <fieldset class="action">

                                    <input type="submit" value="Submit note" class="btn"><a href="/cgi-bin/koha/opac-user.pl" class="cancel">Cancel</a>

                                </fieldset>

                            </form> <!-- issue-note -->

                        [% END %]

                </div> <!-- issuenote -->

            </div> <!-- span10 -->

        </div> <!-- row-fluid -->

    </div> <!-- container-fluid -->

</div> <!-- main -->

[% INCLUDE 'opac-bottom.inc' %]

[% BLOCK jsinclude %][% END %]

                    <div class="alert alert-info" id="notesaved" style="display:none;"></div>

                                                [% IF ( AllowIssueNotes ) %]

                                                    <th class="nosort">Note</th>

                                                [% END %]

                                                [% IF ( AllowIssueNotes ) %]

                                                    <td class="note">

                                                        <input type="text" name="note" data-issue_id="[% ISSUE.issue_id %]" data-origvalue="[% ISSUE.note %]" value="[% ISSUE.note %]" readonly>

                                                        <a class="btn" name="js_submitnote" id="save_[% ISSUE.issue_id %]" style="display:none;">Submit note</a>

                                                        <a class="btn" name="nonjs_submitnote" href="/cgi-bin/koha/opac-issue-note.pl?issue_id=[% ISSUE.issue_id | url %]">Edit / Create note</a>

                                                    </td>

                                                [% END %]

            [% IF ( AllowIssueNotes ) %]

                /* If JS enabled, show button, otherwise show link to redirect to a page where note can be submitted */

                $("a[name='nonjs_submitnote']").hide();

                $("input[name='note']").prop('readonly', false);

                $("input[name='note']").keyup(function(e){

                    /* prevent submitting of renewselected form */

                    if(e.which == 13)

                        e.preventDefault();

                    var $btn_save = $('#save_'+$(this).data('issue_id'));

                    var origvalue = $(this).data('origvalue');

                    var value = $(this).val();

                    if(origvalue != value) {

                        if(origvalue != "")

                            $btn_save.text('Submit changes');

                        else

                            $btn_save.text('Submit note');

                        $btn_save.show();

                    } else {

                        $btn_save.hide();

                    }

                });

                $("a[name='js_submitnote']").click(function(e){

                    var $self = $(this);

                    var title = $(this).parent().siblings('.title').html();

                    var $noteinput = $(this).siblings('input[name="note"]').first();

                    var ajaxData = {

                        'action': 'issuenote',

                        'issue_id': $noteinput.data('issue_id'),

                        'note': $noteinput.val(),

                    };

                    $.ajax({

                        url: '/cgi-bin/koha/svc/patron_notes/',

                        type: 'POST',

                        dataType: 'json',

                        data: ajaxData,

                    })

                    .done(function(data) {

                        var message = "";

                        if(data.status == 'saved') {

                            $("#notesaved").removeClass("alert-error");

                            $("#notesaved").addClass("alert-info");

                            $noteinput.data('origvalue', data.note);

                            $noteinput.val(data.note);

                            message = "<p>Your note about " + title + " has been saved and sent to the library.</p>";

                            $self.hide();

                        } else if(data.status == 'removed') {

                            $("#notesaved").removeClass("alert-error");

                            $("#notesaved").addClass("alert-info");

                            $noteinput.data('origvalue', "");

                            $noteinput.val("");

                            message = "<p>Your note about " + title + " was removed.</p>";

                            $self.hide();

                        } else {

                            $("#notesaved").removeClass("alert-info");

                            $("#notesaved").addClass("alert-error");

                            message = "<p>Your note about " + title + " could not be saved.</p>" +

                                      "<p style=\"font-weight:bold;\">" + data.error + "</p>";

                        }

                        message += "<p style=\"font-style:italic;\">" + data.note + "</p>";

                        $("#notesaved").html(message);

                    })

                    .fail(function(data) {

                        $("#notesaved").removeClass("alert-info");

                        $("#notesaved").addClass("alert-error");

                        var message = "<p>Your note about " + title + " could not be saved.</p>" +

                                      "<p style=\"font-weight:bold;\">Ajax request has failed.</p>";

                        $("#notesaved").html(message);

                    })

                    .always(function() {

                        $("#notesaved").show();

                    });

                });

            [% END %]

#!/usr/bin/perl

# Copyright 2016 Aleisha Amohia <aleisha@catalyst.net.nz>

#

# 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>.

use Modern::Perl;

use strict;

use warnings;

use CGI qw ( -utf8 );

use C4::Koha;

use C4::Context;

use C4::Scrubber;

use C4::Members;

use C4::Output;

use C4::Auth;

use C4::Biblio;

use Koha::Issue;

use Koha::Issues;

my $query = new CGI;

my ( $template, $borrowernumber, $cookie ) = get_template_and_user(

    {

        template_name   => "opac-issue-note.tt",

        query           => $query,

        type            => "opac",

        authnotrequired => 0,

        debug           => 1,

    }

);

my $member = C4::Members::GetMember( borrowernumber => $borrowernumber );

$template->param(

    firstname      => $member->{'firstname'},

    surname        => $member->{'surname'},

    borrowernumber => $borrowernumber,

);

my $issue_id = $query->param('issue_id');

my $issue = Koha::Issue::GetIssue({ issue_id => $issue_id });

my $itemnumber = $issue->{'itemnumber'};

my $biblio = GetBiblioFromItemNumber($itemnumber);

$template->param(

    issue_id   => $issue_id,

    title      => $biblio->{'title'},

    author     => $biblio->{'author'},

    note       => $issue->{'note'},

    itemnumber => $issue->{'itemnumber'},

);

my $action = $query->param('action') || "";

if ( $action eq 'issuenote' && C4::Context->preference('AllowIssueNotes') ) {

    my $note = $query->param('note');

    my $scrubber = C4::Scrubber->new();

    my $clean_note = $scrubber->scrub($note);

    if ( Koha::Issue::SetIssueNote($issue_id, $clean_note) ) {

        if ($clean_note) { # only send email if note not empty

            my $branch = Koha::Libraries->find( $issue->{branchcode} );

            Koha::Issue::SendIssueNote($biblio, $member, $branch);

        }

    }

    print $query->redirect("/cgi-bin/koha/opac-user.pl");

}

output_html_with_http_headers $query, $cookie, $template->output, undef, { force_no_caching => 1 };

use Koha::Libraries;

$template->param( AllowIssueNotes => C4::Context->preference('AllowIssueNotes') );

#!/usr/bin/perl

# This file is part of Koha.

#

# Copyright 2014 BibLibre

#

# 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>.

use Modern::Perl;

use C4::Service;

use C4::Auth qw /check_cookie_auth/;

use C4::Letters qw( GetLetters );

use CGI::Cookie; # need to check cookies before having CGI parse the POST request

use C4::Output qw(:DEFAULT :ajax);

use C4::Scrubber;

use C4::Circulation;

use C4::Members;

use C4::Biblio;

use Koha::Issue;

=head1 NAME

svc/patron_notes - Web service for setting patron notes on items

=head1 DESCRIPTION

=cut

sub ajax_auth_cgi {     # returns CGI object

    my $needed_flags = shift;

    my %cookies = fetch CGI::Cookie;

    my $input = CGI->new;

    my $sessid = $cookies{'CGISESSID'}->value;

    my ($auth_status, $auth_sessid) = check_cookie_auth($sessid, $needed_flags);

    if ($auth_status ne "ok") {

        output_with_http_headers $input, undef,

        "window.alert('Your CGI session cookie ($sessid) is not current.  " .

        "Please refresh the page and try again.');\n", 'js';

        exit 0;

    }

    return $input;

}

# AJAX requests

my $is_ajax = is_ajax();

my $query = ($is_ajax) ? &ajax_auth_cgi({}) : CGI->new();

if ($is_ajax) {

    my $action = $query->param('action');

    # Issue Note

    if ( $action eq 'issuenote' && C4::Context->preference('AllowIssueNotes') ) {

        my $scrubber = C4::Scrubber->new();

        my $note = $query->param('note');

        my $issue_id = $query->param('issue_id');

        my $clean_note = $scrubber->scrub($note);

        my $status = "saved";

        my $error = "";

        my ($member, $issue);

        my ( $template, $borrowernumber, $cookie ) = C4::Auth::get_template_and_user({

            template_name   => "opac-user.tt",

            query           => $query,

            type            => "opac",

            authnotrequired => 1,

        });

        # verify issue_id

        if ( $issue_id =~ /\d+/ ) {

            $member = GetMember(borrowernumber => $borrowernumber);

            $issue = Koha::Issue::GetIssue({issue_id => $issue_id});

            if ( $issue->{'borrowernumber'} != $borrowernumber ) {

                $status = "fail";

                $error = "Invalid issue id!";

            }

        } else {

            $status = "fail";

            $error = "Invalid issue id!";

        }

        if ( (not $error) && SetIssueNote($issue_id, $clean_note) ) {

            if($clean_note) { # only send email if note not empty

                my $branch = Koha::Libraries->find( $issue->{branchcode} );

                my $biblio = GetBiblioFromItemNumber($issue->{'itemnumber'});

                SendIssueNote($biblio, $member, $branch);

            } else { # note empty, i.e removed

                $status = "removed";

            }

        } else {

            $status = "fail";

            $error = "Perhaps the item has already been checked in?";

        }

        my $response = "{\"status\": \"$status\", \"note\": \"$clean_note\", \"issue_id\": \"$issue_id\", \"error\": \"$error\"}";

        output_with_http_headers($query, undef, $response, 'js');

        exit;

    } # END Issue Note

}

use Koha::Issue;

my $patronnote = GetPatronNote($itemnumber);

$data->{patronnote} = $patronnote;