Koha-community/Koha
13
7
Fork 0
Code Issues Releases Wiki Activity

Bug 30708: Add user_train_item_id

Browse source 
Sponsored-by: BULAC - http://www.bulac.fr/
Signed-off-by: BULAC - http://www.bulac.fr/

Signed-off-by: Heather Hernandez <heather_hernandez@nps.gov>
Signed-off-by: Laurence Rault <laurence.rault@biblibre.com>

Signed-off-by: Marcel de Rooy <m.de.rooy@rijksmuseum.nl>
Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io>
This commit is contained in:
Jonathan Druart 2023-04-06 14:50:42 +02:00 committed by Tomas Cohen Arazi
parent 8bbe2eac8e
commit f7e6d2f1bd
Signed by: tomascohen
GPG key ID: 0A272EA1B2F3C15F
9 changed files with 198 additions and 36 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
Koha/Preservation/Train.pm
View file

@ -71,10 +71,15 @@ sub add_item {
Koha::Exceptions::Preservation::ItemNotFound->throw unless $item;
Koha::Exceptions::Preservation::ItemNotInWaitingList->throw if $item->notforloan != $not_for_loan;
# FIXME We need a LOCK here
# Not important for now as we have add_items
# Note that there are several other places in Koha with this max+1 problem
my $max = $self->items->search->_resultset->get_column("user_train_item_id")->max || 0;
my $train_item_rs = $self->_result->add_to_preservation_trains_items(
{
item_id => $item->itemnumber,
processing_id => $train_item->{processing_id} || $self->default_processing_id,
user_train_item_id => $max + 1,
added_on => \'NOW()',
}
);

42
Koha/REST/V1/Preservation/Trains.pm
View file

@ -288,6 +288,48 @@ sub get_item {
};
}
=head3 add_items
Controller function that handles adding items in batch to a train
=cut
sub add_items {
my $c = shift->openapi->valid_input or return;
my $train_id = $c->validation->param('train_id');
my $train = Koha::Preservation::Trains->find( $train_id );
unless ($train) {
return $c->render(
status => 404,
openapi => { error => "Train not found" }
);
}
my $body = $c->validation->every_param('body');
return try {
Koha::Database->new->schema->txn_do(
sub {
my $train_items = $train->add_items($body);
return $c->render( status => 201, openapi => $train_items );
}
);
}
catch {
if ( blessed $_ ) {
if ( $_->isa('Koha::Exceptions::Preservation::MissingSettings') ) {
return $c->render(
status => 400,
openapi => { error => "MissingSettings", parameter => $_->parameter }
);
}
}
$c->unhandled_exception($_);
};
}
=head3 add_item
Controller function that handles adding items in batch to a train

78
api/v1/swagger/paths/preservation_trains.yaml
View file

@ -376,6 +376,84 @@
x-koha-authorization:
permissions:
preservation: 1
"/preservation/trains/{train_id}/items/batch":
post:
x-mojo-to: Preservation::Trains#add_items
operationId: addItemsToTrain
tags:
- preservation_train
summary: Add items to train
consumes:
- application/json
produces:
- application/json
parameters:
- $ref: "../swagger.yaml#/parameters/preservation_train_id_pp"
- description: A list of items
in: body
name: body
required: true
schema:
type: array
items:
type: object
responses:
201:
description: A successfully added list of items
schema:
type: array
items:
type: object
400:
description: Bad parameter
schema:
$ref: "../swagger.yaml#/definitions/error"
401:
description: Authentication required
schema:
$ref: "../swagger.yaml#/definitions/error"
403:
description: Access forbidden
schema:
$ref: "../swagger.yaml#/definitions/error"
404:
description: Ressource not found
schema:
$ref: "../swagger.yaml#/definitions/error"
409:
description: Conflict in creating resource
schema:
$ref: "../swagger.yaml#/definitions/error"
413:
description: Payload too large
schema:
$ref: "../swagger.yaml#/definitions/error"
500:
description: |-
Internal server error. Possible `error_code` attribute values:
* `internal_server_error`
schema:
$ref: "../swagger.yaml#/definitions/error"
503:
description: Under maintenance
schema:
$ref: "../swagger.yaml#/definitions/error"
x-koha-authorization:
permissions:
preservation: 1
description: |-
Internal server error. Possible `error_code` attribute values:
* `internal_server_error`
schema:
$ref: "../swagger.yaml#/definitions/error"
503:
description: Under maintenance
schema:
$ref: "../swagger.yaml#/definitions/error"
x-koha-authorization:
permissions:
preservation: 1
"/preservation/trains/{train_id}/items/{train_item_id}":
put:
x-mojo-to: Preservation::Trains#update_item

2
api/v1/swagger/swagger.yaml
View file

@ -343,6 +343,8 @@ paths:
$ref: "./paths/preservation_trains.yaml#/~1preservation~1trains~1{train_id}"
"/preservation/trains/{train_id}/items":
$ref: "./paths/preservation_trains.yaml#/~1preservation~1trains~1{train_id}~1items"
"/preservation/trains/{train_id}/items/batch":
$ref: "./paths/preservation_trains.yaml#/~1preservation~1trains~1{train_id}~1items~1batch"
"/preservation/trains/{train_id}/items/{train_item_id}":
$ref: "./paths/preservation_trains.yaml#/~1preservation~1trains~1{train_id}~1items~1{train_item_id}"
/preservation/processings:

