package Koha::Illrequest::Availability;

# Copyright 2019 PTFS Europe Ltd

#

# 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, write to the Free Software Foundation, Inc.,

# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

use Modern::Perl;

use JSON;

use MIME::Base64 qw( encode_base64 );

use URI::Escape qw ( uri_escape );

use Koha::Plugins;

=head1 NAME

Koha::Illrequest::Availability - Koha ILL Availability Searching

=head1 SYNOPSIS

Object-oriented class that provides availability searching via

availability plugins

=head1 DESCRIPTION

This class provides the ability to identify and fetch API services

that can be used to search for item availability

=head1 API

=head2 Class Methods

=head3 new

    my $availability = Koha::Illrequest::Logger->new($metadata);

Create a new Koha::Illrequest::Availability object.

We also store the metadata to be used for searching

=cut

sub new {

    my ( $class, $metadata ) = @_;

    my $self  = {};

    $self->{metadata} = $metadata;

    bless $self, $class;

    return $self;

}

=head3 get_services

    my $services = Koha::Illrequest::Availability->get_services();

Given our metadata, iterate plugins with the right method and

check if they can service our request and, if so, return an arrayref

of services

=cut

sub get_services {

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

    my $params = {

        method => 'ill_availability_services'

    };

    if ($metadata) {

        $params->{metadata} = $metadata;

    }

    my @candidates = Koha::Plugins->new()->GetPlugins($params);

    my @services = ();

    foreach my $plugin(@candidates) {

        my $valid_service = $plugin->ill_availability_services(

            $self->{metadata}

        );

        push @services, $valid_service if $valid_service;

    }

    return \@services;

}

=head3 prep_metadata

    my $prepared = Koha::Illrequest::Availability->prep_metadata($metadata);

Given our metadata, return a string representing that metadata that can be

passed in a URL (encoded in JSON then Base64 encoded)

=cut

sub prep_metadata {

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

    return uri_escape(encode_base64(encode_json($metadata)));

}

=head1 AUTHOR

Andrew Isherwood <andrew.isherwood@ptfs-europe.com>

=cut

1;

use Koha::Illrequest::Availability;

use JSON;

            # Prepare availability searching, if required

            # Get the definition for the z39.50 plugin

            my $availability = Koha::Illrequest::Availability->new($request->metadata);

            my $services = $availability->get_services({

                name => 'ILL availability - z39.50'

            });

            # Only pass availability searching stuff to the template if

            # appropriate

            if (

                C4::Context->preference('ILLCheckAvailability') &&

                scalar @{$services} > 0

            ) {

                my $metadata = $availability->prep_metadata($request->metadata);

                $template->param( metadata => $metadata );

                $template->param(

                    services_json => scalar encode_json($services)

                );

                $template->param( services => $services );

            }

    #generic_confirm_search {

        display: block;

        visibility: hidden;

        margin: 1em 0 1em 10em;

    }

    #partnerSearch {

        .modal-dialog {

            width: 50vw;

        }

        .modal-body {

            max-height: 70vh;

        }

    }

.ill_availability_sourcename {

    margin-top: 20px;

}

<div>

    <div>[% service.name %]</div>

    <table class="ill-availability" id="[% service.id %]">

        <thead id="[% service.id %]-header">

            <tr>

                <th>Source</th>

                <th>Title</th>

                <th>Author</th>

                <th>ISBN</th>

                <th>ISSN</th>

                <th>Date</th>

            </tr>

        </thead>

        <tbody id="[% service.id %]-body">

        </tbody>

    </table>

