Difference between revisions of "EPrints 3.4.7"
(→General Improvements) |
m (→Session Initialisation and Close Bespoke Configuration) |
||
(17 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
− | + | {{releasenotes}} | |
− | == Release Notes | + | This page contains information about the EPrints v3.4.7 tag and release on GitHub. |
− | EPrints 3.4.7 | + | |
+ | == Release Notes == | ||
+ | EPrints 3.4.7 is now available on [https://github.com/eprints/eprints3.4/releases/tag/v3.4.7 GitHub]. | ||
* '''Zero codename:''' ''Granita Gregale'' | * '''Zero codename:''' ''Granita Gregale'' | ||
* '''Publications flavour codename:''' ''Tiramisu Tramontane'' | * '''Publications flavour codename:''' ''Tiramisu Tramontane'' | ||
Line 8: | Line 10: | ||
=== New Dependencies === | === New Dependencies === | ||
Check earlier dependencies for [[EPrints 3.4.6]] and before. | Check earlier dependencies for [[EPrints 3.4.6]] and before. | ||
+ | |||
+ | === Upgrade Considerations === | ||
+ | * If you are upgrading from an earlier version of EPrints 3.4.x and have the the [https://github.com/eprints/metatags metatags] ingredient enabled, as well as disabling this by removing it from your flavour's inc file, if your archive has its own '''cfg/cfg.d/eprint_render.pl''' file, you will need to make sure that the following lines are added to it after similar lines for <code>Export::Simple</code> and <code>Export::DC</code>: | ||
+ | $links->appendChild( $repository->plugin( "Export::HighwirePress" )->dataobj_to_html_header( $eprint ) ); | ||
+ | $links->appendChild( $repository->plugin( "Export::Prism" )->dataobj_to_html_header( $eprint ) ); | ||
=== Changes Since 3.4.6 === | === Changes Since 3.4.6 === | ||
Line 16: | Line 23: | ||
* [https://github.com/eprints/eprints3.4/pull/434 Implements missing triggers <code>EP_TRIGGER_BEGIN</code> and <code>EP_TRIGGER_END</code>] | * [https://github.com/eprints/eprints3.4/pull/434 Implements missing triggers <code>EP_TRIGGER_BEGIN</code> and <code>EP_TRIGGER_END</code>] | ||
* Allows [https://github.com/eprints/eprints3.4/issues/445 browse view variation ordering by number] | * Allows [https://github.com/eprints/eprints3.4/issues/445 browse view variation ordering by number] | ||
− | * Adds [https://github.com/eprints/eprints3.4/pull/450 | + | * Adds [https://github.com/eprints/eprints3.4/pull/450 citation cache management script] |
* [https://github.com/eprints/eprints3.4/issues/456 Allows static pages to be put behind login (with exceptions)] | * [https://github.com/eprints/eprints3.4/issues/456 Allows static pages to be put behind login (with exceptions)] | ||
* [https://github.com/eprints/eprints3.4/pull/462 Allows custom sort to be applied at a browse menu level] | * [https://github.com/eprints/eprints3.4/pull/462 Allows custom sort to be applied at a browse menu level] | ||
Line 23: | Line 30: | ||
==== Security and Privacy Improvements ==== | ==== Security and Privacy Improvements ==== | ||
* [https://github.com/eprints/eprints3.4/pull/429 Fixes vulnerability in PrototypeJS] | * [https://github.com/eprints/eprints3.4/pull/429 Fixes vulnerability in PrototypeJS] | ||
− | * [https://github.com/eprints/eprints3.4/issues/465 | + | * [https://github.com/eprints/eprints3.4/issues/465 Uses different identifier for recalling search result caches so it cannot be guessed] |
+ | * [https://github.com/eprints/eprints3.4/issues/502 Ups to latest versions of jQuery and JQuery UI available in jquery ingredient] | ||
==== General Improvements ==== | ==== General Improvements ==== | ||
Line 36: | Line 44: | ||
* [https://github.com/eprints/eprints3.4/pull/460 Prevents 'Manage Deposits' taking a long time to load with a lot of items] | * [https://github.com/eprints/eprints3.4/pull/460 Prevents 'Manage Deposits' taking a long time to load with a lot of items] | ||
* [https://github.com/eprints/eprints3.4/issues/463 Removes references to <code>secure.xml</code> template and <code>secure_auto.js</code>] | * [https://github.com/eprints/eprints3.4/issues/463 Removes references to <code>secure.xml</code> template and <code>secure_auto.js</code>] | ||
− | * Adds place as a related_url type | + | * Adds place as a <code>related_url</code> type |
− | * [https://github.com/eprints/eprints3.4/pull/482/ Tides up use of <code>get_citaiton_id</code | + | * [https://github.com/eprints/eprints3.4/pull/482/ Tides up use of <code>get_citaiton_id</code> in search screens] |
* [https://github.com/eprints/eprints3.4/issues/475 Allows any item that has ever been in the live archive to be retired] | * [https://github.com/eprints/eprints3.4/issues/475 Allows any item that has ever been in the live archive to be retired] | ||
* [https://github.com/eprints/eprints3.4/issues/486 Allows <code>EPrints::Document</code> <code>search_related</code> to be ordered and limited to reduce number of cache tables generated] | * [https://github.com/eprints/eprints3.4/issues/486 Allows <code>EPrints::Document</code> <code>search_related</code> to be ordered and limited to reduce number of cache tables generated] | ||
* [https://github.com/eprints/eprints3.4/issues/476 Allows placeholder to be optionally displayed for un-named subjects in browse views] | * [https://github.com/eprints/eprints3.4/issues/476 Allows placeholder to be optionally displayed for un-named subjects in browse views] | ||
* [https://github.com/eprints/eprints3.4/issues/479 Supports disabling of auto re-searching of cache ID for search has expired] | * [https://github.com/eprints/eprints3.4/issues/479 Supports disabling of auto re-searching of cache ID for search has expired] | ||
+ | * [https://github.com/eprints/eprints3.4/issues/492 Supports plugins exporting as attachment rather that in-browser] | ||
+ | * [https://github.com/eprints/eprints3.4/pull/493 Adds 'export_file_as_attachment' option to force exports to be downloaded] | ||
+ | * [https://github.com/eprints/eprints3.4/pull/500 Add view option to suppress 'feeds'] | ||
==== Bug Fixes ==== | ==== Bug Fixes ==== | ||
− | * Fixes [https://github.com/eprints/eprints3.4/issues/399 generate_apacheconf has issues if archive missing cfg/static/javascript/auto/] | + | * Fixes [https://github.com/eprints/eprints3.4/issues/399 <code>generate_apacheconf</code> has issues if archive missing <code>cfg/static/javascript/auto/</code>] |
− | * Fixes [https://github.com/eprints/eprints3.4/issues/415 Boolean field has inconsistent phrase names] | + | * Fixes [https://github.com/eprints/eprints3.4/issues/415 <code>Boolean</code> field has inconsistent phrase names] |
* Fixes [https://github.com/eprints/eprints3.4/issues/418<code>tools/epm</code>'s <code>link_lib</code> and <code>unlink_lib</code> command so they only remove files referenced in the EPM directory's <code>.epm</code> / <code>.epmi</code> file] | * Fixes [https://github.com/eprints/eprints3.4/issues/418<code>tools/epm</code>'s <code>link_lib</code> and <code>unlink_lib</code> command so they only remove files referenced in the EPM directory's <code>.epm</code> / <code>.epmi</code> file] | ||
− | * Fixes [https://github.com/eprints/eprints3.4/issues/420 UX/Accessibility issue with Import plugin actions] | + | * Fixes [https://github.com/eprints/eprints3.4/issues/420 UX/Accessibility issue with <code>Import</code> plugin actions] |
* Fixes [https://github.com/eprints/eprints3.4/issues/421 History records not retaining formatting of email reasons] | * Fixes [https://github.com/eprints/eprints3.4/issues/421 History records not retaining formatting of email reasons] | ||
* Fixes [https://github.com/eprints/eprints3.4/issues/422 disabling an EPM removes database tables and fields (and counters) it added to an archive] | * Fixes [https://github.com/eprints/eprints3.4/issues/422 disabling an EPM removes database tables and fields (and counters) it added to an archive] | ||
Line 62: | Line 73: | ||
* Fixes [https://github.com/eprints/eprints3.4/issues/452 <code>EPrints::Plugin::Search::Xapian->_get_records</code> cannot handle 0 results] | * Fixes [https://github.com/eprints/eprints3.4/issues/452 <code>EPrints::Plugin::Search::Xapian->_get_records</code> cannot handle 0 results] | ||
* Fixes [https://github.com/eprints/eprints3.4/issues/453 issues with ReCAPTCHAv3 form being able to submit] | * Fixes [https://github.com/eprints/eprints3.4/issues/453 issues with ReCAPTCHAv3 form being able to submit] | ||
− | * Fixes [https://github.com/eprints/eprints3.4/issues/455 login_required_for_X functionality not be able to redirect user to a specific page after login] | + | * Fixes [https://github.com/eprints/eprints3.4/issues/455 <code>login_required_for_X</code> functionality not be able to redirect user to a specific page after login] |
* [https://github.com/eprints/eprints3.4/pull/444 Fixes aspect ratio for video thumbnails if rotation matrix used] | * [https://github.com/eprints/eprints3.4/pull/444 Fixes aspect ratio for video thumbnails if rotation matrix used] | ||
* [https://github.com/eprints/eprints3.4/issues/457 Only crypt passwords that only contain printable ASCII] | * [https://github.com/eprints/eprints3.4/issues/457 Only crypt passwords that only contain printable ASCII] | ||
− | * [https://github.com/eprints/eprints3.4/issues/458 | + | * [https://github.com/eprints/eprints3.4/issues/458 Prevents other sub-field default occasionally be using for another compound field sub-field] |
* [https://github.com/eprints/eprints3.4/pull/468 Fixes lightbox popup preview of a video] | * [https://github.com/eprints/eprints3.4/pull/468 Fixes lightbox popup preview of a video] | ||
− | * Fixes [https://github.com/eprints/eprints3.4/issues/470 Subobject to_sax causes 500 error if there are multiple and subobject is null] | + | * Fixes [https://github.com/eprints/eprints3.4/issues/470 Subobject <code>to_sax</code> causes 500 error if there are multiple and subobject is null] |
− | * [https://github.com/eprints/eprints3.4/issues/470 Sets more sensible maxlength default for MetaFields that are SQL_CLOB to avoid truncation] | + | * [https://github.com/eprints/eprints3.4/issues/470 Sets more sensible <code>maxlength</code> default for MetaFields that are <code>SQL_CLOB</code> to avoid truncation] |
− | * Ensures depositable should be | + | * Ensures depositable should be <code>TRUE</code> not <code>1</code> on initial subject creation through <code>Edit::Subject</code> |
* Fixes [https://github.com/eprints/eprints3.4/issues/472 HTML citation export fails if export citation style for eprint exists] | * Fixes [https://github.com/eprints/eprints3.4/issues/472 HTML citation export fails if export citation style for eprint exists] | ||
* Ensures output from get_custom_view_header user-defined function can appear before or after the browse view navigation bar | * Ensures output from get_custom_view_header user-defined function can appear before or after the browse view navigation bar | ||
− | * Removes no longer support | + | * Removes no longer support <code>use encoding...</code> from random data generator |
* [https://github.com/eprints/eprints3.4/pull/480 Makes 'Move' positions unique] | * [https://github.com/eprints/eprints3.4/pull/480 Makes 'Move' positions unique] | ||
− | * [https://github.com/eprints/eprints3.4/pull/485 Retains attribute order in build_attributes] | + | * [https://github.com/eprints/eprints3.4/pull/485 Retains attribute order in <code>build_attributes</code>] |
* Fixes [https://github.com/eprints/eprints3.4/issues/459 Horizontal scrollbar when zoomed to 400%] | * Fixes [https://github.com/eprints/eprints3.4/issues/459 Horizontal scrollbar when zoomed to 400%] | ||
* Fixes [https://github.com/eprints/eprints3.4/issues/469 default values for search get re-enabled if field left empty] | * Fixes [https://github.com/eprints/eprints3.4/issues/469 default values for search get re-enabled if field left empty] | ||
Line 80: | Line 91: | ||
* [https://github.com/eprints/eprints3.4/issues/474 Adds cgi/register to accessibility check] | * [https://github.com/eprints/eprints3.4/issues/474 Adds cgi/register to accessibility check] | ||
* Fixes logic support complex page ranges (e.g. A-2-B-4) | * Fixes logic support complex page ranges (e.g. A-2-B-4) | ||
+ | * Removes <code>rev_number</code> from eprints in test import data to prevent missing revisions when imported. | ||
+ | * Fixes [https://github.com/eprints/eprints3.4/issues/60 issues when splitting complex page ranges originally implemented for 3.4.2] | ||
+ | * Fixes [https://github.com/eprints/eprints3.4/issues/479 historic cache param causing excessive new cache tables] | ||
+ | * Removes eprint rev_number from test data this cause odd behaviour when importing | ||
+ | * [https://github.com/eprints/eprints3.4/pull/495 Prevents double presses on search buttons sending multiple requests] | ||
+ | |||
+ | == Known Issues == | ||
+ | === Session Initialisation and Close Bespoke Configuration === | ||
+ | EPrints 3.4.7 replaces <code>$c->{session_init}</code> and <code>$c->{session_close}</code> configuration in '''lib/cfg.d/session.pl''' with <code>EP_TRIGGER_BEGIN</code> and <code>EP_TRIGGER_END</code> triggers. Although uncommon, if you have modified <code>session_init</code> in a later configuration file than session.pl and your session_init function requires the <code>EPrints::Repository</code>'s <code>offline</code> parameter then will not be sent to the function. Similarly, if you have modified the <code>session_close</code> function and this requires and <code>EPrints::Repository</code> object as a parameter, this will not be sent. These can be fixed with '''[https://github.com/eprints/eprints3.4/commit/cff8a57e643c230215279f187764fa6ec8d00a99.patch this patch]'''. | ||
+ | |||
+ | == Further Planned Features and Improvements == | ||
+ | See [https://github.com/eprints/eprints3.4/milestone/9 3.4.8 milestone on GitHub] for more details. | ||
[[Category:Eprints3.4]] | [[Category:Eprints3.4]] | ||
− | [[Category: | + | [[Category:Releases]] |
Revision as of 11:08, 2 September 2025
Release Notes
3.4 | 3.4.1 | 3.4.2 | 3.4.3 | 3.4.4 | 3.4.5 | 3.4.6 | 3.4.7
3.3 | 3.3.5 | 3.3.6 | 3.3.7 | 3.3.8 | 3.3.9 | 3.3.10 | 3.3.11 | 3.3.13 | 3.3.14 | 3.3.15 | 3.3.16
3.2.0 | 3.2.1 | 3.2.2 | 3.2.3 | 3.2.4 | 3.2.5 | 3.2.6 | 3.2.7 | 3.2.8 | 3.2.9
This page contains information about the EPrints v3.4.7 tag and release on GitHub.
Release Notes
EPrints 3.4.7 is now available on GitHub.
- Zero codename: Granita Gregale
- Publications flavour codename: Tiramisu Tramontane
New Dependencies
Check earlier dependencies for EPrints 3.4.6 and before.
Upgrade Considerations
- If you are upgrading from an earlier version of EPrints 3.4.x and have the the metatags ingredient enabled, as well as disabling this by removing it from your flavour's inc file, if your archive has its own cfg/cfg.d/eprint_render.pl file, you will need to make sure that the following lines are added to it after similar lines for
Export::Simple
andExport::DC
:
$links->appendChild( $repository->plugin( "Export::HighwirePress" )->dataobj_to_html_header( $eprint ) ); $links->appendChild( $repository->plugin( "Export::Prism" )->dataobj_to_html_header( $eprint ) );
Changes Since 3.4.6
New Functionality
- Adds
check_config
optioion totools/epm
allowing configuration files (undercfg/
) to be compared between the EPM and the archive and potentially copied to the latter if the file is not already present. - Allows
bin/epadmin
to logout all users (possibly with 1 or more exclusions) - Implements missing triggers
EP_TRIGGER_BEGIN
andEP_TRIGGER_END
- Allows browse view variation ordering by number
- Adds citation cache management script
- Allows static pages to be put behind login (with exceptions)
- Allows custom sort to be applied at a browse menu level
- Adds Highwire Press and PRISM meta tags to head of abstract pages as favoured by Google Scholar
Security and Privacy Improvements
- Fixes vulnerability in PrototypeJS
- Uses different identifier for recalling search result caches so it cannot be guessed
- Ups to latest versions of jQuery and JQuery UI available in jquery ingredient
General Improvements
- Tidies up comments under
lib/cfg.d/security.pl
to only refer toEPrints::Repository->ip
function for getting the IP address of the request - Update Recaptcha3 to work with non-request workflows e.g. registration
- Improves
EPrints::Repository->remote_ip
to disregard invalid IP addresses inX-Forwarded-For
- Makes document thumbnails use long URL format
- Removes no longer supported
cgi/paracite
script - Improve
restrict_paths
by only allowing some IP rather than just disallowing others - Various improvements to citation caching
- Partially addresses spurious use of
X-Forwarded-For
header to pollute stats - Prevents 'Manage Deposits' taking a long time to load with a lot of items
- Removes references to
secure.xml
template andsecure_auto.js
- Adds place as a
related_url
type - Tides up use of
get_citaiton_id
in search screens - Allows any item that has ever been in the live archive to be retired
- Allows
EPrints::Document
search_related
to be ordered and limited to reduce number of cache tables generated - Allows placeholder to be optionally displayed for un-named subjects in browse views
- Supports disabling of auto re-searching of cache ID for search has expired
- Supports plugins exporting as attachment rather that in-browser
- Adds 'export_file_as_attachment' option to force exports to be downloaded
- Add view option to suppress 'feeds'
Bug Fixes
- Fixes
generate_apacheconf
has issues if archive missingcfg/static/javascript/auto/
- Fixes
Boolean
field has inconsistent phrase names - Fixes
tools/epm
'slink_lib
andunlink_lib
command so they only remove files referenced in the EPM directory's.epm
/.epmi
file - Fixes UX/Accessibility issue with
Import
plugin actions - Fixes History records not retaining formatting of email reasons
- Fixes disabling an EPM removes database tables and fields (and counters) it added to an archive
- Better handles
EPrint::MetaField->ordervalue_single
returning undefined - Fixes long values in initial dataobj creation leading to empty rows in their database tables
- Updates URLs for GPL/GPL licences to point at GNU rather than Creative Commons website
- Fixes typos is template Accessibility report
- Fixes
EPrint::MetaField::Multipart->ordervalues_basic
does not forward all parameters - Fixes Applying subtitle to
book_title
for book chapter items - Aligns
basic-auth
in Sword and Auth modules so passwords can contain non-word characters - Fixes Increment of data-row-cell-index for compound field header rows
- Fixes citation caching: non-linked cached citations
- Fixes before commit trigger changes not appearing in revision files
- Fixes
EPrints::Plugin::Search::Xapian->_get_records
cannot handle 0 results - Fixes issues with ReCAPTCHAv3 form being able to submit
- Fixes
login_required_for_X
functionality not be able to redirect user to a specific page after login - Fixes aspect ratio for video thumbnails if rotation matrix used
- Only crypt passwords that only contain printable ASCII
- Prevents other sub-field default occasionally be using for another compound field sub-field
- Fixes lightbox popup preview of a video
- Fixes Subobject
to_sax
causes 500 error if there are multiple and subobject is null - Sets more sensible
maxlength
default for MetaFields that areSQL_CLOB
to avoid truncation - Ensures depositable should be
TRUE
not1
on initial subject creation throughEdit::Subject
- Fixes HTML citation export fails if export citation style for eprint exists
- Ensures output from get_custom_view_header user-defined function can appear before or after the browse view navigation bar
- Removes no longer support
use encoding...
from random data generator - Makes 'Move' positions unique
- Retains attribute order in
build_attributes
- Fixes Horizontal scrollbar when zoomed to 400%
- Fixes default values for search get re-enabled if field left empty
- Fixes broken aria reference if help phrase exists, but help isn't shown
- Adds cgi/register to accessibility check
- Fixes logic support complex page ranges (e.g. A-2-B-4)
- Removes
rev_number
from eprints in test import data to prevent missing revisions when imported. - Fixes issues when splitting complex page ranges originally implemented for 3.4.2
- Fixes historic cache param causing excessive new cache tables
- Removes eprint rev_number from test data this cause odd behaviour when importing
- Prevents double presses on search buttons sending multiple requests
Known Issues
Session Initialisation and Close Bespoke Configuration
EPrints 3.4.7 replaces $c->{session_init}
and $c->{session_close}
configuration in lib/cfg.d/session.pl with EP_TRIGGER_BEGIN
and EP_TRIGGER_END
triggers. Although uncommon, if you have modified session_init
in a later configuration file than session.pl and your session_init function requires the EPrints::Repository
's offline
parameter then will not be sent to the function. Similarly, if you have modified the session_close
function and this requires and EPrints::Repository
object as a parameter, this will not be sent. These can be fixed with this patch.
Further Planned Features and Improvements
See 3.4.8 milestone on GitHub for more details.