diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml new file mode 100644 index 0000000..d98bdca --- /dev/null +++ b/.gitlab-ci.yml @@ -0,0 +1,42 @@ +# 1) Build every commit on every branch and add the COMMIT SHORT SHA as suffix +maven-build: + stage: build + script: + - export MAVEN_OPTS='-Xmx128m' + - mvn clean package + artifacts: + paths: + - target/*.jar + name: ${CI_PROJECT_NAME}-${CI_COMMIT_SHORT_SHA} + +# 2) Copies SNAPSHOT builds on 'master' and 'dm4' branch into download.dmx.systems/ci/ directory +copy-to-ci: + stage: deploy + script: + - CIDIR='/var/www/download.dmx.systems/ci' + - DESTDIR="${CIDIR}/${CI_PROJECT_NAME}" + - JARFILE="$( basename $( ls target/*.jar | tail -n1) )" + - NUNC="$( date +%F )" + - DESTJARFILE="$( basename ${JARFILE} .jar )_${NUNC}_${CI_PIPELINE_ID}.jar" + - if [ ! -d ${DESTDIR} ]; then mkdir ${DESTDIR}; fi + - cp target/${JARFILE} ${DESTDIR}/${DESTJARFILE} + - ln -sf ${DESTDIR}/${DESTJARFILE} ${DESTDIR}/${CI_PROJECT_NAME}-latest.jar + dependencies: + - maven-build + only: + - master + - dm4 + +# 3) Copies tagged RELEASE builds into download.dmx.systems/plugins/ directory +copy-to-release: + stage: deploy + script: + - RELEASEDIR='/var/www/download.dmx.systems/plugins' + - DESTDIR="${RELEASEDIR}/${CI_PROJECT_NAME}" + - JARFILE="$( basename $( ls target/*.jar | tail -n1) )" + - if [ ! -d ${DESTDIR} ]; then mkdir ${DESTDIR}; fi + - cp target/${JARFILE} ${DESTDIR}/ + dependencies: + - maven-build + only: + - tags diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..ca9b055 --- /dev/null +++ b/LICENSE @@ -0,0 +1,619 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 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 Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are 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. + + 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. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + 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 Affero 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. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + 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 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 work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero 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 Affero 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 Affero 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 Affero 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 diff --git a/README.md b/README.md index e224b68..6b9c944 100644 --- a/README.md +++ b/README.md @@ -1,39 +1,51 @@ -DeepaMehta 4 Geospatial +DMX Geospatial ======================= -A DeepaMehta 4 plugin that provides geospatial "Within Distance" queries. +A DMX plugin that provides geospatial "Within Distance" queries. -DeepaMehta 4 is a platform for collaboration and knowledge management. - +DMX is a platform for collaboration and knowledge management. + API --- -Java API: +Java API (Within Distance Example): List getTopicsWithinDistance(GeoCoordinate geoCoord, double maxDistanceInKm) Returned is a list of Geo Coordinate topics (as defined in the Geomaps plugin). -REST API: +Java API (Query Shapefile Properties by Geo Coordinates): + + Object `getGeometryFeatureValueByCoordinate(String coordinates, String key)` + +REST API (Within Distance Example): GET /geospatial/,/distance/ The response is an array of Geo Coordinate topics. -If you want include the Geo Coordinate topic's Longitude and Latitude child topics in the result as well append `?include_childs=true` to the request. +If you want include the Geo Coordinate topic's Longitude and Latitude child topics in the result as well append `?include_children=true` to the request. + +REST API Get Feature Name: + + `/feature/{latlng}` + +The response is the `Name` property of the geometry's `Feature` in which a given coordinate pair (WGS-84) is located (using neo4j-spatial shapefile). + + -Example -------- +Example (Within Distance) +------------------------- Java API: - import de.deepamehta.plugins.geospatial.GeospatialService; - import de.deepamehta.plugins.geomaps.GeomapsService; - import de.deepamehta.plugins.geomaps.model.GeoCoordinate; + import systems.dmx.geospatial.GeospatialService; + import systems.dmx.geomaps.GeomapsService; + import systems.dmx.geomaps.model.GeoCoordinate; GeospatialService geospatialService; GeomapsService geomapsService; @@ -49,6 +61,18 @@ Java API: Version History --------------- +**0.5** -- Upcoming + +* Compatible with DMX 5.0 API +* No support for database upgrades for geometry layers in deepamehta-db's (need to re-index) +* Released under the AGPL-3.0 License + +**0.4** -- Mar 30, 2018 + +* Inroduced shapefile-layer capabilities +* Extended service to query shapefile for key, values by geo coordinate +* Compatible with DeepaMehta 4.9.x + **0.3** -- Aug 05, 2016 * Compatible with DeepaMehta 4.8 @@ -71,6 +95,16 @@ Note: This release is not compatible with one of the previous releases. If you h * Based on Neo4j Spatial * Compatible with DeepaMehta 4.4-SNAPSHOT ------------- -Jörg Richter & Malte Reißig
-Aug 05, 2016 +Licensing +--------- + +DMX Geospatial software is available freely under the GNU Affero General Public License, version 3. + +All third party components incorporated into the DMX Geospatial Software are licensed under the original license provided by the owner of the applicable component. + + +Copyright +--------- +Copyright (C) 2016 Jörg Richter
+Copyright (C) 2017-2018 Malte Reißig
+Copyright (C) 2019 DMX Systems
diff --git a/pom.xml b/pom.xml index b3d362c..083d1ec 100644 --- a/pom.xml +++ b/pom.xml @@ -4,29 +4,30 @@ 4.0.0 - DeepaMehta 4 Geospatial - de.deepamehta - dm48-geospatial - 0.3 + DMX Geospatial + systems.dmx + dmx-geospatial + 0.5.0-SNAPSHOT + bundle - de.deepamehta - deepamehta-plugin - 4.8 + systems.dmx + dmx-plugin + 5.0.1-SNAPSHOT - de.deepamehta - deepamehta-geomaps - 4.8 + systems.dmx + dmx-geomaps + 0.2.1-SNAPSHOT provided - de.deepamehta - deepamehta-accesscontrol - 4.8 + systems.dmx + dmx-accesscontrol + 5.0.1-SNAPSHOT provided @@ -54,7 +55,11 @@ org.geotools gt-api 8.0 - runtime + + + org.geotools + gt-shapefile + 8.0 org.geotools @@ -106,6 +111,51 @@ 1.0 provided + + + org.jdom + jdom + 1.1 + runtime + + + + org.geotools + gt-data + 8.0 + runtime + + + org.geotools + gt-main + 8.0 + runtime + + + + org.geotools + gt-cql + 8.0 + runtime + + + org.geotools + gt-geojson + 8.0 + runtime + + + org.geotools.xsd + gt-xsd-kml + 8.0 + runtime + + + org.geotools + gt-wms + 8.0 + runtime + @@ -130,26 +180,28 @@ maven-bundle-plugin - de.deepamehta.geospatial - de.deepamehta.plugins.geospatial.GeospatialPlugin + systems.dmx.geospatial.GeospatialPlugin org.neo4j.graphdb, org.neo4j.graphdb.traversal, org.neo4j.kernel, !org.neo4j.*, - !com.tinkerpop.blueprints.*, + !com.tinkerpop.blueprints.*, !oracle.xml.*, !org.geotools.*, !org.json.simple.*, - !au.com.objectix.jgridshift, + !au.com.objectix.jgridshift, !junit.framework.*, !groovy.lang, !org.codehaus.groovy.*, !jline, !org.apache.commons.collections, !org.apache.commons.pool.*, !org.apache.commons.logging.*, + !org.apache.commons.httpclient.*, !org.apache.commons.lang, !org.apache.log4j, + !org.apache.xerces.*, + !org.jaxen.*, !org.picocontainer.*, !javax.vecmath, !javax.media.jai.*, !javax.transaction.*, * neo4j-spatial, neo4j-graph-collections, - gt-api, gt-opengis, gt-metadata, gt-referencing, - jts, jscience, - gremlin-java, gremlin-groovy, pipes + gt-api, gt-opengis, gt-metadata, gt-referencing, jdom, + jts, jscience, gt-shapefile, gt-data, gt-main, gt-cql, + gt-xsd-kml, gt-wms, gt-geojson, gremlin-java, gremlin-groovy, pipes diff --git a/src/main/java/de/deepamehta/plugins/geospatial/GeospatialPlugin.java b/src/main/java/de/deepamehta/plugins/geospatial/GeospatialPlugin.java deleted file mode 100644 index fde8795..0000000 --- a/src/main/java/de/deepamehta/plugins/geospatial/GeospatialPlugin.java +++ /dev/null @@ -1,265 +0,0 @@ -package de.deepamehta.plugins.geospatial; - -import de.deepamehta.core.Topic; -import de.deepamehta.core.model.TopicModel; -import de.deepamehta.core.osgi.PluginActivator; -import de.deepamehta.core.service.Inject; -import de.deepamehta.core.service.event.PostCreateTopicListener; -import de.deepamehta.core.service.event.PostUpdateTopicListener; -import de.deepamehta.core.service.event.PreDeleteTopicListener; -import de.deepamehta.core.storage.spi.DeepaMehtaTransaction; - -import org.neo4j.graphdb.GraphDatabaseService; -import org.neo4j.gis.spatial.EditableLayerImpl; -import org.neo4j.gis.spatial.SpatialDatabaseService; -import org.neo4j.gis.spatial.pipes.GeoPipeFlow; -import org.neo4j.gis.spatial.pipes.GeoPipeline; - -import com.vividsolutions.jts.geom.Coordinate; -import com.vividsolutions.jts.geom.Point; -import de.deepamehta.accesscontrol.AccessControlService; -import de.deepamehta.core.service.accesscontrol.Operation; -import de.deepamehta.geomaps.GeomapsService; -import de.deepamehta.geomaps.model.GeoCoordinate; - -import javax.ws.rs.GET; -import javax.ws.rs.Path; -import javax.ws.rs.PathParam; -import javax.ws.rs.Produces; -import javax.ws.rs.Consumes; - -import java.util.ArrayList; -import java.util.List; -import java.util.logging.Logger; -import org.neo4j.gis.spatial.EditableLayer; -import org.neo4j.gis.spatial.SpatialDatabaseRecord; -import org.neo4j.graphdb.NotFoundException; - - - -@Path("/geospatial") -@Consumes("application/json") -@Produces("application/json") -public class GeospatialPlugin extends PluginActivator implements GeospatialService, PointFactory, - PostCreateTopicListener, - PostUpdateTopicListener, - PreDeleteTopicListener { - - // ------------------------------------------------------------------------------------------------------- Constants - - public static final String DEFAULT_LAYER_NAME = "dm4.geospatial.default_layer"; - public static final String GEO_NODE_PROPERTY_ID = "dm4.geospatial.geometry_node_id"; - - // ---------------------------------------------------------------------------------------------- Instance Variables - - private EditableLayer layer; - - @Inject private AccessControlService acService; - // @Inject private GeomapsService geomapsService; - - private Logger logger = Logger.getLogger(getClass().getName()); - - // -------------------------------------------------------------------------------------------------- Public Methods - - - - // **************************************** - // *** GeospatialService Implementation *** - // **************************************** - - - - @GET - @Path("/{geo_coord}/distance/{distance}") - @Override - public List getTopicsWithinDistance(@PathParam("geo_coord") GeoCoordinate geoCoord, - @PathParam("distance") double maxDistanceInKm) { - try { - String username = acService.getUsername(); - List geoCoords = new ArrayList(); // the result - // - // logging - int count = layer.getIndex().count(); - if (count == 0) { - // Note: Neo4j Spatial throws a NullPointerException when searching an empty index - logger.info("### Searching the geospatial index ABORTED -- index is empty"); - return geoCoords; - } else { - logger.info("### " + count + " entries in geospatial index"); - } - // - // search geospatial index - Coordinate point = new Coordinate(geoCoord.lon, geoCoord.lat); - GeoPipeline spatialRecords = GeoPipeline.startNearestNeighborLatLonSearch(layer, point, maxDistanceInKm); - /* ### .sort("OrthodromicDistance") */ - // - // build result - for (GeoPipeFlow spatialRecord : spatialRecords) { - // Note: long distance = spatialRecord.getProperty("OrthodromicDistance") - long geoCoordId = ( (Number) spatialRecord.getRecord().getProperty("topic_id")).longValue(); - if (dm4.getAccessControl().hasPermission(username, Operation.READ, geoCoordId)) { - geoCoords.add(dm4.getTopic(geoCoordId)); - } else { - logger.fine("Skipped to load geo coordinate topic, cause user (\""+username+"\") has no READ" - + " permission for topci id"); - } - } - logger.info("Found " + geoCoords.size() + " items nearby the given parameters."); - return geoCoords; - } catch (Exception e) { - throw new RuntimeException("Searching the geospatial index failed", e); - } - } - - - - // *********************************** - // *** PointFactory Implementation *** - // *********************************** - - - - @Override - public Point createPointByCoordinates(double lon, double lat) { - return layer.getGeometryFactory().createPoint(new Coordinate(lon, lat)); - } - - - // **************************** - // *** Hook Implementations *** - // **************************** - - - - @Override - public void init() { - GraphDatabaseService neo4j = (GraphDatabaseService) dm4.getDatabaseVendorObject(); - SpatialDatabaseService spatialDB = new SpatialDatabaseService(neo4j); - // - // IMPORTANT: deleting a Neo4j Spatial layer includes deleting the geometry nodes which are at the same time - // our Geo Coordinate topics. This results in a corrupted DM database as associations with only 1 player remain. - // --> Never delete a layer while Geo Coordinate topics exist!!! - // spatialDB.deleteLayer(DEFAULT_LAYER_NAME, new NullListener()); - // UPDATE: As of 0.2.2 this should not play a role because the geometry nodes are not Geo Coordinate - // topics anymore but are extra neo4j nodes. ### Test and confirm this. Deleting spatial index will not corrupt - // the DeepaMehta database anymore. - // - boolean layerCreated = false; - if (spatialDB.containsLayer(DEFAULT_LAYER_NAME)) { - logger.info("### Default layer already exists (\"" + DEFAULT_LAYER_NAME + "\")"); - layer = (EditableLayer) spatialDB.getLayer(DEFAULT_LAYER_NAME); - } else { - logger.info("### Creating default layer (\"" + DEFAULT_LAYER_NAME + "\")"); - layer = (EditableLayer) spatialDB.createLayer(DEFAULT_LAYER_NAME, GeoCoordinateEncoder.class, - EditableLayerImpl.class); - layerCreated = true; - } - // - ((GeoCoordinateEncoder) layer.getGeometryEncoder()).init(this, dm4); - // - // initial indexing - if (layerCreated) { - indexAllGeoCoordinateTopics(); - } - } - - - - // ******************************** - // *** Listener Implementations *** - // ******************************** - - - - @Override - public void postCreateTopic(Topic topic) { - if (topic.getTypeUri().equals("dm4.geomaps.geo_coordinate")) { - logger.info("### Adding Geo Coordinate to geospatial index (" + topic.getId() + ")"); - addToIndex(topic.loadChildTopics()); - } - } - - @Override - public void postUpdateTopic(Topic topic, TopicModel newModel, TopicModel oldModel) { - if (topic.getTypeUri().equals("dm4.geomaps.geo_coordinate")) { - logger.info("### Updating Geo Coordinate " + topic.getId() + " in geospatial index"); - updateIndex(topic.loadChildTopics()); - } - } - - // --- - - @Override - public void preDeleteTopic(Topic topic) { - if (topic.getTypeUri().equals("dm4.geomaps.geo_coordinate")) { - logger.info("### Removing Geo Coordinate " + topic.getId() + " from geospatial index"); - removeFromIndex(topic); - } - } - - - - // ------------------------------------------------------------------------------------------------- Private Methods - - private void addToIndex(Topic geoCoord) { - // Old: layer.add((Node) geoCoord.getDatabaseVendorObject()); // this triggers a decodeGeom before encoding - geoCoord.loadChildTopics(); - double longitude = geoCoord.getChildTopics().getDouble("dm4.geomaps.longitude"); - double latitude = geoCoord.getChildTopics().getDouble("dm4.geomaps.latitude"); - // Note 1: we store the reference to the geo coordinate topic (id) in the geometry node to assbmel the - // resulting list of topics after a spatial query - String propertyKeys[] = { "topic_id" }; - Object values[] = { geoCoord.getId() }; - // New: We directly (and just) trigger encodeGeometryShape (no decodeGeom is called in our AGE before initial - // encoding) via not using layer.add(Node) but layer.add(Geometry). - SpatialDatabaseRecord sr = layer.add(createPointByCoordinates(longitude, latitude), propertyKeys, values); - // Note 2: we store a reference to the geometry node in a dm4-node property to easify alteration of index - geoCoord.setProperty(GEO_NODE_PROPERTY_ID, sr.getGeomNode().getId(), true); - } - - private void updateIndex(Topic geoCoord) { - // get updated values - geoCoord.loadChildTopics(); - double longitude = geoCoord.getChildTopics().getDouble("dm4.geomaps.longitude"); - double latitude = geoCoord.getChildTopics().getDouble("dm4.geomaps.latitude"); - // update indexed geometry node - try { - long nodeId = ( (Number) geoCoord.getProperty(GEO_NODE_PROPERTY_ID)).longValue(); - layer.update(nodeId, createPointByCoordinates(longitude, latitude)); - } catch (NotFoundException nfe) { - logger.severe("### Geo Coordinate (id="+geoCoord.getId()+") has no geometry node id set/indexed as property" - + " - Spatial index layer can not be updated"); - } - } - - private void removeFromIndex(Topic geoCoord) { - try { - long nodeId = ( (Number) geoCoord.getProperty(GEO_NODE_PROPERTY_ID)).longValue(); - layer.removeFromIndex(nodeId); - } catch (NotFoundException nfe) { - logger.severe("### Geo Coordinate (id="+geoCoord.getId()+") has no geometry node id set/indexed as property" - + "- Node can not be removed from spatial index layer"); - } - } - - // --- - - private void indexAllGeoCoordinateTopics() { - DeepaMehtaTransaction tx = dm4.beginTx(); - try { - List geoCoords = dm4.getTopicsByType("dm4.geomaps.geo_coordinate"); - logger.info("### Filling initial geospatial index with " + geoCoords.size() + " Geo Coordinates"); - for (Topic geoCoord : geoCoords) { - addToIndex(geoCoord.loadChildTopics()); - } - // - tx.success(); - } catch (Exception e) { - logger.warning("ROLLBACK!"); - throw new RuntimeException("Filling initial geospatial index failed", e); - } finally { - tx.finish(); - } - } - -} diff --git a/src/main/java/de/deepamehta/plugins/geospatial/GeospatialService.java b/src/main/java/de/deepamehta/plugins/geospatial/GeospatialService.java deleted file mode 100644 index ac7f178..0000000 --- a/src/main/java/de/deepamehta/plugins/geospatial/GeospatialService.java +++ /dev/null @@ -1,14 +0,0 @@ -package de.deepamehta.plugins.geospatial; - -import de.deepamehta.geomaps.model.GeoCoordinate; - -import de.deepamehta.core.Topic; - -import java.util.List; - - - -public interface GeospatialService { - - List getTopicsWithinDistance(GeoCoordinate geoCoord, double maxDistanceInKm); -} diff --git a/src/main/java/de/deepamehta/plugins/geospatial/migrations/Migration1.java b/src/main/java/de/deepamehta/plugins/geospatial/migrations/Migration1.java deleted file mode 100644 index bf35e51..0000000 --- a/src/main/java/de/deepamehta/plugins/geospatial/migrations/Migration1.java +++ /dev/null @@ -1,36 +0,0 @@ -package de.deepamehta.plugins.geospatial.migrations; - -import de.deepamehta.core.Topic; -import de.deepamehta.core.service.Migration; -import static de.deepamehta.plugins.geospatial.GeospatialPlugin.GEO_NODE_PROPERTY_ID; -import java.util.List; - -import java.util.logging.Logger; -import org.neo4j.graphdb.NotFoundException; - - -/** - * Fix geometry node id property indexes on all geo coordinate topics. Does not alter any data values, just indexes. - * Note: This migration is just needed to clean up a very specific 0.2.2-SNAPSHOT database in existence. - */ -public class Migration1 extends Migration { - - private Logger log = Logger.getLogger(getClass().getName()); - - @Override - public void run() { - log.warning("### Geospatial Migration1: Start fixing geometry node id property indexes on coordinate topics."); - List geoCoordinates = dm4.getTopicsByType("dm4.geomaps.geo_coordinate"); - for (Topic coordinate : geoCoordinates) { - try { - long nodeId = ( (Number) coordinate.getProperty(GEO_NODE_PROPERTY_ID)).longValue(); - coordinate.setProperty(GEO_NODE_PROPERTY_ID, nodeId, true); // re-set node id but with index=true - } catch (NotFoundException nfe) { - log.warning("### Geo Coordinate (id="+coordinate.getId()+") has no geometry node id set/indexed as property" - + " - Spatial indexed topic can not be fixed"); - } - } - log.warning("### Geospatial Migration1: Completed fixing property indexes on all geo coordinate topics."); - - } -} \ No newline at end of file diff --git a/src/main/java/de/deepamehta/plugins/geospatial/GeoCoordinateEncoder.java b/src/main/java/systems/dmx/geospatial/GeoCoordinateEncoder.java similarity index 96% rename from src/main/java/de/deepamehta/plugins/geospatial/GeoCoordinateEncoder.java rename to src/main/java/systems/dmx/geospatial/GeoCoordinateEncoder.java index f3a3475..e82d936 100644 --- a/src/main/java/de/deepamehta/plugins/geospatial/GeoCoordinateEncoder.java +++ b/src/main/java/systems/dmx/geospatial/GeoCoordinateEncoder.java @@ -1,14 +1,11 @@ -package de.deepamehta.plugins.geospatial; +package systems.dmx.geospatial; import com.vividsolutions.jts.geom.Coordinate; - import org.neo4j.gis.spatial.AbstractGeometryEncoder; import org.neo4j.graphdb.PropertyContainer; - import com.vividsolutions.jts.geom.Geometry; -import de.deepamehta.core.service.CoreService; - import java.util.logging.Logger; +import systems.dmx.core.service.CoreService; diff --git a/src/main/java/systems/dmx/geospatial/GeospatialPlugin.java b/src/main/java/systems/dmx/geospatial/GeospatialPlugin.java new file mode 100644 index 0000000..fa35332 --- /dev/null +++ b/src/main/java/systems/dmx/geospatial/GeospatialPlugin.java @@ -0,0 +1,402 @@ +package systems.dmx.geospatial; + +import org.neo4j.graphdb.GraphDatabaseService; +import org.neo4j.gis.spatial.EditableLayerImpl; +import org.neo4j.gis.spatial.SpatialDatabaseService; +import org.neo4j.gis.spatial.pipes.GeoPipeFlow; +import org.neo4j.gis.spatial.pipes.GeoPipeline; + +import com.vividsolutions.jts.geom.Coordinate; +import com.vividsolutions.jts.geom.Geometry; +import com.vividsolutions.jts.geom.GeometryFactory; +import com.vividsolutions.jts.geom.Point; +import java.io.IOException; +import java.nio.charset.Charset; + +import javax.ws.rs.GET; +import javax.ws.rs.Path; +import javax.ws.rs.PathParam; +import javax.ws.rs.Produces; +import javax.ws.rs.Consumes; + +import java.util.ArrayList; +import java.util.List; +import java.util.Map; +import java.util.logging.Logger; +import javax.ws.rs.core.Response; +import org.neo4j.gis.spatial.EditableLayer; +import org.neo4j.gis.spatial.Layer; +import org.neo4j.gis.spatial.ShapefileImporter; +import org.neo4j.gis.spatial.SpatialDatabaseRecord; +import org.neo4j.graphdb.NotFoundException; +import systems.dmx.accesscontrol.AccessControlService; +import systems.dmx.core.Topic; +import systems.dmx.core.model.TopicModel; +import systems.dmx.core.osgi.PluginActivator; +import systems.dmx.core.service.Inject; +import systems.dmx.core.service.Transactional; +import systems.dmx.core.service.accesscontrol.Operation; +import systems.dmx.core.service.event.PostCreateTopic; +import systems.dmx.core.service.event.PostUpdateTopic; +import systems.dmx.core.service.event.PreDeleteTopic; +import systems.dmx.core.storage.spi.DMXTransaction; +import systems.dmx.geomaps.GeoCoordinate; + + + +@Path("/geospatial") +@Consumes("application/json") +@Produces("application/json") +public class GeospatialPlugin extends PluginActivator implements GeospatialService, PointFactory, + PostCreateTopic, + PostUpdateTopic, + PreDeleteTopic { + + // ------------------------------------------------------------------------------------------------------- Constants + + public static final String DEFAULT_POINT_LAYER_NAME = "dmx.geospatial.default_layer"; + public static final String DEFAULT_GEOMETRY_LAYER_NAME = "dmx.geospatial.default_geometry_layer"; + public static final String GEO_NODE_PROPERTY_ID = "dmx.geospatial.geometry_node_id"; + + // ---------------------------------------------------------------------------------------------- Instance Variables + + private EditableLayer pointLayer; + private EditableLayer geometryLayer; + + @Inject private AccessControlService acService; + + private Logger logger = Logger.getLogger(getClass().getName()); + + // -------------------------------------------------------------------------------------------------- Public Methods + + + + // **************************************** + // *** GeospatialService Implementation *** + // **************************************** + + + /** + * Fetches all Geo Coordinate topics within a "given distance" (using neo4j-spatial). + * @param geoCoord Coordinate pair + * @param maxDistanceInKm The maximum distance (e.g 1.3) in kilometers between the given coordinate and a POI. + * @return List Topics will be topics of type "dmx.geomaps.geo_coordinate" + */ + @GET + @Path("/{geo_coord}/distance/{distance}") + @Override + public List getTopicsWithinDistance(@PathParam("geo_coord") GeoCoordinate geoCoord, + @PathParam("distance") double maxDistanceInKm) { + try { + String username = acService.getUsername(); + List geoCoords = new ArrayList(); // the result + // logging + int count = pointLayer.getIndex().count(); + if (count == 0) { + // Note: Neo4j Spatial throws a NullPointerException when searching an empty index + logger.info("### Searching the geospatial index ABORTED -- index is empty"); + return geoCoords; + } else { + logger.fine("### " + count + " entries in geospatial index"); + } + // search geospatial index + Coordinate point = new Coordinate(geoCoord.lon, geoCoord.lat); + GeoPipeline spatialRecords = GeoPipeline. + startNearestNeighborLatLonSearch(pointLayer, point, maxDistanceInKm); + // build result + for (GeoPipeFlow spatialRecord : spatialRecords) { + // Note: long distance = spatialRecord.getProperty("OrthodromicDistance") + long geoCoordId = ( (Number) spatialRecord.getRecord().getProperty("topic_id")).longValue(); + if (dmx.getPrivilegedAccess().hasPermission(username, Operation.READ, geoCoordId)) { + geoCoords.add(dmx.getTopic(geoCoordId)); + } else { + logger.fine("Skipped to load geo coordinate topic, cause user (\""+username+"\") has no READ" + + " permission for topci id"); + } + } + logger.info("Found " + geoCoords.size() + " items nearby the given parameters."); + return geoCoords; + } catch (Exception e) { + throw new RuntimeException("Searching the geospatial index failed", e); + } + } + + /** + * Fetches the name of the geometry (Feature) given a coordinate pair (WGS-84) located within + * that feature (using neo4j-spatial shapefile). + * @param coordinates String lat,lng + * @return String name + */ + @GET + @Path("/feature/{latlng}") + public Response getGeometryFeatureName(@PathParam("latlng") String coordinates) { + String name = getGeometryFeatureNameByCoordinate(coordinates); + if (name != null) { + return Response.ok(name).build(); + } + return Response.noContent().build(); + } + + @GET + @Path("/set/geometry/{absoluteFilePath}") + @Transactional + @Override + public Response setGeometryLayer(@PathParam("absoluteFilePath") String absoluteFile) { + if (!acService.getUsername().equals(AccessControlService.ADMIN_USERNAME)) { + throw new RuntimeException("Unauthorized to write default geometry layer to queries at /feature)"); + } + GraphDatabaseService neo4j = (GraphDatabaseService) dmx.getDatabaseVendorObject(); + SpatialDatabaseService spatialDB = new SpatialDatabaseService(neo4j); + logger.info("### Indexing new layer (\"" + DEFAULT_GEOMETRY_LAYER_NAME + "\")"); + try { + if (spatialDB.containsLayer(DEFAULT_GEOMETRY_LAYER_NAME)) { + geometryLayer = (EditableLayer) spatialDB.getLayer(DEFAULT_GEOMETRY_LAYER_NAME); + spatialDB.deleteLayer(DEFAULT_GEOMETRY_LAYER_NAME, + new ProgressLoggingListener("Deleting layer '" + DEFAULT_GEOMETRY_LAYER_NAME + "'", logger)); + logger.info("### Removed previously stored geometry layer (\"" + DEFAULT_GEOMETRY_LAYER_NAME + "\")"); + } + ShapefileImporter importer = new ShapefileImporter(neo4j); + // The following line requires the "gt-api" module at compile time. + importer.importFile(absoluteFile, DEFAULT_GEOMETRY_LAYER_NAME, Charset.forName("UTF-8")); + logger.info("### Successfully wrote shapefile as default geometry layer (Filename: \"" + + absoluteFile + "\") for queries at /feature"); + return Response.noContent().build(); + } catch (Exception ex) { + logger.severe("IO/Error occured during indexing shapefile layer with neo4j-spatial"); + throw new RuntimeException(ex); + } + } + + @Override + public String getGeometryFeatureNameByCoordinate(@PathParam("latlng") String coordinates) { + Object value = getGeometryFeatureValueByCoordinate(coordinates, "Name"); + return (String) value; + } + + @Override + public Object getGeometryFeatureValueByCoordinate(@PathParam("latlng") String coordinates, String key) { + GraphDatabaseService neo4j = (GraphDatabaseService) dmx.getDatabaseVendorObject(); + SpatialDatabaseService spatialDB = new SpatialDatabaseService(neo4j); + try { + String[] latLng = coordinates.split(","); + if (spatialDB.containsLayer(DEFAULT_GEOMETRY_LAYER_NAME)) { + geometryLayer = (EditableLayer) spatialDB.getLayer(DEFAULT_GEOMETRY_LAYER_NAME); + logger.info("### Inspecting layer (\"" + DEFAULT_GEOMETRY_LAYER_NAME + "\"), by " + + "coordinate: " + coordinates); + // countGeometryIndex(DEFAULT_GEOMETRY_LAYER_NAME); + } else { + throw new RuntimeException("Geometry layer does not exist"); + } + GeometryFactory geometryFactory = new GeometryFactory(); + Coordinate coordinate = new Coordinate(Double.parseDouble(latLng[1]), Double.parseDouble(latLng[0])); + Point point = geometryFactory.createPoint(coordinate); + GeoPipeline spatialRecords = GeoPipeline.start(geometryLayer); + // GeoPipeline spatialRecords = GeoPipeline.startWithinSearch(geometryLayer, pointGeo); + for (GeoPipeFlow spatialRecord : spatialRecords) { + SpatialDatabaseRecord entry = spatialRecord.getRecord(); + Geometry geometry = entry.getGeometry(); + if (point.within(geometry)) { + Object value = getGeometryAttribute(entry, key); + logger.info("Found Point \"" + point + "\" is WITHIN => " + value); + // inspectGeometryAttributes(entry); + return value; + } + } + logger.info("No geometry found matching the coordinates"); + return null; + } catch (RuntimeException ex) { + logger.severe("Error occured during inspecting of geometry layer"); + throw new RuntimeException(ex); + } + } + + // *********************************** + // *** PointFactory Implementation *** + // *********************************** + + + + @Override + public Point createPointByCoordinates(double lon, double lat) { + return pointLayer.getGeometryFactory().createPoint(new Coordinate(lon, lat)); + } + + + // **************************** + // *** Hook Implementations *** + // **************************** + + + + @Override + public void init() { + GraphDatabaseService neo4j = (GraphDatabaseService) dmx.getDatabaseVendorObject(); + SpatialDatabaseService spatialDB = new SpatialDatabaseService(neo4j); + // + // IMPORTANT: deleting a Neo4j Spatial layer includes deleting the geometry nodes which are at the same time + // our Geo Coordinate topics. This results in a corrupted DM database as associations with only 1 player remain. + // --> Never delete a layer while Geo Coordinate topics exist!!! + // spatialDB.deleteLayer(DEFAULT_LAYER_NAME, new NullListener()); + // UPDATE: As of 0.2.2 this should not play a role because the geometry nodes are not Geo Coordinate + // topics anymore but are extra neo4j nodes. ### Test and confirm this. Deleting spatial index will not corrupt + // the DeepaMehta database anymore. + // + boolean layerCreated = false; + if (spatialDB.containsLayer(DEFAULT_POINT_LAYER_NAME)) { + logger.info("### Default geometry layer initialized, already exists. (\"" + DEFAULT_POINT_LAYER_NAME + "\")"); + pointLayer = (EditableLayer) spatialDB.getLayer(DEFAULT_POINT_LAYER_NAME); + } else { + logger.info("### Creating geometry layer (\"" + DEFAULT_POINT_LAYER_NAME + "\")"); + pointLayer = (EditableLayer) spatialDB.createLayer(DEFAULT_POINT_LAYER_NAME, GeoCoordinateEncoder.class, + EditableLayerImpl.class); + layerCreated = true; + } + if (spatialDB.containsLayer(DEFAULT_GEOMETRY_LAYER_NAME)) { + logger.info("### Default geometry layer initialized (already exists). (\"" + DEFAULT_GEOMETRY_LAYER_NAME + "\")"); + geometryLayer = (EditableLayer) spatialDB.getLayer(DEFAULT_GEOMETRY_LAYER_NAME); + } + // + ((GeoCoordinateEncoder) pointLayer.getGeometryEncoder()).init(this, dmx); + // initial indexing + if (layerCreated) { + indexAllGeoCoordinateTopics(); + } + } + + @Override + public boolean validWGS84Coordinates(GeoCoordinate coords) { + return ((coords.lat < 91 && coords.lat > -91) + && (coords.lon < 91 && coords.lon > -91)); + } + + // ******************************** + // *** Listener Implementations *** + // ******************************** + + + + @Override + public void postCreateTopic(Topic topic) { + if (topic.getTypeUri().equals("dmx.geomaps.geo_coordinate")) { + logger.info("### Adding Geo Coordinate to geospatial index (" + topic.getId() + ")"); + addToIndex(topic.loadChildTopics()); + } + } + + @Override + public void postUpdateTopic(Topic topic, TopicModel newModel, TopicModel oldModel) { + if (topic.getTypeUri().equals("dmx.geomaps.geo_coordinate")) { + logger.info("### Updating Geo Coordinate " + topic.getId() + " in geospatial index"); + updateIndex(topic.loadChildTopics()); + } + } + + // --- + + @Override + public void preDeleteTopic(Topic topic) { + if (topic.getTypeUri().equals("dmx.geomaps.geo_coordinate")) { + logger.info("### Removing Geo Coordinate " + topic.getId() + " from geospatial index"); + removeFromIndex(topic); + } + } + + + + // ------------------------------------------------------------------------------------------------- Private Methods + + private Object getGeometryAttribute(SpatialDatabaseRecord entry, String attributeKey) { + try { + return entry.getProperties().get(attributeKey); + } catch (RuntimeException re) { + logger.severe("Could not find an attribute named \"" + attributeKey + + "\" at geospatial entry " + entry.toString()); + } + return null; + } + + /** Useful for inspecting geometries, not in use by default. **/ + private void inspectGeometryAttributes(SpatialDatabaseRecord entry) { + logger.info("=> Inspecting spatial database entry => " + entry.getId()); + Map props = entry.getProperties(); + for (String key : props.keySet()) { + logger.info("=> Attribute \""+key+"\": \"" + props.get(key).toString() + "\""); + } + } + + /** Useful for inspecting geometries, not in use by default. **/ + private void countGeometryIndex(String layerName) throws IOException { + GraphDatabaseService neo4j = (GraphDatabaseService) dmx.getDatabaseVendorObject(); + SpatialDatabaseService spatial = new SpatialDatabaseService(neo4j); + Layer layer = spatial.getLayer(layerName); + if (layer.getIndex().count() < 1) { + logger.warning("Checking Layer Warning: index count zero: " + layer.getName()); + } + logger.info("Checking Layer: '" + layer.getName() + "' has " + layer.getIndex().count() + " entries in the index"); + /** DataStore store = new Neo4jSpatialDataStoreFactory(); + SimpleFeatureCollection features = store.getFeatureSource(layer.getName()).getFeatures(); + logger.info("Checking Layer: '" + layer.getName() + "' has " + features.size() + " features"); **/ + } + + private void addToIndex(Topic geoCoord) { + // Old: layer.add((Node) geoCoord.getDatabaseVendorObject()); // this triggers a decodeGeom before encoding + geoCoord.loadChildTopics(); + double longitude = geoCoord.getChildTopics().getDouble("dmx.geomaps.longitude"); + double latitude = geoCoord.getChildTopics().getDouble("dmx.geomaps.latitude"); + // Note 1: we store the reference to the geo coordinate topic (id) in the geometry node to assemble the + // resulting list of topics after a spatial query + String propertyKeys[] = { "topic_id" }; + Object values[] = { geoCoord.getId() }; + // New: We directly (and just) trigger encodeGeometryShape (no decodeGeom is called in our AGE before initial + // encoding) via not using layer.add(Node) but layer.add(Geometry). + SpatialDatabaseRecord sr = pointLayer.add(createPointByCoordinates(longitude, latitude), propertyKeys, values); + // Note 2: we store a reference to the geometry node in a dmx-node property to easify alteration of index + geoCoord.setProperty(GEO_NODE_PROPERTY_ID, sr.getGeomNode().getId(), true); + } + + private void updateIndex(Topic geoCoord) { + // get updated values + geoCoord.loadChildTopics(); + double longitude = geoCoord.getChildTopics().getDouble("dmx.geomaps.longitude"); + double latitude = geoCoord.getChildTopics().getDouble("dmx.geomaps.latitude"); + // update indexed geometry node + try { + long nodeId = ( (Number) geoCoord.getProperty(GEO_NODE_PROPERTY_ID)).longValue(); + pointLayer.update(nodeId, createPointByCoordinates(longitude, latitude)); + } catch (NotFoundException nfe) { + logger.severe("### Geo Coordinate (id="+geoCoord.getId()+") has no geometry node id set/indexed as property" + + " - Spatial index layer can not be updated"); + } + } + + private void removeFromIndex(Topic geoCoord) { + try { + long nodeId = ( (Number) geoCoord.getProperty(GEO_NODE_PROPERTY_ID)).longValue(); + pointLayer.removeFromIndex(nodeId); + } catch (NotFoundException nfe) { + logger.severe("### Geo Coordinate (id="+geoCoord.getId()+") has no geometry node id set/indexed as property" + + "- Node can not be removed from spatial index layer"); + } + } + + // --- + + private void indexAllGeoCoordinateTopics() { + DMXTransaction tx = dmx.beginTx(); + try { + List geoCoords = dmx.getTopicsByType("dmx.geomaps.geo_coordinate"); + logger.info("### Filling initial geospatial index with " + geoCoords.size() + " Geo Coordinates"); + for (Topic geoCoord : geoCoords) { + addToIndex(geoCoord.loadChildTopics()); + } + // + tx.success(); + } catch (Exception e) { + logger.warning("ROLLBACK!"); + throw new RuntimeException("Filling initial geospatial index failed", e); + } finally { + tx.finish(); + } + } + +} diff --git a/src/main/java/systems/dmx/geospatial/GeospatialService.java b/src/main/java/systems/dmx/geospatial/GeospatialService.java new file mode 100644 index 0000000..23ccac2 --- /dev/null +++ b/src/main/java/systems/dmx/geospatial/GeospatialService.java @@ -0,0 +1,20 @@ +package systems.dmx.geospatial; + +import java.util.List; +import javax.ws.rs.core.Response; +import systems.dmx.core.Topic; +import systems.dmx.geomaps.GeoCoordinate; + +public interface GeospatialService { + + List getTopicsWithinDistance(GeoCoordinate geoCoord, double maxDistanceInKm); + + Response setGeometryLayer(String absoluteFile); + + String getGeometryFeatureNameByCoordinate(String latlng); + + Object getGeometryFeatureValueByCoordinate(String latlng, String valueKey); + + boolean validWGS84Coordinates(GeoCoordinate pos); + +} diff --git a/src/main/java/de/deepamehta/plugins/geospatial/PointFactory.java b/src/main/java/systems/dmx/geospatial/PointFactory.java similarity index 76% rename from src/main/java/de/deepamehta/plugins/geospatial/PointFactory.java rename to src/main/java/systems/dmx/geospatial/PointFactory.java index c0d443b..dd22a5b 100644 --- a/src/main/java/de/deepamehta/plugins/geospatial/PointFactory.java +++ b/src/main/java/systems/dmx/geospatial/PointFactory.java @@ -1,10 +1,7 @@ -package de.deepamehta.plugins.geospatial; - +package systems.dmx.geospatial; import com.vividsolutions.jts.geom.Point; - - interface PointFactory { Point createPointByCoordinates(double longitude, double latitude); diff --git a/src/main/java/systems/dmx/geospatial/ProgressLoggingListener.java b/src/main/java/systems/dmx/geospatial/ProgressLoggingListener.java new file mode 100644 index 0000000..f079b67 --- /dev/null +++ b/src/main/java/systems/dmx/geospatial/ProgressLoggingListener.java @@ -0,0 +1,107 @@ +/** + * Copyright (c) 2002-2013 "Neo Technology," + * Network Engine for Objects in Lund AB [http://neotechnology.com] + * + * This file is part of Neo4j. + * + * Neo4j 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 . + */ +package systems.dmx.geospatial; + + +import java.util.logging.Logger; +import org.neo4j.collections.rtree.Listener; + +/** + * This listener logs percentage progress to the specified PrintStream or Logger based on a timer, + * never logging more frequently than the specified number of ms. + */ +public class ProgressLoggingListener implements Listener { + + private Logger logger = Logger.getLogger(getClass().getName()); + + private final ProgressLog out; + private final String name; + private long lastLogTime = 0L; + private int totalUnits = 0; + private int workedSoFar = 0; + private boolean enabled = false; + private long timeWait = 1000; + + public interface ProgressLog { + void log(String line); + } + + public ProgressLoggingListener(String name, final Logger logger) { + this.name = name; + this.out = new ProgressLog() { + @Override + public void log(String line) { + logger.info(line); + } + }; + } + + public ProgressLoggingListener setTimeWait(long ms) { + this.timeWait = ms; + return this; + } + + @Override + public void begin(int unitsOfWork) { + this.totalUnits = unitsOfWork; + this.workedSoFar = 0; + this.lastLogTime = 0L; + try { + this.enabled = true; + out.log("Starting " + name); + } catch (Exception e) { + System.err.println("Failed to write to output - disabling progress logger: " + e.getMessage()); + this.enabled = false; + } + } + + @Override + public void worked(int workedSinceLastNotification) { + this.workedSoFar += workedSinceLastNotification; + logNoMoreThanOnceASecond("Running"); + } + + @Override + public void done() { + this.workedSoFar = this.totalUnits; + this.lastLogTime = 0L; + logNoMoreThanOnceASecond("Completed"); + } + + private void logNoMoreThanOnceASecond(String action) { + long now = System.currentTimeMillis(); + if (enabled && now - lastLogTime > timeWait) { + if (totalUnits > 0) { + out.log("" + percText() + " (" + workedSoFar + "/" + totalUnits + ") - " + action + " " + name); + } else { + out.log(action + " " + name); + } + this.lastLogTime = now; + } + } + + private String percText() { + if (totalUnits > 0) { + return String.format("%.2f", 100.0 * workedSoFar / totalUnits); + } else { + return "NaN"; + } + } +} \ No newline at end of file diff --git a/src/main/resources/plugin.properties b/src/main/resources/plugin.properties index 6a0acf8..72ccde4 100644 --- a/src/main/resources/plugin.properties +++ b/src/main/resources/plugin.properties @@ -1,2 +1 @@ -dm4.plugin.main_package=de.deepamehta.plugins.geospatial -dm4.plugin.model_version=1 +dmx.plugin.main_package=systems.dmx.geospatial