eXist-db v3.3.0

Release Notes

v3.3.0 - July 2, 2017

We are happy to announce the release of eXist-db v3.3.0. This is a minor release, which introduces a few small features and addresses a number of issues.

New Features

  • Adaptive serialization mode as defined by XQuery 3.1.
  • A DSL which simplifies the definition of functions, function signatures and their parameters for building extension functions.
  • An extension mechanism for extension modules to provide valid XPath/XQuery error codes.
  • An eXist-db TestKit (exist-testkit.jar) which can be used by other projects (e.g. extension module) to execute tests against eXist-db.
  • Added `ExistOutputKeys.JSONIGNOREWHITESPACETEXTNODES` to discard white-space text nodes when serializing XML/XDM to JSON.

Bug Fixes

  • Fixed the XQuery lookup operator ? to return the correct result with regards to empty values.
  • WebDAV now uses the default configuration for serializing XML.
  • Fixed a regression in the xmldb:restore Ant task.
  • xs:base64Binary and xs:hexBinary previously now set the correct srcOffset in the underlying stream when calling CachingFilterInputStream#skip.
  • fn:replace arguments not now correctly cleared when dynamically called.
  • Fixed Lucene inline elements in case of not yet applied white-space.
  • Improved the AppBundler for the MacOS .app package.
    • Now requires Java 8.
    • Renamed the running process from "JavaAppLauncher" to "eXist-JavaAppLauncher" to make things clearer.

Clean Up and Refactoring

  • Update to the Java Admin Client to use the latest version of RSyntaxArea (2.6.1).
  • Update Ant from 1.9.7 to 1.10.1.
  • ... and many more

Backwards Compatibility

  • eXist-db v3.3.0 is backwards binary-compatible as far as v3.0, but not with earlier versions. Users upgrading from previous versions should perform a full backup and restore to migrate their data.

Downloading This Version

eXist-db v3.3.0 is available for download from Bintray. Maven artifacts for eXist-db v3.3.0 are available from our mvn-repo. Mac users of the Homebrew package repository will be able to install and upgrade shortly; an announcement will be made on the exist-open mailing list.

eXist-db v3.2.0

Release Notes

v3.2.0 - May 2, 2017

We are happy to announce the release of eXist-db v3.2.0. This is a minor release, which introduces a few small features and addresses a number of issues.

New Features

  • Added an IPRange Security Realm, to authorize users by IP address only. (Disabled by default)
  • Added --forking and --pidfile options to startup scripts
  • Added configuration options to $EXIST_HOME/webapp/WEB-INF/web.xml to disable XQuery and XUpdate execution via submission to the RESTServer.
  • Added the XPath 3.1 function fn:load-xquery-module
  • Added the XQuery function xmldb:find-last-modified-until

Performance Improvements

  • Small improvements to lock mode use; resulting in more shared locks, and less exclusive locks.
  • Optimised DefaultDocumentSet#contains and DefaultDocumentSet#equals for DefaultDocumentSet comparisons

Critical Bug Fixes

  • Fixed the following-sibling axis so that it also correctly works with names. e.g. $items//b/following-sibling::a
  • DataBackup scheduled tasks now includes all .dbx files and indexes
  • Fixed missing transaction commit in EmbeddedUpload
  • Several locking fixes, including lock acquire/release leaks

Bug Fixes

  • Fixed Lucene match highlighting of ignored nodes; when the ignored node had the same name as the indexed node.
  • Fixed the implementation of org.w3c.dom.Node#isSameNode for persistent nodes; enables better compatibility when using database documents with Saxon.
  • Fixed the reported line numbers when there are newlines in string literals or constructors
  • Java Admin Client again correctly handles --parse or -p argument
  • Namespace Constructor in Computed Element Constructor now works correctly
  • Fixes to install and uninstall for the service wrapper (YAJSW) with systemd
  • Fixes to resolving references in the Configurator
  • Re-implement CollectionConfiguration#triggerRegistered; fixing the xquery-versioning-module
  • DefaultDocumentSet#contains no longer always returns true
  • Avoid implicit conversion of unicode x160 as numerical entity   when serializing XML

Clean Up and Refactoring

  • Corrected the function documentation of xmldb:last-modified-since
  • Disabled sequential token generation in the PersistentLoginModule
  • Disabled auto-deployment of EXPath packages when running tests; faster test suite
  • Switched from MBean to MXBeand for improved JMX client support
  • Further legacy code cleanup to Java 8 syntax
  • Upgraded 3rd party libraries:
    • log4j2 2.8.2
    • j8fu 1.4.1
  • Generalised the MacOS package signing targets in the build system
  • ... and many more

Backwards Compatibility

  • eXist-db v3.2.0 is backwards binary-compatible as far as v3.0, but not with earlier versions. Users upgrading from previous versions should perform a full backup and restore to migrate their data.

