Difference between revisions of "EPrints 3.4.7"

From EPrints Documentation
Jump to: navigation, search
(Changes Since 3.4.6: Up to end of March 2025)
m (Security and Privacy Improvements)
 
(26 intermediate revisions by the same user not shown)
Line 1: Line 1:
This page contains information about the provisional EPrints v3.4.7 tag and release on GitHub.  A date for this release is yet to be scheduled.
+
{{releasenotes}}
  
== Release Notes (Provisional) ==
+
This page contains information about the EPrints v3.4.7 tag and release on GitHub.
EPrints 3.4.6 will be released later in 2025.
+
 
* '''Zero codename:''' ''TO BE DETERMINED''
+
== Release Notes ==
* '''Publications flavour codename:''' ''TO BE DETERMINED''
+
EPrints 3.4.7 is now available on [https://github.com/eprints/eprints3.4/releases/tag/v3.4.7 GitHub].
 +
* '''Zero codename:''' ''Granita Gregale''
 +
* '''Publications flavour codename:''' ''Tiramisu Tramontane''
  
 
=== 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 14: Line 21:
 
* Adds <code>check_config</code> optioion to <code>tools/epm</code> allowing configuration files (under <code>cfg/</code>) to be compared between the EPM and the archive and potentially copied to the latter if the file is not already present.
 
* Adds <code>check_config</code> optioion to <code>tools/epm</code> allowing configuration files (under <code>cfg/</code>) to be compared between the EPM and the archive and potentially copied to the latter if the file is not already present.
 
* [https://github.com/eprints/eprints3.4/issues/425 Allows <code>bin/epadmin</code> to logout all users (possibly with 1 or more exclusions)]
 
* [https://github.com/eprints/eprints3.4/issues/425 Allows <code>bin/epadmin</code> to logout all users (possibly with 1 or more exclusions)]
 +
* [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]
 +
* 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/pull/462 Allows custom sort to be applied at a browse menu level]
 +
* [https://github.com/eprints/eprints3.4/pull/490 Adds Highwire Press and PRISM meta tags to head of abstract pages] as favoured by Google Scholar
  
 
==== 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]
 +
** Severity: Low | By default EPrints does not make use of PrototypeJS in a way that actively exposes CVE-2020-27511. EPrints only allows an administrator to modify the JavaScript EPrints serves, such that the vulnerability could be exposed.
 +
* [https://github.com/eprints/eprints3.4/issues/465 Uses different identifier for recalling search result caches so it cannot be guessed]
 +
** Severity: Low | Change is only intended to partially mitigate certain excessive search queries, which can sometimes be processor intensive.
 +
* [https://github.com/eprints/eprints3.4/issues/502 Ups to latest versions of jQuery and JQuery UI available in jquery ingredient]
 +
** Severity: Low | jquery ingredient is not enabled by default.  Minor upgrade of JQuery libraries is mainly to ensure versions do not fall too far behind the latest, as they may be needed to provide a repository's branding imported from another website.
  
 
==== General Improvements ====
 
==== General Improvements ====
 
* Tidies up comments under <code>lib/cfg.d/security.pl</code> to only refer to <code>EPrints::Repository->ip</code> function for getting the IP address of the request
 
* Tidies up comments under <code>lib/cfg.d/security.pl</code> to only refer to <code>EPrints::Repository->ip</code> function for getting the IP address of the request
 
* [https://github.com/eprints/eprints3.4/pull/416 Update Recaptcha3 to work with non-request workflows e.g. registration]
 
* [https://github.com/eprints/eprints3.4/pull/416 Update Recaptcha3 to work with non-request workflows e.g. registration]
* [https://github.com/eprints/eprints3.4/issues/417 Improves EPrints::Repository->remote_ip to disregard invalid IP addresses in X-Forwarded-For]
+
* [https://github.com/eprints/eprints3.4/issues/417 Improves <code>EPrints::Repository->remote_ip</code> to disregard invalid IP addresses in <code>X-Forwarded-For</code>]
* [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/436 Makes document thumbnails use long URL format]
 
* [https://github.com/eprints/eprints3.4/pull/436 Makes document thumbnails use long URL format]
* [https://github.com/eprints/eprints3.4/issues/439 Removes no longer supported cgi/paracite script]
+
* [https://github.com/eprints/eprints3.4/issues/439 Removes no longer supported <code>cgi/paracite</code> script]
 
* [https://github.com/eprints/eprints3.4/issues/443 Improve <code>restrict_paths</code> by only allowing some IP rather than just disallowing others]
 
* [https://github.com/eprints/eprints3.4/issues/443 Improve <code>restrict_paths</code> by only allowing some IP rather than just disallowing others]
 +
* [https://github.com/eprints/eprints3.4/pull/451 Various improvements to citation caching]
 +
* [https://github.com/eprints/eprints3.4/issues/454 Partially addresses spurious use of <code>X-Forwarded-For</code> header to pollute stats]
 +
* [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>]
 +
* 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> 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/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/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 39: Line 69:
 
* Fixes [https://github.com/eprints/eprints3.4/pull/435 typos is template Accessibility report]
 
* Fixes [https://github.com/eprints/eprints3.4/pull/435 typos is template Accessibility report]
 
* Fixes [https://github.com/eprints/eprints3.4/issues/442 <code>EPrint::MetaField::Multipart->ordervalues_basic</code> does not forward all parameters]
 
* Fixes [https://github.com/eprints/eprints3.4/issues/442 <code>EPrint::MetaField::Multipart->ordervalues_basic</code> does not forward all parameters]
 +
* Fixes [https://github.com/eprints/eprints3.4/pull/426 Applying subtitle to <code>book_title</code> for book chapter items]
 +
* [https://github.com/eprints/eprints3.4/pull/441 Aligns <code>basic-auth</code> in Sword and Auth modules] so passwords can contain non-word characters
 +
* Fixes [https://github.com/eprints/eprints3.4/pull/449 Increment of data-row-cell-index for compound field header rows]
 +
* Fixes [https://github.com/eprints/eprints3.4/issues/447 citation caching: non-linked cached citations]
 +
* Fixes [https://github.com/eprints/eprints3.4/pull/438 before commit trigger changes not appearing in revision files]
 +
* 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/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/issues/457 Only crypt passwords that only contain printable ASCII]
 +
* [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]
 +
* 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 <code>maxlength</code> default for MetaFields that are <code>SQL_CLOB</code> to avoid truncation]
 +
* 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]
 +
* Ensures output from get_custom_view_header user-defined function can appear before or after the browse view navigation bar
 +
* 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/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/469 default values for search get re-enabled if field left empty]
 +
* Fixes [https://github.com/eprints/eprints3.4/issues/473 broken aria reference if help phrase exists, but help isn't shown]
 +
* [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)
 +
* 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]'''.
  
== Planned Features and Improvements ==
+
== Further Planned Features and Improvements ==
See [https://github.com/eprints/eprints3.4/milestone/8 3.4.7 milestone on GitHub] for more details.
+
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:Planned Releases]]
+
[[Category:Releases]]

Latest revision as of 13:47, 4 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


3.1.0

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 and Export::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

Security and Privacy Improvements

General Improvements

Bug Fixes

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.