Attachment 160578 Details for Bug 35717 – Bug 35717: Add link between suggestions and orders

[patch] Bug 35717: Add link between suggestions and orders

Bug-35717-Add-link-between-suggestions-and-orders.patch (text/plain), 24.35 KB, created by Nick Clemens (kidclamp) on 2024-01-05 18:57:05 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Nick Clemens (kidclamp)

Created: 2024-01-05 18:57:05 UTC

Size: 24.35 KB

patch

obsolete

>From 02d8520035fdd337e3939fa3d4df13d185de5d19 Mon Sep 17 00:00:00 2001
>From: Jonathan Druart <jonathan.druart@bugs.koha-community.org>
>Date: Wed, 10 May 2023 15:18:15 +0200
>Subject: [PATCH] Bug 35717: Add link between suggestions and orders
>
>Signed-off-by: Nick Clemens <nick@bywatersolutions.com>
>---
> Koha/Acquisition/Order.pm | 36 ++++++++---
> acqui/addorder.pl | 12 ++++
> acqui/basket.pl | 6 --
> acqui/orderreceive.pl | 1 -
> acqui/parcel.pl | 6 +-
> api/v1/swagger/definitions/order.yaml | 3 +
> api/v1/swagger/definitions/suggestion.yaml | 6 ++
> api/v1/swagger/paths/acquisitions_orders.yaml | 6 +-
> .../prog/en/modules/acqui/basket.tt | 8 ++-
> .../prog/en/modules/acqui/orderreceive.tt | 38 +++++------
> .../prog/en/modules/acqui/parcel.tt | 52 +++++++--------
> t/db_dependent/Koha/Acquisition/Order.t | 64 +++++++++++++++----
> 12 files changed, 156 insertions(+), 82 deletions(-)
>
>diff --git a/Koha/Acquisition/Order.pm b/Koha/Acquisition/Order.pm
>index e0fea073f1a..7c3cbaa0bbb 100644
>--- a/Koha/Acquisition/Order.pm
>+++ b/Koha/Acquisition/Order.pm
>@@ -146,15 +146,17 @@ sub cancel {
> }
> 
> # If ordered from a suggestion, revert the suggestion status to ACCEPTED
>- my $suggestion = Koha::Suggestions->find({ biblionumber => $self->biblionumber, status => "ORDERED" });
>- if ( $suggestion and $suggestion->id ) {
>- ModSuggestion(
>- {
>- suggestionid => $suggestion->id,
>- biblionumber => $self->biblionumber,
>- STATUS => 'ACCEPTED',
>- }
>- );
>+ my $suggestions = $self->suggestions;
>+ while ( my $suggestion = $suggestions->next ){
>+ if ( $suggestion && $suggestion->STATUS eq "ORDERED" ) {
>+ ModSuggestion(
>+ {
>+ suggestionid => $suggestion->id,
>+ biblionumber => $self->biblionumber,
>+ STATUS => 'ACCEPTED',
>+ }
>+ );
>+ }
> }
> 
> my $biblio = $self->biblio;
>@@ -297,6 +299,22 @@ sub subscription {
> return Koha::Subscription->_new_from_dbic( $subscription_rs );
> }
> 
>+=head3 suggestions
>+
>+ my $suggestions = $order->suggestions
>+
>+Returns the I<Koha::Suggestions> object for the suggestions associated
>+to the order.
>+
>+=cut
>+
>+sub suggestions {
>+ my ( $self ) = @_;
>+ my $rs = $self->_result->suggestions;
>+ return unless $rs;
>+ return Koha::Suggestions->_new_from_dbic( $rs );
>+}
>+
> =head3 current_item_level_holds
> 
> my $holds = $order->current_item_level_holds;
>diff --git a/acqui/addorder.pl b/acqui/addorder.pl
>index c5b9847b019..f8d4f9e0b20 100755
>--- a/acqui/addorder.pl
>+++ b/acqui/addorder.pl
>@@ -356,6 +356,18 @@ if ( $basket->{is_standing} || $orderinfo->{quantity} ne '0' ) {
> $order->populate_with_prices_for_ordering();
> $order->store;
> 
>+ # change suggestion status if applicable
>+ if ( my $suggestionid = $input->param('suggestionid') ) {
>+ ModSuggestion(
>+ {
>+ suggestionid => $suggestionid,
>+ biblionumber => $orderinfo->{biblionumber},
>+ ordernumber => $order->ordernumber,
>+ STATUS => 'ORDERED',
>+ }
>+ );
>+ }
>+
> # Log the order creation
> if (C4::Context->preference("AcquisitionLog")) {
> my $infos = {};
>diff --git a/acqui/basket.pl b/acqui/basket.pl
>index 33253aad47b..17589b66f8d 100755
>--- a/acqui/basket.pl
>+++ b/acqui/basket.pl
>@@ -27,7 +27,6 @@ use CGI qw ( -utf8 );
> use C4::Acquisition qw( GetBasket CanUserManageBasket GetBasketAsCSV NewBasket NewBasketgroup ModBasket ReopenBasket ModBasketUsers GetBasketgroup GetBasketgroups GetBasketUsers GetOrders GetOrder get_rounded_price );
> use C4::Budgets qw( GetBudgetHierarchy GetBudget CanUserUseBudget );
> use C4::Contract qw( GetContract );
>-use C4::Suggestions qw( GetSuggestion GetSuggestionInfoFromBiblionumber GetSuggestionInfo );
> use Koha::Biblios;
> use Koha::Acquisition::Baskets;
> use Koha::Acquisition::Booksellers;
>@@ -503,11 +502,6 @@ sub get_order_infos {
> 
> }
> 
>- my $suggestion = GetSuggestionInfoFromBiblionumber($line{biblionumber});
>- $line{suggestionid} = $$suggestion{suggestionid};
>- $line{surnamesuggestedby} = $$suggestion{surnamesuggestedby};
>- $line{firstnamesuggestedby} = $$suggestion{firstnamesuggestedby};
>-
> $line{estimated_delivery_date} = $order->{estimated_delivery_date};
> 
> foreach my $key (qw(transferred_from transferred_to)) {
>diff --git a/acqui/orderreceive.pl b/acqui/orderreceive.pl
>index d8192292f2f..2ca33d16471 100755
>--- a/acqui/orderreceive.pl
>+++ b/acqui/orderreceive.pl
>@@ -68,7 +68,6 @@ use C4::Output qw( output_html_with_http_headers );
> use C4::Budgets qw( GetBudget GetBudgetPeriods GetBudgetPeriod GetBudgetHierarchy CanUserUseBudget );
> use C4::Members;
> use C4::Biblio qw( GetMarcStructure );
>-use C4::Suggestions qw( GetSuggestion GetSuggestionInfoFromBiblionumber GetSuggestionInfo );
> 
> use Koha::Acquisition::Booksellers;
> use Koha::Acquisition::Currencies qw( get_active );
>diff --git a/acqui/parcel.pl b/acqui/parcel.pl
>index 06172690f68..ed3ca1a8fee 100755
>--- a/acqui/parcel.pl
>+++ b/acqui/parcel.pl
>@@ -61,7 +61,6 @@ use C4::Acquisition qw( CancelReceipt GetInvoice GetInvoiceDetails get_rounded_p
> use C4::Budgets qw( GetBudget GetBudgetByOrderNumber GetBudgetName );
> use CGI qw ( -utf8 );
> use C4::Output qw( output_html_with_http_headers );
>-use C4::Suggestions qw( GetSuggestion GetSuggestionInfoFromBiblionumber GetSuggestionInfo );
> 
> use Koha::Acquisition::Baskets;
> use Koha::Acquisition::Bookseller;
>@@ -149,10 +148,7 @@ for my $order ( @orders ) {
> $total_tax_excluded += get_rounded_price($line{unitprice_tax_excluded}) * $line{quantity};
> $total_tax_included += get_rounded_price($line{unitprice_tax_included}) * $line{quantity};
> 
>- my $suggestion = GetSuggestionInfoFromBiblionumber($line{biblionumber});
>- $line{suggestionid} = $suggestion->{suggestionid};
>- $line{surnamesuggestedby} = $suggestion->{surnamesuggestedby};
>- $line{firstnamesuggestedby} = $suggestion->{firstnamesuggestedby};
>+ $line{order_object} = $order_object;
> 
> if ( $line{parent_ordernumber} != $line{ordernumber} ) {
> if ( grep { $_->{ordernumber} == $line{parent_ordernumber} }
>diff --git a/api/v1/swagger/definitions/order.yaml b/api/v1/swagger/definitions/order.yaml
>index 61aaae480d9..2e1ba3b9a23 100644
>--- a/api/v1/swagger/definitions/order.yaml
>+++ b/api/v1/swagger/definitions/order.yaml
>@@ -264,4 +264,7 @@ properties:
> - object
> - "null"
> description: Patron that created the order
>+ suggestions:
>+ type:
>+ - array
> additionalProperties: false
>diff --git a/api/v1/swagger/definitions/suggestion.yaml b/api/v1/swagger/definitions/suggestion.yaml
>index daa136ff23b..327feb4301b 100644
>--- a/api/v1/swagger/definitions/suggestion.yaml
>+++ b/api/v1/swagger/definitions/suggestion.yaml
>@@ -136,6 +136,12 @@ properties:
> - "null"
> description: foreign key linking the suggestion to the biblio table after the
> suggestion has been ordered
>+ order_id:
>+ type:
>+ - integer
>+ - "null"
>+ description: foreign key linking the suggestion to the aqorders table after the
>+ suggestion has been ordered
> reason:
> type:
> - string
>diff --git a/api/v1/swagger/paths/acquisitions_orders.yaml b/api/v1/swagger/paths/acquisitions_orders.yaml
>index 260597281da..6e1a1f15550 100644
>--- a/api/v1/swagger/paths/acquisitions_orders.yaml
>+++ b/api/v1/swagger/paths/acquisitions_orders.yaml
>@@ -57,7 +57,6 @@
> - biblio.active_orders+count
> - biblio.holds+count
> - biblio.items+count
>- - biblio.suggestions.suggester
> - creator
> - fund
> - fund.budget
>@@ -66,6 +65,8 @@
> - items
> - items+strings
> - subscription
>+ - suggestions
>+ - suggestions.suggester
> collectionFormat: csv
> responses:
> "200":
>@@ -177,12 +178,13 @@
> - biblio.active_orders+count
> - biblio.holds+count
> - biblio.items+count
>- - biblio.suggestions.suggester
> - fund
> - current_item_level_holds+count
> - invoice
> - items
> - subscription
>+ - suggestion
>+ - suggestion.suggester
> collectionFormat: csv
> produces:
> - application/json
>diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/acqui/basket.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/acqui/basket.tt
>index 129567a290d..5f616411264 100644
>--- a/koha-tmpl/intranet-tmpl/prog/en/modules/acqui/basket.tt
>+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/acqui/basket.tt
>@@ -582,10 +582,12 @@
> [%- IF ( books_loo.publicationyear ) %], [% books_loo.publicationyear | html -%]
> [%- ELSIF ( books_loo.copyrightdate ) %] [% books_loo.copyrightdate | html %][% END -%]
> [%- IF ( books_loo.editionstatement ) %], [% books_loo.editionstatement | html %][% END -%]
>- [%- IF ( books_loo.suggestionid ) %]
>+ [% SET suggestions = books_loo.order_object.suggestions %]
>+ [% FOREACH suggestion IN suggestions %]
> 
>- Suggested by: [% books_loo.surnamesuggestedby | html %][% IF ( books_loo.firstnamesuggestedby ) %],Â [% books_loo.firstnamesuggestedby | html %] [% END %]
>- (<a href="/cgi-bin/koha/suggestion/suggestion.pl?suggestionid=[% books_loo.suggestionid | uri %]&amp;op=show">suggestion #[% books_loo.suggestionid | html %]</a>)
>+ [% SET suggester = suggestion.suggester %]
>+ Suggested by: [% suggester.surname | html %][% IF suggester.firstname %] %], [% suggester.firstname | html %] [% END %]
>+ (<a href="/cgi-bin/koha/suggestion/suggestion.pl?suggestionid=[% suggestion.suggestionid | uri %]&amp;op=show">suggestion #[% suggestion.suggestionid | html %]</a>)
> [% END %]
> 
> [% IF ( books_loo.order_internalnote ) %]
>diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/acqui/orderreceive.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/acqui/orderreceive.tt
>index c20f14bf994..85a70edebb0 100644
>--- a/koha-tmpl/intranet-tmpl/prog/en/modules/acqui/orderreceive.tt
>+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/acqui/orderreceive.tt
>@@ -553,7 +553,7 @@
> $(document).ready(function(){
> // keep a copy for re-rendering
> var $funds_tree = $('#bookfund').html();
>- var base_query = { "order_id": {"in": [[% multiple_orders | html %]]}};
>+ var base_query = { "me.order_id": {"in": [[% multiple_orders | html %]]}};
> var pending_orders_url = "/api/v1/acquisitions/orders?only_active=1";
> var options = {
> "ajax": {
>@@ -561,10 +561,11 @@
> },
> "embed": [
> "basket",
>- "biblio.suggestions.suggester",
>+ "biblio",
> "fund.budget",
> "items+strings",
>- "creator"
>+ "creator",
>+ "suggestions.suggester",
> ],
> 'dom': 'C<"top pager"ilpfB><"#filter_c">tr<"bottom pager"ip>',
> "columns": [
>@@ -693,13 +694,14 @@
> params['ordernumber'] = row.order_id;
> params['booksellerid'] = row.basket.vendor_id;
> 
>- if(row.biblio.suggestions.length && row.biblio.suggestions[0].reason) {
>- params["suggestionid"] = row.biblio.suggestions[0].suggestion_id;
>- if($("#reason option[value='"+row.biblio.suggestions[0].reason+"']").length) {
>- params['reason'] = row.biblio.suggestions[0].reason;
>+ if(row.suggestions && row.suggestions[0].reason) {
>+
>+ params["suggestionid"] = row.suggestions[0].suggestion_id;
>+ if($("#reason option[value='"+row.suggestions[0].reason+"']").length) {
>+ params['reason'] = row.suggestions[0].reason;
> } else {
> params['reason'] = 'other';
>- params['other_reason'] = row.biblio.suggestions[0].reason;
>+ params['other_reason'] = row.suggestions[0].reason;
> }
> }
> params['datereceived'] = row.date_received;
>@@ -837,14 +839,14 @@
> $("#other_reason").show();
> $(this).hide();
> } else {
>- row.biblio.suggestions[0].reason = val;
>+ row.suggestions[0].reason = val;
> }
> });
> 
> $("#order_edit").on("change", "#select-other_reason", function() {
> var val = $(this).val();
> var row = $("#order_edit").data('row');
>- row.biblio.suggestions[0].reason = val;
>+ row.suggestions[0].reason = val;
> });
> 
> $("#order_edit").on("click", "#other_reason a", function() {
>@@ -1132,30 +1134,30 @@
> o.parent().hide();
> }
> });
>- if(row.biblio.suggestions.length) {
>+ if(row.suggestions) {
> $("#suggestion_fieldset").show();
>- if(row.biblio.suggestions[0].suggester) {
>+ if(row.suggestions[0].suggester) {
> $("#biblio_suggestion_suggester").parent().show();
> $("#biblio_suggestion_suggester")
> .html(
>- [row.biblio.suggestions[0].suggester.surname, row.biblio.suggestions[0].suggester.firstname]
>+ [row.suggestions[0].suggester.surname, row.suggestions[0].suggester.firstname]
> .filter(function(name){
> return name
> })
>- .join(', ')+' (<a href="/cgi-bin/koha/suggestion/suggestion.pl?suggestionid='+row.biblio.suggestions[0].suggestion_id+'&op=show">'+SUGGESTION.format(row.biblio.suggestions[0].suggestion_id)+'</a>)'
>+ .join(', ')+' (<a href="/cgi-bin/koha/suggestion/suggestion.pl?suggestionid='+row.suggestions[0].suggestion_id+'&op=show">'+SUGGESTION.format(row.suggestions[0].suggestion_id)+'</a>)'
> );
> } else {
> $("#biblio_suggestion_suggester").parent().hide();
> }
>- if(row.biblio.suggestions[0].reason) {
>+ if(row.suggestions[0].reason) {
> $("#suggestion_reason").show();
>- if($("#reason option[value='"+row.biblio.suggestions[0].reason+"']").length) {
>+ if($("#reason option[value='"+row.suggestions[0].reason+"']").length) {
> $("#other_reason a").click();
>- $("#reason").val(row.biblio.suggestions[0].reason);
>+ $("#reason").val(row.suggestions[0].reason);
> $("#select-other_reason").val(null);
> } else {
> $("#reason").val("other").change();
>- $("#select-other_reason").val(row.biblio.suggestions[0].reason);
>+ $("#select-other_reason").val(row.suggestions[0].reason);
> }
> 
> } else {
>diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/acqui/parcel.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/acqui/parcel.tt
>index c015324c2b2..cc51d95b338 100644
>--- a/koha-tmpl/intranet-tmpl/prog/en/modules/acqui/parcel.tt
>+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/acqui/parcel.tt
>@@ -244,10 +244,13 @@
> [%- ELSIF ( order.copyrightdate > 0) -%] [% order.copyrightdate | html %]
> [% END %]
> [% END %]
>- [% IF ( order.suggestionid ) %]
>- 
>- Suggested by: [% order.surnamesuggestedby | html %][% IF ( order.firstnamesuggestedby ) %],Â [% order.firstnamesuggestedby | html %] [% END %]
>- (<a href="/cgi-bin/koha/suggestion/suggestion.pl?suggestionid=[% order.suggestionid | uri %]&amp;op=show">suggestion #[% order.suggestionid | html %]</a>)
>+
>+ [% SET suggestions = order.order_object.suggestions %]
>+ [% FOREACH suggestion IN suggestions %]
>+ [% SET suggester = suggestion.suggester %]
>+ 
>+ Suggested by: [% suggester.surname | html %][% IF suggester.firstname %] %], [% suggester.firstname | html %] [% END %]
>+ (<a href="/cgi-bin/koha/suggestion/suggestion.pl?suggestionid=[% suggestion.suggestionid | uri %]&amp;op=show">suggestion #[% suggestion.suggestionid | html %]</a>)
> [% END %]
> 
> [% IF ( order.order_internalnote ) %]
>@@ -394,10 +397,10 @@
> "biblio.active_orders+count",
> "biblio.holds+count",
> "biblio.items+count",
>- "biblio.suggestions.suggester",
> "fund",
> "current_item_level_holds+count",
>- "items"
>+ "items",
>+ "suggestions.suggester"
> ],
> "stateSave": true, // remember state on page reload
> "drawCallback": function (settings) {
>@@ -468,27 +471,26 @@
> result += escape_str(row.biblio.copyright_date);
> }
> }
>- var suggestions = row.biblio.suggestions;
>- if ( suggestions != null && suggestions.length > 0 ) {
>- var suggestion = suggestions[0];
>- if ( suggestion.suggester != null ) {
>- var suggester = suggestion.suggester;
>- var suggested_by = [];
>- if ( suggester.surname != null ) {
>- suggested_by.push(escape_str(suggester.surname));
>- }
>- if ( suggester.firstname != null ) {
>- suggested_by.push(escape_str(suggester.firstname));
>- }
>-
>- result += " " + _("Suggested by: ") +
>- '<a href="/cgi-bin/koha/suggestion/suggestion.pl?suggestionid='
>- + encodeURIComponent(suggestion.suggestionid)
>- + '&amp;op=show">'
>- + suggested_by.join(", ")
>- + " (#" + escape_str(suggestions[0].suggestionid) + ")</a>"; // FIXME: could be changed if we allow matching multiple suggestions
>+ let suggestions = row.suggestions;
>+ suggestions.forEach( (suggestion) => {
>+ if ( suggestion && suggestion.suggested_by != null ) {
>+ var suggester = suggestion.suggester;
>+ var suggested_by = [];
>+ if ( suggester.surname != null ) {
>+ suggested_by.push(escape_str(suggester.surname));
>+ }
>+ if ( suggester.firstname != null ) {
>+ suggested_by.push(escape_str(suggester.firstname));
> }
>+
>+ result += " " + _("Suggested by: ") +
>+ '<a href="/cgi-bin/koha/suggestion/suggestion.pl?suggestionid='
>+ + encodeURIComponent(suggestion.suggestion_id)
>+ + '&amp;op=show">'
>+ + suggested_by.join(", ")
>+ + " (#" + escape_str(suggestion.suggestion_id) + ")</a>";
> }
>+ } );
> result += '';
> }
> 
>diff --git a/t/db_dependent/Koha/Acquisition/Order.t b/t/db_dependent/Koha/Acquisition/Order.t
>index 10fdfa46851..cbe2b5e089f 100755
>--- a/t/db_dependent/Koha/Acquisition/Order.t
>+++ b/t/db_dependent/Koha/Acquisition/Order.t
>@@ -19,7 +19,7 @@
> 
> use Modern::Perl;
> 
>-use Test::More tests => 13;
>+use Test::More tests => 14;
> use Test::Exception;
> 
> use t::lib::TestBuilder;
>@@ -210,6 +210,43 @@ subtest 'subscription' => sub {
> $schema->storage->txn_rollback;
> };
> 
>+subtest 'suggestions' => sub {
>+ plan tests => 4;
>+
>+ $schema->storage->txn_begin;
>+ my $o = $builder->build_object(
>+ {
>+ class => 'Koha::Acquisition::Orders',
>+ }
>+ );
>+
>+ my $order = Koha::Acquisition::Orders->find( $o->ordernumber );
>+ is( ref( $order->suggestions ), 'Koha::Suggestions',
>+ '->suggestions should return a Koha::Suggestions object');
>+ is( $order->suggestions->count, 0,
>+ '->suggestions should return empty set if no linked suggestion');
>+
>+ $o = $builder->build_object(
>+ {
>+ class => 'Koha::Acquisition::Orders',
>+ }
>+ );
>+ $o = $builder->build_object(
>+ {
>+ class => 'Koha::Suggestions',
>+ value => { ordernumber => $o->id }
>+ }
>+ );
>+
>+ $order = Koha::Acquisition::Orders->find( $o->ordernumber );
>+ is( ref( $order->suggestions ), 'Koha::Suggestions',
>+ '->suggestions should return a Koha::Suggestions object');
>+ is( $order->suggestions->count, 1,
>+ '->suggestions should return linked suggestions');
>+
>+ $schema->storage->txn_rollback;
>+};
>+
> subtest 'duplicate_to | add_item' => sub {
> plan tests => 3;
> 
>@@ -903,6 +940,18 @@ subtest 'cancel() tests' => sub {
> $item = $builder->build_sample_item;
> $biblio_id = $item->biblionumber;
> 
>+ $order = $builder->build_object(
>+ {
>+ class => 'Koha::Acquisition::Orders',
>+ value => {
>+ orderstatus => 'new',
>+ biblionumber => $biblio_id,
>+ datecancellationprinted => undef,
>+ cancellationreason => undef,
>+ }
>+ }
>+ );
>+
> # Add the suggestion
> my $suggestion = $builder->build_object(
> {
>@@ -912,18 +961,7 @@ subtest 'cancel() tests' => sub {
> suggesteddate => dt_from_string,
> STATUS => 'ORDERED',
> archived => 0,
>- }
>- }
>- );
>-
>- $order = $builder->build_object(
>- {
>- class => 'Koha::Acquisition::Orders',
>- value => {
>- orderstatus => 'new',
>- biblionumber => $biblio_id,
>- datecancellationprinted => undef,
>- cancellationreason => undef,
>+ ordernumber => $order->id,
> }
> }
> );
>-- 
>2.30.2

Actions: View | Diff | Splinter Review

Attachments on bug 35717: 160576 | 160577 | 160578 | 160579 | 160580 | 160581 | 160582 | 160583 | 164834 | 164835 | 164836 | 164837 | 164838 | 164839 | 164840 | 172871 | 172872 | 172873 | 172874 | 172875 | 172876 | 172877 | 172878 | 172899 | 172900 | 172901