</div>

                        [% IF Koha.Preference('ILLCheckAvailability') %]

                            <div id="partnerSearch" class="modal fade" tabindex="-1" role="dialog" aria-labelledby="partnerSearchLabel" aria-hidden="true">

                                <div class="modal-dialog">

                                    <div class="modal-content">

                                        <div class="modal-header">

                                            <button type="button" class="closebtn" data-dismiss="modal" aria-hidden="true">×</button>

                                            <h3 id="partnerSearchLabel"> Search partners</h3>

                                        </div>

                                        <div class="modal-body">

                                            [% FOR service IN services %]

                                                <h4 class="ill_availability_sourcename">[% service.plugin %]</h4>

                                                [% INCLUDE 'ill-availability-table.inc' service=service %]

                                            [% END %]

                                            <span id="service_id_restrict" data-service_id_restrict_plugin="ILL availability - z39.50" data-service_id_restrict_ids=""></span>

                                        </div>

                                        <div class="modal-footer">

                                            <button class="btn btn-default" data-dismiss="modal" aria-hidden="true">Close</button>

                                        </div>

                                    </div>

                                </div>

                            </div>

                        [% END %]

                [% ELSIF query_type == 'availability' %]

                    <!-- availability -->

                    <h1>Availability</h1>

                    <div id="results">

                        <h3>Displaying availability results</h3>

                        <form method="POST" action="/cgi-bin/koha/ill/ill-requests.pl">

                            [% FOREACH key IN whole.keys %]

                                [% value = whole.$key %]

                                [% IF key != 'method' && key != 'custom_key' && key != 'custom_value' %]

                                <input type="hidden" name="[% key | html %]" value="[% value | html %]">

                                [% END %]

                            [% END %]

                            [% custom_keys = whole.custom_key.split('\0') %]

                            [% custom_values = whole.custom_value.split('\0') %]

                            [% i = 0 %]

                            [% FOREACH custom_key IN custom_keys %]

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

                                <input type="hidden" name="custom_value" value="[% custom_values.$i %]">

                            [% i = i + 1 %]

                            [% END %]

                            <input type="hidden" name="method" value="create">

                            <input type="hidden" name="stage" value="form">

                            <input type="hidden" name="checked_availability" value="1">

                            <div id="continue-request-row" class="alert">

                                If you can't find what you are looking for, you can

                                <button class="button" type="submit">continue creating your request</button> or

                                <a href="/cgi-bin/koha/ill/ill-requests.pl">cancel your request</a>

                            </div>

                        </form>

                        [% FOR service IN services %]

                            <h4 class="ill_availability_sourcename">[% service.plugin %]</h4>

                            [% INCLUDE 'ill-availability-table.inc' service=service %]

                        [% END %]

                    </div>

        [% IF services_json.length > 0 %]

        var services = [% services_json | $raw %];

        [% ELSE %]

        var services = [];

        [% END %]

        [% IF metadata.length > 0 %]

        var metadata = "[% metadata | $raw %]";

        [% END %]

    [% IF (query_type == 'availability' || query_type == 'generic_confirm') && Koha.Preference('ILLCheckAvailability') %]

        [% Asset.js("js/ill-availability.js") | $raw %]

    [% END %]

    [% IF query_type == 'availability' && Koha.Preference('ILLCheckAvailability') %]

        <script>

            $(document).ready(function() {

                window.doSearch();

            });

        </script>

    [% END %]

    [% IF query_type == 'generic_confirm' && Koha.Preference('ILLCheckAvailability') %]

        [% Asset.js("js/ill-availability-partner.js") | $raw %]

    [% END %]

                                    <li><a href="/cgi-bin/koha/plugins/plugins-home.pl?method=ill_availability_services">View ILL availability plugins</a></li>

$(document).ready(function() {

    $('#partners').change(function() {

        var selected = [];

        $('#partners option:selected').each(function() {

            selected.push($(this).data('partner-id'));

        });

        if (selected.length > 0) {

            $('#generic_confirm_search').css('visibility', 'initial');

        } else {

            $('#generic_confirm_search').css('visibility', 'hidden');

        }

        $('#service_id_restrict').

            attr('data-service_id_restrict_ids', selected.join('|'));

    });

    $('#generic_confirm_search').click(function(e) {

        $('#partnerSearch').modal({show:true});

    });

    $('#partnerSearch').on('show.bs.modal', function() {

        doSearch();

    });

    $('#partnerSearch').on('hide.bs.modal', function() {

        $.fn.dataTable.tables({ api: true }).destroy();

    });

});

