[
{
"path": ".github/workflows/gradle-wrapper-validation.yml",
"content": "name: \"Validate Gradle Wrapper\"\non: [push, pull_request]\n\njobs:\n validation:\n name: \"Validation\"\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v2\n - uses: gradle/wrapper-validation-action@v1\n"
},
{
"path": ".gitignore",
"content": "\n# gradle/build files\nbuild\n.gradle\n/framework/dependencies\n\n# build generated files\n/moqui*.war\n/Save*.zip\n\n# runtime directory (separate repository so ignore directory entirely)\n/runtime\n/execwartmp\n/docker/runtime\n/docker/db\n/docker/elasticsearch/data/nodes\n/docker/opensearch/data/nodes/*\n/docker/opensearch/data/*.conf\n!/docker/opensearch/data/nodes/README\n/docker/acme.sh\n/docker/nginx/conf.d\n/docker/nginx/vhost.d\n/docker/nginx/html\n## Do not want to accidentally commit production certificates https://www.theregister.com/2024/07/25/data_from_deleted_github_repos/\n/docker/certs\n!/docker/certs/moqui1.local.*\n!/docker/certs/moqui2.local.*\n!/docker/certs/moqui.local.*\n!/docker/certs/README\n\n# IntelliJ IDEA files\n.idea\nout\n*.ipr\n*.iws\n*.iml\n\n# Eclipse files (and some general ones also used by Eclipse)\n.metadata\nbin\ntmp\n*.tmp\n*.bak\n*.swp\n*~.nib\nlocal.properties\n.settings\n.loadpath\n\n# NetBeans files\nnbproject/private\nnbbuild\n.nb-gradle\nnbdist\nnbactions.xml\nnb-configuration.xml\n\n# VSCode files\n.vscode\n\n# Emacs files\n.projectile\n\n# Version managers (sdkman, mise, asdf)\nmise.toml\n.tool-versions\n\n# OSX auto files\n.DS_Store\n.AppleDouble\n.LSOverride\n._*\n\n# Windows auto files\nThumbs.db\nehthumbs.db\nDesktop.ini\n\n# Linux auto files\n*~\n"
},
{
"path": ".travis.yml",
"content": "language: groovy\n\njdk:\n - openjdk11\n\ninstall: true\n\nenv:\n - TERM=dumb\n\nscript:\n - ./gradlew getRuntime\n - ./gradlew load\n - ./gradlew test --info\n\ncache:\n directories:\n - $HOME/.gradle/caches\n - $HOME/.gradle/wrapper\n"
},
{
"path": ".whitesource",
"content": "{\n \"generalSettings\": {\n \"shouldScanRepo\": true\n },\n \"checkRunSettings\": {\n \"vulnerableCheckRunConclusionLevel\": \"failure\"\n },\n \"issueSettings\": {\n \"minSeverityLevel\": \"LOW\"\n }\n}\n"
},
{
"path": "AUTHORS",
"content": "Moqui Framework (http://github.com/moqui/moqui)\n\nThis software is in the public domain under CC0 1.0 Universal plus a\nGrant of Patent License.\n\nTo the extent possible under law, the author(s) have dedicated all\ncopyright and related and neighboring rights to this software to the\npublic domain worldwide. This software is distributed without any\nwarranty.\n\nYou should have received a copy of the CC0 Public Domain Dedication\nalong with this software (see the LICENSE.md file). If not, see\n.\n\n===========================================================================\n\nCopyright Waiver\n\nI dedicate any and all copyright interest in this software to the\npublic domain. I make this dedication for the benefit of the public at\nlarge and to the detriment of my heirs and successors. I intend this\ndedication to be an overt act of relinquishment in perpetuity of all\npresent and future rights to this software under copyright law.\n\nTo the best of my knowledge and belief, my contributions are either\noriginally authored by me or are derived from prior works which I have\nverified are also in the public domain and are not subject to claims\nof copyright by other parties.\n\nTo the best of my knowledge and belief, no individual, business,\norganization, government, or other entity has any copyright interest\nin my contributions, and I affirm that I will not make contributions\nthat are otherwise encumbered.\n\nSigned by git commit adding my legal name and git username:\n\nWritten in 2010-2022 by David E. Jones - jonesde\nWritten in 2021-2026 by D. Michael Jones - acetousk\nWritten in 2014-2015 by Solomon Bessire - sbessire\nWritten in 2014-2015 by Jacopo Cappellato - jacopoc\nWritten in 2014-2015 by Abdullah Shaikh - abdullahs\nWritten in 2014-2015 by Yao Chunlin - chunlinyao\nWritten in 2014-2015 by Jimmy Shen - shendepu\nWritten in 2014-2015 by Dony Zulkarnaen - donniexyz\nWritten in 2015 by Sam Hamilton - samhamilton\nWritten in 2015 by Leonardo Carvalho - CarvalhoLeonardo\nWritten in 2015 by Swapnil M Mane - swapnilmmane\nWritten in 2015 by Anton Akhiar - akhiar\nWritten in 2015-2023 by Jens Hardings - jenshp\nWritten in 2016 by Shifeng Zhang - zhangshifeng\nWritten in 2016 by Scott Gray - lektran\nWritten in 2016 by Mark Haney - mphaney\nWritten in 2016 by Qiushi Yan - yanqiushi\nWritten in 2017 by Oleg Andrieiev - oandreyev\nWritten in 2018 by Zhang Wei - zhangwei1979\nWritten in 2018 by Nirendra Singh - nirendra10695\nWritten in 2018-2023 by Ayman Abi Abdallah - aabiabdallah\nWritten in 2019 by Daniel Taylor - danieltaylor-nz\nWritten in 2020 by Jacob Barnes - Tellan\nWritten in 2020 by Amir Anjomshoaa - amiranjom\nWritten in 2021 by Deepak Dixit - dixitdeepak\nWritten in 2021 by Taher Alkhateeb - pythys\nWritten in 2022 by Zhang Wei - hellozhangwei\nWritten in 2023 by Rohit Pawar - rohitpawar2811\n\n===========================================================================\n\nGrant of Patent License\n\nI hereby grant to recipients of software a perpetual, worldwide,\nnon-exclusive, no-charge, royalty-free, irrevocable (except as stated in\nthis section) patent license to make, have made, use, offer to sell, sell,\nimport, and otherwise transfer the Work, where such license applies only to\nthose patent claims licensable by me that are necessarily infringed by my\nContribution(s) alone or by combination of my Contribution(s) with the\nWork to which such Contribution(s) was submitted. If any entity institutes\npatent litigation against me or any other entity (including a cross-claim\nor counterclaim in a lawsuit) alleging that my Contribution, or the Work to\nwhich I have contributed, constitutes direct or contributory patent\ninfringement, then any patent licenses granted to that entity under this\nAgreement for that Contribution or Work shall terminate as of the date such\nlitigation is filed.\n\nSigned by git commit adding my legal name and git username:\n\nWritten in 2010-2022 by David E. Jones - jonesde\nWritten in 2021-2021 by D. Michael Jones - acetousk\nWritten in 2014-2015 by Solomon Bessire - sbessire\nWritten in 2014-2015 by Jacopo Cappellato - jacopoc\nWritten in 2014-2015 by Yao Chunlin - chunlinyao\nWritten in 2015 by Dony Zulkarnaen - donniexyz\nWritten in 2015 by Swapnil M Mane - swapnilmmane\nWritten in 2015 by Jimmy Shen - shendepu\nWritten in 2015-2016 by Sam Hamilton - samhamilton\nWritten in 2015 by Leonardo Carvalho - CarvalhoLeonardo\nWritten in 2015 by Anton Akhiar - akhiar\nWritten in 2015-2023 by Jens Hardings - jenshp\nWritten in 2016 by Shifeng Zhang - zhangshifeng\nWritten in 2016 by Scott Gray - lektran\nWritten in 2016 by Mark Haney - mphaney\nWritten in 2016 by Qiushi Yan - yanqiushi\nWritten in 2017 by Oleg Andrieiev - oandreyev\nWritten in 2018 by Zhang Wei - zhangwei1979\nWritten in 2018 by Nirendra Singh - nirendra10695\nWritten in 2018-2023 by Ayman Abi Abdallah - aabiabdallah\nWritten in 2019 by Daniel Taylor - danieltaylor-nz\nWritten in 2020 by Jacob Barnes - Tellan\nWritten in 2020 by Amir Anjomshoaa - amiranjom\nWritten in 2021 by Deepak Dixit - dixitdeepak\nWritten in 2021 by Taher Alkhateeb - pythys\nWritten in 2022 by Zhang Wei - hellozhangwei\nWritten in 2023 by Rohit Pawar - rohitpawar2811\n\n===========================================================================\n"
},
{
"path": "LICENSE.md",
"content": "Because of a lack of patent licensing in CC0 1.0 this software includes a\nseparate Grant of Patent License adapted from Apache License 2.0.\n\n===========================================================================\n\nCreative Commons Legal Code\n\nCC0 1.0 Universal\n\nCREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE\nLEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN\nATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS\nINFORMATION ON AN \"AS-IS\" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES\nREGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS\nPROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM\nTHE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED\nHEREUNDER.\n\nStatement of Purpose\n\nThe laws of most jurisdictions throughout the world automatically confer\nexclusive Copyright and Related Rights (defined below) upon the creator\nand subsequent owner(s) (each and all, an \"owner\") of an original work of\nauthorship and/or a database (each, a \"Work\").\n\nCertain owners wish to permanently relinquish those rights to a Work for\nthe purpose of contributing to a commons of creative, cultural and\nscientific works (\"Commons\") that the public can reliably and without fear\nof later claims of infringement build upon, modify, incorporate in other\nworks, reuse and redistribute as freely as possible in any form whatsoever\nand for any purposes, including without limitation commercial purposes.\nThese owners may contribute to the Commons to promote the ideal of a free\nculture and the further production of creative, cultural and scientific\nworks, or to gain reputation or greater distribution for their Work in\npart through the use and efforts of others.\n\nFor these and/or other purposes and motivations, and without any\nexpectation of additional consideration or compensation, the person\nassociating CC0 with a Work (the \"Affirmer\"), to the extent that he or she\nis an owner of Copyright and Related Rights in the Work, voluntarily\nelects to apply CC0 to the Work and publicly distribute the Work under its\nterms, with knowledge of his or her Copyright and Related Rights in the\nWork and the meaning and intended legal effect of CC0 on those rights.\n\n1. Copyright and Related Rights. A Work made available under CC0 may be\nprotected by copyright and related or neighboring rights (\"Copyright and\nRelated Rights\"). Copyright and Related Rights include, but are not\nlimited to, the following:\n\n i. the right to reproduce, adapt, distribute, perform, display,\n communicate, and translate a Work;\n ii. moral rights retained by the original author(s) and/or performer(s);\niii. publicity and privacy rights pertaining to a person's image or\n likeness depicted in a Work;\n iv. rights protecting against unfair competition in regards to a Work,\n subject to the limitations in paragraph 4(a), below;\n v. rights protecting the extraction, dissemination, use and reuse of data\n in a Work;\n vi. database rights (such as those arising under Directive 96/9/EC of the\n European Parliament and of the Council of 11 March 1996 on the legal\n protection of databases, and under any national implementation\n thereof, including any amended or successor version of such\n directive); and\nvii. other similar, equivalent or corresponding rights throughout the\n world based on applicable law or treaty, and any national\n implementations thereof.\n\n2. Waiver. To the greatest extent permitted by, but not in contravention\nof, applicable law, Affirmer hereby overtly, fully, permanently,\nirrevocably and unconditionally waives, abandons, and surrenders all of\nAffirmer's Copyright and Related Rights and associated claims and causes\nof action, whether now known or unknown (including existing as well as\nfuture claims and causes of action), in the Work (i) in all territories\nworldwide, (ii) for the maximum duration provided by applicable law or\ntreaty (including future time extensions), (iii) in any current or future\nmedium and for any number of copies, and (iv) for any purpose whatsoever,\nincluding without limitation commercial, advertising or promotional\npurposes (the \"Waiver\"). Affirmer makes the Waiver for the benefit of each\nmember of the public at large and to the detriment of Affirmer's heirs and\nsuccessors, fully intending that such Waiver shall not be subject to\nrevocation, rescission, cancellation, termination, or any other legal or\nequitable action to disrupt the quiet enjoyment of the Work by the public\nas contemplated by Affirmer's express Statement of Purpose.\n\n3. Public License Fallback. Should any part of the Waiver for any reason\nbe judged legally invalid or ineffective under applicable law, then the\nWaiver shall be preserved to the maximum extent permitted taking into\naccount Affirmer's express Statement of Purpose. In addition, to the\nextent the Waiver is so judged Affirmer hereby grants to each affected\nperson a royalty-free, non transferable, non sublicensable, non exclusive,\nirrevocable and unconditional license to exercise Affirmer's Copyright and\nRelated Rights in the Work (i) in all territories worldwide, (ii) for the\nmaximum duration provided by applicable law or treaty (including future\ntime extensions), (iii) in any current or future medium and for any number\nof copies, and (iv) for any purpose whatsoever, including without\nlimitation commercial, advertising or promotional purposes (the\n\"License\"). The License shall be deemed effective as of the date CC0 was\napplied by Affirmer to the Work. Should any part of the License for any\nreason be judged legally invalid or ineffective under applicable law, such\npartial invalidity or ineffectiveness shall not invalidate the remainder\nof the License, and in such case Affirmer hereby affirms that he or she\nwill not (i) exercise any of his or her remaining Copyright and Related\nRights in the Work or (ii) assert any associated claims and causes of\naction with respect to the Work, in either case contrary to Affirmer's\nexpress Statement of Purpose.\n\n4. Limitations and Disclaimers.\n\n a. No trademark or patent rights held by Affirmer are waived, abandoned,\n surrendered, licensed or otherwise affected by this document.\n b. Affirmer offers the Work as-is and makes no representations or\n warranties of any kind concerning the Work, express, implied,\n statutory or otherwise, including without limitation warranties of\n title, merchantability, fitness for a particular purpose, non\n infringement, or the absence of latent or other defects, accuracy, or\n the present or absence of errors, whether or not discoverable, all to\n the greatest extent permissible under applicable law.\n c. Affirmer disclaims responsibility for clearing rights of other persons\n that may apply to the Work or any use thereof, including without\n limitation any person's Copyright and Related Rights in the Work.\n Further, Affirmer disclaims responsibility for obtaining any necessary\n consents, permissions or other rights required for any use of the\n Work.\n d. Affirmer understands and acknowledges that Creative Commons is not a\n party to this document and has no duty or obligation with respect to\n this CC0 or use of the Work.\n\n\n===========================================================================\n\nGrant of Patent License\n\n\"License\" shall mean the terms and conditions for use, reproduction, and \ndistribution.\n\n\"Licensor\" shall mean the original copyright owner or entity authorized by \nthe original copyright owner that is granting the License.\n\n\"Legal Entity\" shall mean the union of the acting entity and all other \nentities that control, are controlled by, or are under common control with\nthat entity. For the purposes of this definition, \"control\" means (i) the \npower, direct or indirect, to cause the direction or management of such \nentity, whether by contract or otherwise, or (ii) ownership of fifty \npercent (50%) or more of the outstanding shares, or (iii) beneficial \nownership of such entity.\n\n\"You\" (or \"Your\") shall mean an individual or Legal Entity exercising \npermissions granted by this License.\n\n\"Source\" form shall mean the preferred form for making modifications, \nincluding but not limited to software source code, documentation source, \nand configuration files.\n\n\"Object\" form shall mean any form resulting from mechanical transformation\nor translation of a Source form, including but not limited to compiled\nobject code, generated documentation, and conversions to other media types.\n\n\"Work\" shall mean the work of authorship, whether in Source or Object form,\nmade available under the License, as indicated by a copyright notice that\nis included in or attached to the work.\n\n\"Derivative Works\" shall mean any work, whether in Source or Object form, \nthat is based on (or derived from) the Work and for which the editorial \nrevisions, annotations, elaborations, or other modifications represent, as\na whole, an original work of authorship. For the purposes of this License,\nDerivative Works shall not include works that remain separable from, or \nmerely link (or bind by name) to the interfaces of, the Work and \nDerivative Works thereof.\n\n\"Contribution\" shall mean any work of authorship, including the original\nversion of the Work and any modifications or additions to that Work or\nDerivative Works thereof, that is intentionally submitted to Licensor for\ninclusion in the Work by the copyright owner or by an individual or Legal\nEntity authorized to submit on behalf of the copyright owner. For the\npurposes of this definition, \"submitted\" means any form of electronic, \nverbal, or written communication sent to the Licensor or its \nrepresentatives, including but not limited to communication on electronic\nmailing lists, source code control systems, and issue tracking systems that\nare managed by, or on behalf of, the Licensor for the purpose of discussing\nand improving the Work, but excluding communication that is conspicuously\nmarked or otherwise designated in writing by the copyright owner as \"Not a\nContribution.\"\n\n\"Contributor\" shall mean Licensor and any individual or Legal Entity on \nbehalf of whom a Contribution has been received by Licensor and \nsubsequently incorporated within the Work.\n\nEach Contributor hereby grants to You a perpetual, worldwide, \nnon-exclusive, no-charge, royalty-free, irrevocable (except as stated in \nthis section) patent license to make, have made, use, offer to sell, sell, \nimport, and otherwise transfer the Work, where such license applies only to\nthose patent claims licensable by such Contributor that are necessarily \ninfringed by their Contribution(s) alone or by combination of their \nContribution(s) with the Work to which such Contribution(s) was submitted. \nIf You institute patent litigation against any entity (including a \ncross-claim or counterclaim in a lawsuit) alleging that the Work or a \nContribution incorporated within the Work constitutes direct or \ncontributory patent infringement, then any patent licenses granted to You\nunder this License for that Work shall terminate as of the date such \nlitigation is filed.\n"
},
{
"path": "MoquiInit.properties",
"content": "# No copyright or license for configuration file, details here are not\n# considered a creative work.\n\n# This file is used for the base settings when deploying moqui.war as a\n# webapp in a servlet container or running the WAR file as an executable\n# JAR with java -jar.\n\n# NOTE: configure here before running \"gradle build\", this file is added\n# to the war file.\n\n# You can override these settings with command-line arguments like:\n# -Dmoqui.runtime=runtime\n# -Dmoqui.conf=conf/MoquiProductionConf.xml\n\n# The location of the runtime directory for Moqui to use.\n# If empty it will come from the \"moqui.runtime\" system property.\n#\n# The default property below assumes the application server is started in a\n# directory that is a sibling to a \"moqui\" directory that contains a \"runtime\"\n# directory.\nmoqui.runtime=../moqui/runtime\n# NOTE: if there is a \"runtime\" directory in the war file (in the root of the\n# webapp) that will be used instead of this setting to make it easier to\n# include the runtime in a deployed war without knowing where it will be\n# exploded in the file system.\n\n# The Moqui Conf XML file to use for runtime settings.\n# This property is relative to the runtime location.\nmoqui.conf=conf/MoquiProductionConf.xml\n"
},
{
"path": "Procfile",
"content": "web: java -cp . MoquiStart port=5000 conf=conf/MoquiProductionConf.xml\n"
},
{
"path": "Procfile.README",
"content": "No memory or other JVM options specified here so that the standard JAVA_TOOL_OPTIONS env var may be used (command line args trump JAVA_TOOL_OPTIONS)\n\nFor example: export JAVA_TOOL_OPTIONS=\"-Xmx1024m -Xms1024m\"\nNote that in Java 21 if no max heap size is specified it will default to 1/4 system memory\n\nThe port specified here is the default for the AWS ElasticBeanstalk Java SE image\nsee: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/java-se-procfile.html\n\n"
},
{
"path": "README.md",
"content": "## Welcome to Moqui Framework\n\n[](https://github.com/moqui/moqui-framework/blob/master/LICENSE.md)\n[](https://travis-ci.org/moqui/moqui-framework)\n[](https://github.com/moqui/moqui-framework/releases)\n[](https://github.com/moqui/moqui-framework/commits/master)\n[](https://github.com/moqui/moqui-framework/releases)\n[](https://github.com/moqui/moqui-framework/releases/tag/v4.0.0)\n\n[](https://forum.moqui.org)\n[](https://groups.google.com/d/forum/moqui)\n[](https://www.linkedin.com/groups/4640689)\n[](https://gitter.im/moqui/moqui-framework?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)\n[](http://stackoverflow.com/questions/tagged/moqui)\n\n\nFor information about community infrastructure for code, discussions, support, etc see the Community Guide:\n\n\n\nFor details about running and deploying Moqui see:\n\n\n\nNote that a runtime directory is required for Moqui Framework to run, but is not included in the source repository. The\nGradle get component, load, and run tasks will automatically add the default runtime (from the moqui-runtime repository).\n\nFor information about the current and near future status of Moqui Framework\nsee the [ReleaseNotes.md](https://github.com/moqui/moqui-framework/blob/master/ReleaseNotes.md) file.\n\nFor an overview of features see:\n\n\n\nGet started with Moqui development quickly using the Tutorial at:\n\n\n\nFor comprehensive documentation of Moqui Framework see the wiki based documentation on moqui.org (*running on Moqui HiveMind*):\n \n\n"
},
{
"path": "ReleaseNotes.md",
"content": "# Moqui Framework Release Notes\n\n## Release 4.0.0 - 27 Feb 2026\n\nMoqui framework v4.0.0 is a major new release with massive changes some of which\nare breaking changes. All users are advised to upgrade to benefit from all the\nnew features, security fixes, upgrades, performance improvements and so on.\n\n### Major Changes\n\n#### Java Upgrade to Version 21 (Incompatible Change)\n\nMoqui Framework now requires Java 21. This provides improved performance,\nlong-term support, and access to modern JVM features, while removing legacy\nAPIs. All custom code and components must be validated against Java 21 to ensure\ncompatibility.\n\nAs part of this work:\n\n- Remove deprecated finalize methods no longer applicable in JDK21.\n- Lots of code improvements to comply with JDK21.\n\n#### Groovy upgrade to version 5 (Incompatible Change)\n\nGroovy 5 in combination with newer JDK21 is more strict in @CompileStatic. There\nwere illegal bytecodes being generated, and it has to do with accessing fields\nfrom inner classes.\n\nAnother change is that Groovysh is removed. Therefore, the terminal interface\nwas rewritten from scratch using a different architecture based on\n`groovy.lang.GroovyShell`. This led to both Screen changes (in runtime) and\nbackend changes.\n\n#### Change EntityValue API (Breaking Change)\n\nChange `EntityValue.getEntityName()` to `EntityValue.resolveEntityName()` and\n`EntityValue.getEntityNamePretty()` to `EntityValue.resolveEntityNamePretty()`.\n\nGroovy 4+ introduced a change in the way property to method mapping happens as\n[documented](https://groovy-lang.org/style-guide.html#_getters_and_setters).\n\nThis introduced a bug that occurs when querying an entity that has a field named\n`entityName`. The bug occurs because the query returns an object of type\n`org.moqui.entity.EntityValue`. The problem is that the EntityValue class has a\nmethod called getEntityName() and as per the groovy 4+ behavior this function is\ncalled when trying to access a field named `entityName`. Sample code:\n\n```\ndef someMember = ec.entity\n .find('moqui.entity.view.DbViewEntityMember')\n .condition(...)\n .one()\nsomeMember.entityName // BUG returns .getEntityName(), not .get('entityName')\n```\n\n#### Upgrade to Jetty version 12.1 and EE 11\n\nThis is a major migration. It bumps jetty to version 12.1 and also servlet\nrelated packages (websocket, webapp, proxy) to jakarta EE 11.\n\nThe upgrade broke the existing custom moqui class loaders, and required\nsignificant refactoring of class loaders and webapp structure (e.g.\nWebAppContext, Session Handling, etc ...)\n\nImpact on developers:\n\nAny custom work for jetty should be upgraded to the new versions compatible with\njetty 12.1 and jakarta EE 11\n\n#### Upgrade all javax libraries to jakarta\n\nAll libraries including commons-fileupload, xml.bind-api, activation, mail,\nwebsocket, servlets (6.1), and others are all migrated to their jakarta\nequivalents. As part of this exercise, many deprecated, old or irrelevant / not\nused dependencies were removed. This change required refactoring critical moqui\nfacades and core API to comply with the switch to Jakarta.\n\nAny custom work for older javax should be upgraded where applicable to use the\njakarta equivalent libraries.\n\n#### Integration with the New Bitronix Fork (Incompatible Change)\n\nMoqui Framework now depends on the actively maintained Bitronix fork at:\nhttps://github.com/moqui/bitronix\n\nThe current integrated version is 4.0.0-BETA1, with stabilization ongoing.\n\nThis fork includes:\n\n- Major modernization and cleanup\n- Jakarta namespace migration\n- JMS namespace migration\n- Important bug fixes and stability improvements\n- Legacy Bitronix artifacts are no longer supported.\n- Deployments must remove old Bitronix dependencies.\n\n#### Migration From javax.transaction to jakarta.transaction (BREAKING CHANGE)\n\nMoqui has migrated all transaction-related imports and internal APIs from\njavax.transaction.* to jakarta.transaction.*, following changes in the new\nBitronix fork.\n\nImpact on developers:\n\n- Any code referencing javax.transaction.* must update imports to\n jakarta.transaction.*.\n- Affects transaction facade usage, user transactions, and service-layer\n transaction management.\n- If using custom transaction API, then compilation failures should be expected\n until imports are updated. This does not impact projects that are purely\n depending on moqui facades without accessing the underlying APIs\n\nThis aligns Moqui with the Jakarta EE namespace changes and the newer Bitronix\ntransaction manager.\n\n#### Upgrade Infrastructure\n\n- Postgres to version 18.1\n- MySQL to version 9.5\n- Remove docker compose \"version\" obsolete key\n- Upgrade opensearch to 3.4.0\n- Upgrade java in docker to eclipse-temurin:21\n- Switch jwilder/nginx-proxy to nginxproxy/nginx-proxy\n\nThese upgrades require careful planning when migrating to moqui V4. It is\nrecommended to delete elastic / open search and reindex, and to switch\nfrom elasticsearch to opensearch. Also ensure an upgrade path for your chosen\ndatabase.\n\nAlso, in newer versions of docker, the \"version\" key is obsolete, so ensure\nupdating installed docker so that it works without the \"version\" setting.\n\n#### Gradle Wrapper Updated to 9.2 (BREAKING CHANGE)\n\nThe framework now builds using Gradle 9.2, bringing:\n\n- Faster builds\n- Stricter validation and deprecation cleanup\n\nChanges included:\n- Refactored property assignments and function calls to satisfy newer Gradle immutability rules.\n- Replaced deprecated exec {} blocks with Groovy execute() usage (Windows support still being refined).\n- Updated and corrected dependency declarations, including replacing deprecated modules and fixing invalid version strings.\n- Numerous misc. updates required by Gradle 9.x API changes.\n- Unified dependencyUpdates settings\n\nThis upgrade required significant modifications to component build scripts.\n\nGiven the upgrade to gradle, Java and bitronix, the following community components were upgraded to comply with new requirements:\n- HiveMind\n- PopCommerce\n- PopRestStore\n- example\n- mantle-braintree\n- mantle-usl\n- moqui-camel\n- moqui-cups\n- moqui-fop\n- moqui-hazelcast\n- moqui-image\n- moqui-orientdb\n- moqui-poi\n- moqui-runtime\n- moqui-sftp\n- moqui-sso\n- moqui-wikitext\n- start\n\n### New Features\n\n- Upgrade groovy to version 5\n- Upgrade to JDK21 by default\n- Upgrade to Apache Shiro 2, no longer using INI factory, but rather INI environment classes\n- Upgrade to jetty 2.1 and jakarta EE 11\n- Upgrade docker infrastructure including opensearch, mysql, postgres to latest\n- Upgrade all dependencies to their latest versions\n- Switch from Thread.getId() to Thread.threadId() to work on both virtual and platform threads\n\n## Release 3.9.9 - 25 Feb 2026\n\nMoqui Framework 3.9.9 is a minor new feature and bug fix release, but mostly a maintenance release for the Moqui Framework \n4.0.0 release series.\n\nFor a complete list see the commit log:\n\nhttps://github.com/moqui/moqui-framework/compare/v3.0.0...v3.9.9\n\n## Release 3.1.0 - Canceled release\n\n## Release 3.0.0 - 31 May 2022\n\nMoqui Framework 3.0.0 is a major new feature and bug fix release with some changes that are not backward compatible.\n\nJava 11 is now the minimum Java version required. For development and deployment make sure Java 11 is installed\n(such as openjdk-11-jdk or adoptopenjdk-11-openj9 on Linux), active (on Linux use 'sudo update-alternatives --config java'),\nand that JAVA_HOME is set to the Java 11 JDK install path (for openjdk-11-jdk on Linux: /usr/lib/jvm/java-11-openjdk-amd64).\n\nIn this release the old moqui-elasticsearch component with embedded ElasticSearch is no longer supported. Instead, the new\nElasticFacade is included in the framework as a client to an external OpenSearch or ElasticSearch instance which can be \ninstalled in runtime/opensearch or runtime/elasticsearch and automatically started/stopped in a separate process by the\nMoquiStart class (executable WAR, not when WAR file dropped into Servlet container).\n\nFor search the recommended versions for this release are OpenSearch 1.3.1 (https://opensearch.org/) or ElasticSearch 7.10.2.\nFor ElasticSearch this is the last version released under the Apache 2.0 license).\n\nNow that JavaScript/CSS minify and certain other issues with tools have been resolved, Gradle 7+ is supported. \n\nThis is a brief summary of the changes since the last release, for a complete list see the commit log:\n\nhttps://github.com/moqui/moqui-framework/compare/v2.1.3...v3.0.0\n\n### Non Backward Compatible Changes\n\n- Java 11 is now required, updated from Java 8\n- Updated Spock to 2.1 and with that update now using JUnit Platform and JUnit 5 (Jupiter); with this update old JUnit 4\n test annotations and such are supported, but JUnit 4 TestSuite implementations need to be updated to use the new \n JUnit Platform and Jupiter annotations\n- Library updates have been done that conflict with ElasticSearch making it impossible to run embedded\n- XMLRPC support had been partly removed years ago, is now completely removed\n- CUPS4J library no longer included in moqui-framework, use the moqui-cups component to add this functionality\n- Network printing services (org.moqui.impl.PrintServices) are now mostly placeholders that return error messages if used, CUPS4J\n library and services that depend on it are now in the moqui-cups tool component\n- H2 has non-backward compatible changes, including VALUE now being a reserved word; the Moqui Conf XML file now supports\n per-database entity and field name substitution to handle this and similar future issues; the main issue this cannot\n solve is with older H2 database files that have columns named VALUE, these may need to be changes to THE_VALUE using\n an older version of H2 before updating (this is less common as H2 databases are not generally retained long-term) \n\n### New Features\n\n- Recommended Gradle version is 7+ with updates to support the latest versions of Gradle\n- Updated Jetty to version 10 (which requires Java 11 or later)\n- MFA support for login and update password in screens and REST API with factors including authc code by email and SMS, \n TOTP code (via authenticator app), backup codes; can set a flag on UserGroup to require second factor for all users in\n the group, and if any user has any additional factor enable then a second factor will be required\n- Various security updates including vulnerabilities in 3rd party libraries (including Log4j, Jackson, Shiro, Jetty), \n and some in Moqui itself including XSS vulnerabilities in certain error cases and other framework generated \n messages/responses based on testing with OWASP Zap and two commercial third party reviews (done by larger Moqui users)\n- Optimization for startup-add-missing to get meta data for all tables and columns instead of per entity for much faster startup\n when enabled; default for runtime-add-missing is now 'false' and startup-add-missing is now 'true' for all DBs including H2\n- View Entity find improvements\n - correlated sub-select using SQL LATERAL (mysql8, postgres, db2) or APPLY (mssql and oracle; not yet implemented)\n - extend the member-entity.@sub-select attribute with non-lateral option where not wanted, is used by default as is best for how\n sub-select is commonly used in view entities\n - entity find SQL improvements for view entities where a member entity links to another member-entity with a function on a join field\n - support entity-condition in view-entity used as a sub-select, was being ignored before\n- Improvements to DataDocument generation for a DataFeed to handle very large database tables to feed to ES or elsewhere,\n including chunking and excluding service parameters from the per ExecutionContext instance service call history \n- DataFeed and DataDocument support for manual delete of documents and automatic delete on primary entity record delete\n- Scheduled screen render to send regular reports to users by email (simple email with CSV or XSLT attachment) using \n saved finds on any form-list based screen\n- For entity field encryption default to PBEWithHmacSHA256AndAES_128 instead of PBEWithMD5AndDES, and add configuration\n options for old field encrypt settings (algo, key, etc) to support changing settings, with a service to re-encrypt all \n encrypted fields on all records, or can re-encrypt only when data is touched (as long as all old settings are retained,\n the framework will attempt decrypt with each)\n- Groovy Shell screen added to the Tools app (with special permission), an interactive Groovy Console for testing in \n various environments and for fixing certain production issues\n\n### Bug Fixes\n\n- H2 embedded shutdown hook removal updated, no more Bitronix errors on shutdown from H2 already having been terminated\n\n## Release 2.1.3 - 07 Dec 2019\n\nMoqui Framework 2.1.3 is a patch level new feature and bug fix release.\n\nThere are only minor changes and fixes in this release. For a complete list of changes see:\n\nhttps://github.com/moqui/moqui-framework/compare/v2.1.2...v2.1.3\n\nThis is the last release where the moqui-elasticsearch component for embedded ElasticSearch will be supported. It is\nbeing replaced by the new ElasticFacade included in this release.\n\n### New Features\n\n- Java 11 now supported with some additional libraries (like javax.activation) included by default; some code changes\n to address deprecations in the Java 11 API but more needed to resolve all for better future compatibility\n (in other words expect deprecation warnings when building with Java 11) \n- Built-in ElasticSearch client in the new ElasticFacade that uses pooled HTTP connections with the Moqui RestClient\n for the ElasticSearch JSON REST API; this is most easily used with Groovy where you can use the inline Map and List\n syntax to build what becomes the JSON body for search and other requests; after this release it will replace the old\n moqui-elasticsearch component, now included in the framework because the large ES jar files are no longer required\n- RestClient improvements to support an externally managed RequestFactory to maintain a HttpClient across requests\n for connection pooling, managing cookies, etc \n- Support for binary render modes for screen with new ScreenWidgetRender interface and screen-facade.screen-output\n element in the Moqui Conf XML file; this was initially implemented to support an xlsx render mode implemented in\n the new moqui-poi tool component\n- Screen rendering to XLSX file with one sheet to form-list enabled with the form-list.@show-xlsx-button attribute,\n the XLS button will only show if the moqui-poi tool component is in place\n- Support for binary rendered screen attachments to emails, and reusable emailScreenAsync transition and EmailScreenSection\n to easily add a form to screens to send the screen render as an attachment to an outgoing email, rendered in the background\n- WikiServices to upload and delete attachments, and delete wiki pages; improvements to clone wiki page\n\n## Release 2.1.2 - 23 July 2019\n\nMoqui Framework 2.1.2 is a patch level new feature and bug fix release.\n\nThere are only minor changes and fixes in this release. For a complete list of changes see:\n\nhttps://github.com/moqui/moqui-framework/compare/v2.1.1...v2.1.2\n\n### New Features\n\n- Service include for refactoring, etc with new services.service-include element\n- RestClient now supports retry on timeout for call() and 429 (velocity) return for callFuture()\n- The general worker thread pool now checks for an active ExecutionContext after each run to make sure destroyed\n- CORS preflight OPTIONS request and CORS actual request handling in MoquiServlet\n - headers configured using cors-preflight and cors-actual types in webapp.response-header elements with default headers in MoquiDefaultConf.xml\n - allowed origins configured with the webapp.@allow-origins attribute which defaults the value of the 'webapp_allow_origins'\n property or env var for production configuration; default to empty which means only same origin is allowed\n- Docker and instance management monitoring and configuration option improvements, Postgres support for database instances\n- Entity field currency-amount now has 4 decimal digits in the DB and currency-precise has 5 decimal digits for more currency flexibility\n- Added minRetryTime to ServiceJob to avoid immediate and excessive retries\n- New Gradle tasks for managing git tags\n- Support for read only clone datasource configuration and use (if available) in entity finds\n\n### Bug Fixes\n\n- Issue with DataFeed Runnable not destroying the ExecutionContext causing errors to bleed over\n- Fix double content type header in RestClient in certain scenarios\n\n## Release 2.1.1 - 29 Nov 2018\n\nMoqui Framework 2.1.1 is a patch level new feature and bug fix release.\n\nWhile this release has new features maybe significant enough to warrant a 2.2.0 version bump it is mostly refinements and \nimprovements to existing functionality or to address design limitations and generally make things easier and cleaner. \n\nThere are various bug fixes and security improvements in this release. There are no known backward compatibility issues since the \nlast release but there are minor cases where default behavior has changed (see detailed notes). \n\n### New Features\n\n- Various library updates (see framework/build.gradle for details)\n- Updated to Gradle 4 along with changes to gradle files that require Gradle 4.0 or later\n- In gradle addRuntime task create version.json files for framework/runtime and for each component, shown on System app dashboard\n- New gradle gitCheckoutAll task to bulk checkout branches with option to create\n- New default/example Procfile, include in moqui-plus-runtime.war\n\n##### Web Facade and HTTP\n\n- RestClient improvements for background requests with a Future, retry on 429 for velocity limited APIs, multipart requests, etc\n- In user preferences support override by Java system property (or env var if default-property declared in Moqui Conf XML)\n- Add WebFacade.getRequestBodyText() method, use to get body text more easily and now necessary as WebFacade reads the body for all \n requests with a text content type instead of just application/json or text/json types as before\n- Add email support for notifications with basic default template, enabled only per user for a specific NotificationTopic\n- Add NotificationTopic for web (screen) critical errors\n- Invalidate session before login (with attributes copy to new session) to mitigate session fixation attacks\n- Add more secure defaults for Strict-Transport-Security, Content-Security-Policy, and X-Frame-Options\n\n##### XML Screen and Form\n\n- Support for Vue component based XML Screens using a .js file and a .vuet file that gets merged into the Vue component as the \n template (template can be inline in the .js file); for an example see the DynamicExampleItems.xml screen in the example component\n- XML Screen and WebFacade response headers now configurable with webapp.response-header element in Moqui Conf XML\n- Add moqui-conf.screen-facade.screen and screen.subscreens-item elements that override screen.subscreens.subscreens-item elements \n within a screen definition so that application root screens can be added under webroot and apps in a MoquiConf.xml file in a \n component or in the active Moqui Conf XML file instead of using database records\n- Add support for 'no sub-path' subscreens to extend or override screens, transitions, and resources under the parent screen by \n looking first in each no sub-path subscreen for a given screen path and if not found then look under the parent screen; for \n example this is used in the moqui-org component for the moqui.org web-site so that /index.html is found in the moqui-org \n component and so that /Login resolves to the Login.xml screen in the moqui-org component instead of the default one under webroot\n- Add screen path alias support configured with ScreenPathAlias entity records\n- Now uses URLDecoder for all screen path segments to match use of URLEncoder as default for URL encoding in output\n- In XML Screen transition both service-call and actions are now allowed, service-call runs first\n\n\n- Changed Markdown rendering from Pegdown to flexmark-java to support CommonMark 0.28, some aspects of GitHub Flavored Markdown,\n and automatic table of contents\n- Add form-single.@pass-through-parameters attribute to create hidden inputs for current request parameters\n- Moved validate-* attributes from XML Form field element to sub-field elements so that in form-list different validation can be\n done for header, first-/second-/last-row, and default-/conditional-field; as part of this the automatic validate settings from\n transition.service-call are now set on the sub-field instead of the field element\n\n##### Service Facade\n\n- Add seca.@id and eeca.@id attributes to specify optional IDs that can be used to override or disable SECAs and EECAs\n- SystemMessage improvements for security, HTTP receive endpoint, processing/etc timeouts, etc\n- Service semaphore concurrency improvements, support for semaphore-name which defaults to prior behavior of service name\n\n##### Entity Facade\n\n- Add eeca.set-results attribute to set results of actions in the fields for rules run before entity operation\n- Add entity.relationship.key-value element for constants on join conditions \n- Authorization based entity find filters are now applied after view entities are trimmed so constraints are only added for \n entities actually used in the query\n- EntityDataLoader now supports a create only mode (used in the improved Data Import screen in the Tools app, usable directly)\n- Add mysql8 database conf for new MySQL 8 JDBC driver\n\n### Bug Fixes\n\n- Serious bug in MoquiAuthFilter where it did not destroy ExecutionContext leaving it in place for the next request using that \n thread; also changed MoquiServlet to better protect against existing ExecutionContext for thread; also changed WebFacade init\n from HTTP request to remove current user if it doesn't match user authenticated in session with Shiro, or if no user is \n authenticated in session\n- MNode merge methods did not properly clear node by name internal cache when adding child nodes causing new children to show up\n in full child node list but not when getting first or all children by node name if they had been accessed by name before the merge\n- Fix RestClient path and parameter encoding\n- Fix RestClient basic authentication realm issue, now custom builds Authorization request header\n- Fix issue in update#Password service with reset password when UserAccount has a resetPassword but no currentPassword\n- Disable default geo IP lookup for Visit records because the freegeoip service has been discontinued\n- Fix DataFeed trigger false positives for PK fields on related entities included in DataDocument definitions\n- Fix transaction response type screen-last in vuet/vapps mode, history wasn't being maintained server side\n\n## Release 2.1.0 - 22 Oct 2017\n\nMoqui Framework 2.1.0 is a minor new feature and bug fix release.\n\nMost of the effort in the Moqui Ecosystem since the last release has been on the business artifact and application levels. Most of\nthe framework changes have been for improved user interfaces but there have also been various lower level refinements and \nenhancements. \n\nThis release has a few bug fixes from the 2.0.0 release and has new features like DbResource and WikiPage version management, \na simple tool for ETL, DataDocument based dynamic view entities, and various XML Screen and Form widget options and usability \nimprovements. This release was originally planned to be a patch level release primarily for bug fixes but very soon after the 2.0.0 \nrelease work start on the Vue based client rendering (SPA) functionality and various other new features that due to business deals \nprogressed quickly.\n\nThe default moqui-runtime now has support for hybrid static/dynamic XML Screen rendering based on Vue JS. There are various changes \nfor better server side handling but most changes are in moqui-runtime. See the moqui-runtime release notes for more details. \nSome of these changes may be useful for other client rendering purposes, ie for other client side tools and frameworks.\n\n### Non Backward Compatible Changes\n\n- New compile dependency on Log4J2 and not just SLF4J\n- DataDocument JSON generation no longer automatically adds all primary key fields of the primary entity to allow for aggregation\n by function in DataDocument based queries (where DataDocument is used to create a dynamic view entity); for ElasticSearch indexing\n a unique ID is required so all primary key fields of the primary entity should be defined\n- The DataDocumentField, DataDocumentCondition, and DataDocumentLink entities now have an artificial/sequenced secondary key instead \n of using another field (fieldPath, fieldNameAlias, label); existing tables may work with some things but reloading seed data will\n fail if you have any DataDocument records in place; these are typically seed data records so the easiest way to update/migrate\n is to drop the tables for DataDocumentField/Link/Condition entities and then reload seed data as normal for a code update\n- If using moqui-elasticsearch the index approach has changed to one index per DataDocument to prep for ES6 and improve the\n performance and index types by field name; to update an existing instance it is best to start with an empty ES instance or at\n least delete old indexes and re-index based on data feeds\n- The default Dockerfile now runs the web server on port 80 instead of 8080 within the container\n\n### New Features\n\n- Various library updates\n- SLF4J MDC now used to track moqui_userId and moqui_visitorId for logging\n- New ExecutionContextFactory.registerLogEventSubscriber() method to register for Log4J2 LogEvent processing, initially used in the\n moqui-elasticsearch component to send log messages to ElasticSearch for use in the new LogViewer screen in the System app\n- Improved Docker Compose samples with HTTPS and PostgreSQL, new file for Kibana behind transparent proxy servlet in Moqui\n- Added MoquiAuthFilter that can be used to require authorization and specified permission for arbitrary paths such as servlets;\n this is used along with the Jetty ProxyServlet$Transparent to provide secure access to things server only accessible tools like\n ElasticSearch (on /elastic) and Kibana (on /kibana) in the moqui-elasticsearch component\n- Multi service calls now pass results from previous calls to subsequent calls if parameter names match, and return results\n- Service jobs may now have a lastRunTime parameter passed by the job scheduler; lastRunTime on lock and passed to service is now\n the last run time without an error\n- view-entity now supports member-entity with entity-condition and no key-map for more flexible join expressions\n- TransactionCache now handles more situations like using EntityListIterator.next() calls and not just getCompleteList(), and \n deletes through the tx cache are more cleanly handled for records created through the tx cache\n- ResourceReference support for versions in supported implementations (initially DbResourceReference)\n- ResourceFacade locations now support a version suffix following a hash\n- Improved wiki services to track version along with underlying ResourceReference\n- New SimpleEtl class plus support for extract and load through EntityFacade\n- Various improvements in send#EmailTemplate, email view tracking with transparent pixel image\n- Improvements for form-list aggregations and show-total now supports avg, count, min, max, first, and last in addition to sum\n- Improved SQLException handling with more useful messages and error codes from database\n- Added view-entity.member-relationship element as a simpler alternative to member-entity using existing relationships\n- DataDocumentField now has a functionName attribute for functions on fields in a DataDocument based query \n- Any DataDocument can now be treated as an entity using the name pattern DataDocument.${dataDocumentId}\n- Sub-select (sub-query) is now supported for view-entity by a simple flag on member-entity (or member-relationship); this changes\n the query structure so the member entity is joined in a select clause with any conditions for fields on that member entity put\n in its where clause instead of the where clause for the top-level select; any fields selected are selected in the sub-select as\n are any fields used for the join ON conditions; the first example of this is the InvoicePaymentApplicationSummary view-entity in\n mantle-usl which also uses alias.@function and alias.complex-alias to use concat_ws for combined name aliases\n- Sub-select also now supported for view-entity members of other view entities; this provides much more flexibility for functions\n and complex-aliases in the sub-select queries; there are also examples of this in mantle-usl\n- Now uses Jackson Databind for JSON serialization and deserialization; date/time values are in millis since epoch\n\n### Bug Fixes\n\n- Improved exception (throwable) handling for service jobs, now handled like other errors and don't break the scheduler\n- Fixed field.@hide attribute not working with runtime conditions, now evaluated each time a form-list is rendered\n- Fixed long standing issue with distinct counts and limited selected fields, now uses a distinct sub-select under a count select\n- Fixed long standing issue where view-entity aliased fields were not decrypted\n- Fixed issue with XML entity data loading using sub-elements for related entities and under those sub-elements for field data\n- Fixed regression in EntityFind where cache was used even if forUpdate was set\n- Fixed concurrency issue with screen history (symptom was NPE on iterator.next() call)\n\n## Release 2.0.0 - 24 Nov 2016\n\nMoqui Framework 2.0.0 is a major new feature and bug fix release, with various non backward compatible API and other changes.\n\nThis is the first release since 1.0.0 with significant and non backwards compatible changes to the framework API. Various deprecated\nmethods have been removed. The Cache Facade now uses the standard javax.cache interfaces and the Service Facade now uses standard \njava.util.concurrent interfaces for async and scheduled services. Ehcache and Quartz Scheduler have been replaced by direct, \nefficient interfaces implementations.\n\nThis release includes significant improvements in configuration and with the new ToolFactory functionality is more modular with\nmore internals exposed through interfaces and extendable through components. Larger and less universally used tool are now in \nseparate components including Apache Camel, Apache FOP, ElasticSearch, JBoss KIE and Drools, and OrientDB.\n\nMulti-server instances are far better supported by using Hazelcast for distributed entity cache invalidation, notifications,\ncaching, background service execution, and for web session replication. The moqui-hazelcast component is pre-configured to enable\nall of this functionality in its MoquiConf.xml file. To use add the component and add a hazelcast.xml file to the classpath with\nsettings for your cluster (auto-discover details, etc).\n\nMoqui now scales up better with performance improvements, concurrency fixes, and Hazelcast support (through interfaces other \ndistributed system libraries like Apache Ignite could also be used). Moqui also now scales down better with improved memory \nefficiency and through more modular tools much smaller runtime footprints are possible.\n\nThe multi-tenant functionality has been removed and replaced with the multi-instance approach. There is now a Dockerfile included\nwith the recommended approach to run Moqui in Docker containers and Docker Compose files for various scenarios including an\nautomatic reverse proxy using nginx-proxy. There are now service interfaces and screens in the System application for managing\nmultiple Moqui instances from a master instance. Instances with their own database can be automatically provisioned using \nconfigurable services, with initial support for Docker containers and MySQL databases. Provisioning services will be added over time\nto support other instance hosts and databases, and you can write your own for whatever infrastructure you prefer to use.\n\nTo support WebSocket a more recent Servlet API the embedded servlet container is now Jetty 9 instead of Winstone. When running \nbehind a proxy such as nginx or httpd running in the embedded mode (executable WAR file) is now adequate for production use.\n\nIf you are upgrading from an earlier version of Moqui Framework please read all notes about Non Backward Compatible Changes. Code,\nconfiguration, and database meta data changes may be necessary depending on which features of the framework you are using.\n\nIn this version Moqui Framework starts and runs faster, uses less memory, is more flexible, configuration is easier, and there are\nnew and better ways to deploy and manage multiple instances. A decent machine ($1800 USD Linux workstation, i7-6800K 6 core CPU) \ngenerated around 350 screens per second with an average response time under 200ms. This was running Moqui and MySQL on the same \nmachine with a JMeter script running on a separate machine doing a 23 step order to ship/bill process that included 2 reports \n(one MySQL based, one ElasticSearch based) and all the GL posting, etc. The load simulated entering and shipping (by internal users) \naround 1000 orders/minute which would support thousands of concurrent internal or ecommerce users. On larger server hardware and \nwith some lower level tuning (this was on stock/default Linux, Java 8, and MySQL 5.7 settings) a single machine could handle \nsignificantly more traffic. \n\nWith the latest framework code and the new Hazelcast plugin Moqui supports high performance clusters to handle massive loads. The \nmost significant limit is now database performance as we need a transactional SQL database for this sort of business process \n(with locking on inventory reservations and issuances, GL posting, etc as currently implemented in Mantle USL).\n\nEnjoy!\n\n### Non Backward Compatible Changes\n\n- Java JDK 8 now required (Java 7 no longer supported)\n- Now requires Servlet Container supporting the Servlet 3.1 specification\n- No longer using Winstone embedded web server, now using Jetty 9\n- Multi-Tenant Functionality Removed\n - ExecutionContext.getTenant() and getTenantId() removed\n - UserFacade.loginUser() third parameter (tenantId) removed\n - CacheFacade.getCache() with second parameter for tenantId removed\n - EntityFacade no longer per-tenant, getTenantId() removed\n - TransactionInternal and EntityDatasourceFactory methods no longer have tenantId parameter\n - Removed tenantcommon entity group and moqui.tenant entities\n - Removed tenant related MoquiStart command line options\n - Removed tenant related Moqui Conf XML, XML Screen, etc attributes\n- Entity Definitions\n - XSDs updated for these changes, though old attributes still supported\n - changed entity.@package-name to entity.@package\n - changed entity.@group-name to entity.@group\n - changed relationship.@related-entity-name to relationship.@related\n - changed key-map.@related-field-name to key-map.@related\n - UserField no longer supported (UserField and UserFieldValue entities)\n- XML Screen and Form\n - field.@entry-name attribute replaced by field.@from attribute (more meaningful, matches attribute used on set element); the old\n entry-name attribute is still supported, but removed from XSD\n- Service Job Scheduling\n - Quartz Scheduler has been removed, use new ServiceJob instead with more relevant options, much cleaner and more manageable\n - Removed ServiceFacade.getScheduler() method\n - Removed ServiceCallSchedule interface, implementation, and ServiceFacade.schedule() factory method\n - Removed ServiceQuartzJob class (impl of Job interface)\n - Removed EntityJobStore class (impl of JobStore interface); this is a huge and complicated class to handle the various \n complexities of Quartz and was never fully working, had some remaining issues in testing\n - Removed HistorySchedulerListener and HistoryTriggerListener classes\n - Removed all entities in the moqui.service.scheduler and moqui.service.quartz packages\n - Removed quartz.properties and quartz_data.xml configuration files\n - Removed Scheduler screens from System app in tools component\n - For all of these artifacts see moqui-framework commit #d42ede0 and moqui-runtime commit #6a9c61e\n- Externalized Tools\n - ElasticSearch (and Apache Lucene)\n - libraries, classes and all related services, screens, etc are now in the moqui-elasticsearch component\n - System/DataDocument screens now in moqui-elasticsearch component and added to tools/System app through SubscreensItem record\n - all ElasticSearch services in org.moqui.impl.EntityServices moved to org.moqui.search.SearchServices including:\n index#DataDocuments, put#DataDocumentMappings, index#DataFeedDocuments, search#DataDocuments, search#CountBySource\n - Moved index#WikiSpacePages service from org.moqui.impl.WikiServices to org.moqui.search.SearchServices\n - ElasticSearch dependent REST API methods moved to the 'elasticsearch' REST API in the moqui-elasticsearch component\n - Apache FOP is now in the moqui-fop tool component; everything in the framework, including the now poorly named MoquiFopServlet, \n use generic interfaces but XML-FO files will not transform to PDF/etc without this component in place\n - OrientDB and Entity Facade interface implementations are now in the moqui-orientdb component, see its README.md for usage\n - Apache Camel along with the CamelServiceRunner and MoquiServiceEndpoint are now in the moqui-camel component which has a \n MoquiConf.xml file so no additional configuration is needed\n - JBoss KIE and Drools are now in tool component moqui-kie, an optional component for mantle-usl; has MoquiConf to add ToolFactory\n - Atomikos TM moved to moqui-atomikos tool component\n- ExecutionContext and ExecutionContextFactory\n - Removed initComponent(), destroyComponent() methods; were never well supported (runtime component init/destroy caused issues)\n - Removed getCamelContext() from ExecutionContextFactory and ExecutionContext, use getTool(\"Camel\", CamelContext.class)\n - Removed getElasticSearchClient() from ExecutionContextFactory and ExecutionContext, use getTool(\"ElasticSearch\", Client.class)\n - Removed getKieContainer, getKieSession, and getStatelessKieSession methods from ExecutionContextFactory and ExecutionContext, \n use getTool(\"KIE\", KieToolFactory.class) and use the corresponding methods there\n - See new feature notes under Tool Factory\n- Caching\n - Ehcache has been removed\n - The org.moqui.context.Cache interface is replaced by javax.cache.Cache\n - Configuration options for caches changed (moqui-conf.cache-list.cache)\n- NotificationMessage\n - NotificationMessage, NotificationMessageListener interfaces have various changes for more features and to better support \n serialized messages for notification through a distributed topic\n- Async Services\n - Now uses more standard java.util.concurrent interfaces\n - Removed ServiceCallAsync.maxRetry() - was never supported\n - Removed ServiceCallAsync.persist() - was never supported well, used to simply call through Quartz Scheduler when set\n - Removed persist option from XML Actions service-call.@async attribute\n - Async services never called through Quartz Scheduler (only scheduled)\n - ServiceCallAsync.callWaiter() replaced by callFuture()\n - Removed ServiceCallAsync.resultReceiver()\n - Removed ServiceResultReceiver interface - use callFuture() instead\n - Removed ServiceResultWaiter class - use callFuture() instead\n - See related new features below\n- Service parameter.subtype element removed, use the much more flexible nested parameter element\n- JCR and Apache Jackrabbit\n - The repository.@type, @location, and @conf-location attributes have been removed and the repository.parameter sub-element \n added for use with the javax.jcr.RepositoryFactory interface\n - See new configuration examples in MoquiDefaultConf.xml under the repository-list element\n- OWASP ESAPI and AntiSamy\n - ESAPI removed, now using simple StringEscapeUtils from commons-lang\n - AntiSamy replaced by Jsoup.clean()\n- Removed ServiceSemaphore entity, now using ServiceParameterSemaphore\n- Deprecated methods\n - These methods were deprecated (by methods with shorter names) long ago and with other API changes now removing them\n - Removed getLocalizedMessage() and formatValue() from L10nFacade\n - Removed renderTemplateInCurrentContext(), runScriptInCurrentContext(), evaluateCondition(), evaluateContextField(), and \n evaluateStringExpand() from ResourceFacade\n - Removed EntityFacade.makeFind() \n- ArtifactHit and ArtifactHitBin now use same artifact type enum as ArtifactAuthz, for efficiency and consistency; configuration of\n artifact-stats by sub-type no longer supported, had little value and caused performance overhead\n- Removed ArtifactAuthzRecord/Cond entities and support for them; this was never all that useful and is replaced by the \n ArtifactAuthzFilter and EntityFilter entities\n- The ContextStack class has moved to the org.moqui.util package\n- Replaced Apache HttpComponents client with jetty-client to get support for HTTP/2, cleaner API, better async support, etc\n- When updating to this version recommend stopping all instances in a cluster before starting any instance with the new version\n\n### New Features\n\n- Now using Jetty embedded for the executable WAR instead of Winstone\n - using Jetty 9 which requires Java 8\n - now internally using Servlet API 3.1.0\n- Many library updates, cleanup of classes found in multiple jar files (ElasticSearch JarHell checks pass; nice in general)\n- Configuration\n - Added default-property element to set Java System properties from the configuration file\n - Added Groovy string expansion to various configuration attributes\n - looks for named fields in Java System properties and environment variables\n - used in default-property.@value and all xa-properties attributes\n - replaces the old explicit check for ${moqui.runtime}, which was a simple replacement hack\n - because these are Groovy expressions the typical dots used in property names cannot be used in these strings, use an \n underscore instead of a dot, ie ${moqui_runtime} instead of ${moqui.runtime}; if a property name contains underscores and \n no value is found with the literal name it replaces underscores with dots and looks again\n- Deployment and Docker\n - The MoquiStart class can now run from an expanded WAR file, i.e. from a directory with the contents of a Moqui executable WAR\n - On startup DataSource (database) connections are retried 5 times, every 5 seconds, for situations where init of separate \n containers is triggered at the same time like with Docker Compose\n - Added a MySQLConf.xml file where settings can come from Java system properties or system environment variables\n - The various webapp.@http* attributes can now be set as system properties or environment variables\n - Added a Dockerfile and docker-build.sh script to build a Docker image from moqui-plus-runtime.war or moqui.war and runtime\n - Added sample Docker Compose files for moqui+mysql, and for moqui, mysql, and nginx-proxy for reverse proxy that supports \n virtual hosts for multiple Docker containers running Moqui\n - Added script to run a Docker Compose file after copying configuration and data persistence runtime directories if needed\n- Multi-Instance Management\n - New services (InstanceServices.xml) and screens in the System app for Moqui instance management\n - This replaces the removed multi-tenant functionality\n - Initially supports Docker for the instance hosting environment via Docker REST API\n - Initially supports MySQL for instance databases (one DB per instance, just like in the past)\n- Tool Factory\n - Added org.moqui.context.ToolFactory interface used to initialize, destroy, and get instances of tools\n - Added tools.tool-factory element in Moqui Conf XML file; has default tools in MoquiDefaultConf.xml and can be populated or \n modified in component and/or runtime conf XML files\n - Use new ExecutionContextFactory.getToolFactory(), ExecutionContextFactory.getTool(), and ExecutionContext.getTool() methods \n to interact with tools\n - See non backward compatible change notes for ExecutionContextFactory\n- WebSocket Support\n - Now looks for javax.websocket.server.ServerContainer in ServletContext during init, available from ECFI.getServerContainer()\n - If ServletContainer found adds endpoints defined in the webapp.endpoint element in the Moqui Conf XML file\n - Added MoquiAbstractEndpoint, extend this when implementing an Endpoint so that Moqui objects such as ExecutionContext/Factory \n are available, UserFacade initialized from handshake (HTTP upgrade) request, etc\n - Added NotificationEndpoint which listens for NotificationMessage through ECFI and sends them over WebSocket to notify user\n- NotificationMessage\n - Notifications can now be configured to send through a topic interface for distributed topics (implemented in the \n moqui-hazelcast component); this handles the scenario where a notification is generated on one server but a user is connected \n (by WebSocket, etc) to another\n - Various additional fields for display in the JavaScript NotificationClient including type, title and link templates, etc\n- Caching\n - CacheFacade now supports separate local and distributed caches both using the javax.cache interfaces\n - Added new MCache class for faster local-only caches\n - implements the javax.cache.Cache interface\n - supports expire by create, access, update\n - supports custom expire on get\n - supports max entries, eviction done in separate thread\n - Support for distributed caches such as Hazelcast\n - New interfaces to plugin entity distributed cache invalidation through a SimpleTopic interface, supported in moqui-hazelcast\n - Set many entities to cache=never, avoid overhead of cache where read/write ratio doesn't justify it or cache could cause issues\n- Async Services\n - ServiceCallAsync now using standard java.util.concurrent interfaces\n - Use callFuture() to get a Future object instead of callWaiter()\n - Can now get Runnable or Callable objects to run a service through a ExecutorService of your choice\n - Services can now be called local or distributed\n - Added ServiceCallAsync.distribute() method\n - Added distribute option to XML Actions service-call.@async attribute\n - Distributed executor is configurable, supported in moqui-hazelcast\n - Distributed services allow offloading service execution to worker nodes\n- Service Jobs\n - Configure ad-hoc (explicitly executed) or scheduled jobs using the new ServiceJob and related entities\n - Tracks execution in ServiceJobRun records\n - Can send NotificationMessage, success or error, to configured topic\n - Run service job through ServiceCallJob interface, ec.service.job()\n - Replacement for Quartz Scheduler scheduled services\n- Added SubEtha SMTP server which receives email messages and calls EMECA rules, an alternative to polling IMAP and POP3 servers\n- Hazelcast Integration (moqui-hazelcast component)\n - These features are only enabled with this tool component in place\n - Added default Hazelcast web session replication config\n - Hazelcast can be used for distributed entity cache, web session replication, distributed execution, and OrientDB clustering\n - Implemented distributed entity cache invalidate using a Hazelcast Topic, enabled in Moqui Conf XML file with the\n @distributed-cache-invalidate attribute on the entity-facade element\n- XSL-FO rendering now supports a generic ToolFactory to create a org.xml.sax.ContentHandler object, with an implementation \n using Apache FOP now in the moqui-fop component\n- JCR and Apache Jackrabbit\n - JCR support (for content:// locations in the ResourceFacade) now uses javax.jcr interfaces only, no dependencies on Jackrabbit\n - JCR repository configuration now supports other JCR implementations by using RepositoryFactory parameters\n- Added ADMIN_PASSWORD permission for administrative password change (in UserServices.update#Password service)\n- Added UserServices.enable#UserAccount service to enable disabled account\n- Added support for error screens rendered depending on type of error\n - configured in the webapp.error-screen element in Moqui Conf XML file\n - if error screen render fails sends original error response\n - this is custom content that avoids sending an error response\n- A component may now have a MoquiConf.xml file that overrides the default configuration file (MoquiDefaultConf.xml from the \n classpath) but is overridden by the runtime configuration file; the MoquiConf.xml file in each component is merged into the main \n conf based on the component dependency order (logged on startup)\n- Added ExecutionContext.runAsync method to run a closure in a worker thread with an ExecutionContext like the current (user, etc)\n- Added configuration for worker thread pool parameters, used for local async services, EC.runAsync, etc\n- Transaction Facade\n - The write-through transaction cache now supports a read only mode\n - Added service.@no-tx-cache attribute which flushes and disables write through transaction cache for the rest of the transaction\n - Added flushAndDisableTransactionCache() method to flush/disable the write through cache like service.@no-tx-cache\n- Entity Facade\n - In view-entity.alias.complex-alias the expression attribute is now expanded so context fields may be inserted or other Groovy \n expressions evaluated using dollar-sign curly-brace (${}) syntax\n - Added view-entity.alias.case element with when and else sub-elements that contain complex-alias elements; these can be used for \n CASE, CASE WHEN, etc SQL expressions\n - EntityFind.searchFormMap() now has a defaultParameters argument, used when no conditions added from the input fields Map\n - EntityDataWriter now supports export with a entity master definition name, applied only to entities exported that have a master \n definition with the given master name\n- XML Screen and Form\n - screen path URLs that don't exist are now by default disabled instead of throwing an exception\n - form-list now supports @header-dialog to put header-field widgets in a dialog instead of in the header\n - form-list now supports @select-columns to allow users to select which fields are displayed in which columns, or not displayed\n - added search-form-inputs.default-parameters element whose attributes are used as defaultParameters in searchFormMap()\n - ArtifactAuthzFailure records are only created when a user tries to use an artifact, not when simply checking to see if use is \n permitted (such as in menus, links, etc)\n - significant macro cleanups and improvements\n - csv render macros now improved to support more screen elements, more intelligently handle links (only include anchor/text), etc\n - text render macros now use fixed width output (number of characters) along with new field attributes to specify print settings\n - added field.@aggregate attribute for use in form-list with options to aggregate field values across multiple results or\n display fields in a sub-list under a row with the common fields for the group of rows\n - added form-single.@owner-form attribute to skip HTML form element and add the HTML form attribute to fields so they are owned\n by a different form elsewhere in the web page\n- The /status path now a transition instead of a screen and returns JSON with more server status information\n- XML Actions now statically import all the old StupidUtilities methods so 'StupidUtilities.' is no longer needed, shouldn't be used\n- StupidUtilities and StupidJavaUtilities reorganized into the new ObjectUtilities, CollectionUtilities, and StringUtilities\n classes in the moqui.util package (in the moqui-util project)\n\n### Bug Fixes\n\n- Fixed issues with clean shutdown running with the embedded Servlet container and with gradle test\n- Fixed issue with REST and other requests using various HTTP request methods that were not handled, MoquiServlet now uses the\n HttpServlet.service() method instead of the various do*() methods\n- Fixed issue with REST and other JSON request body parameters where single entry lists were unwrapped to just the entry\n- Fixed NPE in EntityFind.oneMaster() when the master value isn't found, returns null with no error; fixes moqui-runtime issue #18\n- Fixed ElFinder rm (moqui-runtime GitHub issue #23), response for upload\n- Screen sub-content directories treated as not found so directory entries not listed (GitHub moqui-framework issue #47)\n- In entity cache auto clear for list of view-entity fixed mapping of member entity fields to view entity alias, and partial match \n when only some view entity fields are on a member entity\n- Cache clear fix for view-entity list cache, fixes adding a permission on the fly\n- Fixed issue with Entity/DataEdit screens in the Tools application where the parameter and form field name 'entityName' conflicted \n with certain entities that have a field named entityName\n- Concurrency Issues\n - Fixed concurrent update errors in EntityCache RA (reverse association) using Collections.synchronizedList()\n - Fixed per-entity DataFeed info rebuild to avoid multiple runs and rebuild before adding to cache in use to avoid partial data\n - Fixed attribute and child node wrapper caching in FtlNodeWrapper where in certain cases a false null would be returned\n\n## Release 1.6.2 - 26 Mar 2016\n\nMoqui Framework 1.6.2 is a minor new feature and bug fix release.\n\nThis release is all about performance improvements, bug fixes, library\nupdates and cleanups. There are a number of minor new features like better\nmulti-tenant handling (and security), optionally loading data on start if\nthe DB is empty, more flexible handling of runtime Moqui Conf XML location,\ndatabase support and transaction management, and so on.\n\n### Non Backward Compatible Changes\n\n- Entity field types are somewhat more strict for database operations; this\n is partly for performance reasons and partly to avoid database errors\n that happen only on certain databases (ie some allow passing a String for\n a Timestamp, others don't; now you have to use a Timestamp or other date\n object); use EntityValue.setString or similar methods to do data\n conversions higher up\n- Removed the TenantCurrency, TenantLocale, TenantTimeZone, and\n TenantCountry entities; they aren't generally used and better not to have\n business settings in these restricted technical config entities\n\n### New Features\n\n- Many performance improvements based on profiling; cached entities finds\n around 6x faster, non cached around 3x; screen rendering also faster\n- Added JDBC Connection stash by tenant, entity group, and transaction,\n can be disabled with transaction-facade.@use-connection-stash=false in\n the Moqui Conf XML file\n- Many code cleanups and more CompileStatic with XML handling using new\n MNode class instead of Groovy Node; UserFacadeImpl and\n TransactionFacadeImpl much cleaner with internal classes for state\n- Added tools.@empty-db-load attribute with data file types to load on\n startup (through webapp ContextListener init only) if the database is\n empty (no records for moqui.basic.Enumeration)\n- If the moqui.conf property (system property, command line, or in\n MoquiInit.properties) starts with a forward slash ('/') it is now\n considered an absolute path instead of relative to the runtime directory\n allowing a conf file outside the runtime directory (an alternative\n to using ../)\n- UserAccount.userId and various other ID fields changed from id-long to id\n as userId is only an internal/sequenced ID now, and for various others\n the 40 char length changed years ago is more than adequate; existing\n columns can be updated for the shorter length, but don't have to be\n- Changes to run tests without example component in place (now a component\n separate from moqui-runtime), using the moqui.test and other entities\n- Added run-jackrabbit option to run Apache Jackrabbit locally when Moqui\n starts and stop is when Moqui stops, with conf/etc in runtime/jackrabbit\n- Added SubscreensDefault entity and supporting code to override default\n subscreens by tenant and/or condition with database records\n- Now using the VERSION_2_3_23 version for FreeMarker instead of a\n previous release compatibility version\n- Added methods to L10nFacade that accept a Locale when something other\n than the current user's locale is needed\n- Added TransactionFacade runUseOrBegin() and runRequireNew() methods to\n run code (in a Groovy Closure) in a transaction\n- ArtifactHit/Bin persistence now done in a worker thread instead of async\n service; uses new eci.runInWorkerThread() method, may be added\n ExecutionContext interface in the future\n- Added XML Form text-line.depends-on element so autocomplete fields can\n get data on the client from other form fields and clear on change\n- Improved encode/decode handling for URL path segments and parameters\n- Service parameters with allow-html=safe are now accepted even with\n filtered elements and attributes, non-error messages are generated and\n the clean HTML from AntiSamy is used\n- Now using PegDown for Markdown processing instead of Markdown4J\n- Multi Tenant\n - Entity find and CrUD operations for entities in the tenantcommon group\n are restricted to the DEFAULT instance, protects REST API and so on\n regardless of admin permissions a tenant admin might assign\n - Added tenants allowed on SubscreensItem entity and subscreens-item\n element, makes more sense to filter apps by tenant than in screen\n - Improvements to tenant provisioning services, new MySQL provisioning,\n and enable/disable tenant services along with enable check on switch\n - Added ALL_TENANTS option for scheduled services, set on system\n maintenance services in quartz_data.xml by default; runs the service\n for each known tenant (by moqui.tenant.Tenant records)\n- Entity Facade\n - DB meta data (create tables, etc) and primary sequenced ID queries now\n use a separate thread to run in a different transaction instead of\n suspend/resume as some databases have issues with that, especially\n nested which happens when service and framework code suspends\n- Service Facade\n - Added separateThread option to sync service call as an alternative to\n requireNewTransaction which does a suspend/resume, runs service in a\n separate thread and waits for the service to complete\n - Added service.@semaphore-parameter attribute which creates a distinct\n semaphore per value of that parameter\n - Services called with a ServiceResultWaiter now get messages passed\n through from the service job in the current MessageFacade (through\n the MessageFacadeException), better handling for other Throwable\n - Async service calls now run through lighter weight worker thread pool\n if persist not set (if persist set still through Quartz Scheduler)\n- Dynamic (SPA) browser features\n - Added screen element when render screen to support macros at the screen\n level, such as code for components and services in Angular 2\n - Added support for render mode extension (like .html, .js, etc) to\n last screen name in screen path (or URL), uses the specified\n render-mode and doesn't try to render additional subscreens\n - Added automatic actions.json transition for all screens, runs actions\n and returns results as JSON for use in client-side template rendering\n - Added support for .json extension to transitions, will run the\n transition and if the response goes to another screen returns path to\n that screen in a list and parameters for it, along with\n messages/errors/etc for client side routing between screens\n\n### Bug Fixes\n\n- DB operations for sequenced IDs, service semaphores, and DB meta data are\n now run in a separate thread instead of tx suspend/resume as some\n databases have issues with suspend/resume, especially multiple\n outstanding suspended transactions\n- Fixed issue with conditional default subscreen URL caching\n- Internal login from login/api key and async/scheduled services now checks\n for disabled accounts, expired passwords, etc just like normal login\n- Fixed issue with entity lists in TransactionCache, were not cloned so\n new/updated records changed lists that calling code might use\n- Fixed issue with cached entity lists not getting cleared when a record is\n updated that wasn't in a list already in the cache but that matches its\n condition\n- Fixed issue with cached view-entity lists not getting cleared on new or\n updated records; fixes issues with new authz, tarpits and much more not\n applied immediately\n- Fixed issue with cached view-entity one results not getting cleared when\n a member entity is updated (was never implemented)\n- Entities in the tenantcommon group no longer available for find and CrUD\n operations outside the DEFAULT instance (protect tenant data)\n- Fixed issue with find one when using a Map as a condition that may\n contain non-PK fields and having an artifact authz filter applied, was\n getting non-PK fields and constraining query when it shouldn't\n (inconsistent with previous behavior)\n- Fixed ElasticSearch automatic mappings where sub-object mappings always\n had just the first property\n- Fixed issues with Entity DataFeed where cached DataDocument mappings per\n entity were not consistent and no feed was done for creates\n- Fixed safe HTML service parameters (allow-html=safe), was issue loading\n antisamy-esapi.xml though ESAPI so now using AntiSamy directly\n- Fixed issues with DbResource reference move and other operations\n- Fixed issues with ResourceReference operations and wiki page updates\n\n\n## Release 1.6.1 - 24 Jan 2016\n\nMoqui Framework 1.6.1 is a minor new feature and bug fix release.\n\nThis is the first release after the repository reorganization in Moqui \nEcosystem. The runtime directory is now in a separate repository. The \nframework build now gets JAR files from Bintray JCenter instead of having\nthem in the framework/lib directory. Overall the result is a small\nfoundation with additional libraries, components, etc added as needed using\nGradle tasks.\n\n### Build Changes\n\n- Gradle tasks to help handle runtime directory in a separate repository\n from Moqui Framework\n- Added component management features as Gradle tasks\n - Components available configured in addons.xml\n - Repositories components come from configured in addons.xml\n - Get component from current or release archive (getCurrent, getRelease)\n - Get component from git repositories (getGit)\n - When getting a component, automatically gets all components it depends\n on (must be configured in addons.xml so it knows where to get them)\n - Do a git pull for moqui, runtime, and all components\n- Most JAR files removed, framework build now uses Bintray JCenter\n- JAR files are downloaded as needed on build\n- For convenience in IDEs to copy JAR files to the framework/dependencies\n directory use: gradle framework:copyDependencies; note that this is not\n necessary in IntelliJ IDEA (will import dependencies when creating a new\n project based on the gradle files, use the refresh button in the Gradle\n tool window to update after updating moqui)\n- If your component builds source or runs Spock tests changes will be\n needed, see the runtime/base-component/example/build.gradle file\n\n### New Features\n\n- The makeCondition(Map) methods now support _comp entry for comparison\n operator, _join entry for join operator, and _list entry for a list of\n conditions that will be combined with other fields/values in the Map\n- In FieldValueCondition if the value is a collection and operator is\n EQUALS set to IN, or if NOT_EQUAL then NOT_IN\n\n### Bug Fixes\n\n- Fixed issue with EntityFindBase.condition() where condition break down\n set ignore case to true\n- Fixed issue with from/thru date where conversion from String was ignored\n- Fixed MySQL date-time type for milliseconds; improved example conf for XA\n- If there are errors in screen actions the error message is displayed\n instead of rendering the widgets (usually just resulting in more errors)\n\n\n## Long Term To Do List - aka Informal Road Map\n\n- Support local printers, scales, etc in web-based apps using https://qz.io/\n\n- PDF, Office, etc document indexing for wiki attachments (using Apache Tika)\n- Wiki page version history with full content history diff, etc; store just differences, lib for that?\n - https://code.google.com/archive/p/java-diff-utils/\n - compile group: 'com.googlecode.java-diff-utils', name: 'diffutils', version: '1.3.0'\n - https://bitbucket.org/cowwoc/google-diff-match-patch/\n - compile group: 'org.bitbucket.cowwoc', name: 'diff-match-patch', version: '1.1'\n\n- Option for transition to only mount if all response URLs for screen paths exist\n\n- Saved form-list Finds\n - Save settings for a user or group to share (i.e. associate with userId or userGroupId). Allow for any group a user is in.\n - allow different aggregate/show-total/etc options in select-columns, more complex but makes sense?\n - add form-list presets in xml file, like saved finds but perhaps more options? allow different aggregate settings in presets?\n\n- form-list data prep, more self-contained\n - X form-list.entity-find element support instead of form-list.@list attribute\n - _ form-list.service-call\n - _ also more general form-list.actions element?\n- form-single.entity-find-one element support, maybe form-single.actions too\n\n- Instance Provisioning and Management\n - embedded and gradle docker client (for docker host or docker swarm)\n - direct through Docker API\n - https://docs.docker.com/engine/reference/commandline/dockerd/#bind-docker-to-another-host-port-or-a-unix-socket\n - https://docs.docker.com/engine/security/https/\n - https://docs.docker.com/engine/reference/api/docker_remote_api/\n\n- Support incremental (add/subtract) updates in EntityValue.update() or a variation of it; deterministic DB style\n- Support seek for faster pagination like jOOQ: https://blog.jooq.org/2013/10/26/faster-sql-paging-with-jooq-using-the-seek-method/\n\n- Improved Distributed Datasource Support\n - Put all framework, mantle entities in the 4 new groups: transactional, nontransactional, configuration, analytical\n - Review warnings about view-entities that have members in multiple groups (which may be in different databases)\n - Test with transactional in H2 and nontransactional, configuration, analytical in OrientDB\n - Known changes needed\n - Check distributed foreign keys in create, update, delete (make sure records exist or don't exist in other databases)\n - Add augment-member to view-entity that can be in a separate database\n - Make it easier to define view-entity so that caller can treat it mostly as a normal join-based view\n - Augment query results with optionally cached values from records in a separate database\n - For conditions on fields from augment-member do a pre-query to get set of PKs, use them in an IN condition on\n the main query (only support simple AND scenario, error otherwise); sort of like a sub-select\n - How to handle order by fields on augment-member? Might require separate query and some sort of fancy sorting...\n - Some sort of EntityDynamicView handling without joins possible? Maybe augment member methods?\n - DataDocument support across multiple databases, doing something other than one big dynamic join...\n - Possibly useful\n - Consider meta-data management features such as versioning and more complete history for nontransactional and\n configuration, preferably using some sort of more efficient underlying features in the datasource\n (like Jackrabbit/Oak; any support for this in OrientDB? ElasticSearch keeps version number for concurrency, but no history)\n - Write EntityFacade interface for ElasticSearch to use like OrientDB?\n - Support persistence through EntityFacade as nested documents, ie specify that detail/etc entities be included in parent/master document\n - SimpleFind interface as an alternative to EntityFind for datasources that don't support joins, etc (like OrientDB)\n and maybe add support for the internal record ID that can be used for faster graph traversal, etc\n\n- Try Caffeine JCache at https://github.com/ben-manes/caffeine\n - do in moqui-caffeine tool component\n - add multiple threads to SpeedTest.xml?\n\n- WebSocket Notifications\n - Increment message, event, task count labels in header?\n - DataDocument add flag if new or updated\n - if new increment count with JS\n - Side note: DataDocument add info about what was updated somehow?\n- User Notification\n - Add Moqui Conf XML elements to configure NotificationMessageListener classes\n - Listener to send Email with XML Screen to layout (and try out using JSON documents as nested Maps from a screen)\n - where to configure the email and screen to use? use EmailTemplate/emailTemplateId, but where to specify?\n - for notifications from DataFeeds can add DataFeed.emailTemplateId (or not, what about toAddresses, etc?)\n - maybe have a more general way to configure details of topics, including emailTemplateId and screenLocation...\n\n- Hazelcast based improvements\n - configuration for 'microservice' deployments, partitioning services to run on particular servers in a cluster and\n not others (partition groups or other partition feature?)\n - can use for reliable WAN service calls like needed for EntitySync?\n - ie to a remote cluster\n - different from commercial only WAN replication feature\n - would be nice for reliable message queue\n - Quartz Scheduler\n - can use Hazelcast for scheduled service execution in a cluster, perhaps something on top of, underneath, or instead of Quartz Scheduler?\n - consider using Hazelcast as a Quartz JobStore, ie: https://github.com/FlavioF/quartz-scheduler-hazelcast-jobstore\n - DB (or ElasticSearch?) MapStore for persisted (backed up) Hazelcast maps\n - use MapStore and MapLoader interfaces\n - see http://docs.hazelcast.org/docs/latest/manual/html-single/index.html#loading-and-storing-persistent-data\n - https://github.com/mozilla-metrics/bagheera-elasticsearch\n - older, useful only as a reference for implementing something like this in Moqui\n - best to implement something using the EntityFacade for easier configuration, etc\n - see JDBC, etc samples: https://github.com/hazelcast/hazelcast-code-samples/tree/master/distributed-map/mapstore/src/main/java\n - Persisted Queue for Async Services, etc\n - use QueueStore interface\n - see http://docs.hazelcast.org/docs/latest/manual/html-single/index.html#queueing-with-persistent-datastore\n - use DB?\n\n- XML Screens\n - Screen section-iterate pagination\n - Screen form automatic client JS validation for more service in-parameters\n for: number-range, text-length, text-letters, time-range, credit-card.@types\n - Dynamic Screens (database-driven: DynamicScreen* entities)\n- Entity Facade\n - LiquiBase integration (entity.change-set element?)\n - Add view log, like current change audit log (AuditLogView?)\n - Improve entity cache auto-clear performance using ehcache search\n http://ehcache.org/generated/2.9.0/html/ehc-all/#page/Ehcache_Documentation_Set%2Fto-srch_searching_a_cache.html%23\n- Artifact Execution Facade\n - Call ArtifactExecutionFacade.push() (to track, check authz, etc) for\n other types of artifacts (if/as determined to be helpful), including:\n Component, Webapp, Screen Section, Screen Form, Screen Form Field,\n Template, Script, Entity Field\n - For record-level authz automatically add constraints to queries if\n the query follows an adequate pattern and authz requires it, or fail\n authz if can't add constraint\n- Tools Screens\n - Auto Screen\n - Editable data grid, created by form-list, for detail and assoc related entities\n - Entity\n - Entity model internal check (relationship, view-link.key-map, ?)\n - Database meta-data check/report against entity definitions; NOTE: use LiquiBase for this\n - Script Run (or groovy shell?)\n - Service\n - Configure and run chain of services (dynamic wizard)\n - Artifact Info screens (with in/out references for all)\n - Screen tree and graph browse screen\n - Entity usage/reference section\n - Service usage/reference section on ServiceDetail screen\n - Screen to install a component (upload and register, load data from it; require special permission for this, not enabled on the demo server)\n\n- Data Document and Feed\n - API (or service?) push outstanding data changes (registration/connection, time trigger; tie to SystemMessage)\n - API (or service?) receive/persist data change messages - going reverse of generation for DataDocuments... should be interesting\n - Consumer System Registry\n - feed transport (for each: supports confirmation?)\n - WebSocket (use Notification system, based on notificationName (and userId?))\n - Service to send email from DataFeed (ie receive#DataFeed implementation), use XML Screen for email content\n - don't do this directly, do through NotificationMessage, ie the next item... or maybe not, too many parameters for\n email from too many places related to a DataDocument, may not be flexible enough and may be quite messy\n - Service (receive#DataFeed impl) to send documents as User NotificationMessages (one message per DataDocument); this\n is probably the best way to tie a feed to WebSocket notifications for data updates\n - Use the dataFeedId as the NotificationMessage topic\n - Use this in HiveMind to send notifications of project, task, and wiki changes (maybe?)\n\n- Integration\n - OData V4 (http://www.odata.org) compliant entity auto REST API\n - like current but use OData URL structure, query parameters, etc\n - mount on /odata4 as alternative to existing /rest\n - generate EDMX for all entities (and exported services?)\n - use Apache Olingo (http://olingo.apache.org)\n - see: https://templth.wordpress.com/2015/04/27/implementing-an-odata-service-with-olingo/\n - also add an ElasticSearch interface? https://templth.wordpress.com/2015/04/03/handling-odata-queries-with-elasticsearch/\n - Generate minimal Data Document based on changes (per TX possible, runs async so not really; from existing doc, like current ES doc)\n - Update database from Data Document\n - Data Document UI\n - show/edit field, rel alias, condition, link\n - special form for add (edit?) field with 5 drop-downs for relationships, one for field, all updated based on\n master entity and previous selections\n - Data Document REST interface\n - get single by dataDocumentId and PK values for primary entity\n - search through ElasticSearch for those with associated feed/index\n - json-schema, RAML, Swagger API defs\n - generic service for sending Data Document to REST (or other?) end point\n - Service REST API\n - allow mapping DataDocument operations as well\n - Add attribute for resource/method like screen for anonymous and no authz access\n - OAuth2 Support\n - Simple OAuth2 for authentication only\n - https://tools.ietf.org/html/draft-ietf-oauth-v2-27#section-4.4\n - use current api key functionality, or expand for limiting tokens to a particular client by registered client ID\n - Use Apache Oltu, see https://cwiki.apache.org/confluence/display/OLTU/OAuth+2.0+Authorization+Server\n - Spec at http://tools.ietf.org/html/rfc6749\n - http://oltu.apache.org/apidocs/oauth2/reference/org/apache/oltu/oauth2/as/request/package-summary.html\n - http://search.maven.org/#search|ga|1|org.apache.oltu\n - https://stormpath.com/blog/build-api-restify-stormpath/\n - https://github.com/PROCERGS/login-cidadao/blob/master/app/Resources/doc/en/examplejava.md\n - https://github.com/swagger-api/swagger-ui/issues/807\n - Add authz and token transitions in rest.xml\n - Support in Service REST API (and entity/master?)\n - Add examples of auth and service calls using OAuth2\n - Add OAuth2 details in Swagger and RAML files\n - More?\n\n- AS2 Client and Server\n - use OpenAS2 (http://openas2.sourceforge.net, https://github.com/OpenAS2/OpenAs2App)?\n - tie into SystemMessage for send/receive (with AS2 service for send, code to receive SystemMessage from AS2 server)\n\n- Email verification by random code on registration and email change\n- Login through Google, Facebook, etc\n - OpenID, SAML, OAuth, ...\n - https://developers.facebook.com/docs/facebook-login/login-flow-for-web/v2.0\n\n- Workflow that manages activity flow with screens and services attached to\n activities, and tasks based on them taking users to defined or automatic\n screen; see BonitaSoft.com Open Source BPM for similar concept; generally\n workflow without requiring implementation of an entire app once the\n workflow itself is defined\n\n"
},
{
"path": "SECURITY.md",
"content": "# Security Policy\n\n## Supported Versions\n\nThe primary supported version for each repository is the latest commit in the master (primary) branch.\n\nMoqui Ecosystem projects are maintained by volunteer contributors, primarily people who use and work with the code as part of their employment or professional services. There are periodic community releases but most distributions and releases involve custom code and are managed, internally or publicly, by third parties. Community releases are checkpoint releases, not maintained release branches, and are best for evaluation rather than production use.\n\nMoqui uses a 'continous release' approach for managing code repositories. Aside from new (work-in-progress) and archived repositories, the master branch in each repository is considered production ready. Rather than running a centrally dictated release schedule and process, the focus is on keeping master branches in a production ready state so that users may use whatever release process and frequency they prefer.\n\nFor most use cases we recommend using code directly from the master branch in each repository. For stabilization and periodic updates (instead of continuous) we recommend using a fork for each git repository with an 'upstream' remote pointing to the Moqui Ecosystem repository for easy upstream updates.\n\n## Reporting a Vulnerability\n\nTo report security issues that should not be disclosed publicly before they are fixed, please use the private **[moqui-board@googlegroups.com](mailto:moqui-board@googlegroups.com)** mailing list. This is setup so that anyone can send messages to it, but only members of the group can read the messages.\n\n## Issues and Pull Requests\n\nFor more information on submitting issues and pull requests please see the [Issue and Pull Request Guide](https://moqui.org/m/docs/moqui/Issue+and+Pull+Request+Guide) on moqui.org.\n"
},
{
"path": "addons.xml",
"content": "\n \n\n \n \n \n \n \n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n\n \n \n\n \n \n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n \n\n \n \n \n\n \n \n \n \n \n\n \n \n\n \n \n\n \n \n \n \n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n \n \n \n \n \n \n\n \n \n \n \n\n \n\n"
},
{
"path": "build.gradle",
"content": "/*\n * This software is in the public domain under CC0 1.0 Universal plus a\n * Grant of Patent License.\n *\n * To the extent possible under law, the author(s) have dedicated all\n * copyright and related and neighboring rights to this software to the\n * public domain worldwide. This software is distributed without any\n * warranty.\n *\n * You should have received a copy of the CC0 Public Domain Dedication\n * along with this software (see the LICENSE.md file). If not, see\n * .\n */\nplugins {\n id 'com.github.ben-manes.versions' version '0.53.0'\n id 'org.ajoberstar.grgit' version '5.3.3'\n}\n\n// Filters dependencyUpdates to report only stable (official) releases\n// Use `./gradlew dependencyUpdates` to check which packages are upgradable in all components\ndependencyUpdates.resolutionStrategy {\n componentSelection { rules ->\n rules.all { ComponentSelection selection ->\n boolean rejected = ['alpha', 'beta', 'rc', 'cr', 'm', 'b'].any { qualifier ->\n selection.candidate.version ==~ /(?i).*[.-]${qualifier}[.\\d-].*/\n }\n if (rejected) selection.reject('Release candidate')\n }\n }\n}\n\n// Run headless so GradleWorkerMain does not steal focus (mostly a macOS annoyance)\nallprojects {\n tasks.withType(JavaForkOptions) {\n jvmArgs '-Djava.awt.headless=true'\n }\n repositories {\n mavenCentral()\n }\n}\n\nimport groovy.util.Node\nimport groovy.xml.XmlParser\nimport groovy.xml.XmlSlurper\nimport org.ajoberstar.grgit.*\n\ndefaultTasks 'build'\n\ndef openSearchVersion = '3.4.0'\ndef elasticSearchVersion = '7.10.2'\n\ndef tomcatHome = '../apache-tomcat'\n// no longer include version in war file name: def getWarName() { 'moqui-' + childProjects.framework.version + '.war' }\ndef getWarName() { 'moqui.war' }\ndef plusRuntimeName = 'moqui-plus-runtime.war'\ndef execTempDir = 'execwartmp'\ndef moquiRuntime = 'runtime'\n\ndef moquiConfDev = 'conf/MoquiDevConf.xml'\ndef moquiConfProduction = 'conf/MoquiProductionConf.xml'\n\ndef allCleanTasks = getTasksByName('clean', true)\ndef allBuildTasks = getTasksByName('build', true)\ndef allTestTasks = getTasksByName('test', true)\nallTestTasks.each { it.systemProperties << System.properties.subMap(getDefaultPropertyKeys()) }\n// kill the build -> check -> test dependency, only run tests explicitly and not always on build\ngetTasksByName('check', true).each { it.dependsOn.clear() }\n\nSet getComponentTestTasks() {\n Set testTasks = new LinkedHashSet()\n for (Project subProject in getSubprojects())\n if (subProject.getPath().startsWith(':runtime:component:')) testTasks.addAll(subProject.getTasksByName('test', false))\n return testTasks\n}\ndef getDefaultPropertyKeys() {\n def defaultProperties = []\n Node confXml = new XmlParser().parse(file('framework/src/main/resources/MoquiDefaultConf.xml'))\n for (Node defaultProperty in confXml.'default-property') { defaultProperties << defaultProperty.'@name' }\n defaultProperties\n}\n\n// ========== clean tasks ==========\n\ntask clean(type: Delete) { delete file(warName); delete file(execTempDir); delete file('wartemp'); cleanVersionDetailFiles() }\ntask cleanTempDir(type: Delete) { delete file(execTempDir) }\ntask cleanDb { doLast {\n if (!file(moquiRuntime).exists()) return\n delete files(file(moquiRuntime+'/db/derby').listFiles()) - files(moquiRuntime+'/db/derby/derby.properties')\n delete file(moquiRuntime+'/db/h2')\n delete file(moquiRuntime+'/db/orientdb/databases')\n delete fileTree(dir: moquiRuntime+'/txlog', include: '*')\n cleanElasticSearch(moquiRuntime)\n} }\ntask cleanLog(type: Delete) { delete fileTree(dir: moquiRuntime+'/log', include: '*') }\ntask cleanSessions(type: Delete) { delete fileTree(dir: moquiRuntime+'/sessions', include: '*') }\ntask cleanLoadSave(type: Delete) { delete file('SaveH2.zip'); delete file('SaveDEFAULT.zip')\n delete file('SaveTransactional.zip'); delete file('SaveAnalytical.zip'); delete file('SaveOrientDb.zip')\n delete file('SaveElasticSearch.zip'); delete file('SaveOpenSearch.zip') }\ntask cleanPlusRuntime(type: Delete) { delete file(plusRuntimeName) }\ntask cleanOther(type: Delete) { delete fileTree(dir: '.', includes: ['**/.nbattrs', '**/*~', '**/.#*', '**/.DS_Store', '**/*.rej', '**/*.orig']) }\n\ntask cleanAll { dependsOn clean, allCleanTasks, cleanDb, cleanLog, cleanSessions, cleanLoadSave, cleanPlusRuntime }\n\n// ========== ElasticSearch tasks (for install in runtime/elasticsearch) ==========\n\ndef cleanElasticSearch(String moquiRuntime) {\n File osDir = file(moquiRuntime + '/opensearch')\n String workDir = moquiRuntime + (osDir.exists() ? '/opensearch' : '/elasticsearch')\n if (file(workDir+'/bin').exists()) {\n def pidFile = file(workDir+'/pid')\n if (pidFile.exists()) {\n String pid = pidFile.getText()\n logger.lifecycle(\"${osDir.exists() ? 'OpenSearch' : 'ElasticSearch'} running with pid ${pid}, stopping before deleting data then restarting\")\n ['kill', pid].execute(null, file(workDir)).waitFor()\n ['tail', \"--pid=${pid}\", '-f', '/dev/null'].execute(null, file(workDir)).waitFor()\n\n delete file(workDir+'/data')\n if (file(workDir+'/logs').exists()) delete files(file(workDir+'/logs').listFiles())\n if (pidFile.exists()) delete pidFile\n\n startSearch()\n } else {\n logger.lifecycle(\"Found ${osDir.exists() ? 'OpenSearch' : 'ElasticSearch'} in ${workDir}/bin directory but no pid, deleting data without stop/start; WARNING if ${osDir.exists() ? 'OpenSearch' : 'ElasticSearch'} is running this will cause problems!\")\n delete file(workDir+'/data')\n if (file(workDir+'/logs').exists()) delete files(file(workDir+'/logs').listFiles())\n }\n } else {\n delete file(workDir+'/data')\n if (file(workDir+'/logs').exists()) delete files(file(workDir+'/logs').listFiles())\n }\n}\ntask downloadOpenSearch { doLast {\n // NOTE: works with Linux and macOS\n // TODO: Windows support...\n String distType = \"tar.gz\"\n // https://artifacts.opensearch.org/releases/core/opensearch/1.3.1/opensearch-min-1.3.1-linux-x64.tar.gz\n String esUrl = \"https://artifacts.opensearch.org/releases/core/opensearch/${openSearchVersion}/opensearch-min-${openSearchVersion}-linux-x64.${distType}\"\n String targetDirPath = moquiRuntime + '/opensearch'\n String esExtraDirPath = targetDirPath + '/opensearch-' + openSearchVersion\n File targetDir = file(targetDirPath)\n if (targetDir.exists()) { logger.lifecycle(\"Found directory at ${targetDirPath}, deleting\"); delete targetDir }\n File zipFile = file(\"${moquiRuntime}/opensearch-min-${openSearchVersion}-linux-x64.${distType}\")\n if (!zipFile.exists()) {\n logger.lifecycle(\"Downloading OpenSearch from ${esUrl}\")\n ant.get(src: esUrl, dest: zipFile)\n } else {\n logger.lifecycle(\"Found OpenSearch archive at ${zipFile.getPath()}, using that instead of downloading\")\n }\n // the eachFile closure removes the first path from each file, moving everything up a directory, which also requires delete of the extra dirs\n copy { from distType == \"zip\" ? zipTree(zipFile) : tarTree(zipFile); into targetDir; eachFile {\n def pathList = it.getRelativePath().getSegments() as List\n if (pathList[0] == \".\") pathList = pathList.tail()\n it.setPath(pathList.tail().join(\"/\"))\n return it\n } }\n\n // make sure there is a logs directory, OpenSearch (just like ES) has start error without it\n File esLogsDir = file(targetDirPath + '/logs')\n if (!esLogsDir.exists()) esLogsDir.mkdir()\n\n File extraDir = file(esExtraDirPath)\n if (extraDir.exists()) delete extraDir\n\n delete zipFile\n}}\ntask downloadElasticSearch { doLast {\n String suffix\n String distType\n String osName = System.getProperty(\"os.name\").toLowerCase()\n if (osName.startsWith(\"windows\")) {\n suffix = \"windows-x86_64.zip\"\n distType = \"zip\"\n } else if (osName.startsWith(\"mac\")) {\n suffix = \"darwin-x86_64.tar.gz\"\n distType = \"tar.gz\"\n } else {\n suffix = \"linux-x86_64.tar.gz\"\n distType = \"tar.gz\"\n }\n String esUrl = \"https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-oss-${elasticSearchVersion}-no-jdk-${suffix}\"\n String targetDirPath = moquiRuntime + '/elasticsearch'\n String esExtraDirPath = targetDirPath + '/elasticsearch-' + elasticSearchVersion\n File targetDir = file(targetDirPath)\n if (targetDir.exists()) { logger.lifecycle(\"Found directory at ${targetDirPath}, deleting\"); delete targetDir }\n File zipFile = file(\"${targetDirPath}-${elasticSearchVersion}.${distType}\")\n if (!zipFile.exists()) {\n logger.lifecycle(\"Downloading ElasticSearch from ${esUrl}\")\n ant.get(src: esUrl, dest: zipFile)\n } else {\n logger.lifecycle(\"Found ElasticSearch archive at ${zipFile.getPath()}, using that instead of downloading\")\n }\n // the eachFile closure removes the first path from each file, moving everything up a directory, which also requires delete of the extra dirs\n copy { from distType == \"zip\"? zipTree(zipFile) : tarTree(zipFile); into targetDir; eachFile {\n def pathList = it.getRelativePath().getSegments() as List\n if (pathList[0] == \".\") pathList = pathList.tail()\n it.setPath(pathList.tail().join(\"/\"))\n return it\n } }\n\n // make sure there is a logs directory, ES start error without it\n File esLogsDir = file(targetDirPath + '/logs')\n if (!esLogsDir.exists()) esLogsDir.mkdir()\n\n File extraDir = file(esExtraDirPath)\n if (extraDir.exists()) delete extraDir\n\n delete zipFile\n}}\n/* startElasticSearch old approach, with ES 7.10.2 and OpenSearch never exits, gradle just sits there doing nothing (though same command in terminal does exit)\ntask startElasticSearch(type:Exec) {\n File osDir = file(moquiRuntime + '/opensearch')\n workingDir moquiRuntime + (osDir.exists() ? '/opensearch' : '/elasticsearch')\n commandLine (osDir.exists() ? ['./bin/opensearch', '-d', '-p', 'pid'] : ['./bin/elasticsearch', '-d', '-p', 'pid'])\n ignoreExitValue true\n onlyIf { (file(moquiRuntime + '/elasticsearch/bin').exists() || file(moquiRuntime + '/opensearch/bin').exists())\n && !file(moquiRuntime + '/elasticsearch/pid').exists() && !file(moquiRuntime + '/opensearch/pid').exists() }\n doFirst {\n logger.lifecycle(\"Starting ${osDir.exists() ? 'OpenSearch' : 'ElasticSearch'} installed in runtime/${osDir.exists() ? 'opensearch' : 'elasticsearch'}\")\n }\n}\n*/\nvoid startSearch(String moquiRuntime) {\n File osDir = file(moquiRuntime + '/opensearch')\n String workDir = moquiRuntime + (osDir.exists() ? '/opensearch' : '/elasticsearch')\n def pidFile = file(workDir + '/pid')\n def binFile = file(workDir + '/bin')\n if (binFile.exists() && !pidFile.exists()) {\n logger.lifecycle(\"Starting ${osDir.exists() ? 'OpenSearch' : 'ElasticSearch'} installed in ${workDir}\")\n ProcessBuilder pb = new ProcessBuilder((osDir.exists() ? './bin/opensearch' : './bin/elasticsearch'), '-d', '-p', 'pid')\n pb.directory(file(workDir))\n pb.redirectOutput()\n pb.redirectError()\n pb.inheritIO()\n logger.lifecycle(\"Starting process with command ${pb.command()} in ${pb.directory().path}\")\n try {\n Process proc = pb.start()\n // logger.lifecycle(\"ran start waiting...\")\n int result = proc.waitFor()\n logger.lifecycle(\"Process finished with ${result}\")\n } catch (Exception e) {\n logger.lifecycle(\"Error starting ${osDir.exists() ? 'OpenSearch' : 'ElasticSearch'}\", e)\n }\n } else {\n if (pidFile.exists()) logger.lifecycle(\"Not Starting ${osDir.exists() ? 'OpenSearch' : 'ElasticSearch'} installed in ${workDir}, pid file already exists\")\n if (!binFile.exists()) logger.lifecycle(\"Not Starting ${osDir.exists() ? 'OpenSearch' : 'ElasticSearch'}, no ${workDir}/bin directory found\")\n }\n}\ntask startElasticSearch { doLast {\n startSearch(moquiRuntime)\n} }\nvoid stopSearch(String moquiRuntime) {\n File osDir = file(moquiRuntime + '/opensearch')\n String workDir = moquiRuntime + (osDir.exists() ? '/opensearch' : '/elasticsearch')\n def pidFile = file(workDir + '/pid')\n def binFile = file(workDir + '/bin')\n if (pidFile.exists() && binFile.exists()) {\n String pid = pidFile.getText()\n logger.lifecycle(\"Stopping ${osDir.exists() ? 'OpenSearch' : 'ElasticSearch'} installed in ${workDir} with pid ${pid}\")\n [\"kill\", pid].execute(null, file(workDir)).waitFor()\n if (pidFile.exists()) delete pidFile\n } else {\n if (!pidFile.exists()) logger.lifecycle(\"Not Stopping ${osDir.exists() ? 'OpenSearch' : 'ElasticSearch'} installed in ${workDir}, no pid file found\")\n if (!binFile.exists()) logger.lifecycle(\"Not Stopping ${osDir.exists() ? 'OpenSearch' : 'ElasticSearch'}, no ${workDir}/bin directory found\")\n }\n}\ntask stopElasticSearch { doLast {\n stopSearch(moquiRuntime)\n} }\n\n// ========== JDBC driver download tasks ==========\n\ntask getPostgresJdbc {\n description = \"Download the latest PostgreSQL JDBC driver to runtime/lib\"\n dependsOn 'getRuntime'\n doLast {\n def libDir = file(moquiRuntime + '/lib')\n if (!libDir.exists()) libDir.mkdirs()\n\n // Remove existing Postgres JAR files\n fileTree(dir: libDir, include: 'postgres*.jar').each { it.delete() }\n\n // Get the latest version from Maven repository\n def metadataUrl = 'https://repo1.maven.org/maven2/org/postgresql/postgresql/maven-metadata.xml'\n def metadataFile = file(\"${buildDir}/postgresql-maven-metadata.xml\")\n ant.get(src: metadataUrl, dest: metadataFile)\n def metadata = new XmlSlurper().parse(metadataFile)\n def latestVersion = metadata.versioning.latest.text()\n metadataFile.delete()\n\n // Download the latest version\n def downloadUrl = \"https://repo1.maven.org/maven2/org/postgresql/postgresql/${latestVersion}/postgresql-${latestVersion}.jar\"\n def jarFile = file(\"${libDir}/postgresql-${latestVersion}.jar\")\n logger.lifecycle(\"Downloading PostgreSQL JDBC driver ${latestVersion} from ${downloadUrl}\")\n ant.get(src: downloadUrl, dest: jarFile)\n logger.lifecycle(\"Downloaded PostgreSQL JDBC driver to ${jarFile}\")\n }\n}\n\ntask getMySqlJdbc {\n description = \"Download the latest MySQL JDBC driver to runtime/lib\"\n dependsOn 'getRuntime'\n doLast {\n def libDir = file(moquiRuntime + '/lib')\n if (!libDir.exists()) libDir.mkdirs()\n\n // Remove existing MySQL connector JAR files\n fileTree(dir: libDir, include: 'mysql-connector*.jar').each { it.delete() }\n\n // Get the latest version from Maven repository\n def metadataUrl = 'https://repo1.maven.org/maven2/com/mysql/mysql-connector-j/maven-metadata.xml'\n def metadataFile = file(\"${buildDir}/mysql-connector-j-maven-metadata.xml\")\n ant.get(src: metadataUrl, dest: metadataFile)\n def metadata = new XmlSlurper().parse(metadataFile)\n def latestVersion = metadata.versioning.latest.text()\n metadataFile.delete()\n\n // Download the latest version\n def downloadUrl = \"https://repo1.maven.org/maven2/com/mysql/mysql-connector-j/${latestVersion}/mysql-connector-j-${latestVersion}.jar\"\n def jarFile = file(\"${libDir}/mysql-connector-j-${latestVersion}.jar\")\n logger.lifecycle(\"Downloading MySQL JDBC driver ${latestVersion} from ${downloadUrl}\")\n ant.get(src: downloadUrl, dest: jarFile)\n logger.lifecycle(\"Downloaded MySQL JDBC driver to ${jarFile}\")\n }\n}\n\n// ========== development tasks ==========\ntask setupIntellij {\n description = \"Adds all XML catalog items to intellij to enable autocomplete\"\n doLast {\n def ideaDir = \"${rootDir}/.idea\"\n def parser = new XmlSlurper()\n parser.setFeature(\"http://apache.org/xml/features/disallow-doctype-decl\", false)\n parser.setFeature(\"http://apache.org/xml/features/nonvalidating/load-external-dtd\", false)\n def catalogEntries = parser.parse(file(\"${rootDir}/framework/xsd/framework-catalog.xml\"))\n .system\n .list()\n .stream()\n .map { [url: it.@systemId, location: \"\\$PROJECT_DIR\\$/framework/xsd/${it.@uri}\"] }\n .collect(java.util.stream.Collectors.toList())\n mkdir ideaDir\n def rawXml\n def miscFile = file(\"${ideaDir}/misc.xml\")\n if (!miscFile.exists()) {\n def builder = new groovy.xml.StreamingMarkupBuilder()\n builder.encoding = 'UTF-8'\n rawXml = builder.bind {\n project(version: '4') {\n component(name: 'ExternalStorageConfigurationManager', enabled: true)\n component(name: 'ProjectResources') {\n catalogEntries.each { resource(url: it.url, location: it.location) }\n }\n }\n }\n } else {\n def projectNode = parser.parse(miscFile)\n def resourcesNode = projectNode.children().find { it.@name == 'ProjectResources' }\n if (resourcesNode.size() == 0) {\n projectNode.appendNode {\n component(name: 'ProjectResources') {\n catalogEntries.each { resource(url: it.url, location: it.location) }\n }\n }\n } else {\n catalogEntries.each { cat ->\n def existingEntry = resourcesNode.children().find { it.@url == cat.url }\n if (existingEntry.size() > 0) {\n existingEntry.replaceNode { resource(url: cat.url, location: cat.location) }\n } else {\n resourcesNode.appendNode { resource(url: cat.url, location: cat.location) }\n }\n }\n }\n rawXml = projectNode\n }\n def misc = groovy.xml.XmlUtil.serialize(rawXml)\n miscFile.write(misc)\n }\n}\n\ntask setupVscode {\n description = \"Configures VS Code settings with runtime directory exclusions\"\n doLast {\n def settingsFile = file(\"${rootDir}/.vscode/settings.json\")\n mkdir settingsFile.parentFile\n \n def settings = (settingsFile.exists() && settingsFile.length() > 0) ? \n new groovy.json.JsonSlurper().parseText(settingsFile.text) : [:]\n \n // Disable gitignore for search (so we can manually exclude build/runtime dirs)\n settings['search.useIgnoreFiles'] = false\n \n // Add search.exclude if missing\n if (!settings['search.exclude']) settings['search.exclude'] = [:]\n \n // Add exclusion patterns\n settings['search.exclude']['**/build'] = true\n settings['search.exclude']['runtime/{log,sessions,txlog,db,elasticsearch,opensearch}'] = true\n \n // Write formatted JSON\n settingsFile.text = groovy.json.JsonOutput.prettyPrint(groovy.json.JsonOutput.toJson(settings))\n logger.lifecycle(\"VS Code settings updated at ${settingsFile}\")\n }\n}\n\n// ========== test task ==========\n// NOTE1: to run startElasticSearch before the first test task add it as a dependency to all test tasks\n// NOTE2: to run stopElasticSearch after the last test task make all test tasks finalizedBy stopElasticSearch\ngetTasksByName('test', true).each {\n if (it.path != ':test') {\n // logger.lifecycle(\"Adding dependencies for test task ${it.getPath()}\")\n it.dependsOn(startElasticSearch)\n it.finalizedBy(stopElasticSearch)\n }\n}\n\n// ========== check/update tasks ==========\n\ntask getRuntime {\n description = \"If the runtime directory does not exist get it using settings in myaddons.xml or addons.xml; also check default components in myaddons.xml (addons.@default) and download any missing\"\n doLast { checkRuntimeDirAndDefaults(project.hasProperty('locationType') ? locationType : null) }\n}\ntask checkRuntime { doLast {\n if (!file('runtime').exists()) throw new GradleException(\"Required 'runtime' directory not found. Use 'gradle getRuntime' or 'gradle getComponent' or manually clone the moqui-runtime repository. This must be done in a separate Gradle run before a build so Gradle can find and run build tasks.\")\n} }\ntask gitPullAll {\n description = \"Do a git pull to update moqui, runtime, and each installed component (for each where a .git directory is found)\"\n doLast {\n // framework and runtime\n if (file(\".git\").exists()) { doGitPullWithStatus(file('.').path) }\n if (file(\"runtime/.git\").exists()) { doGitPullWithStatus(file('runtime').path) }\n // all directories under runtime/component\n for (File compDir in file('runtime/component').listFiles().findAll { it.isDirectory() && it.listFiles().find { it.name == '.git' } }) {\n doGitPullWithStatus(compDir.path)\n }\n }\n}\ndef doGitPullWithStatus(def gitDir) {\n try {\n def curGrgit = Grgit.open(dir: gitDir)\n logger.lifecycle(\"\\nPulling ${gitDir} (branch:${curGrgit.branch.current()?.name}, tracking:${curGrgit.branch.current()?.trackingBranch?.name})\")\n\n def beforeHead = curGrgit.head()\n curGrgit.pull()\n def afterHead = curGrgit.head()\n if (beforeHead == afterHead) {\n logger.lifecycle(\"Already up-to-date.\")\n } else {\n List commits = curGrgit.log { range(beforeHead, afterHead) }\n for (Commit commit in commits) logger.lifecycle(\"- ${commit.getAbbreviatedId(7)} by ${commit.committer?.name}: ${commit.shortMessage}\")\n }\n } catch (Throwable t) {\n logger.error(t.message)\n }\n}\ntask gitCheckoutAll {\n description = \"Do a git checkout on moqui, runtime, and each installed component (for each where a .git directory is found); use -Pbranch= (required) to specify a branch, use -Pcreate=true to create branches with the given name\"\n doLast {\n if (!project.hasProperty('branch')) throw new InvalidUserDataException(\"No branch property specified (use -Pbranch=...)\")\n String curBranch = branch\n String curTag = (project.hasProperty('tag') ? tag : null) ?: curBranch\n boolean createBranch = false\n if (project.hasProperty('create') && create == 'true') createBranch = true\n\n List gitDirectories = []\n if (file(\".git\").exists()) gitDirectories.add(file('.').path)\n if (file(\"runtime/.git\").exists()) gitDirectories.add(file('runtime').path)\n for (File compDir in file('runtime/component').listFiles().findAll { it.isDirectory() && it.listFiles().find { it.name == '.git' } })\n gitDirectories.add(compDir.path)\n\n for (String gitDir in gitDirectories) {\n def curGrgit = Grgit.open(dir: gitDir)\n def branchList = curGrgit.branch.list(mode: org.ajoberstar.grgit.operation.BranchListOp.Mode.ALL)\n def tagList = curGrgit.tag.list()\n def targetBranch = branchList.find({ it.name == curBranch })\n def targetTag = tagList.find({ it.name == curTag })\n if (targetBranch == null && targetTag == null) {\n def originBranch = branchList.find({ it.name == 'origin/' + curBranch })\n if (originBranch != null) {\n logger.lifecycle(\"In ${gitDir} branch ${curBranch} not found but found ${originBranch.name}, creating local branch tracking that branch\")\n targetBranch = curGrgit.branch.add(name: curBranch, startPoint: originBranch, mode: org.ajoberstar.grgit.operation.BranchAddOp.Mode.TRACK)\n }\n }\n if (createBranch || targetBranch != null || targetTag != null) {\n if (targetTag != null) {\n if (createBranch && curBranch != curTag) {\n logger.lifecycle(\"== Git checkout ${gitDir} tag ${curTag} and create branch ${curBranch}\")\n try { curGrgit.checkout(branch: curBranch, createBranch: true, startPoint: targetTag) }\n catch (Exception e) { logger.lifecycle(\"Checkout error\", e) }\n } else {\n logger.lifecycle(\"== Git checkout ${gitDir} tag ${curTag}\")\n try { curGrgit.checkout(branch: curTag, createBranch: false) }\n catch (Exception e) { logger.lifecycle(\"Checkout error\", e) }\n }\n } else {\n logger.lifecycle(\"== Git checkout ${gitDir} branch ${curBranch} create ${createBranch}\")\n try { curGrgit.checkout(branch: curBranch, createBranch: createBranch) }\n catch (Exception e) { logger.lifecycle(\"Checkout error\", e) }\n }\n } else {\n logger.lifecycle(\"* No branch or tag '${curBranch}' in ${gitDir}\\nBranches: ${branchList.collect({it.name})}\\nTags: ${tagList.collect({it.name})}\")\n }\n logger.lifecycle(\"\")\n }\n }\n}\ntask gitStatusAll {\n description = \"Do a git status to check moqui, runtime, and each installed component (for each where a .git directory is found)\"\n doLast {\n List gitDirectories = []\n if (file(\".git\").exists()) gitDirectories.add(file('.').path)\n if (file(\"runtime/.git\").exists()) gitDirectories.add(file('runtime').path)\n for (File compDir in file('runtime/component').listFiles().findAll { it.isDirectory() && it.listFiles().find { it.name == '.git' } })\n gitDirectories.add(compDir.path)\n for (String gitDir in gitDirectories) {\n def curGrgit = Grgit.open(dir: gitDir)\n logger.lifecycle(\"\\nGit status for ${gitDir} (branch:${curGrgit.branch.current()?.name}, tracking:${curGrgit.branch.current()?.trackingBranch?.name})\")\n\n try {\n if (curGrgit.remote.list().find({ it.name == 'upstream'})) {\n def upstreamAhead = curGrgit.log { range curGrgit.resolve.toCommit('refs/remotes/upstream/master'), curGrgit.resolve.toCommit('refs/remotes/origin/master') }\n if (upstreamAhead) logger.lifecycle(\"- origin/master ${upstreamAhead.size()} commits ahead of upstream/master\")\n }\n } catch (Exception e) {\n logger.error(\"Error finding commits ahead of upstream\", e)\n }\n try {\n def masterLatest = curGrgit.resolve.toCommit('refs/remotes/origin/master')\n if (masterLatest == null) {\n logger.error(\"No origin/master branch exists, can't determine unpushed commits\")\n } else {\n def unpushed = curGrgit.log { range masterLatest, curGrgit.resolve.toCommit('HEAD') }\n if (unpushed) logger.lifecycle(\"--- ${unpushed.size()} commits unpushed (ahead of origin/master)\")\n for (Commit commit in unpushed) logger.lifecycle(\" - ${commit.getAbbreviatedId(8)} - ${commit.shortMessage}\")\n }\n } catch (Exception e) {\n logger.error(\"Error finding unpushed commits\", e)\n }\n def curStatus = curGrgit.status()\n if (curStatus.isClean()) logger.lifecycle(\"* nothing to commit, working directory clean\")\n if (curStatus.staged.added || curStatus.staged.modified || curStatus.staged.removed) logger.lifecycle(\"--- Changes to be committed::\")\n for (String fn in curStatus.staged.added) logger.lifecycle(\" added: ${fn}\")\n for (String fn in curStatus.staged.modified) logger.lifecycle(\" modified: ${fn}\")\n for (String fn in curStatus.staged.removed) logger.lifecycle(\" removed: ${fn}\")\n if (curStatus.unstaged.added || curStatus.unstaged.modified || curStatus.unstaged.removed) logger.lifecycle(\"--- Changes not staged for commit:\")\n for (String fn in curStatus.unstaged.added) logger.lifecycle(\" added: ${fn}\")\n for (String fn in curStatus.unstaged.modified) logger.lifecycle(\" modified: ${fn}\")\n for (String fn in curStatus.unstaged.removed) logger.lifecycle(\" removed: ${fn}\")\n }\n }\n}\ntask gitUpstreamAll {\n description = \"Do a git pull upstream:master for moqui, runtime, and each installed component (for each where a .git directory is found and has a remote called upstream)\"\n doLast {\n String remoteName = project.hasProperty('remote') ? remote : 'upstream'\n\n List gitDirectories = []\n if (file(\".git\").exists()) gitDirectories.add(file('.').path)\n if (file(\"runtime/.git\").exists()) gitDirectories.add(file('runtime').path)\n for (File compDir in file('runtime/component').listFiles().findAll { it.isDirectory() && it.listFiles().find { it.name == '.git' } })\n gitDirectories.add(compDir.path)\n for (String gitDir in gitDirectories) {\n def curGrgit = Grgit.open(dir: gitDir)\n if (curGrgit.remote.list().find({ it.name == remoteName})) {\n logger.lifecycle(\"\\nGit merge ${remoteName} for ${gitDir}\")\n curGrgit.pull(remote: remoteName, branch: 'master')\n } else {\n logger.lifecycle(\"\\nNo ${remoteName} remote for ${gitDir}\")\n }\n\n }\n }\n}\n\ntask gitTagAll {\n description = \"Do a git add or remove tag on the currently checked out commit in moqui, runtime, and each installed component\"\n doLast {\n def tagName = (project.hasProperty('tag')) ? tag : null;\n def tagMessage = (project.hasProperty('message')) ? message : null;\n\n boolean removeTags = (project.hasProperty('remove') && remove == 'true')\n boolean pushTags = (project.hasProperty('push') && push == 'true')\n\n // Users can simply push tags to the remote\n if (tagName == null && pushTags == false)\n throw new InvalidUserDataException(\"No tag property specified (use -Ptag=...) and No push tag specified (use -Ppush=true)\")\n\n List gitDirectories = []\n if (file(\".git\").exists()) gitDirectories.add(file('.').path)\n if (file(\"runtime/.git\").exists()) gitDirectories.add(file('runtime').path)\n for (File compDir in file('runtime/component').listFiles().findAll { it.isDirectory() && it.listFiles().find { it.name == '.git' } })\n gitDirectories.add(compDir.path)\n\n def frameworkDir = gitDirectories.first()\n for (String gitDir in gitDirectories) {\n def relativePath = \".\"+gitDir.minus(frameworkDir)\n def curGrgit = Grgit.open(dir: gitDir)\n def branchName = curGrgit.branch.current().name\n def commit = curGrgit.log(maxCommits: 1).find()\n\n if (tagName != null) {\n def tagList = curGrgit.tag.list()\n def targetTag = tagList.find({ it.name == tagName })\n\n if (targetTag == null) {\n if (removeTags) {\n logger.lifecycle(\"== Git tag '${tagName}' not found in ${branchName} of ${relativePath} ... skipping\")\n } else {\n curGrgit.tag.add(name: tagName, message: tagMessage ?: \"Tagging version ${tagName}\")\n logger.lifecycle(\"== Git tagging commit ${commit.abbreviatedId} - '${commit.shortMessage}' by '${commit.author.name}' in ${branchName} of ${relativePath}\")\n }\n } else {\n if (removeTags) {\n curGrgit.tag.remove(names: [tagName])\n logger.lifecycle(\"== Git removing tag '${tagName}' in ${branchName} of ${relativePath}\")\n } else {\n logger.lifecycle(\"== Git tag '${tagName}' already exists in ${branchName} of ${relativePath}, skipping...\")\n }\n }\n }\n if (pushTags) {\n if (removeTags) {\n curGrgit.push(refsOrSpecs: [':refs/tags/'+tagName])\n } else {\n curGrgit.push(tags: true)\n }\n logger.lifecycle(\"== Git pushing tag changes to remote of ${relativePath}\")\n }\n }\n }\n}\ntask gitDiffTagsAll {\n description = \"Do a git diff between two tags in the currently checked out branch in moqui, runtime, and each installed component\"\n doLast {\n if (!project.hasProperty('taga') || taga == null)\n throw new InvalidUserDataException(\"No taga property specified (use -Ptaga=...)\")\n\n // If tagb is not passed, we assume HEAD\n def tagb = (project.hasProperty('tagb') && tagb != null) ? tagb : \"HEAD\";\n\n logger.lifecycle(\"== Git diffing tags ${taga} and ${tagb}\")\n\n List gitDirectories = []\n if (file(\".git\").exists()) gitDirectories.add(file('.').path)\n if (file(\"runtime/.git\").exists()) gitDirectories.add(file('runtime').path)\n for (File compDir in file('runtime/component').listFiles().findAll { it.isDirectory() && it.listFiles().find { it.name == '.git' } })\n gitDirectories.add(compDir.path)\n\n def frameworkDir = gitDirectories.first()\n for (String gitDir in gitDirectories) {\n def relativePath = \".\"+gitDir.minus(frameworkDir)\n def grgit = Grgit.open(dir: gitDir)\n\n def tagList = grgit.tag.list()\n def tagaCommit = tagList.find({ it.name == taga })\n def tagbCommit = tagList.find({ it.name == tagb })\n\n logger.lifecycle(\"${relativePath}\")\n\n if ((taga == \"HEAD\" || tagaCommit != null) && (tagb == \"HEAD\" || tagbCommit != null)) {\n grgit.log {\n range taga, tagb\n }.each {\n logger.lifecycle(\" ${it.abbreviatedId} - ${it.shortMessage}\")\n }\n }\n }\n }\n}\n\ntask gitMergeAll {\n description = \"Do a git diff between two tags in the currently checked out branch in moqui, runtime, and each installed component\"\n doLast {\n def branchName = (project.hasProperty('branch')) ? branch : null;\n def tagName = (project.hasProperty('tag')) ? tag : null;\n def mergeMode = (project.hasProperty('mode')) ? mode : null;\n def mergeMessage = (project.hasProperty('message')) ? message : null;\n def pushMerge = (project.hasProperty('push')) ? push : null;\n\n\n List gitDirectories = []\n if (file(\".git\").exists()) gitDirectories.add(file('.').path)\n if (file(\"runtime/.git\").exists()) gitDirectories.add(file('runtime').path)\n for (File compDir in file('runtime/component').listFiles().findAll { it.isDirectory() && it.listFiles().find { it.name == '.git' } })\n gitDirectories.add(compDir.path)\n\n def frameworkDir = gitDirectories.first()\n for (String gitDir in gitDirectories) {\n def relativePath = \".\"+gitDir.minus(frameworkDir)\n logger.lifecycle(\"${relativePath}\")\n def grgit = Grgit.open(dir: gitDir)\n def currentBranch = grgit.branch.current()?.name;\n if (branchName == currentBranch)\n continue\n\n def doMerge = false;\n\n if (branchName && grgit.branch.list().find({ it.name == branchName }) != null) {\n doMerge = true;\n }\n\n if (tagName && grgit.tag.list().find({ it.name == tagName }) != null) {\n doMerge = true;\n }\n\n if (doMerge) {\n grgit.merge(head: branchName ?: tagName, mode: mergeMode, message: mergeMessage)\n logger.lifecycle(\" Merging ${branchName ?: tagName} into ${currentBranch}\")\n }\n\n if (pushMerge) {\n grgit.push();\n logger.lifecycle(\" Pushing merge\")\n }\n }\n }\n}\n\n// ========== run tasks ==========\n\ntask run(type: JavaExec) {\n dependsOn checkRuntime, allBuildTasks, cleanTempDir\n workingDir = '.'; jvmArgs = ['-server', '-XX:-OmitStackTraceInFastThrow']\n systemProperties = ['moqui.conf':moquiConfDev, 'moqui.runtime':moquiRuntime]\n // NOTE: this is a hack, using -jar instead of a class name, and then the first argument is the name of the jar file\n mainClass = '-jar'; args = [warName]\n}\ntask runProduction(type: JavaExec) {\n dependsOn checkRuntime, allBuildTasks, cleanTempDir\n workingDir = '.'; jvmArgs = ['-server', '-Xms1024M']\n systemProperties = ['moqui.conf':moquiConfProduction, 'moqui.runtime':moquiRuntime]\n mainClass = '-jar'; args = [warName]\n}\n\ntask load(type: JavaExec) {\n description = \"Run Moqui to load data; to specify data types use something like: gradle load -Ptypes=seed,seed-initial,install\"\n dependsOn checkRuntime, allBuildTasks\n systemProperties = ['moqui.conf':moquiConfDev, 'moqui.runtime':moquiRuntime]\n workingDir = '.'; jvmArgs = ['-server']; mainClass = '-jar'\n args = [warName, 'load', (project.properties.containsKey('types') ? \"types=${types}\" : \"types=all\")]\n}\ntask loadSeed(type: JavaExec) {\n dependsOn checkRuntime, allBuildTasks\n systemProperties = ['moqui.conf':moquiConfProduction, 'moqui.runtime':moquiRuntime]\n workingDir = '.'; jvmArgs = ['-server']; mainClass = '-jar'\n args = [warName, 'load', (project.properties.containsKey('types') ? \"types=${types}\" : \"types=seed\")]\n}\ntask loadSeedInitial(type: JavaExec) {\n dependsOn checkRuntime, allBuildTasks\n systemProperties = ['moqui.conf':moquiConfProduction, 'moqui.runtime':moquiRuntime]\n workingDir = '.'; jvmArgs = ['-server']; mainClass = '-jar'\n args = [warName, 'load', (project.properties.containsKey('types') ? \"types=${types}\" : \"types=seed,seed-initial\")]\n}\ntask loadProduction(type: JavaExec) {\n dependsOn checkRuntime, allBuildTasks\n systemProperties = ['moqui.conf':moquiConfProduction, 'moqui.runtime':moquiRuntime]\n workingDir = '.'; jvmArgs = ['-server']; mainClass = '-jar'\n args = [warName, 'load', (project.properties.containsKey('types') ? \"types=${types}\" : \"types=seed,seed-initial,install\")]\n}\n\ntask saveDb { doLast {\n if (file(moquiRuntime+'/db/derby/moqui').exists())\n ant.zip(destfile: 'SaveDerby.zip') { fileset(dir: moquiRuntime+'/db/derby/moqui') { include(name: '**/*') } }\n if (file(moquiRuntime+'/db/h2').exists())\n ant.zip(destfile: 'SaveH2.zip') { fileset(dir: moquiRuntime+'/db/h2') { include(name: '**/*') } }\n if (file(moquiRuntime+'/db/orientdb/databases').exists())\n ant.zip(destfile: 'SaveOrientDb.zip') { fileset(dir: moquiRuntime+'/db/orientdb/databases') { include(name: '**/*') } }\n\n File osDir = file(moquiRuntime + '/opensearch')\n String workDir = moquiRuntime + (osDir.exists() ? '/opensearch' : '/elasticsearch')\n if (file(workDir+'/data').exists()) {\n if (file(workDir+'/bin').exists()) {\n def pidFile = file(workDir+'/pid')\n if (pidFile.exists()) {\n String pid = pidFile.getText()\n logger.lifecycle(\"ElasticSearch running with pid ${pid}, stopping before saving data then restarting\")\n ['kill', pid].execute(null, file(workDir)).waitFor()\n ['tail', \"--pid=${pid}\", '-f', '/dev/null'].execute(null, file(workDir)).waitFor()\n if (pidFile.exists()) delete pidFile\n\n ant.zip(destfile: (osDir.exists() ? 'SaveOpenSearch.zip' : 'SaveElasticSearch.zip')) { fileset(dir: workDir+'/data') { include(name: '**/*') } }\n\n startSearch(moquiRuntime)\n } else {\n logger.lifecycle(\"Found ${osDir.exists() ? 'OpenSearch' : 'ElasticSearch'} ${workDir}/bin directory but no pid, saving data without stop/start; WARNING if ElasticSearch is running this will cause problems!\")\n\n ant.zip(destfile: (osDir.exists() ? 'SaveOpenSearch.zip' : 'SaveElasticSearch.zip')) { fileset(dir: workDir+'/data') { include(name: '**/*') } }\n }\n } else {\n ant.zip(destfile: (osDir.exists() ? 'SaveOpenSearch.zip' : 'SaveElasticSearch.zip')) { fileset(dir: workDir+'/data') { include(name: '**/*') } }\n }\n }\n} }\ntask loadSave {\n description = \"Clean all, build and load, then save database (H2, Derby), OrientDB, and OpenSearch/ElasticSearch files; to be used before reloadSave\"\n dependsOn cleanAll, load, saveDb\n}\n\ntask reloadSave {\n description = \"After a loadSave clean database (H2, Derby), OrientDB, and ElasticSearch files and reload from saved copy\"\n dependsOn cleanTempDir, cleanDb, cleanLog, cleanSessions\n dependsOn allBuildTasks\n doLast {\n if (file('SaveDerby.zip').exists()) copy { from zipTree('SaveDerby.zip'); into file(moquiRuntime+'/db/derby/moqui') }\n if (file('SaveH2.zip').exists()) copy { from zipTree('SaveH2.zip'); into file(moquiRuntime+'/db/h2') }\n if (file('SaveOrientDb.zip').exists()) copy { from zipTree('SaveOrientDb.zip'); into file(moquiRuntime+'/db/orientdb/databases') }\n\n if (file('SaveElasticSearch.zip').exists()) {\n String esDir = moquiRuntime+'/elasticsearch'\n if (file(esDir+'/bin').exists()) {\n def pidFile = file(esDir+'/pid')\n if (pidFile.exists()) {\n String pid = pidFile.getText()\n logger.lifecycle(\"ElasticSearch running with pid ${pid}, stopping before restoring data then restarting\")\n ['kill', pid].execute(null, file(esDir)).waitFor()\n ['tail', \"--pid=${pid}\", '-f', '/dev/null'].execute(null, file(esDir)).waitFor()\n copy { from zipTree('SaveElasticSearch.zip'); into file(moquiRuntime+'/elasticsearch/data') }\n if (pidFile.exists()) delete pidFile\n ['./bin/elasticsearch', '-d', '-p', 'pid'].execute(null, file(esDir)).waitFor()\n } else {\n logger.lifecycle(\"Found ElasticSearch ${esDir}/bin directory but no pid, saving data without stop/start; WARNING if ElasticSearch is running this will cause problems!\")\n copy { from zipTree('SaveElasticSearch.zip'); into file(moquiRuntime+'/elasticsearch/data') }\n }\n } else {\n copy { from zipTree('SaveElasticSearch.zip'); into file(moquiRuntime+'/elasticsearch/data') }\n }\n }\n if (file('SaveOpenSearch.zip').exists()) {\n String esDir = moquiRuntime+'/opensearch'\n if (file(esDir+'/bin').exists()) {\n def pidFile = file(esDir+'/pid')\n if (pidFile.exists()) {\n String pid = pidFile.getText()\n logger.lifecycle(\"OpenSearch running with pid ${pid}, stopping before restoring data then restarting\")\n ['kill', pid].execute(null, file(esDir)).waitFor()\n ['tail', \"--pid=${pid}\", '-f', '/dev/null'].execute(null, file(esDir)).waitFor()\n copy { from zipTree('SaveOpenSearch.zip'); into file(moquiRuntime+'/opensearch/data') }\n if (pidFile.exists()) delete pidFile\n ['./bin/opensearch', '-d', '-p', 'pid'].execute(null, file(esDir)).waitFor()\n } else {\n logger.lifecycle(\"Found OpenSearch ${esDir}/bin directory but no pid, saving data without stop/start; WARNING if OpenSearch is running this will cause problems!\")\n copy { from zipTree('SaveOpenSearch.zip'); into file(moquiRuntime+'/opensearch/data') }\n }\n } else {\n copy { from zipTree('SaveOpenSearch.zip'); into file(moquiRuntime+'/opensearch/data') }\n }\n }\n }\n}\n\n// ========== deploy tasks ==========\n\ntask deployTomcat { doLast {\n // remove runtime directory, may have been added for logs/etc\n delete file(tomcatHome + '/runtime')\n // remove ROOT directory and war to avoid conflicts\n delete file(tomcatHome + '/webapps/ROOT')\n delete file(tomcatHome + '/webapps/ROOT.war')\n // copy the war file to ROOT.war\n copy { from file(warName); into file(tomcatHome + '/webapps'); rename(warName, 'ROOT.war') }\n} }\n\ntask plusRuntimeWarTemp {\n dependsOn checkRuntime, allBuildTasks\n\n doLast {\n File wartempFile = file('wartemp')\n if (wartempFile.exists()) delete wartempFile\n\n // make version detail files\n makeVersionDetailFiles()\n // unzip the \"moqui-${version}.war\" file to the wartemp directory\n copy { from zipTree(warName); into wartempFile }\n // copy runtime directory (with a few exceptions) into a runtime directory in the war\n copy {\n from fileTree(dir: '.', include: moquiRuntime+'/**',\n excludes: ['**/*.jar', '**/build', moquiRuntime+'/classes/**', moquiRuntime+'/lib/**', moquiRuntime+'/log/**', moquiRuntime+'/sessions/**'])\n into wartempFile\n }\n // copy the jar files from runtime/lib\n copy { from fileTree(dir: moquiRuntime+'/lib', include: '**/*.jar').files into 'wartemp/WEB-INF/lib' }\n // copy the classpath resource files from runtime/classes\n copy { from fileTree(dir: moquiRuntime+'/classes', include: '**/*') into 'wartemp/WEB-INF/classes' }\n // copy the jar files from components\n copy { from fileTree(dir: moquiRuntime+'/base-component', include: '**/*.jar').files into 'wartemp/WEB-INF/lib' }\n copy {\n from fileTree(dir: moquiRuntime+'/component', include: '**/*.jar', exclude: '**/librepo/*.jar').files\n into 'wartemp/WEB-INF/lib'\n duplicatesStrategy DuplicatesStrategy.WARN\n }\n copy {\n from fileTree(dir: moquiRuntime+'/ecomponent', include: '**/*.jar', exclude: '**/librepo/*.jar').files\n into 'wartemp/WEB-INF/lib'\n duplicatesStrategy DuplicatesStrategy.WARN\n }\n // add MoquiInit.properties fresh copy, just in case it was changed\n copy { from file('MoquiInit.properties') into 'wartemp/WEB-INF/classes' }\n // add Procfile to root\n copy { from file('Procfile') into 'wartemp' }\n // special case: copy elasticsearch plugin/module jars (needed for ES installed in runtime/elasticsearch\n if (file(moquiRuntime+'/elasticsearch').exists())\n copy { from fileTree(dir: '.', include: moquiRuntime+'/elasticsearch/**/*.jar') into wartempFile }\n // special case: copy opensearch plugin/module jars (needed for ES installed in runtime/opensearch\n if (file(moquiRuntime+'/opensearch').exists())\n copy { from fileTree(dir: '.', include: moquiRuntime+'/opensearch/**/*.jar') into wartempFile }\n // special case: copy jackrabbit standalone jar (if exists)\n copy { from fileTree(dir: moquiRuntime + '/jackrabbit', include: 'jackrabbit-standalone-*.jar').files; into 'wartemp/' + moquiRuntime + '/jackrabbit' }\n\n // clean up version detail files\n cleanVersionDetailFiles()\n }\n}\ntask addRuntime(type: Zip) {\n description = \"Create moqui-plus-runtime.war file from the moqui.war file and the runtime directory embedded in it\"\n dependsOn checkRuntime, allBuildTasks, plusRuntimeWarTemp\n\n archiveFileName = plusRuntimeName\n destinationDirectory = file('.')\n from file('wartemp')\n\n doFirst { if (file(plusRuntimeName).exists()) delete file(plusRuntimeName) }\n doLast { delete file('wartemp') }\n}\n\n// don't use this task directly, use addRuntimeTomcat which calls this\ntask deployTomcatRuntime { doLast {\n delete file(tomcatHome + '/runtime'); delete file(tomcatHome + '/webapps/ROOT'); delete file(tomcatHome + '/webapps/ROOT.war')\n copy { from file(plusRuntimeName); into file(tomcatHome + '/webapps'); rename(plusRuntimeName, 'ROOT.war') }\n} }\ntask addRuntimeTomcat {\n dependsOn addRuntime\n dependsOn deployTomcatRuntime\n}\n\n// ========== component tasks ==========\n\ntask getDefaults {\n description = \"Get a component using specified location type, also check/get all components it depends on; requires component property; locationType property optional (defaults to git if there is a .git directory, otherwise to current)\"\n doLast {\n String curLocationType = file('.git').exists() ? 'git' : 'current'\n if (project.hasProperty('locationType')) curLocationType = locationType\n getComponentTop(curLocationType)\n }\n}\ntask getComponent {\n description = \"Get a component using specified location type, also check/get all components it depends on; requires component property; locationType property optional (defaults to git if there is a .git directory, otherwise to current)\"\n doLast {\n String curLocationType = file('.git').exists() ? 'git' : 'current'\n if (project.hasProperty('locationType')) curLocationType = locationType\n getComponentTop(curLocationType)\n }\n}\ntask createComponent {\n description = \"Create a new component. Set new component name with -Pcomponent=new_component_name (based on the moqui start component here: https://github.com/moqui/start)\"\n doLast {\n String curLocationType = file('.git').exists() ? 'git' : 'current'\n if (project.hasProperty('locationType')) curLocationType = locationType\n\n if (project.hasProperty('component')) {\n checkRuntimeDirAndDefaults(curLocationType)\n Set compsChecked = new TreeSet()\n\n def startComponentName = 'start'\n\n File componentDir = getComponent(startComponentName, curLocationType, parseAddons(), parseMyaddons(), compsChecked)\n if (componentDir?.exists()) {\n logger.lifecycle(\"Got component start, dependent components checked: ${compsChecked}\")\n\n def newComponent = file(\"runtime/component/${component}\")\n def renameSuccessful = componentDir.renameTo(newComponent)\n if (!renameSuccessful) {\n logger.error(\"Failed to rename component start to ${component}. Try removing the existing component directory first or giving this program write permissions.\")\n } else {\n logger.lifecycle(\"Renamed component start to ${component}\")\n }\n\n print \"Updated file: \"\n newComponent.eachFileRecurse(groovy.io.FileType.FILES) { file ->\n try {\n // If file name is startComponentName.* rename to component.*\n if (file.name.startsWith(startComponentName)) {\n String newFileName = (file.name - startComponentName)\n newFileName = component + newFileName\n File newFile = new File(file.parent, newFileName)\n file.renameTo(newFile)\n file = newFile\n print \"${file.path - newComponent.path - '/'}, \"\n }\n\n String content = file.text\n if (content.contains(startComponentName)) {\n content = content.replaceAll(startComponentName, component)\n file.text = content\n print \"${file.path - newComponent.path - '/'}, \"\n }\n } catch (IOException e) {\n println \"Error processing file ${file.path}: ${e.message}\"\n }\n }\n print \"\\n\\n\"\n println \"Select rest api (r), screens (s), or both (B):\"\n def componentInput = System.in.newReader().readLine()\n\n if (componentInput == 'r') {\n new File(newComponent, 'screen').deleteDir()\n new File(newComponent, 'template').deleteDir()\n new File(newComponent, 'data/AppSeedData.xml').delete()\n new File(newComponent, 'MoquiConf.xml').delete()\n def moquiConf = new File(newComponent, 'MoquiConf.xml')\n moquiConf.append(\"\\n\" +\n \"\\n\" +\n \"\\n\" +\n \"\")\n println \"Selected rest api so, deleted screen, template, and AppSeedData.xml\\n\"\n } else if (componentInput == 's') {\n new File(newComponent, \"services/${component}.rest.xml\").delete()\n new File(newComponent, 'data/ApiSeedData.xml').delete()\n println \"Selected screens so, deleted rest api and ApiSeedData.xml\\n\"\n } else if (componentInput == 'b' || componentInput == 'B' || componentInput == '') {\n println \"Selected both rest api and screens\\n\"\n } else {\n println \"Invalid input. Try again\"\n newComponent.deleteDir()\n return\n }\n\n println \"Are you going to code or test in groovy or java [y/N]\"\n def codeInput = System.in.newReader().readLine()\n\n if (codeInput == 'y' || codeInput == 'Y') {\n println \"Keeping src folder\\n\"\n } else if (codeInput == 'n' || codeInput == 'N' || codeInput == '') {\n new File(newComponent, 'src').deleteDir()\n new File(newComponent, 'build.grade').delete()\n println \"Selected no so, deleted src and build.grade\\n\"\n } else {\n println \"Invalid input. Try again\"\n newComponent.deleteDir()\n return\n }\n\n println \"Setup a git repository [Y/n]\"\n def gitInput = System.in.newReader().readLine()\n if (gitInput == 'y' || gitInput == 'Y' || gitInput == '') {\n new File(newComponent, '.git').deleteDir()\n // Setup git repository\n\n def grgit = Grgit.init(dir: newComponent.path)\n grgit.add(patterns: ['.'])\n // Can't get signing to work easily. If signing works well then might as well commit\n// grgit.commit(message: 'Initial commit')\n println \"Selected yes, so git is initialized\\n\"\n println \"To setup the git remote origin, type the git remote url or enter to skip\"\n def remoteUrl = System.in.newReader().readLine()\n if (remoteUrl != '') {\n grgit.remote.add(name: 'origin', url: remoteUrl)\n println \"Run the following to push the git repository:\\ncd runtime/component/${component} && git commit -m 'Initial commit' && git push && cd ../../..\"\n } else {\n println \"Run the following to push the git repository:\\ncd runtime/component/${component} && git commit -m 'Initial commit' && git remote add origin git@github.com:yourgroup/${component} && git push && cd ../../..\"\n }\n } else if (gitInput == 'n' || gitInput == 'N') {\n new File(newComponent, '.git').deleteDir()\n println \"Selected no, so git is not initialized\\n\"\n println \"Run the following to push the git repository:\\ncd runtime/component/${component} && git commit -m 'Initial commit' && git remote add origin git@github.com:yourgroup/${component} && git push && cd ../../..\"\n } else {\n println \"Invalid input. Try again\"\n newComponent.deleteDir()\n return\n }\n\n println \"Add to myaddons.xml [Y/n]\"\n def myaddonsInput = System.in.newReader().readLine()\n if (myaddonsInput == 'y' || myaddonsInput == 'Y' || myaddonsInput == '') {\n def myaddonsFile = file('myaddons.xml')\n if (myaddonsFile.exists()){\n // Iterate through myaddons file and delete the lines that are \n // Read the lines from the file\n def lines = myaddonsFile.readLines()\n\n // Filter out the lines that contain \n def filteredLines = lines.findAll { !it.contains(\"\") }\n\n // Write the filtered lines back to the file\n myaddonsFile.text = filteredLines.join('\\n')\n } else {\n println \"myaddons.xml not found. Creating one\\nEnter repository github (g), github-ssh (GS), bitbucket (b), or bitbucket-ssh (bs)\"\n def repositoryInput = System.in.newReader().readLine()\n myaddonsFile.append(\"\")\n }\n\n println \"Enter the component git repository group\"\n def groupInput = System.in.newReader().readLine()\n\n println \"Enter the component git repository name\"\n def nameInput = System.in.newReader().readLine()\n\n // get git branch\n def grgit = Grgit.open(dir: newComponent.path)\n def branch = grgit.branch.current().name\n\n myaddonsFile.append(\"\\n \")\n myaddonsFile.append(\"\\n\")\n\n } else if (myaddonsInput == 'n' || myaddonsInput == 'N') {\n println \"Selected no, so component not added to myaddons.xml\\n\"\n } else {\n println \"Invalid input. Try again\"\n newComponent.deleteDir()\n return\n }\n\n }\n } else {\n throw new InvalidUserDataException(\"No component property specified\")\n }\n\n }\n}\ntask getCurrent {\n description = \"Get the current archive for a component, also check each component it depends on and if not present get its current archive; requires component property\"\n doLast { getComponentTop('current') }\n}\ntask getRelease {\n description = \"Get the release archive for a component, also check each component it depends on and if not present get its configured release archive; requires component property\"\n doLast { getComponentTop('release') }\n}\ntask getBinary {\n description = \"Get the binary release archive for a component, also check each component it depends on and if not present get its configured release archive; requires component property\"\n doLast { getComponentTop('binary') }\n}\ntask getGit {\n description = \"Clone the git repository for a component, also check each component it depends on and if not present clone its git repository; requires component property\"\n doLast { getComponentTop('git') }\n}\ntask getDepends {\n description = \"Check/Get all dependencies for all components in runtime/component; locationType property optional (defaults to git if there is a .git directory, otherwise to current)\"\n doLast {\n String curLocationType = file('.git').exists() ? 'git' : 'current'\n if (project.hasProperty('locationType')) curLocationType = locationType\n checkAllComponentDependencies(curLocationType)\n }\n}\n\ntask getComponentSet {\n description = \"Gets all components in the specied componentSet using specified location type, also check/get all components it depends on; requires -Pcomponent property; -PlocationType property optional (defaults to git if there is a .git directory, otherwise to current)\"\n doLast {\n String curLocationType = file('.git').exists() ? 'git' : 'current'\n if (project.hasProperty('locationType')) curLocationType = locationType\n if (!project.hasProperty('componentSet')) throw new InvalidUserDataException(\"No componentSet property specified\")\n checkRuntimeDirAndDefaults(curLocationType)\n Set compsChecked = new TreeSet()\n loadComponentSet((String) componentSet, curLocationType, parseAddons(), parseMyaddons(), compsChecked)\n logger.lifecycle(\"Got component-set ${componentSet}, got or checked components: ${compsChecked}\")\n }\n}\n\ntask zipComponents {\n description = \"Create a .zip archive file for each component in runtime/component\"\n dependsOn allBuildTasks\n doLast { for (File compDir in findComponentDirs()) createComponentZip(compDir) }\n}\ntask zipComponent {\n description = \"Create a .zip archive file a single component in runtime/component; requires component property\"\n dependsOn allBuildTasks\n doLast {\n if (!project.hasProperty('component')) throw new InvalidUserDataException(\"No component property specified\")\n createComponentZip(file('runtime/component/' + component))\n }\n}\n\n// ========== utility methods ==========\n\ndef createComponentZip(File compDir) {\n File compXmlFile = file(\"${compDir.path}/component.xml\")\n if (!compXmlFile.exists()) {\n logger.lifecycle(\"No component.xml file found at ${compXmlFile.path}, not creating component zip\")\n return\n }\n Node compXml = new XmlParser().parse(compXmlFile)\n File zipFile = file(\"${compDir.parentFile.path}/${compXml.'@name'}${compXml.'@version' ? '-' + compXml.'@version' : ''}.zip\")\n if (zipFile.exists()) { logger.lifecycle(\"Deleting existing component zip file: ${zipFile.name}\"); zipFile.delete() }\n // exclude build, src, librepo, build.gradle, defaultexcludes (which includes .git)\n ant.zip(destfile: zipFile.path) { fileset(dir: compDir.parentFile.path, includes: \"${compDir.name}/**\", defaultexcludes: 'yes',\n excludes: \"${compDir.name}/build/**,${compDir.name}/src/**,${compDir.name}/librepo/**,${compDir.name}/build.gradle\") }\n logger.lifecycle(\"Created component zip file: ${zipFile.name}\")\n}\n\ndef checkRuntimeDirAndDefaults(String locType) {\n Node addons = parseAddons()\n Node myaddons = parseMyaddons()\n if (!locType) locType = file('.git').exists() ? 'git' : 'current'\n\n File runtimeDir = file('runtime')\n if (!runtimeDir.exists()) {\n Node runtimeNode = myaddons != null && myaddons.runtime ? (Node) myaddons.runtime[0] : null\n if (runtimeNode == null) runtimeNode = addons != null && addons.runtime ? (Node) addons.runtime[0] : null\n if (runtimeNode == null) throw new InvalidUserDataException(\"The runtime directory does not exist and no runtime element found in myaddons.xml or addons.xml\")\n downloadComponent(\"runtime\", locType, runtimeNode, addons, myaddons)\n }\n\n // look for @default in myaddons.xml only\n if (myaddons?.'@default') {\n String defaultComps = myaddons.'@default'\n Set compsChecked = new TreeSet()\n Set defaultCompsDownloaded = new TreeSet()\n for (String compName in defaultComps.split(',')) {\n compName = compName.trim()\n if (!compName) continue\n File componentDir = file(\"runtime/component/${compName}\")\n if (componentDir.exists()) continue\n getComponent(compName, locType, addons, myaddons, compsChecked)\n defaultCompsDownloaded.add(compName)\n }\n if (defaultCompsDownloaded)\n logger.lifecycle(\"Got default components ${defaultCompsDownloaded}, dependent components checked: ${compsChecked}\")\n }\n}\n\ndef loadComponentSet(String setName, String curLocationType, Node addons, Node myaddons, Set compsChecked) {\n Node setNode = null\n if (myaddons) setNode = myaddons.'component-set'.find({ it.\"@name\" == setName })\n if (setNode == null) setNode = addons.'component-set'.find({ it.\"@name\" == setName })\n if (setNode == null) throw new InvalidUserDataException(\"Could not find component-set with name ${setName}\")\n String components = setNode.'@components'\n if (components) for (String compName in components.split(\",\"))\n getComponent(compName, curLocationType, addons, myaddons, compsChecked)\n String sets = setNode.'@sets'\n if (sets) for (String subsetName in sets.split(\",\"))\n loadComponentSet(subsetName, curLocationType, addons, myaddons, compsChecked)\n}\n\nCollection findComponentDirs() {\n file('runtime/component').listFiles().findAll({ it.isDirectory() && it.listFiles().find({ it.name == 'component.xml' }) })\n}\nNode parseAddons() { new XmlParser().parse(file('addons.xml')) }\nNode parseMyaddons() { if (file('myaddons.xml').exists()) { new XmlParser().parse(file('myaddons.xml')) } else { null } }\nNode parseComponent(project) { new XmlParser().parse(project.file('component.xml')) }\n\ndef getComponentTop(String locationType) {\n if (project.hasProperty('component')) {\n checkRuntimeDirAndDefaults(locationType)\n Set compsChecked = new TreeSet()\n File componentDir = getComponent(component, locationType, parseAddons(), parseMyaddons(), compsChecked)\n if (componentDir?.exists()) logger.lifecycle(\"Got component ${component}, dependent components checked: ${compsChecked}\")\n } else {\n throw new InvalidUserDataException(\"No component property specified\")\n }\n}\nFile getComponent(String compName, String type, Node addons, Node myaddons, Set compsChecked) {\n // get the component\n Node component = myaddons != null ? (Node) myaddons.component.find({ it.\"@name\" == compName }) : null\n if (component == null) component = (Node) addons.component.find({ it.\"@name\" == compName })\n if (component == null) throw new InvalidUserDataException(\"Component ${compName} not found in myaddons.xml or addons.xml\")\n if (component.'@skip-get' == 'true') { logger.lifecycle(\"Skipping get component ${compName} (skip-get=true)\"); return null }\n File componentDir = downloadComponent(\"runtime/component/${compName}\", type, component, addons, myaddons)\n\n checkComponentDependencies(compName, type, addons, myaddons, compsChecked)\n return componentDir\n}\nFile downloadComponent(String targetDirPath, String type, Node component, Node addons, Node myaddons) {\n String compName = component.'@name'\n String branch = component.'@branch'\n // fall back to 'current' (branch-based) if release/binary requested but version is empty\n if (type in ['release', 'binary'] && !component.'@version') type = 'current'\n\n String repositoryName = (component.'@repository' ?: myaddons?.'@default-repository' ?: addons.'@default-repository' ?: 'github')\n Node repository = myaddons != null ? (Node) myaddons.repository.find({ it.\"@name\" == repositoryName }) : null\n if (repository == null) repository = (Node) addons.repository.find({ it.\"@name\" == repositoryName })\n if (repository == null) throw new InvalidUserDataException(\"Repository ${repositoryName} not found in myaddons.xml or addons.xml\")\n Node location = (Node) repository.location.find({ it.\"@type\" == type })\n if (location == null) throw new InvalidUserDataException(\"Location for type ${type} now found in repository ${repositoryName}\")\n\n String url = Eval.me('component', component, '\"\"\"' + location.'@url' + '\"\"\"')\n logger.lifecycle(\"Getting ${compName} (type ${type}) from ${url} at ${branch} to ${targetDirPath}\")\n\n File targetDir = file(targetDirPath)\n if (targetDir.exists()) { logger.lifecycle(\"Component ${compName} already exists at ${targetDir}\"); return targetDir }\n if (type in ['current', 'release', 'binary']) {\n File zipFile = file(\"${targetDirPath}.zip\")\n ant.get(src: url, dest: zipFile)\n // the eachFile closure removes the first path from each file, moving everything up a directory\n copy { from zipTree(zipFile); into targetDir; eachFile { it.setPath((it.getRelativePath().getSegments() as List).tail().join(\"/\")); return it } }\n delete zipFile\n // delete the empty directories left over from zip expansion with first path removed\n String archiveDirName = compName + '-'\n if (type == 'current') { archiveDirName += component.'@branch' } else { archiveDirName += component.'@version' }\n // logger.lifecycle(\"Deleting dir ${targetDirPath}/${archiveDirName}\")\n delete file(\"${targetDirPath}/${archiveDirName}\")\n } else if (type == 'git') {\n Grgit.clone(dir: targetDir, uri: url, refToCheckout: branch)\n }\n logger.lifecycle(\"Downloaded ${compName} to ${targetDirPath}\")\n return targetDir\n}\ndef checkComponentDependencies(String compName, String type, Node addons, Node myaddons, Set compsChecked) {\n File componentDir = file(\"runtime/component/${compName}\")\n if (!componentDir.exists()) return\n compsChecked.add(compName)\n File compXmlFile = file(\"${componentDir.path}/component.xml\")\n if (!compXmlFile.exists()) return\n Node compXml = new XmlParser().parse(compXmlFile)\n for (Node dependsOn in compXml.'depends-on') {\n String depCompName = dependsOn.'@name'\n if (file(\"runtime/component/${depCompName}\").exists()) {\n if (!compsChecked.contains(depCompName)) checkComponentDependencies(depCompName, type, addons, myaddons, compsChecked)\n } else {\n getComponent(depCompName, type, addons, myaddons, compsChecked)\n }\n }\n}\ndef checkAllComponentDependencies(String type) {\n Node addons = parseAddons()\n Node myaddons = parseMyaddons()\n Set compsChecked = new TreeSet()\n for (File compDir in findComponentDirs()) {\n checkComponentDependencies(compDir.name, type, addons, myaddons, compsChecked)\n }\n logger.lifecycle(\"Dependent components checked: ${compsChecked}\")\n}\n\ndef makeVersionDetailFiles() {\n if (file(\".git\").exists()) {\n def topVersionMap = [framework:getVersionDetailMap(file('.'))]\n if (file(\"runtime/.git\").exists()) topVersionMap.runtime = getVersionDetailMap(file('runtime'))\n file('runtime/version.json').write(groovy.json.JsonOutput.toJson(topVersionMap), \"UTF-8\")\n }\n for (File compDir in file('runtime/component').listFiles().findAll { it.isDirectory() && it.listFiles().find { it.name == '.git' } }) {\n def versionMap = getVersionDetailMap(compDir)\n if (versionMap == null) continue\n file(compDir.path + '/version.json').write(groovy.json.JsonOutput.toJson(versionMap), \"UTF-8\")\n }\n}\nMap getVersionDetailMap(File gitDir) {\n def curGrgit = Grgit.open(dir: gitDir)\n if (curGrgit == null) return null\n String trackingName = curGrgit.branch.current()?.trackingBranch?.name\n String trackingUrl = \"\"\n int trackingNameSlash = trackingName ? trackingName.indexOf('/') : -1\n if (trackingNameSlash > 0) {\n String remoteName = trackingName.substring(0, trackingNameSlash)\n def trackingRemote = curGrgit.remote.list().find({ it.name == remoteName })\n if (trackingRemote != null) trackingUrl = trackingRemote.url\n }\n try {\n String headId = curGrgit.head()?.id\n // tags come in order of oldest first so want to find last in case multiple tags refer to HEAD commit\n def headTag = curGrgit.tag.list().reverse().find({ it.commit.id == headId })\n return [branch:curGrgit.branch.current()?.name, tracking:trackingName, url:trackingUrl, head:headId?.take(10), tag:headTag?.name]\n } catch (Throwable t) {\n logger.lifecycle(\"Error getting git info for directory ${gitDir?.path}\", t)\n return null\n }\n}\ndef cleanVersionDetailFiles() {\n def runtimeVersionFile = file(\"runtime/version.json\")\n if (runtimeVersionFile.exists()) runtimeVersionFile.delete()\n for (File compDir in file('runtime/component').listFiles().findAll { it.isDirectory() }) {\n File versionDetailFile = file(compDir.path + '/version.json')\n if (versionDetailFile.exists()) versionDetailFile.delete()\n }\n}\n\n// ========== combined tasks ==========\n\ntask cleanPullLoad { dependsOn cleanAll, gitPullAll, load }\ntask cleanPullTest { dependsOn cleanAll, gitPullAll, load, allTestTasks }\ntask cleanPullCompTest { dependsOn cleanAll, gitPullAll, load, getComponentTestTasks() }\ntask compTest { dependsOn getComponentTestTasks() }\n"
},
{
"path": "build.xml",
"content": "\n\n\n\n\n\n \n \n\n \n \n \n\n \n \n \n \n\n \n \n \n \n \n \n \n \n \n \n\n \n \n\n \n \n\n \n \n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n"
},
{
"path": "docker/README.md",
"content": "# Moqui On Docker\n\nThis directory contains everything needed to deploy moqui on docker.\n\n## Prerequisites\n\n- Docker.\n- Docker Compose Plugin.\n- Java 21.\n- Convenience scripts require bash.\n\n## Deployment Instructions\n\nTo deploy moqui on docker with all necessary services, follow below:\n\n- Choose a docker compose file in `docker/`. For example to deploy moqui on\n postgres you can choose moqui-postgres-compose.yml.\n- Find and download a suitable JDBC driver for the target database, download its\n jar file and place it in `runtime/lib`.\n- Generate moqui war file `./gradlew build`\n- Get into docker folder `cd docker`\n- Build chosen compose file, e.g. `./build-compose-up.sh moqui-postgres-compose.yml`\n\nThis last step would build the \"moqui\" image and deploy all services. You can\nconfirm by accessing the system on http://localhost\n\nFor a more secure and complete deployment, it is recommended to carefully review\nthe compose files and adjust as needed, including changing credentials and other\nsettings such as setting the host names, configuring for letsencrypt, etc ...\n\n## Compose Files\n\nThere are multiple compose files offered providing different services:\n\n- moqui-acme-postgres.yml: Moqui, nginx, postgres and automatically issues SSL\n certificates from letsencrypt. Requires configuring variables including\n `VIRTUAL_HOST` and `LETSENCRYPT_HOST` and postgres driver.\n- moqui-postgres-compose.yml: Moqui with postgres and nginx standard deployment.\n- moqui-mysql-compose.yml: Moqui with mysql and nginx standard deployment.\n- mysql-compose.yml: deploys all services with mysql except moqui itself. Useful\n when deploying moqui elsewhere like on a servlet container.\n- postgres-compose.yml: Same as mysql-compose but replacing mysql with postgres\n- moqui-cluster1-compose.yml: Moqui with mysql. Designed to be deployed in a\n hazelcast cluster for horizontal scaling. Requires preparing moqui with\n the hazelcast component and mysql driver.\n\n## Helper Scripts\n\n- `build-compose-up.sh`: Given a certain compose file, build \"moqui\" and deploy\n all services in the chosen yml file.\n- `clean.sh`: Clean the artifacts generated upon deployment including the\n database, opensearch and runtime.\n- `compose-down.sh`: Tear down all services of a certain yml file\n- `compose-up.sh`: Deploy all services of a certain yml file. If the \"moqui\"\n image exists in the yml file and it is not built, this script will fail, and\n you should use the build-compose-up.sh instead.\n- `postgres_backup.sh`: Convenience script to create a database dump. Might need\n adjusting the credentials.\n\n## Moqui Image\n\nThe actual image \"moqui\" is generated from the Dockerfile found in\n`docker/simple/Dockerfile`. All compose files depend on a \"moqui\" image\ngenerated by this file.\n\nNote: The deployment and tear down scripts can accept a container image name to\noverride the default name. For example, to use a hardened JDK image, a command\nlike the following can be used:\n\n`./build-compose-up.sh moqui-acme-postgres.yml .. eclipse-temurin:21-jdk-ubi10-minimal`\n"
},
{
"path": "docker/build-compose-up.sh",
"content": "#! /bin/bash\n\nif [[ ! $1 ]]; then\n echo \"Usage: ./build-compose-up.sh [] []\"\n exit 1\nfi\n\nCOMP_FILE=\"${1}\"\nMOQUI_HOME=\"${2:-..}\"\nNAME_TAG=moqui\nRUNTIME_IMAGE=\"${3:-eclipse-temurin:21-jdk}\"\n\nif [ -f simple/docker-build.sh ]; then\n cd simple\n ./docker-build.sh ../.. $NAME_TAG $RUNTIME_IMAGE\n # shellcheck disable=SC2103\n cd ..\nfi\n\nif [ -f compose-up.sh ]; then\n ./compose-up.sh $COMP_FILE $MOQUI_HOME $RUNTIME_IMAGE\nfi\n"
},
{
"path": "docker/clean.sh",
"content": "#! /bin/bash\n\nsearch_name=opensearch\nif [ -d runtime/opensearch/bin ]; then search_name=opensearch;\nelif [ -d runtime/elasticsearch/bin ]; then search_name=elasticsearch;\nfi\n\nrm -Rf runtime/\nrm -Rf runtime1/\nrm -Rf runtime2/\nrm -Rf db/\nrm -Rf $search_name/data/nodes\nrm -Rf $search_name/data/*.conf\nrm $search_name/logs/*.log\n\ndocker rm moqui-server\ndocker rm moqui-database\ndocker rm nginx-proxy\n"
},
{
"path": "docker/compose-down.sh",
"content": "#! /bin/bash\n\nif [[ ! $1 ]]; then\n echo \"Usage: ./compose-down.sh \"\n exit 1\nfi\n\nCOMP_FILE=\"${1}\"\n\n# set the project name to 'moqui', network will be called 'moqui_default'\ndocker compose -f $COMP_FILE -p moqui down\n"
},
{
"path": "docker/compose-up.sh",
"content": "#! /bin/bash\n\nif [[ ! $1 ]]; then\n echo \"Usage: ./compose-up.sh [] []\"\n exit 1\nfi\n\nCOMP_FILE=\"${1}\"\nMOQUI_HOME=\"${2:-..}\"\nNAME_TAG=moqui\nRUNTIME_IMAGE=\"${3:-eclipse-temurin:21-jdk}\"\n\n# Note: If you don't have access to your conf directory while running this:\n# This will make it so that your docker/conf directory no longer has your configuration files in it.\n# This is because when docker-compose provisions a volume on the host it applies the host's data before the image's data.\n# - change docker compose's moqui-server conf volume path from ./runtime/conf to conf\n# - add a top level volumes: tag with conf: below\n# - remove the next block of if statements from this file and you should be good to go\nsearch_name=opensearch\nif [ -d runtime/opensearch/bin ]; then search_name=opensearch;\nelif [ -d runtime/elasticsearch/bin ]; then search_name=elasticsearch;\nfi\nif [ ! -e runtime ]; then mkdir runtime; fi\nif [ ! -e runtime/conf ]; then cp -R $MOQUI_HOME/runtime/conf runtime/; fi\nif [ ! -e runtime/lib ]; then cp -R $MOQUI_HOME/runtime/lib runtime/; fi\nif [ ! -e runtime/classes ]; then cp -R $MOQUI_HOME/runtime/classes runtime/; fi\nif [ ! -e runtime/log ]; then cp -R $MOQUI_HOME/runtime/log runtime/; fi\nif [ ! -e runtime/txlog ]; then cp -R $MOQUI_HOME/runtime/txlog runtime/; fi\nif [ ! -e runtime/db ]; then cp -R $MOQUI_HOME/runtime/db runtime/; fi\nif [ ! -e runtime/$search_name ]; then cp -R $MOQUI_HOME/runtime/$search_name runtime/; fi\n\n# set the project name to 'moqui', network will be called 'moqui_default'\ndocker compose -f $COMP_FILE -p moqui up -d\n"
},
{
"path": "docker/elasticsearch/data/README",
"content": "This directory must exist for mapping otherwise created as root in container and elasticsearch cannot access it.\n"
},
{
"path": "docker/elasticsearch/moquiconfig/elasticsearch.yml",
"content": "# ======================== Elasticsearch Configuration =========================\n#\n# NOTE: Elasticsearch comes with reasonable defaults for most settings.\n# Before you set out to tweak and tune the configuration, make sure you\n# understand what are you trying to accomplish and the consequences.\n#\n# The primary way of configuring a node is via this file. This template lists\n# the most important settings you may want to configure for a production cluster.\n#\n# Please see the documentation for further information on configuration options:\n# \n#\n# ---------------------------------- Cluster -----------------------------------\n#\n# Use a descriptive name for your cluster:\n\ncluster.name: MoquiElasticSearch\n\n# ------------------------------------ Node ------------------------------------\n#\n# Use a descriptive name for the node:\n\n# NOTE: for cluster use auto generated\n# node.name: MoquiLocal\n\n# Add custom attributes to the node:\n#\n#node.attr.rack: r1\n\nnode.master: false\nnode.data: false\nnode.ingest: false\n\n# ----------------------------------- Paths ------------------------------------\n#\n# Path to directory where to store the data (separate multiple locations by comma):\n#\n#path.data: /path/to/data\n#\n# Path to log files:\n#\n#path.logs: /path/to/logs\n#\n# ----------------------------------- Memory -----------------------------------\n#\n# Lock the memory on startup:\n#\n#bootstrap.memory_lock: true\n#\n# Make sure that the heap size is set to about half the memory available\n# on the system and that the owner of the process is allowed to use this\n# limit.\n#\n# Elasticsearch performs poorly when the system is swapping the memory.\n#\n# ---------------------------------- Network -----------------------------------\n#\n# Set the bind address to a specific IP (IPv4 or IPv6):\n\n# By default use _local_ and _site_ for localhost or any local network including docker container virtual network\nnetwork.host:\n - _site_\n - _local_\n\n# transport.type: local\n# discovery.type: single-node\ndiscovery.type: zen\ndiscovery.zen.minimum_master_nodes: 1\n# use unicast discovery to find external elasticsearch server, multicast doesn't seem to work with docker bridge network\ndiscovery.zen.ping.unicast.hosts: elasticsearch\n\ntransport.host: 0.0.0.0\ntransport.tcp.port: 9300\n\n# CORS settings for local testing only\n# http.cors.enabled: true\n# http.cors.allow-origin: '*'\n\n# Set a port for HTTP (9200 is the default, or with no port specified looks at subsequent ports to find one open):\nhttp.port: 9200\n\n# For more information, see the documentation at:\n# \n\n# --------------------------------- Discovery ----------------------------------\n#\n# Pass an initial list of hosts to perform discovery when new node is started:\n# The default list of hosts is [\"127.0.0.1\", \"[::1]\"]\n#\n#discovery.zen.ping.unicast.hosts: [\"host1\", \"host2\"]\n#\n# Prevent the \"split brain\" by configuring the majority of nodes (total number of nodes / 2 + 1):\n#\n#discovery.zen.minimum_master_nodes: 3\n#\n# For more information, see the documentation at:\n# \n#\n# ---------------------------------- Gateway -----------------------------------\n#\n# Block initial recovery after a full cluster restart until N nodes are started:\n#\n#gateway.recover_after_nodes: 3\n#\n# For more information, see the documentation at:\n# \n#\n# ---------------------------------- Various -----------------------------------\n#\n# Disable starting multiple nodes on a single system:\n#\n#node.max_local_storage_nodes: 1\n#\n# Require explicit names when deleting indices:\n#\n#action.destructive_requires_name: true\n\n# ---------------------------------- Script ------------------------------------\n\n# see: https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-scripting-security.html\n"
},
{
"path": "docker/elasticsearch/moquiconfig/log4j2.properties",
"content": "status = info\n\n# log action execution errors for easier debugging\nlogger.action.name = org.elasticsearch.action\nlogger.action.level = debug\n\nappender.console.type = Console\nappender.console.name = console\nappender.console.layout.type = PatternLayout\nappender.console.layout.pattern = [%d{ISO8601}][%-5p][%-25c{1.}] %marker%m%n\n\nappender.rolling.type = RollingFile\nappender.rolling.name = rolling\nappender.rolling.fileName = ${sys:es.logs}.log\nappender.rolling.layout.type = PatternLayout\nappender.rolling.layout.pattern = [%d{ISO8601}][%-5p][%-25c{1.}] %marker%.10000m%n\nappender.rolling.filePattern = ${sys:es.logs}-%d{yyyy-MM-dd}.log\nappender.rolling.policies.type = Policies\nappender.rolling.policies.time.type = TimeBasedTriggeringPolicy\nappender.rolling.policies.time.interval = 1\nappender.rolling.policies.time.modulate = true\n\nrootLogger.level = info\nrootLogger.appenderRef.console.ref = console\nrootLogger.appenderRef.rolling.ref = rolling\n\nappender.deprecation_rolling.type = RollingFile\nappender.deprecation_rolling.name = deprecation_rolling\nappender.deprecation_rolling.fileName = ${sys:es.logs}_deprecation.log\nappender.deprecation_rolling.layout.type = PatternLayout\nappender.deprecation_rolling.layout.pattern = [%d{ISO8601}][%-5p][%-25c{1.}] %marker%.10000m%n\nappender.deprecation_rolling.filePattern = ${sys:es.logs}_deprecation-%i.log.gz\nappender.deprecation_rolling.policies.type = Policies\nappender.deprecation_rolling.policies.size.type = SizeBasedTriggeringPolicy\nappender.deprecation_rolling.policies.size.size = 1GB\nappender.deprecation_rolling.strategy.type = DefaultRolloverStrategy\nappender.deprecation_rolling.strategy.max = 4\n\nlogger.deprecation.name = org.elasticsearch.deprecation\nlogger.deprecation.level = warn\nlogger.deprecation.appenderRef.deprecation_rolling.ref = deprecation_rolling\nlogger.deprecation.additivity = false\n\nappender.index_search_slowlog_rolling.type = RollingFile\nappender.index_search_slowlog_rolling.name = index_search_slowlog_rolling\nappender.index_search_slowlog_rolling.fileName = ${sys:es.logs}_index_search_slowlog.log\nappender.index_search_slowlog_rolling.layout.type = PatternLayout\nappender.index_search_slowlog_rolling.layout.pattern = [%d{ISO8601}][%-5p][%-25c] %marker%.10000m%n\nappender.index_search_slowlog_rolling.filePattern = ${sys:es.logs}_index_search_slowlog-%d{yyyy-MM-dd}.log\nappender.index_search_slowlog_rolling.policies.type = Policies\nappender.index_search_slowlog_rolling.policies.time.type = TimeBasedTriggeringPolicy\nappender.index_search_slowlog_rolling.policies.time.interval = 1\nappender.index_search_slowlog_rolling.policies.time.modulate = true\n\nlogger.index_search_slowlog_rolling.name = index.search.slowlog\nlogger.index_search_slowlog_rolling.level = trace\nlogger.index_search_slowlog_rolling.appenderRef.index_search_slowlog_rolling.ref = index_search_slowlog_rolling\nlogger.index_search_slowlog_rolling.additivity = false\n\nappender.index_indexing_slowlog_rolling.type = RollingFile\nappender.index_indexing_slowlog_rolling.name = index_indexing_slowlog_rolling\nappender.index_indexing_slowlog_rolling.fileName = ${sys:es.logs}_index_indexing_slowlog.log\nappender.index_indexing_slowlog_rolling.layout.type = PatternLayout\nappender.index_indexing_slowlog_rolling.layout.pattern = [%d{ISO8601}][%-5p][%-25c] %marker%.10000m%n\nappender.index_indexing_slowlog_rolling.filePattern = ${sys:es.logs}_index_indexing_slowlog-%d{yyyy-MM-dd}.log\nappender.index_indexing_slowlog_rolling.policies.type = Policies\nappender.index_indexing_slowlog_rolling.policies.time.type = TimeBasedTriggeringPolicy\nappender.index_indexing_slowlog_rolling.policies.time.interval = 1\nappender.index_indexing_slowlog_rolling.policies.time.modulate = true\n\nlogger.index_indexing_slowlog.name = index.indexing.slowlog.index\nlogger.index_indexing_slowlog.level = trace\nlogger.index_indexing_slowlog.appenderRef.index_indexing_slowlog_rolling.ref = index_indexing_slowlog_rolling\nlogger.index_indexing_slowlog.additivity = false\n"
},
{
"path": "docker/kibana/kibana.yml",
"content": "# Kibana is served by a back end server. This setting specifies the port to use.\nserver.port: 5601\n\n# Specifies the address to which the Kibana server will bind. IP addresses and host names are both valid values.\n# The default is 'localhost', which usually means remote machines will not be able to connect.\n# To allow connections from remote users, set this parameter to a non-loopback address.\nserver.host: \"kibana\"\n\n# Enables you to specify a path to mount Kibana at if you are running behind a proxy. This only affects\n# the URLs generated by Kibana, your proxy is expected to remove the basePath value before forwarding requests\n# to Kibana. This setting cannot end in a slash.\nserver.basePath: \"/kibana\"\n\n# The maximum payload size in bytes for incoming server requests.\n#server.maxPayloadBytes: 1048576\n\n# The Kibana server's name. This is used for display purposes.\n#server.name: \"your-hostname\"\n\n# The URL of the Elasticsearch instance to use for all your queries.\nelasticsearch.url: \"http://moqui-server:9200\"\n\n# When this setting's value is true Kibana uses the hostname specified in the server.host\n# setting. When the value of this setting is false, Kibana uses the hostname of the host\n# that connects to this Kibana instance.\n#elasticsearch.preserveHost: true\n\n# Kibana uses an index in Elasticsearch to store saved searches, visualizations and\n# dashboards. Kibana creates a new index if the index doesn't already exist.\n#kibana.index: \".kibana\"\n\n# The default application to load.\n#kibana.defaultAppId: \"discover\"\n\n# If your Elasticsearch is protected with basic authentication, these settings provide\n# the username and password that the Kibana server uses to perform maintenance on the Kibana\n# index at startup. Your Kibana users still need to authenticate with Elasticsearch, which\n# is proxied through the Kibana server.\n#elasticsearch.username: \"user\"\n#elasticsearch.password: \"pass\"\n\n# Enables SSL and paths to the PEM-format SSL certificate and SSL key files, respectively.\n# These settings enable SSL for outgoing requests from the Kibana server to the browser.\n#server.ssl.enabled: false\n#server.ssl.certificate: /path/to/your/server.crt\n#server.ssl.key: /path/to/your/server.key\n\n# Optional settings that provide the paths to the PEM-format SSL certificate and key files.\n# These files validate that your Elasticsearch backend uses the same key files.\n#elasticsearch.ssl.certificate: /path/to/your/client.crt\n#elasticsearch.ssl.key: /path/to/your/client.key\n\n# Optional setting that enables you to specify a path to the PEM file for the certificate\n# authority for your Elasticsearch instance.\n#elasticsearch.ssl.certificateAuthorities: [ \"/path/to/your/CA.pem\" ]\n\n# To disregard the validity of SSL certificates, change this setting's value to 'none'.\n#elasticsearch.ssl.verificationMode: full\n\n# Time in milliseconds to wait for Elasticsearch to respond to pings. Defaults to the value of\n# the elasticsearch.requestTimeout setting.\n#elasticsearch.pingTimeout: 1500\n\n# Time in milliseconds to wait for responses from the back end or Elasticsearch. This value\n# must be a positive integer.\n#elasticsearch.requestTimeout: 30000\n\n# List of Kibana client-side headers to send to Elasticsearch. To send *no* client-side\n# headers, set this value to [] (an empty list).\n#elasticsearch.requestHeadersWhitelist: [ authorization ]\n\n# Header names and values that are sent to Elasticsearch. Any custom headers cannot be overwritten\n# by client-side headers, regardless of the elasticsearch.requestHeadersWhitelist configuration.\n#elasticsearch.customHeaders: {}\n\n# Time in milliseconds for Elasticsearch to wait for responses from shards. Set to 0 to disable.\n#elasticsearch.shardTimeout: 0\n\n# Time in milliseconds to wait for Elasticsearch at Kibana startup before retrying.\n#elasticsearch.startupTimeout: 5000\n\n# Specifies the path where Kibana creates the process ID file.\n#pid.file: /var/run/kibana.pid\n\n# Enables you specify a file where Kibana stores log output.\n#logging.dest: stdout\n\n# Set the value of this setting to true to suppress all logging output.\n#logging.silent: false\n\n# Set the value of this setting to true to suppress all logging output other than error messages.\n#logging.quiet: false\n\n# Set the value of this setting to true to log all events, including system usage information\n# and all requests.\n#logging.verbose: false\n\n# Set the interval in milliseconds to sample system and process performance\n# metrics. Minimum is 100ms. Defaults to 5000.\n#ops.interval: 5000\n\n# The default locale. This locale can be used in certain circumstances to substitute any missing\n# translations.\n#i18n.defaultLocale: \"en\"\n"
},
{
"path": "docker/moqui-acme-postgres.yml",
"content": "# A Docker Compose application with Moqui, Postgres, OpenSearch, OpenSearch Dashboards, and virtual hosting through\n# nginx-proxy supporting multiple moqui instances on different hostnames.\n\n# Run with something like this for detached mode:\n# $ docker compose -f moqui-postgres-compose.yml -p moqui up -d\n# Or to copy runtime directories for mounted volumes, set default settings, etc use something like this:\n# $ ./compose-run.sh moqui-postgres-compose.yml\n# This sets the project/app name to 'moqui' and the network will be 'moqui_default', to be used by external moqui containers\n\n# Test locally by adding the virtual host to /etc/hosts or with something like:\n# $ curl -H \"Host: moqui.local\" localhost/Login\n\n# To run an additional instance of moqui run something like this (but with\n# many more arguments for volume mapping, db setup, etc):\n# $ docker run -e VIRTUAL_HOST=moqui2.local --name moqui2_local --network moqui_default moqui\n\n# To import data from the docker host using port 5432 mapped for 127.0.0.1 only use something like this:\n# $ psql -h 127.0.0.1 -p 5432 -U moqui -W moqui < pg-dump.sql\n\nservices:\n nginx-proxy:\n # For documentation on SSL and other settings see:\n # https://github.com/nginxproxy/nginx-proxy\n image: nginxproxy/nginx-proxy\n container_name: nginx-proxy\n restart: always\n ports:\n - 80:80\n - 443:443\n labels:\n com.github.jrcs.letsencrypt_nginx_proxy_companion.nginx_proxy: \"true\"\n volumes:\n - /var/run/docker.sock:/tmp/docker.sock:ro\n - /etc/localtime:/etc/localtime:ro\n # note: .crt, .key, and .dhparam.pem files start with the domain name in VIRTUAL_HOST (ie 'acetousk.com.*') or use CERT_NAME env var\n - ./certs:/etc/nginx/certs\n - ./nginx/conf.d:/etc/nginx/conf.d\n - ./nginx/vhost.d:/etc/nginx/vhost.d\n - ./nginx/html:/usr/share/nginx/html\n environment:\n # change this for the default host to use when accessing directly by IP, etc\n - DEFAULT_HOST=moqui.local\n # use SSL_POLICY to disable TLSv1.0, etc in nginx-proxy\n - SSL_POLICY=AWS-TLS-1-1-2017-01\n networks:\n - proxy-tier\n\n acme-companion:\n image: nginxproxy/acme-companion\n container_name: acme-companion\n restart: always\n volumes:\n - /var/run/docker.sock:/var/run/docker.sock:ro\n - /etc/localtime:/etc/localtime:ro\n - ./certs:/etc/nginx/certs\n - ./nginx/conf.d:/etc/nginx/conf.d\n - ./nginx/vhost.d:/etc/nginx/vhost.d\n - ./nginx/html:/usr/share/nginx/html\n - ./acme.sh:/etc/acme.sh\n networks:\n - proxy-tier\n environment:\n # TODO: For production change this to your email\n - DEFAULT_EMAIL=mail@yourdomain.tld\n # TODO: For production change this to false\n - LETSENCRYPT_TEST=true\n depends_on:\n - nginx-proxy\n\n moqui-server:\n image: moqui\n container_name: moqui-server\n command: conf=conf/MoquiProductionConf.xml port=80 no-run-es\n restart: always\n links:\n - moqui-database\n - moqui-search\n volumes:\n - /etc/localtime:/etc/localtime:ro\n - ./runtime/conf:/opt/moqui/runtime/conf\n - ./runtime/lib:/opt/moqui/runtime/lib\n - ./runtime/classes:/opt/moqui/runtime/classes\n - ./runtime/ecomponent:/opt/moqui/runtime/ecomponent\n - ./runtime/log:/opt/moqui/runtime/log\n - ./runtime/txlog:/opt/moqui/runtime/txlog\n - ./runtime/sessions:/opt/moqui/runtime/sessions\n - ./runtime/db:/opt/moqui/runtime/db\n - ./runtime/opensearch:/opt/moqui/runtime/opensearch\n environment:\n - \"JAVA_TOOL_OPTIONS=-Xms1024m -Xmx1024m\"\n - instance_purpose=production\n - entity_ds_db_conf=postgres\n - entity_ds_host=moqui-database\n - entity_ds_port=5432\n - entity_ds_database=moqui\n - entity_ds_schema=public\n - entity_ds_user=moqui\n - entity_ds_password='MOQUI_CHANGE_ME!!!'\n - entity_ds_crypt_pass='DEFAULT_CHANGE_ME!!!'\n # configuration for ElasticFacade.ElasticClient, make sure the old moqui-elasticsearch component is NOT included in the Moqui build\n - elasticsearch_url=https://moqui-search:9200\n # prefix for index names, use something distinct and not 'moqui_' or 'mantle_' which match the beginning of OOTB index names\n - elasticsearch_index_prefix=default_\n - elasticsearch_user=admin\n - elasticsearch_password=MoquiElasticChangeMe@2026\n # CHANGE ME - note that VIRTUAL_HOST is for nginx-proxy so it picks up this container as one it should reverse proxy\n # this can be a comma separate list of hosts like 'example.com,www.example.com'\n - VIRTUAL_HOST=moqui.local\n - LETSENCRYPT_HOST=moqui.local\n # moqui will accept traffic from other hosts but these are the values used for URL writing when specified:\n # - webapp_http_host=moqui.local\n - webapp_http_port=80\n - webapp_https_port=443\n - webapp_https_enabled=true\n # nginx-proxy populates X-Real-IP with remote_addr by default, better option for outer proxy than X-Forwarded-For which defaults to proxy_add_x_forwarded_for\n - webapp_client_ip_header=X-Real-IP\n - default_locale=en_US\n - default_time_zone=UTC\n networks:\n - proxy-tier\n - default\n\n moqui-database:\n image: postgres:18.1\n container_name: moqui-database\n restart: always\n ports:\n # change this as needed to bind to any address or even comment to not expose port outside containers\n - 127.0.0.1:5432:5432\n volumes:\n - /etc/localtime:/etc/localtime:ro\n # edit these as needed to map configuration and data storage\n - ./db/postgres:/var/lib/postgresql\n environment:\n - POSTGRES_DB=moqui\n - POSTGRES_DB_SCHEMA=public\n - POSTGRES_USER=moqui\n - POSTGRES_PASSWORD='MOQUI_CHANGE_ME!!!'\n # PGDATA, POSTGRES_INITDB_ARGS\n networks:\n default:\n\n moqui-search:\n image: opensearchproject/opensearch:3.4.0\n container_name: moqui-search\n restart: always\n ports:\n # change this as needed to bind to any address or even comment to not expose port outside containers\n - 127.0.0.1:9200:9200\n - 127.0.0.1:9300:9300\n volumes:\n - /etc/localtime:/etc/localtime:ro\n # edit these as needed to map configuration and data storage\n - ./opensearch/data/nodes:/usr/share/opensearch/data/nodes\n # - ./opensearch/config/opensearch.yml:/usr/share/opensearch/config/opensearch.yml\n # - ./opensearch/logs:/usr/share/opensearch/logs\n environment:\n - \"OPENSEARCH_JAVA_OPTS=-Xms512m -Xmx512m\"\n - OPENSEARCH_INITIAL_ADMIN_PASSWORD=MoquiElasticChangeMe@2026\n - discovery.type=single-node\n - network.host=_site_\n ulimits:\n memlock:\n soft: -1\n hard: -1\n nofile:\n soft: 65536\n hard: 65536\n networks:\n proxy-tier:\n\n opensearch-dashboards:\n image: opensearchproject/opensearch-dashboards:3.4.0\n container_name: opensearch-dashboards\n volumes:\n - /etc/localtime:/etc/localtime:ro\n links:\n - moqui-search\n ports:\n - 127.0.0.1:5601:5601\n environment:\n OPENSEARCH_HOSTS: '[\"https://moqui-search:9200\"]'\n networks:\n default:\n proxy-tier:\n\nnetworks:\n proxy-tier:\n"
},
{
"path": "docker/moqui-cluster1-compose.yml",
"content": "# NOTE: ElasticSearch uses odd user and directory setup for externally mapped data, etc directories, see:\n# https://www.elastic.co/guide/en/elasticsearch/reference/current/docker.html\n\n# Make sure vm.max_map_count=262144 is set in /etc/sysctl.conf on host (on live system run 'sudo sysctl -w vm.max_map_count=262144')\n\n# A Docker Compose application with 2 moqui instances, mysql, elasticsearch, kibana, and virtual hosting through\n# nginx-proxy supporting multiple moqui instances on different hosts.\n\n# The 'moqui' image should be prepared with the MySQL JDBC jar and the moqui-hazelcast and moqui-elasticsearch components.\n\n# This does virtual hosting instead of load balancing so that each moqui instance can be accessed consistently (moqui1.local, moqui2.local).\n\n# Run with something like this for detached mode:\n# $ docker-compose -f moqui-cluster1-compose.yml -p moqui up -d\n# Or to copy runtime directories for mounted volumes, set default settings, etc use something like this:\n# $ ./compose-run.sh moqui-cluster1-compose.yml\n# This sets the project/app name to 'moqui' and the network will be 'moqui_default', to be used by external moqui containers\n\n# Test locally by adding the virtual host to /etc/hosts or with something like:\n# $ curl -H \"Host: moqui1.local\" localhost/Login\n\nservices:\n nginx-proxy:\n # For documentation on SSL and other settings see:\n # https://github.com/nginx-proxy/nginx-proxy\n image: nginxproxy/nginx-proxy\n container_name: nginx-proxy\n restart: always\n ports:\n - 80:80\n - 443:443\n volumes:\n - /var/run/docker.sock:/tmp/docker.sock:ro\n # note: .crt, .key, and .dhparam.pem files start with the domain name in VIRTUAL_HOST (ie 'moqui.local.*') or use CERT_NAME env var\n - ./certs:/etc/nginx/certs\n - ./nginx/my_proxy.conf:/etc/nginx/conf.d/my_proxy.conf\n environment:\n # change this for the default host to use when accessing directly by IP, etc\n - DEFAULT_HOST=moqui1.local\n # use SSL_POLICY to disable TLSv1.0, etc in nginx-proxy\n - SSL_POLICY=AWS-TLS-1-1-2017-01\n\n moqui-server1:\n image: moqui\n container_name: moqui-server1\n command: conf=conf/MoquiProductionConf.xml port=80\n restart: always\n links:\n - moqui-database\n - moqui-search\n volumes:\n - ./runtime/conf:/opt/moqui/runtime/conf\n - ./runtime/lib:/opt/moqui/runtime/lib\n - ./runtime/classes:/opt/moqui/runtime/classes\n - ./runtime/ecomponent:/opt/moqui/runtime/ecomponent\n - ./runtime/log:/opt/moqui/runtime/log\n - ./runtime/txlog:/opt/moqui/runtime/txlog\n - ./runtime/sessions:/opt/moqui/runtime/sessions\n - ./runtime/db:/opt/moqui/runtime/db\n - ./runtime/opensearch:/opt/moqui/runtime/opensearch\n environment:\n - \"JAVA_TOOL_OPTIONS=-Xms1024m -Xmx1024m\"\n - instance_purpose=production\n - entity_ds_db_conf=mysql8\n - entity_ds_host=moqui-database\n - entity_ds_port=3306\n - entity_ds_database=moqui\n # NOTE: using root user because for TX recovery MySQL requires the 'XA_RECOVER_ADMIN' and in version 8 that must be granted explicitly\n - entity_ds_user=root\n - entity_ds_password=moquiroot\n - entity_ds_crypt_pass='DEFAULT_CHANGE_ME!!!'\n # configuration for ElasticFacade.ElasticClient, make sure the old moqui-elasticsearch component is NOT included in the Moqui build\n - elasticsearch_url=https://moqui-search:9200\n # prefix for index names, use something distinct and not 'moqui_' or 'mantle_' which match the beginning of OOTB index names\n - elasticsearch_index_prefix=default_\n - elasticsearch_user=admin\n - elasticsearch_password=MoquiElasticChangeMe@2026\n # settings for kibana proxy\n - kibana_host=opensearch-dashboards\n # CHANGE ME - note that VIRTUAL_HOST is for nginx-proxy so it picks up this container as one it should reverse proxy\n # this can be a comma separate list of hosts like 'example.com,www.example.com'\n - VIRTUAL_HOST=moqui1.local\n # moqui will accept traffic from other hosts but these are the values used for URL writing when specified:\n - webapp_http_host=moqui1.local\n - webapp_http_port=80\n - webapp_https_port=443\n - webapp_https_enabled=true\n # nginx-proxy populates X-Real-IP with remote_addr by default, better option for outer proxy than X-Forwarded-For which defaults to proxy_add_x_forwarded_for\n - webapp_client_ip_header=X-Real-IP\n - default_locale=en_US\n - default_time_zone=UTC\n # hazelcast multicast setup\n - hazelcast_multicast_enabled=true\n - hazelcast_multicast_group=224.2.2.3\n - hazelcast_multicast_port=54327\n - hazelcast_group_name=test\n - hazelcast_group_password=test-pass\n\n moqui-server2:\n image: moqui\n container_name: moqui-server2\n command: conf=conf/MoquiProductionConf.xml port=80\n restart: always\n links:\n - moqui-database\n - moqui-search\n volumes:\n - ./runtime/conf:/opt/moqui/runtime/conf\n - ./runtime/lib:/opt/moqui/runtime/lib\n - ./runtime/classes:/opt/moqui/runtime/classes\n - ./runtime/ecomponent:/opt/moqui/runtime/ecomponent\n - ./runtime/log:/opt/moqui/runtime/log\n - ./runtime/txlog:/opt/moqui/runtime/txlog\n - ./runtime/sessions:/opt/moqui/runtime/sessions\n # this one isn't needed when not using H2/etc: - ./runtime/db:/opt/moqui/runtime/db\n environment:\n - \"JAVA_TOOL_OPTIONS=-Xms1024m -Xmx1024m\"\n - instance_purpose=production\n - entity_ds_db_conf=mysql8\n - entity_ds_host=moqui-database\n - entity_ds_port=3306\n - entity_ds_database=moqui\n # NOTE: using root user because for TX recovery MySQL requires the 'XA_RECOVER_ADMIN' and in version 8 that must be granted explicitly\n - entity_ds_user=root\n - entity_ds_password=moquiroot\n - entity_ds_crypt_pass='DEFAULT_CHANGE_ME!!!'\n # configuration for ElasticFacade.ElasticClient, make sure the old moqui-elasticsearch component is NOT included in the Moqui build\n - elasticsearch_url=https://moqui-search:9200\n # prefix for index names, use something distinct and not 'moqui_' or 'mantle_' which match the beginning of OOTB index names\n - elasticsearch_index_prefix=default_\n - elasticsearch_user=admin\n - elasticsearch_password=MoquiElasticChangeMe@2026\n # settings for kibana proxy\n - kibana_host=opensearch-dashboards\n # CHANGE ME - note that VIRTUAL_HOST is for nginx-proxy so it picks up this container as one it should reverse proxy\n # this can be a comma separate list of hosts like 'example.com,www.example.com'\n - VIRTUAL_HOST=moqui2.local\n # moqui will accept traffic from other hosts but these are the values used for URL writing when specified:\n - webapp_http_host=moqui2.local\n - webapp_http_port=80\n - webapp_https_port=443\n - webapp_https_enabled=true\n # nginx-proxy populates X-Real-IP with remote_addr by default, better option for outer proxy than X-Forwarded-For which defaults to proxy_add_x_forwarded_for\n - webapp_client_ip_header=X-Real-IP\n - default_locale=en_US\n - default_time_zone=UTC\n # hazelcast multicast setup\n - hazelcast_multicast_enabled=true\n - hazelcast_multicast_group=224.2.2.3\n - hazelcast_multicast_port=54327\n - hazelcast_group_name=test\n - hazelcast_group_password=test-pass\n\n moqui-database:\n image: mysql:9.5\n container_name: moqui-database\n restart: always\n ports:\n # change this as needed to bind to any address or even comment to not expose port outside containers\n - 127.0.0.1:3306:3306\n volumes:\n # edit these as needed to map configuration and data storage\n - ./db/mysql/data:/var/lib/mysql\n # - /my/mysql/conf.d:/etc/mysql/conf.d\n environment:\n - MYSQL_ROOT_PASSWORD=moquiroot\n - MYSQL_DATABASE=moqui\n - MYSQL_USER=moqui\n - MYSQL_PASSWORD=moqui\n\n moqui-search:\n image: opensearchproject/opensearch:3.4.0\n container_name: moqui-search\n restart: always\n ports:\n # change this as needed to bind to any address or even comment to not expose port outside containers\n - 127.0.0.1:9200:9200\n - 127.0.0.1:9300:9300\n volumes:\n # edit these as needed to map configuration and data storage\n - ./opensearch/data:/usr/share/opensearch/data\n # - ./opensearch/config/opensearch.yml:/usr/share/opensearch/config/opensearch.yml\n # - ./opensearch/logs:/usr/share/opensearch/logs\n environment:\n - \"OPENSEARCH_JAVA_OPTS=-Xms512m -Xmx512m\"\n - OPENSEARCH_INITIAL_ADMIN_PASSWORD=MoquiElasticChangeMe@2026\n - discovery.type=single-node\n - network.host=_site_\n ulimits:\n memlock:\n soft: -1\n hard: -1\n nofile:\n soft: 65536\n hard: 65536\n\n opensearch-dashboards:\n image: opensearchproject/opensearch-dashboards:3.4.0\n container_name: opensearch-dashboards\n links:\n - moqui-search\n ports:\n - 5601:5601\n environment:\n OPENSEARCH_HOSTS: '[\"https://moqui-search:9200\"]'\n"
},
{
"path": "docker/moqui-mysql-compose.yml",
"content": "# A Docker Compose application with Moqui, MySQL, OpenSearch, OpenSearch Dashboards, and virtual hosting through\n# nginx-proxy supporting multiple moqui instances on different hostnames.\n\n# Run with something like this for detached mode:\n# $ docker compose -f moqui-mysql-compose.yml -p moqui up -d\n# Or to copy runtime directories for mounted volumes, set default settings, etc use something like this:\n# $ ./compose-run.sh moqui-mysql-compose.yml\n# This sets the project/app name to 'moqui' and the network will be 'moqui_default', to be used by external moqui containers\n\n# Test locally by adding the virtual host to /etc/hosts or with something like:\n# $ curl -H \"Host: moqui.local\" localhost/Login\n\n# To run an additional instance of moqui run something like this (but with\n# many more arguments for volume mapping, db setup, etc):\n# $ docker run -e VIRTUAL_HOST=moqui2.local --name moqui2_local --network moqui_default moqui\n\n# To import data from the docker host using port 3306 mapped for 127.0.0.1 only use something like this:\n# $ mysql -p -u root -h 127.0.0.1 moqui < mysql-export.sql\n\nservices:\n nginx-proxy:\n # For documentation on SSL and other settings see:\n # https://github.com/nginxproxy/nginx-proxy\n image: nginxproxy/nginx-proxy\n container_name: nginx-proxy\n restart: always\n ports:\n - 80:80\n - 443:443\n labels:\n com.github.jrcs.letsencrypt_nginx_proxy_companion.nginx_proxy: \"true\"\n volumes:\n - /var/run/docker.sock:/tmp/docker.sock:ro\n - /etc/localtime:/etc/localtime:ro\n # note: .crt, .key, and .dhparam.pem files start with the domain name in VIRTUAL_HOST (ie 'moqui.local.*') or use CERT_NAME env var\n - ./certs:/etc/nginx/certs\n - ./nginx/conf.d:/etc/nginx/conf.d\n - ./nginx/vhost.d:/etc/nginx/vhost.d\n - ./nginx/html:/usr/share/nginx/html\n environment:\n # change this for the default host to use when accessing directly by IP, etc\n - DEFAULT_HOST=moqui.local\n # use SSL_POLICY to disable TLSv1.0, etc in nginx-proxy\n - SSL_POLICY=AWS-TLS-1-1-2017-01\n\n moqui-server:\n image: moqui\n container_name: moqui-server\n command: conf=conf/MoquiProductionConf.xml port=80\n restart: always\n links:\n - moqui-database\n - moqui-search\n volumes:\n - ./runtime/conf:/opt/moqui/runtime/conf\n - ./runtime/lib:/opt/moqui/runtime/lib\n - ./runtime/classes:/opt/moqui/runtime/classes\n - ./runtime/ecomponent:/opt/moqui/runtime/ecomponent\n - ./runtime/log:/opt/moqui/runtime/log\n - ./runtime/txlog:/opt/moqui/runtime/txlog\n - ./runtime/sessions:/opt/moqui/runtime/sessions\n - ./runtime/db:/opt/moqui/runtime/db\n - ./runtime/opensearch:/opt/moqui/runtime/opensearch\n environment:\n - \"JAVA_TOOL_OPTIONS=-Xms1024m -Xmx1024m\"\n - instance_purpose=production\n - entity_ds_db_conf=mysql8\n - entity_ds_host=moqui-database\n - entity_ds_port=3306\n - entity_ds_database=moqui\n # NOTE: using root user because for TX recovery MySQL requires the 'XA_RECOVER_ADMIN' and in version 8 that must be granted explicitly\n - entity_ds_user=root\n - entity_ds_password=moquiroot\n - entity_ds_crypt_pass='DEFAULT_CHANGE_ME!!!'\n # configuration for ElasticFacade.ElasticClient, make sure the old moqui-elasticsearch component is NOT included in the Moqui build\n - elasticsearch_url=https://moqui-search:9200\n # prefix for index names, use something distinct and not 'moqui_' or 'mantle_' which match the beginning of OOTB index names\n - elasticsearch_index_prefix=default_\n - elasticsearch_user=admin\n - elasticsearch_password=MoquiElasticChangeMe@2026\n # CHANGE ME - note that VIRTUAL_HOST is for nginx-proxy so it picks up this container as one it should reverse proxy\n # this can be a comma separate list of hosts like 'example.com,www.example.com'\n - VIRTUAL_HOST=moqui.local\n # moqui will accept traffic from other hosts but these are the values used for URL writing when specified:\n # - webapp_http_host=moqui.local\n - webapp_http_port=80\n - webapp_https_port=443\n - webapp_https_enabled=true\n # nginx-proxy populates X-Real-IP with remote_addr by default, better option for outer proxy than X-Forwarded-For which defaults to proxy_add_x_forwarded_for\n - webapp_client_ip_header=X-Real-IP\n - default_locale=en_US\n - default_time_zone=UTC\n\n moqui-database:\n image: mysql:9.5\n container_name: moqui-database\n restart: always\n ports:\n # change this as needed to bind to any address or even comment to not expose port outside containers\n - 127.0.0.1:3306:3306\n volumes:\n # edit these as needed to map configuration and data storage\n - ./db/mysql/data:/var/lib/mysql\n # - /my/mysql/conf.d:/etc/mysql/conf.d\n environment:\n - MYSQL_ROOT_PASSWORD=moquiroot\n - MYSQL_DATABASE=moqui\n - MYSQL_USER=moqui\n - MYSQL_PASSWORD=moqui\n\n moqui-search:\n image: opensearchproject/opensearch:3.4.0\n container_name: moqui-search\n restart: always\n ports:\n # change this as needed to bind to any address or even comment to not expose port outside containers\n - 127.0.0.1:9200:9200\n - 127.0.0.1:9300:9300\n volumes:\n # edit these as needed to map configuration and data storage\n - ./opensearch/data:/usr/share/opensearch/data\n # - ./opensearch/config/opensearch.yml:/usr/share/opensearch/config/opensearch.yml\n # - ./opensearch/logs:/usr/share/opensearch/logs\n environment:\n - \"OPENSEARCH_JAVA_OPTS=-Xms512m -Xmx512m\"\n - OPENSEARCH_INITIAL_ADMIN_PASSWORD=MoquiElasticChangeMe@2026\n - discovery.type=single-node\n - network.host=_site_\n ulimits:\n memlock:\n soft: -1\n hard: -1\n nofile:\n soft: 65536\n hard: 65536\n\n opensearch-dashboards:\n image: opensearchproject/opensearch-dashboards:3.4.0\n container_name: opensearch-dashboards\n links:\n - moqui-search\n ports:\n - 5601:5601\n environment:\n OPENSEARCH_HOSTS: '[\"https://moqui-search:9200\"]'\n"
},
{
"path": "docker/moqui-postgres-compose.yml",
"content": "# A Docker Compose application with Moqui, Postgres, OpenSearch, OpenSearch Dashboards, and virtual hosting through\n# nginx-proxy supporting multiple moqui instances on different hostnames.\n\n# Run with something like this for detached mode:\n# $ docker compose -f moqui-postgres-compose.yml -p moqui up -d\n# Or to copy runtime directories for mounted volumes, set default settings, etc use something like this:\n# $ ./compose-run.sh moqui-postgres-compose.yml\n# This sets the project/app name to 'moqui' and the network will be 'moqui_default', to be used by external moqui containers\n\n# Test locally by adding the virtual host to /etc/hosts or with something like:\n# $ curl -H \"Host: moqui.local\" localhost/Login\n\n# To run an additional instance of moqui run something like this (but with\n# many more arguments for volume mapping, db setup, etc):\n# $ docker run -e VIRTUAL_HOST=moqui2.local --name moqui2_local --network moqui_default moqui\n\n# To import data from the docker host using port 5432 mapped for 127.0.0.1 only use something like this:\n# $ psql -h 127.0.0.1 -p 5432 -U moqui -W moqui < pg-dump.sql\n\nservices:\n nginx-proxy:\n # For documentation on SSL and other settings see:\n # https://github.com/nginx-proxy/nginx-proxy\n image: nginxproxy/nginx-proxy\n container_name: nginx-proxy\n restart: always\n ports:\n - 80:80\n - 443:443\n volumes:\n - /var/run/docker.sock:/tmp/docker.sock:ro\n # note: .crt, .key, and .dhparam.pem files start with the domain name in VIRTUAL_HOST (ie 'moqui.local.*') or use CERT_NAME env var\n - ./certs:/etc/nginx/certs\n - ./nginx/my_proxy.conf:/etc/nginx/conf.d/my_proxy.conf\n environment:\n # change this for the default host to use when accessing directly by IP, etc\n - DEFAULT_HOST=moqui.local\n # use SSL_POLICY to disable TLSv1.0, etc in nginx-proxy\n - SSL_POLICY=AWS-TLS-1-1-2017-01\n\n moqui-server:\n image: moqui\n container_name: moqui-server\n command: conf=conf/MoquiProductionConf.xml port=80\n restart: always\n links:\n - moqui-database\n - moqui-search\n volumes:\n - ./runtime/conf:/opt/moqui/runtime/conf\n - ./runtime/lib:/opt/moqui/runtime/lib\n - ./runtime/classes:/opt/moqui/runtime/classes\n - ./runtime/ecomponent:/opt/moqui/runtime/ecomponent\n - ./runtime/log:/opt/moqui/runtime/log\n - ./runtime/txlog:/opt/moqui/runtime/txlog\n - ./runtime/sessions:/opt/moqui/runtime/sessions\n - ./runtime/db:/opt/moqui/runtime/db\n - ./runtime/opensearch:/opt/moqui/runtime/opensearch\n environment:\n - \"JAVA_TOOL_OPTIONS=-Xms1024m -Xmx1024m\"\n - instance_purpose=production\n - entity_ds_db_conf=postgres\n - entity_ds_host=moqui-database\n - entity_ds_port=5432\n - entity_ds_database=moqui\n - entity_ds_schema=public\n - entity_ds_user=moqui\n - entity_ds_password=moqui\n - entity_ds_crypt_pass='DEFAULT_CHANGE_ME!!!'\n # configuration for ElasticFacade.ElasticClient, make sure the old moqui-elasticsearch component is NOT included in the Moqui build\n - elasticsearch_url=https://moqui-search:9200\n # prefix for index names, use something distinct and not 'moqui_' or 'mantle_' which match the beginning of OOTB index names\n - elasticsearch_index_prefix=default_\n - elasticsearch_user=admin\n - elasticsearch_password=MoquiElasticChangeMe@2026\n # CHANGE ME - note that VIRTUAL_HOST is for nginx-proxy so it picks up this container as one it should reverse proxy\n # this can be a comma separate list of hosts like 'example.com,www.example.com'\n - VIRTUAL_HOST=moqui.local\n # moqui will accept traffic from other hosts but these are the values used for URL writing when specified:\n # - webapp_http_host=moqui.local\n - webapp_http_port=80\n - webapp_https_port=443\n - webapp_https_enabled=true\n # nginx-proxy populates X-Real-IP with remote_addr by default, better option for outer proxy than X-Forwarded-For which defaults to proxy_add_x_forwarded_for\n - webapp_client_ip_header=X-Real-IP\n - default_locale=en_US\n - default_time_zone=UTC\n\n moqui-database:\n image: postgres:18.1\n container_name: moqui-database\n restart: always\n ports:\n # change this as needed to bind to any address or even comment to not expose port outside containers\n - 127.0.0.1:5432:5432\n volumes:\n # edit these as needed to map configuration and data storage\n - ./db/postgres:/var/lib/postgresql\n environment:\n - POSTGRES_DB=moqui\n - POSTGRES_DB_SCHEMA=public\n - POSTGRES_USER=moqui\n - POSTGRES_PASSWORD=moqui\n # PGDATA, POSTGRES_INITDB_ARGS\n\n moqui-search:\n image: opensearchproject/opensearch:3.4.0\n container_name: moqui-search\n restart: always\n ports:\n # change this as needed to bind to any address or even comment to not expose port outside containers\n - 127.0.0.1:9200:9200\n - 127.0.0.1:9300:9300\n volumes:\n # edit these as needed to map configuration and data storage\n - ./opensearch/data:/usr/share/opensearch/data\n # - ./opensearch/config/opensearch.yml:/usr/share/opensearch/config/opensearch.yml\n # - ./opensearch/logs:/usr/share/opensearch/logs\n environment:\n - \"OPENSEARCH_JAVA_OPTS=-Xms512m -Xmx512m\"\n - OPENSEARCH_INITIAL_ADMIN_PASSWORD=MoquiElasticChangeMe@2026\n - discovery.type=single-node\n - network.host=_site_\n ulimits:\n memlock:\n soft: -1\n hard: -1\n nofile:\n soft: 65536\n hard: 65536\n\n opensearch-dashboards:\n image: opensearchproject/opensearch-dashboards:3.4.0\n container_name: opensearch-dashboards\n links:\n - moqui-search\n ports:\n - 5601:5601\n environment:\n OPENSEARCH_HOSTS: '[\"https://moqui-search:9200\"]'\n"
},
{
"path": "docker/moqui-run.sh",
"content": "#! /bin/bash\n\necho \"Usage: moqui-run.sh [] [] []\"\necho\n\nMOQUI_HOME=\"${1:-..}\"\nNAME_TAG=\"${2:-moqui}\"\nRUNTIME_IMAGE=\"${3:-eclipse-temurin:21-jdk}\"\n\nsearch_name=opensearch\nif [ -d \"$MOQUI_HOME/runtime/opensearch/bin\" ]; then search_name=opensearch;\nelif [ -d \"$MOQUI_HOME/runtime/elasticsearch/bin\" ]; then search_name=elasticsearch;\nfi\n\nif [ -f simple/docker-build.sh ]; then\n cd simple\n ./docker-build.sh ../.. $NAME_TAG $RUNTIME_IMAGE\n # shellcheck disable=SC2103\n cd ..\nfi\n\nif [ ! -e runtime ]; then mkdir runtime; fi\nif [ ! -e runtime/conf ]; then cp -R $MOQUI_HOME/runtime/conf runtime/; fi\nif [ ! -e runtime/lib ]; then cp -R $MOQUI_HOME/runtime/lib runtime/; fi\nif [ ! -e runtime/classes ]; then cp -R $MOQUI_HOME/runtime/classes runtime/; fi\nif [ ! -e runtime/log ]; then cp -R $MOQUI_HOME/runtime/log runtime/; fi\nif [ ! -e runtime/txlog ]; then cp -R $MOQUI_HOME/runtime/txlog runtime/; fi\nif [ ! -e runtime/db ]; then cp -R $MOQUI_HOME/runtime/db runtime/; fi\nif [ ! -e runtime/$search_name ]; then cp -R $MOQUI_HOME/runtime/$search_name runtime/; fi\n\ndocker run --rm -p 80:80 -v $PWD/runtime/conf:/opt/moqui/runtime/conf -v $PWD/runtime/lib:/opt/moqui/runtime/lib \\\n -v $PWD/runtime/classes:/opt/moqui/runtime/classes -v $PWD/runtime/log:/opt/moqui/runtime/log \\\n -v $PWD/runtime/txlog:/opt/moqui/runtime/txlog -v $PWD/runtime/db:/opt/moqui/runtime/db \\\n -v $PWD/runtime/$search_name:/opt/moqui/runtime/$search_name \\\n --name moqui-server $NAME_TAG\n# docker run -d -p 80:80 $NAME_TAG\n# docker run --rm -p 80:80 $NAME_TAG\n"
},
{
"path": "docker/mysql-compose.yml",
"content": "# A Docker Compose application with Moqui, MySQL, OpenSearch, OpenSearch Dashboards, and virtual hosting through\n# nginx-proxy supporting multiple moqui instances on different hostnames.\n\n# Run with something like this for detached mode:\n# $ docker compose -f mysql-compose.yml -p moqui up -d\n# Or to copy runtime directories for mounted volumes, set default settings, etc use something like this:\n# $ ./compose-run.sh mysql-compose.yml\n# This sets the project/app name to 'moqui' and the network will be 'moqui_default', to be used by external moqui containers\n\n# Test locally by adding the virtual host to /etc/hosts or with something like:\n# $ curl -H \"Host: moqui.local\" localhost/Login\n\n# To run an additional instance of moqui run something like this (but with\n# many more arguments for volume mapping, db setup, etc):\n# $ docker run -e VIRTUAL_HOST=moqui2.local --name moqui2_local --network moqui_default moqui\n\n# To import data from the docker host using port 3306 mapped for 127.0.0.1 only use something like this:\n# $ mysql -p -u root -h 127.0.0.1 moqui < mysql-export.sql\n\nservices:\n nginx-proxy:\n # For documentation on SSL and other settings see:\n # https://github.com/nginx-proxy/nginx-proxy\n image: nginxproxy/nginx-proxy\n container_name: nginx-proxy\n restart: always\n ports:\n - 80:80\n - 443:443\n volumes:\n - /var/run/docker.sock:/tmp/docker.sock:ro\n # note: .crt, .key, and .dhparam.pem files start with the domain name in VIRTUAL_HOST (ie 'moqui.local.*') or use CERT_NAME env var\n - ./certs:/etc/nginx/certs\n - ./nginx/my_proxy.conf:/etc/nginx/conf.d/my_proxy.conf\n environment:\n # use SSL_POLICY to disable TLSv1.0, etc in nginx-proxy\n - SSL_POLICY=AWS-TLS-1-1-2017-01\n\n moqui-database:\n image: mysql:9.5\n container_name: moqui-database\n restart: always\n # expose the port for use outside other containers, needed for external management (like Moqui Instance Management)\n ports:\n - 127.0.0.1:3306:3306\n # edit these as needed to map configuration and data storage\n volumes:\n - ./db/mysql/data:/var/lib/mysql\n # - /my/mysql/conf.d:/etc/mysql/conf.d\n environment:\n - MYSQL_ROOT_PASSWORD=moquiroot\n - MYSQL_DATABASE=moqui\n - MYSQL_USER=moqui\n - MYSQL_PASSWORD=moqui\n\n moqui-search:\n image: opensearchproject/opensearch:3.4.0\n container_name: moqui-search\n restart: always\n ports:\n # change this as needed to bind to any address or even comment to not expose port outside containers\n - 127.0.0.1:9200:9200\n - 127.0.0.1:9300:9300\n volumes:\n # edit these as needed to map configuration and data storage\n - ./opensearch/data:/usr/share/opensearch/data\n # - ./opensearch/config/opensearch.yml:/usr/share/opensearch/config/opensearch.yml\n # - ./opensearch/logs:/usr/share/opensearch/logs\n environment:\n - \"OPENSEARCH_JAVA_OPTS=-Xms512m -Xmx512m\"\n - OPENSEARCH_INITIAL_ADMIN_PASSWORD=MoquiElasticChangeMe@2026\n - discovery.type=single-node\n - network.host=_site_\n ulimits:\n memlock:\n soft: -1\n hard: -1\n nofile:\n soft: 65536\n hard: 65536\n\n opensearch-dashboards:\n image: opensearchproject/opensearch-dashboards:3.4.0\n container_name: opensearch-dashboards\n links:\n - moqui-search\n ports:\n - 5601:5601\n environment:\n OPENSEARCH_HOSTS: '[\"https://moqui-search:9200\"]'\n"
},
{
"path": "docker/nginx/my_proxy.conf",
"content": "client_max_body_size 20M;\n\nproxy_connect_timeout 3600s;\nproxy_read_timeout 3600s;\nproxy_send_timeout 3600s;\n\n# NOTE: this always sets X-Forwarded-For to the remote_addr instead of appending it.\n# The default behavior in nginx-proxy is to use $proxy_add_x_forwarded_for which\n# appends the current upstream IP to any in an existing X-Forwarded-For header\n# If nginx-proxy is used and it is there is another reverse proxy in front of it\n# (such as CloudFlare, AWS CloudFront, etc) this needs to be changed back to\n# $proxy_add_x_forwarded_for or it will always pick up the other reverse\n# proxy's IP address instead of the client IP address!\n# In other words, only the first proxy a client hits should set X-Forwarded-For\n# this way, all others should append.\nproxy_set_header X-Forwarded-For $remote_addr;\n\nunderscores_in_headers on;\n"
},
{
"path": "docker/opensearch/data/nodes/README",
"content": "This directory must exist for mapping otherwise created as root in container and opensearch cannot access it.\n"
},
{
"path": "docker/postgres-compose.yml",
"content": "# A Docker Compose application with Moqui, Postgres, OpenSearch, OpenSearch Dashboards, and virtual hosting through\n# nginx-proxy supporting multiple moqui instances on different hostnames.\n\n# Run with something like this for detached mode:\n# $ docker compose -f postgres-compose.yml -p moqui up -d\n# Or to copy runtime directories for mounted volumes, set default settings, etc use something like this:\n# $ ./compose-run.sh postgres-compose.yml\n# This sets the project/app name to 'moqui' and the network will be 'moqui_default', to be used by external moqui containers\n\n# Test locally by adding the virtual host to /etc/hosts or with something like:\n# $ curl -H \"Host: moqui.local\" localhost/Login\n\n# To run an additional instance of moqui run something like this (but with\n# many more arguments for volume mapping, db setup, etc):\n# $ docker run -e VIRTUAL_HOST=moqui2.local --name moqui2_local --network moqui_default moqui\n\n# To import data from the docker host using port 5432 mapped for 127.0.0.1 only use something like this:\n# $ psql -h 127.0.0.1 -p 5432 -U moqui -W moqui < pg-dump.sql\n\nservices:\n nginx-proxy:\n # For documentation on SSL and other settings see:\n # https://github.com/nginx-proxy/nginx-proxy\n image: nginxproxy/nginx-proxy\n container_name: nginx-proxy\n restart: always\n ports:\n - 80:80\n - 443:443\n volumes:\n - /var/run/docker.sock:/tmp/docker.sock:ro\n # note: .crt, .key, and .dhparam.pem files start with the domain name in VIRTUAL_HOST (ie 'moqui.local.*') or use CERT_NAME env var\n - ./certs:/etc/nginx/certs\n - ./nginx/my_proxy.conf:/etc/nginx/conf.d/my_proxy.conf\n environment:\n # use SSL_POLICY to disable TLSv1.0, etc in nginx-proxy\n - SSL_POLICY=AWS-TLS-1-1-2017-01\n\n moqui-database:\n image: postgres:18.1\n container_name: moqui-database\n restart: always\n ports:\n # change this as needed to bind to any address or even comment to not expose port outside containers\n - 127.0.0.1:5432:5432\n volumes:\n # edit these as needed to map configuration and data storage\n - ./db/postgres:/var/lib/postgresql\n environment:\n - POSTGRES_DB=moqui\n - POSTGRES_DB_SCHEMA=public\n - POSTGRES_USER=moqui\n - POSTGRES_PASSWORD=moqui\n # PGDATA, POSTGRES_INITDB_ARGS\n\n moqui-search:\n image: opensearchproject/opensearch:3.4.0\n container_name: moqui-search\n restart: always\n ports:\n # change this as needed to bind to any address or even comment to not expose port outside containers\n - 127.0.0.1:9200:9200\n - 127.0.0.1:9300:9300\n volumes:\n # edit these as needed to map configuration and data storage\n - ./opensearch/data:/usr/share/opensearch/data\n # - ./opensearch/config/opensearch.yml:/usr/share/opensearch/config/opensearch.yml\n # - ./opensearch/logs:/usr/share/opensearch/logs\n environment:\n - \"OPENSEARCH_JAVA_OPTS=-Xms512m -Xmx512m\"\n - OPENSEARCH_INITIAL_ADMIN_PASSWORD=MoquiElasticChangeMe@2026\n - discovery.type=single-node\n - network.host=_site_\n ulimits:\n memlock:\n soft: -1\n hard: -1\n nofile:\n soft: 65536\n hard: 65536\n\n opensearch-dashboards:\n image: opensearchproject/opensearch-dashboards:3.4.0\n container_name: opensearch-dashboards\n links:\n - moqui-search\n ports:\n - 5601:5601\n environment:\n OPENSEARCH_HOSTS: '[\"https://moqui-search:9200\"]'\n"
},
{
"path": "docker/postgres_backup.sh",
"content": "#!/bin/bash\n\n# This is a simple script to do a rotating backup of PostgreSQL (default once per day, retain 30 days)\n# For a complete backup solution these backup files would be copied to a remote site, potentially with a different retention pattern\n\n# Database info\nuser=\"moqui\"\nhost=\"localhost\"\ndb_name=\"moqui\"\n# Other options\n# a full path from root should be used for backup_path or there will be issues running via crontab\nbackup_path=\"/opt/pgbackups\"\ndate=$(date +\"%Y%m%d\")\nbackup_file=$backup_path/$db_name-$date.sql.gz\n\n# for password for cron job one option is to use a .pgpass file in home directory, see: https://www.postgresql.org/docs/current/libpq-pgpass.html\n# each line in .pgpass should be like: hostname:port:database:username:password\n# for example: localhost:5432:moqui:moqui:CHANGEME\n# note that ~/.pgpass must have u=rw (0600) permission or less (or psql, pg_dump, etc will refuse to use it)\n\n# Remove file for same day if exists\nif [ -e $backup_file ]; then rm $backup_file; fi\n# Set default file permissions\numask 177\n# Dump database into SQL file\npg_dump -h $host -p 5432 -U $user -w $db_name | gzip > $backup_file\n# Remove all files not within 7 days, most recent per month for 6 months, or most recent of the year\necho \"removing:\"\nls \"$backup_path\"/moqui-[0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9].sql.gz | awk -v now_epoch=\"$(date +%s)\" '\n{\n date_string = substr($0, index($0,\"-\")+1, 8)\n command = \"date -d \\\"\" date_string \"\\\" +%s\"\n command | getline file_epoch\n close(command)\n\n files[NR] = $0\n file_epoch_by_name[$0] = file_epoch\n\n year_month = substr(date_string,1,6)\n year_only = substr(date_string,1,4)\n\n age_in_months = int((now_epoch - file_epoch) / 2592000)\n\n if (age_in_months < 6 &&\n (!(year_month in newest_month_epoch) ||\n file_epoch > newest_month_epoch[year_month])) {\n newest_month_epoch[year_month] = file_epoch\n newest_month_file[year_month] = $0\n }\n\n if (!(year_only in newest_year_epoch) ||\n file_epoch > newest_year_epoch[year_only]) {\n newest_year_epoch[year_only] = file_epoch\n newest_year_file[year_only] = $0\n }\n}\nEND {\n for (i in files) {\n file_name = files[i]\n file_epoch = file_epoch_by_name[file_name]\n\n date_string = substr(file_name, index(file_name,\"-\")+1, 8)\n year_month = substr(date_string,1,6)\n year_only = substr(date_string,1,4)\n\n if (now_epoch - file_epoch <= 7*86400) continue\n if (file_name == newest_month_file[year_month]) continue\n if (file_name == newest_year_file[year_only]) continue\n\n printf \"%s\\0\", file_name\n }\n}' |\nxargs -0 --no-run-if-empty rm -v\n\n# update cloned test instance database using backup file from production/main database\n# docker stop moqui-test\n# dropdb -h localhost -p 5432 -U moqui -w moqui-test\n# createdb -h localhost -p 5432 -U moqui -w moqui-test\n# gunzip < $backup_file | psql -h localhost -p 5432 -U moqui -w moqui-test\n# docker start moqui-test\n\n# example for crontab (safe edit using: 'crontab -e'), each day at midnight: 00 00 * * * /opt/moqui/postgres_backup.sh\n"
},
{
"path": "docker/simple/Dockerfile",
"content": "# Builds a minimal docker image with openjdk and moqui with various volumes for configuration and persisted data outside the container\n# NOTE: add components, build and if needed load data before building a docker image with this\nARG RUNTIME_IMAGE=eclipse-temurin:21-jdk\nFROM ${RUNTIME_IMAGE}\nMAINTAINER Moqui Framework \n\nWORKDIR /opt/moqui\n\n# for running from the war directly, preffered approach unzips war in advance (see docker-build.sh that does this)\n#COPY moqui.war .\n# copy files from unzipped moqui.war file\nCOPY WEB-INF WEB-INF\nCOPY META-INF META-INF\nCOPY *.class ./\nCOPY execlib execlib\n\n# always want the runtime directory\nCOPY runtime runtime\n\n# create user for search and chown corresponding files\nARG search_name=opensearch\n\nRUN if [ -d runtime/opensearch/bin ]; then echo \"Installing OpenSearch User\"; \\\n search_name=opensearch; \\\n groupadd -g 1000 opensearch 2>/dev/null || echo \"group 1000 already exists\" && \\\n useradd -u 1000 -g 1000 -G 0 -d /opt/moqui/runtime/opensearch opensearch 2>/dev/null || echo \"user 1000 already exists\" && \\\n chmod 0775 /opt/moqui/runtime/opensearch && \\\n chown -R 1000:0 /opt/moqui/runtime/opensearch; \\\n elif [ -d runtime/elasticsearch/bin ]; then echo \"Installing ElasticSearch User\"; \\\n search_name=elasticsearch; \\\n groupadd -r elasticsearch && \\\n useradd --no-log-init -r -g elasticsearch -d /opt/moqui/runtime/elasticsearch elasticsearch && \\\n chown -R elasticsearch:elasticsearch runtime/elasticsearch; \\\n fi\n\n# exposed as volumes for configuration purposes\nVOLUME [\"/opt/moqui/runtime/conf\", \"/opt/moqui/runtime/lib\", \"/opt/moqui/runtime/classes\", \"/opt/moqui/runtime/ecomponent\"]\n# exposed as volumes to persist data outside the container, recommended\nVOLUME [\"/opt/moqui/runtime/log\", \"/opt/moqui/runtime/txlog\", \"/opt/moqui/runtime/sessions\", \"/opt/moqui/runtime/db\", \"/opt/moqui/runtime/$search_name\"]\n\n# Main Servlet Container Port\nEXPOSE 80\n# Search HTTP Port\nEXPOSE 9200\n# Search Cluster (TCP Transport) Port\nEXPOSE 9300\n# Hazelcast Cluster Port\nEXPOSE 5701\n\n# this is to run from the war file directly, preferred approach unzips war file in advance\n# ENTRYPOINT [\"java\", \"-jar\", \"moqui.war\"]\nENTRYPOINT [\"java\", \"-cp\", \".\", \"MoquiStart\"]\n\nHEALTHCHECK --interval=30s --timeout=600ms --start-period=120s CMD curl -f -H \"X-Forwarded-Proto: https\" -H \"X-Forwarded-Ssl: on\" http://localhost/status || exit 1\n# specify this as a default parameter if none are specified with docker exec/run, ie run production by default\nCMD [\"conf=conf/MoquiProductionConf.xml\", \"port=80\"]\n"
},
{
"path": "docker/simple/docker-build.sh",
"content": "#! /bin/bash\n\necho \"Usage: docker-build.sh [] [] []\"\n\nMOQUI_HOME=\"${1:-../..}\"\nNAME_TAG=\"${2:-moqui}\"\nRUNTIME_IMAGE=\"${3:-eclipse-temurin:21-jdk}\"\n\nif [ ! \"$1\" ]; then\n echo \"Usage: docker-build.sh [] [] []\"\nelse\n echo \"Running: docker-build.sh $MOQUI_HOME $NAME_TAG $RUNTIME_IMAGE\"\nfi\necho\n\nif [ -f $MOQUI_HOME/moqui-plus-runtime.war ]\nthen\n echo \"Building docker image from moqui-plus-runtime.war\"\n echo\n unzip -q $MOQUI_HOME/moqui-plus-runtime.war\nelif [ -f $MOQUI_HOME/moqui.war ]\nthen\n echo \"Building docker image from moqui.war and runtime directory\"\n echo \"NOTE: this includes everything in the runtime directory, it is better to run 'gradle addRuntime' first and use the moqui-plus-runtime.war file for the docker image\"\n echo\n unzip -q $MOQUI_HOME/moqui.war\n cp -R $MOQUI_HOME/runtime .\nelse\n echo \"Could not find $MOQUI_HOME/moqui-plus-runtime.war or $MOQUI_HOME/moqui.war\"\n echo \"Build moqui first, for example 'gradle build addRuntime' or 'gradle load addRuntime'\"\n echo\n exit 1\nfi\n\ndocker build -t $NAME_TAG --build-arg RUNTIME_IMAGE=$RUNTIME_IMAGE .\n\nif [ -d META-INF ]; then rm -Rf META-INF; fi\nif [ -d WEB-INF ]; then rm -Rf WEB-INF; fi\nif [ -d execlib ]; then rm -Rf execlib; fi\nrm *.class\nif [ -d runtime ]; then rm -Rf runtime; fi\nif [ -f Procfile ]; then rm Procfile; fi\n"
},
{
"path": "framework/build.gradle",
"content": "/*\n * This software is in the public domain under CC0 1.0 Universal plus a\n * Grant of Patent License.\n *\n * To the extent possible under law, the author(s) have dedicated all\n * copyright and related and neighboring rights to this software to the\n * public domain worldwide. This software is distributed without any\n * warranty.\n *\n * You should have received a copy of the CC0 Public Domain Dedication\n * along with this software (see the LICENSE.md file). If not, see\n * .\n */\n\nplugins {\n id 'java-library'\n id 'groovy'\n id 'war'\n}\n\nversion = '4.0.0'\n\nrepositories {\n flatDir name: 'localLib', dirs: projectDir.absolutePath + '/lib'\n mavenCentral()\n}\n\njava {\n sourceCompatibility = 21\n targetCompatibility = 21\n}\n\nbase {\n archivesName.set('moqui')\n}\n\nsourceSets {\n start\n execWar\n}\n\ngroovydoc {\n docTitle = \"Moqui Framework ${version}\"\n source = sourceSets.main.allSource\n}\n\n//tasks.withType(JavaCompile) { options.compilerArgs << \"-Xlint:unchecked\" }\n//tasks.withType(JavaCompile) { options.compilerArgs << \"-Xlint:deprecation\" }\n//tasks.withType(GroovyCompile) { options.compilerArgs << \"-Xlint:unchecked\" }\n//tasks.withType(GroovyCompile) { options.compilerArgs << \"-Xlint:deprecation\" }\n\n// Log4J has annotation processors, disable to avoid warning\ntasks.withType(JavaCompile) { options.compilerArgs << \"-proc:none\" }\ntasks.withType(GroovyCompile) { options.compilerArgs << \"-proc:none\" }\n\n// NOTE: for dependency types and 'api' definition see: https://docs.gradle.org/current/userguide/java_library_plugin.html\ndependencies {\n // Groovy\n api 'org.apache.groovy:groovy:5.0.3' // Apache 2.0\n api 'org.apache.groovy:groovy-dateutil:5.0.3' // Apache 2.0\n api 'org.apache.groovy:groovy-json:5.0.3' // Apache 2.0\n api 'org.apache.groovy:groovy-templates:5.0.3' // Apache 2.0\n api 'org.apache.groovy:groovy-xml:5.0.3' // Apache 2.0\n\n // Bitronix Transaction Manager, a modernized fork\n api 'org.moqui:btm:4.0.1' // Apache 2.0\n\n // Apache Commons\n api 'org.apache.commons:commons-csv:1.14.1' // Apache 2.0\n api('org.apache.commons:commons-email2-jakarta:2.0.0-M1') {\n exclude group: 'com.sun.mail', module: 'jakarta.mail'\n exclude group: 'com.sun.activation', module: 'jakarta.activation'\n }\n api 'org.apache.commons:commons-collections4:4.5.0' // Apache 2.0\n api 'org.apache.commons:commons-fileupload2-jakarta-servlet6:2.0.0-M4' // Apache 2.0\n api 'commons-codec:commons-codec:1.20.0' // Apache 2.0\n api 'commons-io:commons-io:2.21.0' // Apache 2.0\n api 'commons-logging:commons-logging:1.3.5' // Apache 2.0\n api 'commons-validator:commons-validator:1.10.1' // Apache 2.0\n\n // Cron Utils\n api 'com.cronutils:cron-utils:9.2.1' // Apache 2.0\n\n // Flexmark (markdown)\n api 'com.vladsch.flexmark:flexmark:0.64.8'\n api 'com.vladsch.flexmark:flexmark-ext-tables:0.64.8'\n api 'com.vladsch.flexmark:flexmark-ext-toc:0.64.8'\n\n // Freemarker\n // Remember to change the version number in FtlTemplateRenderer and MNode class when upgrading\n api 'org.freemarker:freemarker:2.3.34' // Apache 2.0\n\n // H2 Database\n api 'com.h2database:h2:2.4.240' // MPL 2.0, EPL 1.0\n\n // Java Specifications\n api 'jakarta.transaction:jakarta.transaction-api:2.0.1'\n api 'javax.cache:cache-api:1.1.1'\n api 'javax.jcr:jcr:2.0'\n api('jakarta.xml.bind:jakarta.xml.bind-api:4.0.4') { transitive = false } // EPL 2.0\n api 'jakarta.activation:jakarta.activation-api:2.1.4' // activation api\n api 'org.eclipse.angus:angus-activation:2.0.3' // activation implementation\n api 'jakarta.websocket:jakarta.websocket-api:2.2.0'\n api 'jakarta.websocket:jakarta.websocket-client-api:2.2.0'\n\n // servlet-api needed during both compile and test\n compileOnlyApi 'jakarta.servlet:jakarta.servlet-api:6.1.0'\n testImplementation 'jakarta.servlet:jakarta.servlet-api:6.1.0'\n\n // Java TOTP\n api 'dev.samstevens.totp:totp:1.7.1' // MIT\n // dev.samstevens.totp:totp depends on com.google.zxing:javase which depends on com.beust:jcommander, but an older version with a CVE, so specify latest to fix\n api 'com.beust:jcommander:1.82'\n\n // Jackson Databind (JSON, etc)\n api 'com.fasterxml.jackson.core:jackson-databind:2.20.1'\n\n // Jetty HTTP Client and Proxy Servlet\n api 'org.eclipse.jetty:jetty-client:12.1.5' // Apache 2.0\n api 'org.eclipse.jetty.ee11:jetty-ee11-proxy:12.1.5' // Apache 2.0\n api 'org.eclipse.jetty:jetty-jndi:12.1.5' // Apache 2.0\n\n // jakarta.mail\n api 'jakarta.mail:jakarta.mail-api:2.1.5' // mail api\n api 'org.eclipse.angus:angus-mail:2.0.5' // mail implementation\n\n // JSoup (HTML parser, cleaner)\n api 'org.jsoup:jsoup:1.21.2' // MIT\n\n // Apache Shiro\n api('org.apache.shiro:shiro-core:2.0.6') { transitive = false } // Apache 2.0\n api('org.apache.shiro:shiro-web:2.0.6:jakarta') { transitive = false } // Apache 2.0\n api('org.apache.shiro:shiro-lang:2.0.6') { transitive = false } // Apache 2.0\n api('org.apache.shiro:shiro-cache:2.0.6') { transitive = false } // Apache 2.0\n api('org.apache.shiro:shiro-event:2.0.6') { transitive = false } // Apache 2.0\n api('org.apache.shiro:shiro-config-core:2.0.6') { transitive = false } // Apache 2.0\n api('org.apache.shiro:shiro-config-ogdl:2.0.6') { transitive = false } // Apache 2.0\n api('org.apache.shiro:shiro-crypto-core:2.0.6') { transitive = false } // Apache 2.0\n api('org.apache.shiro:shiro-crypto-hash:2.0.6') { transitive = false } // Apache 2.0\n api('org.apache.shiro:shiro-crypto-cipher:2.0.6') { transitive = false } // Apache 2.0\n api('org.owasp.encoder:encoder:1.4.0') // BSD - transitive dependency of shiro-web\n\n // SLF4J, Log4j 2 (note Log4j 2 is used by various libraries, best not to replace it even if mostly possible with SLF4J)\n api 'org.slf4j:slf4j-api:2.0.17'\n implementation 'org.apache.logging.log4j:log4j-core:2.25.2'\n implementation 'org.apache.logging.log4j:log4j-api:2.25.2'\n runtimeOnly 'org.apache.logging.log4j:log4j-jcl:2.25.2'\n runtimeOnly 'org.apache.logging.log4j:log4j-slf4j2-impl:2.25.2'\n\n // SubEtha SMTP, depends on jakarta.mail-api which is provided\n api(\"com.github.davidmoten:subethasmtp:7.2.0\") { transitive = false }\n\n // Snake YAML\n api 'org.yaml:snakeyaml:2.5' // Apache 2.0\n\n // Apache Jackrabbit - uncomment here or include elsewhere when Jackrabbit repository configurations are used\n // api 'org.apache.jackrabbit:jackrabbit-jcr-rmi:2.12.1' // Apache 2.0\n // api 'org.apache.jackrabbit:jackrabbit-jcr2dav:2.12.1' // Apache 2.0\n\n // Apache Commons JCS - Only needed when using JCSCacheToolFactory\n // api 'org.apache.commons:commons-jcs-jcache:2.0-beta-1' // Apache 2.0\n\n // Liquibase (for future reference, not used yet)\n // api 'org.liquibase:liquibase-core:3.4.2' // Apache 2.0\n\n // ========== test dependencies ==========\n\n // junit-platform-launcher is a dependency from spock-core, included explicitly to get more recent version as needed\n testImplementation 'org.junit.platform:junit-platform-launcher:6.0.1'\n // junit-platform-suite required for test suites to specify test class order, etc\n testImplementation 'org.junit.platform:junit-platform-suite:6.0.1'\n // junit-jupiter-api for using JUnit directly, not generally needed for Spock based tests\n testImplementation 'org.junit.jupiter:junit-jupiter-api:6.0.1'\n // Spock Framework\n testImplementation platform('org.spockframework:spock-bom:2.4-groovy-5.0') // Apache 2.0\n testImplementation 'org.spockframework:spock-core:2.4-groovy-5.0' // Apache 2.0\n testImplementation 'org.spockframework:spock-junit4:2.4-groovy-5.0' // Apache 2.0\n testImplementation 'org.hamcrest:hamcrest-core:3.0' // BSD 3-Clause\n\n // ========== executable war dependencies ==========\n // Jetty\n execWarRuntimeOnly 'org.eclipse.jetty:jetty-server:12.1.5' // Apache 2.0\n execWarRuntimeOnly 'org.eclipse.jetty.ee11:jetty-ee11-webapp:12.1.5' // Apache 2.0\n execWarRuntimeOnly 'org.eclipse.jetty.ee11.websocket:jetty-ee11-websocket-jakarta-server:12.1.5' // Apache 2.0\n}\n\n// setup task dependencies to make sure the start sourceSets always get run\ncompileJava.dependsOn startClasses\ncompileTestGroovy.dependsOn classes\nsourceSets.test.compileClasspath += files(sourceSets.main.output.classesDirs)\n\n// by default the Java plugin runs test on build, change to not do that (only run test if explicit task)\n// no longer works as of gradle 4.8 or possibly earlier, use clear() instead: check.dependsOn.remove(test)\ncheck.dependsOn.clear()\n\ntest {\n useJUnitPlatform()\n testLogging { events \"passed\", \"skipped\", \"failed\" }\n testLogging.showStandardStreams = true; testLogging.showExceptions = true\n maxParallelForks = 1\n\n dependsOn cleanTest\n include '**/*MoquiSuite.class'\n\n systemProperty 'moqui.runtime', '../runtime'\n systemProperty 'moqui.conf', 'conf/MoquiDevConf.xml'\n systemProperty 'moqui.init.static', 'true'\n\n classpath += files(sourceSets.main.output.classesDirs); classpath += files(projectDir.absolutePath)\n // filter out classpath entries that don't exist (gradle adds a bunch of these), or ElasticSearch JarHell will blow up\n classpath = classpath.filter { it.exists() }\n\n beforeTest { descriptor -> logger.lifecycle(\"Running test: ${descriptor}\") }\n}\n\njar {\n // this is necessary otherwise jar won't build when war plugin is applied\n enabled = true\n archiveBaseName = 'moqui-framework'\n manifest { attributes 'Implementation-Title': 'Moqui Framework', 'Implementation-Version': version, 'Implementation-Vendor': 'Moqui Ecosystem' }\n from sourceSets.main.output\n // get all of the \"resources\" that are in component-standard directories instead of src/main/resources\n from fileTree(dir: projectDir.absolutePath, includes: ['data/**', 'entity/**', 'screen/**', 'service/**', 'template/**']) // 'xsd/**'\n}\n\ntasks.test {\n inputs.files(tasks.jar)\n}\n\nwar {\n dependsOn jar\n // put the war file in the parent directory, ie the moqui dir instead of the framework dir\n destinationDirectory.set(projectDir.parentFile)\n archiveFileName = 'moqui.war'\n // add MoquiInit.properties to the WEB-INF/classes dir for the deployed war mode of operation\n from(fileTree(dir: projectDir.parentFile, includes: ['MoquiInit.properties'])) { into 'WEB-INF/classes' }\n // this excludes the classes in sourceSets.main.output (better to have the jar file built above)\n classpath = configurations.runtimeClasspath - configurations.providedCompile\n classpath jar.archiveFile.get().asFile\n\n // put start classes and Jetty jars in the root of the war file for the executable war/jar mode of operation\n from sourceSets.start.output\n from(files(configurations.execWarRuntimeClasspath)) { into 'execlib' }\n // TODO some sort of config for Jetty? from file(projectDir.absolutePath + '/jetty/jetty.xml')\n // setup the manifest for the executable war/jar mode\n manifest { attributes 'Implementation-Title': 'Moqui Start', 'Implementation-Vendor': 'Moqui Ecosystem',\n 'Implementation-Version': version, 'Main-Class': 'MoquiStart' }\n}\n\ntask copyDependencies { doLast {\n delete file(projectDir.absolutePath + '/dependencies')\n copy { from configurations.runtime; into file(projectDir.absolutePath + '/dependencies') }\n copy { from configurations.testCompile; into file(projectDir.absolutePath + '/dependencies') }\n} }\n"
},
{
"path": "framework/data/CommonL10nData.xml",
"content": "\n\n\n \n \n \n \n\n \n \n \n \n\n \n \n \n \n\n \n \n \n \n\n \n \n \n \n\n \n \n \n \n\n \n \n \n \n\n \n \n \n \n\n \n \n \n \n\n \n \n \n \n\n \n \n \n \n\n \n \n \n \n\n \n \n \n \n \n\n \n \n \n\n \n\n"
},
{
"path": "framework/data/CurrencyData.xml",
"content": "\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n"
},
{
"path": "framework/data/EntityTypeData.xml",
"content": "\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n"
},
{
"path": "framework/data/GeoCountryData.xml",
"content": "\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n