Downloading This Version

eXist-db v3.2.0 is available for download from Bintray. Maven artifacts for eXist-db v3.2.0 are available from our mvn-repo. Mac users of the Homebrew package repository will be able to install and upgrade shortly; an announcement will be made on the exist-open mailing list.

eXist-db v3.1.1

Release Notes

v3.1.1 - March 22, 2017

We are happy to announce the release of eXist-db v3.1.1. This is a bug fix release, which addresses a number of issues and closes two memory leaks. The most important changes are:

  • fixed command line parameters for backup/restore and the Java admin client (partially broken in 3.1.0)
  • closed memory leak in XQuery map constructor
  • closed memory leak preventing memory used for accessing binary resources in XQuery being freed
  • added missing dependencies for YAJSW when installing as a System-V service
  • corrected fn:doc-available() to return false(), not FODC0005, when the remote resource does not return a document node
  • prevented an NPE when an account or a group can't be found by id due to storage corruption or a missing account or group

In addition to eXist-db itself, this release includes updated versions of a number of the bundled applications: Documentation (v0.4.8), Monitoring and Profiling AKA "Monex" (v0.9.7), Shared Resources (v0.4.2). Other applications updated since the last release of eXist-db include Demo Apps (v0.4.0), Public Application Repository (v0.6.0), and XQuery Versioning Module (v1.1.2). The updated versions and their release notes are all available via Dashboard > Package Manager or from the Public Application Repository.

Backwards Compatibility

  • eXist-db v3.1.1 is binary-compatible with v3.0 and v3.1.0, but not with previous versions (v2.x). Users upgrading from pre-3.0 versions should perform a full backup and restore to migrate their data.
  • eXist-db v3.1.1 requires Java 8.

Downloading This Version

eXist-db v3.1.1 is available for download from the eXist-db Releases page on Bintray. (The old download page on Sourceforge is no longer updated.) Maven artifacts for eXist-db v3.1.1 are available from our mvn-repo repository. For macOS users of the Homebrew package manager, eXist-db v3.1.1 is already available.

eXist-db v3.1.0 available

Release Notes

v3.1.0 - March 7, 2017

We are very pleased to announce the release of eXist-db v3.1.0.

We encourage everyone to upgrade to this latest release. It is the culmination of changes since the release of v3.0 26 days ago, on February 9, 2017, and brings new features and numerous improvements, detailed below. Most notably of these: eXist-db releases now follow the "semantic versioning" (semver) convention; it adds support for XQuery 3.1 features and improves those already supported; and shutdown and package management were made more robust.

New Features

  • Implemented the Arrow Operator (=>) from XQuery 3.1
  • Implemented String Constructors from XQuery 3.1
  • Implemented fn:has-children, fn:innermost, and fn:outermost functions from XQuery 3.1
  • Extended the Range Index conditions feature

Performance Improvements

  • FLWOR where clauses are no longer evaluated for empty sequences, resulting in significant speed increase

Critical Bug Fixes

  • Fixed the shutdown timer
  • Improved EXPath Package repository stability in cases of failures or corruption
  • Replaced some additional read locks with write locks where required
  • AuditTrailSessionListener now releases locks correctly
  • Variable names without namespace prefix are now correctly in no namespace

Clean Up and Refactoring

  • Refactored many tests
  • Simplified the sql:execute function and corrected the encoding of its results
  • Function definitions are no longer shared between deferred function calls
  • All FLWOR clauses except where clauses are now pre-evaluated
  • Added tests for range index conditions
  • IntelliJ, NetBeans, and Eclipse configuration files cleaned up
  • Map and Array constructors are now inlined in grammar
  • Improved the Lookup Operator (?) for postfix expressions with Maps from XQuery v3.0
  • Continued clean up of eXist-db's Test Suite
  • Added integration tests to ensure EXPath Package functionality and further support the trimming of the core
  • Extended use of SystemExitCodes instead of explicit integers
  • Improved the service wrapper (yajsw) introduced in v3.0
  • Made the ft:query-field only depend on context sequence
  • Removed support for Launch4j exe creation
  • Fixed short form of shutdown arguments
  • Upgraded 3rd party libraries:
    • log4j2
    • Switched to use Jargo instead of defunct Excalibur (and Guava)
  • ... and many more

