Jonathan Druart
424aca3d56
Here we go!
Disclaimer: this patch is huge and does many things, but splitting it in
several chunks would be time consuming and painful to rebase. However it
adds many tests and isolate/refactor code to make it way more reusable.
This patchset will make the "batch item modification" and "batch item
deletion" features use the task queue (reminder: Since bug 28158, and so
21.05.00, we do no longer use the old "background job" functionality and
the user does not get any info about the progress of the job).
More than that, more of the code to build an item form and a list of
items is now isolated in module (.pm) and include files (.inc)
We are reusing the changes made by bug 27526 that simplifies the way we
edit/create items (no more unecessary serialization Koha > MARC > MARCXML
> XML > HTML)
New module:
* Koha::BackgroundJob::BatchDeleteItem
Subclass for process item deletion in batch
* Koha::BackgroundJob::BatchUpdateItem
Subclass for process item modification in batch
* Koha::Item::Attributes
We needed an object to represent item's attributes that are not
mapped with a koha field (aka "more subfields xml")
This module will help us to create the marcxml from a hashref and the
reverse.
* Koha::UI::Form::Builder::Item
The code that was used to build the add/edit item form is
centralised in this module. In conjunction with the
subfields_for_item BLOCK (from html_helpers.inc) it will be really
easy to reuse this code in other places where the item form is used
(acquisition and serials modules)
* Koha::UI::Table::Builder::Items
Same as previously for the table. We are now using this table from 3
different places (batch item mod, batch item del, backgroung job
detail view) and the code is only in one place.
To use with items_table_batchmod BLOCK (still from html_helpers.inc)
This patch is fixing some bugs about repeatable subfields and regex. A UI
change will reflect the limitation: if you want to apply a regex on a
subfield you cannot add several subfields for the same subfield code.
Test plan:
Prepare the ground:
- Make sure you are always using a bibliographic/item record using the framework
you are modifying!
- Add some subfields for items that are not mapped with a koha field
(note that you can use 'é' for more fun, don't try more funny
characters)
- Make some subfields (mapped and not mapped with a kohafield)
repeatable
- Add default values to some of your subfields
There are 4 main screens to test:
1. Add/edit item form
The behaviour should be the same before and after this patch.
See test plan from bug 27526.
Those 2 prefs must be tested:
* SubfieldsToAllowForRestrictedEditing
* SubfieldsToUseWhenPrefill
2. Batch modification
a. Fill some values, play with repeatable and regex.
Note that the behaviour in master was buggy, only the first value was modified by the regex:
* With subfield = "a | b"
1 value added with "new"
=> "new | b"
* With subfield = "a | b"
2 new fields "new1","new2"
=> "new2 | b"
Important note: For repeatable subfields, a regex will apply on the subfields in
the "concatenated form". To apply the regex on all the different subfields of a given
subfield code you must use the "g" modifier.
This could be improved later, but keep in mind that it's not a regression or behaviour
change.
b. Play with the "Populate fields with default values from default framework" checkbox
c. Use this tool to modify items and play with the different sysprefs that
interfer with it:
* NewItemsDefaultLocation
* SubfieldsToAllowForRestrictedBatchmod
* MaxItemsToDisplayForBatchMod
* MaxItemsToProcessForBatchMod
3. Batch deletion
a. Batch delete some items
b. Check items out and try to delete them
c. Use the "Delete records if no items remain" checkbox to delete
bibliographic records without remaining items.
d. Play with the following sysprefs and confirm that it works as
expected:
* MaxItemsToDisplayForBatchDel
e. Stress the tool: Go to the confirmation screen with items that can be
deleted, don't request the job to be processed right away, but check the
item out before.
4. Background job detail view
You must have seen it already if you are curious and tested the above.
When a new modification or deletion batch is requested, the confirmation
screen will tell you that the job has enqueued. A link to the progress
of the job can be followed.
On this screen you will be able to see the result of the job once it's
fully processed.
QA notes:
* There are some FIXME's that are not blocker in my opinion. Feel free to
discuss them if you have suggestions.
* Do we still need MaxItemsToProcessForBatchMod?
* Prior to this patchset we had a "Return to the cataloging module" link
if we went from the cataloguing module and that the biblio was deleted.
We cannot longer know if the biblio will be deleted but we could display
a "Go to the cataloging module" link on the "job has been enqueued"
screen regardless from where we were coming from.
Signed-off-by: Nick Clemens <nick@bywatersolutions.com>
Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io>
Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>
201 lines
7.2 KiB
Text
201 lines
7.2 KiB
Text
[% USE raw %]
|
|
[% USE KohaDates %]
|
|
[% USE Asset %]
|
|
[% SET footerjs = 1 %]
|
|
[% PROCESS 'i18n.inc' %]
|
|
[% INCLUDE 'doc-head-open.inc' %]
|
|
<title>Batch item deletion › Tools › Koha</title>
|
|
[% INCLUDE 'doc-head-close.inc' %]
|
|
<!--[if IE]>
|
|
<style>#selections { display: none; }</style>
|
|
<![endif]-->
|
|
</head>
|
|
<body id="tools_batchMod-del" class="tools">
|
|
[% INCLUDE 'header.inc' %]
|
|
[% INCLUDE 'cat-search.inc' %]
|
|
|
|
<nav id="breadcrumbs" aria-label="Breadcrumb" class="breadcrumb">
|
|
<ol>
|
|
<li>
|
|
<a href="/cgi-bin/koha/mainpage.pl">Home</a>
|
|
</li>
|
|
<li>
|
|
<a href="/cgi-bin/koha/tools/tools-home.pl">Tools</a>
|
|
</li>
|
|
<li>
|
|
<a href="#" aria-current="page">Batch item deletion</a>
|
|
</li>
|
|
</ol>
|
|
</nav>
|
|
|
|
<div class="main container-fluid">
|
|
|
|
<h1>Batch item deletion</h1>
|
|
|
|
[% FOREACH message IN messages %]
|
|
[% IF message.type == 'success' %]
|
|
<div class="dialog message">
|
|
[% ELSIF message.type == 'warning' %]
|
|
<div class="dialog alert">
|
|
[% ELSIF message.type == 'error' %]
|
|
<div class="dialog alert" style="margin:auto;">
|
|
[% END %]
|
|
[% IF message.code == 'cannot_enqueue_job' %]
|
|
Cannot enqueue this job.
|
|
[% END %]
|
|
[% IF message.error %]
|
|
(The error was: [% message.error | html %], see the Koha log file for more information).
|
|
[% END %]
|
|
</div>
|
|
[% END %]
|
|
|
|
|
|
[% UNLESS ( action ) %]
|
|
|
|
[% IF ( notfoundbarcodes.size ) %]
|
|
<div class="dialog alert">
|
|
[% IF ( itemresults ) %]<p>Warning, the following barcodes were not found:</p>[% ELSE %]<p>Warning: no barcodes were found</p>[% END %]
|
|
</div>
|
|
<table style="margin:auto;">
|
|
<thead>
|
|
<tr><th>Barcodes not found</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
[% FOREACH notfoundbarcode IN notfoundbarcodes %]
|
|
<tr><td>[% notfoundbarcode |html %]</td></td>
|
|
[% END %]
|
|
</tbody>
|
|
</table>
|
|
[% END %] <!-- /notfoundbarcodes -->
|
|
[% IF ( notfounditemnumbers.size ) %]
|
|
<div class="dialog alert">
|
|
[% IF ( itemresults ) %]<p>Warning, the following itemnumbers were not found:</p>[% ELSE %]<p>Warning: no itemnumbers were found</p>[% END %]
|
|
</div>
|
|
<table style="margin:auto;">
|
|
<thead>
|
|
<tr><th>Itemnumbers not found</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
[% FOREACH notfounditemnumber IN notfounditemnumbers %]
|
|
<tr><td>[% notfounditemnumber |html %]</td></td>
|
|
[% END %]
|
|
</tbody>
|
|
</table>
|
|
[% END %] <!-- /notfounditemnumbers -->
|
|
|
|
[% IF cannot_be_deleted.size %]
|
|
<div class="dialog alert">
|
|
<p>Warning, the following items cannot be deleted: </p>
|
|
</div>
|
|
<table style="margin:auto;">
|
|
<thead>
|
|
<tr><th>Cannot be deleted</th></tr>
|
|
</thead>
|
|
<tbody>
|
|
[% FOREACH barcode IN cannot_be_deleted %]
|
|
<tr><td>[% barcode | html %]</td></td>
|
|
[% END %]
|
|
</tbody>
|
|
</table>
|
|
[% END %]
|
|
|
|
[% IF ( notfoundbarcodes.size || notfounditemnumbers.size || cannot_be_deleted.size ) && !too_many_items_display && item_loop %]
|
|
<h4>The following barcodes were found: </h4>
|
|
[% END %]
|
|
|
|
|
|
<form name="f" action="batchMod.pl" method="post">
|
|
<input type="hidden" name="biblionumber" id="biblionumber" value="[% biblionumber | html %]" />
|
|
<input type="hidden" name="op" value="[% op | html %]" />
|
|
<input type="hidden" name="searchid" value="[% searchid | html %]" />
|
|
<input type="hidden" name="src" id="src" value="[% src | html %]" />
|
|
[% IF biblionumber %]
|
|
<input type="hidden" name="biblionumber" id="biblionumber" value="[% biblionumber | html %]" />
|
|
[% END %]
|
|
|
|
[% IF items.size %]
|
|
[% PROCESS items_table_batchmod headers => item_header_loop, items => items, checkboxes_delete => 1, display_columns_selection => 1 %]
|
|
[% END %]
|
|
|
|
[% IF ( simple_items_display ) %]
|
|
<ul>
|
|
[% FOREACH simple_items_displa IN simple_items_display %]
|
|
<li>
|
|
<a href="[% simple_items_displa.itemnumber | url %]">[% simple_items_displa.barcode | html %]</a>
|
|
</li>
|
|
[% END %]
|
|
</ul>
|
|
[% END %]
|
|
|
|
|
|
[% IF ( show ) %]
|
|
|
|
[% IF ( too_many_items_display ) %]
|
|
<p>Too many items ([% too_many_items_display | html %]) to display individually.</p>
|
|
[% FOREACH itemnumber IN itemnumbers_array %]
|
|
<input type="hidden" name="itemnumber" value="[% itemnumber | html %]" />
|
|
[% END %]
|
|
[% END %]
|
|
|
|
[% IF ( itemresults ) %]
|
|
<div id="cataloguing_additem_newitem">
|
|
<input type="hidden" name="op" value="[% op | html %]" />
|
|
<p>This will delete [% IF ( too_many_items_display ) %]all the[% ELSE %]the selected[% END %] items.</p>
|
|
<input type="hidden" name="del" value="1" />
|
|
<fieldset class="action">
|
|
<input type="checkbox" name="del_records" id="del_records" /> <label for="del_records">Delete records if no items remain.</label>
|
|
[% IF too_many_items_display %]
|
|
<input type="submit" name="mainformsubmit" value="Delete ALL submitted items" />
|
|
[% ELSE %]
|
|
<input type="submit" name="mainformsubmit" value="Delete selected items" />
|
|
[% END %]
|
|
|
|
<a href="/cgi-bin/koha/tools/batchMod.pl?del=1" class="cancel">Cancel</a>
|
|
</fieldset>
|
|
</div>
|
|
[% ELSE %]
|
|
<p><a href="/cgi-bin/koha/tools/batchMod.pl?del=1">Return to batch item deletion</a></p>
|
|
[% END %]
|
|
[% END %]
|
|
</form>
|
|
[% END %]
|
|
|
|
|
|
[% IF op == 'enqueued' %]
|
|
<div class="dialog message">
|
|
<p>The job has been enqueued! It will be processed as soon as possible.</p>
|
|
<p><a href="/cgi-bin/koha/admin/background_jobs.pl?op=view&id=[% job_id | uri %]" title="View detail of the enqueued job">View detail of the enqueued job</a>
|
|
| <a href="/cgi-bin/koha/tools/batchMod.pl?del=1" title="New batch item deletion">New batch item deletion</a></p>
|
|
</div>
|
|
|
|
<fieldset class="action">
|
|
[% IF src == 'CATALOGUING' # from catalogue/detail.pl > Delete items in a batch%]
|
|
[% IF searchid %]
|
|
<a href="/cgi-bin/koha/catalogue/detail.pl?biblionumber=[% biblionumber | uri %]&searchid=[% searchid | uri %]">Return to the record</a>
|
|
[% ELSE %]
|
|
<a href="/cgi-bin/koha/catalogue/detail.pl?biblionumber=[% biblionumber | uri %]">Return to the record</a>
|
|
[% END %]
|
|
[% ELSIF src %]
|
|
<a href="[% src | url %]">Return to where you were</a>
|
|
[% ELSE %]
|
|
<a href="/cgi-bin/koha/tools/batchMod.pl?del=1">Return to batch item deletion</a>
|
|
[% END %]
|
|
</fieldset>
|
|
[% END %]
|
|
|
|
</div>
|
|
|
|
[% MACRO jsinclude BLOCK %]
|
|
[% Asset.js("js/tools-menu.js") | $raw %]
|
|
[% INCLUDE 'datatables.inc' %]
|
|
[% Asset.js("js/pages/batchMod.js") | $raw %]
|
|
[% Asset.js("js/browser.js") | $raw %]
|
|
<script>
|
|
[% IF searchid %]
|
|
browser = KOHA.browser('[% searchid | html %]');
|
|
browser.show_back_link();
|
|
[% END %]
|
|
</script>
|
|
[% END %]
|
|
|
|
[% INCLUDE 'intranet-bottom.inc' %]
|