misc/release_notes/release_notes_21_05_06.md

   1 # RELEASE NOTES FOR KOHA 21.05.06
   2 24 Nov 2021
   3
   4 Koha is the first free and open source software library automation
   5 package (ILS). Development is sponsored by libraries of varying types
   6 and sizes, volunteers, and support companies from around the world. The
   7 website for the Koha project is:
   8
   9 - [Koha Community](http://koha-community.org)
  10
  11 Koha 21.05.06 can be downloaded from:
  12
  13 - [Download](http://download.koha-community.org/koha-21.05.06.tar.gz)
  14
  15 Installation instructions can be found at:
  16
  17 - [Koha Wiki](http://wiki.koha-community.org/wiki/Installation_Documentation)
  18 - OR in the INSTALL files that come in the tarball
  19
  20 Koha 21.05.06 is a bugfix/maintenance release.
  21
  22 It includes 3 enhancements, 63 bugfixes.
  23
  24 ### System requirements
  25
  26 You can learn about the system components (like OS and database) needed for running Koha here: https://wiki.koha-community.org/wiki/System_requirements_and_recommendations
  27
  28
  29
  30
  31 ## Enhancements
  32
  33 ### Plugin architecture
  34
  35 - [[27173]](http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=27173) Add plugin hooks for authority record changes
  36
  37   >This enhancement allows plugin authors to implement an `after_authority_action` method in order to act upon authority create, modify and delete.
  38 - [[28474]](http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=28474) Pass process_message_queue.pl params to before_send_messages plugin hooks
  39
  40   >This enhancement passes the parameters received by process_message_queue.pl through to the before_send_messages plugin calls. This allows plugins to respect calls that should only affect certain letter codes etc.
  41
  42 ### REST API
  43
  44 - [[17314]](http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=17314) Routes to create, list and delete a purchase suggestion
  45
  46
  47 ## Critical bugs fixed
  48
  49 ### Acquisitions
  50
  51 - [[14999]](http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=14999) Adding to basket orders from staged files mixes up the prices between different orders
  52 - [[29283]](http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=29283) Cannot delete basket with cancelled order for deleted biblio
  53
  54 ### Architecture, internals, and plumbing
  55
  56 - [[26374]](http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=26374) Update for 19974 is not idempotent
  57 - [[29330]](http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=29330) Koha cannot send emails with attachments using Koha::Email and message_queue table
  58 - [[29386]](http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=29386) background jobs table data field is a TEXT which is too small
  59
  60 ### Circulation
  61
  62 - [[29255]](http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=29255) Built-in offline circulation broken with SQL error
  63
  64 ### Command-line Utilities
  65
  66 - [[28994]](http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=28994) Make writeoff_debts.pl use amountoutstanding, not amount
  67
  68 ### Notices
  69
  70 - [[28803]](http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=28803) process_message_queue.pl dies if any messsages in the message queue contain an invalid to_address
  71 - [[29223]](http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=29223) Auto-renewals can fail when not digested per branch and patron requests digest
  72
  73 ### OPAC
  74
  75 - [[28870]](http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=28870) Cart shipping fails because of Non-ASCII characters in display-name of reply-to address
  76 - [[29318]](http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=29318) OverDrive search page should not require edit_borrowers permission
  77 - [[29416]](http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=29416) Regression: information from existing bib no longer populating on suggest for purchase
  78
  79   >This restores the behaviour for purchase suggestions for an existing title, so that the suggestion form is pre-filled with the details from the existing record.
  80
  81 ### Patrons
  82
  83 - [[29341]](http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=29341) If OpacRenewalBranch = opacrenew, pseudonymization process leads to "internal server error" when patrons renew the loans at OPAC
  84 - [[29524]](http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=29524) Cannot set a new value for privacy_guarantor_checkouts in memberentry.pl
  85
  86 ### REST API
  87
  88 - [[28585]](http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=28585) Cannot search on date fields
  89
  90   >This patch fixes the date handling for query parsing from the API.  We use dt_from_string to convert out RFC3339 formatted date strings to DateTime objects with an associated timezone and then user the native datetime formatted provided by the SQL connection library to convert to an appropriately formated date time string.
  91 - [[29272]](http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=29272) API not respecting $category->effective_change_password
  92
  93 ### Reports
  94
  95 - [[29204]](http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=29204) Error 500 when execute Circulation report with date period
  96
  97 ### SIP2
  98
  99 - [[26871]](http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=26871) L1 cache still too long in SIP Server
 100
 101   >This fixes SIP connections so that when system preference and configuration changes are made (for example: enabling or disabling logging of issues and returns) they are picked up automatically with the next message, rather than requiring the SIP connection to be closed and reopened.
 102   >
 103   >SIP connections typically tend to be long lived - weeks if not months. Basically the connection per SIP machine is initiated once when the SIP machine boots and then never closed until maintenance is required. Therefore we need to reset Koha's caches on every SIP request to get the latest system preference and configuration changes from the memcached cache that is shared between all the Koha programs (staff interface, OPAC, SIP, cronjobs, etc).
 104 - [[29264]](http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=29264) SIP config allows use of non-branchcode institution ids causes workers to die without responding
 105
 106   >This adds a warning to the logs where a SIP login uses an institution id that is *not* a valid library code.
 107   >
 108   >If a SIP login uses an institution with an id that doesn't match a valid branchcode, everything will appear to work, but the SIP worker will die anywhere that Koha gets the branch from the userenv and assumes it is valid.
 109   >
 110   >The repercussions of this are that actions such as the checkout message simply die and do not return a response message to the requestor.
 111
 112 ### Searching
 113
 114 - [[29152]](http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=29152) Change to default search behavior when limiting by branch
 115
 116 ### Searching - Elasticsearch
 117
 118 - [[29284]](http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=29284) Koha dies when an analytics search fails in Elasticsearch
 119
 120 ### Staff Client
 121
 122 - [[28573]](http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=28573) Replace authority record with Z39.50/SRU creates new authority record
 123
 124 ### System Administration
 125
 126 - [[28729]](http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=28729) Return-path header not set in emails
 127
 128
 129 ## Other bugs fixed
 130
 131 ### About
 132
 133 - [[28904]](http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=28904) Update information on Newsletter editor on about page
 134 - [[29123]](http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=29123) Add Dataly Tech to About page
 135 - [[29300]](http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=29300) Release team 22.05
 136
 137 ### Acquisitions
 138
 139 - [[27708]](http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=27708) Cannot create EDI order if AcqCreateItem value is not "placing an order"
 140 - [[28627]](http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=28627) Revert the order receive page to display 'Actual cost' as ecost_tax_included/ecost_tax_excluded if unitprice not set
 141
 142 ### Architecture, internals, and plumbing
 143
 144 - [[29218]](http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=29218) "hidden" class is not working for DT if column visibility button is used
 145 - [[29321]](http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=29321) Remove a last without loop context
 146 - [[29350]](http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=29350) TT method 'delete' don't need to be escaped
 147 - [[29408]](http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=29408) The datatables api wrapper is ambiguously named
 148
 149   >This patch 1) renames the Koha REST JS dataTables wrapper from the
 150   >ambiguous 'api' to the clearer 'kohaTable' 2) goes through the codebase and updates existing relevant calls to .api referencing the Koha REST dataTables wrapper to use the name 'kohaTable', and 3) adds JSDoc formatted parameter documentation for the kohaTable function.
 151
 152 ### Cataloging
 153
 154 - [[29319]](http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=29319) Errors when doing a cataloging search which starts with a number + letter
 155
 156   >This fixes an error that occurs in cataloging search when entering a search term with ten characters (like "7th Heaven" or "2nd editio") - Koha thinks you are entering an ISBN10 number, gets confused and delivers an error page. Searching now works as expected for ISBN13/ISBN10 (without the '-'s), title and author searches.
 157 - [[29437]](http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=29437) 500 error when performing a catalog search for an ISBN13 with no valid ISBN10
 158
 159 ### Fines and fees
 160
 161 - [[29309]](http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=29309) 'Pay all fines' should be 'Pay all charges'
 162
 163 ### Label/patron card printing
 164
 165 - [[25459]](http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=25459) In patron cards layout, barcode position doesn't respect units
 166
 167 ### Notices
 168
 169 - [[29460]](http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=29460) Typo 'pendin    g approval'
 170
 171 ### OPAC
 172
 173 - [[28768]](http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=28768) OPAC reading history page (opac-readingrecord.pl) wont display news items
 174 - [[28901]](http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=28901) showCart incorrectly calculates position if content above navbar
 175 - [[28910]](http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=28910) Correct eslint errors in OPAC basket.js
 176 - [[29329]](http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=29329) stray "s" in opac-detail
 177
 178 ### Patrons
 179
 180 - [[27145]](http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=27145) Patron deletion via intranet doesn't handle exceptions well
 181 - [[28973]](http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=28973) Improve Koha::Patron::can_see_patron_infos efficiency
 182 - [[29213]](http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=29213) Typo ol in member-alt-contact-style.inc
 183 - [[29227]](http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=29227) Patron messaging preferences digest show as editable but are not
 184
 185 ### REST API
 186
 187 - [[28613]](http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=28613) Several objects.search-based routes missing parameters
 188 - [[29405]](http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=29405) The patron spec for date_renewed is missing it's format definition
 189
 190   >This fix adds the date format string to the date_renewed field. This is to ensure that the date_renewed field can be correctly validated.
 191
 192 ### Reports
 193
 194 - [[27884]](http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=27884) Add HTML mail support for patron emailer script
 195 - [[29328]](http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=29328) Add missing list parameter to reports parameter menu
 196 - [[29352]](http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=29352) Runtime parameter labels should not be said to be optional
 197
 198 ### SIP2
 199
 200 - [[29452]](http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=29452) Unnecessary warns in sip logs
 201
 202 ### Searching
 203
 204 - [[28365]](http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=28365) (Bug 19873 follow-up) Make it possible to search on value 0
 205 - [[28847]](http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=28847) Branch limits while searching should be expanded in query building and not in CGI
 206
 207 ### Staff Client
 208
 209 - [[28913]](http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=28913) Automatic checkin setting in item type setup should note required cronjob
 210 - [[29195]](http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=29195) Highlighting broken on odd rows in circ-patron-search-results
 211
 212 ### System Administration
 213
 214 - [[29075]](http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=29075) OPAC info should not be displayed in libraries table
 215 - [[29456]](http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=29456) "Auto renewal" and "Hold reminder" notice shown as "unknown" on the patron category list view
 216
 217 ### Templates
 218
 219 - [[29286]](http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=29286) Typo: Librarien will need the manage_auth_values subpermission.
 220
 221 ### Test Suite
 222
 223 - [[29306]](http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=29306) Holds.t: Fix Use of uninitialized value $_ in concatenation (.) or string
 224 - [[29315]](http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=29315) Remove warnings from Search.t
 225 - [[29363]](http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=29363) TestBuilder.t failing if biblionumber=123 does not exist
 226 - [[29364]](http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=29364) Search.t not reverting changes made to the framework
 227
 228 ### Web services
 229
 230 - [[21105]](http://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=21105) oai.pl returns invalid earliestDatestamp
 231
 232   **Sponsored by** *Reformational Study Centre*
 233
 234   >This fixes the date format in OAI-PMH for Identify.earliestDatestamp so that it uses "YYYY-MM-DDThh:mm:ssZ" and is in UTC, instead of the SQL formsat "YYYY-MM-DD hh:mm:ss" currently used. For OAI-PMH all date and time values must be in the format "YYYY-MM-DDThh:mm:ssZ" and in UTC.
 235
 236
 237
 238 ## Documentation
 239
 240 The Koha manual is maintained in Sphinx. The home page for Koha
 241 documentation is
 242
 243 - [Koha Documentation](http://koha-community.org/documentation/)
 244
 245 As of the date of these release notes, the Koha manual is available in the following languages:
 246
 247
 248 - [Arabic](https://koha-community.org/manual/21.05/ar/html/) (34.3%)
 249 - [Chinese (Taiwan)](https://koha-community.org/manual/21.05/zh_TW/html/) (58.7%)
 250 - [Czech](https://koha-community.org/manual/21.05/cs/html/) (27.6%)
 251 - [English (USA)](https://koha-community.org/manual/21.05/en/html/)
 252 - [French](https://koha-community.org/manual/21.05/fr/html/) (51.8%)
 253 - [French (Canada)](https://koha-community.org/manual/21.05/fr_CA/html/) (25.2%)
 254 - [German](https://koha-community.org/manual/21.05/de/html/) (73.5%)
 255 - [Hindi](https://koha-community.org/manual/21.05/hi/html/) (100%)
 256 - [Italian](https://koha-community.org/manual/21.05/it/html/) (48.1%)
 257 - [Spanish](https://koha-community.org/manual/21.05/es/html/) (34.8%)
 258 - [Turkish](https://koha-community.org/manual/21.05/tr/html/) (40.3%)
 259
 260 The Git repository for the Koha manual can be found at
 261
 262 - [Koha Git Repository](https://gitlab.com/koha-community/koha-manual)
 263
 264
 265 ## Translations
 266
 267 Complete or near-complete translations of the OPAC and staff
 268 interface are available in this release for the following languages:
 269
 270 - Arabic (90%)
 271 - Armenian (100%)
 272 - Armenian (Classical) (89%)
 273 - Chinese (Taiwan) (82.3%)
 274 - Czech (71.4%)
 275 - English (New Zealand) (61.5%)
 276 - English (USA)
 277 - Finnish (82.6%)
 278 - French (91.9%)
 279 - French (Canada) (87.6%)
 280 - German (100%)
 281 - German (Switzerland) (60.8%)
 282 - Greek (55%)
 283 - Hindi (100%)
 284 - Italian (93.5%)
 285 - Nederlands-Nederland (Dutch-The Netherlands) (61.7%)
 286 - Norwegian Bokmål (65.9%)
 287 - Polish (100%)
 288 - Portuguese (91.4%)
 289 - Portuguese (Brazil) (87.2%)
 290 - Russian (86.7%)
 291 - Slovak (72.8%)
 292 - Spanish (96.3%)
 293 - Swedish (77.1%)
 294 - Telugu (99.8%)
 295 - Turkish (99.8%)
 296 - Ukrainian (68.3%)
 297
 298 Partial translations are available for various other languages.
 299
 300 The Koha team welcomes additional translations; please see
 301
 302 - [Koha Translation Info](http://wiki.koha-community.org/wiki/Translating_Koha)
 303
 304 For information about translating Koha, and join the koha-translate
 305 list to volunteer:
 306
 307 - [Koha Translate List](http://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-translate)
 308
 309 The most up-to-date translations can be found at:
 310
 311 - [Koha Translation](http://translate.koha-community.org/)
 312
 313 ## Release Team
 314
 315 The release team for Koha 21.05.06 is
 316
 317
 318 - Release Manager: Jonathan Druart
 319
 320 - Release Manager assistants:
 321   - Martin Renvoize
 322   - Tomás Cohen Arazi
 323
 324 - QA Manager: Katrin Fischer
 325
 326 - QA Team:
 327   - Agustín Moyano
 328   - Andrew Nugged
 329   - David Cook
 330   - Joonas Kylmälä
 331   - Julian Maurice
 332   - Kyle M Hall
 333   - Marcel de Rooy
 334   - Martin Renvoize
 335   - Nick Clemens
 336   - Petro Vashchuk
 337   - Tomás Cohen Arazi
 338   - Victor Grousset
 339
 340 - Topic Experts:
 341   - UI Design -- Owen Leonard
 342   - REST API -- Tomás Cohen Arazi
 343   - Elasticsearch -- Fridolin Somers
 344   - Zebra -- Fridolin Somers
 345   - Accounts -- Martin Renvoize
 346
 347 - Bug Wranglers:
 348   - Sally Healey
 349
 350 - Packaging Manager:
 351
 352
 353 - Documentation Manager: David Nind
 354
 355
 356 - Documentation Team:
 357   - David Nind
 358   - Lucy Vaux-Harvey
 359
 360 - Translation Managers:
 361   - Bernardo González Kriegel
 362
 363 - Wiki curators:
 364   - Thomas Dukleth
 365
 366 - Release Maintainers:
 367   - 21.05 -- Kyle M Hall
 368   - 20.11 -- Fridolin Somers
 369   - 20.05 -- Victor Grousset
 370   - 19.11 -- Wainui Witika-Park
 371
 372 - Release Maintainer assistants:
 373   - 21.05 -- Nick Clemens
 374
 375 - Release Maintainer mentors:
 376   - 19.11 -- Aleisha Amohia
 377
 378 ## Credits
 379 We thank the following libraries, companies, and other institutions who are known to have sponsored
 380 new features in Koha 21.05.06
 381
 382 - Reformational Study Centre
 383
 384 We thank the following individuals who contributed patches to Koha 21.05.06
 385
 386 - Tomás Cohen Arazi (22)
 387 - Jérémy Breuillard (1)
 388 - Rudolf Byker (1)
 389 - Nick Clemens (21)
 390 - Christophe Croullebois (1)
 391 - Jonathan Druart (19)
 392 - Magnus Enger (1)
 393 - Katrin Fischer (2)
 394 - Andrew Fuerste-Henry (1)
 395 - Lucas Gass (3)
 396 - David Gustafsson (2)
 397 - Kyle M Hall (15)
 398 - Mason James (1)
 399 - Joonas Kylmälä (5)
 400 - Owen Leonard (7)
 401 - Martin Renvoize (16)
 402 - Marcel de Rooy (8)
 403 - Andreas Roussos (1)
 404 - Maryse Simard (1)
 405 - Fridolin Somers (3)
 406 - Koha translators (1)
 407 - Petro Vashchuk (1)
 408 - George Veranis (1)
 409
 410 We thank the following libraries, companies, and other institutions who contributed
 411 patches to Koha 21.05.06
 412
 413 - Athens County Public Libraries (7)
 414 - BibLibre (5)
 415 - Bibliotheksservice-Zentrum Baden-Württemberg (BSZ) (2)
 416 - ByWater-Solutions (40)
 417 - Dataly Tech (2)
 418 - Independant Individuals (9)
 419 - Koha Community Developers (19)
 420 - KohaAloha (1)
 421 - Libriotech (1)
 422 - PTFS-Europe (16)
 423 - Rijksmuseum (8)
 424 - Solutions inLibro inc (1)
 425 - Theke Solutions (22)
 426
 427 We also especially thank the following individuals who tested patches
 428 for Koha
 429
 430 - Tomás Cohen Arazi (9)
 431 - Nick Clemens (9)
 432 - Jonathan Druart (90)
 433 - Katrin Fischer (19)
 434 - Andrew Fuerste-Henry (10)
 435 - Lucas Gass (1)
 436 - Victor Grousset (2)
 437 - Kyle M Hall (126)
 438 - Andrew Isherwood (1)
 439 - Barbara Johnson (1)
 440 - Joonas Kylmälä (19)
 441 - Owen Leonard (3)
 442 - Kelly McElligott (1)
 443 - David Nind (32)
 444 - Eric Phetteplace (1)
 445 - Martin Renvoize (43)
 446 - Marcel de Rooy (13)
 447 - Emmi Takkinen (1)
 448 - Petro Vashchuk (1)
 449 - George Veranis (1)
 450
 451
 452
 453 We regret any omissions.  If a contributor has been inadvertently missed,
 454 please send a patch against these release notes to koha-devel@lists.koha-community.org.
 455
 456 ## Revision control notes
 457
 458 The Koha project uses Git for version control.  The current development
 459 version of Koha can be retrieved by checking out the master branch of:
 460
 461 - [Koha Git Repository](https://git.koha-community.org/koha-community/koha)
 462
 463 The branch for this version of Koha and future bugfixes in this release
 464 line is 21.05.x.
 465
 466 ## Bugs and feature requests
 467
 468 Bug reports and feature requests can be filed at the Koha bug
 469 tracker at:
 470
 471 - [Koha Bugzilla](http://bugs.koha-community.org)
 472
 473 He rau ringa e oti ai.
 474 (Many hands finish the work)
 475
 476 Autogenerated release notes updated last on 24 Nov 2021 19:32:31.