This is an automated email from the git hooks/post-receive script. New commit to branch develop in repository tutti. See http://git.codelutin.com/tutti.git commit 35d8aceafba6cf1549035c410bc94a141804069c Author: Tony CHEMIT <chemit@codelutin.com> Date: Wed Mar 11 09:36:05 2015 +0100 - introduces new module to generate report as a tool - includes it in the release process - introduces new ReportGenerationService (will replace ReportService) --- pom.xml | 55 +- .../java/fr/ifremer/tutti/TuttiConfiguration.java | 37 ++ tutti-report-generator/LICENSE.txt | 674 +++++++++++++++++++++ tutti-report-generator/README.txt | 0 tutti-report-generator/pom.xml | 127 ++++ .../src/license/THIRD-PARTY.properties | 36 ++ tutti-report-generator/src/main/assembly/bin.xml | 27 + .../java/fr/ifremer/tutti/report/ReportConfig.java | 50 ++ .../java/fr/ifremer/tutti/report/ReportEngine.java | 118 ++++ .../java/fr/ifremer/tutti/report/RunReport.java | 47 ++ tutti-service/pom.xml | 28 + .../service/report/ReportGenerationContext.java | 67 ++ .../service/report/ReportGenerationRequest.java | 54 ++ .../service/report/ReportGenerationResult.java | 49 ++ .../service/report/ReportGenerationService.java | 169 ++++++ .../report/ReportGenerationServiceTest.java | 119 ++++ tutti-ui-swing/pom.xml | 23 + tutti-ui-swing/src/license/THIRD-PARTY.properties | 6 +- .../src/main/assembly/full-shared-component.xml | 8 + tutti-ui-swing/src/main/assembly/standalone.xml | 8 + .../fr/ifremer/tutti/ui/swing/TuttiUIContext.java | 13 +- 21 files changed, 1650 insertions(+), 65 deletions(-) diff --git a/pom.xml b/pom.xml index 14a2ff2..f48dc8b 100644 --- a/pom.xml +++ b/pom.xml @@ -93,6 +93,7 @@ <modules> <module>tutti-persistence</module> <module>tutti-ichtyometer</module> + <module>tutti-report-generator</module> <module>tutti-service</module> <module>tutti-ui-swing-updater</module> <module>tutti-ui-swing</module> @@ -456,60 +457,6 @@ <artifactId>org.eclipse.birt.runtime</artifactId> <version>4.3.1-1</version> <classifier>codelutin</classifier> - <exclusions> - <exclusion> - <groupId>batik</groupId> - <artifactId>batik-util</artifactId> - </exclusion> - <exclusion> - <groupId>batik</groupId> - <artifactId>batik-xml</artifactId> - </exclusion> - <exclusion> - <groupId>batik</groupId> - <artifactId>batik-gvt</artifactId> - </exclusion> - <exclusion> - <groupId>batik</groupId> - <artifactId>batik-script</artifactId> - </exclusion> - <exclusion> - <groupId>batik</groupId> - <artifactId>batik-transcoder</artifactId> - </exclusion> - <exclusion> - <groupId>batik</groupId> - <artifactId>batik-parser</artifactId> - </exclusion> - <exclusion> - <groupId>batik</groupId> - <artifactId>batik-css</artifactId> - </exclusion> - <exclusion> - <groupId>batik</groupId> - <artifactId>batik-bridge</artifactId> - </exclusion> - <exclusion> - <groupId>batik</groupId> - <artifactId>batik-dom</artifactId> - </exclusion> - <exclusion> - <groupId>batik</groupId> - <artifactId>batik-svg-dom</artifactId> - </exclusion> - <exclusion> - <groupId>batik</groupId> - <artifactId>batik-awt-util</artifactId> - </exclusion> - <exclusion> - <groupId>batik</groupId> - <artifactId>batik-svggen</artifactId> - </exclusion> - <exclusion> - <groupId>batik</groupId> - <artifactId>batik-ext</artifactId> - </exclusion> - </exclusions> </dependency> <!-- Jdbc drivers --> diff --git a/tutti-persistence/src/main/java/fr/ifremer/tutti/TuttiConfiguration.java b/tutti-persistence/src/main/java/fr/ifremer/tutti/TuttiConfiguration.java index 78c5027..9a017bc 100644 --- a/tutti-persistence/src/main/java/fr/ifremer/tutti/TuttiConfiguration.java +++ b/tutti-persistence/src/main/java/fr/ifremer/tutti/TuttiConfiguration.java @@ -68,6 +68,8 @@ public class TuttiConfiguration extends ApplicationConfiguration { private static TuttiConfiguration instance; + private final boolean windowsOS; + public static TuttiConfiguration getInstance() { return instance; } @@ -121,10 +123,12 @@ public class TuttiConfiguration extends ApplicationConfiguration { public TuttiConfiguration(ApplicationConfig applicationConfig) { super(applicationConfig); optionKeyToNotSave = null; + this.windowsOS = System.getProperty("os.name").startsWith("Windows"); } public TuttiConfiguration(String file, String... args) { super(new ApplicationConfig()); + this.windowsOS = System.getProperty("os.name").startsWith("Windows"); applicationConfig.setEncoding(Charsets.UTF_8.name()); Set<ApplicationConfigProvider> providers = getDefaultApplicationConfig(applicationConfig); @@ -687,4 +691,37 @@ public class TuttiConfiguration extends ApplicationConfiguration { return applicationConfig.getOptionAsBoolean(TuttiConfigurationOption.FULL_BLUETOOTH_SCAN.getKey()); } + public String getJavaCommandPath() { + String path; + String commandName = windowsOS ? "java.exe" : "java"; + if (isFullLaunchMode()) { + path = getBasedir().toPath().resolve("jre").resolve("bin").resolve(commandName).toFile().getAbsolutePath(); + } else { + path = commandName; + } + return path; + } + + private File reportJarPath; + + public File getReportJarPath() { + if (reportJarPath == null) { + //FIXME Should include version in file name + String commandName = "tutti-report-generator.jar"; + if (isFullLaunchMode()) { + reportJarPath = getBasedir().toPath().resolve("tutti").resolve("report-generator").resolve(commandName).toFile(); + } else { + + if (log.isWarnEnabled()) { + log.warn("You must defined yourself the path to tutti-report-generator jar!"); + } + + } + } + return reportJarPath; + } + + public void setReportJarPath(File reportJarPath) { + this.reportJarPath = reportJarPath; + } } diff --git a/tutti-report-generator/LICENSE.txt b/tutti-report-generator/LICENSE.txt new file mode 100644 index 0000000..94a9ed0 --- /dev/null +++ b/tutti-report-generator/LICENSE.txt @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/> + 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. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + 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 <http://www.gnu.org/licenses/>. + +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: + + <program> Copyright (C) <year> <name of author> + 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 +<http://www.gnu.org/licenses/>. + + 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 +<http://www.gnu.org/philosophy/why-not-lgpl.html>. diff --git a/tutti-report-generator/README.txt b/tutti-report-generator/README.txt new file mode 100644 index 0000000..e69de29 diff --git a/tutti-report-generator/pom.xml b/tutti-report-generator/pom.xml new file mode 100644 index 0000000..dc9fbf8 --- /dev/null +++ b/tutti-report-generator/pom.xml @@ -0,0 +1,127 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + #%L + Tutti :: Report Generator + %% + Copyright (C) 2015 Ifremer + %% + 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 + <http://www.gnu.org/licenses/gpl-3.0.html>. + #L% + --> + +<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> + <modelVersion>4.0.0</modelVersion> + + <parent> + <groupId>fr.ifremer</groupId> + <artifactId>tutti</artifactId> + <version>3.13-SNAPSHOT</version> + </parent> + + <groupId>fr.ifremer.tutti</groupId> + <artifactId>tutti-report-generator</artifactId> + + <name>Tutti :: Report Generator</name> + + <properties> + + <maven.jar.main.class>fr.ifremer.tutti.report.RunReport</maven.jar.main.class> + </properties> + <dependencies> + + <!-- Birt --> + <dependency> + <groupId>org.eclipse.birt.runtime</groupId> + <artifactId>org.eclipse.birt.runtime</artifactId> + <classifier>codelutin</classifier> + </dependency> + + <!-- Test --> + <dependency> + <groupId>junit</groupId> + <artifactId>junit</artifactId> + <scope>test</scope> + </dependency> + <dependency> + <groupId>commons-logging</groupId> + <artifactId>commons-logging</artifactId> + <scope>test</scope> + </dependency> + <dependency> + <groupId>log4j</groupId> + <artifactId>log4j</artifactId> + <scope>test</scope> + </dependency> + + </dependencies> + + <build> + + <plugins> + + <plugin> + <artifactId>maven-jar-plugin</artifactId> + <configuration> + <archive> + <manifest> + <useUniqueVersions>false</useUniqueVersions> + <mainClass>${maven.jar.main.class}</mainClass> + <addClasspath>true</addClasspath> + <classpathPrefix>./lib/</classpathPrefix> + </manifest> + </archive> + </configuration> + </plugin> + + <!--plugin> + <artifactId>maven-dependency-plugin</artifactId> + <executions> + <execution> + <id>copy-dependencies</id> + <goals> + <goal>copy-dependencies</goal> + </goals> + <phase>prepare-package</phase> + <configuration> + <overWriteReleases>false</overWriteReleases> + <overWriteSnapshots>true</overWriteSnapshots> + <overWriteIfNewer>true</overWriteIfNewer> + <outputDirectory>${project.build.directory}/lib</outputDirectory> + <silent>true</silent> + </configuration> + </execution> + </executions> + </plugin--> + + <plugin> + <artifactId>maven-assembly-plugin</artifactId> + <executions> + <execution> + <id>make-assembly</id> + <phase>package</phase> + <goals> + <goal>single</goal> + </goals> + <configuration> + <descriptor>src/main/assembly/bin.xml</descriptor> + </configuration> + </execution> + </executions> + </plugin> + + </plugins> + </build> + +</project> diff --git a/tutti-report-generator/src/license/THIRD-PARTY.properties b/tutti-report-generator/src/license/THIRD-PARTY.properties new file mode 100644 index 0000000..ede81f2 --- /dev/null +++ b/tutti-report-generator/src/license/THIRD-PARTY.properties @@ -0,0 +1,36 @@ +# Generated by org.codehaus.mojo.license.AddThirdPartyMojo +#------------------------------------------------------------------------------- +# Already used licenses in project : +# - BSD License +# - COMMON DEVELOPMENT AND DISTRIBUTION LICENSE (CDDL) Version 1.0 +# - Eclipse Public License - v 1.0 +# - Eclipse Public License 1.0 +# - ICU License +# - Indiana University Extreme! Lab Software License, vesion 1.1.1 +# - Java HTML Tidy License +# - Lesser General Public License (LGPL) +# - Lesser General Public License (LPGL) +# - Lesser General Public License (LPGL) v 2.1 +# - MIT License +# - Mozilla Public License +# - New BSD License +# - The Apache Software License, Version 2.0 +#------------------------------------------------------------------------------- +# Please fill the missing licenses for dependencies : +# +# +#Wed Mar 11 09:10:14 CET 2015 +batik--batik-awt-util--1.6=The Apache Software License, Version 2.0 +batik--batik-bridge--1.6=The Apache Software License, Version 2.0 +batik--batik-css--1.6=The Apache Software License, Version 2.0 +batik--batik-dom--1.6=The Apache Software License, Version 2.0 +batik--batik-ext--1.6=The Apache Software License, Version 2.0 +batik--batik-gvt--1.6=The Apache Software License, Version 2.0 +batik--batik-parser--1.6=The Apache Software License, Version 2.0 +batik--batik-script--1.6=The Apache Software License, Version 2.0 +batik--batik-svg-dom--1.6=The Apache Software License, Version 2.0 +batik--batik-svggen--1.6=The Apache Software License, Version 2.0 +batik--batik-transcoder--1.6=The Apache Software License, Version 2.0 +batik--batik-util--1.6=The Apache Software License, Version 2.0 +batik--batik-xml--1.6=The Apache Software License, Version 2.0 +dom4j--dom4j--1.6.1=BSD License diff --git a/tutti-report-generator/src/main/assembly/bin.xml b/tutti-report-generator/src/main/assembly/bin.xml new file mode 100644 index 0000000..3828df6 --- /dev/null +++ b/tutti-report-generator/src/main/assembly/bin.xml @@ -0,0 +1,27 @@ +<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2 http://maven.apache.org/xsd/assembly-1.1.2.xsd"> + + <id>bin</id> + <formats> + <format>zip</format> + </formats> + + <includeBaseDirectory>false</includeBaseDirectory> + + <dependencySets> + <dependencySet> + <outputDirectory>lib</outputDirectory> + <useProjectArtifact>false</useProjectArtifact> + </dependencySet> + </dependencySets> + + <files> + <file> + <source>target/${project.build.finalName}.${project.packaging}</source> + <outputDirectory/> + <destName>${project.artifactId}.${project.packaging}</destName> + </file> + </files> + +</assembly> \ No newline at end of file diff --git a/tutti-report-generator/src/main/java/fr/ifremer/tutti/report/ReportConfig.java b/tutti-report-generator/src/main/java/fr/ifremer/tutti/report/ReportConfig.java new file mode 100644 index 0000000..2e3261b --- /dev/null +++ b/tutti-report-generator/src/main/java/fr/ifremer/tutti/report/ReportConfig.java @@ -0,0 +1,50 @@ +package fr.ifremer.tutti.report; + +import java.io.File; + +/** + * Created on 3/10/15. + * + * @author Tony Chemit - chemit@codelutin.com + * @since 3.13.2 + */ +public class ReportConfig { + + private final File reportFile; + + private final File dataDirectory; + + private final File outputFile; + + private final String stationNumber; + + private final int fishingOperationNumber; + + public ReportConfig(File reportFile, File dataDirectory, File outputFile, String stationNumber, int fishingOperationNumber) { + this.reportFile = reportFile; + this.dataDirectory = dataDirectory; + this.outputFile = outputFile; + this.stationNumber = stationNumber; + this.fishingOperationNumber = fishingOperationNumber; + } + + public File getReportFile() { + return reportFile; + } + + public File getDataDirectory() { + return dataDirectory; + } + + public String getStationNumber() { + return stationNumber; + } + + public int getFishingOperationNumber() { + return fishingOperationNumber; + } + + public File getOutputFile() { + return outputFile; + } +} diff --git a/tutti-report-generator/src/main/java/fr/ifremer/tutti/report/ReportEngine.java b/tutti-report-generator/src/main/java/fr/ifremer/tutti/report/ReportEngine.java new file mode 100644 index 0000000..ae028bf --- /dev/null +++ b/tutti-report-generator/src/main/java/fr/ifremer/tutti/report/ReportEngine.java @@ -0,0 +1,118 @@ +package fr.ifremer.tutti.report; + +import org.eclipse.birt.core.exception.BirtException; +import org.eclipse.birt.core.framework.Platform; +import org.eclipse.birt.report.engine.api.EngineConfig; +import org.eclipse.birt.report.engine.api.EngineConstants; +import org.eclipse.birt.report.engine.api.EngineException; +import org.eclipse.birt.report.engine.api.IRenderOption; +import org.eclipse.birt.report.engine.api.IReportEngine; +import org.eclipse.birt.report.engine.api.IReportEngineFactory; +import org.eclipse.birt.report.engine.api.IReportRunnable; +import org.eclipse.birt.report.engine.api.IRunAndRenderTask; +import org.eclipse.birt.report.engine.api.RenderOption; + +import java.io.Closeable; +import java.io.File; +import java.util.HashMap; +import java.util.Map; +import java.util.logging.Level; + +/** + * Created on 3/10/15. + * + * @author Tony Chemit - chemit@codelutin.com + * @since 3.13.2 + */ +public class ReportEngine implements Closeable { + + private static final int RENDER_DPI = 300; + + private final IReportEngine engine; + + public ReportEngine(File reportHomeDirectory, File reportLogDirectory) { + + EngineConfig engineConfig = new EngineConfig(); + engineConfig.setBIRTHome(reportHomeDirectory.getAbsolutePath()); + engineConfig.setResourcePath(reportHomeDirectory.getAbsolutePath()); + engineConfig.setLogConfig(reportLogDirectory.getAbsolutePath(), Level.ALL); + + try { + Platform.startup(engineConfig); + } catch (BirtException e) { + throw new RuntimeException("Could not init birt", e); + } + + IReportEngineFactory factory = (IReportEngineFactory) Platform.createFactoryObject(IReportEngineFactory.EXTENSION_REPORT_ENGINE_FACTORY); + + engine = factory.createReportEngine(engineConfig); + + } + + public void generate(ReportConfig reportConfig) { + + IReportRunnable rptDoc; + + try { + rptDoc = engine.openReportDesign(reportConfig.getReportFile().getAbsolutePath()); + } catch (EngineException e) { + + throw new RuntimeException("Could not get report " + reportConfig.getReportFile(), e); + + } + + /** + * rpt-param_dirfile : répertoire contant les fichiers + + rpt-param_codestation : code de la station (ex: G101) + + rpt-param_numerotrait : code du trait (ex: 53) + */ + + // Create the render task + IRunAndRenderTask task = engine.createRunAndRenderTask(rptDoc); + + try { + + // Configure the render options + IRenderOption renderOption = new RenderOption(); + renderOption.setOutputFileName(reportConfig.getOutputFile().getAbsolutePath()); + renderOption.setOutputFormat(IRenderOption.OUTPUT_FORMAT_PDF); + + task.setRenderOption(renderOption); + + // Report context + Map<String, Object> context = new HashMap<>(); + context.put(EngineConstants.APPCONTEXT_CHART_RESOLUTION, RENDER_DPI); + + task.setAppContext(context); + task.setParameterValue("rpt-param_dirfile", reportConfig.getDataDirectory().getAbsolutePath()); + task.setParameterValue("rpt-param_codestation", reportConfig.getStationNumber()); + task.setParameterValue("rpt-param_numerotrait", reportConfig.getFishingOperationNumber()); + + task.run(); + + } catch (EngineException e) { + + throw new RuntimeException("Could not execute report", e); + + } finally { + + // close task + task.close(); + + } + + } + + @Override + public void close() { + + try { + engine.destroy(); + } finally { + + Platform.shutdown(); + + } + + } +} diff --git a/tutti-report-generator/src/main/java/fr/ifremer/tutti/report/RunReport.java b/tutti-report-generator/src/main/java/fr/ifremer/tutti/report/RunReport.java new file mode 100644 index 0000000..4b00979 --- /dev/null +++ b/tutti-report-generator/src/main/java/fr/ifremer/tutti/report/RunReport.java @@ -0,0 +1,47 @@ +package fr.ifremer.tutti.report; + +import java.io.File; + +/** + * Created on 3/10/15. + * + * @author Tony Chemit - chemit@codelutin.com + * @since 3.13.2 + */ +public class RunReport { + + public static void main(String... args) { + + if (args.length != 7) { + + String help = RunReport.class.getName() + " requires 6 arguments:" + + "\n\tReport Home directory" + + "\n\tReport Log directory" + + "\n\tReport file to use" + + "\n\tOutput file to generate" + + "\n\trpt-param_dirfile : répertoire contant les fichiers de données" + + "\n\trpt-param_codestation : code de la station (ex: G101)" + + "\n\trpt-param_numerotrait : code du trait (ex: 53)"; + + throw new IllegalArgumentException(help); + } + + File reportHomeDirectory = new File(args[0]); + File reportLogDirectory = new File(args[1]); + File reportFile = new File(args[2]); + File outputFile = new File(args[3]); + File dataDirectory = new File(args[4]); + String stationNumber = args[5]; + int fishingOperationNumber = Integer.valueOf(args[6]); + + ReportConfig model = new ReportConfig(reportFile, dataDirectory, outputFile, stationNumber, fishingOperationNumber); + + try (ReportEngine engine = new ReportEngine(reportHomeDirectory, reportLogDirectory)) { + + engine.generate(model); + + } + + } + +} diff --git a/tutti-service/pom.xml b/tutti-service/pom.xml index d89e841..7a19cc1 100644 --- a/tutti-service/pom.xml +++ b/tutti-service/pom.xml @@ -243,6 +243,34 @@ </executions> </plugin> + <plugin> + <artifactId>maven-dependency-plugin</artifactId> + <executions> + <execution> + <id>get-report-generator-env</id> + <phase>prepare-package</phase> + <goals> + <goal>unpack</goal> + </goals> + <configuration> + <outputDirectory> + ${project.build.directory}/tutti-report-generator + </outputDirectory> + <artifactItems> + <artifactItem> + <groupId>${project.groupId}</groupId> + <artifactId>tutti-report-generator</artifactId> + <version>${project.version}</version> + <type>zip</type> + <classifier>bin</classifier> + </artifactItem> + </artifactItems> + </configuration> + </execution> + + </executions> + </plugin> + </plugins> </build> diff --git a/tutti-service/src/main/java/fr/ifremer/tutti/service/report/ReportGenerationContext.java b/tutti-service/src/main/java/fr/ifremer/tutti/service/report/ReportGenerationContext.java new file mode 100644 index 0000000..56921e1 --- /dev/null +++ b/tutti-service/src/main/java/fr/ifremer/tutti/service/report/ReportGenerationContext.java @@ -0,0 +1,67 @@ +package fr.ifremer.tutti.service.report; + +import fr.ifremer.tutti.persistence.entities.data.FishingOperation; + +import java.io.File; + +/** + * Context of report generation. + * + * Created on 3/11/15. + * + * @author Tony Chemit - chemit@codelutin.com + * @since 3.13.2 + */ +public class ReportGenerationContext { + + /** + * Incoming report request. + */ + protected final ReportGenerationRequest request; + + /** + * Selected fishing operation. + */ + protected final FishingOperation fishingOperation; + + /** + * Where export is exploded. + */ + protected final File exportDirectory; + + /** + * Where to generate report. + */ + protected final File outputFile; + + public ReportGenerationContext(ReportGenerationRequest request, + FishingOperation fishingOperation, + File exportFileDirectory, + File outputFile) { + this.request = request; + this.fishingOperation = fishingOperation; + this.exportDirectory = exportFileDirectory; + this.outputFile = outputFile; + } + + public File getReport() { + return request.getReport(); + } + + public File getExportDirectory() { + return exportDirectory; + } + + public FishingOperation getFishingOperation() { + return fishingOperation; + } + + public File getOutputFile() { + return outputFile; + } + + public ReportGenerationResult toResult() { + return new ReportGenerationResult(request, outputFile); + } + +} diff --git a/tutti-service/src/main/java/fr/ifremer/tutti/service/report/ReportGenerationRequest.java b/tutti-service/src/main/java/fr/ifremer/tutti/service/report/ReportGenerationRequest.java new file mode 100644 index 0000000..3916416 --- /dev/null +++ b/tutti-service/src/main/java/fr/ifremer/tutti/service/report/ReportGenerationRequest.java @@ -0,0 +1,54 @@ +package fr.ifremer.tutti.service.report; + +import java.io.File; +import java.io.Serializable; + +/** + * Request to generate a report. + * + * Created on 3/11/15. + * + * @author Tony Chemit - chemit@codelutin.com + * @since 3.13.2 + */ +public class ReportGenerationRequest implements Serializable { + + private static final long serialVersionUID = 1L; + + /** Report to use. */ + protected File report; + + /** + * Selected cruise id (of fishing operation). + */ + protected String cruiseId; + + /** + * Selected fishing operation to report. + */ + protected String fishingOperationId; + + public File getReport() { + return report; + } + + public void setReport(File report) { + this.report = report; + } + + public String getCruiseId() { + return cruiseId; + } + + public void setCruiseId(String cruiseId) { + this.cruiseId = cruiseId; + } + + public String getFishingOperationId() { + return fishingOperationId; + } + + public void setFishingOperationId(String fishingOperationId) { + this.fishingOperationId = fishingOperationId; + } +} diff --git a/tutti-service/src/main/java/fr/ifremer/tutti/service/report/ReportGenerationResult.java b/tutti-service/src/main/java/fr/ifremer/tutti/service/report/ReportGenerationResult.java new file mode 100644 index 0000000..ccebd0f --- /dev/null +++ b/tutti-service/src/main/java/fr/ifremer/tutti/service/report/ReportGenerationResult.java @@ -0,0 +1,49 @@ +package fr.ifremer.tutti.service.report; + +import java.io.File; +import java.io.Serializable; + +/** + * Result of a report generation. + * + * Created on 3/11/15. + * + * @author Tony Chemit - chemit@codelutin.com + * @since 3.13.2 + */ +public class ReportGenerationResult implements Serializable{ + + private static final long serialVersionUID = 1L; + + /** + * Incoming request. + */ + protected final ReportGenerationRequest request; + + /** + * Where was generated the report. + */ + protected final File outputFile; + + public ReportGenerationResult(ReportGenerationRequest request, File outputFile) { + this.request = request; + this.outputFile = outputFile; + } + + public File getReport() { + return request.getReport(); + } + + public String getCruiseId() { + return request.getCruiseId(); + } + + public String getFishingOperationId() { + return request.getFishingOperationId(); + } + + public File getOutputFile() { + return outputFile; + } + +} diff --git a/tutti-service/src/main/java/fr/ifremer/tutti/service/report/ReportGenerationService.java b/tutti-service/src/main/java/fr/ifremer/tutti/service/report/ReportGenerationService.java new file mode 100644 index 0000000..befa8ce --- /dev/null +++ b/tutti-service/src/main/java/fr/ifremer/tutti/service/report/ReportGenerationService.java @@ -0,0 +1,169 @@ +package fr.ifremer.tutti.service.report; + +import com.google.common.base.Preconditions; +import com.google.common.collect.Lists; +import fr.ifremer.tutti.TuttiConfiguration; +import fr.ifremer.tutti.persistence.ProgressionModel; +import fr.ifremer.tutti.persistence.entities.data.FishingOperation; +import fr.ifremer.tutti.service.AbstractTuttiService; +import fr.ifremer.tutti.service.PersistenceService; +import fr.ifremer.tutti.service.export.generic.TuttiExportService; +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; +import org.nuiton.jaxx.application.ApplicationTechnicalException; + +import java.io.File; +import java.io.FileFilter; +import java.io.IOException; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.List; + +import static org.nuiton.i18n.I18n.t; + +/** + * Created on 3/11/15. + * + * @author Tony Chemit - chemit@codelutin.com + * @since 3.13.2 + */ +public class ReportGenerationService extends AbstractTuttiService { + + private static final Log log = LogFactory.getLog(ReportGenerationService.class); + + private static final FileFilter REPORT_FILTER = new FileFilter() { + @Override + public boolean accept(File pathname) { + return pathname.isFile() && + pathname.getName().endsWith(".rptdesign"); + } + }; + + public List<File> getAvailableReports() { + List<File> result = Lists.newArrayList(); + File reportDirectory = context.getConfig().getReportDirectory(); + File[] files = reportDirectory.listFiles(REPORT_FILTER); + if (files != null) { + result.addAll(Arrays.asList(files)); + } + return result; + } + + public ReportGenerationResult generateReport(ReportGenerationRequest request, ProgressionModel progressionModel) { + + Preconditions.checkNotNull(request); + Preconditions.checkNotNull(request.getReport()); + Preconditions.checkState(request.getReport().exists()); + Preconditions.checkNotNull(request.getCruiseId()); + Preconditions.checkNotNull(request.getFishingOperationId()); + + // load fishing operation + progressionModel.increments(t("tutti.report.step.load.fishingOperation")); + FishingOperation operation = getService(PersistenceService.class). + getFishingOperation(request.getFishingOperationId()); + + // export fishing operation + progressionModel.increments(t("tutti.report.step.export.fishingOperation")); + File exportDirectory = getService(TuttiExportService.class). + exportFishingOperation(request.getCruiseId(), + request.getFishingOperationId()); + + File outputFile = newOutputFile(); + + ReportGenerationContext reportContext = new ReportGenerationContext(request, + operation, + exportDirectory, + outputFile); + + progressionModel.increments(t("tutti.report.step.generateReport", request.getReport().getName())); + + ReportGenerationResult result = generateReport(reportContext); + return result; + + } + + protected File newOutputFile() { + return context.getConfig().newTempFile("tutti-report", ".pdf"); + } + + protected ReportGenerationResult generateReport(ReportGenerationContext reportContext) { + + Preconditions.checkNotNull(reportContext.getFishingOperation()); + Preconditions.checkNotNull(reportContext.getExportDirectory()); + Preconditions.checkState(reportContext.getExportDirectory().exists()); + + if (log.isInfoEnabled()) { + log.info("Will generate report using report " + reportContext.getReport().getName()); + } + + List<String> arguments = prepareCall(reportContext); + + ProcessBuilder pb = new ProcessBuilder(arguments); + + pb.inheritIO(); + + if (log.isInfoEnabled()) { + log.info("Starts java command: " + arguments); + } + + try { + + int exitCode = pb.start().waitFor(); + + if (log.isDebugEnabled()) { + log.debug("Exit Code: " + exitCode); + } + + if (exitCode != 0) { + throw new ApplicationTechnicalException("Report execution failed, see the report log directory " + context.getConfig().getReportLogDirectory()); + } + + } catch (InterruptedException | IOException e) { + throw new ApplicationTechnicalException("Could not generate report", e); + } + + if (log.isInfoEnabled()) { + log.info("Report generated at: " + reportContext.getOutputFile()); + } + + ReportGenerationResult result = reportContext.toResult(); + return result; + + } + + protected List<String> prepareCall(ReportGenerationContext reportContext) { + + TuttiConfiguration config = context.getConfig(); + + List<String> command = new ArrayList<>(); + + command.add(config.getJavaCommandPath()); + + // jvm options + command.add("-XX:MaxPermSize=128M"); + command.add("-XX:PermSize=64M"); + command.add("-XX:MaxNewSize=32M"); + command.add("-XX:NewSize=32M"); + command.add("-Xms256m"); + command.add("-Xmx1024m"); + + //command.add("-agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=8000"); + + command.add("-jar"); + command.add(config.getReportJarPath().getAbsolutePath()); + + // arguments + + command.add(config.getReportHomeDirectory().getAbsolutePath()); + command.add(config.getReportLogDirectory().getAbsolutePath()); + command.add(reportContext.getReport().getAbsolutePath()); + command.add(reportContext.getOutputFile().getAbsolutePath()); + command.add(reportContext.getExportDirectory().getAbsolutePath()); + command.add(reportContext.getFishingOperation().getStationNumber()); + command.add(reportContext.getFishingOperation().getFishingOperationNumber().toString()); + + return command; + + } + +} diff --git a/tutti-service/src/test/java/fr/ifremer/tutti/service/report/ReportGenerationServiceTest.java b/tutti-service/src/test/java/fr/ifremer/tutti/service/report/ReportGenerationServiceTest.java new file mode 100644 index 0000000..5dd9ce3 --- /dev/null +++ b/tutti-service/src/test/java/fr/ifremer/tutti/service/report/ReportGenerationServiceTest.java @@ -0,0 +1,119 @@ +package fr.ifremer.tutti.service.report; + +import fr.ifremer.tutti.TuttiConfiguration; +import fr.ifremer.tutti.persistence.ProgressionModel; +import fr.ifremer.tutti.persistence.entities.data.FishingOperation; +import fr.ifremer.tutti.persistence.entities.data.FishingOperations; +import fr.ifremer.tutti.service.ServiceDbResource; +import fr.ifremer.tutti.service.TuttiServiceContext; +import org.apache.commons.logging.Log; +import org.apache.commons.logging.LogFactory; +import org.junit.Assert; +import org.junit.Assume; +import org.junit.Before; +import org.junit.ClassRule; +import org.junit.Test; +import org.nuiton.jaxx.application.ApplicationIOUtil; +import org.nuiton.util.FileUtil; + +import java.io.File; +import java.util.List; + +/** + * Created on 3/11/15. + * + * @author Tony Chemit - chemit@codelutin.com + * @since 3.13.2 + */ +public class ReportGenerationServiceTest { + + @ClassRule + public static final ServiceDbResource dbResource = ServiceDbResource.noDb(); + + /** Logger. */ + private static final Log log = LogFactory.getLog(ReportGenerationServiceTest.class); + + public static final String PROGRAM_ID = "CAM-MEDITS"; + + public static final String CRUISE_ID = "100001"; + + public static final String OPERATION_1_ID = "100106"; + + protected ReportGenerationService service; + + @Before + public void setUp() throws Exception { + + TuttiServiceContext serviceContext = dbResource.getServiceContext(); + + service = serviceContext.getService(ReportGenerationService.class); + + File reportJarPath = FileUtil.getFileFromPaths(new File("target"), "tutti-report-generator", "tutti-report-generator.jar"); + Assume.assumeTrue("Could not find " + reportJarPath, reportJarPath.exists()); + TuttiConfiguration config = dbResource.getConfig(); + + config.setReportJarPath(reportJarPath); + + config.getReportLogDirectory().mkdirs(); + + } + + @Test + public void testGenerateReportFromExport() throws Exception { + + // copy report resources from class-path + File sourceDirectory = FileUtil.getFileFromPaths(new File("src"), "test", "resources", "report", "2013.12.05"); + File targetDirectory = dbResource.getConfig().getReportHomeDirectory(); + if (log.isInfoEnabled()) { + log.info("Prepare report birt home at " + targetDirectory); + } + ApplicationIOUtil.copyDirectory(sourceDirectory, targetDirectory, "Could not copy report directory"); + + // copy export resources from class-path + File exportSourceDirectory = FileUtil.getFileFromPaths(new File("src"), "test", "resources", "report", "exportCruise"); + File exportTargetDirectory = dbResource.getConfig().newTempFile("exportCruise"); + if (log.isInfoEnabled()) { + log.info("Prepare export at " + exportTargetDirectory); + } + ApplicationIOUtil.copyDirectory(exportSourceDirectory, exportTargetDirectory, "Could not copy report directory"); + + // get reports + List<File> availableReports = service.getAvailableReports(); + Assert.assertNotNull(availableReports); + Assert.assertFalse(availableReports.isEmpty()); + Assert.assertEquals(1, availableReports.size()); + + // get unique report file + File reportFileName = availableReports.get(0); + + ReportGenerationRequest request = new ReportGenerationRequest(); + request.setReport(reportFileName); + request.setCruiseId(CRUISE_ID); + request.setFishingOperationId(OPERATION_1_ID); + + ProgressionModel progressionModel = new ProgressionModel(); + progressionModel.setTotal(3); + + FishingOperation fishingOperation = FishingOperations.newFishingOperation(); + fishingOperation.setId(OPERATION_1_ID); + fishingOperation.setFishingOperationNumber(53); + fishingOperation.setStationNumber("G101"); + + File outputFile = service.newOutputFile(); + + // report NOT must exist + Assert.assertFalse(outputFile.exists()); + + ReportGenerationContext reportContext = new ReportGenerationContext(request, + fishingOperation, + exportTargetDirectory, + outputFile); + + // generate report + ReportGenerationResult result = service.generateReport(reportContext); + + // report must exist + Assert.assertTrue(result.getOutputFile().exists()); + } + +} diff --git a/tutti-ui-swing/pom.xml b/tutti-ui-swing/pom.xml index 1b03644..3345023 100644 --- a/tutti-ui-swing/pom.xml +++ b/tutti-ui-swing/pom.xml @@ -434,6 +434,29 @@ <silent>true</silent> </configuration> </execution> + + <execution> + <id>get-report-generator-env</id> + <phase>prepare-package</phase> + <goals> + <goal>unpack</goal> + </goals> + <configuration> + <outputDirectory> + ${project.build.directory}/tutti-report-generator + </outputDirectory> + <artifactItems> + <artifactItem> + <groupId>${project.groupId}</groupId> + <artifactId>tutti-report-generator</artifactId> + <version>${project.version}</version> + <type>zip</type> + <classifier>bin</classifier> + </artifactItem> + </artifactItems> + </configuration> + </execution> + </executions> </plugin> diff --git a/tutti-ui-swing/src/license/THIRD-PARTY.properties b/tutti-ui-swing/src/license/THIRD-PARTY.properties index 98174e1..d4a4d02 100644 --- a/tutti-ui-swing/src/license/THIRD-PARTY.properties +++ b/tutti-ui-swing/src/license/THIRD-PARTY.properties @@ -12,7 +12,6 @@ # - Common Development and Distribution License (CDDL) v1.0 # - Eclipse Distribution License (EDL), Version 1.0 # - Eclipse Public License (EPL), Version 1.0 -# - Eclipse Public License - v 1.0 # - Eclipse Public License 1.0 # - GNU Affero General Public License v3 # - GNU General Public License (GPL) @@ -23,14 +22,11 @@ # - GNU Lesser Public License # - GNU Library or Lesser General Public License # - General Public License (GPL) -# - ICU License -# - Java HTML Tidy License # - LGPL 2.1 # - Lesser General Public License (LGPL) # - Lesser General Public License (LGPL) v 3.0 # - MIT License # - MPL 1.1 -# - Mozilla Public License # - Mozilla Public License version 1.1 # - New BSD License # - Public Domain @@ -41,7 +37,7 @@ # Please fill the missing licenses for dependencies : # # -#Thu Jan 15 14:23:58 CET 2015 +#Tue Mar 10 22:51:39 CET 2015 commons-codec--commons-codec--1.2=The Apache Software License, Version 2.0 commons-primitives--commons-primitives--1.0=The Apache Software License, Version 2.0 dom4j--dom4j--1.6.1=BSD License diff --git a/tutti-ui-swing/src/main/assembly/full-shared-component.xml b/tutti-ui-swing/src/main/assembly/full-shared-component.xml index 23e736a..5e0123f 100644 --- a/tutti-ui-swing/src/main/assembly/full-shared-component.xml +++ b/tutti-ui-swing/src/main/assembly/full-shared-component.xml @@ -91,6 +91,14 @@ </excludes> </fileSet> + <fileSet> + <directory>target/tutti-report-generator</directory> + <outputDirectory>tutti/report-generator</outputDirectory> + <includes> + <include>**</include> + </includes> + </fileSet> + <!-- I18N component --> <fileSet> <directory>target/classes/META-INF</directory> diff --git a/tutti-ui-swing/src/main/assembly/standalone.xml b/tutti-ui-swing/src/main/assembly/standalone.xml index ad0701b..0c08a28 100644 --- a/tutti-ui-swing/src/main/assembly/standalone.xml +++ b/tutti-ui-swing/src/main/assembly/standalone.xml @@ -69,6 +69,14 @@ </fileSet> <fileSet> + <directory>target/tutti-report-generator</directory> + <outputDirectory>report-generator</outputDirectory> + <includes> + <include>**</include> + </includes> + </fileSet> + + <fileSet> <directory>src/main/assembly/standalone</directory> <outputDirectory/> <filtered>true</filtered> diff --git a/tutti-ui-swing/src/main/java/fr/ifremer/tutti/ui/swing/TuttiUIContext.java b/tutti-ui-swing/src/main/java/fr/ifremer/tutti/ui/swing/TuttiUIContext.java index 7a91e01..1ca4210 100644 --- a/tutti-ui-swing/src/main/java/fr/ifremer/tutti/ui/swing/TuttiUIContext.java +++ b/tutti-ui-swing/src/main/java/fr/ifremer/tutti/ui/swing/TuttiUIContext.java @@ -54,6 +54,7 @@ import fr.ifremer.tutti.service.referential.ReferentialTemporaryPersonService; import fr.ifremer.tutti.service.referential.ReferentialTemporarySpeciesService; import fr.ifremer.tutti.service.referential.ReferentialTemporaryVesselService; import fr.ifremer.tutti.service.referential.TuttiReferentialSynchronizeService; +import fr.ifremer.tutti.service.report.ReportGenerationService; import fr.ifremer.tutti.service.report.ReportService; import fr.ifremer.tutti.ui.swing.content.MainUI; import fr.ifremer.tutti.ui.swing.updater.DeleteHelper; @@ -85,6 +86,7 @@ import org.nuiton.jaxx.application.ApplicationTechnicalException; import org.nuiton.jaxx.application.listener.PropagatePropertyChangeListener; import org.nuiton.jaxx.application.swing.ApplicationUIContext; import org.nuiton.jaxx.application.swing.action.ApplicationActionEngine; +import org.nuiton.jaxx.application.swing.action.ApplicationActionFactory; import org.nuiton.jaxx.application.swing.action.ApplicationActionUI; import org.nuiton.jaxx.application.swing.action.ApplicationUIAction; import org.nuiton.jaxx.application.swing.util.ApplicationErrorHelper; @@ -358,12 +360,7 @@ public class TuttiUIContext extends AbstractBean implements Closeable, UIMessage @Override public void showErrorDialog(String message, Throwable cause) { - if (actionUI != null) { - actionUI.close(); - actionUI.dispose(); - } super.showErrorDialog(message, cause); - } }; this.dataContext = serviceContext.getDataContext(); @@ -755,6 +752,10 @@ public class TuttiUIContext extends AbstractBean implements Closeable, UIMessage return serviceContext.getService(FishingOperationImportService.class); } + public ReportGenerationService getReportGenerationService() { + return serviceContext.getService(ReportGenerationService.class); + } + public ReportService getReportService() { return serviceContext.getService(ReportService.class); } @@ -984,7 +985,7 @@ public class TuttiUIContext extends AbstractBean implements Closeable, UIMessage } @Override - public TuttiActionFactory getActionFactory() { + public ApplicationActionFactory getActionFactory() { return tuttiActionFactory; } -- To stop receiving notification emails like this one, please contact codelutin.com SCM administrator <admin+scm@codelutin.com>.