Backwards Compatibility

  • eXist-db v3.1.0 is binary-compatible with v3.0 but not with previous versions. Users upgrading from previous versions should perform a full backup and restore to migrate their data.
  • eXist-db v3.1.0 and v3.0 require Java 8.
  • Due to the legacy Full Text Index being removed, the text XQuery module (http://exist-db.org/xquery/text) has also been removed. Users should now rely on the fn:analyze-string function, e.g.:
    • Instead of using text:groups(), use analyze-string()//fn:group,
    • Instead of text:filter("apparat", "([pr])"), use analyze-string("apparat", "([pr])")//fn:match/string()
  • There have been changes to some internal APIs, e.g., XQueryService has been moved from DBBroker to BrokerPool.
  • EXPath Packages that incorporate Java libraries may no longer work with eXist-db v3.1.0 and may need to be recompiled for our API changes; packages should now explicitly specify the eXist-db versions that they are compatible with.

Downloading This Version

eXist-db v3.1.0 is available for download from Bintray. (The older Sourceforge download page is no longer updated.) Maven artifacts for eXist-db v3.1.0 are available from our mvn-repo. Mac users of the Homebrew package repository will be able to install and upgrade shortly; an announcement will be made on the exist-open mailing list.

Development

All of the changes that went into eXist-db v3.1.0 can be viewed via this link on GitHub.

It is our great pleasure to announce the official release of the TEI Publisher, an open source app for eXist-db offering single-source publishing without writing any code. Currently TEI Publisher works out of the box with TEI documents (hence its name) but it can be customized to accommodate any XML schema.

Publishing any TEI content requires only few simple steps:

  • Upload the content into eXist
  • Customize the appearance via TEI ODD file
  • Generate a robust standalone application

Apps generated with TEI Publisher work well across devices and include features like page by page browsing, search and cross-media export or side-by-side text and image display. This approach has been applied to a range of commercial and academic projects, and has proven very successful in terms of development time, maintenance cost, performance and scalability, an outstanding example being the Foreign Relations of the United States series at the US Department of State.

TEI Publisher builds upon an efficient implementation of the TEI Processing Model, which has become a standard part of TEI Consortium’s recommendations, so customising the appearance of the text is done in TEI XML. No media specific stylesheets are required since rendition choices are transparently translated into different media types like HTML, XSL-FO, LaTeX, or ePUB.

TEI Publisher empowers the editors, offering rapid publishing across media while assuring full control over editorial decisions. For developers, TEI Publisher heavily reduces the amount of custom code required by typical digital edition. Transformations can be customized just by tweaking a single processing specification expressed in TEI ODD and changes are consistently carried through into all output formats. Highly formulaic and easily readable TEI ODD processing models save thousands of lines of handwritten transformations. Typically less than a few hundred lines of ODD instructions are sufficient to cover the needs even for projects of broad scope and volume, sustaining substantial everyday traffic. This means roughly ten-fold decrease in code size alone, not mentioning drastic improvements in maintenance.

/exist/apps/wiki/blogs/eXist/sebastian.jpg
Sebastian Rahtz sketching Wolfgang Meier's proposal for Processing Model extension
TEI Publisher is a result of serendipitous chain of events started with the TEI Processing Model developed by TEI Simple project. TEI Simple, funded by a generous grant from the Andrew W. Mellon Foundation, with substantial contributions from the Northwestern University, University of Nebraska-Lincoln, the University of Oxford, and the TEI Consortium was the work of the late Sebastian Rahtz and Martin Mueller with substantial contributions from James Cummings, Brian Pytlik Zillig, and Magdalena Turska. The integration of the Processing Model into the TEI infrastructure has been possible due to the efforts of the TEI Council with notable input of Lou Burnard. Implementation of the TEI Processing Model in XQuery has been the work of Wolfgang Meier and so was later the development of the TEI Publisher (initially under the name of TEI Processing Model Toolbox), made possible by strong support from eXist Solutions.

Having its roots in the TEI community, TEI Publisher is obviously well-suited to publishing TEI documents, but by no means are its applications limited to documents encoded in TEI (or TEI Simple) schema. Thanks to the universality of the Processing Model, the TEI Publisher can be made to work with any XML vocabulary as long as default processing models are defined for it. Moreover the processing model library can be used independently of the TEI Publisher app.

TEI Publisher is a free software released under GPLv3 licence. It requires eXist-db v3.0 and can be installed from the Dashboard via Package Manager.

We welcome and strongly encourage other contributions, both via community engagement and pull requests as well as financial support and other forms of cooperation. Ideas for future developments include:

  • preconfigured app templates to cover specific TEI use cases like EpiDoc, epistolary corpora or manuscripts, as well as support for different layouts (e.g. facsimile display). We are looking for your suggestions and contributions in this area,
  • more output options: we would welcome some TeX specialists to improve the current LaTeX output mode. There are also concrete plans concerning an interface to indesign,
  • a visual ODD editor to facilitate creation of processing model instructions,
  • extension for the TEI processing model library to transform other XML languages.

We hope you will find this project interesting and useful and encourage you to visit the project website and try it out together with new eXist-db release.