Bug 15766: Adding descriptions to patron card batches

This patch adds a 'description' column to the creator_batches table. The
description for a batch can be added and updated using ajax.

To test:
1) Apply patch and update database (you will have to restart memcached)
2) Go to Tools -> Patron card creator -> Manage batches
3) There should now be a Description column next to Batch ID. This
will be empty (as none of the batches have descriptions yet)
4) Click Edit for any batch
5) Notice new Batch description text field. Enter a description for
the batch in here and click Save description. Some text should show
saying the description was saved.
6) If you go back to the manage batches page, the description should
now show under the Description column.
7) Go to Tools -> Label Creator -> Manage labels
8) Repeat steps 3 to 6

Sponsored-by: Catalyst IT
Signed-off-by: Katrin Fischer <katrin.fischer.83@web.de>
Signed-off-by: Katrin Fischer <katrin.fischer.83@web.de>
Signed-off-by: Nick Clemens <nick@bywatersolutions.com>

diff --git a/C4/Creators/Batch.pm b/C4/Creators/Batch.pm
index 1191b96..3f13917 100644 (file)
--- a/C4/Creators/Batch.pm
+++ b/C4/Creators/Batch.pm
@@ -15,6 +15,7 @@ sub _check_params {
     my @valid_template_params = (
         'label_id',
         'batch_id',
+        'description',
         'item_number',
         'card_number',
         'branch_code',
@@ -43,6 +44,7 @@ sub new {
     my $type = ref($invocant) || $invocant;
     my $self = {
         batch_id        => 0,
+        description     => '',
         items           => [],
         branch_code     => 'NB',
         batch_stat      => 0,   # False if any data has changed and the db has not been updated
@@ -63,7 +65,7 @@ sub add_item {
         my $batch_id = $sth->fetchrow_array;
         $self->{'batch_id'}= ++$batch_id;
     }
-    my $query = "INSERT INTO creator_batches (batch_id, $number_type, branch_code, creator) VALUES (?,?,?,?);";
+    my $query = "INSERT INTO creator_batches (batch_id, description, $number_type, branch_code, creator) VALUES (?,?,?,?,?);";
     my $sth = C4::Context->dbh->prepare($query);
 #    $sth->{'TraceLevel'} = 3;
     $sth->execute($self->{'batch_id'}, $number, $self->{'branch_code'}, $1);
@@ -149,6 +151,7 @@ sub retrieve {
     while (my $record = $sth->fetchrow_hashref) {
         $self->{'branch_code'} = $record->{'branch_code'};
         $self->{'creator'} = $record->{'creator'};
+        $self->{'description'} = $record->{'description'};
         push (@{$self->{'items'}}, {$number_type => $record->{$number_type}, label_id => $record->{'label_id'}});
         $record_flag = 1;       # true if one or more rows were retrieved
     }

diff --git a/C4/Creators/Lib.pm b/C4/Creators/Lib.pm
index fc40c7b..68e6aa5 100644 (file)
--- a/C4/Creators/Lib.pm
+++ b/C4/Creators/Lib.pm
@@ -293,7 +293,7 @@ NOTE: Do not pass in the keyword 'WHERE.'
 sub get_batch_summary {
     my ( $params ) = @_;
     my @batches = ();
-    $params->{fields} = ['batch_id', 'count(batch_id) as _item_count'];
+    $params->{fields} = ['batch_id', 'description', 'count(batch_id) as _item_count'];
     my ( $query, @where_args ) = _build_query( $params, 'creator_batches' );
     $query .= " GROUP BY batch_id";
     my $sth = C4::Context->dbh->prepare($query);

diff --git a/installer/data/mysql/atomicupdate/bug_15766_-_add_description_column_to_batches.perl b/installer/data/mysql/atomicupdate/bug_15766_-_add_description_column_to_batches.perl
new file mode 100644 (file)
index 0000000..1eb2c4a
--- /dev/null
+++ b/installer/data/mysql/atomicupdate/bug_15766_-_add_description_column_to_batches.perl
@@ -0,0 +1,9 @@
+$DBversion = 'XXX';
+if( CheckVersion( $DBversion ) ) {
+    unless( column_exists( 'creator_batches', 'description' ) ) {
+        $dbh->do(q|ALTER TABLE creator_batches ADD description mediumtext default NULL AFTER batch_id|);
+    }
+
+    SetVersion( $DBversion );
+    print "Upgrade to $DBversion done (Bug 15766: Add column creator_batches.description)\n";
+}

diff --git a/installer/data/mysql/kohastructure.sql b/installer/data/mysql/kohastructure.sql
index a56128e..383ea48 100644 (file)
--- a/installer/data/mysql/kohastructure.sql
+++ b/installer/data/mysql/kohastructure.sql
@@ -1820,6 +1820,7 @@ SET character_set_client = utf8;
 CREATE TABLE `creator_batches` (
   `label_id` int(11) NOT NULL AUTO_INCREMENT,
   `batch_id` int(10) NOT NULL DEFAULT '1',
+  `description` mediumtext DEFAULT NULL,
   `item_number` int(11) DEFAULT NULL,
   `borrower_number` int(11) DEFAULT NULL,
   `timestamp` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,

diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/labels/label-edit-batch.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/labels/label-edit-batch.tt
index 445071f..6aabda7 100644 (file)
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/labels/label-edit-batch.tt
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/labels/label-edit-batch.tt
@@ -63,6 +63,9 @@
                                     <ol><li>
                                         <input type="hidden" name="op" value="add" />
                                         <input type="hidden" name="batch_id" value="[% batch_id | html %]" />
+                                        <label for="description">Batch description: </label>
+                                        <input type="text" name="description" value="[% description | html %]">
+                                        <a href="#" id="savedesc" data-batch_id="[% batch_id | html %]">Save description</a> <span id="change-status"></span>
                                     </li>
                                     <li>
                                         <input type="radio" name="number_type" id="barcode_enter" value="barcode" checked />
@@ -319,6 +322,33 @@
                 var batch_id = $(this).data("batch-id");
                 GB_showCenter(_("Export labels"),"/cgi-bin/koha/labels/label-print.pl?batch_id=" + batch_id + "&label_id=" + label_id, 400, 800);
             });
+            $("#savedesc").click(function(event){
+                event.preventDefault(); // prevent form submission
+                var newdescription = $(this).siblings('input[name="description"]').val();
+                var batch_id = $(this).data('batch_id');
+                var ajaxData = {
+                    'newdescription': newdescription,
+                    'batch_id': batch_id,
+                    'card_element': "batch",
+                    'creator': "label",
+                };
+
+                $.ajax({
+                    url: '/cgi-bin/koha/svc/creator_batches',
+                    type: 'POST',
+                    dataType: 'json',
+                    data: ajaxData,
+                })
+
+                .done(function(data){
+                    if (data.status == 'success') {
+                        $("input[name='description']").text(data.newdesc);
+                        $("#change-status").text(_("Saved"));
+                    } else {
+                        $("#change-status").text(_("Unable to save description"));
+                    }
+                });
+            });
          });
     </script>
 [% END %]

diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/patroncards/edit-batch.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/patroncards/edit-batch.tt
index d16ad3f..6a3d37a 100644 (file)
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/patroncards/edit-batch.tt
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/patroncards/edit-batch.tt
@@ -45,12 +45,16 @@
                                 <div>
                                     <fieldset class="rows" style="border-bottom: 0px; border: 0px;">
                                     <ol><li>
-                                    <input type="hidden" name="op" value="add" />
-                                    <input type="hidden" name="batch_id" value="[% batch_id | html %]" />
-                                    <label for="bor_num_list">Add by borrowernumber(s):
-                                        <br /> <span class="hint">One borrowernumber per line.</span>
-                                    </label>
-                                    <textarea rows="5" id="bor_num_list" name="bor_num_list" tabindex="1" class="focus"></textarea>
+                                        <input type="hidden" name="op" value="add" />
+                                        <input type="hidden" name="batch_id" value="[% batch_id | html %]" />
+                                        <label for="description">Batch description: </label>
+                                        <input type="text" name="description" value="[% description | html %]">
+                                        <a href="#" id="savedesc" data-batch_id="[% batch_id | html %]">Save description</a> <span id="change-status"></span>
+                                    </li><li>
+                                        <label for="bor_num_list">Add by borrowernumber(s):
+                                            <br /> <span class="hint">One borrowernumber per line.</span>
+                                        </label>
+                                        <textarea rows="5" id="bor_num_list" name="bor_num_list" tabindex="1" class="focus"></textarea>
                                     </li></ol>
                                     </fieldset>
                                 </div>
@@ -265,7 +269,33 @@
                 e.preventDefault();
                 var label_id = $(this).data("label-id");
                 var batch_id = $(this).data("batch-id");
-                GB_showCenter( _("Export single card"),'/cgi-bin/koha/patroncards/print.pl?batch_id='+batch_id+'&label_id='+label_id, 400, 800);
+                GB_showCenter( _("Export single card"),'/cgi-bin/koha/patroncards/print.pl?batch_id=' + batch_id + '&label_id=' + label_id, 400, 800);
+            });
+            $("#savedesc").click(function(event){
+                var newdescription = $(this).siblings('input[name="description"]').val();
+                var batch_id = $(this).data('batch_id');
+                var ajaxData = {
+                    'newdescription': newdescription,
+                    'batch_id': batch_id,
+                    'card_element': "batch",
+                    'creator': "patroncard",
+                };
+
+                $.ajax({
+                    url: '/cgi-bin/koha/svc/creator_batches',
+                    type: 'POST',
+                    dataType: 'json',
+                    data: ajaxData,
+                })
+
+                .done(function(data){
+                    if (data.status == 'success') {
+                        $("input[name='description']").text(data.newdesc);
+                        $("#change-status").text(_("Saved"));
+                    } else {
+                        $("#change-status").text(_("Unable to save description"));
+                    }
+                });
             });
         });
     </script>

