Bug 10855: interface configuration for adding new fields to subscriptions
authorJonathan Druart <jonathan.druart@biblibre.com>
Thu, 29 Aug 2013 11:32:30 +0000 (13:32 +0200)
committerTomas Cohen Arazi <tomascohen@theke.io>
Fri, 2 Oct 2015 18:10:30 +0000 (15:10 -0300)
This patch adds an interface configuration for adding fields to
subscriptions.

Test plan:
- go to serials/serials-home.pl
- click on the "Add subscription fields" link on the left of the screen
- try to add/update/delete new fields
You are not abble to add a field with an authorised value category and a
marcfield. Columns are sortable
- for the rest, you should have, at least:
  * a new field named af1, sortable, linked to a category
  * a new field named af2, sortable, linked to a marcfield
  * a new field named af3, not sortable

Signed-off-by: Brendan Gallagher <brendan@bywatersolutions.com>
Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io>
koha-tmpl/intranet-tmpl/prog/en/modules/serials/add_fields.tt [new file with mode: 0644]
serials/add_fields.pl [new file with mode: 0755]

diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/serials/add_fields.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/serials/add_fields.tt
new file mode 100644 (file)
index 0000000..6e1a290
--- /dev/null
@@ -0,0 +1,178 @@
+[% INCLUDE 'doc-head-open.inc' %]
+<title>Koha &rsaquo; Serials &rsaquo; Manage new fields for subscriptions
+  [% IF op == "list" %] &rsaquo; List of fields
+  [% ELSIF op == "add_form" %]
+    [% IF field %] &rsaquo; Modify field
+    [% ELSE %] &rsaquo; Add field
+    [% END %]
+  [% END %]
+</title>
+[% INCLUDE 'doc-head-close.inc' %]
+<link rel="stylesheet" type="text/css" href="[% themelang %]/css/datatables.css" />
+<script type="text/javascript" src="[% themelang %]/lib/jquery/plugins/jquery.dataTables.min.js"></script>
+[% INCLUDE 'datatables-strings.inc' %]
+<script type="text/javascript" src="[% themelang %]/js/datatables.js"></script>
+<script type="text/javascript">
+//<![CDATA[
+  $(document).ready(function(){
+
+    $("#fieldst").dataTable($.extend(true, {}, dataTablesDefaults, {
+        'bAutoWidth': false,
+        'sDom': 't<"bottom pager"ilpf>',
+        'sPaginationType': 'four_button',
+        'aLengthMenu': [[10, 20, 50, 100, -1], [10, 20, 50, 100, "All"]],
+        'iDisplayLength': 20,
+        'aaSorting': [[ 0, "asc" ]],
+    }));
+
+    $(".confirmdelete").click(function(){
+      return confirm(_("Are you sure you want to delete this field?"));
+    });
+
+    $("#add_field").on('submit', function(){
+        if ( $("#marcfield").val().length > 0
+            && $("select[name='authorised_value_category']" ).val().length > 0 ) {
+            alert("You cannot select an authorised value category and a marcfield");
+            return false;
+        }
+        return true;
+    });
+  });
+//]]>
+</script>
+</head>
+
+<body id="ser_add_fields" class="ser">
+  [% INCLUDE 'header.inc' %]
+  [% INCLUDE 'serials-search.inc' %]
+
+  <div id="breadcrumbs">
+    <a href="/cgi-bin/koha/mainpage.pl">Home</a> &rsaquo; <a href="/cgi-bin/koha/serials/serials-home.pl">Serials</a> &rsaquo; Manage new fields for subscriptions
+  </div>
+
+  <div id="doc3" class="yui-t2">
+  <div id="bd">
+  <div id="yui-main">
+  <div class="yui-b">
+  [% IF op == 'list' %]
+    <div id="toolbar" class="btn-toolbar">
+      <a class="btn btn-small" id="newfields" href="/cgi-bin/koha/serials/add_fields.pl?op=add_form"><i class="icon-plus"></i> New fields</a>
+    </div>
+  [% END %]
+
+  [% IF messages %]
+    [% FOR message IN messages %]
+      [% IF message.code == 'insert' %]
+        [% IF message.number > 0 %]
+          <div class="dialog message">The field has been inserted</div>
+        [% ELSE %]
+          <div class="dialog alert">The field has not been inserted (name still exist?)</div>
+        [% END %]
+      [% ELSIF message.code == 'update' %]
+        [% IF message.number > 0 %]
+          <div class="dialog message">The field has been updated</div>
+        [% ELSE %]
+          <div class="dialog alert">The field has not been updated (name still exist?)</div>
+        [% END %]
+      [% ELSIF message.code == 'delete' %]
+        [% IF message.number > 0 %]
+          <div class="dialog message">The field has been deleted</div>
+        [% ELSE %]
+          <div class="dialog alert">The field has not been deleted</div>
+        [% END %]
+      [% END %]
+    [% END %]
+  [% END %]
+
+  [% IF op == 'list' %]
+    <h3>Additional fields for subscriptions</h3>
+    [% IF fields %]
+      <table id="fieldst">
+        <thead>
+          <tr>
+            <th>Name</th>
+            <th>Authorised value category</th>
+            <th>Marc field</th>
+            <th>Searchable</th>
+            <th>Actions</th>
+          </tr>
+        </thead>
+        <tbody>
+          [% FOR field IN fields %]
+            <tr>
+              <td>[% field.name %]</td>
+              <td>[% field.authorised_value_category %]</td>
+              <td>[% field.marcfield %]</td>
+              <td>
+                [% IF field.searchable %]Yes[% ELSE %]No[% END %]
+              </td>
+              <td>
+                <a href="/cgi-bin/koha/serials/add_fields.pl?op=add_form&amp;field_id=[% field.id %]" title="Edit this field">Edit</a>
+                <a class="confirmdelete" href="/cgi-bin/koha/serials/add_fields.pl?op=delete&amp;field_id=[% field.id %]" title="Delete this field">Delete</a>
+              </td>
+            </tr>
+          [% END %]
+        </tbody>
+      </table>
+    [% ELSE %]
+      There is no field defined.
+    [% END %]
+  [% ELSIF op == 'add_form' %]
+    [% IF field %]
+      <h3>Modify field</h3>
+    [% ELSE %]
+      <h3>Add field</h3>
+    [% END %]
+    <form action="/cgi-bin/koha/serials/add_fields.pl" name="add_form" id="add_field" method="post">
+      <fieldset class="rows">
+        <ol>
+          <li>
+            <label for="name" class="required">Name: </label>
+            <input type="text" name="name" id="name" value="[% field.name | html %]" />
+          </li>
+          <li>
+            <label for="av">Authorised value category: </label>
+            <select name="authorised_value_category">
+              <option value="">None</option>
+              [% FOR category IN categories %]
+                [% IF field.authorised_value_category == category %]
+                  <option value="[% category %]" selected="selected">[% category %]</option>
+                [% ELSE %]
+                  <option value="[% category %]">[% category %]</option>
+                [% END %]
+              [% END %]
+            </select>
+          </li>
+          <li>
+            <label for="marcfield">Marc field: </label>
+            <input type="text" name="marcfield" id="marcfield" value="[% field.marcfield| html %]" />
+          </li>
+          <li>
+            <label for="searchable">Searchable: </label>
+            [% IF field.searchable %]
+              <input type="checkbox" name="searchable" id="searchable" checked="checked" />
+            [% ELSE %]
+              <input type="checkbox" name="searchable" id="searchable" />
+            [% END %]
+          </li>
+        </ol>
+      </fieldset>
+      <fieldset class="action">
+        [% IF field %]
+          <input type="hidden" name="field_id" value="[% field.id %]" />
+        [% END %]
+        <input type="hidden" name="op" value="add" />
+        <input type="submit" value="Save" />
+        <a href="/cgi-bin/koha/serials/add_fields.pl" class="cancel">Cancel</a>
+      </fieldset>
+    </form>
+  [% END %]
+
+  </div>
+  </div>
+
+<div class="yui-b">
+[% INCLUDE 'serials-menu.inc' %]
+</div>
+</div>
+[% INCLUDE 'intranet-bottom.inc' %]
diff --git a/serials/add_fields.pl b/serials/add_fields.pl
new file mode 100755 (executable)
index 0000000..9451a1b
--- /dev/null
@@ -0,0 +1,126 @@
+#!/usr/bin/perl
+
+# This file is part of Koha.
+#
+# Copyright 2013 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 CGI;
+use C4::Auth;
+use C4::Koha;
+use C4::Output;
+use Koha::AdditionalField;
+
+my $input = new CGI;
+
+my ( $template, $loggedinuser, $cookie ) = get_template_and_user(
+    {
+        template_name   => "serials/add_fields.tt",
+        query           => $input,
+        type            => "intranet",
+        authnotrequired => 0,
+        flagsrequired   => { serials => '*' },
+        debug           => 1,
+    }
+);
+
+my $op = $input->param('op') // 'list';
+my $field_id = $input->param('field_id');
+my @messages;
+
+if ( $op eq 'add' ) {
+    my $name = $input->param('name') // q{};
+    my $authorised_value_category = $input->param('authorised_value_category') // q{};
+    my $marcfield = $input->param('marcfield') // q{};
+    my $searchable = $input->param('searchable') ? 1 : 0;
+    if ( $field_id and $name ) {
+        my $updated = 0;
+        eval {
+            my $af = Koha::AdditionalField->new({
+                id => $field_id,
+                name => $name,
+                authorised_value_category => $authorised_value_category,
+                marcfield => $marcfield,
+                searchable => $searchable,
+            });
+            $updated = $af->update;
+        };
+        push @messages, {
+            code => 'update',
+            number => $updated,
+        };
+    } elsif ( $name ) {
+        my $inserted = 0;
+        eval {
+            my $af = Koha::AdditionalField->new({
+                tablename => 'subscription',
+                name => $name,
+                authorised_value_category => $authorised_value_category,
+                marcfield => $marcfield,
+                searchable => $searchable,
+            });
+            $inserted = $af->insert;
+        };
+        push @messages, {
+            code => 'insert',
+            number => $inserted,
+        };
+    } else {
+        push @messages, {
+            code => 'insert',
+            number => 0,
+        };
+    }
+    $op = 'list';
+}
+
+if ( $op eq 'delete' ) {
+    my $deleted = 0;
+    eval {
+        my $af = Koha::AdditionalField->new( { id => $field_id } );
+        $deleted = $af->delete;
+        $deleted = 0 if $deleted eq '0E0';
+    };
+    push @messages, {
+        code => 'delete',
+        number => $deleted,
+    };
+    $op = 'list';
+}
+
+if ( $op eq 'add_form' ) {
+    my $categories = C4::Koha::GetAuthorisedValueCategories();
+    my $field;
+    if ( $field_id ) {
+        $field = Koha::AdditionalField->new( { id => $field_id } )->fetch;
+    }
+
+    $template->param(
+        field => $field,
+        categories => $categories,
+    );
+}
+
+if ( $op eq 'list' ) {
+    my $fields = Koha::AdditionalField->all( { tablename => 'subscription' } );
+    $template->param( fields => $fields );
+}
+
+$template->param(
+    op => $op,
+    messages => \@messages,
+);
+
+output_html_with_http_headers $input, $cookie, $template->output;