1
installer/data/mysql/kohastructure.sql
View file

@ -4881,6 +4881,7 @@ CREATE TABLE `preservation_trains_items` (
`train_id` int(11) NOT NULL COMMENT 'link with preservation_train',
`item_id` int(11) NOT NULL COMMENT 'link with items',
`processing_id` int(11) NULL COMMENT 'specific processing for this item',
`user_train_item_id` int(11) NOT NULL COMMENT 'train item id for this train, starts from 1',
`added_on` datetime DEFAULT NULL COMMENT 'added date',
PRIMARY KEY (`train_item_id`),
UNIQUE KEY (`train_id`,`item_id`),

26
koha-tmpl/intranet-tmpl/prog/js/vue/components/Preservation/TrainsShow.vue
View file

@ -146,9 +146,8 @@
v-for="(item, counter) in train.items"
v-bind:key="counter"
>
<!-- FIXME Counter here may change, we should pass an order by clause when retrieving the items -->
<label
>{{ counter + 1 }}
>{{ item.user_train_item_id }}
<span class="action_links">
<router-link
:to="`/cgi-bin/koha/preservation/trains/${train.train_id}/items/edit/${item.train_item_id}`"
@ -253,14 +252,21 @@ export default {
let item_row = {}
this.train.default_processing.attributes.forEach(
attribute => {
if (item.attributes.length <= 0) return ""
item_row[
attribute.processing_attribute_id
] = item.attributes.find(
let v = ""
if (item.attributes.length >= 0) {
let a = item.attributes.find(
a =>
a.processing_attribute_id ==
attribute.processing_attribute_id
).value
)
if (a) {
v = a.value
}
}
item_row[
attribute.processing_attribute_id
] = v
}
)
item_row.item = item
@ -268,11 +274,9 @@ export default {
})
this.item_table.columns = []
this.item_table.columns.push({
name: "id",
name: "",
title: this.$__("ID"),
render: (data, type, row) => {
return 42
},
data: "item.user_train_item_id",
})
train.default_processing.attributes.forEach(a =>
this.item_table.columns.push({

34
koha-tmpl/intranet-tmpl/prog/js/vue/components/Preservation/WaitingList.vue
View file

@ -192,30 +192,36 @@ export default {
this.loading()
let item_ids = Object.values(this.last_items)
const client = APIClient.preservation
let promises = []
this.last_items.forEach(i =>
promises.push(
client.train_items.create(
{ item_id: i.item_id },
this.train_id_selected_for_add
)
)
)
Promise.all(promises)
.then(() => {
client.train_items
.createAll(item_ids, this.train_id_selected_for_add)
.then(
result => {
if (result.length) {
this.setMessage(
this.$__(
"The items have been added to train %s."
).format(this.train_id_selected_for_add),
"%s items have been added to train %s."
).format(
result.length,
this.train_id_selected_for_add
),
true
)
} else {
this.setMessage(
this.$__(
"No items have been added to the train."
)
)
}
this.$refs.table.redraw(
"/api/v1/preservation/waiting-list/items"
)
this.show_modal_add_to_train = false
this.last_items = []
})
},
error => {}
)
.then(() => this.loaded())
},
addItemsToWaitingList: function (e) {

5
koha-tmpl/intranet-tmpl/prog/js/vue/fetch/preservation-api-client.js
View file

@ -116,6 +116,11 @@ export class PreservationAPIClient extends HttpClient {
endpoint: "trains/" + train_id + "/items",
body: train_item,
}),
createAll: (train_items, train_id) =>
this.post({
endpoint: "trains/" + train_id + "/items/batch",
body: train_items,
}),
update: (train_item, train_id, id) =>
this.put({
endpoint: "trains/" + train_id + "/items/" + id,

21
t/db_dependent/api/v1/preservation_Trains.t
View file

@ -19,6 +19,7 @@ use Modern::Perl;
use Test::More tests => 6;
use Test::Mojo;
use Test::Warn;
use t::lib::TestBuilder;
use t::lib::Mocks;
@ -372,7 +373,7 @@ subtest 'delete() tests' => sub {
subtest '*_item() tests' => sub {
plan tests => 26;
plan tests => 35;
$schema->storage->txn_begin;
@ -485,6 +486,24 @@ subtest '*_item() tests' => sub {
json => { item_id => $item_2->itemnumber } )->status_is(404)
->json_is( { error => 'Item not found' } );
# batch add items
# Nothing added (FIXME maybe not 201?)
warning_is {
$t->post_ok(
"//$userid:$password@/api/v1/preservation/trains/$train_id/items/batch"
=> json => [ { item_id => $item_3->itemnumber } ] )
->status_is(201)->json_is( [] );
}
'Item not added to train: [Cannot add item to train, it is not in the waiting list]';
$item_3->notforloan($not_for_loan_waiting_list_in)->store;
$t->post_ok(
"//$userid:$password@/api/v1/preservation/trains/$train_id/items/batch"
=> json => [ { item_id => $item_3->itemnumber } ] )->status_is(201)
->json_is( '/0/item_id' => $item_3->itemnumber )
->json_is( '/0/processing_id' => $train->default_processing_id )
->json_has('/0/added_on');
# Update item
my $new_item_attributes = [
{