Bug 31259

Please post this URL from your instance:

http://staff-client.kohadev.org/cgi-bin/koha/patroncards/create-pdf.pl?batch_id=1&template_id=1&layout_id=5&start_label=1

Include the parameters which cause the loop.

Hi Chris,

This is the URL:
https://support-staff.koha-ptfs.co.uk/cgi-bin/koha/patroncards/create-pdf.pl?batch_id=2&template_id=8&layout_id=9&layout_back_id=9&start_card=1 

Many thanks,
Jake

I had the same problem years ago but fixed it with bug 22429 so must be something else causing the problem now. 

The infinite loop is probably in the "while(1)" block, and it probably relates to whatever data you're feeding in. 

Are you able to replicate this problem using koha-testing-docker?

(In reply to Jake Deery from comment #2)
> Hi Chris,
> 
> This is the URL:
> https://support-staff.koha-ptfs.co.uk/cgi-bin/koha/patroncards/create-pdf.
> pl?batch_id=2&template_id=8&layout_id=9&layout_back_id=9&start_card=1 
> 

Could you post the results of the following query:

SELECT * FROM creator_batches WHERE batch_id=2;

(In reply to Jake Deery from comment #2)
> Hi Chris,
> 
> This is the URL:
> https://support-staff.koha-ptfs.co.uk/cgi-bin/koha/patroncards/create-pdf.
> pl?batch_id=2&template_id=8&layout_id=9&layout_back_id=9&start_card=1 

In addition, try this URL and see if it tight-loops:

https://support-staff.koha-ptfs.co.uk/cgi-bin/koha/patroncards/create-pdf.pl?batch_id=2&template_id=8&layout_id=9&start_card=1

(In reply to David Cook from comment #3)
> I had the same problem years ago but fixed it with bug 22429 so must be
> something else causing the problem now. 
> 
> The infinite loop is probably in the "while(1)" block, and it probably
> relates to whatever data you're feeding in.

This while block is problematic (says the one who coded this mess): it has no out in the case that the main conditional never evaluates true. There may be some fringe cases where the regexp does not match... ever.

Hard to tell without data which causes the infinite looping.

(In reply to Jake Deery from comment #0)
> Hi,
> 
> One of our customers is having an issue with their patron card creator, that
> we have been able to replicate on our support server. Both installations are
> Debian package installations, and both installations run atop Debian 10.
> 
> When one goes to create a 'patron card' using the build-in patron card

Are you using your customer's data? Would it be possible to get a copy of the exact text that is to be put on the card? You can send it directly via email to avoid posting here if needed.

Otherwise if it's sample data, I'll look there.

Hi,

here's an example of what we're trying to do, in field 2 text:

The person whose signature appears on this card accepts responsibility for the appropriate care of all books and materials checked out on this card.

I'll put an attachment of the whole template screen too.

Cheers,
Liz

Created attachment 138917 [details]
screenshot of problem template

(In reply to Liz Rea from comment #8)

Thanks Liz!

To confirm: Removing this text from field two stops the loop from becoming infinite?

> The person whose signature appears on this card accepts responsibility for
> the appropriate care of all books and materials checked out on this card.

It appears to not be infinite when the text doesn't have to wrap.

(In reply to Liz Rea from comment #11)
> It appears to not be infinite when the text doesn't have to wrap.

Sounds like the issue is in the WRAP_LINES block in C4/Patroncards/Patroncard.pm then (like it was for bug 22429).

I don't have time to look at this today, but I could take a look in the next few days/weeks.

Created attachment 145571 [details] [review]
Bug 31259: Escape infinite loop when lime cannot wrap enough

It seems the wrapping here works with words, not characters. If a line is too long,
or too far over, we can't trim it enough. We need to escape if successive loops are
not changing the line

To test:
 1 - Using sample data, edit the layout to match picture in comment 9
 2 - Add some borrowers to a batch
 3 - Attempt to export batch and save PDF
 4 - Staff client waits
 5 - ps aux | grep card
 6 - Note the job keeps running
 7 - Kill it
 8 - Apply patch
 9 - Restart_all
10 - Export batch again
11 - Success, you get a badly formatted PDF, rather than nothing
12 - Note the PDF does not show "Yakama Nation Library"
13 - Edit layout, male "Lower left X" 20 instead of 220
14 - Export again and note text field 1 shows correctly

Comment on attachment 145571 [details] [review]
Bug 31259: Escape infinite loop when lime cannot wrap enough

Review of attachment 145571 [details] [review]:
-----------------------------------------------------------------

I cannot test this, but the logic appears sound, fwiw.

Created attachment 145639 [details] [review]
Bug 31259: Escape infinite loop when lime cannot wrap enough

It seems the wrapping here works with words, not characters. If a line is too long,
or too far over, we can't trim it enough. We need to escape if successive loops are
not changing the line

To test:
 1 - Using sample data, edit the layout to match picture in comment 9
 2 - Add some borrowers to a batch
 3 - Attempt to export batch and save PDF
 4 - Staff client waits
 5 - ps aux | grep card
 6 - Note the job keeps running
 7 - Kill it
 8 - Apply patch
 9 - Restart_all
10 - Export batch again
11 - Success, you get a badly formatted PDF, rather than nothing
12 - Note the PDF does not show "Yakama Nation Library"
13 - Edit layout, male "Lower left X" 20 instead of 220
14 - Export again and note text field 1 shows correctly

Signed-off-by: David Nind <david@davidnind.com>

Testing notes (using koha-testing-docker):

1. Tested on the current master.

2. To kill the processes: kill -9 XXXXX (where XXXXX = the 'pid' number, from the second column).

3. I didn't setup the layout to match 100%, but can confirm the issue occurred and the patch fixed things so the PDF was created.

Created attachment 148224 [details] [review]
Bug 31259: Escape infinite loop when lime cannot wrap enough

It seems the wrapping here works with words, not characters. If a line is too long,
or too far over, we can't trim it enough. We need to escape if successive loops are
not changing the line

To test:
 1 - Using sample data, edit the layout to match picture in comment 9
 2 - Add some borrowers to a batch
 3 - Attempt to export batch and save PDF
 4 - Staff client waits
 5 - ps aux | grep card
 6 - Note the job keeps running
 7 - Kill it
 8 - Apply patch
 9 - Restart_all
10 - Export batch again
11 - Success, you get a badly formatted PDF, rather than nothing
12 - Note the PDF does not show "Yakama Nation Library"
13 - Edit layout, male "Lower left X" 20 instead of 220
14 - Export again and note text field 1 shows correctly

Signed-off-by: David Nind <david@davidnind.com>
Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>

Nice fix, thanks Nick.

All tested and working here.. QA scripts happy.

I decided to let the lack of Unit test pass here as it's an important fix and the unit tests are already rather bare here.

Passing QA

Pushed to master for 23.05.

Nice work everyone, thanks!

Nice work, thanks everyone!

Pushed to 22.11.x for the next release.

Backported to 22.05.x for upcoming 22.05.12

applied to 21.11.x for 21.11.20