About Features Downloads Getting Started Documentation Events Support GitHub

Love VuFind®? Consider becoming a financial supporter. Your support helps build a better VuFind®!

Site Tools


Warning: This page has not been updated in over over a year and may be outdated or deprecated.
changelog

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
Next revisionBoth sides next revision
changelog [2019/12/02 16:56] – [Release 6.1 - currently under development] demiankatzchangelog [2020/07/02 20:30] – [Release 7.0 - coming 7/20/2020] demiankatz
Line 3: Line 3:
 // When adding a new release, see the [[changelog:release_checklist|release checklist]]. // // When adding a new release, see the [[changelog:release_checklist|release checklist]]. //
  
-===== Release 6.1 - currently under development =====+===== Release 7.0 - coming 7/20/2020 ===== 
 + 
 +New features: 
 + 
 +  * [[configuration:static_pages|Static pages]] can now be built using Markdown as well as PHP templates. 
 +  * New [[https://vufind.org/wiki/development:plugins:contentblocks|Content Block plugin]]: TemplateBased, which allows you to embed a template that will behave similarly to a [[configuration:static_pages|static pages]] in terms of supporting internationalization, Markdown, etc. 
 +  * VuFind now supports configurable [[administration:security:content_security_policy|Content Security Policy]] headers, for improved security. These default to "report only" mode to avoid breaking existing installations, but administrators are strongly encouraged to turn these to enforcing mode in production. 
 +  * VuFind now supports [[development:plugins:captcha_handlers|CAPTCHA plug-ins]], maintaining the pre-existing ReCaptcha support while making it possible to use alternative mechanisms for blocking automated agents. See [[https://github.com/vufind-org/vufind/pull/1574|pull request #1574]] for additional details. 
 +  * ArchivesSpace integration (support for ingesting Dublin Core records harvested from ArchivesSpace over OAI-PMH; see [[https://github.com/vufind-org/vufind/pull/1623|pull request #1623]]). 
 +  * Improved ILS drivers: the FOLIO driver is now production-ready, and the new KohaRest driver provides richer support for Koha (compatible with Koha 20.05+ using the [[https://github.com/natlibfi/koha-plugin-rest-di|koha-plugin-rest-di]] plugin). 
 +  * When using the optional link shortener feature, you can now configure how shortlinks redirect to full URLs (HTML-based, header-based, or conditional URL-length-based redirection). See [[https://github.com/vufind-org/vufind/pull/1533|pull request #1533]]. 
 +  * VuFind's integration with EBSCO Discovery Service has been significantly improved, with a large number of bug fixes and added support for citation and export functionality. 
 +  * New [[development:plugins:view_helpers|view helpers]] ("slot" and "parentTemplate" / "templatePath") make it easier to extend and customize core templates. See [[https://github.com/vufind-org/vufind/pull/1454|pull request #1454]] and [[https://github.com/vufind-org/vufind/pull/1458|pull request #1458]] for details. 
 +  * Custom [[configuration:feedback|Feedback Forms]] now support help text both before and after form elements through new pre/post help configuration settings. 
 +  * Unpaywall DOI links now include both PDF and non-PDF resources (previously, only PDFs were linked). 
 +  * It is now possible to obtain links from multiple DOI handlers (either in sequence or merged together); see [[https://github.com/vufind-org/vufind/pull/1560|pull request #1560]]. 
 +  * You can now choose between extra-short and more private short links via the url_shortener_key_type setting in config.ini; see [[https://github.com/vufind-org/vufind/pull/1549|pull request #1549]] for details. 
 +  * VuFind's [[development:code_generators#creating_new_plugins|plugin generator]] can now build controllers, controller plugins, and Symfony console commands. 
 +  * The NoILS driver can now extract data from more than one MARC field at a time (for displaying status/call number information). See [[https://github.com/vufind-org/vufind/pull/1622|pull request #1622]]. 
 +  * VuFind's [[development:apis|API]] now offers access to the secondary Solr index configurable through Search2.ini as well as the website index. 
 +  * Support routines have been developed for indexing geographic data from dc:coverage fields in XML records; it may be optionally turned on in the DSpace indexing example. See [[[[https://github.com/vufind-org/vufind/pull/1465|pull request #1465]] for details. 
 +  * In VuFind's browse module, the display order of browse options is now controlled by the order of configuration settings in the [Browse] section of [[configuration:files:config.ini]]. 
 +  * VuFind's Mailer class now supports multi-part messages (though this capability is not being used in the core code yet). See [[https://github.com/vufind-org/vufind/pull/1610|pull request #1610]] for details. 
 +  * The util/scssBuilder command line utility has been added for users who wish to use SCSS instead of the default LESS for building VuFind's CSS. 
 +  * VuFind now sets the SameSite attribute on cookies for improved browser compatibility; see [[https://github.com/vufind-org/vufind/pull/1664|pull request #1664]]. 
 + 
 +Possible backward compatibility breaks: 
 + 
 +  * :!: Be sure to run a database upgrade to reflect table changes (see also the [[development:architecture:database_schema#release_70|database changelog]]); if you are using the shortlinks feature, be sure to run the web-based upgrade even if you are using PostgreSQL to back-fill hashes properly. 
 +  * :!: The Solr schema has changed to remove the deprecated recordtype field, so records should be reindexed after an upgrade. See the [[development:architecture:solr_index_schema#changelog|index schema changelog]] for more details. 
 +  * :!: VuFind now requires PHP 7.2 or newer; please ensure you have a compatible version installed before upgrading. 
 +  * :!: Zend Framework has become Laminas; this upgrade has caused significant changes throughout the code because of class and package name changes. You should update your local code to match. See [[https://github.com/vufind-org/vufind/pull/1537/|pull request #1537]] for details. 
 +  * :!: The Laminas\Console component has been deprecated, so all command line tools have been migrated to use Symfony\Console instead; see [[https://github.com/vufind-org/vufind/pull/1571|pull request #1571]] and the [[https://blog.library.villanova.edu/2020/04/23/vufind-moving-from-laminasconsole-to-symfonyconsole/|console migration blog post]] for more details. 
 +  * :!: The ZfcRbac module has been replaced with LmcRbacMvc to reflect the Laminas migration; custom authentication code may need minor adjustments to reflect the namespace change and the switch of the configuration key from zfc_rbac to lmc_rbac. See [[https://github.com/vufind-org/vufind/pull/1657|pull request #1657]] for details. 
 +  * :!: VuFind's default Solr port has changed from 8080 to 8983, to better reflect Solr best practices and to reduce port conflicts with other applications; it can easily be [[administration:security#changing_the_solr_port_number|changed back]] as needed. 
 +  * :!: As noted above, you are strongly encouraged to configure a [[administration:security:content_security_policy|content security policy]] for improved security. Note that adjustments to local custom themes may be needed to conform to security requirements; for example, Javascript event attributes (onclick, etc.) should not be used, and all scripts should be loaded through the Laminas headScript or inlineScript helpers instead of with hand-written script tags. 
 +  * :!: If you are using ReCaptcha, several configuration settings have been renamed; the automated configuration updates through the web-based upgrade tool will take care of this, but if you are using a different mechanism to upgrade, you may need to make some adjustments to config.ini; see [[https://github.com/vufind-org/vufind/pull/1574|pull request #1574]] for details. 
 +  * :!: VuFind's session handler code has been significantly refactored to improve extensibility and testability; see [[https://github.com/vufind-org/vufind/pull/1506|pull request #1506]] for details. If you have built a custom session handler, it will likely need to be adjusted; otherwise, this should not impact you. 
 +  * :!: VuFind's jQuery version has been upgraded from 2.1.1 to 3.5.1; if you have custom jQuery code, you should double-check its compatibility. 
 +  * :!: Several templates have been rewritten to use the slot view helper instead of view variables, improving readability and extensibility; if you have extended these templates yourself, the code may need to be adjusted. See [[https://github.com/vufind-org/vufind/pull/1454|pull request #1454]] details. 
 +  * :!: Support for Amazon cover images and reviews has been removed; the ZendService\Amazon library has been deprecated, and there was insufficient demand to take the time to port the code to a new library. If you need Amazon support, please open a new [[https://vufind.org/jira|JIRA]] ticket. 
 +  * :!: The \VuFind\Search\Base\Params::getFilters() method, which was deprecated in release 6.1 (see [[https://github.com/vufind-org/vufind/pull/1489|pull request #1489]]), has now been completely removed; use \VuFind\Search\Base\Params::getRawFilters() instead. 
 +  * :!: The constructor signature of the \VuFindTheme\Initializer has been changed so that it can now optionally accept a service container instead of an MVC event object; if you have subclassed the Initializer, you will have to adjust your method signature to match. See [[https://github.com/vufind-org/vufind/pull/1600|pull request #1600]] for details. 
 +  * :!: The \VuFindSearch\Backend\Eds\Zend2 class has been renamed to \VuFindSearch\Backend\Eds\Connector to prevent Laminas-related confusion; this should only impact you if you have made low-level changes to the EDS integration. See [[https://github.com/vufind-org/vufind/pull/1546|pull request #1546]]. 
 +  * :!: The sitemap generator now uses the search service instead of direct access to the Solr connector; to support this, the constructor signature of \VuFind\Sitemap\Generator has changed, and the service is now constructed using a factory instead of hard-coded controller logic. If you have customized any of this, adjustments may be needed; see [[https://github.com/vufind-org/vufind/pull/1486|pull request #1486]]. 
 +  * :!: The way feedback forms do text translation has been refactored; if you have customized this code, you may need to adjust to match. See [[https://github.com/vufind-org/vufind/pull/1565|pull request #1565]]. 
 +  * :!: AJAX item status loading has been improved and refactored; in the unlikely event that you have customized or extended this Javascript code, you may need to make adjustments. See [[https://github.com/vufind-org/vufind/pull/1663|pull request #1663]]. 
 +  * :!: Because score values are never used in core code (except when dumped out in non-MARC staff view tabs), the default field list retrieved from Solr has been changed from "*,score" to simply "*". There is now a default_record_fields setting in searches.ini (and other equivalent Solr backend configurations) which can be used to customize the field list. See [[https://github.com/vufind-org/vufind/pull/1568/files|pull request #1568]] for details. 
 +  * :!: The SierraRest ILS driver now defaults to API version 5 instead of API version 3 to reflect deprecations in the Sierra platform. See [[https://github.com/vufind-org/vufind/pull/1659|pull request #1659]] for details. 
 +  * :!: Some internals of the Primo Central integration have changed slightly; see [[https://github.com/vufind-org/vufind/pull/1653|pull request #1653]]. 
 +  * The EBSCO Discovery Service integration now uses POST instead of GET for search API requests; the legacy GET behavior can still be accessed through an EDS.ini setting. See [[https://github.com/vufind-org/vufind/pull/1627|pull request #1627]] for details. 
 +  * The \VuFind\RecordTab\TabManager::zendConfig property has been renamed to legacyConfig to prevent Laminas-related confusion; because this property is only used for accessing obsolete configuration settings, the impact of this change is expected to be minimal... but if you have customized the TabManager, you should check for issues. See [[https://github.com/vufind-org/vufind/commit/46e10504b90da88d0b4673a085b19941088f23b4|this commit]] for details. 
 + 
 +===== Release 6.1.2 - coming 7/13/2020 ===== 
 + 
 +  * Minor bug fix / improved accessibility release. 
 +  * :!: Note: when using this release, you may see a warning about MySQL SSL configuration while indexing MARC records; this is a side effect of improved MySQL 8 compatibility, but it is harmless. MySQL SSL configuration will be addressed in more detail in a future release; see [[https://vufind.org/jira/browse/VUFIND-1395|VUFIND-1395]]. 
 + 
 +===== Release 6.1.1 - 3/16/2020 ===== 
 + 
 +  * Minor bug fix / improved accessibility release. 
 + 
 +===== Release 6.1 - 2/3/2020 =====
  
 New features: New features:
Line 11: Line 73:
   * Users can now change their email addresses in their accounts (though this feature is disabled by default -- see the config.ini change_email setting and [[https://github.com/vufind-org/vufind/pull/1401|pull request #1401]] for details).   * Users can now change their email addresses in their accounts (though this feature is disabled by default -- see the config.ini change_email setting and [[https://github.com/vufind-org/vufind/pull/1401|pull request #1401]] for details).
   * The filter interface changes introduced in release 6.0 have been further improved, making the user experience more consistent.   * The filter interface changes introduced in release 6.0 have been further improved, making the user experience more consistent.
-  * Added "Email" authentication method to allow login by receiving a link in an email (see [[https://github.com/vufind-org/vufind/pull/1409|pull request #1409]]).+  * Added "Email" authentication method to allow login by receiving a link in an email (see [[https://github.com/vufind-org/vufind/pull/1409|pull request #1409]] and [[https://github.com/vufind-org/vufind/pull/1520|pull request #1520]]).
   * Added "PasswordAccess" authentication method to allow login using a single credential rather than a username/password combination (see [[https://github.com/vufind-org/vufind/pull/1394|pull request #1394]]).   * Added "PasswordAccess" authentication method to allow login using a single credential rather than a username/password combination (see [[https://github.com/vufind-org/vufind/pull/1394|pull request #1394]]).
   * Added "RecommendLinks" recommendation module, offering a simple mechanism for displaying a static link list.   * Added "RecommendLinks" recommendation module, offering a simple mechanism for displaying a static link list.
 +  * You can now embed meta tags for Google Scholar and other services by configuring metadata.ini (see [[https://github.com/vufind-org/vufind/pull/1529|pull request #1529]] for details).
   * It is now possible to limit site permissions on a global or controller-specific basis through configuration files, making it easier to manage protected content. See [[https://github.com/vufind-org/vufind/pull/1395|pull request #1395]] for details.   * It is now possible to limit site permissions on a global or controller-specific basis through configuration files, making it easier to manage protected content. See [[https://github.com/vufind-org/vufind/pull/1395|pull request #1395]] for details.
   * Improved support for running VuFind behind a reverse proxy (such as Apache's mod_proxy); see [[https://github.com/vufind-org/vufind/pull/1429|pull request #1429]] for details.   * Improved support for running VuFind behind a reverse proxy (such as Apache's mod_proxy); see [[https://github.com/vufind-org/vufind/pull/1429|pull request #1429]] for details.
Line 25: Line 88:
   * The OAI-PMH Server now supports a new "delete_lifetime" setting to expire old deleted records, preventing them from slowing down harvests (see [[https://github.com/vufind-org/vufind/pull/1496|pull request #1496]]).   * The OAI-PMH Server now supports a new "delete_lifetime" setting to expire old deleted records, preventing them from slowing down harvests (see [[https://github.com/vufind-org/vufind/pull/1496|pull request #1496]]).
   * Added Croatian and Hindi language support to the user interface.   * Added Croatian and Hindi language support to the user interface.
 +  * Added support for ISMNs (International Standard Music Numbers) and National Bibliography Numbers to the cover image loader (see [[https://github.com/vufind-org/vufind/pull/1451|pull request #1451]]).
   * Introduced the [[https://github.com/wikimedia/composer-merge-plugin|Wikimedia Composer Merge Plugin]] to help developers add dependencies to local VuFind instances more easily. This has no impact on end users; see [[https://github.com/vufind-org/vufind/pull/1425|pull request #1425]] for more details.   * Introduced the [[https://github.com/wikimedia/composer-merge-plugin|Wikimedia Composer Merge Plugin]] to help developers add dependencies to local VuFind instances more easily. This has no impact on end users; see [[https://github.com/vufind-org/vufind/pull/1425|pull request #1425]] for more details.
   * VuFind's controllers and controller plugins now respect the same "-aware" interfaces as other VuFind plugins, making it possible to auto-inject loggers, etc. (see [[https://github.com/vufind-org/vufind/pull/1441|pull request #1441]]).   * VuFind's controllers and controller plugins now respect the same "-aware" interfaces as other VuFind plugins, making it possible to auto-inject loggers, etc. (see [[https://github.com/vufind-org/vufind/pull/1441|pull request #1441]]).
   * The "Search2" secondary Solr backend (see [[configuration:combining_search_types|Combining Search Types]]) is now fully compatible with [[indexing:hierarchies_and_collections|Hierarchies and Collections]]; see [[https://github.com/vufind-org/vufind/pull/1478|pull request #1478]].   * The "Search2" secondary Solr backend (see [[configuration:combining_search_types|Combining Search Types]]) is now fully compatible with [[indexing:hierarchies_and_collections|Hierarchies and Collections]]; see [[https://github.com/vufind-org/vufind/pull/1478|pull request #1478]].
   * Support for profiling (a tool for developers) has been updated; see [[https://github.com/vufind-org/vufind/pull/1487|pull request #1487]].   * Support for profiling (a tool for developers) has been updated; see [[https://github.com/vufind-org/vufind/pull/1487|pull request #1487]].
-  * Improved PHP 7.3 compatibility.+  * Improved PHP 7.3 and 7.4 compatibility.
  
 Possible backward compatibility breaks: Possible backward compatibility breaks:
Line 36: Line 100:
   * :!: The new email login capability adds some new features to the authentication logic along with some minor refactoring; if you have custom authentication code, you should review [[https://github.com/vufind-org/vufind/pull/1409|pull request #1409]] to be sure you are not impacted by it.   * :!: The new email login capability adds some new features to the authentication logic along with some minor refactoring; if you have custom authentication code, you should review [[https://github.com/vufind-org/vufind/pull/1409|pull request #1409]] to be sure you are not impacted by it.
   * :!: Templates related to search filters have been changed significantly to fix a bug introduced in release 6.0 and to improve the revised functionality; if you have customized the filters.phtml template, or a template that includes filters.phtml, you should adjust to match the changes in [[https://github.com/vufind-org/vufind/pull/1482|pull request #1482]], [[https://github.com/vufind-org/vufind/pull/1499|pull request #1499]] and [[https://github.com/vufind-org/vufind/pull/1500|pull request #1500]] (plus this subsequent [[https://github.com/vufind-org/vufind/commit/1be2ac19500da9c5491087e41e4d98d0895aa0ff|bug fix commit]]).   * :!: Templates related to search filters have been changed significantly to fix a bug introduced in release 6.0 and to improve the revised functionality; if you have customized the filters.phtml template, or a template that includes filters.phtml, you should adjust to match the changes in [[https://github.com/vufind-org/vufind/pull/1482|pull request #1482]], [[https://github.com/vufind-org/vufind/pull/1499|pull request #1499]] and [[https://github.com/vufind-org/vufind/pull/1500|pull request #1500]] (plus this subsequent [[https://github.com/vufind-org/vufind/commit/1be2ac19500da9c5491087e41e4d98d0895aa0ff|bug fix commit]]).
 +  * :!: Low-level filtering/validation of parameters was introduced by [[https://github.com/vufind-org/vufind/pull/1518|pull request #1518]]. This should have no impact on normal activity within the system, but if you encounter unexpected parameter processing behavior, you should investigate these changes.
   * :!: The itemLimit setting used for paginating holdings in some ILS drivers (Alma/Demo) has been moved from the "Holds" configuration to the more appropriate "Holdings" configuration. If you have taken advantage of this feature in a custom driver or if you have changed it in your driver's .ini file, you should move the setting -- see [[https://github.com/vufind-org/vufind/pull/1463|PR #1463]].   * :!: The itemLimit setting used for paginating holdings in some ILS drivers (Alma/Demo) has been moved from the "Holds" configuration to the more appropriate "Holdings" configuration. If you have taken advantage of this feature in a custom driver or if you have changed it in your driver's .ini file, you should move the setting -- see [[https://github.com/vufind-org/vufind/pull/1463|PR #1463]].
 +  * :!: To fix a minor bug, the $messages property of VuFind\Form\Form has been redefined -- it now contains raw, untranslated messages instead of fully translated messages (see [[https://github.com/vufind-org/vufind/pull/1534|pull request #1534]]). If you have extended the class and added values to this property, you may need to make adjustments to avoid double translation.
   * Some minor improvements have been made to item status display logic; if you notice an unexpected change in behavior, see [[https://github.com/vufind-org/vufind/pull/1466|pull request #1466]] for details.   * Some minor improvements have been made to item status display logic; if you notice an unexpected change in behavior, see [[https://github.com/vufind-org/vufind/pull/1466|pull request #1466]] for details.
   * Some changes to record collection creation have been made for performance reasons, but they should not change behavior; see [[https://github.com/vufind-org/vufind/pull/1488|#1488]] for details.   * Some changes to record collection creation have been made for performance reasons, but they should not change behavior; see [[https://github.com/vufind-org/vufind/pull/1488|#1488]] for details.
Line 45: Line 111:
   * The HierarchicalFacetHelper::sortFacetList method's signature has changed slightly, but in a backward-compatible way. In the very unlikely event that you have extended this service, you may need to make adjustments. See [[https://github.com/vufind-org/vufind/pull/1389|pull request #1389]].   * The HierarchicalFacetHelper::sortFacetList method's signature has changed slightly, but in a backward-compatible way. In the very unlikely event that you have extended this service, you may need to make adjustments. See [[https://github.com/vufind-org/vufind/pull/1389|pull request #1389]].
   * The way the VuFind theme system overrides Zend Framework functionality has been simplified significantly (see [[https://github.com/vufind-org/vufind/pull/1436|pull request #1436]]), but there should be no functional differences.   * The way the VuFind theme system overrides Zend Framework functionality has been simplified significantly (see [[https://github.com/vufind-org/vufind/pull/1436|pull request #1436]]), but there should be no functional differences.
 +
 +[[changelog:release-6.1|Press Release]]
 ===== Release 6.0.1 - 9/16/2019 ===== ===== Release 6.0.1 - 9/16/2019 =====
  
Line 718: Line 786:
   * New [[development:architecture:search_service|search service]] architecture.   * New [[development:architecture:search_service|search service]] architecture.
   * Support for [[indexing:hierarchies_and_collections|hierarchies and collections]] (consistent with the 1.4 release).   * Support for [[indexing:hierarchies_and_collections|hierarchies and collections]] (consistent with the 1.4 release).
-  * Upgraded to newer versions of [[indexing:solrmarc|SolrMarc]] and [[development:architecture:zend_framework|Zend Framework 2]].+  * Upgraded to newer versions of [[indexing:solrmarc|SolrMarc]] and [[development:architecture:laminas|Zend Framework 2]].
   * Security improvements (safer password storage, optional login requirement before emailing).   * Security improvements (safer password storage, optional login requirement before emailing).
   * New "MultiBackend" ILS driver for connecting multiple ILSes to a single VuFind instance.   * New "MultiBackend" ILS driver for connecting multiple ILSes to a single VuFind instance.
Line 730: Line 798:
 ===== Release 2.0beta - 10/1/2012 ===== ===== Release 2.0beta - 10/1/2012 =====
  
-  * Switched from Zend Framework 1.x to [[development:architecture:zend_framework|Zend Framework 2]].+  * Switched from Zend Framework 1.x to [[development:architecture:laminas|Zend Framework 2]].
   * More [[http://vufind.org/downloads.php|download options]] than previous releases (tar.gz/zip/deb).   * More [[http://vufind.org/downloads.php|download options]] than previous releases (tar.gz/zip/deb).
   * Improved installation process for [[installation:installing_multiple_instances|multi-site configurations]].   * Improved installation process for [[installation:installing_multiple_instances|multi-site configurations]].
changelog.txt · Last modified: 2024/03/21 14:57 by demiankatz