diff --git a/labels/label-edit-batch.pl b/labels/label-edit-batch.pl
index 0026ebe..0121ad2 100755 (executable)
--- a/labels/label-edit-batch.pl
+++ b/labels/label-edit-batch.pl
@@ -63,6 +63,7 @@ my @item_numbers;
 my $number_list;
 my $number_type = $cgi->param('number_type') || "barcode";
 my $batch_id = $cgi->param('element_id') || $cgi->param('batch_id') || 0;
+my $description = $cgi->param('description') || '';
 @label_ids = $cgi->multi_param('label_id') if $cgi->param('label_id');
 @item_numbers = $cgi->multi_param('item_number') if $cgi->param('item_number');
 $number_list = $cgi->param('number_list') if $cgi->param('number_list');
@@ -99,6 +100,7 @@ elsif ($op eq 'add') {
     }
     if ($batch_id != 0) {$batch = C4::Labels::Batch->retrieve(batch_id => $batch_id);}
     if ($batch_id == 0 || $batch == -2) {$batch = C4::Labels::Batch->new(branch_code => $branch_code);}
+    $template->param( description => $batch->{description} );
     if ($branch_code){
         foreach my $item_number (@item_numbers) {
             $err = $batch->add_item($item_number);
@@ -123,6 +125,7 @@ elsif ($op eq 'de_duplicate') {
 }
 else { # edit
     $batch = C4::Labels::Batch->retrieve(batch_id => $batch_id);
+    $template->param( description => $batch->{description} );
 }
 
 my $items = $batch->get_attr('items');

diff --git a/labels/label-manage.pl b/labels/label-manage.pl
index 1d8a34e..8ee73b1 100755 (executable)
--- a/labels/label-manage.pl
+++ b/labels/label-manage.pl
@@ -66,6 +66,7 @@ my $display_columns = { layout =>   [  # db column       => {col label
                                     ],
                         batch =>    [
                                         {batch_id        => {label => 'Batch ID',       link_field      => 0}},
+                                        {description     => {label => 'Description',    link_field      => 0}},
                                         {_item_count     => {label => 'Item Count',     link_field      => 0}},
                                         {select          => {label => 'Actions',         value           => 'batch_id'}},
                                         {select1         => {label => ' ',           link_field       => 'batch_id'}},

diff --git a/patroncards/edit-batch.pl b/patroncards/edit-batch.pl
index bd06aab..236706e 100755 (executable)
--- a/patroncards/edit-batch.pl
+++ b/patroncards/edit-batch.pl
@@ -55,6 +55,7 @@ my $display_columns = [ {_summary       => {label => 'Summary', link_field => 0}
                       ];
 my $op = $cgi->param('op') || 'new';
 my $batch_id = $cgi->param('element_id') || $cgi->param('batch_id') || 0;
+my $description = $cgi->param('description') || '';
 my ( @label_ids, @item_numbers, @borrower_numbers );
 @label_ids = $cgi->multi_param('label_id') if $cgi->param('label_id');
 @item_numbers = $cgi->multi_param('item_number') if $cgi->param('item_number');
@@ -93,6 +94,7 @@ if ($bor_num_list) {
     }
     if ($batch_id != 0) {$batch = C4::Patroncards::Batch->retrieve(batch_id => $batch_id);}
     if ($batch_id == 0 || $batch == -2) {$batch = C4::Patroncards::Batch->new(branch_code => $branch_code);}
+    $template->param( description => $batch->{'description'} );
     if ($branch_code){
         foreach my $borrower_number (@borrower_numbers) {
             $err = $batch->add_item($borrower_number);
@@ -119,6 +121,7 @@ elsif ($op eq 'de_duplicate') {
 }
 elsif ($op eq 'edit') {
     $batch = C4::Patroncards::Batch->retrieve(batch_id => $batch_id);
+    $template->param( description => $batch->{'description'} );
 }
 elsif ($op eq 'new') {
     if ($branch_code eq '') {

diff --git a/patroncards/manage.pl b/patroncards/manage.pl
index 96f8158..cc4a817 100755 (executable)
--- a/patroncards/manage.pl
+++ b/patroncards/manage.pl
@@ -69,6 +69,7 @@ my $display_columns = { layout =>   [  # db column       => {col label
                                         {select          => {label => 'Select',         value           => 'profile_id'}},
                                     ],
                         batch =>    [   {batch_id        => {label => 'Batch ID',       link_field      => 0}},
+                                        {description     => {label => 'Description',    link_field      => 0}},
                                         {_item_count     => {label => 'Patron Count',   link_field      => 0}},
                                         {_action         => {label => 'Actions',        link_field      => 0}},
                                         {select          => {label => 'Select',         value           => 'batch_id'}},

diff --git a/svc/creator_batches b/svc/creator_batches
new file mode 100644 (file)
index 0000000..28436e0
--- /dev/null
+++ b/svc/creator_batches
@@ -0,0 +1,73 @@
+#!/usr/bin/perl
+
+# This file is part of Koha.
+#
+# Copyright 2017 Aleisha Amohia <aleisha@catalyst.net.nz>
+#
+# 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 JSON qw( encode_json );
+use CGI;
+use C4::Service;
+use C4::Context;
+use C4::Auth qw /check_cookie_auth/;
+use C4::Output qw(:DEFAULT :ajax);
+use C4::Patroncards::Batch;
+use C4::Labels::Batch;
+
+=head1 NAME
+
+svc/creator_batches - Web service for managing AJAX functionality for patroncards and label batches
+
+=head1 DESCRIPTION
+
+=cut
+
+# AJAX requests
+my $is_ajax = is_ajax();
+my $cgi = new CGI;
+my ( $auth_status, $sessionID ) = check_cookie_auth( $cgi->cookie('CGISESSID'), { catalogue => 1 } );
+if ( $auth_status ne "ok" ) {
+    exit 0;
+}
+
+if ($is_ajax) {
+    my $batch_id = $cgi->param('batch_id');
+    my $description = $cgi->param('newdescription');
+    my $status = '';
+    my $dbh = C4::Context->dbh;
+    my $query = "UPDATE creator_batches SET description = ? WHERE batch_id = ?";
+    my $sth = $dbh->prepare($query);
+    $sth->execute($description, $batch_id);
+
+    # Check for success
+    my $creator = $cgi->param('creator');
+    if ( $creator eq 'patroncard' ) {
+        my $batch = C4::Patroncards::Batch->retrieve(batch_id => $batch_id);
+        if ( $batch->{description} eq $description ) {
+            $status = 'success';
+        }
+    } elsif ( $creator eq 'label' ) {
+        my $batch = C4::Labels::Batch->retrieve(batch_id => $batch_id);
+        if ( $batch->{description} eq $description ) {
+            $status = 'success';
+        }
+    }
+
+    my $json = encode_json ( { status => $status, newdesc => $description } );
+    output_with_http_headers $cgi, undef, $json, 'js';
+    exit;
+}