$(document).ready(function() {

    window.doSearch = function() {

        // In case the source doesn't supply data required for DT to calculate

        // pagination, we need to do it ourselves

        var ownPagination = false;

        var directionSet = false;

        var start = 0;

        var forward = true; // true == forward, false == backwards

        // Arbitrary starting value, it will be corrected by the first

        // page of results

        var pageSize = 20;

        var tableTmpl = {

            ajax: {

                cache: true, // Prevent DT appending a "_" cache param

            },

            columns: [

                // defaultContent prevents DT from choking if

                // the API response doesn't return a column

                {

                    title: 'Source',

                    data: 'source',

                    defaultContent: ''

                },

                {

                    data: 'title',

                    defaultContent: ''

                },

                {

                    data: 'author',

                    defaultContent: ''

                },

                {

                    data: 'isbn',

                    defaultContent: ''

                },

                {

                    data: 'issn',

                    defaultContent: ''

                },

                {

                    data: 'date',

                    defaultContent: ''

                }

            ]

        };

        // render functions don't get copied across when we make a dereferenced

        // copy of them, so we have to reattach them once we have a copy

        // Here we store them

        var renders = {

            title: function(data, type, row) {

                return row.url ?

                    '<a href="'+row.url+'" target="_blank">'+row.title+'</a>' :

                    row.title;

            }

        };

        services.forEach(function(service) {

            // Create a deferenced copy of our table definition object

            var tableDef = JSON.parse(JSON.stringify(tableTmpl));

            // Iterate the table's columns array and add render functions

            // as necessary

            tableDef.columns.forEach(function(column) {

                if (renders[column.data]) {

                    column.render = renders[column.data];

                }

            });

            tableDef.ajax.dataSrc = function(data) {

                var results = data.results.search_results;

                // The source appears to be returning it's own pagination

                // data

                if (

                    results.hasOwnProperty('recordsFiltered') ||

                    results.hasOwnProperty('recordsTotal')

                ) {

                    return results;

                }

                // Set up our own pagination values based on what we just

                // got back

                ownPagination = true;

                directionSet = false;

                pageSize = results.length;

                // These values are completely arbitrary, but they enable

                // us to display pagination links

                data.recordsFiltered = 5000,

                data.recordsTotal = 5000;

                return results;

            };

            tableDef.ajax.data = function(data) {

                // Datatables sends a bunch of superfluous params

                // that we don't want to litter our API schema

                // with, so just remove them from the request

                if (data.hasOwnProperty('columns')) {

                    delete data.columns;

                }

                if (data.hasOwnProperty('draw')) {

                    delete data.draw;

                }

                if (data.hasOwnProperty('order')) {

                    delete data.order;

                }

                if (data.hasOwnProperty('search')) {

                    delete data.search;

                }

                // If we're handling our own pagination, set the properties

                // that DT will send in the request

                if (ownPagination) {

                    start = forward ? start + pageSize : start - pageSize;

                    data.start = start;

                    data.length = pageSize;

                }

                // We may need to restrict the service IDs being queries, this

                // needs to be handled in the plugin's API module

                var restrict = $('#service_id_restrict').

                    attr('data-service_id_restrict_ids');

                if (restrict && restrict.length > 0) {

                    data.restrict = restrict;

                }

            };

            // Add any datatables config options passed from the service

            // to the table definition

            tableDef.ajax.url = service.endpoint + metadata;

            if (service.hasOwnProperty('datatablesConfig')) {

                var conf = service.datatablesConfig;

                for (var key in conf) {

                    // The config from the service definition comes from a Perl

                    // hashref, therefore can't contain true/false, so we

                    // special case it

                    if (conf.hasOwnProperty(key)) {

                        if (conf[key] == 'false') {

                            // Special case false values

                            tableDef[key] = false;

                        } else if (conf[key] == 'true') {

                            // Special case true values

                            tableDef[key] = true;

                        } else {

                            // Copy the property value

                            tableDef[key] = conf[key];

                        }

                    }

                }

            }

            // Create event watchers for the "next" and "previous" pagination

            // links, this enables us to set the direction the next request is

            // going in when we're doing our own pagination. We use "hover"

            // because the click event is caught after the request has been

            // sent

            tableDef.drawCallback = function() {

                $('.paginate_button.next:not(.disabled)',

                    this.api().table().container()

                ).on('hover', function() {

                    forward = true;

                    directionSet = true;

                });

                $('.paginate_button.previous:not(.disabled)',

                    this.api().table().container()

                ).on('hover', function() {

                    forward = false;

                    directionSet = true;

                });

            }

            // Initialise the table

            KohaTable(service.id, tableDef);

        });

    }

});

}

