commit 4ddae6a8a352bc4cd15e18f9611f519c9ca668af Author: Brian M. Long Date: Tue Dec 14 13:13:43 2021 -0500 initial commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..620a11b --- /dev/null +++ b/.gitignore @@ -0,0 +1,9 @@ +# Maven +target +pom.xml.versionsBackup + +# Eclipse +.settings +.project +.classpath + diff --git a/COPYING.LESSER.md b/COPYING.LESSER.md new file mode 100644 index 0000000..0927556 --- /dev/null +++ b/COPYING.LESSER.md @@ -0,0 +1,157 @@ +### GNU LESSER GENERAL PUBLIC LICENSE + +Version 3, 29 June 2007 + +Copyright (C) 2007 Free Software Foundation, Inc. + + +Everyone is permitted to copy and distribute verbatim copies of this +license document, but changing it is not allowed. + +This version of the GNU Lesser General Public License incorporates the +terms and conditions of version 3 of the GNU General Public License, +supplemented by the additional permissions listed below. + +#### 0. Additional Definitions. + +As used herein, "this License" refers to version 3 of the GNU Lesser +General Public License, and the "GNU GPL" refers to version 3 of the +GNU General Public License. + +"The Library" refers to a covered work governed by this License, other +than an Application or a Combined Work as defined below. + +An "Application" is any work that makes use of an interface provided +by the Library, but which is not otherwise based on the Library. +Defining a subclass of a class defined by the Library is deemed a mode +of using an interface provided by the Library. + +A "Combined Work" is a work produced by combining or linking an +Application with the Library. The particular version of the Library +with which the Combined Work was made is also called the "Linked +Version". + +The "Minimal Corresponding Source" for a Combined Work means the +Corresponding Source for the Combined Work, excluding any source code +for portions of the Combined Work that, considered in isolation, are +based on the Application, and not on the Linked Version. + +The "Corresponding Application Code" for a Combined Work means the +object code and/or source code for the Application, including any data +and utility programs needed for reproducing the Combined Work from the +Application, but excluding the System Libraries of the Combined Work. + +#### 1. Exception to Section 3 of the GNU GPL. + +You may convey a covered work under sections 3 and 4 of this License +without being bound by section 3 of the GNU GPL. + +#### 2. Conveying Modified Versions. + +If you modify a copy of the Library, and, in your modifications, a +facility refers to a function or data to be supplied by an Application +that uses the facility (other than as an argument passed when the +facility is invoked), then you may convey a copy of the modified +version: + +- a) under this License, provided that you make a good faith effort + to ensure that, in the event an Application does not supply the + function or data, the facility still operates, and performs + whatever part of its purpose remains meaningful, or +- b) under the GNU GPL, with none of the additional permissions of + this License applicable to that copy. + +#### 3. Object Code Incorporating Material from Library Header Files. + +The object code form of an Application may incorporate material from a +header file that is part of the Library. You may convey such object +code under terms of your choice, provided that, if the incorporated +material is not limited to numerical parameters, data structure +layouts and accessors, or small macros, inline functions and templates +(ten or fewer lines in length), you do both of the following: + +- a) Give prominent notice with each copy of the object code that + the Library is used in it and that the Library and its use are + covered by this License. +- b) Accompany the object code with a copy of the GNU GPL and this + license document. + +#### 4. Combined Works. + +You may convey a Combined Work under terms of your choice that, taken +together, effectively do not restrict modification of the portions of +the Library contained in the Combined Work and reverse engineering for +debugging such modifications, if you also do each of the following: + +- a) Give prominent notice with each copy of the Combined Work that + the Library is used in it and that the Library and its use are + covered by this License. +- b) Accompany the Combined Work with a copy of the GNU GPL and this + license document. +- c) For a Combined Work that displays copyright notices during + execution, include the copyright notice for the Library among + these notices, as well as a reference directing the user to the + copies of the GNU GPL and this license document. +- d) Do one of the following: + - 0) Convey the Minimal Corresponding Source under the terms of + this License, and the Corresponding Application Code in a form + suitable for, and under terms that permit, the user to + recombine or relink the Application with a modified version of + the Linked Version to produce a modified Combined Work, in the + manner specified by section 6 of the GNU GPL for conveying + Corresponding Source. + - 1) Use a suitable shared library mechanism for linking with + the Library. A suitable mechanism is one that (a) uses at run + time a copy of the Library already present on the user's + computer system, and (b) will operate properly with a modified + version of the Library that is interface-compatible with the + Linked Version. +- e) Provide Installation Information, but only if you would + otherwise be required to provide such information under section 6 + of the GNU GPL, and only to the extent that such information is + necessary to install and execute a modified version of the + Combined Work produced by recombining or relinking the Application + with a modified version of the Linked Version. (If you use option + 4d0, the Installation Information must accompany the Minimal + Corresponding Source and Corresponding Application Code. If you + use option 4d1, you must provide the Installation Information in + the manner specified by section 6 of the GNU GPL for conveying + Corresponding Source.) + +#### 5. Combined Libraries. + +You may place library facilities that are a work based on the Library +side by side in a single library together with other library +facilities that are not Applications and are not covered by this +License, and convey such a combined library under terms of your +choice, if you do both of the following: + +- a) Accompany the combined library with a copy of the same work + based on the Library, uncombined with any other library + facilities, conveyed under the terms of this License. +- b) Give prominent notice with the combined library that part of it + is a work based on the Library, and explaining where to find the + accompanying uncombined form of the same work. + +#### 6. Revised Versions of the GNU Lesser General Public License. + +The Free Software Foundation may publish revised and/or new versions +of the GNU Lesser General Public License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Library +as you received it specifies that a certain numbered version of the +GNU Lesser General Public License "or any later version" applies to +it, you have the option of following the terms and conditions either +of that published version or of any later version published by the +Free Software Foundation. If the Library as you received it does not +specify a version number of the GNU Lesser General Public License, you +may choose any version of the GNU Lesser General Public License ever +published by the Free Software Foundation. + +If the Library as you received it specifies that a proxy can decide +whether future versions of the GNU Lesser General Public License shall +apply, that proxy's public statement of acceptance of any version is +permanent authorization for you to choose that version for the +Library. diff --git a/COPYING.md b/COPYING.md new file mode 100644 index 0000000..2fb2e74 --- /dev/null +++ b/COPYING.md @@ -0,0 +1,675 @@ +### GNU GENERAL PUBLIC LICENSE + +Version 3, 29 June 2007 + +Copyright (C) 2007 Free Software Foundation, Inc. + + +Everyone is permitted to copy and distribute verbatim copies of this +license document, but changing it is not allowed. + +### Preamble + +The GNU General Public License is a free, copyleft license for +software and other kinds of works. + +The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom +to share and change all versions of a program--to make sure it remains +free software for all its users. We, the Free Software Foundation, use +the GNU General Public License for most of our software; it applies +also to any other work released this way by its authors. You can apply +it to your programs, too. + +When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + +To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you +have certain responsibilities if you distribute copies of the +software, or if you modify it: responsibilities to respect the freedom +of others. + +For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + +Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + +For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + +Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the +manufacturer can do so. This is fundamentally incompatible with the +aim of protecting users' freedom to change the software. The +systematic pattern of such abuse occurs in the area of products for +individuals to use, which is precisely where it is most unacceptable. +Therefore, we have designed this version of the GPL to prohibit the +practice for those products. If such problems arise substantially in +other domains, we stand ready to extend this provision to those +domains in future versions of the GPL, as needed to protect the +freedom of users. + +Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish +to avoid the special danger that patents applied to a free program +could make it effectively proprietary. To prevent this, the GPL +assures that patents cannot be used to render the program non-free. + +The precise terms and conditions for copying, distribution and +modification follow. + +### TERMS AND CONDITIONS + +#### 0. Definitions. + +"This License" refers to version 3 of the GNU General Public License. + +"Copyright" also means copyright-like laws that apply to other kinds +of works, such as semiconductor masks. + +"The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + +To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of +an exact copy. The resulting work is called a "modified version" of +the earlier work or a work "based on" the earlier work. + +A "covered work" means either the unmodified Program or a work based +on the Program. + +To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + +To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user +through a computer network, with no transfer of a copy, is not +conveying. + +An interactive user interface displays "Appropriate Legal Notices" to +the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + +#### 1. Source Code. + +The "source code" for a work means the preferred form of the work for +making modifications to it. "Object code" means any non-source form of +a work. + +A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + +The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + +The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + +The Corresponding Source need not include anything that users can +regenerate automatically from other parts of the Corresponding Source. + +The Corresponding Source for a work in source code form is that same +work. + +#### 2. Basic Permissions. + +All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + +You may make, run and propagate covered works that you do not convey, +without conditions so long as your license otherwise remains in force. +You may convey covered works to others for the sole purpose of having +them make modifications exclusively for you, or provide you with +facilities for running those works, provided that you comply with the +terms of this License in conveying all material for which you do not +control copyright. Those thus making or running the covered works for +you must do so exclusively on your behalf, under your direction and +control, on terms that prohibit them from making any copies of your +copyrighted material outside their relationship with you. + +Conveying under any other circumstances is permitted solely under the +conditions stated below. Sublicensing is not allowed; section 10 makes +it unnecessary. + +#### 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + +No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + +When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such +circumvention is effected by exercising rights under this License with +respect to the covered work, and you disclaim any intention to limit +operation or modification of the work as a means of enforcing, against +the work's users, your or third parties' legal rights to forbid +circumvention of technological measures. + +#### 4. Conveying Verbatim Copies. + +You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + +You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + +#### 5. Conveying Modified Source Versions. + +You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these +conditions: + +- a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. +- b) The work must carry prominent notices stating that it is + released under this License and any conditions added under + section 7. This requirement modifies the requirement in section 4 + to "keep intact all notices". +- c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. +- d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + +A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + +#### 6. Conveying Non-Source Forms. + +You may convey a covered work in object code form under the terms of +sections 4 and 5, provided that you also convey the machine-readable +Corresponding Source under the terms of this License, in one of these +ways: + +- a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. +- b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the Corresponding + Source from a network server at no charge. +- c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. +- d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. +- e) Convey the object code using peer-to-peer transmission, + provided you inform other peers where the object code and + Corresponding Source of the work are being offered to the general + public at no charge under subsection 6d. + +A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + +A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, +family, or household purposes, or (2) anything designed or sold for +incorporation into a dwelling. In determining whether a product is a +consumer product, doubtful cases shall be resolved in favor of +coverage. For a particular product received by a particular user, +"normally used" refers to a typical or common use of that class of +product, regardless of the status of the particular user or of the way +in which the particular user actually uses, or expects or is expected +to use, the product. A product is a consumer product regardless of +whether the product has substantial commercial, industrial or +non-consumer uses, unless such uses represent the only significant +mode of use of the product. + +"Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to +install and execute modified versions of a covered work in that User +Product from a modified version of its Corresponding Source. The +information must suffice to ensure that the continued functioning of +the modified object code is in no case prevented or interfered with +solely because modification has been made. + +If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + +The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or +updates for a work that has been modified or installed by the +recipient, or for the User Product in which it has been modified or +installed. Access to a network may be denied when the modification +itself materially and adversely affects the operation of the network +or violates the rules and protocols for communication across the +network. + +Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + +#### 7. Additional Terms. + +"Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + +When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + +Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders +of that material) supplement the terms of this License with terms: + +- a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or +- b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or +- c) Prohibiting misrepresentation of the origin of that material, + or requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or +- d) Limiting the use for publicity purposes of names of licensors + or authors of the material; or +- e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or +- f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions + of it) with contractual assumptions of liability to the recipient, + for any liability that these contractual assumptions directly + impose on those licensors and authors. + +All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + +If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + +Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; the +above requirements apply either way. + +#### 8. Termination. + +You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + +However, if you cease all violation of this License, then your license +from a particular copyright holder is reinstated (a) provisionally, +unless and until the copyright holder explicitly and finally +terminates your license, and (b) permanently, if the copyright holder +fails to notify you of the violation by some reasonable means prior to +60 days after the cessation. + +Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + +Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + +#### 9. Acceptance Not Required for Having Copies. + +You are not required to accept this License in order to receive or run +a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + +#### 10. Automatic Licensing of Downstream Recipients. + +Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + +An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + +You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + +#### 11. Patents. + +A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + +A contributor's "essential patent claims" are all patent claims owned +or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + +Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + +In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + +If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + +If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + +A patent license is "discriminatory" if it does not include within the +scope of its coverage, prohibits the exercise of, or is conditioned on +the non-exercise of one or more of the rights that are specifically +granted under this License. You may not convey a covered work if you +are a party to an arrangement with a third party that is in the +business of distributing software, under which you make payment to the +third party based on the extent of your activity of conveying the +work, and under which the third party grants, to any of the parties +who would receive the covered work from you, a discriminatory patent +license (a) in connection with copies of the covered work conveyed by +you (or copies made from those copies), or (b) primarily for and in +connection with specific products or compilations that contain the +covered work, unless you entered into that arrangement, or that patent +license was granted, prior to 28 March 2007. + +Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + +#### 12. No Surrender of Others' Freedom. + +If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under +this License and any other pertinent obligations, then as a +consequence you may not convey it at all. For example, if you agree to +terms that obligate you to collect a royalty for further conveying +from those to whom you convey the Program, the only way you could +satisfy both those terms and this License would be to refrain entirely +from conveying the Program. + +#### 13. Use with the GNU Affero General Public License. + +Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + +#### 14. Revised Versions of this License. + +The Free Software Foundation may publish revised and/or new versions +of the GNU General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in +detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies that a certain numbered version of the GNU General Public +License "or any later version" applies to it, you have the option of +following the terms and conditions either of that numbered version or +of any later version published by the Free Software Foundation. If the +Program does not specify a version number of the GNU General Public +License, you may choose any version ever published by the Free +Software Foundation. + +If the Program specifies that a proxy can decide which future versions +of the GNU General Public License can be used, that proxy's public +statement of acceptance of a version permanently authorizes you to +choose that version for the Program. + +Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + +#### 15. Disclaimer of Warranty. + +THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT +WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND +PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE +DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR +CORRECTION. + +#### 16. Limitation of Liability. + +IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR +CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES +ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT +NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR +LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM +TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER +PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. + +#### 17. Interpretation of Sections 15 and 16. + +If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + +END OF TERMS AND CONDITIONS + +### How to Apply These Terms to Your New Programs + +If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these +terms. + +To do so, attach the following notices to the program. It is safest to +attach them to the start of each source file to most effectively state +the exclusion of warranty; and each file should have at least the +"copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper +mail. + +If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands \`show w' and \`show c' should show the +appropriate parts of the General Public License. Of course, your +program's commands might be different; for a GUI interface, you would +use an "about box". + +You should also get your employer (if you work as a programmer) or +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. For more information on this, and how to apply and follow +the GNU GPL, see . + +The GNU General Public License does not permit incorporating your +program into proprietary programs. If your program is a subroutine +library, you may consider it more useful to permit linking proprietary +applications with the library. If this is what you want to do, use the +GNU Lesser General Public License instead of this License. But first, +please read . diff --git a/pom.xml b/pom.xml new file mode 100644 index 0000000..0088d9a --- /dev/null +++ b/pom.xml @@ -0,0 +1,235 @@ + + + + 4.0.0 + + com.inteligr8.alfresco + aps-model-maven-plugin + 1.0-SNAPSHOT + maven-plugin + + A Maven plugin for Alfresco Process Services model portability + + + https://bitbucket.org/inteligr8/aps-model-maven-plugin + + + Inteligr8 + https://www.inteligr8.com + + + + brian.long + Brian Long + brian@inteligr8.com + https://twitter.com/brianmlong + + + + + UTF-8 + 1.8 + 1.8 + 3.6.3 + + 2.34 + + + + + com.inteligr8.alfresco + aps-public-rest-api + 1.2.0 + aps1 + + + org.apache.commons + commons-lang3 + 3.4 + + + org.glassfish.jersey.ext + jersey-proxy-client + ${jersey.version} + + + org.glassfish.jersey.core + jersey-client + ${jersey.version} + + + org.glassfish.jersey.media + jersey-media-multipart + ${jersey.version} + + + org.glassfish.jersey.inject + jersey-hk2 + ${jersey.version} + + + org.glassfish.jersey.media + jersey-media-json-jackson + ${jersey.version} + + + org.apache.maven.shared + file-management + 3.0.0 + + + org.apache.maven + maven-plugin-api + ${maven.version} + provided + + + org.apache.maven.plugin-tools + maven-plugin-annotations + 3.6.0 + provided + + + org.apache.maven + maven-core + ${maven.version} + provided + + + org.apache.maven.plugin-testing + maven-plugin-testing-harness + 3.3.0 + test + + + org.apache.maven + maven-compat + ${maven.version} + test + + + junit + junit + 4.12 + test + + + + + + + maven-plugin-plugin + 3.6.0 + + aps-model + + + + default-descriptor + + descriptor + + + + help-descriptor + + helpmojo + + + + + + org.codehaus.plexus + plexus-component-metadata + 2.0.0 + + + + generate-metadata + + + + + + maven-invoker-plugin + 3.2.2 + + ${basedir}/src/it + ${project.build.directory}/it + ${project.build.directory}/it-repo + ${env.MAVEN_HOME} + true + + ${basedir} + + + + + run-its + + install + run + + + + + + maven-javadoc-plugin + + + javadoc + package + jar + + public + + + + + + + + + + run-it-1 + + + run-it + + + + + + maven-invoker-plugin + 3.2.2 + + + run-its + + install + run + + + + ${run-it}/pom.xml + + + + + + + + + + + + + inteligr8-releases + Inteligr8 Releases + https://repos.inteligr8.com/nexus/repository/inteligr8-public + + + + diff --git a/src/it/aps-info/pom.xml b/src/it/aps-info/pom.xml new file mode 100644 index 0000000..828e86e --- /dev/null +++ b/src/it/aps-info/pom.xml @@ -0,0 +1,34 @@ + + + + 4.0.0 + + com.inteligr8.alfresco + aps-model-maven-plugin-aps-info + @pom.version@ + pom + + APS Info Plugin Tests + + + + + ${project.groupId} + aps-model-maven-plugin + @pom.version@ + + + aps-info + validate + + aps-info + + + + + + + + diff --git a/src/it/deploy-app/pom.xml b/src/it/deploy-app/pom.xml new file mode 100644 index 0000000..d995edd --- /dev/null +++ b/src/it/deploy-app/pom.xml @@ -0,0 +1,42 @@ + + + + 4.0.0 + + com.inteligr8.alfresco + aps-model-maven-plugin-deploy-app + @pom.version@ + pom + + Deploy App Plugin Tests + + + FORMS Core + + + + + + ${project.groupId} + aps-model-maven-plugin + @pom.version@ + + + download-app + validate + + download-app + deploy-app + + + ${aps.app} + + + + + + + + diff --git a/src/it/download-app/pom.xml b/src/it/download-app/pom.xml new file mode 100644 index 0000000..6f4c9dd --- /dev/null +++ b/src/it/download-app/pom.xml @@ -0,0 +1,72 @@ + + + + 4.0.0 + + com.inteligr8.alfresco + aps-model-maven-plugin-download-app + @pom.version@ + pom + + Download App Plugin Tests + + + FORMS Core + + + + + + ${project.groupId} + aps-model-maven-plugin + @pom.version@ + + + download-app + validate + + download-app + + + ${aps.app} + + + + download-app-other + validate + + download-app + + + ${aps.app} + ${basedir}/src/main/app + + + + + + maven-enforcer-plugin + 1.4.1 + + + assert + enforce + + + + + ${project.build.directory}/app/${aps.app}.zip + ${basedir}/src/main/app/${aps.app}.zip + + + + + + + + + + + diff --git a/src/it/pack-app/pom.xml b/src/it/pack-app/pom.xml new file mode 100644 index 0000000..5d2a52b --- /dev/null +++ b/src/it/pack-app/pom.xml @@ -0,0 +1,72 @@ + + + + 4.0.0 + + com.inteligr8.alfresco + aps-model-maven-plugin-pack-app + @pom.version@ + pom + + Pack App Plugin Tests + + + FORMS Core + + + + + + ${project.groupId} + aps-model-maven-plugin + @pom.version@ + + + download-unpack-app + validate + + download-app + unpack-app + + + ${aps.app} + + + + pack-app + validate + + pack-app + + + ${aps.app} + ${basedir}/src/main/app + + + + + + maven-enforcer-plugin + 1.4.1 + + + assert + enforce + + + + + ${basedir}/src/main/app/${aps.app}.zip + + + + + + + + + + + diff --git a/src/it/translate-app/pom.xml b/src/it/translate-app/pom.xml new file mode 100644 index 0000000..0d70c2a --- /dev/null +++ b/src/it/translate-app/pom.xml @@ -0,0 +1,72 @@ + + + + 4.0.0 + + com.inteligr8.alfresco + aps-model-maven-plugin-translate-app + @pom.version@ + pom + + Translate App Plugin Tests + + + FORMS Core + + + + + + ${project.groupId} + aps-model-maven-plugin + @pom.version@ + + + download-unpack-app + validate + + download-app + unpack-app + + + ${aps.app} + + + + translate-app + validate + + translate-app + + + ${aps.app} + ${basedir}/src/main/app + + + + + + maven-enforcer-plugin + 1.4.1 + + + assert + enforce + + + + + ${basedir}/src/main/app/${aps.app}/${aps.app}.json + + + + + + + + + + + diff --git a/src/it/unpack-app/pom.xml b/src/it/unpack-app/pom.xml new file mode 100644 index 0000000..085b737 --- /dev/null +++ b/src/it/unpack-app/pom.xml @@ -0,0 +1,73 @@ + + + + 4.0.0 + + com.inteligr8.alfresco + aps-model-maven-plugin-unpack-app + @pom.version@ + pom + + Unpack App Plugin Tests + + + FORMS Core + + + + + + ${project.groupId} + aps-model-maven-plugin + @pom.version@ + + + download-unpack-app + validate + + download-app + unpack-app + + + ${aps.app} + + + + unpack-app + validate + + unpack-app + + + ${aps.app} + ${basedir}/src/main/app + + + + + + maven-enforcer-plugin + 1.4.1 + + + assert + enforce + + + + + ${project.build.directory}/app/${aps.app}/${aps.app}.json + ${basedir}/src/main/app/${aps.app}/${aps.app}.json + + + + + + + + + + + diff --git a/src/main/java/com/inteligr8/maven/aps/modeling/ApsAddressibleGoal.java b/src/main/java/com/inteligr8/maven/aps/modeling/ApsAddressibleGoal.java new file mode 100644 index 0000000..5da59ff --- /dev/null +++ b/src/main/java/com/inteligr8/maven/aps/modeling/ApsAddressibleGoal.java @@ -0,0 +1,83 @@ +package com.inteligr8.maven.aps.modeling; + +import org.apache.maven.plugin.AbstractMojo; +import org.apache.maven.plugins.annotations.Parameter; + +import com.inteligr8.alfresco.activiti.ApsClientConfiguration; +import com.inteligr8.alfresco.activiti.ApsClientJerseyImpl; +import com.inteligr8.alfresco.activiti.ApsPublicRestApiJerseyImpl; + +public abstract class ApsAddressibleGoal extends AbstractMojo { + + @Parameter( property = "activitiAppBaseUrl", required = true, defaultValue = "http://localhost:8080/activiti-app" ) + protected String activitiAppBaseUrl; + + @Parameter( property = "activitiAppAuth", required = true, defaultValue = "BASIC" ) + protected String activitiAppAuthType; + + @Parameter( property = "activitiAppBasicUsername", required = false, defaultValue = "admin" ) + protected String activitiAppAuthBasicUsername; + + @Parameter( property = "activitiAppBasicPassword", required = false, defaultValue = "admin" ) + protected String activitiAppAuthBasicPassword; + + @Parameter( property = "oAuthCode", required = false ) + protected String oauthCode; + + @Parameter( property = "oAuthClientId", required = false ) + protected String oauthClientId; + + @Parameter( property = "oAuthClientSecret", required = false ) + protected String oauthClientSecret; + + @Parameter( property = "oAuthUsername", required = false ) + protected String oauthUsername; + + @Parameter( property = "oAuthPassword", required = false ) + protected String oauthPassword; + + @Parameter( property = "oAuthTokenUrl", required = false ) + protected String oauthTokenUrl; + + private ApsPublicRestApiJerseyImpl api; + + public ApsClientConfiguration getApsClientConfiguration() { + ApsClientConfiguration config = new ApsClientConfiguration(); + config.setBaseUrl(this.activitiAppBaseUrl); + switch (this.activitiAppAuthType.toUpperCase()) { + case "BASIC": + this.getLog().info("Configuring APS with BASIC authentication"); + this.getLog().debug("Username: " + this.activitiAppAuthBasicUsername); + config.setBasicAuthUsername(this.activitiAppAuthBasicUsername); + config.setBasicAuthPassword(this.activitiAppAuthBasicPassword); + break; + case "OAUTH": + this.getLog().info("Configuring APS with OAuth authentication"); + this.getLog().debug("OAuth Code: " + this.oauthCode); + this.getLog().debug("OAuth Client ID: " + this.oauthClientId); + this.getLog().debug("OAuth Username: " + this.oauthUsername); + config.setOAuthAuthCode(this.oauthCode); + config.setOAuthTokenUrl(this.oauthTokenUrl); + config.setOAuthClientId(this.oauthClientId); + config.setOAuthClientSecret(this.oauthClientSecret); + config.setOAuthUsername(this.oauthUsername); + config.setOAuthPassword(this.oauthPassword); + break; + default: + throw new IllegalArgumentException("The 'activitiAppAuth' configuration must be either 'Basic' or 'OAuth'"); + } + + return config; + } + + public synchronized ApsPublicRestApiJerseyImpl getApsApi() { + if (this.api == null) { + ApsClientConfiguration config = this.getApsClientConfiguration(); + ApsClientJerseyImpl apsClient = new ApsClientJerseyImpl(config); + this.api = new ApsPublicRestApiJerseyImpl(apsClient); + } + + return this.api; + } + +} diff --git a/src/main/java/com/inteligr8/maven/aps/modeling/ApsAppAccessibleGoal.java b/src/main/java/com/inteligr8/maven/aps/modeling/ApsAppAccessibleGoal.java new file mode 100644 index 0000000..d59ff31 --- /dev/null +++ b/src/main/java/com/inteligr8/maven/aps/modeling/ApsAppAccessibleGoal.java @@ -0,0 +1,38 @@ +package com.inteligr8.maven.aps.modeling; + +import java.util.List; + +import com.inteligr8.alfresco.activiti.ApsPublicRestApiJerseyImpl; +import com.inteligr8.alfresco.activiti.api.ModelsApi.ModelType; +import com.inteligr8.alfresco.activiti.model.Datum; +import com.inteligr8.alfresco.activiti.model.ResultListDataRepresentation; +import com.inteligr8.alfresco.activiti.model.Tenant; + +public abstract class ApsAppAccessibleGoal extends ApsAddressibleGoal { + + protected Long findTenantId() { + List tenants = this.getApsApi().getAdminApi().getTenants(); + if (tenants == null || tenants.isEmpty()) + return null; + return tenants.iterator().next().getId(); + } + + protected Long findAppByName(String appName) { + ApsPublicRestApiJerseyImpl api = this.getApsApi(); + + this.getLog().debug("Searching for APS App with name: " + appName); + ResultListDataRepresentation results = api.getModelsApi().get(null, null, ModelType.App.getId(), null); + this.getLog().debug("Found " + results.getTotal() + " APS Apps"); + for (Datum datum : results.getData()) { + String name = (String)datum.getAdditionalProperties().get("name"); + if (name.equals(appName)) { + Number id = (Number)datum.getAdditionalProperties().get("id"); + this.getLog().info("Found APS App ID: " + id); + return id == null ? null : id.longValue(); + } + } + + return null; + } + +} diff --git a/src/main/java/com/inteligr8/maven/aps/modeling/ApsAppJsonTranslator.java b/src/main/java/com/inteligr8/maven/aps/modeling/ApsAppJsonTranslator.java new file mode 100644 index 0000000..6b947a5 --- /dev/null +++ b/src/main/java/com/inteligr8/maven/aps/modeling/ApsAppJsonTranslator.java @@ -0,0 +1,96 @@ +package com.inteligr8.maven.aps.modeling; + +import java.io.File; +import java.io.IOException; +import java.util.Map; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import com.fasterxml.jackson.databind.JsonNode; +import com.fasterxml.jackson.databind.node.ObjectNode; +import com.inteligr8.alfresco.activiti.model.Group; + +public class ApsAppJsonTranslator implements ApsFileTranslator { + + private final Logger logger = LoggerFactory.getLogger(ApsAppJsonTranslator.class); + + private Map apsOrgIndex; + private Index apsProcessIndex; + private Index fileProcessIndex; + + public ApsAppJsonTranslator( + Map apsOrgIndex, + Index apsProcessIndex, + Index fileProcessIndex) { + this.apsOrgIndex = apsOrgIndex; + this.apsProcessIndex = apsProcessIndex; + + this.fileProcessIndex = fileProcessIndex; + } + + @Override + public void translateFile(File file, String modelName, Long modelId) throws IOException { + this.logger.debug("Translating JSON file: {}", file); + + JsonNode descriptor = ModelUtil.getInstance().readJson(file); + + boolean changed = false; + + for (JsonNode _jsonModel : descriptor.get("definition").get("models")) { + ObjectNode jsonModel = (ObjectNode)_jsonModel; + + String fileProcessName = jsonModel.get("name").asText(); + this.logger.trace("Found process '{}' in APS App descriptor", fileProcessName); + + if (this.apsProcessIndex.containsValue(fileProcessName)) { + long fileProcessId = jsonModel.get("id").asLong(); + this.logger.debug("The process '{}' has ID {} in APS App descriptor", fileProcessName, fileProcessId); + + if (!fileProcessName.equals(this.fileProcessIndex.getValue(fileProcessId))) { + throw new IllegalArgumentException("DATA INTEGRITY: The APS App descriptor and BPMN proess descriptor are mismatched"); + } else if (this.fileProcessIndex.getKeys(fileProcessName).isEmpty()) { + throw new IllegalArgumentException("DATA INTEGRITY: The APS App descriptor references a missing BPMN process file"); + } + + Long apsProcessId = this.apsProcessIndex.getFirstKey(fileProcessName); + if (apsProcessId == null) { + this.logger.debug("The process '{}' is not found in APS; leaving unchanged", fileProcessName); + } else if (apsProcessId != fileProcessId) { + this.logger.debug("The process '{}' is found in APS with ID {}; changing descriptor", fileProcessName, apsProcessId); + jsonModel.put("id", apsProcessId); + changed = true; + } else { + this.logger.trace("The process '{}' ID does not change; leaving unchanged", fileProcessName); + } + } + } + + for (JsonNode _jsonIdentityInfo : descriptor.get("definition").get("publishIdentityInfo")) { + ObjectNode jsonGroup = (ObjectNode)_jsonIdentityInfo.get("group"); + + String fileOrgName = jsonGroup.get("name").asText(); + this.logger.trace("Found organization '{}' in APS App descriptor", fileOrgName); + + if (this.apsOrgIndex.containsKey(fileOrgName)) { + long fileOrgId = jsonGroup.get("id").asLong(); + long apsOrgId = this.apsOrgIndex.get(fileOrgName).getId(); + + if (fileOrgId != apsOrgId) { + this.logger.debug("The organziation '{}' exists in APS with ID {}; changing descriptor", fileOrgName, apsOrgId); + jsonGroup.put("id", apsOrgId); + changed = true; + } else { + this.logger.trace("The organization '{}' ID does not change; leaving unchanged", fileOrgName); + } + } else { + this.logger.warn("The organziation '{}' does not exist in APS", fileOrgName); + // FIXME create the organization + } + } + + if (changed) + ModelUtil.getInstance().writeJson(descriptor, file); + } + +} diff --git a/src/main/java/com/inteligr8/maven/aps/modeling/ApsAppTranslator.java b/src/main/java/com/inteligr8/maven/aps/modeling/ApsAppTranslator.java new file mode 100644 index 0000000..424d94e --- /dev/null +++ b/src/main/java/com/inteligr8/maven/aps/modeling/ApsAppTranslator.java @@ -0,0 +1,233 @@ +package com.inteligr8.maven.aps.modeling; + +import java.io.File; +import java.io.IOException; +import java.util.Collections; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.Set; +import java.util.regex.Matcher; +import java.util.regex.Pattern; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import com.inteligr8.alfresco.activiti.ApsPublicRestApiJerseyImpl; +import com.inteligr8.alfresco.activiti.api.ModelsApi.ModelType; +import com.inteligr8.alfresco.activiti.model.Datum; +import com.inteligr8.alfresco.activiti.model.Group; +import com.inteligr8.alfresco.activiti.model.ResultListDataRepresentation; +import com.inteligr8.alfresco.activiti.model.Tenant; + +public class ApsAppTranslator { + + private final Logger logger = LoggerFactory.getLogger(ApsAppTranslator.class); + private final Pattern filenamePattern = Pattern.compile("([^/]+)-([0-9]+)\\.(json|bpmn20\\.xml)"); + private final ApsPublicRestApiJerseyImpl api; + private final String appName; + private final File appDirectory; + private final File appDescriptor; + private final boolean failOnIntegrityViolation; + + private Map apsOrgIndex; + private Index apsFormIndex; + private Index apsProcessIndex; + private Index fileFormIndex; + private Index fileProcessIndex; + private Index fileSubprocessIndex; + + public ApsAppTranslator(String apsAppName, File apsAppDirectory, ApsPublicRestApiJerseyImpl api, boolean failOnIntegrityViolation) { + this.api = api; + this.appName = apsAppName; + this.appDirectory = apsAppDirectory; + this.failOnIntegrityViolation = failOnIntegrityViolation; + + this.appDescriptor = this.validateDescriptor(appDirectory); + if (this.logger.isDebugEnabled()) + this.logger.debug("APS App descriptor found: " + this.appDescriptor); + } + + protected File validateDescriptor(File appDirectory) { + File appDescriptor = new File(appDirectory, this.appName + ".json"); + + if (!appDescriptor.exists()) + throw new IllegalStateException("The APS App descriptor could not be found: " + appDescriptor); + if (!appDescriptor.isFile()) + throw new IllegalStateException("The APS App descriptor is not a file: " + appDescriptor); + + return appDescriptor; + } + + public void execute() throws IOException { + this.buildIndexes(); + this.translate(); + } + + protected void buildIndexes() throws IOException { + this.logger.info("Building indexes ..."); + + long tenantId = this.findTenantId(); + this.logger.debug("APS App tenant ID: {}", tenantId); + + this.apsOrgIndex = this.buildApsGroupMap(tenantId); + this.logger.debug("APS App organizations: {}", this.apsOrgIndex); + + this.apsProcessIndex = this.buildApsModelIndex(ModelType.Process); + this.logger.debug("APS process models: {}", this.apsProcessIndex); + + this.apsFormIndex = this.buildApsModelIndex(ModelType.Form); + this.logger.debug("APS form models: {}", this.apsFormIndex); + + this.fileFormIndex = this.buildFileIndex("form-models", this.apsFormIndex, true); + this.logger.debug("File form models: {}", this.fileFormIndex); + + this.fileProcessIndex = this.buildFileIndex("bpmn-models", this.apsProcessIndex, true); + this.logger.debug("File process models: {}", this.fileProcessIndex); + + this.fileSubprocessIndex = this.buildFileIndex("bpmn-subprocess-models", this.apsProcessIndex, true); + this.logger.debug("File subprocess models: {}", this.fileSubprocessIndex); + } + + protected void translate() throws IOException { + this.logger.info("Translating models ..."); + + ApsFileTranslator descriptorTranslator = new ApsAppJsonTranslator( + this.apsOrgIndex, + this.apsProcessIndex, + this.fileProcessIndex); + ApsFileTranslator formTranslator = new ApsFormJsonTranslator( + this.apsFormIndex); + ApsFileTranslator processTranslator = new ApsProcessJsonTranslator( + this.apsProcessIndex, + this.apsOrgIndex, + this.apsFormIndex); + ApsFileTranslator bpmnTranslator = new ApsProcessBpmnTranslator( + this.apsProcessIndex, + this.apsOrgIndex, + this.apsFormIndex, + this.fileFormIndex); + + Map processTranslators = new HashMap<>(); + processTranslators.put("json", processTranslator); + processTranslators.put("bpmn20.xml", bpmnTranslator); + processTranslators.put("bpmn", bpmnTranslator); + + this.translate(descriptorTranslator, this.appDescriptor, this.appName, null); + this.translateModels("form-models", formTranslator); + this.translateModels("bpmn-models", processTranslators); + this.translateModels("bpmn-subprocess-models", processTranslator); + } + + protected Long findTenantId() { + List tenants = this.api.getAdminApi().getTenants(); + return (tenants == null || tenants.isEmpty()) ? null : tenants.iterator().next().getId(); + } + + protected Map buildApsGroupMap(long tenantId) { + List groups = this.api.getAdminApi().getGroups(tenantId, true, true); + + Map map = new HashMap<>(groups.size()); + for (Group group : groups) + map.put(group.getName(), group); + return map; + } + + protected Index buildApsModelIndex(ModelType modelType) { + ResultListDataRepresentation results = this.api.getModelsApi().get(null, null, modelType.getId(), null); + + Index map = new Index<>(results.getSize().intValue(), false); + + try { + for (Datum datum : results.getData()) { + Number defId = (Number)datum.getAdditionalProperties().get("id"); + String defName = (String)datum.getAdditionalProperties().get("name"); + map.put(defId.longValue(), defName); + } + } catch (IllegalArgumentException iae) { + throw new IllegalStateException("This goal does not support the current state of APS", iae); + } + + return map; + } + + private Index buildFileIndex(String modelFolderName, Index apsProcessIndex, boolean renameFiles) { + File subprocessesDirectory = new File(this.appDirectory, modelFolderName); + return this.buildFileIndex(subprocessesDirectory, apsProcessIndex, renameFiles); + } + + protected Index buildFileIndex(File modelDirectory, Index apsModelIndex, boolean renameFiles) { + if (!modelDirectory.exists()) + return new Index<>(0, false); + if (!modelDirectory.isDirectory()) + throw new IllegalStateException("The APS model directory is actually a file: " + modelDirectory); + + Index fileModelIndex = new Index<>(apsModelIndex.size(), false); + + for (File modelFile : modelDirectory.listFiles()) { + Matcher matcher = this.filenamePattern.matcher(modelFile.getName()); + String modelName = matcher.replaceFirst("$1"); + String modelIdStr = matcher.replaceFirst("$2"); + String modelExt = matcher.replaceFirst("$3"); + long fileModelId = Long.parseLong(modelIdStr); + + fileModelIndex.put(fileModelId, modelName); + + Set apsModelIds = apsModelIndex.getKeys(modelName); + if (apsModelIds.size() > 1) + throw new IllegalStateException("An APS " + modelDirectory.getName() + " name was used multiple times: " + modelName); + + if (renameFiles && !apsModelIds.isEmpty()) { + Long apsModelId = apsModelIds.iterator().next(); + if (apsModelId != fileModelId) { + this.logger.debug("Renaming form model from '" + modelFile.getName() + "' to match APS form ID: " + apsModelId); + File newModelFile = new File(modelFile.getParentFile(), modelName + "-" + apsModelId + "." + modelExt); + modelFile.renameTo(newModelFile); + } else { + this.logger.debug("The APS model '{}' and corresponding model file have matching IDs", modelName); + } + } + } + + return fileModelIndex; + } + + protected void translateModels(String modelsDirectoryName, ApsFileTranslator translator) throws IOException { + this.translateModels(modelsDirectoryName, Collections.singletonMap("json", translator)); + } + + protected void translateModels(String modelsDirectoryName, Map translators) throws IOException { + File modelsDirectory = new File(this.appDirectory, modelsDirectoryName); + for (File modelFile : modelsDirectory.listFiles()) { + Matcher matcher = this.filenamePattern.matcher(modelFile.getName()); + if (!matcher.find()) { + this.logger.warn("The '{}' folder has a file with an unexpected filename format; skipping: {}", modelsDirectoryName, modelFile); + continue; + } + + String ext = matcher.group(3); + ApsFileTranslator translator = translators.get(ext.toLowerCase()); + if (translator == null) { + this.logger.warn("The '{}' folder has a file with an unexpected extension; skipping: {}", modelsDirectoryName, modelFile); + continue; + } + + String modelName = matcher.group(1); + Long modelId = new Long(matcher.group(2)); + this.translate(translator, modelFile, modelName, modelId); + } + } + + private void translate(ApsFileTranslator translator, File modelFile, String modelName, Long modelId) throws IOException { + try { + translator.translateFile(modelFile, modelName, modelId); + } catch (IllegalArgumentException | IllegalStateException ie) { + if (this.failOnIntegrityViolation) { + throw ie; + } else { + this.logger.warn(ie.getMessage()); + } + } + } + +} diff --git a/src/main/java/com/inteligr8/maven/aps/modeling/ApsFileTranslator.java b/src/main/java/com/inteligr8/maven/aps/modeling/ApsFileTranslator.java new file mode 100644 index 0000000..80d4862 --- /dev/null +++ b/src/main/java/com/inteligr8/maven/aps/modeling/ApsFileTranslator.java @@ -0,0 +1,10 @@ +package com.inteligr8.maven.aps.modeling; + +import java.io.File; +import java.io.IOException; + +public interface ApsFileTranslator { + + void translateFile(File file, String modelName, Long modelId) throws IOException; + +} diff --git a/src/main/java/com/inteligr8/maven/aps/modeling/ApsFormJsonTranslator.java b/src/main/java/com/inteligr8/maven/aps/modeling/ApsFormJsonTranslator.java new file mode 100644 index 0000000..1d9228a --- /dev/null +++ b/src/main/java/com/inteligr8/maven/aps/modeling/ApsFormJsonTranslator.java @@ -0,0 +1,50 @@ +package com.inteligr8.maven.aps.modeling; + +import java.io.File; +import java.io.IOException; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import com.fasterxml.jackson.databind.JsonNode; +import com.fasterxml.jackson.databind.node.ObjectNode; + +public class ApsFormJsonTranslator implements ApsFileTranslator { + + private final Logger logger = LoggerFactory.getLogger(ApsFormJsonTranslator.class); + private final Index apsIndex; + + public ApsFormJsonTranslator(Index apsFormIndex) { + this.apsIndex = apsFormIndex; + } + + @Override + public void translateFile(File file, String formName, Long formId) throws IOException { + this.logger.debug("Translating JSON file: {}", file); + boolean changed = false; + + ObjectNode jsonDescriptor = ModelUtil.getInstance().readJson(file, ObjectNode.class); + JsonNode jsonResourceId = jsonDescriptor.get("resourceId"); + if (jsonResourceId == null || jsonResourceId.isNull()) { + this.logger.debug("The form has no ID to translate"); + return; + } + + this.logger.trace("Found ID {} in the '{}' APS Form descriptor", jsonResourceId, formName); + + Long apsFormId = this.apsIndex.getFirstKey(formName); + if (apsFormId == null) { + this.logger.debug("The form '{}' does not exist in APS; leaving unchanged", formName); + } else if (!formId.equals(apsFormId)) { + this.logger.debug("The form '{}' exists in APS with ID {}; changing descriptor", formName, apsFormId); + jsonDescriptor.put("resourceId", apsFormId); + changed = true; + } else { + this.logger.trace("The form '{}' ID does not change; leaving unchanged", formName, apsFormId); + } + + if (changed) + ModelUtil.getInstance().writeJson(jsonDescriptor, file); + } + +} diff --git a/src/main/java/com/inteligr8/maven/aps/modeling/ApsInfoGoal.java b/src/main/java/com/inteligr8/maven/aps/modeling/ApsInfoGoal.java new file mode 100644 index 0000000..07b8d01 --- /dev/null +++ b/src/main/java/com/inteligr8/maven/aps/modeling/ApsInfoGoal.java @@ -0,0 +1,25 @@ +package com.inteligr8.maven.aps.modeling; + +import org.apache.maven.plugin.MojoExecutionException; +import org.apache.maven.plugin.MojoFailureException; +import org.apache.maven.plugins.annotations.Mojo; +import org.codehaus.plexus.component.annotations.Component; + +import com.inteligr8.alfresco.activiti.model.AppVersion; + +@Mojo( name = "aps-info", threadSafe = true ) +@Component( role = org.apache.maven.plugin.Mojo.class ) +public class ApsInfoGoal extends ApsAddressibleGoal { + + @Override + public void execute() throws MojoExecutionException, MojoFailureException { + AppVersion version = this.getApsApi() + .getAppVersionApi() + .get(); + + this.getLog().debug("APS type: " + version.getType()); + this.getLog().info("APS edition: " + version.getEdition()); + this.getLog().info("APS version: " + version.getMajorVersion() + "." + version.getMinorVersion() + "." + version.getRevisionVersion()); + } + +} diff --git a/src/main/java/com/inteligr8/maven/aps/modeling/ApsProcessBpmnTranslator.java b/src/main/java/com/inteligr8/maven/aps/modeling/ApsProcessBpmnTranslator.java new file mode 100644 index 0000000..61966ca --- /dev/null +++ b/src/main/java/com/inteligr8/maven/aps/modeling/ApsProcessBpmnTranslator.java @@ -0,0 +1,331 @@ +package com.inteligr8.maven.aps.modeling; + +import java.io.File; +import java.io.IOException; +import java.util.LinkedList; +import java.util.List; +import java.util.Map; +import java.util.regex.Matcher; +import java.util.regex.Pattern; + +import javax.xml.transform.TransformerException; +import javax.xml.xpath.XPathConstants; +import javax.xml.xpath.XPathExpressionException; + +import org.apache.commons.lang3.StringUtils; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.w3c.dom.Attr; +import org.w3c.dom.CDATASection; +import org.w3c.dom.Document; +import org.w3c.dom.Element; +import org.w3c.dom.NodeList; +import org.xml.sax.SAXException; + +import com.inteligr8.alfresco.activiti.model.Group; + +public class ApsProcessBpmnTranslator implements ApsFileTranslator { + + private static final String NAMESPACE_ACTIVITI = "http://activiti.org/bpmn"; + private static final String NAMESPACE_ACTIVITI_MODELER = "http://activiti.com/modeler"; + + private final Logger logger = LoggerFactory.getLogger(ApsProcessBpmnTranslator.class); + private final Index apsIndex; + private final Map apsOrgIndex; + private final Index apsFormIndex; + private final Index fileFormIndex; + + public ApsProcessBpmnTranslator( + Index apsProcessIndex, + Map apsOrgIndex, + Index apsFormIndex, + Index fileFormIndex) { + this.apsIndex = apsProcessIndex; + this.apsOrgIndex = apsOrgIndex; + this.apsFormIndex = apsFormIndex; + + this.fileFormIndex = fileFormIndex; + } + + @Override + public void translateFile(File file, String processName, Long processId) throws IOException { + this.logger.debug("Translating BPMN file: {}", file); + + boolean changed = false; + Long apsProcessId = this.apsIndex.getFirstKey(processName); + + try { + Document bpmn = ModelUtil.getInstance().readXml(file); + Element definitionsElement = bpmn.getDocumentElement(); + + changed = this.translateRootElement(definitionsElement, apsProcessId) || changed; + + NodeList candidateGroupElements = ModelUtil.getInstance().xpath(definitionsElement, "//*[@activiti:candidateGroups]"); + for (int n = 0; n < candidateGroupElements.getLength(); n++) { + Element candidateGroupElement = (Element)candidateGroupElements.item(n); + changed = this.translateTaskCandidateGroup(candidateGroupElement) || changed; + } + + NodeList formKeyElements = ModelUtil.getInstance().xpath(definitionsElement, "//*[@activiti:formKey]"); + for (int n = 0; n < formKeyElements.getLength(); n++) { + Element formKeyElement = (Element)formKeyElements.item(n); + changed = this.translateTaskForm(formKeyElement) || changed; + } + + NodeList subprocessElements = ModelUtil.getInstance().xpath(definitionsElement, "//subProcess"); + for (int n = 0; n < subprocessElements.getLength(); n++) { + Element subprocessElement = (Element)subprocessElements.item(n); + changed = this.translateSubprocess(subprocessElement) || changed; + } + + NodeList conditionDefinitionElements = ModelUtil.getInstance().xpath(definitionsElement, "//modeler:conditionDefinition"); + for (int n = 0; n < conditionDefinitionElements.getLength(); n++) { + Element conditionDefinitionElement = (Element)conditionDefinitionElements.item(n); + changed = this.translateConditionDefinition(conditionDefinitionElement) || changed; + } + + NodeList conditionExpressions = ModelUtil.getInstance().xpath(definitionsElement, "//conditionExpression/text()"); + for (int n = 0; n < conditionExpressions.getLength(); n++) { + CDATASection conditionExpression = (CDATASection)conditionExpressions.item(n); + changed = this.translateConditionExpression(conditionExpression) || changed; + } + + if (changed) + ModelUtil.getInstance().writeXml(bpmn, file); + } catch (TransformerException | XPathExpressionException | SAXException e) { + throw new IllegalStateException("An XML issue occurred", e); + } + } + + private boolean translateRootElement(Element definitionsElement, Long apsProcessId) { + boolean changed = false; + + changed = this.setAttributeIfSet(definitionsElement, NAMESPACE_ACTIVITI_MODELER, "modelId", apsProcessId) || changed; + changed = this.removeAttributeIfSet(definitionsElement, NAMESPACE_ACTIVITI_MODELER, "modelVersion") || changed; + changed = this.removeAttributeIfSet(definitionsElement, NAMESPACE_ACTIVITI_MODELER, "exportDateTime") || changed; + changed = this.removeAttributeIfSet(definitionsElement, NAMESPACE_ACTIVITI_MODELER, "modelLastUpdated") || changed; + + return changed; + } + + + + private boolean translateTaskCandidateGroup(Element taskElement) throws XPathExpressionException { + this.logger.trace("Translating task for candidate groups: {}", taskElement.getAttribute("id")); + boolean changed = false; + + Attr candidateGroupsAttr = taskElement.getAttributeNodeNS(NAMESPACE_ACTIVITI, "candidateGroups"); + if (candidateGroupsAttr == null) + return false; + + this.logger.trace("Found '{}' candidate groups in the APS Process BPMN model", candidateGroupsAttr.getValue()); + + List groupIdsList = new LinkedList<>(); + + String[] groupIds = candidateGroupsAttr.getValue().split(","); + for (String groupIdStr : groupIds) { + groupIdStr = groupIdStr.trim(); + if (groupIdStr.length() == 0) + continue; + long orgId = Long.parseLong(groupIdStr.trim()); + + Element groupNameElement = (Element)ModelUtil.getInstance().xpath( + taskElement, + "tns:extensionElements/modeler:group-info-name-" + orgId, + XPathConstants.NODE); + if (groupNameElement == null) + throw new IllegalStateException("The candidate group ID " + orgId +" does not have a corresponding candidate group name"); + + String groupName = groupNameElement.getTextContent().trim(); + this.logger.trace("Found '{}' candidate group in the APS Process BPMN model", groupName); + + if (this.apsOrgIndex.containsKey(groupName)) { + long apsOrgId = this.apsOrgIndex.get(groupName).getId(); + groupIdsList.add(apsOrgId); + + if (apsOrgId != orgId) { + this.logger.debug("The organization '{}' exists in APS with ID {}; changing model", groupName, apsOrgId); + groupNameElement = (Element)groupNameElement.getOwnerDocument().renameNode(groupNameElement, + groupNameElement.getNamespaceURI(), "group-info-name-" + apsOrgId); + changed = true; + } else { + this.logger.trace("The organization '{}' ID does not change; leaving unchanged", groupName); + } + } else { + // FIXME automatically add the group? + this.logger.debug("The organization '{}' does not exist in APS; leaving unchanged", groupName); + groupIdsList.add(orgId); + } + } + + if (changed) + candidateGroupsAttr.setValue(StringUtils.join(groupIdsList, ",")); + return changed; + } + + private boolean translateTaskForm(Element taskElement) throws XPathExpressionException { + this.logger.trace("Translating task for forms: {}", taskElement.getAttribute("id")); + boolean changed = false; + + String formRefName = (String)ModelUtil.getInstance().xpath( + taskElement, + "tns:extensionElements/modeler:form-reference-name/text()", + XPathConstants.STRING); + if (formRefName == null) + throw new IllegalStateException("A form was detected in the task, but no form name was found: " + taskElement.getAttribute("id")); + + formRefName = formRefName.trim(); + this.logger.trace("Found '{}' form in the APS Process BPMN model", formRefName); + + Long apsFormId = this.apsFormIndex.getFirstKey(formRefName); + if (apsFormId == null) { + this.logger.debug("The form '{}' does not exist in APS; leaving unchanged", formRefName); + return false; + } + + this.logger.trace("Found ID {} for the form '{}' in the APS Process BPMN model", apsFormId, formRefName); + + Attr formKeyAttr = taskElement.getAttributeNodeNS(NAMESPACE_ACTIVITI, "formKey"); + if (formKeyAttr == null) + throw new IllegalStateException("A form was detected in the task, but no form key was found: " + taskElement.getAttribute("id")); + + long formKey = Long.parseLong(formKeyAttr.getValue().trim()); + if (apsFormId != formKey) { + this.logger.debug("The form '{}' exists in APS with ID {}; changing model", formRefName, apsFormId); + formKeyAttr.setValue(apsFormId.toString()); + changed = true; + } else { + this.logger.trace("The form '{}' key does not change; leaving unchanged", formRefName); + } + + CDATAFlexSection formRefIdData = (CDATAFlexSection)ModelUtil.getInstance().xpath( + taskElement, + "tns:extensionElements/modeler:form-reference-id", + ModelUtil.CDATA_FLEX); + if (formRefIdData == null) + throw new IllegalStateException("A form was detected in the task, but no form reference ID was found: " + taskElement.getAttribute("id")); + + long formRefId = Long.parseLong(formRefIdData.getValue()); + if (apsFormId != formRefId) { + this.logger.debug("The form '{}' reference exists in APS with ID {}; changing model", formRefName, apsFormId); + formRefIdData.setValue(apsFormId.toString()); + changed = true; + } else { + this.logger.trace("The form '{}' reference ID does not change; leaving unchanged", formRefName); + } + + return changed; + } + + private boolean translateSubprocess(Element subprocessElement) throws XPathExpressionException { + this.logger.trace("Translating subprocess: {}", subprocessElement.getAttribute("id")); + boolean changed = false; + + String subprocessName = (String)ModelUtil.getInstance().xpath( + subprocessElement, + "tns:extensionElements/modeler:subprocess-name/text()", + XPathConstants.STRING); + if (subprocessName == null) { + this.logger.warn("The subprocess task '{}' has no defined subprocess; ignoring", subprocessElement.getAttribute("id")); + return false; + } + + subprocessName = subprocessName.trim(); + this.logger.trace("Found '{}' subprocess in the APS Process BPMN model", subprocessName); + + Long apsProcessId = this.apsIndex.getFirstKey(subprocessName); + + if (apsProcessId == null) { + this.logger.debug("The process '{}' does not exist in APS; leaving unchanged", subprocessName); + return false; + } + + this.logger.trace("Found ID {} for the subprocess '{}' in the APS Process BPMN model", apsProcessId, subprocessName); + + CDATAFlexSection subprocessIdData = (CDATAFlexSection)ModelUtil.getInstance().xpath( + subprocessElement, + "tns:extensionElements/modeler:subprocess-id", + ModelUtil.CDATA_FLEX); + long subprocessId = Long.parseLong(subprocessIdData.getValue()); + if (apsProcessId != subprocessId) { + this.logger.debug("The process '{}' exists in APS with ID {}; changing model", subprocessName, apsProcessId); + subprocessIdData.setValue(apsProcessId.toString()); + changed = true; + } else { + this.logger.trace("The process '{}' ID does not change; leaving unchanged", subprocessName); + } + + return changed; + } + + private boolean translateConditionDefinition(Element conditionDefinitionElement) throws XPathExpressionException { + this.logger.trace("Translating condition definition for outcome form elements: {}", conditionDefinitionElement.getParentNode().getParentNode().getAttributes().getNamedItem("id")); + boolean changed = false; + + Attr outcomeFormNameAttr = conditionDefinitionElement.getAttributeNodeNS(NAMESPACE_ACTIVITI_MODELER, "outcomeFormName"); + if (outcomeFormNameAttr != null) { + String outcomeFormName = outcomeFormNameAttr.getValue(); + Long outcomeApsFormId = this.apsFormIndex.getFirstKey(outcomeFormName); + if (outcomeApsFormId != null) { + Attr outcomeFormIdAttr = conditionDefinitionElement.getAttributeNodeNS(NAMESPACE_ACTIVITI_MODELER, "outcomeFormId"); + long outcomeFormId = Long.parseLong(outcomeFormIdAttr.getValue().trim()); + if (outcomeApsFormId != outcomeFormId) { + this.logger.debug("The form '{}' exists in APS with ID {}; leaving unchanged", outcomeFormName, outcomeApsFormId); + outcomeFormIdAttr.setValue(String.valueOf(outcomeApsFormId)); + changed = true; + } else { + this.logger.trace("The form '{}' ID does not change; leaving unchanged", outcomeFormName); + } + } + } + + return changed; + } + + private boolean translateConditionExpression(CDATASection conditionExpressionCdata) throws XPathExpressionException { + this.logger.trace("Translating condition expression for outcome form elements: {}", conditionExpressionCdata.getParentNode().getParentNode().getAttributes().getNamedItem("id")); + boolean changed = false; + + String conditionExpression = conditionExpressionCdata.getData(); + Pattern formOutcomeInExpressionPattern = Pattern.compile("[^A-Za-z0-9]form([0-9]+)outcome[^A-Za-z0-9]"); + Matcher matcher = formOutcomeInExpressionPattern.matcher(conditionExpression); + while (matcher.find()) { + long formId = Long.parseLong(matcher.group(1)); + String formName = this.fileFormIndex.getValue(formId); + if (formName == null) { + this.logger.warn("The form ID '{}' does not exist in the form model files; ignoring", formId); + } else { + Long apsFormId = this.apsFormIndex.getFirstKey(formName); + if (apsFormId == null) { + this.logger.warn("The form '{}' does not exist in APS; leaving unchanged", formName); + } else { + conditionExpressionCdata.setData(apsFormId.toString()); + changed = true; + } + } + } + + return changed; + } + + + + private boolean setAttributeIfSet(Element element, String attrNamespace, String attrName, Object value) { + Attr attr = element.getAttributeNodeNS(attrNamespace, attrName); + if (attr == null) + return false; + + attr.setValue(value.toString()); + return true; + } + + private boolean removeAttributeIfSet(Element element, String attrNamespace, String attrName) { + Attr attr = element.getAttributeNodeNS(attrNamespace, attrName); + if (attr == null) + return false; + + element.removeAttributeNode(attr); + return true; + } + +} diff --git a/src/main/java/com/inteligr8/maven/aps/modeling/ApsProcessJsonTranslator.java b/src/main/java/com/inteligr8/maven/aps/modeling/ApsProcessJsonTranslator.java new file mode 100644 index 0000000..f61b020 --- /dev/null +++ b/src/main/java/com/inteligr8/maven/aps/modeling/ApsProcessJsonTranslator.java @@ -0,0 +1,203 @@ +package com.inteligr8.maven.aps.modeling; + +import java.io.File; +import java.io.IOException; +import java.util.Map; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import com.fasterxml.jackson.databind.JsonNode; +import com.fasterxml.jackson.databind.node.ArrayNode; +import com.fasterxml.jackson.databind.node.ObjectNode; +import com.inteligr8.alfresco.activiti.model.Group; + +public class ApsProcessJsonTranslator implements ApsFileTranslator { + + private final Logger logger = LoggerFactory.getLogger(ApsProcessJsonTranslator.class); + private final Index apsIndex; + private final Map apsOrgIndex; + private final Index apsFormIndex; + + public ApsProcessJsonTranslator( + Index apsProcessIndex, + Map apsOrgIndex, + Index apsFormIndex) { + this.apsIndex = apsProcessIndex; + this.apsOrgIndex = apsOrgIndex; + this.apsFormIndex = apsFormIndex; + } + + @Override + public void translateFile(File file, String processName, Long processId) throws IOException { + this.logger.debug("Translating JSON file: {}", file); + + boolean changed = false; + Long apsProcessId = this.apsIndex.getFirstKey(processName); + + ObjectNode jsonDescriptor = ModelUtil.getInstance().readJson(file, ObjectNode.class); + + changed = this.translateResourceId(jsonDescriptor, apsProcessId) || changed; + changed = this.translateOrganizations(jsonDescriptor) || changed; + changed = this.translateForms(jsonDescriptor) || changed; + changed = this.translateSubprocesses(jsonDescriptor) || changed; + + if (changed) + ModelUtil.getInstance().writeJson(jsonDescriptor, file); + } + + private boolean translateResourceId(ObjectNode jsonDescriptor, Long apsProcessId) { + JsonNode jsonResourceId = jsonDescriptor.get("resourceId"); + if (jsonResourceId == null || jsonResourceId.isNull()) { + this.logger.trace("The process 'resourceId' is not defined; leaving unchanged", apsProcessId); + return false; + } else if (jsonResourceId.asLong() != apsProcessId) { + this.logger.debug("The process is found in APS with ID {}; changing 'resourceId' in descriptor", apsProcessId); + jsonDescriptor.put("resourceId", apsProcessId); + return true; + } else { + this.logger.trace("The process ID {} does not change; leaving unchanged", apsProcessId); + return false; + } + } + + + + private boolean translateOrganizations(ObjectNode jsonDescriptor) { + boolean changed = false; + + for (JsonNode jsonChildShape : this.getChildShapes(jsonDescriptor)) { + try { + JsonNode jsonUserTaskAssignment = (JsonNode)jsonChildShape.get("properties").get("usertaskassignment"); + if (!jsonUserTaskAssignment.isObject()) + continue; + + for (JsonNode _jsonCandidateGroup : jsonUserTaskAssignment.get("assignment").get("idm").get("candidateGroups")) { + ObjectNode jsonCandidateGroup = (ObjectNode)_jsonCandidateGroup; + changed = this.translateOrganization(jsonCandidateGroup) || changed; + } + } catch (NullPointerException npe) { + // suppress; gracefully skip + } + } + + return changed; + } + + private boolean translateOrganization(ObjectNode jsonCandidateGroup) { + String fileOrgName = jsonCandidateGroup.get("name").asText(); + this.logger.trace("Found organization '{}' in the APS Process descriptor", fileOrgName); + + if (this.apsOrgIndex.containsKey(fileOrgName)) { + long fileOrgId = jsonCandidateGroup.get("id").asLong(); + long apsOrgId = this.apsOrgIndex.get(fileOrgName).getId(); + if (apsOrgId != fileOrgId) { + this.logger.debug("The organization '{}' exists in APS with ID {}; changing descriptor", fileOrgName, apsOrgId); + jsonCandidateGroup.put("id", apsOrgId); + return true; + } else { + this.logger.trace("The organization '{}' ID does not change; leaving unchanged", fileOrgName); + return false; + } + } else { + // FIXME automatically add the group? + this.logger.debug("The organization '{}' does not exist in APS; leaving unchanged", fileOrgName); + return false; + } + } + + + + private boolean translateForms(ObjectNode jsonDescriptor) { + boolean changed = false; + + for (JsonNode jsonChildShape : this.getChildShapes(jsonDescriptor)) { + try { + JsonNode jsonConditionalSequenceFlow = (JsonNode)jsonChildShape.get("properties").get("conditionalsequenceflow"); + changed = this.translateConditionalSequenceFlow(jsonConditionalSequenceFlow) || changed; + + JsonNode jsonFormRef = (JsonNode)jsonChildShape.get("properties").get("formreference"); + changed = this.translateReference(jsonFormRef, this.apsFormIndex) || changed; + } catch (NullPointerException npe) { + // suppress; gracefully skip + } + } + + return changed; + } + + private boolean translateConditionalSequenceFlow(JsonNode jsonConditionalSequenceFlow) { + if (jsonConditionalSequenceFlow == null || !jsonConditionalSequenceFlow.isObject()) + return false; + + this.logger.trace("Found a conditional sequence flow in the APS Process descriptor"); + + ObjectNode expression = (ObjectNode)jsonConditionalSequenceFlow.get("expression"); + + boolean changed = false; + changed = this.translateNamedId(expression, this.apsFormIndex, "outcomeForm") || changed; + changed = this.translateNamedId(expression, this.apsFormIndex, "rightOutcomeForm") || changed; + return changed; + } + + + + private boolean translateSubprocesses(ObjectNode jsonDescriptor) { + boolean changed = false; + + for (JsonNode jsonChildShape : this.getChildShapes(jsonDescriptor)) { + try { + JsonNode jsonSubprocessRef = (JsonNode)jsonChildShape.get("properties").get("subprocessreference"); + changed = this.translateReference(jsonSubprocessRef, this.apsIndex) || changed; + } catch (NullPointerException npe) { + // suppress; gracefully skip + } + } + + return changed; + } + + + + private boolean translateReference(JsonNode _jsonRef, Index apsIndex) { + return this.translateNamedId(_jsonRef, apsIndex, null); + } + + private boolean translateNamedId(JsonNode _jsonRef, Index apsIndex, String prefix) { + if (_jsonRef == null || !_jsonRef.isObject()) + return false; + + String nameField = prefix == null ? "name" : prefix + "Name"; + String idField = prefix == null ? "id" : prefix + "Id"; + + ObjectNode jsonRef = (ObjectNode)_jsonRef; + String modelName = jsonRef.get(nameField).asText(); + this.logger.trace("Found model '{}' in the APS Process descriptor", modelName); + + if (apsIndex.containsValue(modelName)) { + long modelId = jsonRef.get(idField).asLong(); + long apsModelId = apsIndex.getFirstKey(modelName); + if (apsModelId != modelId) { + this.logger.debug("The model '{}' exists in APS with ID {}; leaving unchanged", modelName, apsModelId); + jsonRef.put(idField, apsModelId); + return true; + } else { + this.logger.trace("The model '{}' ID does not change; leaving unchanged", modelName); + } + } else { + this.logger.debug("The model '{}' does not exists in APS; leaving unchanged", modelName); + } + + return false; + } + + + + private ArrayNode getChildShapes(ObjectNode jsonDescriptor) { + JsonNode jsonChildShapes = jsonDescriptor.get("childShapes"); + if (jsonChildShapes == null) + jsonChildShapes = jsonDescriptor.get("editorJson").get("childShapes"); + return (ArrayNode)jsonChildShapes; + } + +} diff --git a/src/main/java/com/inteligr8/maven/aps/modeling/CDATAFlexSection.java b/src/main/java/com/inteligr8/maven/aps/modeling/CDATAFlexSection.java new file mode 100644 index 0000000..195b7ba --- /dev/null +++ b/src/main/java/com/inteligr8/maven/aps/modeling/CDATAFlexSection.java @@ -0,0 +1,31 @@ +package com.inteligr8.maven.aps.modeling; + +import org.w3c.dom.CDATASection; +import org.w3c.dom.Node; + +public class CDATAFlexSection { + + private final Node node; + + public CDATAFlexSection(Node node) { + this.node = node; + } + + public String getValue() { + if (this.node instanceof CDATASection) { + return ((CDATASection)this.node).getData(); + } else { + String value = this.node.getTextContent(); + return value == null ? null : this.node.getTextContent().trim(); + } + } + + public void setValue(String value) { + if (this.node instanceof CDATASection) { + ((CDATASection)this.node).setData(value); + } else { + this.node.setTextContent(value); + } + } + +} diff --git a/src/main/java/com/inteligr8/maven/aps/modeling/DeployAppGoal.java b/src/main/java/com/inteligr8/maven/aps/modeling/DeployAppGoal.java new file mode 100644 index 0000000..5559303 --- /dev/null +++ b/src/main/java/com/inteligr8/maven/aps/modeling/DeployAppGoal.java @@ -0,0 +1,102 @@ +package com.inteligr8.maven.aps.modeling; + +import java.io.BufferedInputStream; +import java.io.File; +import java.io.FileInputStream; +import java.io.IOException; + +import org.apache.maven.plugin.MojoExecutionException; +import org.apache.maven.plugin.MojoFailureException; +import org.apache.maven.plugins.annotations.Mojo; +import org.apache.maven.plugins.annotations.Parameter; +import org.codehaus.plexus.component.annotations.Component; +import org.glassfish.jersey.media.multipart.FormDataContentDisposition; + +import com.inteligr8.alfresco.activiti.ApsPublicRestApiJerseyImpl; + +@Mojo( name = "deploy-app", threadSafe = true ) +@Component( role = org.apache.maven.plugin.Mojo.class ) +public class DeployAppGoal extends ApsAppAccessibleGoal { + + @Parameter( property = "apsAppName", required = true ) + protected String apsAppName; + + @Parameter( property = "sourceDirectory", required = true, defaultValue = "${project.build.directory}/app" ) + protected File sourceDirectory; + + @Parameter( property = "publish", required = true, defaultValue = "false" ) + protected boolean publish = false; + + @Parameter( property = "skip", required = true, defaultValue = "false" ) + protected boolean skip = false; + + protected final int bufferSize = 128 * 1024; + + @Override + public void execute() throws MojoExecutionException, MojoFailureException { + File sourceFile = this.validateSourceDirectory(); + + try { + Long appId = this.findAppByName(this.apsAppName); + this.uploadApp(appId, sourceFile); + } catch (IOException ie) { + throw new MojoExecutionException("The downloaded APS App could not be unpacked", ie); + } + } + + protected File validateSourceDirectory() { + if (!this.sourceDirectory.exists()) { + throw new IllegalStateException("The 'sourceDirectory' does not exist: " + this.sourceDirectory); + } else if (!this.sourceDirectory.isDirectory()) { + throw new IllegalStateException("The 'sourceDirectory' is not a directory: " + this.sourceDirectory); + } + + File sourceFile = new File(this.sourceDirectory, this.apsAppName + ".zip"); + + if (!sourceFile.exists()) { + throw new IllegalStateException("The App file does not exists in the 'sourceDirectory': " + sourceFile); + } else if (!sourceFile.isFile()) { + throw new IllegalStateException("The App file is not a file: " + sourceFile); + } + + return sourceFile; + } + + private void uploadApp(Long appId, File appZip) throws IOException, MojoExecutionException { + ApsPublicRestApiJerseyImpl api = this.getApsApi(); + + FormDataContentDisposition cdisposition = FormDataContentDisposition.name("file") + .size(appZip.length()) + .fileName(appZip.getName()) + .build(); + + FileInputStream fistream = new FileInputStream(appZip); + BufferedInputStream bistream = new BufferedInputStream(fistream, this.bufferSize); + try { + if (appId == null) { + if (this.publish) { + this.getLog().info("Uploading & publishing new APS App: " + this.apsAppName); +// AppDefinitionUpdateResultRepresentation appDefUpdate = api.getAppDefinitionsJerseyApi().publishApp(bistream, cdisposition); +// if (Boolean.TRUE.equals(appDefUpdate.getError())) +// throw new MojoExecutionException(appDefUpdate.getErrorDescription()); + } else { + this.getLog().info("Uploading new APS App: " + this.apsAppName); +// api.getAppDefinitionsJerseyApi().import_(bistream, cdisposition); + } + } else { + if (this.publish) { + this.getLog().info("Uploading, versioning, & publishing APS App: " + this.apsAppName); +// AppDefinitionUpdateResultRepresentation appDefUpdate = api.getAppDefinitionsJerseyApi().publishApp(appId, bistream, cdisposition); +// if (Boolean.TRUE.equals(appDefUpdate.getError())) +// throw new MojoExecutionException(appDefUpdate.getErrorDescription()); + } else { + this.getLog().info("Uploading & versioning APS App: " + this.apsAppName); +// api.getAppDefinitionsJerseyApi().import_(appId, bistream, cdisposition); + } + } + } finally { + bistream.close(); + } + } + +} diff --git a/src/main/java/com/inteligr8/maven/aps/modeling/DomNamespaceContext.java b/src/main/java/com/inteligr8/maven/aps/modeling/DomNamespaceContext.java new file mode 100644 index 0000000..09e0aef --- /dev/null +++ b/src/main/java/com/inteligr8/maven/aps/modeling/DomNamespaceContext.java @@ -0,0 +1,79 @@ +package com.inteligr8.maven.aps.modeling; + +import java.util.Collections; +import java.util.Iterator; + +import javax.xml.namespace.NamespaceContext; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.w3c.dom.Node; + +public class DomNamespaceContext implements NamespaceContext { + + private final Logger logger = LoggerFactory.getLogger(DomNamespaceContext.class); + private final Node node; + private final String defaultNamespacePrefix; + private final String defaultNamespace; + + public DomNamespaceContext(Node node) { + this(node, "tns"); + } + + public DomNamespaceContext(Node node, String defaultNamespacePrefix) { + this.node = node; + this.defaultNamespacePrefix = defaultNamespacePrefix; + + String defaultNamespace = null; + + while (node != null && defaultNamespace == null) { + defaultNamespace = node.lookupNamespaceURI(null); + node = node.getParentNode(); + } + + this.defaultNamespace = defaultNamespace; + } + + @Override + public String getNamespaceURI(String prefix) { + this.logger.trace("Performing namespace lookup by prefix: {}", prefix); + + if (prefix.equals(this.defaultNamespacePrefix)) + return this.defaultNamespace; + + Node node = this.node; + String namespace = null; + + while (node != null && namespace == null) { + namespace = node.lookupNamespaceURI(prefix); + node = node.getParentNode(); + } + + return namespace; + } + + @Override + public String getPrefix(String namespaceURI) { + this.logger.trace("Performing prefix lookup by namespace: {}", namespaceURI); + + Node node = this.node; + String prefix = null; + + while (node != null && prefix == null) { + prefix = node.lookupPrefix(namespaceURI); + node = node.getParentNode(); + } + + if (namespaceURI.equals(this.defaultNamespace)) + return this.defaultNamespacePrefix; + + return prefix; + } + + @Override + public Iterator getPrefixes(String namespaceURI) { + String prefix = this.getPrefix(namespaceURI); + return prefix == null ? Collections.emptyListIterator() : Collections.singletonList(prefix).iterator(); + } + +} diff --git a/src/main/java/com/inteligr8/maven/aps/modeling/DownloadAppGoal.java b/src/main/java/com/inteligr8/maven/aps/modeling/DownloadAppGoal.java new file mode 100644 index 0000000..ce95e70 --- /dev/null +++ b/src/main/java/com/inteligr8/maven/aps/modeling/DownloadAppGoal.java @@ -0,0 +1,61 @@ +package com.inteligr8.maven.aps.modeling; + +import java.io.File; +import java.io.IOException; + +import org.apache.commons.io.FileUtils; +import org.apache.maven.plugin.MojoExecutionException; +import org.apache.maven.plugin.MojoFailureException; +import org.apache.maven.plugins.annotations.Mojo; +import org.apache.maven.plugins.annotations.Parameter; +import org.codehaus.plexus.component.annotations.Component; + +import com.inteligr8.alfresco.activiti.ApsPublicRestApiJerseyImpl; + +@Mojo( name = "download-app", threadSafe = true ) +@Component( role = org.apache.maven.plugin.Mojo.class ) +public class DownloadAppGoal extends ApsAppAccessibleGoal { + + @Parameter( property = "apsAppName", required = true ) + protected String apsAppName; + + @Parameter( property = "targetDirectory", required = true, defaultValue = "${project.build.directory}/app" ) + protected File targetDirectory; + + @Parameter( property = "skip", required = true, defaultValue = "false" ) + protected boolean skip = false; + + @Override + public void execute() throws MojoExecutionException, MojoFailureException { + this.validateTargetDirectory(); + + long appId = this.findAppByName(this.apsAppName); + File appZip = this.downloadApp(appId); + + File toAppZip = new File(this.targetDirectory, this.apsAppName + ".zip"); + if (toAppZip.exists()) + toAppZip.delete(); + + try { + FileUtils.copyFile(appZip, toAppZip); + } catch (IOException ie) { + throw new MojoExecutionException("The downloaded APS App could not be saved", ie); + } + } + + protected void validateTargetDirectory() { + if (!this.targetDirectory.exists()) { + this.getLog().debug("Creating APS Apps directory: " + this.targetDirectory); + this.targetDirectory.mkdirs(); + } else if (!this.targetDirectory.isDirectory()) { + throw new IllegalStateException("The 'targetDirectory' refers to a file and not a directory"); + } + } + + private File downloadApp(long appId) { + ApsPublicRestApiJerseyImpl api = this.getApsApi(); + this.getLog().debug("Downloading APS App: " + appId); + return api.getAppDefinitionsApi().export(appId); + } + +} diff --git a/src/main/java/com/inteligr8/maven/aps/modeling/Index.java b/src/main/java/com/inteligr8/maven/aps/modeling/Index.java new file mode 100644 index 0000000..6eb7f79 --- /dev/null +++ b/src/main/java/com/inteligr8/maven/aps/modeling/Index.java @@ -0,0 +1,100 @@ +package com.inteligr8.maven.aps.modeling; + +import java.util.HashMap; +import java.util.HashSet; +import java.util.Map; +import java.util.Map.Entry; +import java.util.Set; + +import com.fasterxml.jackson.core.JsonProcessingException; +import com.fasterxml.jackson.databind.ObjectMapper; + +public class Index { + + private final Map forwardMap; + private final Map> reverseMap; + private final boolean allowDuplicateValues; + + public Index(int initialCapacity, boolean allowDuplicateValues) { + this.forwardMap = new HashMap(initialCapacity); + this.reverseMap = new HashMap>(initialCapacity); + this.allowDuplicateValues = allowDuplicateValues; + } + + public boolean containsKey(K key) { + return this.forwardMap.containsKey(key); + } + + public boolean containsValue(V value) { + return this.reverseMap.containsKey(value); + } + + public V getValue(K key) { + return this.forwardMap.get(key); + } + + public Set getKeys(V value) { + return this.reverseMap.get(value); + } + + public K getFirstKey(V value) { + Set keys = this.reverseMap.get(value); + return (keys == null || keys.isEmpty()) ? null : keys.iterator().next(); + } + + public int size() { + return this.forwardMap.size(); + } + + public Iterable> entries() { + return this.forwardMap.entrySet(); + } + + public synchronized boolean put(K key, V value) { + boolean overwrote = false; + + V oldValue = this.forwardMap.get(key); + if (oldValue != null) { + this.reverseMap.get(oldValue) + .remove(key); + overwrote = true; + } + + this.forwardMap.put(key, value); + + Set keys = this.reverseMap.get(value); + if (keys == null) { + this.reverseMap.put(value, keys = new HashSet<>(2)); + } else if (this.allowDuplicateValues && !keys.isEmpty() && !key.equals(keys.iterator().next())) { + throw new IllegalArgumentException("The map explicitly disallows duplicate values. The value '" + value + "' is already indexed by: " + keys); + } + keys.add(key); + + return overwrote; + } + + public synchronized boolean remove(K key) { + V oldValue = this.forwardMap.remove(key); + if (oldValue == null) + return false; + + this.reverseMap.get(oldValue) + .remove(key); + return true; + } + + public synchronized void clear() { + this.forwardMap.clear(); + this.reverseMap.clear(); + } + + @Override + public String toString() { + try { + return new ObjectMapper().writeValueAsString(this.forwardMap); + } catch (JsonProcessingException jpe) { + return "\"JSON processing error\""; + } + } + +} diff --git a/src/main/java/com/inteligr8/maven/aps/modeling/ModelUtil.java b/src/main/java/com/inteligr8/maven/aps/modeling/ModelUtil.java new file mode 100644 index 0000000..2e1f7b6 --- /dev/null +++ b/src/main/java/com/inteligr8/maven/aps/modeling/ModelUtil.java @@ -0,0 +1,283 @@ +package com.inteligr8.maven.aps.modeling; + +import java.io.BufferedInputStream; +import java.io.BufferedOutputStream; +import java.io.File; +import java.io.FileInputStream; +import java.io.FileOutputStream; +import java.io.IOException; +import java.io.InputStream; +import java.io.OutputStream; + +import javax.xml.namespace.QName; +import javax.xml.parsers.DocumentBuilder; +import javax.xml.parsers.DocumentBuilderFactory; +import javax.xml.parsers.ParserConfigurationException; +import javax.xml.transform.Transformer; +import javax.xml.transform.TransformerConfigurationException; +import javax.xml.transform.TransformerException; +import javax.xml.transform.TransformerFactory; +import javax.xml.transform.dom.DOMSource; +import javax.xml.transform.stream.StreamResult; +import javax.xml.transform.stream.StreamSource; +import javax.xml.xpath.XPath; +import javax.xml.xpath.XPathConstants; +import javax.xml.xpath.XPathExpressionException; +import javax.xml.xpath.XPathFactory; + +import org.w3c.dom.CDATASection; +import org.w3c.dom.Document; +import org.w3c.dom.Element; +import org.w3c.dom.Node; +import org.w3c.dom.NodeList; +import org.xml.sax.SAXException; + +import com.fasterxml.jackson.databind.JsonNode; +import com.fasterxml.jackson.databind.MapperFeature; +import com.fasterxml.jackson.databind.ObjectMapper; +import com.fasterxml.jackson.databind.SerializationFeature; + +public class ModelUtil { + + public final static QName CDATA = QName.valueOf("inteligr8:xml:cdata"); + public final static QName CDATA_FLEX = QName.valueOf("inteligr8:xml:cdata_or_element"); + private final static ModelUtil INSTANCE = new ModelUtil(); + + public static ModelUtil getInstance() { + return INSTANCE; + } + + + + private final ObjectMapper om = new ObjectMapper(); + private final DocumentBuilderFactory dbfactory = DocumentBuilderFactory.newInstance(); + private final DocumentBuilder docBuilder; + private final XPathFactory xpathfactory = XPathFactory.newInstance(); + private final TransformerFactory tfactory = TransformerFactory.newInstance(); + private final Transformer transformer; + private final int bufferSize = 128 * 1024; + + private ModelUtil() { + this.dbfactory.setNamespaceAware(true); + + try { + this.docBuilder = this.dbfactory.newDocumentBuilder(); + + InputStream istream = this.getClass().getResourceAsStream("/bpmn.xslt"); + BufferedInputStream bistream = new BufferedInputStream(istream, this.bufferSize); + try { + StreamSource ssource = new StreamSource(bistream); + this.transformer = this.tfactory.newTransformer(ssource); + } finally { + bistream.close(); + } + } catch (ParserConfigurationException | TransformerConfigurationException | IOException e) { + throw new ExceptionInInitializerError(e); + } + + // makes Git handling a whole lot better + this.om.enable(SerializationFeature.INDENT_OUTPUT); + // makes Git handling better between environment nuances + this.om.enable(MapperFeature.SORT_PROPERTIES_ALPHABETICALLY); + this.om.enable(SerializationFeature.ORDER_MAP_ENTRIES_BY_KEYS); + } + + + + public void json(File inplaceFile) throws IOException { + JsonNode json; + + FileInputStream fistream = new FileInputStream(inplaceFile); + BufferedInputStream bistream = new BufferedInputStream(fistream, this.bufferSize); + try { + json = this.readJson(bistream); + } finally { + bistream.close(); + } + + FileOutputStream fostream = new FileOutputStream(inplaceFile); + BufferedOutputStream bostream = new BufferedOutputStream(fostream, this.bufferSize); + try { + this.writeJson(json, bostream); + } finally { + bostream.close(); + } + } + + public void json(File sourceFile, File targetFile) throws IOException { + FileInputStream fistream = new FileInputStream(sourceFile); + BufferedInputStream bistream = new BufferedInputStream(fistream, this.bufferSize); + try { + FileOutputStream fostream = new FileOutputStream(targetFile); + BufferedOutputStream bostream = new BufferedOutputStream(fostream, this.bufferSize); + try { + this.json(bistream, bostream); + } finally { + bostream.close(); + } + } finally { + bistream.close(); + } + } + + public void json(InputStream istream, OutputStream ostream) throws IOException { + // FIXME stream it for lower memory/IO usage + JsonNode json = this.readJson(istream); + this.writeJson(json, ostream); + } + + public JsonNode readJson(File file) throws IOException { + return this.readJson(file, JsonNode.class); + } + + public T readJson(File file, Class type) throws IOException { + FileInputStream fistream = new FileInputStream(file); + BufferedInputStream bistream = new BufferedInputStream(fistream, this.bufferSize); + try { + return this.readJson(bistream, type); + } finally { + bistream.close(); + } + } + + public JsonNode readJson(InputStream istream) throws IOException { + return this.om.readTree(istream); + } + + public T readJson(InputStream istream, Class type) throws IOException { + return this.om.readValue(istream, type); + } + + public void writeJson(JsonNode json, File file) throws IOException { + FileOutputStream fostream = new FileOutputStream(file); + BufferedOutputStream bostream = new BufferedOutputStream(fostream, this.bufferSize); + try { + this.writeJson(json, bostream); + } finally { + bostream.close(); + } + } + + public void writeJson(JsonNode json, OutputStream ostream) throws IOException { + this.om.writeValue(ostream, json); + } + + + + public void xml(File inplaceFile) throws IOException, SAXException, TransformerException { + Document xml; + + FileInputStream fistream = new FileInputStream(inplaceFile); + BufferedInputStream bistream = new BufferedInputStream(fistream, this.bufferSize); + try { + xml = this.readXml(bistream); + } finally { + bistream.close(); + } + + FileOutputStream fostream = new FileOutputStream(inplaceFile); + BufferedOutputStream bostream = new BufferedOutputStream(fostream, this.bufferSize); + try { + this.writeXml(xml, bostream); + } finally { + bostream.close(); + } + } + + public void xml(File sourceFile, File targetFile) throws IOException, SAXException, TransformerException { + FileInputStream fistream = new FileInputStream(sourceFile); + BufferedInputStream bistream = new BufferedInputStream(fistream, this.bufferSize); + try { + FileOutputStream fostream = new FileOutputStream(targetFile); + BufferedOutputStream bostream = new BufferedOutputStream(fostream, this.bufferSize); + try { + this.xml(bistream, bostream); + } finally { + bostream.close(); + } + } finally { + bistream.close(); + } + } + + public void xml(InputStream istream, OutputStream ostream) throws IOException, SAXException, TransformerException { + // FIXME stream it for lower memory/IO usage + Document doc = this.readXml(istream); + this.writeXml(doc, ostream); + } + + public Document readXml(File file) throws IOException, SAXException { + FileInputStream fistream = new FileInputStream(file); + BufferedInputStream bistream = new BufferedInputStream(fistream, this.bufferSize); + try { + return this.readXml(bistream); + } finally { + bistream.close(); + } + } + + public Document readXml(InputStream istream) throws IOException, SAXException { + return this.docBuilder.parse(istream); + } + + public void writeXml(Node xml, File file) throws IOException, TransformerException { + FileOutputStream fostream = new FileOutputStream(file); + BufferedOutputStream bostream = new BufferedOutputStream(fostream, this.bufferSize); + try { + this.writeXml(xml, bostream); + } finally { + bostream.close(); + } + } + + public void writeXml(Node xml, OutputStream ostream) throws IOException, TransformerException { + DOMSource source = new DOMSource(xml); + StreamResult result = new StreamResult(ostream); + this.transformer.transform(source, result); + } + + public NodeList xpath(Node node, String xpathExpr) throws XPathExpressionException { + return (NodeList)this.xpath(node, xpathExpr, XPathConstants.NODESET); + } + + public Object xpath(Node node, String xpathExpr, QName returnType) throws XPathExpressionException { + XPath xpath = this.xpathfactory.newXPath(); + xpath.setNamespaceContext(new DomNamespaceContext(node)); + + boolean isFlex = returnType.equals(ModelUtil.CDATA_FLEX); + + if (returnType.equals(ModelUtil.CDATA) || isFlex) { + NodeList nodes = (NodeList)xpath.evaluate(xpathExpr, node, XPathConstants.NODESET); + Node anode = this.getFirstCDataSectionOrLastElement(nodes); + if (anode instanceof CDATASection) { + // nothing special + } else if (anode instanceof Element) { + Node anode2 = this.getFirstCDataSectionOrLastElement(anode.getChildNodes()); + if (anode2 != null) + return anode = anode2; + } else { + return null; + } + + return isFlex ? new CDATAFlexSection(anode) : anode; + } else { + return xpath.evaluate(xpathExpr, node, returnType); + } + } + + private Node getFirstCDataSectionOrLastElement(NodeList nodes) { + Element element = null; + + for (int n = 0; n < nodes.getLength(); n++) { + Node anode = nodes.item(n); + if (anode.getNodeType() == Node.CDATA_SECTION_NODE) { + return (CDATASection)anode; + } else if (anode.getNodeType() == Node.ELEMENT_NODE) { + element = (Element)anode; + } + } + + return element; + } + +} diff --git a/src/main/java/com/inteligr8/maven/aps/modeling/PackAppGoal.java b/src/main/java/com/inteligr8/maven/aps/modeling/PackAppGoal.java new file mode 100644 index 0000000..fb24f77 --- /dev/null +++ b/src/main/java/com/inteligr8/maven/aps/modeling/PackAppGoal.java @@ -0,0 +1,143 @@ +package com.inteligr8.maven.aps.modeling; + +import java.io.BufferedInputStream; +import java.io.BufferedOutputStream; +import java.io.File; +import java.io.FileInputStream; +import java.io.FileOutputStream; +import java.io.IOException; +import java.nio.file.Path; +import java.nio.file.Paths; +import java.util.zip.ZipEntry; +import java.util.zip.ZipOutputStream; + +import org.apache.commons.io.IOUtils; +import org.apache.maven.plugin.AbstractMojo; +import org.apache.maven.plugin.MojoExecutionException; +import org.apache.maven.plugin.MojoFailureException; +import org.apache.maven.plugins.annotations.Mojo; +import org.apache.maven.plugins.annotations.Parameter; +import org.codehaus.plexus.component.annotations.Component; + +@Mojo( name = "pack-app", threadSafe = true ) +@Component( role = org.apache.maven.plugin.Mojo.class ) +public class PackAppGoal extends AbstractMojo { + + @Parameter( property = "apsAppName", required = true ) + protected String apsAppName; + + @Parameter( property = "sourceDirectory", required = true, defaultValue = "${project.build.directory}/app" ) + protected File sourceDirectory; + + @Parameter( property = "targetDirectory", required = true, defaultValue = "${project.build.directory}/app" ) + protected File targetDirectory; + + @Parameter( property = "skip", required = true, defaultValue = "false" ) + protected boolean skip = false; + + protected final int bufferSize = 128 * 1024; + + @Override + public void execute() throws MojoExecutionException, MojoFailureException { + this.validateSourceDirectory(); + File appDirectory = this.validateAppDirectory(); + + File targetFile = this.validateTargetDirectory(); + + try { + this.pack(appDirectory, targetFile); + } catch (IOException ie) { + throw new MojoExecutionException("The APS App could not be packed", ie); + } + } + + protected void validateSourceDirectory() { + if (!this.sourceDirectory.exists()) { + throw new IllegalStateException("The 'sourceDirectory' does not exist: " + this.sourceDirectory); + } else if (!this.sourceDirectory.isDirectory()) { + throw new IllegalStateException("The 'sourceDirectory' is not a directory: " + this.sourceDirectory); + } + } + + protected File validateAppDirectory() { + File appDirectory = new File(this.sourceDirectory, this.apsAppName); + if (!appDirectory.exists()) { + throw new IllegalStateException("The 'apsAppName' does not exist in the source directory: " + this.sourceDirectory); + } else if (!appDirectory.isDirectory()) { + throw new IllegalStateException("The 'apsAppName' refers to a file and not a directory: " + appDirectory); + } + + return appDirectory; + } + + protected File validateTargetDirectory() { + if (!this.targetDirectory.exists()) { + this.getLog().debug("The 'targetDirectory' does not exist; creating: " + this.targetDirectory); + this.targetDirectory.mkdirs(); + } else if (!this.targetDirectory.isDirectory()) { + throw new IllegalStateException("The 'targetDirectory' is not a directory: " + this.targetDirectory); + } + + File targetFile = new File(this.targetDirectory, this.apsAppName + ".zip"); + + if (targetFile.isDirectory()) { + throw new IllegalStateException("The App file is not a file: " + targetFile); + } else if (targetFile.exists()) { + this.getLog().debug("The App file in the 'targetDirectory' exists; deleting: " + targetFile); + targetFile.delete(); + } + + return targetFile; + } + + private void pack(File appDirectory, File appZip) throws IOException { + this.getLog().debug("Packing APS App to ZIP: " + appZip); + + FileOutputStream fostream = new FileOutputStream(appZip); + BufferedOutputStream bostream = new BufferedOutputStream(fostream, this.bufferSize); + try { + ZipOutputStream zostream = new ZipOutputStream(bostream); + try { + this.zipDirectory(appDirectory, null, zostream); + } finally { + zostream.close(); + } + } finally { + bostream.close(); + } + } + + private void zipDirectory(File directory, Path path, ZipOutputStream zostream) throws IOException { + for (File file : directory.listFiles()) { + Path newPath = path == null ? Paths.get(file.getName()) : path.resolve(file.getName()); + + if (file.isDirectory()) { + this.zipDirectory(file, newPath, zostream); + } else { + this.zipFile(file, newPath, zostream); + } + } + } + + private void zipFile(File file, Path path, ZipOutputStream zostream) throws IOException { + if (file.isDirectory() || !file.exists()) + throw new IllegalStateException(); + + this.getLog().debug("Packing APS file: " + path); + + ZipEntry zentry = new ZipEntry(path.toString()); + zostream.putNextEntry(zentry); + try { + FileInputStream fistream = new FileInputStream(file); + BufferedInputStream bistream = new BufferedInputStream(fistream); + try { + IOUtils.copy(bistream, zostream); + } finally { + bistream.close(); + } + } finally { + zostream.closeEntry(); + } + } + +} diff --git a/src/main/java/com/inteligr8/maven/aps/modeling/TranslateAppGoal.java b/src/main/java/com/inteligr8/maven/aps/modeling/TranslateAppGoal.java new file mode 100644 index 0000000..faa79ba --- /dev/null +++ b/src/main/java/com/inteligr8/maven/aps/modeling/TranslateAppGoal.java @@ -0,0 +1,99 @@ +package com.inteligr8.maven.aps.modeling; + +import java.io.File; +import java.io.IOException; + +import org.apache.commons.io.FileUtils; +import org.apache.maven.execution.MavenSession; +import org.apache.maven.plugin.MojoExecutionException; +import org.apache.maven.plugin.MojoFailureException; +import org.apache.maven.plugins.annotations.Mojo; +import org.apache.maven.plugins.annotations.Parameter; +import org.apache.maven.project.MavenProject; +import org.codehaus.plexus.component.annotations.Component; + +@Mojo( name = "translate-app", threadSafe = true ) +@Component( role = org.apache.maven.plugin.Mojo.class ) +public class TranslateAppGoal extends ApsAppAccessibleGoal { + + @Parameter( defaultValue = "${project}", readonly = true ) + protected MavenProject project; + + @Parameter( defaultValue = "${session}", readonly = true ) + protected MavenSession session; + + @Parameter( property = "apsAppName", required = true ) + protected String apsAppName; + + @Parameter( property = "sourceDirectory", required = true, defaultValue = "${project.build.directory}/app" ) + protected File sourceDirectory; + + @Parameter( property = "targetDirectory", required = false, defaultValue = "${project.build.directory}/app" ) + protected File targetDirectory; + + @Parameter( property = "overwrite", required = true, defaultValue = "true" ) + protected boolean overwrite = true; + + @Parameter( property = "charset", required = true, defaultValue = "utf-8" ) + protected String charsetName = "utf-8"; + + @Parameter( property = "skip", required = true, defaultValue = "false" ) + protected boolean skip = false; + + @Override + public void execute() throws MojoExecutionException, MojoFailureException { + File apsAppDirectory = this.validateApsAppDirectory(); + File newApsAppDirectory = this.validateTargetDirectory(); + + try { + if (!apsAppDirectory.equals(newApsAppDirectory)) { + FileUtils.copyDirectory(apsAppDirectory, newApsAppDirectory); + apsAppDirectory = newApsAppDirectory; + } + + ApsAppTranslator translator = new ApsAppTranslator(this.apsAppName, apsAppDirectory, this.getApsApi(), true); + translator.execute(); + } catch (IOException ie) { + throw new MojoExecutionException("An I/O issue occurred", ie); + } catch (IllegalArgumentException iae) { + throw new MojoExecutionException("The input is not supported", iae); + } catch (IllegalStateException ise) { + throw new MojoExecutionException("The state of system is not supported", ise); + } + } + + protected File validateApsAppDirectory() throws MojoExecutionException { + if (!this.sourceDirectory.exists()) + throw new MojoExecutionException("The 'sourceDirectory' does not exist: " + this.sourceDirectory); + if (!this.sourceDirectory.isDirectory()) + throw new MojoExecutionException("The 'sourceDirectory' is not a directory: " + this.sourceDirectory); + + File appDirectory = new File(this.sourceDirectory, this.apsAppName); + + if (!appDirectory.exists()) + throw new MojoExecutionException("The 'apsAppName' does not exist in the 'apsAppsDirectory': " + appDirectory); + if (!appDirectory.isDirectory()) + throw new MojoExecutionException("The 'apsAppName' is not a directory in the 'apsAppsDirectory': " + appDirectory); + + return appDirectory; + } + + protected File validateTargetDirectory() throws MojoExecutionException { + if (!this.targetDirectory.exists()) { + this.targetDirectory.mkdirs(); + } else if (!this.targetDirectory.isDirectory()) { + throw new MojoExecutionException("The 'targetDirectory' is not a directory: " + this.targetDirectory); + } + + File appDirectory = new File(this.targetDirectory, this.apsAppName); + + if (!appDirectory.exists()) { + appDirectory.mkdirs(); + } else if (!appDirectory.isDirectory()) { + throw new MojoExecutionException("The 'apsAppName' is not a directory in the 'targetDirectory': " + appDirectory); + } + + return appDirectory; + } + +} diff --git a/src/main/java/com/inteligr8/maven/aps/modeling/UnpackAppGoal.java b/src/main/java/com/inteligr8/maven/aps/modeling/UnpackAppGoal.java new file mode 100644 index 0000000..ed755e0 --- /dev/null +++ b/src/main/java/com/inteligr8/maven/aps/modeling/UnpackAppGoal.java @@ -0,0 +1,186 @@ +package com.inteligr8.maven.aps.modeling; + +import java.io.BufferedInputStream; +import java.io.BufferedOutputStream; +import java.io.File; +import java.io.FileInputStream; +import java.io.FileOutputStream; +import java.io.IOException; +import java.io.InputStream; +import java.nio.file.Files; +import java.nio.file.Path; +import java.nio.file.Paths; +import java.util.zip.ZipEntry; +import java.util.zip.ZipInputStream; + +import javax.xml.transform.TransformerException; + +import org.apache.commons.io.IOUtils; +import org.apache.maven.plugin.AbstractMojo; +import org.apache.maven.plugin.MojoExecutionException; +import org.apache.maven.plugin.MojoFailureException; +import org.apache.maven.plugins.annotations.Mojo; +import org.apache.maven.plugins.annotations.Parameter; +import org.codehaus.plexus.component.annotations.Component; +import org.xml.sax.SAXException; + +@Mojo( name = "unpack-app", threadSafe = true ) +@Component( role = org.apache.maven.plugin.Mojo.class ) +public class UnpackAppGoal extends AbstractMojo { + + @Parameter( property = "apsAppName", required = true ) + protected String apsAppName; + + @Parameter( property = "sourceDirectory", required = true, defaultValue = "${project.build.directory}/app" ) + protected File sourceDirectory; + + @Parameter( property = "targetDirectory", required = true, defaultValue = "${project.build.directory}/app" ) + protected File targetDirectory; + + @Parameter( property = "charset", required = true, defaultValue = "utf-8" ) + protected String charsetName = "utf-8"; + + @Parameter( property = "skip", required = true, defaultValue = "false" ) + protected boolean skip = false; + + private final int bufferSize = 128 * 1024; + + @Override + public void execute() throws MojoExecutionException, MojoFailureException { + File sourceFile = this.validateSourceDirectory(); + + this.validateTargetDirectory(); + File appDirectory = this.validateAppDirectory(); + this.getLog().debug("Clearing directory: " + appDirectory); + this.clearDirectory(appDirectory); + + try { + this.unpack(sourceFile, appDirectory); + } catch (IOException ie) { + throw new MojoExecutionException("The downloaded APS App could not be unpacked", ie); + } + + this.normalizeFiles(appDirectory); + } + + protected File validateSourceDirectory() { + if (!this.sourceDirectory.exists()) { + throw new IllegalStateException("The 'sourceDirectory' does not exist: " + this.sourceDirectory); + } else if (!this.sourceDirectory.isDirectory()) { + throw new IllegalStateException("The 'sourceDirectory' is not a directory: " + this.sourceDirectory); + } + + File sourceFile = new File(this.sourceDirectory, this.apsAppName + ".zip"); + + if (!sourceFile.exists()) { + throw new IllegalStateException("The App file does not exists in the 'sourceDirectory': " + sourceFile); + } else if (!sourceFile.isFile()) { + throw new IllegalStateException("The App file is not a file: " + sourceFile); + } + + return sourceFile; + } + + protected void validateTargetDirectory() { + if (!this.targetDirectory.exists()) { + this.getLog().debug("Creating APS Apps directory: " + this.targetDirectory); + this.targetDirectory.mkdirs(); + } else if (!this.targetDirectory.isDirectory()) { + throw new IllegalStateException("The 'apsAppsDirectory' refers to a file and not a directory: " + this.targetDirectory); + } + } + + protected File validateAppDirectory() { + File appDirectory = new File(this.targetDirectory, this.apsAppName); + if (!appDirectory.exists()) { + this.getLog().debug("Creating APS App directory: " + appDirectory); + appDirectory.mkdirs(); + } else if (!appDirectory.isDirectory()) { + throw new IllegalStateException("The 'apsAppsDirectory' has a file where nothing or a directory is expected: " + appDirectory); + } + + return appDirectory; + } + + private void unpack(File appZip, File targetDirectory) throws IOException { + FileInputStream fistream = new FileInputStream(appZip); + BufferedInputStream bistream = new BufferedInputStream(fistream, this.bufferSize); + try { + ZipInputStream zistream = new ZipInputStream(bistream); + try { + for (ZipEntry zentry = zistream.getNextEntry(); zentry != null; zentry = zistream.getNextEntry()) { + try { + String path = zentry.getName(); + if (!zentry.isDirectory()) { + this.getLog().debug("Unzipping path: " + zentry.getName()); + this.unzipToPath(zistream, Paths.get(path), targetDirectory); + } + } finally { + zistream.closeEntry(); + } + } + } finally { + zistream.close(); + } + } finally { + bistream.close(); + } + } + + private void unzipToPath(InputStream istream, Path relativePath, File targetDirectory) throws IOException { + Path path = targetDirectory.toPath().resolve(relativePath); + Path folderPath = path.getParent(); + Files.createDirectories(folderPath); + + FileOutputStream fostream = new FileOutputStream(path.toFile()); + BufferedOutputStream bostream = new BufferedOutputStream(fostream); + try { + IOUtils.copy(istream, bostream); + } finally { + bostream.close(); + } + } + + private void clearDirectory(File directory) { + for (File file : directory.listFiles()) { + if (file.isDirectory()) + this.clearDirectory(file); + file.delete(); + } + } + + private void normalizeFiles(File directory) throws MojoFailureException { + for (File file : directory.listFiles()) { + if (file.isDirectory()) { + this.normalizeFiles(file); + } else { + String ext = this.getFileExtension(file); + + try { + switch (ext) { + case "json": + ModelUtil.getInstance().json(file); + break; + case "xml": + case "bpmn": + ModelUtil.getInstance().xml(file); + break; + default: + file.delete(); + } + } catch (TransformerException | SAXException | IOException e) { + throw new MojoFailureException("The following file faild to be reformatted: " + file, e); + } + } + } + } + + private String getFileExtension(File file) { + int lastdot = file.getName().lastIndexOf('.'); + if (lastdot < 0) + return null; + + return file.getName().substring(lastdot+1).toLowerCase(); + } + +} diff --git a/src/main/resources/bpmn.xslt b/src/main/resources/bpmn.xslt new file mode 100644 index 0000000..9659319 --- /dev/null +++ b/src/main/resources/bpmn.xslt @@ -0,0 +1,9 @@ + + + + + + + + +