EPrints 3.4.3 - Revision history

Drn@ecs.soton.ac.uk: /* General Improvements */ Fixes internal page link

2023-03-06T16:13:29Z

‎General Improvements: Fixes internal page link

Th.lauke@arcor.de: some typos removed

2022-12-27T16:38:41Z

some typos removed

Drn@ecs.soton.ac.uk: Added new known issue.

2022-12-13T16:53:51Z

Added new known issue.

Drn@ecs.soton.ac.uk: wrong heading level

2022-07-27T08:45:38Z

wrong heading level

Drn@ecs.soton.ac.uk: Added known issue with using EPrints::System sanitise function in bin scripts.

2022-07-27T08:38:31Z

Added known issue with using EPrints::System sanitise function in bin scripts.

Drn@ecs.soton.ac.uk: Added link to documentation about using Page ID pin.

2022-07-05T10:30:06Z

Added link to documentation about using Page ID pin.

Drn@ecs.soton.ac.uk: /* RIOXX2 plugin field validation leads to internal server error */

2022-02-07T14:34:02Z

‎RIOXX2 plugin field validation leads to internal server error

Drn@ecs.soton.ac.uk: Added known issue about RIOXX2 field validation.

2022-01-13T15:26:57Z

Added known issue about RIOXX2 field validation.

Drn@ecs.soton.ac.uk: /* Known Issues */

2021-12-20T14:20:25Z

‎Known Issues

Drn@ecs.soton.ac.uk: Add known issue about non-compulsory boolean radiogroups and bespoke validations for date fields.

2021-11-03T02:07:29Z

Add known issue about non-compulsory boolean radiogroups and bespoke validations for date fields.