.ill_availability_sourcename {

    margin-top: 20px;

}

#continue-request-row {

    text-align: center;

<div>

    <div>[% service.name %]</div>

    <table class="ill-availability table table-bordered table-striped" id="[% service.id %]">

        <thead id="[% service.id %]-header">

            <tr>

                <th>Source</th>

                <th>Title</th>

                <th>Author</th>

                <th>ISBN</th>

                <th>ISSN</th>

                <th>Date</th>

            </tr>

        </thead>

        <tbody id="[% service.id %]-body">

        </tbody>

    </table>

</div>

                    [% ELSIF method == 'availability' %]

                        <h2>Interlibrary loan item availability</h2>

                        <div id="results">

                            <h3>Displaying availability results</h3>

                            <form method="POST" action="/cgi-bin/koha/opac-illrequests.pl">

                                [% FOREACH key IN whole.keys %]

                                    [% value = whole.$key %]

                                    [% IF key != 'custom_key' && key != 'custom_value' %]

                                    <input type="hidden" name="[% key | html %]" value="[% value | html %]">

                                    [% END %]

                                [% END %]

                                [% custom_keys = whole.custom_key.split('\0') %]

                                [% custom_values = whole.custom_value.split('\0') %]

                                [% i = 0 %]

                                [% FOREACH custom_key IN custom_keys %]

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

                                    <input type="hidden" name="custom_value" value="[% custom_values.$i %]">

                                [% i = i + 1 %]

                                [% END %]

                                <input type="hidden" name="checked_availability" value="1">

                                <div id="continue-request-row" class="alert">

                                    If you can't find what you are looking for, you can

                                    <button class="button" type="submit">continue creating your request</button> or

                                    <a href="/cgi-bin/koha/opac-illrequests.pl">cancel your request</a>

                                </div>

                            </form>

                            [% FOR service IN services %]

                                <h4 class="ill_availability_sourcename">[% service.plugin %]</h4>

                                [% INCLUDE 'ill-availability-table.inc' service=service %]

                            [% END %]

                        </div>

        [% IF services_json.length > 0 %]

        var services = [% services_json | $raw %];

        [% ELSE %]

        var services = [];

        [% END %]

        [% IF metadata.length > 0 %]

        var metadata = "[% metadata | $raw %]";

        [% END %]

[% Asset.js("js/ill-availability.js") | $raw %]

