Difference between revisions of "EPrints 3.4.6"
m (→General Improvements) |
m (→Running generate_apacheconf with an archive without a cfg/static/javascript/auto/ directory) |
||
(10 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
− | + | {{releasenotes}} | |
− | == Release Notes | + | This page contains information about the provisional EPrints v3.4.6 tag and release on GitHub. |
− | EPrints 3.4.6 | + | |
− | * '''Zero codename:''' | + | == Release Notes == |
− | * '''Publications flavour codename:''' | + | EPrints 3.4.6 is now available on [https://github.com/eprints/eprints3.4/releases/tag/v3.4.6 GitHub]. |
+ | * '''Zero codename:''' Creme Brulee Cryoseism | ||
+ | * '''Publications flavour codename:''' Affogato Snowmelt | ||
=== New Dependencies === | === New Dependencies === | ||
Line 13: | Line 15: | ||
==== New Functionality ==== | ==== New Functionality ==== | ||
* Adds <code>unlink_lib</code> option to <code>tools/epm</code>. | * Adds <code>unlink_lib</code> option to <code>tools/epm</code>. | ||
+ | * Adds <code>--to-link</code> flag to <code>unpack</code> option of <code>tools/epm</code> to allow an EPM file to be unpack so it can subsequently be deployed by <code>link_lib</code> option. | ||
* [https://github.com/eprints/eprints3.4/issues/340 Provide support for converting HEIC and WEBP thumbnails] | * [https://github.com/eprints/eprints3.4/issues/340 Provide support for converting HEIC and WEBP thumbnails] | ||
+ | * Adds support for setting default reply-to when separate <code>$c->{adminemail}</code> and <code>$c->{sendermail}</code> | ||
+ | * [https://github.com/eprints/eprints3.4/issues/388 Allows certain URL paths to be blocked for certain IPs] | ||
+ | * [https://github.com/eprints/eprints3.4/pull/387 Initial Signposting integration] | ||
==== Security and Privacy Improvements ==== | ==== Security and Privacy Improvements ==== | ||
Line 19: | Line 25: | ||
* [https://github.com/eprints/eprints3.4/issues/344 Creates and enables <code>export_privacy</code> setting to prevent export formats that include email addresses to be publicly accessible by default]. | * [https://github.com/eprints/eprints3.4/issues/344 Creates and enables <code>export_privacy</code> setting to prevent export formats that include email addresses to be publicly accessible by default]. | ||
* Ensure <code>ga.js</code> is always served on HTTPS | * Ensure <code>ga.js</code> is always served on HTTPS | ||
+ | * Makes sure <code>cache</code> parameter value provided by search form is a number to prevent URL injection. | ||
==== General Improvements ==== | ==== General Improvements ==== | ||
Line 40: | Line 47: | ||
* Reports useful error message if user tries to remove subject that has children | * Reports useful error message if user tries to remove subject that has children | ||
* [https://github.com/eprints/eprints3.4/issues/353 Allows way to pass timeout to indexer daemon] | * [https://github.com/eprints/eprints3.4/issues/353 Allows way to pass timeout to indexer daemon] | ||
+ | * [https://github.com/eprints/eprints3.4/pull/351 Aligns headings when Itemref occurs within Compound Metafield] | ||
+ | * Log failure if email attempts send with <code>to_email</code> or <code>to_list</code> set | ||
+ | * Allows <code>EPrints::Repository::render_option_list</code> to render select box as disabled | ||
+ | * Ensures more consistent use of space for results listings where div rather than table rows are now used for better Accessibility | ||
+ | * Better margin for search results toolbar (e.g. Batch Edit) | ||
+ | * [https://github.com/eprints/eprints3.4/issues/367 Organise fields under stage in EPrint::View screen by workflow rather than data object] | ||
+ | * [https://github.com/eprints/eprints3.4/issues/370 Rewrite CitationCache code to use EPrints API rather than SQL query] | ||
+ | * [https://github.com/eprints/eprints3.4/issues/360 Allow "make open access" on request copy responses a disable-able field] | ||
+ | * [https://github.com/eprints/eprints3.4/issues/376 Allow signed in user to be logged in Apache access logs] | ||
+ | * [https://github.com/eprints/eprints3.4/pull/382 Adds lastmod attributes to entries in sitemap] | ||
+ | * [https://github.com/eprints/eprints3.4/issues/381 Add <code>threads</code> option to ffmpeg invocations] | ||
+ | * [https://github.com/eprints/eprints3.4/issues/392 Stop unnecessarily generating list of user's eprints twice for Manage Deposits page load] | ||
+ | * [https://github.com/eprints/eprints3.4/issues/374 Uses <code>Text::Unidecode</code> primarily to tokenize input for indexing] (rather than manually defining mappings) | ||
+ | * [https://github.com/eprints/eprints3.4/issues/373 Rework cpan_modules.pl to install all required Perl modules] | ||
+ | * Allows EPC to render icon without a link | ||
+ | * Adds commented out config option <code>show_ids_in_log</code> | ||
+ | * Removes long since deprecated pagehooks functionality | ||
+ | * Removes irrelevant <code>dbsid</code> config setting | ||
+ | * Improvements to simplify login monitoring configuration | ||
+ | * Remove reference to defunct <code>quiet</code> config setting | ||
==== Bug Fixes ==== | ==== Bug Fixes ==== | ||
Line 59: | Line 86: | ||
* Testing an import should set the <code>filename</code> parameter like it would in a real import | * Testing an import should set the <code>filename</code> parameter like it would in a real import | ||
* Checks <code>$c->{oai}->{comments}</code> is set before iterating over it. | * Checks <code>$c->{oai}->{comments}</code> is set before iterating over it. | ||
+ | * Prevents bin script from complaining about email-less users. | ||
+ | * Fixed EPC <code>contains</code> function to return a boolean value rather than a TRUE/FALSE string. | ||
+ | * [https://github.com/eprints/eprints3.4/pull/365 Allows documents to <code>redo_thumbnails</code> even if they have no parent eprint] | ||
+ | * Fixes wrong optione name for loading external DTDs in XML | ||
+ | * [https://github.com/eprints/eprints3.4/issues/366 Fixes overloading of etaField <code>render_quiet</code> attribute by introducing <code>render_column_quiet</code> attribute | ||
+ | * [https://github.com/eprints/eprints3.4/issues/369 Fixes unsecure request when uploading file] | ||
+ | * [https://github.com/eprints/eprints3.4/issues/371 Fix encoding issues for bespoke Export plugins] | ||
+ | * [https://github.com/eprints/eprints3.4/issues/334 Using page_id pin in page templates breaks editing static pages in web interface] | ||
+ | * Checks value is set before performing a regular expression replace in <code>EPrints::MetaField::Search::form_value_basi</code> | ||
+ | * [https://github.com/eprints/eprints3.4/issues/375 Return more appropriate 500 rather than 404 HTTP code if document present but database query fails] | ||
+ | * [https://github.com/eprints/eprints3.4/issues/377 Fixes drag 'n' drop issues leading to zero byte files | ||
+ | * [https://github.com/eprints/eprints3.4/issues/378 Fixes "More input rows" button affecting layout of Compound field tables in workflow] | ||
+ | * Ensures clicking tabs on abstract pages does not reload page | ||
+ | * [https://github.com/eprints/eprints3.4/pull/380 Ensures fields sent in autocompleter requests are encoded] | ||
+ | * [https://github.com/eprints/eprints3.4/issues/383 Allows phrase editor to add phrases for alternative languages] | ||
+ | * [https://github.com/eprints/eprints3.4/issues/385 Fixes bug with edit subjects if ID field value is too long] | ||
+ | * Fixes warnings produced when <code>readonly</code> or <code>show_help</code> MetaField attributes are not defined when expected | ||
+ | * [https://github.com/eprints/eprints3.4/issues/48 Fixes further issue with <code>toform</code> attribute for <code>itemref</code> MetaField] | ||
+ | * Fixes warnings when using <codeEPrints::UTils::compare_version function | ||
+ | * [https://github.com/eprints/eprints3.4/issues/323 Fixes ancestor numbers (of items) in subject-based browse views] | ||
+ | * [https://github.com/eprints/eprints3.4/issues/390 Fixes slow page loads when user has lots of items under Manage Deposits] | ||
+ | * [https://github.com/eprints/eprints3.4/issues/249 Reverts changes to implement subject MetaField's <code>top</code> attribute as a function] (Best done through conditional in the workflow) | ||
+ | * Fixes XSLT import/export plugins so they no longer prevent EPrints being run using Apache MPM Event (i.e. threaded) | ||
+ | * [https://github.com/eprints/eprints3.4/issues/384 Ensure search pages respect <code>template</code> specified in their configuration] | ||
+ | * Makes sure XML converted to string does not contain any control/non characters that might break if they attempt to be rendered within XML. | ||
+ | * Fixes wrong config variable loads for <code>citation_default</code> for Dublin Core and simple export. | ||
+ | * Extends sanitization invalid characters for values of ID metadata fields and their subclasses. | ||
* Fixes various typos | * Fixes various typos | ||
+ | * [https://github.com/eprints/eprints3.4/issues/395 Fixes broken <code>eprint_status</code> filters when <code>get_users_owned_eprints</code> configuration function is defined] | ||
+ | * [https://github.com/eprints/eprints3.4/issues/394 Fixes incorrect white space in citations rendered in emails] | ||
+ | |||
+ | == Known Issues == | ||
+ | === Running generate_apacheconf with an archive without a cfg/static/javascript/auto/ directory === | ||
+ | If you are upgrading an EPrints repository and your archive(s) do not have a <code>cfg/static/javascript/auto/</code> directory then <code>bin/generate_apacheconf</code> will fail. This is because 3.4.6 [https://github.com/eprints/eprints3.4/issues/369 introduces] code that makes sure that the maximum upload limit is configured to be the same in the Apache configuration and in EPrints' JavaScript, which prevents you from trying to upload files larger than a certain size. This is useful because if you just updated the JavaScript, EPrints would allow the upload to start but would then fail when the Apache limit was reached. So not only would you not be able to upload the file but you would waste a load of time and possibly not understand why the upload failed. | ||
+ | |||
+ | To fix this issue for this version of EPrints, just make sure your archive (or archives) all have a <code>cfg/static/javascript/auto/</code> before running <code>bin/generate_apacheconf</code>. Future versions of EPrints will automatically create this directory if it does not already exist. | ||
== Further Planned Features and Improvements == | == Further Planned Features and Improvements == | ||
− | See [https://github.com/eprints/eprints3.4/milestone/ | + | See [https://github.com/eprints/eprints3.4/milestone/8 3.4.7 milestone on GitHub] for more details. |
[[Category:Eprints3.4]] | [[Category:Eprints3.4]] | ||
− | [[Category: | + | [[Category:Releases]] |
Latest revision as of 15:10, 29 August 2024
Release Notes
3.4 | 3.4.1 | 3.4.2 | 3.4.3 | 3.4.4 | 3.4.5 | 3.4.6
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 provisional EPrints v3.4.6 tag and release on GitHub.
Release Notes
EPrints 3.4.6 is now available on GitHub.
- Zero codename: Creme Brulee Cryoseism
- Publications flavour codename: Affogato Snowmelt
New Dependencies
Check earlier dependencies for EPrints 3.4.5 and before.
Changes Since 3.4.5
New Functionality
- Adds
unlink_lib
option totools/epm
. - Adds
--to-link
flag tounpack
option oftools/epm
to allow an EPM file to be unpack so it can subsequently be deployed bylink_lib
option. - Provide support for converting HEIC and WEBP thumbnails
- Adds support for setting default reply-to when separate
$c->{adminemail}
and$c->{sendermail}
- Allows certain URL paths to be blocked for certain IPs
- Initial Signposting integration
Security and Privacy Improvements
- Implement stronger password hashing
- Creates and enables
export_privacy
setting to prevent export formats that include email addresses to be publicly accessible by default. - Ensure
ga.js
is always served on HTTPS - Makes sure
cache
parameter value provided by search form is a number to prevent URL injection.
General Improvements
- Implement Recaptcha field to work with Google ReCAPTCHA v3
- [https://github.com/eprints/eprints3.4/issues/339 Sets
ignore_login_ip = 1
by default if HTTPS is enabled. - Improvements Accessibility based on issues raised by axe DevTools
- Improves message when file retrieval fails
- Adds
.gitignore
for ingredients other than those included, so those deploying EPrints using Git do not see new ingredients as uncommitted. - Updates and tidies
SystemSettings.pm
andSystemSettings.pm.in
- Adds function to get local path on disk for file object
- Overwrites media video stream if incoming stream is higher res
- Uses
export
version of citation if exists (rather thandefault
) for HTML export of data objects - Adds title attribute for preview images to display on hover
- Adds function to test if citation style file exists
- Allows truncated URL linls to set a
target
attribute - Provide large icons to be printed by EPC
icon
function - Added EPC
text
function to print out phrases into HTML attributes values - Allows certain HTML formatting tags in imports, (e.g. from PubMed)
- Adds title for action button image
- Allows fields of various types to be more customisable in search forms
- Reports useful error message if user tries to remove subject that has children
- Allows way to pass timeout to indexer daemon
- Aligns headings when Itemref occurs within Compound Metafield
- Log failure if email attempts send with
to_email
orto_list
set - Allows
EPrints::Repository::render_option_list
to render select box as disabled - Ensures more consistent use of space for results listings where div rather than table rows are now used for better Accessibility
- Better margin for search results toolbar (e.g. Batch Edit)
- Organise fields under stage in EPrint::View screen by workflow rather than data object
- Rewrite CitationCache code to use EPrints API rather than SQL query
- Allow "make open access" on request copy responses a disable-able field
- Allow signed in user to be logged in Apache access logs
- Adds lastmod attributes to entries in sitemap
- Add
threads
option to ffmpeg invocations - Stop unnecessarily generating list of user's eprints twice for Manage Deposits page load
- Uses
Text::Unidecode
primarily to tokenize input for indexing (rather than manually defining mappings) - Rework cpan_modules.pl to install all required Perl modules
- Allows EPC to render icon without a link
- Adds commented out config option
show_ids_in_log
- Removes long since deprecated pagehooks functionality
- Removes irrelevant
dbsid
config setting - Improvements to simplify login monitoring configuration
- Remove reference to defunct
quiet
config setting
Bug Fixes
- Fixes Downloading document from preview image does not work for some filenames
- Fixes Do not add
requester_userid
by default as access table can take a long time to add new fields. However, ensure if field exists it is set to current user ID, if set. - Fixes serialization of EPM for
build
option oftools/epm
. - Fixes issues with
disable
andunpack
options fortools/epm
. - Duplicated "_label" span id
- Fixes Tab children deemed decorative
- Fixes bug preventing user password updates from command line.
- Fixes intermittent issue with
xmlns:xsi
attribute being defined twice on some/cgi/oai2/...
pages. - Check that
uri
of relation is set before comparing its value forEPrints::DataObj::remove_dataobj_relations
- Check that
uri
of relation is set before comparing its value forEPrints::MetaField::Relation::to_sax_basic
- Check URL is set before testing its length in
EPrints::Extras::render_url_truncate_end
- Fixes
EPrints::XML::SAX::Writer::escape
to make sure$str
is set before applying regular expression - Export bar form should use
rel_cgipath
nothttp_cgiroot
- Actually use
size
when callingEPrints::DataObj::Document::render_icon_link
- Ensure lookup of keyname is set before using it in
EPrints::Database::get_dataobjs
- Testing an import should set the
filename
parameter like it would in a real import - Checks
$c->{oai}->{comments}
is set before iterating over it. - Prevents bin script from complaining about email-less users.
- Fixed EPC
contains
function to return a boolean value rather than a TRUE/FALSE string. - Allows documents to
redo_thumbnails
even if they have no parent eprint - Fixes wrong optione name for loading external DTDs in XML
- [https://github.com/eprints/eprints3.4/issues/366 Fixes overloading of etaField
render_quiet
attribute by introducingrender_column_quiet
attribute - Fixes unsecure request when uploading file
- Fix encoding issues for bespoke Export plugins
- Using page_id pin in page templates breaks editing static pages in web interface
- Checks value is set before performing a regular expression replace in
EPrints::MetaField::Search::form_value_basi
- Return more appropriate 500 rather than 404 HTTP code if document present but database query fails
- [https://github.com/eprints/eprints3.4/issues/377 Fixes drag 'n' drop issues leading to zero byte files
- Fixes "More input rows" button affecting layout of Compound field tables in workflow
- Ensures clicking tabs on abstract pages does not reload page
- Ensures fields sent in autocompleter requests are encoded
- Allows phrase editor to add phrases for alternative languages
- Fixes bug with edit subjects if ID field value is too long
- Fixes warnings produced when
readonly
orshow_help
MetaField attributes are not defined when expected - Fixes further issue with
toform
attribute foritemref
MetaField - Fixes warnings when using <codeEPrints::UTils::compare_version function
- Fixes ancestor numbers (of items) in subject-based browse views
- Fixes slow page loads when user has lots of items under Manage Deposits
- Reverts changes to implement subject MetaField's
top
attribute as a function (Best done through conditional in the workflow) - Fixes XSLT import/export plugins so they no longer prevent EPrints being run using Apache MPM Event (i.e. threaded)
- Ensure search pages respect
template
specified in their configuration - Makes sure XML converted to string does not contain any control/non characters that might break if they attempt to be rendered within XML.
- Fixes wrong config variable loads for
citation_default
for Dublin Core and simple export. - Extends sanitization invalid characters for values of ID metadata fields and their subclasses.
- Fixes various typos
- Fixes broken
eprint_status
filters whenget_users_owned_eprints
configuration function is defined - Fixes incorrect white space in citations rendered in emails
Known Issues
Running generate_apacheconf with an archive without a cfg/static/javascript/auto/ directory
If you are upgrading an EPrints repository and your archive(s) do not have a cfg/static/javascript/auto/
directory then bin/generate_apacheconf
will fail. This is because 3.4.6 introduces code that makes sure that the maximum upload limit is configured to be the same in the Apache configuration and in EPrints' JavaScript, which prevents you from trying to upload files larger than a certain size. This is useful because if you just updated the JavaScript, EPrints would allow the upload to start but would then fail when the Apache limit was reached. So not only would you not be able to upload the file but you would waste a load of time and possibly not understand why the upload failed.
To fix this issue for this version of EPrints, just make sure your archive (or archives) all have a cfg/static/javascript/auto/
before running bin/generate_apacheconf
. Future versions of EPrints will automatically create this directory if it does not already exist.
Further Planned Features and Improvements
See 3.4.7 milestone on GitHub for more details.