From 2e4bd981ad7c22b02201b025c6062d629ed05c6a Mon Sep 17 00:00:00 2001 From: Alex Arnaud Date: Thu, 27 Sep 2018 13:15:50 +0000 Subject: [PATCH] Bug 17047: add a dedicated page for Mana setup Signed-off-by: Michal Denar Signed-off-by: Michal Denar Signed-off-by: Kyle M Hall --- Koha/Subscription/Frequency.pm | 4 - admin/admin-home.pl | 2 + admin/share_content.pl | 89 ++++++++++++ .../atomicupdate/mana_02-add_Mana_syspref.sql | 3 +- installer/data/mysql/sysprefs.sql | 2 +- koha-tmpl/intranet-tmpl/lib/jquery/activatemana.js | 18 --- .../en/includes/mana/mana-report-search-result.inc | 29 ++-- .../mana/mana-subscription-search-result.inc | 33 ++--- .../prog/en/includes/reports-toolbar.inc | 24 ++-- .../prog/en/includes/serials-menu.inc | 2 +- .../prog/en/includes/serials-toolbar.inc | 54 ++++---- .../prog/en/modules/admin/admin-home.tt | 18 ++- .../prog/en/modules/admin/preferences.tt | 1 - .../en/modules/admin/preferences/web_services.pref | 6 +- .../prog/en/modules/admin/share_content.tt | 152 +++++++++++++++++++++ .../en/modules/reports/guided_reports_start.tt | 146 ++++++++++---------- .../prog/en/modules/serials/serials-search.tt | 2 +- .../prog/en/modules/serials/subscription-add.tt | 9 +- .../prog/en/modules/serials/subscription-detail.tt | 2 +- .../intranet-tmpl/prog/js/subscription-add.js | 6 +- reports/guided_reports.pl | 4 +- serials/subscription-add.pl | 5 +- svc/mana/token | 55 -------- t/db_dependent/Koha/Subscription.t | 2 + 24 files changed, 427 insertions(+), 241 deletions(-) create mode 100755 admin/share_content.pl delete mode 100644 koha-tmpl/intranet-tmpl/lib/jquery/activatemana.js create mode 100644 koha-tmpl/intranet-tmpl/prog/en/modules/admin/share_content.tt delete mode 100755 svc/mana/token diff --git a/Koha/Subscription/Frequency.pm b/Koha/Subscription/Frequency.pm index d7d06dc..64dd327 100644 --- a/Koha/Subscription/Frequency.pm +++ b/Koha/Subscription/Frequency.pm @@ -25,11 +25,7 @@ use base qw(Koha::Object); =head1 NAME -<<<<<<< b4c9007cc708d995838eae801a5a24b47435095e -Koha::Subscription::Frequency - Koha Subscription Frequency Object class -======= Koha::Subscription::Frequency - Koha Subscription::Frequency Object class ->>>>>>> Bug 17047 subscriptions management with Mana-KB =head1 API diff --git a/admin/admin-home.pl b/admin/admin-home.pl index ae16bf6..f6a7b23 100755 --- a/admin/admin-home.pl +++ b/admin/admin-home.pl @@ -25,6 +25,7 @@ use Koha::Plugins; my $query = new CGI; my $plugins_enabled = C4::Context->preference('UseKohaPlugins') && C4::Context->config("enable_plugins"); +my $mana_url = C4::Context->config('mana_config'); my ( $template, $loggedinuser, $cookie ) = get_template_and_user( { @@ -38,5 +39,6 @@ my ( $template, $loggedinuser, $cookie ) = get_template_and_user( ); $template->param( plugins_enabled => $plugins_enabled, ); +$template->param( mana_url => $mana_url, ); output_html_with_http_headers $query, $cookie, $template->output; diff --git a/admin/share_content.pl b/admin/share_content.pl new file mode 100755 index 0000000..d900b3e --- /dev/null +++ b/admin/share_content.pl @@ -0,0 +1,89 @@ +#!/usr/bin/perl + +# 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 . + +use Modern::Perl; + +use CGI qw ( -utf8 ); +use JSON; +use HTTP::Request; + +use C4::Auth; +use C4::Output; + +use Koha::SharedContent; + +my $query = new CGI; +my ( $template, $loggedinuser, $cookie ) = get_template_and_user( + { + template_name => "admin/share_content.tt", + query => $query, + type => "intranet", + authnotrequired => 0, + flagsrequired => { parameters => '*' }, + debug => 1, + } +); + +my $op = $query->param('op') || q||; + +if ( $op eq 'save' ) { + my $auto_share = $query->param('autosharewithmana'); + my $mana = $query->param('mana'); + + C4::Context->set_preference('Mana', $mana); + + if ( $auto_share ne '' ) { + C4::Context->set_preference('AutoShareWithMana', 'subscription'); + } else { + C4::Context->set_preference('AutoShareWithMana', ''); + } +} + +if ( $op eq 'reset' ) { + C4::Context->set_preference('ManaToken', ''); +} + +if ( $op eq 'send' ) { + my $name = $query->param('lastname'); + my $firstname = $query->param('firstname'); + my $email = $query->param('email'); + + my $content = to_json({firstname => $firstname, + lastname => $name, + email => $email}); + + my $mana_ip = C4::Context->config('mana_config'); + my $url = "$mana_ip/getsecuritytoken"; + my $request = HTTP::Request->new( POST => $url ); + $request->content($content); + my $result = Koha::SharedContent::process_request($request); + + $template->param( result => $result ); + + if ( $result->{code} eq '201' && $result->{token} ) { + C4::Context->set_preference('ManaToken', $result->{token}); + } +} + + +my $mana_url = C4::Context->config('mana_config') || ''; + +$template->param( + mana_url => $mana_url, +); + +output_html_with_http_headers $query, $cookie, $template->output; diff --git a/installer/data/mysql/atomicupdate/mana_02-add_Mana_syspref.sql b/installer/data/mysql/atomicupdate/mana_02-add_Mana_syspref.sql index dda85a5..2a3c273 100644 --- a/installer/data/mysql/atomicupdate/mana_02-add_Mana_syspref.sql +++ b/installer/data/mysql/atomicupdate/mana_02-add_Mana_syspref.sql @@ -1 +1,2 @@ -INSERT IGNORE INTO systempreferences (variable,value,options,explanation,type) VALUES ('Mana','2', 0|1|2,'request to Mana Webservice. Mana centralize commun information between other Koha to facilitate the creation of new subscriptions, vendors, report queries etc... You can search, share, import and comment the content of Mana.','Choice'); +INSERT IGNORE INTO systempreferences ( `variable`, `value`, `options`, `explanation`, `type` ) VALUES +('Mana','1',NULL,'request to Mana Webservice. Mana centralize common information between other Koha to facilitate the creation of new subscriptions, vendors, report queries etc... You can search, share, import and comment the content of Mana.','YesNo'); diff --git a/installer/data/mysql/sysprefs.sql b/installer/data/mysql/sysprefs.sql index f94efd6..bc012d3 100644 --- a/installer/data/mysql/sysprefs.sql +++ b/installer/data/mysql/sysprefs.sql @@ -275,7 +275,7 @@ INSERT INTO systempreferences ( `variable`, `value`, `options`, `explanation`, ` ('LocalHoldsPriorityItemControl', 'holdingbranch', 'holdingbranch|homebranch', 'decides if the feature operates using the item''s home or holding library.', 'Choice'), ('LocalHoldsPriorityPatronControl', 'PickupLibrary', 'HomeLibrary|PickupLibrary', 'decides if the feature operates using the library set as the patron''s home library, or the library set as the pickup library for the given hold.', 'Choice'), ('makePreviousSerialAvailable','0','','make previous serial automatically available when collecting a new serial. Please note that the item-level_itypes syspref must be set to specific item.','YesNo'), -('Mana','1',NULL,'request to Mana Webservice. Mana centralize commun information between other Koha to facilitate the creation of new subscriptions, vendors, report queries etc... You can search, share, import and comment the content of Mana.','YesNo'), +('Mana','1',NULL,'request to Mana Webservice. Mana centralize common information between other Koha to facilitate the creation of new subscriptions, vendors, report queries etc... You can search, share, import and comment the content of Mana.','YesNo'), ('ManInvInNoissuesCharge','1',NULL,'MANUAL_INV charges block checkouts (added to noissuescharge).','YesNo'), ('MARCAuthorityControlField008','|| aca||aabn | a|a d',NULL,'Define the contents of MARC21 authority control field 008 position 06-39','Textarea'), ('MarcFieldDocURL', NULL, NULL, 'URL used for MARC field documentation. Following substitutions are available: {MARC} = marc flavour, eg. "MARC21" or "UNIMARC". {FIELD} = field number, eg. "000" or "048". {LANG} = user language, eg. "en" or "fi-FI"', 'free'), diff --git a/koha-tmpl/intranet-tmpl/lib/jquery/activatemana.js b/koha-tmpl/intranet-tmpl/lib/jquery/activatemana.js deleted file mode 100644 index 0e9b2e2..0000000 --- a/koha-tmpl/intranet-tmpl/lib/jquery/activatemana.js +++ /dev/null @@ -1,18 +0,0 @@ -$(document).ready(function(){ - $("#activatemana").on("click", function(){ - var mylastname = $("#lastname").val() - var myfirstname = $("#firstname").val() - var myemail = $("#email").val() - $.ajax( { - type: "POST", - url: "/cgi-bin/koha/svc/mana/token", - data: { lastname: mylastname, firstname: myfirstname, email: myemail}, - dataType: "json", - }) - .done(function(result){ - $("#pref_ManaToken").val(result.token); - $("#pref_ManaToken").trigger("input"); - }); - return false; - }); -}); diff --git a/koha-tmpl/intranet-tmpl/prog/en/includes/mana/mana-report-search-result.inc b/koha-tmpl/intranet-tmpl/prog/en/includes/mana/mana-report-search-result.inc index b95600c..fca1b12 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/includes/mana/mana-report-search-result.inc +++ b/koha-tmpl/intranet-tmpl/prog/en/includes/mana/mana-report-search-result.inc @@ -2,6 +2,7 @@ [% USE Koha %] [% USE AuthorisedValues %] [% USE Branches %] +[% USE raw %] +[% END %] +[% INCLUDE 'intranet-bottom.inc' %] diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/reports/guided_reports_start.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/reports/guided_reports_start.tt index 17d3ccb..b8c4b0c 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/reports/guided_reports_start.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/reports/guided_reports_start.tt @@ -137,7 +137,7 @@ canned reports and writing custom SQL reports.

[% IF report_converted %]
- The report "[% report_converted %]" has been converted. + The report "[% report_converted | html %]" has been converted.
[% END %] @@ -179,7 +179,7 @@ canned reports and writing custom SQL reports.

[% IF manamsg %] [% END %] @@ -355,85 +355,78 @@ canned reports and writing custom SQL reports.

- [% IF ( languages_loop ) %] - [% UNLESS ( one_language_enabled ) %] -
-
  • Id:
    -
    • -
  • Name:
    -
    • -
  • SQL:
    -
    • -
  • Group:
    -
    • -
  • Type:
    -
    • -
  • Notes:
    -
    • - -
    -
    -
    - - -
    - - + + [% IF (languages_loop) %] +
    + + - -
    - -
    - [% END %] - [% END %] + [% END %] + + + [% ELSE %] + + [% END %] + + +
    @@ -1291,6 +1284,7 @@ canned reports and writing custom SQL reports.

    $("#note-error").show(); } else{ + $("#reportid").val($(this).closest("tr").find(".report_id").text()); $("#shared_id").html($(this).closest("tr").find(".report_id").text()); $("#shared_name").html($(this).closest("tr").find(".report_name").text()); $("#shared_sql").html($(this).closest("tr").find(".report_sql").val()); @@ -1496,7 +1490,11 @@ canned reports and writing custom SQL reports.

    }); $('div#ManaShareButton').click(function() { - window.location="/cgi-bin/koha/reports/guided_reports.pl?phase=Share"; + $("#mana_share_form").submit(); + }); + + $("#mana_search_form").submit(function(e){ + e.preventDefault(); }); }); diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/serials/serials-search.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/serials/serials-search.tt index adc7428..bbca46c 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/serials/serials-search.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/serials/serials-search.tt @@ -516,7 +516,7 @@ $(".ui-datepicker-trigger").hide(); $("label[for=location], select#location_filter").hide(); [% FOR field IN additional_fields_for_subscription %] - $("label[for=additional_field_[% field.id %]], input#additional_field_[% field.id %]").hide(); + $("label[for=additional_field_[% field.id | $raw %]], input#additional_field_[% field.id | $raw %]").hide(); [% END %] [% END %] }); diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/serials/subscription-add.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/serials/subscription-add.tt index a7bb471..e194a6c 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/serials/subscription-add.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/serials/subscription-add.tt @@ -214,11 +214,10 @@ width: 300px; /* not enough for IE7 apparently */
    - [% IF ( Koha.Preference('Mana') == 2) %] + [% IF ( Koha.Preference('Mana') == 1) && !mana_url %]
    -

    You haven't activated the Mana Knowledge Base, click - here - to configure.

    +

    The Mana Knowledge Base can be used to import subscription patterns submitted by other libraries and save you extra work. Ask your system administrator to configure this service and complete the configuration, or remove this message by disabling the system preference + here

    [% END %] @@ -529,7 +528,7 @@ width: 300px; /* not enough for IE7 apparently */ [% FOREACH field IN dont_export_field_loop %] tags.push("[% field.fieldid | html %]"); [% END %] - var mana_enabled = [% Koha.Preference('Mana') %] + var mana_enabled = [% IF (Koha.Preference('Mana') && mana_url) %]1[% ELSE %]0[% END %]; var MSG_LINK_TO_VENDOR = _("If you wish to claim late or missing issues you must link this subscription to a vendor. Click OK to ignore or Cancel to return and enter a vendor"); var MSG_LINK_BIBLIO = _("You must choose or create a bibliographic record"); var MSG_REQUIRED_SUB_LENGTH = _("You must choose a subscription length or an end date."); diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/serials/subscription-detail.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/serials/subscription-detail.tt index 141b63a..193b707 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/serials/subscription-detail.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/serials/subscription-detail.tt @@ -62,7 +62,7 @@ [% IF mana_code.defined %]

    - [% mana_code %] + [% mana_code | html %]

    [% END %] diff --git a/koha-tmpl/intranet-tmpl/prog/js/subscription-add.js b/koha-tmpl/intranet-tmpl/prog/js/subscription-add.js index da8abd1..776c9fd 100644 --- a/koha-tmpl/intranet-tmpl/prog/js/subscription-add.js +++ b/koha-tmpl/intranet-tmpl/prog/js/subscription-add.js @@ -507,7 +507,9 @@ function mana_use(mana_id){ } $(document).ready(function() { - mana_search(); + if ( mana_enabled == 1 ) { + mana_search(); + } $("#displayexample").hide(); $("#mana_search_result").modal("hide"); $("#aqbooksellerid").on('keypress', function(e) { @@ -617,7 +619,7 @@ $(document).ready(function() { }); $("#subscription_add_next").on("click",function(){ if ( Check_page1() ){ - if ( mana_enabled ) { + if ( mana_enabled == 1 ) { mana_search(); } show_page_2(); diff --git a/reports/guided_reports.pl b/reports/guided_reports.pl index 511d939..80edc2a 100755 --- a/reports/guided_reports.pl +++ b/reports/guided_reports.pl @@ -678,7 +678,9 @@ elsif ( $phase eq 'Save Report' ) { } elsif ($phase eq 'Share'){ - my $result = Koha::SharedContent::send_entity($input->param('mana_language'), $borrowernumber, scalar $input->param('reportid'), 'report'); + my $lang = $input->param('mana_language') || ''; + my $reportid = $input->param('reportid'); + my $result = Koha::SharedContent::send_entity($lang, $borrowernumber, $reportid, 'report'); if ( $result ) { print $input->redirect("/cgi-bin/koha/reports/guided_reports.pl?phase=Use%20saved&manamsg=".$result->{msg}); }else{ diff --git a/serials/subscription-add.pl b/serials/subscription-add.pl index 2edb78d..31198c6 100755 --- a/serials/subscription-add.pl +++ b/serials/subscription-add.pl @@ -52,7 +52,7 @@ my $sub_length; my $permission = ( $op eq 'modify' || $op eq 'modsubscription' ) ? "edit_subscription" : "create_subscription"; -my ($template, $loggedinuser, $cookie) +our ($template, $loggedinuser, $cookie) = get_template_and_user({template_name => "serials/subscription-add.tt", query => $query, type => "intranet", @@ -68,6 +68,9 @@ my $sub_on; my $subs; our $firstissuedate; +my $mana_url = C4::Context->config('mana_config'); +$template->param( 'mana_url' => $mana_url ); + if ($op eq 'modify' || $op eq 'dup' || $op eq 'modsubscription') { my $subscriptionid = $query->param('subscriptionid'); diff --git a/svc/mana/token b/svc/mana/token deleted file mode 100755 index 3ea6254..0000000 --- a/svc/mana/token +++ /dev/null @@ -1,55 +0,0 @@ -#!/usr/bin/perl - -# Copyright 2016 BibLibre Baptiste Wojtkowski -# -# 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 . -# - - -use Modern::Perl; - -use Koha::SharedContent; -use C4::Auth qw(check_cookie_auth); - -use CGI; -use JSON; - -my $input = new CGI; -binmode STDOUT, ":encoding(UTF-8)"; -print $input->header( -type => 'text/plain', -charset => 'UTF-8' ); - -my ( $auth_status, $sessionID ) = - check_cookie_auth( $input->cookie('CGISESSID'), - { serials => 'create_subscription' } ); - -if ( $auth_status ne "ok" ) { - exit 0; -} - -my $mana_ip = C4::Context->config('mana_config'); - -my $url = "$mana_ip/getsecuritytoken"; -my $request = HTTP::Request->new( POST => $url ); - -my $content; -$content->{ firstname }= $input->param("firstname"); -$content->{ lastname }= $input->param("lastname"); -$content->{ email }= $input->param("email"); -my $json = to_json( $content, { utf8 => 1 } ); -$request->content($json); -my $result = Koha::SharedContent::process_request($request); - -print(to_json($result)); diff --git a/t/db_dependent/Koha/Subscription.t b/t/db_dependent/Koha/Subscription.t index fadaae7..926bdc1 100644 --- a/t/db_dependent/Koha/Subscription.t +++ b/t/db_dependent/Koha/Subscription.t @@ -32,6 +32,8 @@ use t::lib::TestBuilder; my $schema = Koha::Database->new->schema; $schema->storage->txn_begin; +my $builder = t::lib::TestBuilder->new; + use_ok('Koha::Subscription'); subtest 'Koha::Subscription->biblio' => sub { -- 2.7.4