$(document).ready(function() {

    // In case the source doesn't supply data required for DT to calculate

    // pagination, we need to do it ourselves

    var ownPagination = false;

    var directionSet = false;

    var start = 0;

    var forward = true; // true == forward, false == backwards

    // Arbitrary starting value, it will be corrected by the first

    // page of results

    var pageSize = 20;

    var tableTmpl = {

        ajax: {

            cache: true, // Prevent DT appending a "_" cache param

        },

        columns: [

            // defaultContent prevents DT from choking if

            // the API response doesn't return a column

            {

                title: 'Source',

                data: 'source',

                defaultContent: ''

            },

            {

                data: 'title',

                defaultContent: ''

            },

            {

                data: 'author',

                defaultContent: ''

            },

            {

                data: 'isbn',

                defaultContent: ''

            },

            {

                data: 'issn',

                defaultContent: ''

            },

            {

                data: 'date',

                defaultContent: ''

            }

        ]

    };

    // render functions don't get copied across when we make a dereferenced

    // copy of them, so we have to reattach them once we have a copy

    // Here we store them

    var renders = {

        title: function(data, type, row) {

            return row.url ?

                '<a href="'+row.url+'" target="_blank">'+row.title+'</a>' :

                row.title;

        }

    };

    services.forEach(function(service) {

        // Create a deferenced copy of our table definition object

        var tableDef = JSON.parse(JSON.stringify(tableTmpl));

        // Iterate the table's columns array and add render functions

        // as necessary

        tableDef.columns.forEach(function(column) {

            if (renders[column.data]) {

                column.render = renders[column.data];

            }

        });

        tableDef.ajax.dataSrc = function(data) {

            var results = data.results.search_results;

            // The source appears to be returning it's own pagination

            // data

            if (

                results.hasOwnProperty('recordsFiltered') ||

                results.hasOwnProperty('recordsTotal')

            ) {

                return results;

            }

            // Set up our own pagination values based on what we just

            // got back

            ownPagination = true;

            directionSet = false;

            pageSize = results.length;

            // These values are completely arbitrary, but they enable

            // us to display pagination links

            data.recordsFiltered = 5000,

            data.recordsTotal = 5000;

            return results;

        };

        tableDef.ajax.data = function(data) {

            // Datatables sends a bunch of superfluous params

            // that we don't want to litter our API schema

            // with, so just remove them from the request

            if (data.hasOwnProperty('columns')) {

                delete data.columns;

            }

            if (data.hasOwnProperty('draw')) {

                delete data.draw;

            }

            if (data.hasOwnProperty('order')) {

                delete data.order;

            }

            if (data.hasOwnProperty('search')) {

                delete data.search;

            }

            // If we're handling our own pagination, set the properties

            // that DT will send in the request

            if (ownPagination) {

                start = forward ? start + pageSize : start - pageSize;

                data.start = start;

                data.length = pageSize;

            }

        };

        // Add any datatables config options passed from the service

        // to the table definition

        tableDef.ajax.url = service.endpoint + metadata;

        if (service.hasOwnProperty('datatablesConfig')) {

            var conf = service.datatablesConfig;

            for (var key in conf) {

                // The config from the service definition comes from a Perl

                // hashref, therefore can't contain true/false, so we

                // special case it

                if (conf.hasOwnProperty(key)) {

                    if (conf[key] == 'false') {

                        // Special case false values

                        tableDef[key] = false;

                    } else if (conf[key] == 'true') {

                        // Special case true values

                        tableDef[key] = true;

                    } else {

                        // Copy the property value

                        tableDef[key] = conf[key];

                    }

                }

            }

        }

        // Create event watchers for the "next" and "previous" pagination

        // links, this enables us to set the direction the next request is

        // going in when we're doing our own pagination. We use "hover"

        // because the click event is caught after the request has been

        // sent

        tableDef.drawCallback = function() {

            $('.paginate_button.next:not(.disabled)',

                this.api().table().container()

            ).on('hover', function() {

                forward = true;

                directionSet = true;

            });

            $('.paginate_button.previous:not(.disabled)',

                this.api().table().container()

             ).on('hover', function() {

                forward = false;

                directionSet = true;

            });

        }

        // Initialise the table

        $('#'+service.id ).dataTable(

            $.extend(true, {}, dataTablesDefaults, tableDef)

        );

    });

});

use JSON qw( encode_json );

use Koha::Illrequest::Availability;

        # Does this backend enable us to insert an availability stage and should

        # we? If not, proceed as normal.

        if (

            C4::Context->preference("ILLCheckAvailability") &&

            $request->_backend_capability(

                'should_display_availability',

                $params

            ) &&

            # If the user has elected to continue with the request despite

            # having viewed availability info, this flag will be set

            !$params->{checked_availability}

        ) {

            # Establish which of the installed availability providers

            # can service our metadata, if so, jump in

            my $availability = Koha::Illrequest::Availability->new($params);

            my $services = $availability->get_services();

            if (scalar @{$services} > 0) {

                # Modify our method so we use the correct part of the

                # template

                $op = 'availability';

                # Prepare the metadata we're sending them

                my $metadata = $availability->prep_metadata($params);

                $template->param(

                    metadata        => $metadata,

                    services_json   => encode_json($services),

                    services        => $services,

                    illrequestsview => 1,

                    message         => $params->{message},

                    method          => $op,

                    whole           => $params

                );

                output_html_with_http_headers $query, $cookie,

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

                exit;

            }

        }