diff --git a/.gitignore b/.gitignore index a1fc39c..035dc75 100644 --- a/.gitignore +++ b/.gitignore @@ -12,3 +12,7 @@ gradle-app.setting # # Work around https://youtrack.jetbrains.com/issue/IDEA-116898 # gradle/wrapper/gradle-wrapper.properties +/bin/ +.classpath +.project +.settings/ \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..ca0e480 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,14 @@ +# Change Log +All notable changes to this project will be documented in this file. + +## [Unreleased] + +### Add +- foo +- boo + +### Changed + +### Fixed + +[Unreleased]: https://github.com/miurahr/omegat-plugin-skelton/compare/v0.1...HEAD diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..94a9ed0 --- /dev/null +++ b/COPYING @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..bf0b4f9 --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ +# OMT OmegaT Package Plugin + + + +## Test report + +You will find a test results report at `build/reports/` and can show it with your favorite web browser. + +## Installation + +You can get a plugin jar file from zip/tgz distribution file. +OmegaT plugin should be placed in `$HOME/.omegat/plugin` or `C:\Program Files\OmegaT\plugin` +depending on your operating system. + +## License + +This project is distributed under the GNU general public license version 3 or later. + diff --git a/build.gradle b/build.gradle new file mode 100644 index 0000000..fc496ed --- /dev/null +++ b/build.gradle @@ -0,0 +1,113 @@ +plugins { + id 'java' + id 'findbugs' + id 'checkstyle' + id 'distribution' + id 'maven' + id 'idea' +} + +repositories { + maven { + url "https://dl.bintray.com/omegat-org/maven" + } + jcenter() +} + +def compileDependencies = [ + 'org.omegat:omegat:4.1.3-02', + 'commons-io:commons-io:2.4', + 'commons-lang:commons-lang:2.6' +] + +def testDependencies = [ + 'junit:junit:4.12', + 'xmlunit:xmlunit:1.6', + 'org.madlonkay.supertmxmerge:supertmxmerge:2.0.1' +] + +dependencies { + + compileDependencies.each { + compileOnly it + testImplementation it + } + + testDependencies.each { + testImplementation it + } +} + + +tasks.withType(JavaCompile) { + options.compilerArgs << "-Xlint:deprecation" << "-Xlint:unchecked" +} + +jar { + manifest { + // plugin's main class name is defined in gradle.properties file. + attributes( + "OmegaT-Plugins": pluginMainClass, + "Plugin-Version": pluginVersion, + "Plugin-Name": pluginName + ) + } +} + +/* Checkstyle */ +checkstyle { + config = resources.text.fromFile("${rootProject.projectDir}/config/checkstyle/checkstyle.xml") + ignoreFailures = true + toolVersion = '7.1' + sourceSets = [project.sourceSets.main] +} +tasks.checkstyleMain.setGroup('Verification') +tasks.remove(tasks['checkstyleTest']) + +/* FindBugs */ +findbugs { + ignoreFailures = true + sourceSets = [project.sourceSets.main] +} + +tasks.withType(FindBugs) { + setGroup('Verification') + reports { + xml.enabled = false + html.enabled = true + } +} +tasks.remove(tasks['findbugsTest']) + +artifacts { + archives jar +} + +distTar { + compression = Compression.GZIP +} + +distributions { + main { + contents { + from('README.md', 'COPYING') + into('docs') { + from 'CHANGELOG.md' + } + + from(jar) { + into 'plugin' + } + } + } +} + +task deployOmegaT(type: Copy) { + + from 'build/install/plugin-omt-package/plugin' + into omegatDir + include('*.jar') + +} + +installDist.dependsOn deployOmegaT diff --git a/config/checkstyle/checkstyle.xml b/config/checkstyle/checkstyle.xml new file mode 100644 index 0000000..de9a3d6 --- /dev/null +++ b/config/checkstyle/checkstyle.xml @@ -0,0 +1,188 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/config/checkstyle/header.txt b/config/checkstyle/header.txt new file mode 100644 index 0000000..9d522ad --- /dev/null +++ b/config/checkstyle/header.txt @@ -0,0 +1,25 @@ +/************************************************************************** + OmegaT - Computer Assisted Translation (CAT) tool + with fuzzy matching, translation memory, keyword search, + glossaries, and translation leveraging into updated projects. + + Copyright (C) 2016 Hiroshi Miura + Home page: http://www.omegat.org/ + Support center: http://groups.yahoo.com/group/OmegaT/ + + This file is part of OmegaT. + + OmegaT 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. + + OmegaT 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 . + **************************************************************************/ + diff --git a/gradle.properties b/gradle.properties new file mode 100644 index 0000000..85f32da --- /dev/null +++ b/gradle.properties @@ -0,0 +1,5 @@ +pluginMainClass=net.briac.omegat.plugin.omt.ManageOMTPackage +pluginName=OMT Package Plugin +pluginVersion=1.0 + +omegatDir=C:/Users/briac/AppData/Roaming/OmegaT/plugins/ \ No newline at end of file diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..29953ea Binary files /dev/null and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..82c45bf --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,6 @@ +#Fri Mar 08 21:45:51 CET 2019 +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-4.10.2-all.zip diff --git a/gradlew b/gradlew new file mode 100644 index 0000000..27309d9 --- /dev/null +++ b/gradlew @@ -0,0 +1,164 @@ +#!/usr/bin/env bash + +############################################################################## +## +## Gradle start up script for UN*X +## +############################################################################## + +# Attempt to set APP_HOME +# Resolve links: $0 may be a link +PRG="$0" +# Need this for relative symlinks. +while [ -h "$PRG" ] ; do + ls=`ls -ld "$PRG"` + link=`expr "$ls" : '.*-> \(.*\)$'` + if expr "$link" : '/.*' > /dev/null; then + PRG="$link" + else + PRG=`dirname "$PRG"`"/$link" + fi +done +SAVED="`pwd`" +cd "`dirname \"$PRG\"`/" >/dev/null +APP_HOME="`pwd -P`" +cd "$SAVED" >/dev/null + +APP_NAME="Gradle" +APP_BASE_NAME=`basename "$0"` + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS="" + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD="maximum" + +warn ( ) { + echo "$*" +} + +die ( ) { + echo + echo "$*" + echo + exit 1 +} + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "`uname`" in + CYGWIN* ) + cygwin=true + ;; + Darwin* ) + darwin=true + ;; + MINGW* ) + msys=true + ;; + NONSTOP* ) + nonstop=true + ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD="$JAVA_HOME/jre/sh/java" + else + JAVACMD="$JAVA_HOME/bin/java" + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD="java" + which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." +fi + +# Increase the maximum file descriptors if we can. +if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then + MAX_FD_LIMIT=`ulimit -H -n` + if [ $? -eq 0 ] ; then + if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then + MAX_FD="$MAX_FD_LIMIT" + fi + ulimit -n $MAX_FD + if [ $? -ne 0 ] ; then + warn "Could not set maximum file descriptor limit: $MAX_FD" + fi + else + warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" + fi +fi + +# For Darwin, add options to specify how the application appears in the dock +if $darwin; then + GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" +fi + +# For Cygwin, switch paths to Windows format before running java +if $cygwin ; then + APP_HOME=`cygpath --path --mixed "$APP_HOME"` + CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` + JAVACMD=`cygpath --unix "$JAVACMD"` + + # We build the pattern for arguments to be converted via cygpath + ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` + SEP="" + for dir in $ROOTDIRSRAW ; do + ROOTDIRS="$ROOTDIRS$SEP$dir" + SEP="|" + done + OURCYGPATTERN="(^($ROOTDIRS))" + # Add a user-defined pattern to the cygpath arguments + if [ "$GRADLE_CYGPATTERN" != "" ] ; then + OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" + fi + # Now convert the arguments - kludge to limit ourselves to /bin/sh + i=0 + for arg in "$@" ; do + CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` + CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option + + if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition + eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` + else + eval `echo args$i`="\"$arg\"" + fi + i=$((i+1)) + done + case $i in + (0) set -- ;; + (1) set -- "$args0" ;; + (2) set -- "$args0" "$args1" ;; + (3) set -- "$args0" "$args1" "$args2" ;; + (4) set -- "$args0" "$args1" "$args2" "$args3" ;; + (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; + (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; + (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; + (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; + (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; + esac +fi + +# Split up the JVM_OPTS And GRADLE_OPTS values into an array, following the shell quoting and substitution rules +function splitJvmOpts() { + JVM_OPTS=("$@") +} +eval splitJvmOpts $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS +JVM_OPTS[${#JVM_OPTS[*]}]="-Dorg.gradle.appname=$APP_BASE_NAME" + +exec "$JAVACMD" "${JVM_OPTS[@]}" -classpath "$CLASSPATH" org.gradle.wrapper.GradleWrapperMain "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 0000000..832fdb6 --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,90 @@ +@if "%DEBUG%" == "" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%" == "" set DIRNAME=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS= + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if "%ERRORLEVEL%" == "0" goto init + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto init + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:init +@rem Get command-line arguments, handling Windows variants + +if not "%OS%" == "Windows_NT" goto win9xME_args +if "%@eval[2+2]" == "4" goto 4NT_args + +:win9xME_args +@rem Slurp the command line arguments. +set CMD_LINE_ARGS= +set _SKIP=2 + +:win9xME_args_slurp +if "x%~1" == "x" goto execute + +set CMD_LINE_ARGS=%* +goto execute + +:4NT_args +@rem Get arguments from the 4NT Shell from JP Software +set CMD_LINE_ARGS=%$ + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% + +:end +@rem End local scope for the variables with windows NT shell +if "%ERRORLEVEL%"=="0" goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 +exit /b 1 + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/settings.gradle b/settings.gradle new file mode 100644 index 0000000..ca2ea8f --- /dev/null +++ b/settings.gradle @@ -0,0 +1 @@ +rootProject.name = 'plugin-omt-package' \ No newline at end of file diff --git a/src/main/java/net/briac/omegat/plugin/omt/ChooseOmtProject.java b/src/main/java/net/briac/omegat/plugin/omt/ChooseOmtProject.java new file mode 100644 index 0000000..0559b99 --- /dev/null +++ b/src/main/java/net/briac/omegat/plugin/omt/ChooseOmtProject.java @@ -0,0 +1,42 @@ +package net.briac.omegat.plugin.omt; + +import org.omegat.util.OStrings; +import org.omegat.util.Preferences; + +import javax.swing.*; +import javax.swing.filechooser.FileFilter; +import java.io.File; +import java.util.Locale; + +@SuppressWarnings("serial") +public final class ChooseOmtProject extends JFileChooser { + public ChooseOmtProject() { + super(Preferences.getPreference(Preferences.CURRENT_FOLDER)); + + setMultiSelectionEnabled(false); + setFileHidingEnabled(true); + setFileSelectionMode(FILES_ONLY); + setDialogTitle(OStrings.getString("PP_OMT_OPEN")); + setAcceptAllFileFilterUsed(false); + addChoosableFileFilter(new FileFilter() { + + @Override + public String getDescription() { + return OStrings.getString("PP_OMT_OPEN_FILTER"); + } + + @Override + public boolean accept(File f) { + return f.isFile() && f.getName().toLowerCase(Locale.ENGLISH).endsWith(ManageOMTPackage.OMT_EXTENSION); + } + }); + } + + @Override + public boolean accept(File f) { + if (f.isDirectory()) { + return true; + } + return f.isFile() && f.getName().toLowerCase(Locale.ENGLISH).endsWith(ManageOMTPackage.OMT_EXTENSION); + } +} diff --git a/src/main/java/net/briac/omegat/plugin/omt/ManageOMTPackage.java b/src/main/java/net/briac/omegat/plugin/omt/ManageOMTPackage.java new file mode 100644 index 0000000..7ec5ead --- /dev/null +++ b/src/main/java/net/briac/omegat/plugin/omt/ManageOMTPackage.java @@ -0,0 +1,278 @@ +package net.briac.omegat.plugin.omt; + +import org.apache.commons.io.FileUtils; +import org.omegat.core.Core; +import org.omegat.core.CoreEvents; +import org.omegat.core.data.ProjectProperties; +import org.omegat.core.events.IApplicationEventListener; +import org.omegat.gui.main.IMainMenu; +import org.omegat.gui.main.IMainWindow; +import org.omegat.gui.main.ProjectUICommands; +import org.omegat.util.Log; +import org.omegat.util.OConsts; +import org.omegat.util.gui.OmegaTFileChooser; +import org.omegat.util.gui.UIThreadsUtil; +import org.openide.awt.Mnemonics; + +import javax.swing.*; +import java.awt.*; +import java.io.*; +import java.nio.file.DirectoryStream; +import java.nio.file.Files; +import java.nio.file.Path; +import java.nio.file.Paths; +import java.util.Enumeration; +import java.util.Locale; +import java.util.zip.ZipEntry; +import java.util.zip.ZipFile; +import java.util.zip.ZipOutputStream; + +import static org.omegat.core.Core.getMainWindow; + +public class ManageOMTPackage { + + public static final String OMT_EXTENSION = ".omt"; + private static JMenuItem importOMT; + private static JMenuItem exportOMT; + + public static void loadPlugins() { + + CoreEvents.registerProjectChangeListener(e -> onProjectStatusChanged(Core.getProject().isProjectLoaded())); + + CoreEvents.registerApplicationEventListener(new IApplicationEventListener() { + @Override + public void onApplicationStartup() { + IMainMenu menu = getMainWindow().getMainMenu(); + JMenu projectMenu = menu.getProjectMenu(); + + importOMT = new JMenuItem(); + Mnemonics.setLocalizedText(importOMT, "Import OMT Package..."); + importOMT.addActionListener(e -> { + projectImportOMT(); + }); + + + int itemCount = projectMenu.getItemCount(); + projectMenu.add(new JPopupMenu.Separator(), itemCount -3); + projectMenu.add(importOMT,itemCount - 2); + + exportOMT = new JMenuItem(); + Mnemonics.setLocalizedText(exportOMT, "Export OMT Package..."); + exportOMT.addActionListener(e -> { + projectExportOMT(); + }); + projectMenu.add(exportOMT,itemCount - 1); + + onProjectStatusChanged(false); + } + + @Override + public void onApplicationShutdown() { + } + }); + } + + public static void unloadPlugins() { + /* empty */ + } + + private static void onProjectStatusChanged(boolean isProjectLoaded) { + exportOMT.setEnabled(isProjectLoaded); + importOMT.setEnabled(!isProjectLoaded); + } + + public static void projectImportOMT() { + UIThreadsUtil.mustBeSwingThread(); + + if (Core.getProject().isProjectLoaded()) { + return; + } + + ChooseOmtProject ndm = new ChooseOmtProject(); + + // ask for OMT file + int ndmResult = ndm.showOpenDialog(Core.getMainWindow().getApplicationFrame()); + if (ndmResult != OmegaTFileChooser.APPROVE_OPTION) { + // user press 'Cancel' in project creation dialog + return; + } + final File omtFile = ndm.getSelectedFile(); + + new SwingWorker() { + protected Void doInBackground() throws Exception { + + final File projectDir = extractFromOmt(omtFile); + ProjectUICommands.projectOpen(projectDir); + return null; + } + + protected void done() { + try { + get(); + SwingUtilities.invokeLater(Core.getEditor()::requestFocus); + } catch (Exception ex) { + Log.logErrorRB(ex, "PP_ERROR_UNABLE_TO_READ_PROJECT_FILE"); + Core.getMainWindow().displayErrorRB(ex, "PP_ERROR_UNABLE_TO_READ_PROJECT_FILE"); + } + } + }.execute(); + } + + public static void projectExportOMT() { + UIThreadsUtil.mustBeSwingThread(); + + if (!Core.getProject().isProjectLoaded()) { + return; + } + + // commit the current entry first + Core.getEditor().commitAndLeave(); + + ChooseOmtProject ndm = new ChooseOmtProject(); + + // ask for new OMT file + // default name + String zipName = Core.getProject().getProjectProperties().getProjectName() + OMT_EXTENSION; + + // By default, save inside the project + ndm.setSelectedFile( + new File(Core.getProject().getProjectProperties().getProjectRootDir(), zipName)); + int ndmResult = ndm.showSaveDialog(Core.getMainWindow().getApplicationFrame()); + if (ndmResult != OmegaTFileChooser.APPROVE_OPTION) { + // user press 'Cancel' in project creation dialog + return; + } + // add .zip extension if there is no + final File omtFile = ndm.getSelectedFile().getName().toLowerCase(Locale.ENGLISH) + .endsWith(OMT_EXTENSION) ? ndm.getSelectedFile() + : new File(ndm.getSelectedFile().getAbsolutePath() + OMT_EXTENSION); + + new SwingWorker() { + protected Void doInBackground() throws Exception { + IMainWindow mainWindow = Core.getMainWindow(); + Cursor hourglassCursor = Cursor.getPredefinedCursor(Cursor.WAIT_CURSOR); + Cursor oldCursor = mainWindow.getCursor(); + mainWindow.setCursor(hourglassCursor); + + mainWindow.showStatusMessageRB("MW_STATUS_SAVING"); + + Core.executeExclusively(true, () -> { + Core.getProject().saveProject(true); + try { + Core.getProject().compileProject(".*"); + } catch (Exception ex) { + throw new RuntimeException(ex); + } + }); + + createOmt(omtFile, Core.getProject().getProjectProperties()); + + mainWindow.showStatusMessageRB("MW_STATUS_SAVED"); + mainWindow.setCursor(oldCursor); + return null; + } + + protected void done() { + try { + get(); + SwingUtilities.invokeLater(Core.getEditor()::requestFocus); + } catch (Exception ex) { + Log.logErrorRB(ex, "PP_ERROR_UNABLE_TO_READ_PROJECT_FILE"); + Core.getMainWindow().displayErrorRB(ex, "PP_ERROR_UNABLE_TO_READ_PROJECT_FILE"); + } + } + }.execute(); + } + + + /** + * It creates project internals from OMT zip file. + */ + public static File extractFromOmt(File omtFile) throws Exception { + String omtName = omtFile.getName().replaceAll("\\" + OMT_EXTENSION + "$", ""); + + ZipFile zip = new ZipFile(omtFile); + + ZipEntry e = zip.getEntry(OConsts.FILE_PROJECT); + if (e == null) { + zip.close(); + throw new Exception("Invalid OMT file, missing file \"." + OConsts.FILE_PROJECT + "\"."); + } + + File projectDir = new File(omtFile.getParentFile(), omtName); + projectDir.mkdirs(); + + for (Enumeration en = zip.entries(); en.hasMoreElements();) { + e = en.nextElement(); + + File outFile = new File(projectDir, e.getName()); + if (e.isDirectory()) { + outFile.mkdirs(); + } else { + try (InputStream in = zip.getInputStream(e)) { + // TODO Maybe not overwrite project_save.tmx if it already exists? Ask the user? + if (e.getName().equals(OConsts.DEFAULT_INTERNAL + "/" + OConsts.STATUS_EXTENSION) + && outFile.exists()) { + + } + FileUtils.copyInputStreamToFile(in, outFile); + } + } + } + + zip.close(); + + return projectDir; + } + + public static void createOmt(final File omtZip, final ProjectProperties props) throws Exception { + Path path = Paths.get(props.getProjectRootDir().getAbsolutePath()); + if (!Files.isDirectory(path)) { + throw new IllegalArgumentException("Path must be a directory."); + } + + BufferedOutputStream bos = new BufferedOutputStream(new FileOutputStream(omtZip)); + + try (ZipOutputStream out = new ZipOutputStream(bos)) { + addZipDir(out, null, path, props); + } + } + + // FIXME includes empty directory (glossary, etc.) + private static final void addZipDir(final ZipOutputStream out, final Path root, final Path dir, + final ProjectProperties props) throws IOException { + try (DirectoryStream stream = Files.newDirectoryStream(dir)) { + for (Path child : stream) { + final Path childPath = child.getFileName(); + + if (childPath.toFile().getName().endsWith(OConsts.BACKUP_EXTENSION)) { + continue; + } + if (childPath.endsWith(OConsts.FILE_PROJECT)) { + + File tmpProjectFile = File.createTempFile("omt", null, props.getProjectRootDir()); + try { + ProjectFileStorage.writeProjectFile(props, tmpProjectFile); + } catch (Exception e) { + throw new IOException(e); + } + out.putNextEntry(new ZipEntry(OConsts.FILE_PROJECT)); + Files.copy(Paths.get(tmpProjectFile.getAbsolutePath()), out); + out.closeEntry(); + tmpProjectFile.delete(); + continue; + } + + Path entry = root == null ? childPath : Paths.get(root.toString(), childPath.toString()); + if (Files.isDirectory(child)) { + addZipDir(out, entry, child, props); + } else { + out.putNextEntry(new ZipEntry(entry.toString())); + Files.copy(child, out); + out.closeEntry(); + } + } + } + } + +} diff --git a/src/main/java/net/briac/omegat/plugin/omt/ProjectFileStorage.java b/src/main/java/net/briac/omegat/plugin/omt/ProjectFileStorage.java new file mode 100644 index 0000000..07a671a --- /dev/null +++ b/src/main/java/net/briac/omegat/plugin/omt/ProjectFileStorage.java @@ -0,0 +1,108 @@ +package net.briac.omegat.plugin.omt; + +import gen.core.project.Masks; +import gen.core.project.Omegat; +import gen.core.project.Project; +import org.apache.commons.lang.StringUtils; +import org.omegat.core.data.ProjectProperties; +import org.omegat.util.OConsts; + +import javax.xml.bind.JAXBContext; +import javax.xml.bind.Marshaller; +import java.io.File; +import java.nio.file.Path; +import java.nio.file.Paths; + +/** Copy of org.omegat.util.ProjectFileStorage just to be able to create an project.properties */ +public class ProjectFileStorage { + private static final JAXBContext CONTEXT; + static { + try { + CONTEXT = JAXBContext.newInstance(Omegat.class); + } catch (Exception ex) { + throw new ExceptionInInitializerError(ex); + } + } + + // Should be in org.omegat.util.ProjectFileStorage.writeProjectFile + public static void writeProjectFile(ProjectProperties props, File outFile) throws Exception { + String root = outFile.getAbsoluteFile().getParent(); + + Omegat om = new Omegat(); + om.setProject(new Project()); + om.getProject().setVersion(OConsts.PROJ_CUR_VERSION); + + om.getProject().setSourceDir(getPathForStoring(root, props.getSourceRoot(), OConsts.DEFAULT_SOURCE)); + om.getProject().setSourceDirExcludes(new Masks()); + om.getProject().getSourceDirExcludes().getMask().addAll(props.getSourceRootExcludes()); + om.getProject().setTargetDir(getPathForStoring(root, props.getTargetRoot(), OConsts.DEFAULT_TARGET)); + om.getProject().setTmDir(getPathForStoring(root, props.getTMRoot(), OConsts.DEFAULT_TM)); + String glossaryDir = getPathForStoring(root, props.getGlossaryRoot(), OConsts.DEFAULT_GLOSSARY); + om.getProject().setGlossaryDir(glossaryDir); + + // Compute glossary file location: must be relative to glossary root + String glossaryFile = getPathForStoring(props.getGlossaryRoot(), props.getWriteableGlossary(), null); + if (glossaryDir.equalsIgnoreCase(org.omegat.util.ProjectFileStorage.DEFAULT_FOLDER_MARKER) && props.isDefaultWriteableGlossaryFile()) { + // Everything equals to default + glossaryFile = org.omegat.util.ProjectFileStorage.DEFAULT_FOLDER_MARKER; + } + om.getProject().setGlossaryFile(glossaryFile); + + om.getProject().setDictionaryDir(getPathForStoring(root, props.getDictRoot(), OConsts.DEFAULT_DICT)); + om.getProject().setSourceLang(props.getSourceLanguage().toString()); + om.getProject().setTargetLang(props.getTargetLanguage().toString()); + om.getProject().setSourceTok(props.getSourceTokenizer().getCanonicalName()); + om.getProject().setTargetTok(props.getTargetTokenizer().getCanonicalName()); + om.getProject().setSentenceSeg(props.isSentenceSegmentingEnabled()); + om.getProject().setSupportDefaultTranslations(props.isSupportDefaultTranslations()); + om.getProject().setRemoveTags(props.isRemoveTags()); + om.getProject().setExternalCommand(props.getExternalCommand()); + + if (props.getRepositories() != null && !props.getRepositories().isEmpty()) { + om.getProject().setRepositories(new Project.Repositories()); + om.getProject().getRepositories().getRepository().addAll(props.getRepositories()); + } + + Marshaller m = CONTEXT.createMarshaller(); + m.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true); + m.marshal(om, outFile); + } + + private static String getPathForStoring(String root, String absolutePath, String defaultName) { + if (defaultName != null && new File(absolutePath).equals(new File(root, defaultName))) { + return org.omegat.util.ProjectFileStorage.DEFAULT_FOLDER_MARKER; + } + + // Fall back to using the input path if all else fails. + String result = absolutePath; + try { + // Path.normalize() will resolve any remaining "../" + Path absPath = Paths.get(absolutePath).normalize(); + String rel = Paths.get(root).relativize(absPath).toString(); + if (StringUtils.countMatches(rel, ".." + File.separatorChar) <= OConsts.MAX_PARENT_DIRECTORIES_ABS2REL) { + // Use the relativized path as it is "near" enough. + result = rel; + } else { + // + result = absPath.toString(); + } + } catch (IllegalArgumentException e) { + } + return normalizeSlashes(result); + } + /** + * Replace \ with / and remove / from the end if present. Within OmegaT we + * generally require a / on the end of directories, but for storage we + * prefer no trailing /. + */ + static String normalizeSlashes(String path) { + return withoutTrailingSlash(path.replace('\\', '/')); + } + + static String withoutTrailingSlash(String path) { + while (path.endsWith("/")) { + path = path.substring(0, path.length() - 1); + } + return path; + } +} diff --git a/src/main/java/net/briac/omegat/plugin/omt/omt-package.properties b/src/main/java/net/briac/omegat/plugin/omt/omt-package.properties new file mode 100644 index 0000000..4e9cb43 --- /dev/null +++ b/src/main/java/net/briac/omegat/plugin/omt/omt-package.properties @@ -0,0 +1,5 @@ +omt.menu.import=Import OMT package... +omt.menu.export=Export OMT package... +omt.chooser.import=Select the OMT package to import +omt.chooser.export=Select the OMT package to export +omt.chooser.filter=OMT Package file