@@ Line 41: / Line 41: @@
 ==== General Improvements ====
 * Resolves all accessibility errors and most alerts (as reported by the [https://wave.webaim.org/ WAVE Web Accessibility Evaluation Tool]) for backend admin pages as listed in the [https://accessibility.eprints-hosting.org/accessibility/report.html Accessibility report].
-* [[#Configuration URLs and Paths|Tidies up the use of configuration URLs and Paths]]
+* [[#Configuration for URLs and Paths|Tidies up the use of configuration URLs and Paths]]
 * Uses HTML class for <tt>Longtext_counter</tt> counter line and provides CSS to by default make this red and bold if the <tt>maxwords</tt> limit is exceeded.
 * Allows full path or just subject name to be displayed for values set in subjects field by setting <tt>render_path</tt> attribute (true by default).

@@ Line 19: / Line 19: @@
 ==== New Functionality ====
-* Provides function (<tt>EPrints::Utils::compare_version</tt>) for comparing EPrints software versions so plugins can choose to behave differently.
+* Provides function (<tt>EPrints::Utils::compare_version</tt>) for comparing EPrints software versions so plug-ins can choose to behave differently.
 * Adds <tt>jquery</tt> EPrints 3.4 ingredient to allow JQuery resources to be incorporated if required by non-core EPrints functionality.  Ingredient added but commented out in <tt>flavours/pub_lib/inc</tt>.
 * Provides picker for date fields to reduce potential for human error.
@@ Line 27: / Line 27: @@
 * Sets <tt>contact_email</tt> to not export by default for better GDPR compliance.
 * Rate limits failed local login attempts for a particular user.  Defaults to 10 failed login attempts in 10 minutes (using <tt>$c->{max_login_attempts}</tt> and <tt>$c->{lockout_minutes}</tt> configuration options).
-* Rate limits new account requests.  Defaults to 100 requests in a hour long period to avoid causing problems with planned mass sign up events.  Configured using <tt>$c->{max_account_requests}</tt> and <tt>$c->{max_account_requests_minutes}</tt> options.
+* Rate limits new account requests.  Defaults to 100 requests in an hour long period to avoid causing problems with planned mass sign up events.  Configured using <tt>$c->{max_account_requests}</tt> and <tt>$c->{max_account_requests_minutes}</tt> options.
 * Limits the maximum length of a password (default 200 characters) to prevent specific Denial-of-Service attacks.
-* Modifies <code>latex</code> invocation to make more secure an ensure it rights to the correct output directory.
+* Modifies <code>latex</code> invocation to make more secure and ensure it rights to the correct output directory.
 * Removes legacy <code>/cgi/latex2png</code> script to prevent Remote Code Execution (RCE) from [https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-3342 CVE-2021-3342].
 * Validates parameters passed to <code>/cgi/cal</code> script to protect against RCE and Cross Site Scripting (XSS) from [https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-26475 CVE-2021-26475] and [https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2021-26476 CVE-2021-26476].
@@ Line 46: / Line 46: @@
 * Allows time between password reset requests to be configured (to a number of hours) rather than hard-coded to 24 hours.
 * Adds option to set status of EPrints that should be checked by <tt>check_xapian</tt> script.
-* Adds <tt>date_embargo_retained</tt> field to Documents to retain the embargo date after the embargo is lifted.
+* Adds <tt>date_embargo_retained</tt> field to documents to retain the embargo date after the embargo is lifted.
 * Adds deprecation warning to indicate only LibXML library will be supported in future versions of EPrints. (Version for removal yet to be confirmed).
 * Adds basic default citation for files.
 * Adds validation for date fields to prevent invalid dates being set.
 * Allows files to be stored to disk with generic filenames (i.e. <code><fileid>.bin</code>) rather than the upload filename that can cause retrieval problem by setting the <code>$c->{generic_filenames}</code> configuration setting.
-* Adds code to <code>lib</code> and <code>pub_lib</code> versions of <code>security.pl</code> to deal with request a copy access issue if repository has coversheets plugin enabled.
+* Adds code to <code>lib</code> and <code>pub_lib</code> versions of <code>security.pl</code> to deal with request a copy access issue if repository has coversheets plug-in enabled.
 * Allows sub-fields to have help texts configured.
 * Generates log message for views that have reached their <code>max_items</code> limit.
-* Allows document fields displayed in an eprint's Details tab to be configured.
+* Allows document fields displayed in an eprint's details tab to be configured.
-* Adds data-context attributes to aid CSS styling of HTML div elements within search forms.
+* Adds data-context attributes to aid CSS styling of HTML <code>&lt;div&gt;</code> elements within search forms.
 * Improves scaling of of Lightbox popups on narrow screens.
 * [[Using Page ID in Templates|Allows a pin to set the id or class attribute for a template HTML element to facilitate different CSS styling on different pages]].
@@ Line 65: / Line 65: @@
 * Tidies up citations by removing identical <code>flavours/pub_lib/</code> citations that appear in <code>lib/</code>.
 * Allows <code>max_files</code> that can be expanded from an uploaded zip file to be configured. (Previously hardcoded to 100 file limit).
-* Allows customisable overriding of type-mapping based on <code>ispublished</code> value for BiBTeX and RIS export. (I.e. not using <code>@unpublished</code> type if <code>ispublished</code> set to <code>unpub</code>).
+* Allows customisable overriding of type-mapping based on <code>ispublished</code> value for BibTeX and RIS export. (I.e. not using <code>unpublished</code> type if <code>ispublished</code> set to <code>unpub</code>).
 * Provides <code>has_role</code> EPC function to allow more granular control of workflows that can be edited by specific group of user that have has this role added to their profile.
 * Allows positioning of hovering document preview to be set to left or right and implements this in <code>summary_page</code> and <code>result</code> eprint citations to improve preview positioning.
@@ Line 83: / Line 83: @@
 * Fixes internal server error when trying to save values to a non-multiple compound field.
 * Fixes issue with XML import setting unset compound subfields to NULL rather than empty string.
-* Fixes errors on import pages caused by Accessibility improvements and fixes other Accessibility issues for import pages.
+* Fixes errors on import pages caused by accessibility improvements and fixes other accessibility issues for import pages.
 * Fixes broken link of default 401 error page.
 * Sets STDOUT and STDERR binmode to utf8 to avoid wide character errors.
-* Fixes user history layout as a result of earlier Accessibility improvements.
+* Fixes user history layout as a result of earlier accessibility improvements.
 * Fixes missing phrases reported in error logs.  Typically fieldhelp phrases for sub-fields of compound fields, which are generally not rendered but still report missing phrase warnings.
 * Sets <code>SameSite</code> property to <code>None</code> for secure login and request copy cookies as Google Chrome is now quite strict about this.
-* Provides handling for XML parsing of revision files to show warning for particular revision in the hostory tab rather than an internal server error for the whole page.
+* Provides handling for XML parsing of revision files to show warning for particular revision in the history tab rather than an internal server error for the whole page.
 * Allows use of same pin multiple times within a phrase.
 * Prevents undefined <code>$c->{aliases}</code> from causing <code>epadmin config_core</code> to fail.
-* Ensures saved searches indicate email notifications cannot be sent when the <code>Xapianv2</code> (in addition to <code>Xapian</code>) plugin has been used for the original search.
+* Ensures saved searches indicate email notifications cannot be sent when the <code>Xapianv2</code> (in addition to <code>Xapian</code>) plug-in has been used for the original search.
 * Adds missing <code>event_queue</code> phrases.
 * Fixes inappropriate mapping of <code>monograph_type</code> in BibTeX import.
 * Fixes erroneous post-login redirection when login required to access eprint summary/abstract pages and long URLs (e.g. /id/eprint/1234) enabled.
 * Ensures <code>readonly</code> attribute works for <code>MetaField::Set</code> in compound-multiple fields.
-* Adds missing <code>reason</code> phrase for <code>RejectWithEmail</code> screen plugin.
+* Adds missing <code>reason</code> phrase for <code>RejectWithEmail</code> screen plug-in.
 * Prevents HEAD requests (e.g. email link checkers) for password from resets from actioning the reset.  (Otherwise, when the user clicks the link it will say the password has already been reset, which may concern the user).
 * Forces full day-month-year to be set for document embargo expiry to avoid any ambiguity.
@@ Line 106: / Line 106: @@
 * Fixes missing pin for error message phrase when restarting indexer.
 * Fixes <code>MetaField::Listing</code> from logging an error that no <code>datasetid</code> is defined when on its index page (listing datasets).
-* Updates positions for plugins that appear in key tools menu to ensure deterministic ordering.
+* Updates positions for plug-ins that appear in key tools menu to ensure deterministic ordering.
 * Fixes bug to allow REST calls for subjects with IDs that contain full stops (.).
 * Better handles finding parent eprint when this has been deleted.
@@ Line 112: / Line 112: @@
 * Fixes <code>tools/update_phrase/file</code> to ensure EPrints libraries can be used and allows specified base path, current working directory or full path to be used for phrase file parameters.
 * Fixes BibTeX import using uploaded files broken by update to third-party <code>BibTeX::Parser</code> in EPrints 3.4.2.
-* Fixes RDF export by adding doi namespace for when id_number field is set to a DOI and is then translated to and owl:sameAs in a RDF export.
+* Fixes RDF export by adding doi namespace for when id_number field is set to a DOI and is then translated to an owl:sameAs in a RDF export.
 * Fixes bug preventing exporting file data objects in various metadata formats (e.g. Atom, EP3XML, CSV, etc.).

@@ Line 154: / Line 154: @@
 If you call the <code>sanitise</code> function ofr <code>EPrints::System</code>, this works fine under CGI because the <code>EPrints::Repository</code> object can be determined but this is not currently possible if this function is called by a standalone bin script.  [https://github.com/eprints/eprints3.4/commit/08581f02531184e7aa4b917e95db4a5ab93e0dca This patch] allows the function to be passed an optional <code>EPrints::Repository</code> object.  The bin script in question may need to be modified so it pass this additional parameter.
-=== Configuration URLs and Paths ===
+==== $c->{userhome} and $c->{urlpath} Auto-set Incorrectly ====
 EPrints has various configuration settings for URLs and paths that are automatically configured based on the settings in an archive's <code>cfg/cfg.d/10_core.pl</code>.  The six most significant are the following:

@@ Line 151: / Line 151: @@
 Both the RIOXX2 plugin and <tt>lib/cfg.d/user_password_maxlength.pl</tt> should be patched.  The former to avoid any other trigger methods from causing an internal server error in a similar way and the latter to work round the bug in the RIOXX2 field's <code>validate</code> method. [https://github.com/eprints/eprints3.4/commit/0904940a1d68f3e92317bb3bae1e33888c777b36 This is the patch] for the latter.  Any future versions of the RIOXX2 plugin should hopefully have a patch to ensure the data object is sent as a parameter to the underlying field's <code>validate_method</code>.
-=== EPrints::System's sanitise cannot be called by bin scripts ===
+==== EPrints::System's sanitise cannot be called by bin scripts ====
 If you call the <code>sanitise</code> function ofr <code>EPrints::System</code>, this works fine under CGI because the <code>EPrints::Repository</code> object can be determined but this is not currently possible if this function is called by a standalone bin script.  [https://github.com/eprints/eprints3.4/commit/08581f02531184e7aa4b917e95db4a5ab93e0dca This patch] allows the function to be passed an optional <code>EPrints::Repository</code> object.  The bin script in question may need to be modified so it pass this additional parameter.

@@ Line 150: / Line 150: @@
 # When this underlying validate method calls the <code>EP_TRIGGER_VALIDATE_FIELD</code> this initiate the trigger method in <tt>lib/cfg.d/user_password_maxlength.pl</tt>.  This  trigger expect the data object to be set under the variable <code>$user</code> but is is not and therefore fails when trying to call the <code>isa</code> method on it, which is not possible when it is undefined.
 Both the RIOXX2 plugin and <tt>lib/cfg.d/user_password_maxlength.pl</tt> should be patched.  The former to avoid any other trigger methods from causing an internal server error in a similar way and the latter to work round the bug in the RIOXX2 field's <code>validate</code> method. [https://github.com/eprints/eprints3.4/commit/0904940a1d68f3e92317bb3bae1e33888c777b36 This is the patch] for the latter.  Any future versions of the RIOXX2 plugin should hopefully have a patch to ensure the data object is sent as a parameter to the underlying field's <code>validate_method</code>.
 === Configuration URLs and Paths ===

@@ Line 57: / Line 57: @@
 * Adds data-context attributes to aid CSS styling of HTML div elements within search forms.
 * Improves scaling of of Lightbox popups on narrow screens.
-* Allows a pin to set the id or class attribute for a template HTML element to facilitate different CSS styling on different pages.
+* [[Using Page ID in Templates|Allows a pin to set the id or class attribute for a template HTML element to facilitate different CSS styling on different pages]].
 * Prompts for organisation name when creating a new archive using <code>epadmin create</code>.
 * Allows classes to be assigned to parts (i.e. top, left, main, after, etc.) of abstract/summary pages to facilitate better CSS styling.

@@ Line 144: / Line 144: @@
 ==== Non-compulsory boolean radiogroup fields cannot deselect UNSPECIFIED ====
 If a field is set to type <code>boolean</code> and then in the workflow it is not set as required, then the ''UNSPECIFIED'' option will be displayed and selected.  This is due to a typo in the code when enhancing accessibility for various MetaFields.  [https://github.com/eprints/eprints3.4/commit/73f493421fb5feba81e1461181d444e4bb72ae1b This patch] fixes the typo so that the name of the input field is set correctly, whilst the id for the input field is set to a unique value.
 === Configuration URLs and Paths ===

@@ Line 128: / Line 128: @@
   cpan CGI::Cookie
-==== Non-multiple Subject field causes and internal server error ====
+==== Non-multiple Subject field causes an internal server error ====
 This problem does not affect any fields in a vanilla installation of EPrints 3.4.3 but will affect any non-multiple [[Subject field]]s unless they use the <code>Field::Subject</code> typed component in the workflow.  From the web browser the page will just show an internal server error but the underling error message in the webserver logs will be something like:

@@ Line 118: / Line 118: @@
 ==== Multiple values not supported by EPrints::MetaField::Date validate function ====
 The <code>validate</code> function of <code>EPrints::MetaField::Date</code> does not support multiple values like is used in [https://bazaar.eprints.org/449/ Dates, Dates, Dates] Bazaar plugin. [[:File:MetaField-Date-validate.patch|This patch]] fixes this issue and also improves the warning message generated if an invalidate date is entered.
 ==== Requesting /cgi/set_lang causes an internal server error ====
@@ Line 138: / Line 141: @@
 This issue can be resolved by the [https://github.com/eprints/eprints3.4/commit/41f6f199d7abb753a3d180aabde6a0c482825ff8 same patch] that fixes the bug with non-multiple [[Subject field]]s.  It makes sure that only previously selected items that are now undepositable are added to the array of selected options, as the one that are still depositable will be added to this array by other means.  In making this change, both undepositable and depositable options will only be selected once in the select input for this field.
 === Configuration URLs and Paths ===