diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..46661c7 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,17 @@ +root = true +[*] +end_of_line = lf +insert_final_newline = true +trim_trailing_whitespace = true +charset = utf-8 +indent_size = 2 +indent_style = space + +[*.{bat, cmd}] +end_of_line = crlf + +[Makefile] +indent_style = tab + +[*.{adoc, asciidoc, md, markdown}] +trim_trailing_whitespace = false diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..9c0e843 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,4 @@ +* text=auto +*.cmd text=crlf +*.bat text=crlf + diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..c019a64 --- /dev/null +++ b/.gitignore @@ -0,0 +1,9 @@ +.DS_Store +app/build +!app/build/.gitkeep +jasonette/ +!jasonette/.gitkeep +.gradle +app/icons/android/backup +node_modules +dist/ diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..9ab7ec1 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,24 @@ +FROM alvrme/alpine-android:android-28-jdk11 +LABEL maintainer="CLSource " + +# Install Rsync and ImageMagick helpers +RUN apk add --no-cache rsync imagemagick pngcrush optipng=0.7.7-r0 + +# Required for running utility scripts +RUN apk add --no-cache nodejs npm + +# Install Additional Android SDK Versions +# RUN sdkmanager --sdk_root=${ANDROID_SDK_ROOT} --install "build-tools;22.0.1" "platforms;android-22" +# RUN sdkmanager --sdk_root=${ANDROID_SDK_ROOT} --install "build-tools;26.0.3" "platforms;android-26" +# RUN sdkmanager --sdk_root=${ANDROID_SDK_ROOT} --install "build-tools;27.0.3" "platforms;android-27" + +# Install Gradle +RUN wget "https://services.gradle.org/distributions/gradle-5.6.2-bin.zip" -P ${ANDROID_SDK_ROOT}/cmdline-tools/${CMDLINE_VERSION} + +# Install https://github.com/ddimtirov/gwo-agent +# So gradle will be downloaded from local prefetched file +RUN wget https://jitpack.io/com/github/ddimtirov/gwo-agent/1.2.0/gwo-agent-1.2.0.jar -P ${ANDROID_SDK_ROOT}/cmdline-tools/${CMDLINE_VERSION} + +ENV GRADLE_OPTS=-javaagent:${ANDROID_SDK_ROOT}/cmdline-tools/${CMDLINE_VERSION}/gwo-agent-1.2.0.jar=distributionUrl=file\://${ANDROID_SDK_ROOT}/cmdline-tools/${CMDLINE_VERSION}/gradle-5.6.2-bin.zip + +# WORKDIR /home/android diff --git a/LICENSE b/LICENSE deleted file mode 100644 index 0ad25db..0000000 --- a/LICENSE +++ /dev/null @@ -1,661 +0,0 @@ - GNU AFFERO GENERAL PUBLIC LICENSE - Version 3, 19 November 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU Affero General Public License is a free, copyleft license for -software and other kinds of works, specifically designed to ensure -cooperation with the community in the case of network server software. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -our General Public Licenses are intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - Developers that use our General Public Licenses protect your rights -with two steps: (1) assert copyright on the software, and (2) offer -you this License which gives you legal permission to copy, distribute -and/or modify the software. - - A secondary benefit of defending all users' freedom is that -improvements made in alternate versions of the program, if they -receive widespread use, become available for other developers to -incorporate. Many developers of free software are heartened and -encouraged by the resulting cooperation. However, in the case of -software used on network servers, this result may fail to come about. -The GNU General Public License permits making a modified version and -letting the public access it on a server without ever releasing its -source code to the public. - - The GNU Affero General Public License is designed specifically to -ensure that, in such cases, the modified source code becomes available -to the community. It requires the operator of a network server to -provide the source code of the modified version running there to the -users of that server. Therefore, public use of a modified version, on -a publicly accessible server, gives the public access to the source -code of the modified version. - - An older license, called the Affero General Public License and -published by Affero, was designed to accomplish similar goals. This is -a different license, not a version of the Affero GPL, but Affero has -released a new version of the Affero GPL which permits relicensing under -this license. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU Affero General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Remote Network Interaction; Use with the GNU General Public License. - - Notwithstanding any other provision of this License, if you modify the -Program, your modified version must prominently offer all users -interacting with it remotely through a computer network (if your version -supports such interaction) an opportunity to receive the Corresponding -Source of your version by providing access to the Corresponding Source -from a network server at no charge, through some standard or customary -means of facilitating copying of software. This Corresponding Source -shall include the Corresponding Source for any work covered by version 3 -of the GNU General Public License that is incorporated pursuant to the -following paragraph. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the work with which it is combined will remain governed by version -3 of the GNU General Public License. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU Affero General Public License from time to time. Such new versions -will be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU Affero General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU Affero General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU Affero General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - 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 Affero 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 Affero General Public License for more details. - - You should have received a copy of the GNU Affero General Public License - along with this program. If not, see . - -Also add information on how to contact you by electronic and paper mail. - - If your software can interact with users remotely through a computer -network, you should also make sure that it provides a way for users to -get its source. For example, if your program is a web application, its -interface could display a "Source" link that leads users to an archive -of the code. There are many ways you could offer source, and different -solutions will be better for different programs; see section 13 for the -specific requirements. - - 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 AGPL, see -. diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..3df9cf4 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,660 @@ +# GNU AFFERO GENERAL PUBLIC LICENSE + +Version 3, 19 November 2007 + +Copyright (C) 2007 Free Software Foundation, Inc. + + +Everyone is permitted to copy and distribute verbatim copies of this +license document, but changing it is not allowed. + +### Preamble + +The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + +The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains +free software for all its users. + +When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + +Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + +A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + +The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + +An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing +under this license. + +The precise terms and conditions for copying, distribution and +modification follow. + +### TERMS AND CONDITIONS + +#### 0. Definitions. + +"This License" refers to version 3 of the GNU Affero General Public +License. + +"Copyright" also means copyright-like laws that apply to other kinds +of works, such as semiconductor masks. + +"The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + +To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of +an exact copy. The resulting work is called a "modified version" of +the earlier work or a work "based on" the earlier work. + +A "covered work" means either the unmodified Program or a work based +on the Program. + +To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + +To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user +through a computer network, with no transfer of a copy, is not +conveying. + +An interactive user interface displays "Appropriate Legal Notices" to +the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + +#### 1. Source Code. + +The "source code" for a work means the preferred form of the work for +making modifications to it. "Object code" means any non-source form of +a work. + +A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + +The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + +The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + +The Corresponding Source need not include anything that users can +regenerate automatically from other parts of the Corresponding Source. + +The Corresponding Source for a work in source code form is that same +work. + +#### 2. Basic Permissions. + +All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + +You may make, run and propagate covered works that you do not convey, +without conditions so long as your license otherwise remains in force. +You may convey covered works to others for the sole purpose of having +them make modifications exclusively for you, or provide you with +facilities for running those works, provided that you comply with the +terms of this License in conveying all material for which you do not +control copyright. Those thus making or running the covered works for +you must do so exclusively on your behalf, under your direction and +control, on terms that prohibit them from making any copies of your +copyrighted material outside their relationship with you. + +Conveying under any other circumstances is permitted solely under the +conditions stated below. Sublicensing is not allowed; section 10 makes +it unnecessary. + +#### 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + +No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + +When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such +circumvention is effected by exercising rights under this License with +respect to the covered work, and you disclaim any intention to limit +operation or modification of the work as a means of enforcing, against +the work's users, your or third parties' legal rights to forbid +circumvention of technological measures. + +#### 4. Conveying Verbatim Copies. + +You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + +You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + +#### 5. Conveying Modified Source Versions. + +You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these +conditions: + +- a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. +- b) The work must carry prominent notices stating that it is + released under this License and any conditions added under + section 7. This requirement modifies the requirement in section 4 + to "keep intact all notices". +- c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. +- d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + +A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + +#### 6. Conveying Non-Source Forms. + +You may convey a covered work in object code form under the terms of +sections 4 and 5, provided that you also convey the machine-readable +Corresponding Source under the terms of this License, in one of these +ways: + +- a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. +- b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the Corresponding + Source from a network server at no charge. +- c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. +- d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. +- e) Convey the object code using peer-to-peer transmission, + provided you inform other peers where the object code and + Corresponding Source of the work are being offered to the general + public at no charge under subsection 6d. + +A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + +A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, +family, or household purposes, or (2) anything designed or sold for +incorporation into a dwelling. In determining whether a product is a +consumer product, doubtful cases shall be resolved in favor of +coverage. For a particular product received by a particular user, +"normally used" refers to a typical or common use of that class of +product, regardless of the status of the particular user or of the way +in which the particular user actually uses, or expects or is expected +to use, the product. A product is a consumer product regardless of +whether the product has substantial commercial, industrial or +non-consumer uses, unless such uses represent the only significant +mode of use of the product. + +"Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to +install and execute modified versions of a covered work in that User +Product from a modified version of its Corresponding Source. The +information must suffice to ensure that the continued functioning of +the modified object code is in no case prevented or interfered with +solely because modification has been made. + +If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + +The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or +updates for a work that has been modified or installed by the +recipient, or for the User Product in which it has been modified or +installed. Access to a network may be denied when the modification +itself materially and adversely affects the operation of the network +or violates the rules and protocols for communication across the +network. + +Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + +#### 7. Additional Terms. + +"Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + +When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + +Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders +of that material) supplement the terms of this License with terms: + +- a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or +- b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or +- c) Prohibiting misrepresentation of the origin of that material, + or requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or +- d) Limiting the use for publicity purposes of names of licensors + or authors of the material; or +- e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or +- f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions + of it) with contractual assumptions of liability to the recipient, + for any liability that these contractual assumptions directly + impose on those licensors and authors. + +All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + +If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + +Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; the +above requirements apply either way. + +#### 8. Termination. + +You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + +However, if you cease all violation of this License, then your license +from a particular copyright holder is reinstated (a) provisionally, +unless and until the copyright holder explicitly and finally +terminates your license, and (b) permanently, if the copyright holder +fails to notify you of the violation by some reasonable means prior to +60 days after the cessation. + +Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + +Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + +#### 9. Acceptance Not Required for Having Copies. + +You are not required to accept this License in order to receive or run +a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + +#### 10. Automatic Licensing of Downstream Recipients. + +Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + +An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + +You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + +#### 11. Patents. + +A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + +A contributor's "essential patent claims" are all patent claims owned +or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + +Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + +In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + +If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + +If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + +A patent license is "discriminatory" if it does not include within the +scope of its coverage, prohibits the exercise of, or is conditioned on +the non-exercise of one or more of the rights that are specifically +granted under this License. You may not convey a covered work if you +are a party to an arrangement with a third party that is in the +business of distributing software, under which you make payment to the +third party based on the extent of your activity of conveying the +work, and under which the third party grants, to any of the parties +who would receive the covered work from you, a discriminatory patent +license (a) in connection with copies of the covered work conveyed by +you (or copies made from those copies), or (b) primarily for and in +connection with specific products or compilations that contain the +covered work, unless you entered into that arrangement, or that patent +license was granted, prior to 28 March 2007. + +Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + +#### 12. No Surrender of Others' Freedom. + +If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under +this License and any other pertinent obligations, then as a +consequence you may not convey it at all. For example, if you agree to +terms that obligate you to collect a royalty for further conveying +from those to whom you convey the Program, the only way you could +satisfy both those terms and this License would be to refrain entirely +from conveying the Program. + +#### 13. Remote Network Interaction; Use with the GNU General Public License. + +Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your +version supports such interaction) an opportunity to receive the +Corresponding Source of your version by providing access to the +Corresponding Source from a network server at no charge, through some +standard or customary means of facilitating copying of software. This +Corresponding Source shall include the Corresponding Source for any +work covered by version 3 of the GNU General Public License that is +incorporated pursuant to the following paragraph. + +Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + +#### 14. Revised Versions of this License. + +The Free Software Foundation may publish revised and/or new versions +of the GNU Affero General Public License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever +published by the Free Software Foundation. + +If the Program specifies that a proxy can decide which future versions +of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + +Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + +#### 15. Disclaimer of Warranty. + +THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT +WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND +PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE +DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR +CORRECTION. + +#### 16. Limitation of Liability. + +IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR +CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES +ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT +NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR +LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM +TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER +PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. + +#### 17. Interpretation of Sections 15 and 16. + +If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + +END OF TERMS AND CONDITIONS + +### 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 Affero 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 Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper +mail. + +If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for +the specific requirements. + +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 AGPL, see . diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..adcb99c --- /dev/null +++ b/Makefile @@ -0,0 +1,102 @@ +# Tested on Docker v20.10.0 +.PHONY: install docs zip fa da bad bar caf ki + +VERSION=1.0.0 +TAG=jasonette-setup-docker +KEYSTORE_NAME=jasonette.keystore +KEYSTORE_ALIAS=upload + +# Helper Commands +DOCKER=docker run --rm -it --mount +CURL=${DOCKER} type=bind,source="${PWD}",target=/files curlimages/curl +GRADLE=${DOCKER} type=bind,source="${PWD}/jasonette/android",target=/home/android ${TAG} ./gradlew +BUILDER=${DOCKER} type=bind,source="${PWD}",target=/home/android ${TAG} + +# Exec inside Builder docker +## Common Utilities +UNZIP=${BUILDER} unzip -u +RM=${BUILDER} rm -rf +MKDIR=${BUILDER} mkdir -p +COPY=${BUILDER} cp +MOVE=${BUILDER} mv + +## Special Programs +KEYTOOL=${BUILDER} keytool +RSYNC=${BUILDER} rsync +SH=${BUILDER} /bin/sh -c + +# Make Commands + +## Installation Command +##> Use this command to install all the dependencies of Docker and Jasonelle +##> $ make install +i install: + @echo + @echo " ╦┌─┐┌─┐┌─┐┌┐┌┌─┐┬ ┬ ┌─┐" + @echo " ║├─┤└─┐│ ││││├┤ │ │ ├┤ " + @echo "╚╝┴ ┴└─┘└─┘┘└┘└─┘┴─┘┴─┘└─┘" + @echo " Android Setup Tool v${VERSION}" + @echo + docker build -t ${TAG} . + +## Download Android +##> Use this command to download the latest develop version. +##> $ make fa +fa fetch-android fetch-android-develop: + ${CURL} https://github.com/jasonelle/jasonette-android/archive/refs/heads/develop.zip -L -o /files/jasonette/android.zip + +##> Download and unzip the directory +##> Danger: It will delete the jasonette/android directory if present +##> $ make da +da dad download-android download-android-develop: + make fetch-android-develop + ${SH} "cd ./jasonette && unzip ./android.zip && rm -rf ./android && mv ./jasonette-android-develop ./android && rm android.zip" + +## Copy Android Files +##> Use this command to copy files inside app/file and app/settings/android to jasonette/android +##> $ make caf +caf copy-android-files: + ${RSYNC} -av ./app/file/ ./jasonette/android/app/src/main/assets/file + ${SH} "cp ./app/settings/android/AndroidManifest.xml ./jasonette/android/app/src/main && cp ./app/settings/android/strings.xml ./jasonette/android/app/src/main/res/values && cp ./app/settings/android/build.gradle ./jasonette/android/app" + +## Create Android Keystore +##> Use this command to create a new file *.keystore that will be stored inside app/keys +##> This file is needed to build a release APK and sign in. +##> $ make ki +ki key-install-android: + ${KEYTOOL} -genkey -v -keystore ${KEYSTORE_NAME} -alias ${KEYSTORE_ALIAS} -keyalg RSA -keysize 2048 -validity 9125 + ${COPY} ./${KEYSTORE_NAME} ./jasonette/android/app + ${MOVE} ./${KEYSTORE_NAME} ./app/keys/${KEYSTORE_NAME} + +## Build Android APK in Debug Mode +##> Use this command to create an APK in debug mode. +##> It will copy files inside app/file app/settings/android. +##> The APK will be copied to build/ directory. +##> $ make bad +bad build-android-debug: + make copy-android-files + ${GRADLE} assembleDebug --warning-mode=all --stacktrace -PdisablePreDex + ${COPY} ./jasonette/android/app/build/outputs/apk/debug/app-debug.apk ./app/build/ + +## Build Android APK in Release Mode +##> Use this command to create an APK in release mode. +##> It will copy files inside app/file app/settings/android. +##> Also it will copy the keystore file. +##> Make sure your build.gradle file is configured with the keystore file. +##> The APK will be copied to build/ directory. +##> $ make bar +bar build-android-release: + @echo "Make sure to configure build.gradle and include ${KEYSTORE_NAME} in the build settings" + make copy-android-files + ${COPY} ./app/keys/${KEYSTORE_NAME} ./jasonette/android/app + ${GRADLE} assembleRelease --warning-mode=all --stacktrace -PdisablePreDex + ${COPY} ./jasonette/android/app/build/outputs/apk/release/app-release.apk ./app/build/ + +# Dev Commands +docs: + @cp README.adoc ./docs && cd docs && asciidoctor README.adoc && asciidoctor-pdf README.adoc && mv README.html index.html && rm README.adoc + +zip: + @mkdir -p ./dist + @git archive --format zip --output ./dist/jasonelle-android-docker-tool-${VERSION}.zip main + @echo "./dist/jasonelle-android-docker-tool-${VERSION}.zip created" diff --git a/README.adoc b/README.adoc new file mode 100644 index 0000000..2f0eaad --- /dev/null +++ b/README.adoc @@ -0,0 +1,193 @@ +:toc: macro +:toclevels: 3 +:ext-relative: + +# Jasonelle Android Setup Tools + +These are a bunch of scripts and docker files that will help you +developing apps with Jasonette in Android. + +toc::[] + +## Directory Structure + +When unzipping you can see the following directory structure: + +```text +. (root) +├── Dockerfile +├── Makefile +├── app +│   ├── build +│   ├── file +│   ├── keys +│   └── settings +├── docs +├── jasonette +└── tools + └── windows +``` + +## Installation + +The only requirement is _Docker Desktop_ at least _v20.10.0_. You can read the installation docs at +https://docs.docker.com/get-docker/. Be sure that is up and running before installing the _Jasonelle Android Setup Tools_. + +### Linux/Mac + +_Linux_ and _Mac_ use the https://en.wikipedia.org/wiki/Make_(software)[Make] command. It is a fairly standard tool. + +- https://osxdaily.com/2014/02/12/install-command-line-tools-mac-os-x/[Install Make in MacOS] +- https://linuxconfig.org/command-make-not-found-on-ubuntu-20-04-focal-fossa[Install Make in Ubuntu Linux] + +Open the *terminal* application, go to the _root_ directory and run: + +```sh +$ make install +``` + +### Windows + +Open a new https://www.zdnet.com/article/windows-10-tip-the-fastest-smartest-ways-to-open-a-command-prompt/[*cmd* application] +inside the _root_ directory and execute: + +```sh +.\tools\windows\install.cmd +``` + +## Android + +### Jasonette + +The main directory is _jasonette/android_. Here you can put your own jasonette project. + +### Keystore Creation + +Before sending your app to the _PlayStore_ you need to create a new _Keystore_ that will sign the app. + +Follow the instructions in the Android Studio Help Center (https://developer.android.com/studio/publish/app-signing.html#generate-key) to generate a new key. It must be different from any previous keys. Alternatively, you can use the following command line to generate a new key: + +```sh +$ keytool -genkeypair -alias upload -keyalg RSA -keysize 2048 -validity 9125 -keystore keystore.jks +``` + +This key must be a 2048 bit RSA key and have 25-year validity. +Export the certificate for that key to PEM format: + +```sh +$ keytool -export -rfc -alias upload -file upload_certificate.pem -keystore keystore.jks +``` + +- *Important*: Keep in mind that the generated *jks* or *keystore* file will be used for signing all future updates of your app. +Please make sure you store it in a safe place. If you lost it, you will need to contact _Google Support_ to upload a new *keystore* file. The *keystore* file contains both _private_ and _public_ keys. *pem* and *der* files are only public keys. + +- *Extra Important*: When creating the *keystore* the command will ask to input a password. Make sure you use a secure password and remember it. Otherwise your *keystore* will not be possible to sign the _APK_ and you would need to recreate a new *keystore*. + +You can use the *Keystore Tool* to ease the keystore creation. + +More information on creating and using a *keystore* can be found at https://positive-stud.medium.com/step-by-step-guide-to-generate-a-signed-apk-using-android-studio-1e22ab7b3e86 and https://developer.android.com/training/articles/keystore + +#### Example build.gradle + +This is a sample _build.gradle_ file which was configured for using the *jasonette.keystore* file. + +```gradle + // ... + signingConfigs { + release { + storeFile file('jasonette.keystore') + storePassword 'your_key_store_password' + keyAlias 'your_key_alias' + keyPassword 'your_key_file_alias_password' + } + } + buildTypes { + release { + debuggable false + minifyEnabled false + proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro' + + // set the signing config for the release apk + signingConfig signingConfigs.release + } + } + // ... +``` + +### Edit your files + +The main directory for your files is `app/file`. Where every file here will be copied to `jasonette/android`. +By default it was included three example apps. Select your initial app in `app/settings/android/strings.xml`. + +### Edit your settings + +The following files: + +- AndroidManifest.xml +- build.gradle +- settings.xml + +will be stored inside `app/settings/android`. They will overwrite the files inside `jasonette/android`. + +## Commands + +### Installation Command + +Use this command to install all the dependencies of Docker and Jasonelle. +This is the first command you must execute before everything else. +Be sure that the _Docker Service_ is running and all the directories +have *read/write* (_chmod 755_) permissions. + +- Linux/Mac: `$ make install` +- Windows: `.\tools\windows\install.cmd` + +### Download and unzip the android directory + +*Danger*: It will delete the jasonette/android directory if exists. + +- Linux/Mac: `$ make da` +- Windows: `.\tools\windows\android-download-latest.cmd` + +### Create Android Keystore +Use this command to create a new file _*.keystore_ that will be stored inside _app/keys_. +This file is needed to build a release APK and sign in. + +If you already have a _*.keystore_ file then this step is optional. Be sure to +name the file *jasonette.keystore*. + +- Linux/Mac: `$ make ki` +- Windows: `.\tools\windows\android-key-tool.cmd` + +### Build Android APK in Debug Mode +Use this command to create an APK in debug mode. +It will copy files inside _app/file_ and _app/settings/android_. +The APK will be copied to _app/build_ directory. + +- Linux/Mac: `$ make bad` +- Windows: `.\tools\windows\android-build-debug.cmd` + +### Build Android APK in Release Mode + +Use this command to create an APK in release mode. +It will copy files inside app/file app/settings/android. +Also it will copy the keystore file. +Make sure your build.gradle file is configured with the keystore file. +The APK will be copied to build/ directory. + +- Linux/Mac: `$ make bar` +- Windows: `.\tools\windows\android-build-release.cmd` + +## License + +The following files are under the GNU AFFERO GENERAL PUBLIC LICENSE (Version 3). + +- _Dockerfile_ +- _Makefile_ +- All files inside _tools_ directory + +Other files are under their respective licenses. + +## Credits +++++ +Made with ♥ by Ninjas.cl. +++++ diff --git a/README.md b/README.md deleted file mode 100644 index f979cdb..0000000 --- a/README.md +++ /dev/null @@ -1,2 +0,0 @@ -# android-docker-tool -A helper tool to compile Jasonette Android using Docker diff --git a/app/build/.gitkeep b/app/build/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/app/file/.gitkeep b/app/file/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/app/file/hello.json b/app/file/hello.json new file mode 100644 index 0000000..601e3ce --- /dev/null +++ b/app/file/hello.json @@ -0,0 +1,115 @@ +{ + "$jason": { + "head": { + "title": "{ ˃̵̑ᴥ˂̵̑}", + "actions": { + "$foreground": { + "type": "$reload" + } + } + }, + "body": { + "header": { + "style": { + "theme": true + } + }, + "style": { + "background": "#ffffff", + "border": "none" + }, + "sections": [ + { + "items": [ + { + "type": "vertical", + "style": { + "padding": 30, + "spacing": 20, + "align": "center" + }, + "components": [ + { + "type": "label", + "text": "It's ALIVE!", + "style": { + "align": "center", + "font": "Courier-Bold", + "size": 26 + } + }, + { + "type": "label", + "text": "This is a demo app. You can make your own app by changing the url inside strings.xml", + "style": { + "align": "center", + "font": "Courier", + "padding": 30, + "size": 20 + } + }, + { + "type": "label", + "text": "{ ˃̵̑ᴥ˂̵̑}", + "style": { + "align": "center", + "font": "HelveticaNeue-Bold", + "size": 50 + } + } + ] + }, + { + "type": "label", + "style": { + "align": "right", + "padding": 10, + "color": "#000000", + "font": "HelveticaNeue", + "size": 20 + }, + "text": "Check out Live DEMO", + "href": { + "url": "https://raw.githubusercontent.com/jasonelle/docs/develop/examples/jasonette/apps/jasonpedia/demo.json", + "fresh": true + } + }, + { + "type": "label", + "style": { + "align": "right", + "padding": 10, + "color": "#000000", + "font": "HelveticaNeue", + "size": 20 + }, + "text": "Watch the tutorial video", + "href": { + "url": "https://www.youtube.com/watch?v=hfevBAAfCMQ", + "view": "web" + } + }, + { + "type": "label", + "style": { + "align": "right", + "padding": 10, + "color": "#000000", + "font": "HelveticaNeue", + "size": 20 + }, + "text": "View documentation", + "href": { + "url": "https://jasonelle.com/docs", + "view": "web", + "options": { + "reader": true + } + } + } + ] + } + ] + } + } +} diff --git a/app/file/jasonapp.json b/app/file/jasonapp.json new file mode 100644 index 0000000..3858a09 --- /dev/null +++ b/app/file/jasonapp.json @@ -0,0 +1,288 @@ +{ + "$jason": { + "head": { + "title": "Jason", + "actions": { + "$pull": { + "trigger": "scan" + }, + "remove": { + "type": "$set", + "options": { + "del": "{{$jason.url}}" + }, + "success": { + "type": "$cache.set", + "options": { + "history": "{{$cache.history.filter(function(item){return item.url!=$get.del;})}}" + }, + "success": { + "type": "$reload" + } + } + }, + "scan": { + "type": "$href", + "options": { + "url": "https://raw.githubusercontent.com/jasonelle/docs/develop/examples/jasonette/apps/jason-app/qr.json" + }, + "success": { + "type": "$set", + "options": { + "url": [ + { + "{{#if /jason:/.test($jason.content)}}": "{{$jason.content.match(/http.*/)[0]}}" + }, + { + "{{#else}}": "{{$jason.content}}" + } + ] + }, + "success": { + "trigger": "say" + } + } + }, + "say": { + "type": "$set", + "options": [ + { + "{{#if /http.?:\\/\\//.test($get.url)}}": { + "url": "{{$get.url}}" + } + }, + { + "{{#else}}": { + "url": "https://jasonbase.com/things/{{$get.url}}" + } + } + ], + "success": { + "type": "$network.request", + "options": [ + { + "{{#if /http.?:\\/\\//.test($get.url)}}": { + "url": "{{$get.url}}" + } + }, + { + "{{#else}}": { + "url": "https://jasonbase.com/things/{{$get.url}}" + } + } + ], + "success": [ + { + "{{#if $jason && ('$jason' in $jason) && ('head' in $jason['$jason']) && ('title' in $jason['$jason']['head']) }}": { + "type": "$cache.set", + "options": { + "history": "{{ [{title: $jason['$jason']['head']['title'], url: $get.url}].concat($cache.history) }}" + }, + "success": { + "trigger": "refresh" + } + } + }, + { + "{{#else}}": { + "type": "$cache.set", + "options": { + "history": "{{ [{title: 'No title', url: $get.url}].concat($cache.history) }}" + }, + "success": { + "trigger": "refresh" + } + } + } + ], + "error": { + "type": "$util.banner", + "options": { + "title": "Error", + "description": "Please enter a valid url." + } + } + } + }, + "refresh": [ + { + "{{#if $cache && 'history' in $cache}}": { + "type": "$render" + } + }, + { + "{{#else}}": { + "type": "$cache.set", + "options": { + "history": [ + + ] + }, + "success": { + "type": "$render" + } + } + } + ], + "load": { + "type": "$cache.reset" + }, + "$load": { + "trigger": "refresh" + }, + "$foreground": { + "type": "$reload" + } + }, + "templates": { + "body": { + "header": { + "title": "{·ᴥ·}", + "menu": { + "text": "Documentation", + "href": { + "url": "https://jasonelle.com/docs", + "view": "web" + } + } + }, + "sections": [ + { + "header": { + "type": "vertical", + "style": { + "background": "rgba(255,255,255,0.95)" + }, + "components": [ + { + "type": "label", + "style": { + "font": "HelveticaNeue-Bold", + "size": "12" + }, + "text": "Jason is a JSON browser" + }, + { + "type": "label", + "style": { + "color": "#cecece", + "font": "HelveticaNeue", + "size": "12" + }, + "text": "Enter a valid JASON url below, or view the documentation to learn how to write one." + } + ] + } + }, + { + "items": [ + { + "{{#if $cache && 'history' in $cache}}": { + "{{#each $cache.history}}": { + "type": "horizontal", + "href": { + "url": "{{url}}", + "loading": "true" + }, + "style": { + "color": "#cecece", + "spacing": "10" + }, + "menu": { + "items": [ + { + "text": "delete", + "action": { + "type": "$set", + "options": { + "del": "{{url}}" + }, + "success": { + "type": "$cache.set", + "options": { + "history": "{{$cache.history.filter(function(item){return item.url!=$get.del;})}}" + }, + "success": { + "type": "$reload" + } + } + } + } + ] + }, + "components": [ + { + "type": "button", + "text": "Delete", + "style": { + "width": "80", + "background": "#DD2209", + "color": "#FFD351" + }, + "action": { + "trigger": "remove", + "options": { + "url": "{{url}}" + } + } + }, + { + "type": "vertical", + "components": [ + { + "type": "label", + "style": { + "font": "HelveticaNeue-Bold", + "size": "12" + }, + "text": "{{title}}" + }, + { + "type": "label", + "style": { + "font": "HelveticaNeue-Bold", + "size": "10", + "color": "#cecece" + }, + "text": "{{url}}" + } + ] + } + ] + } + } + }, + { + "{{#else}}": [ + + ] + } + ] + } + ], + "footer": { + "input": { + "name": "url", + "placeholder": "Enter a valid jason url", + "left": { + "image": "https://raw.githubusercontent.com/jasonelle/docs/develop/examples/jasonette/apps/jason-app/images/qr-code.png", + "action": { + "trigger": "scan" + } + }, + "right": { + "text": "Go", + "style": { + "color": "#000000" + }, + "action": { + "trigger": "say" + } + } + } + } + } + } + } + } +} diff --git a/app/file/webview.json b/app/file/webview.json new file mode 100644 index 0000000..5af148a --- /dev/null +++ b/app/file/webview.json @@ -0,0 +1,17 @@ +{ + "$jason": { + "body": { + "background": { + "type": "html", + "url": "https://www.google.com", + "style": { + "background": "#ffffff", + "progress" : "rgba(0,0,0,0)" + }, + "action": { + "type": "$default" + } + } + } + } +} diff --git a/app/keys/.gitkeep b/app/keys/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/app/settings/android/AndroidManifest.xml b/app/settings/android/AndroidManifest.xml new file mode 100644 index 0000000..bce8812 --- /dev/null +++ b/app/settings/android/AndroidManifest.xml @@ -0,0 +1,97 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/app/settings/android/build.gradle b/app/settings/android/build.gradle new file mode 100644 index 0000000..04dde9f --- /dev/null +++ b/app/settings/android/build.gradle @@ -0,0 +1,79 @@ +// This file will override ./jasonette/android/app/build.gradle +buildscript { + repositories { + maven { url 'https://plugins.gradle.org/m2/' } + } +} + +repositories { + maven { url 'https://maven.google.com' } +} + +apply plugin: 'com.android.application' + +android { + compileSdkVersion 28 + buildToolsVersion '28.0.3' + defaultConfig { + applicationId "com.jasonette" + minSdkVersion 22 + // Android 8 is the minimum required for the playstore + targetSdkVersion 26 + versionCode 3 + versionName "0.1.0" + testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner" + multiDexEnabled true + } + buildTypes { + release { + debuggable false + minifyEnabled false + proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro' + } + } + lintOptions { + disable "ResourceType" + } +} + +dependencies { + implementation fileTree(include: ['*.jar'], dir: 'libs') + androidTestImplementation('androidx.test.espresso:espresso-core:3.2.0', { + exclude group: 'com.android.support', module: 'support-annotations' + }) + implementation 'com.google.firebase:firebase-messaging:20.0.0' + debugImplementation 'com.facebook.stetho:stetho:1.5.1' + debugImplementation 'com.facebook.stetho:stetho-okhttp3:1.5.1' + debugImplementation 'com.facebook.stetho:stetho-timber:1.5.1' + //noinspection GradleCompatible + implementation 'androidx.appcompat:appcompat:1.1.0' + implementation 'androidx.appcompat:appcompat:1.1.0' + implementation 'com.squareup.okhttp3:okhttp:4.2.0' + implementation 'com.github.bumptech.glide:glide:4.10.0' + implementation 'jp.wasabeef:glide-transformations:2.0.1' + implementation 'com.eclipsesource.j2v8:j2v8:5.0.103@aar' + //implementation 'com.android.support:recyclerview-v7:27.1.1' + implementation 'androidx.recyclerview:recyclerview:1.0.0' + //implementation 'com.android.support:design:27.1.1' + implementation 'com.google.android.material:material:1.0.0' + implementation 'com.aurelhubert:ahbottomnavigation:2.0.2' + //implementation 'com.android.support:support-core-ui:27.1.1' + implementation 'androidx.legacy:legacy-support-core-ui:1.0.0' + implementation 'commons-lang:commons-lang:20030203.000129' + implementation 'com.github.scribejava:scribejava-apis:6.8.1' + implementation 'com.yqritc:recyclerview-flexibledivider:1.4.0' + implementation 'com.commonsware.cwac:cam2:0.7.4' + implementation 'com.github.maks:AndroidAudioRecorder:0.3.0-jasonette' + implementation 'com.github.florent37:singledateandtimepicker:1.0.8' + implementation 'com.jakewharton.timber:timber:4.7.1' + //noinspection UseOfBundledGooglePlayServices + //implementation 'com.android.support:multidex:1.0.3' + implementation 'androidx.multidex:multidex:2.0.1' + implementation 'com.android.volley:volley:1.1.1' + implementation 'com.facebook.stetho:stetho:1.5.1' + implementation 'com.facebook.stetho:stetho-okhttp3:1.5.1' + implementation 'com.google.android.gms:play-services-vision:18.0.0' + implementation 'com.google.android.gms:play-services-maps:17.0.0' + + implementation 'org.hjson:hjson:3.0.0' +} diff --git a/app/settings/android/example.release.build.gradle b/app/settings/android/example.release.build.gradle new file mode 100644 index 0000000..c6302bf --- /dev/null +++ b/app/settings/android/example.release.build.gradle @@ -0,0 +1,56 @@ +// This file will override ./jasonette/android/app/build.gradle + +buildscript { + repositories { + maven { url 'https://plugins.gradle.org/m2/' } + } +} + +repositories { + maven { url 'https://maven.google.com' } +} + +apply plugin: 'com.android.application' + +android { + compileSdkVersion 28 + buildToolsVersion '28.0.3' + defaultConfig { + applicationId "com.jasonette" + minSdkVersion 22 + targetSdkVersion 26 + versionCode 3 + versionName "0.1.0" + testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner" + multiDexEnabled true + } + // execute `make ki` first to generate jasonette.keystore + // more on https://medium.com/geekculture/react-native-generate-apk-debug-and-release-apk-4e9981a2ea51 + // https://positive-stud.medium.com/step-by-step-guide-to-generate-a-signed-apk-using-android-studio-1e22ab7b3e86 + // https://developer.android.com/training/articles/keystore + signingConfigs { + release { + storeFile file('jasonette.keystore') // default: jasonette.keystore + storePassword 'your_key_store_password' + keyAlias 'your_key_alias' // default: upload + keyPassword 'your_key_file_alias_password' + } + } + buildTypes { + release { + debuggable false + minifyEnabled false + proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro' + + // set the signing config for the release apk + signingConfig signingConfigs.release + } + } + lintOptions { + disable "ResourceType" + } +} + +dependencies { + // deps +} diff --git a/app/settings/android/strings.xml b/app/settings/android/strings.xml new file mode 100644 index 0000000..0e3cb4f --- /dev/null +++ b/app/settings/android/strings.xml @@ -0,0 +1,6 @@ + + + Jasonette + file://hello.json + file://preload.json + diff --git a/docs/.gitkeep b/docs/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/docs/README.pdf b/docs/README.pdf new file mode 100644 index 0000000..211f209 Binary files /dev/null and b/docs/README.pdf differ diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 0000000..b77f0d9 --- /dev/null +++ b/docs/index.html @@ -0,0 +1,804 @@ + + + + + + + +Jasonelle Android Setup Tools + + + + + +
+
+
+
+

These are a bunch of scripts and docker files that will help you +developing apps with Jasonette in Android.

+
+ +
+
+
+

Directory Structure

+
+
+

When unzipping you can see the following directory structure:

+
+
+
+
. (root)
+├── Dockerfile
+├── Makefile
+├── app
+│   ├── build
+│   ├── file
+│   ├── keys
+│   └── settings
+├── docs
+├── jasonette
+└── tools
+    └── windows
+
+
+
+
+
+

Installation

+
+
+

The only requirement is Docker Desktop at least v20.10.0. You can read the installation docs at +https://docs.docker.com/get-docker/. Be sure that is up and running before installing the Jasonelle Android Setup Tools.

+
+
+

Linux/Mac

+
+

Linux and Mac use the Make command. It is a fairly standard tool.

+
+
+ +
+
+

Open the terminal application, go to the root directory and run:

+
+
+
+
$ make install
+
+
+
+
+

Windows

+
+

Open a new cmd application +inside the root directory and execute:

+
+
+
+
.\tools\windows\install.cmd
+
+
+
+
+
+
+

Android

+
+
+

Jasonette

+
+

The main directory is jasonette/android. Here you can put your own jasonette project.

+
+
+
+

Keystore Creation

+
+

Before sending your app to the PlayStore you need to create a new Keystore that will sign the app.

+
+
+

Follow the instructions in the Android Studio Help Center (https://developer.android.com/studio/publish/app-signing.html#generate-key) to generate a new key. It must be different from any previous keys. Alternatively, you can use the following command line to generate a new key:

+
+
+
+
$ keytool -genkeypair -alias upload -keyalg RSA -keysize 2048 -validity 9125 -keystore keystore.jks
+
+
+
+

This key must be a 2048 bit RSA key and have 25-year validity. +Export the certificate for that key to PEM format:

+
+
+
+
$ keytool -export -rfc -alias upload -file upload_certificate.pem -keystore keystore.jks
+
+
+
+
    +
  • +

    Important: Keep in mind that the generated jks or keystore file will be used for signing all future updates of your app. +Please make sure you store it in a safe place. If you lost it, you will need to contact Google Support to upload a new keystore file. The keystore file contains both private and public keys. pem and der files are only public keys.

    +
    • +
  • +

    Extra Important: When creating the keystore the command will ask to input a password. Make sure you use a secure password and remember it. Otherwise your keystore will not be possible to sign the APK and you would need to recreate a new keystore.

    +
    • +
+
+
+

You can use the Keystore Tool to ease the keystore creation.

+
+
+

More information on creating and using a keystore can be found at https://positive-stud.medium.com/step-by-step-guide-to-generate-a-signed-apk-using-android-studio-1e22ab7b3e86 and https://developer.android.com/training/articles/keystore

+
+
+

Example build.gradle

+
+

This is a sample build.gradle file which was configured for using the jasonette.keystore file.

+
+
+
+
    // ...
+    signingConfigs {
+        release {
+            storeFile file('jasonette.keystore')
+            storePassword 'your_key_store_password'
+            keyAlias 'your_key_alias'
+            keyPassword 'your_key_file_alias_password'
+        }
+    }
+    buildTypes {
+        release {
+            debuggable false
+            minifyEnabled false
+            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
+
+            // set the signing config for the release apk
+            signingConfig signingConfigs.release
+        }
+    }
+    // ...
+
+
+
+
+
+

Edit your files

+
+

The main directory for your files is app/file. Where every file here will be copied to jasonette/android. +By default it was included three example apps. Select your initial app in app/settings/android/strings.xml.

+
+
+
+

Edit your settings

+
+

The following files:

+
+
+
    +
  • +

    AndroidManifest.xml

    +
    • +
  • +

    build.gradle

    +
    • +
  • +

    settings.xml

    +
    • +
+
+
+

will be stored inside app/settings/android. They will overwrite the files inside jasonette/android.

+
+
+
+
+
+

Commands

+
+
+

Installation Command

+
+

Use this command to install all the dependencies of Docker and Jasonelle. +This is the first command you must execute before everything else. +Be sure that the Docker Service is running and all the directories +have read/write (chmod 755) permissions.

+
+
+
    +
  • +

    Linux/Mac: $ make install

    +
    • +
  • +

    Windows: .\tools\windows\install.cmd

    +
    • +
+
+
+
+

Download and unzip the android directory

+
+

Danger: It will delete the jasonette/android directory if exists.

+
+
+
    +
  • +

    Linux/Mac: $ make da

    +
    • +
  • +

    Windows: .\tools\windows\android-download-latest.cmd

    +
    • +
+
+
+
+

Create Android Keystore

+
+

Use this command to create a new file *.keystore that will be stored inside app/keys. +This file is needed to build a release APK and sign in.

+
+
+

If you already have a *.keystore file then this step is optional. Be sure to +name the file jasonette.keystore.

+
+
+
    +
  • +

    Linux/Mac: $ make ki

    +
    • +
  • +

    Windows: .\tools\windows\android-key-tool.cmd

    +
    • +
+
+
+
+

Build Android APK in Debug Mode

+
+

Use this command to create an APK in debug mode. +It will copy files inside app/file and app/settings/android. +The APK will be copied to app/build directory.

+
+
+
    +
  • +

    Linux/Mac: $ make bad

    +
    • +
  • +

    Windows: .\tools\windows\android-build-debug.cmd

    +
    • +
+
+
+
+

Build Android APK in Release Mode

+
+

Use this command to create an APK in release mode. +It will copy files inside app/file app/settings/android. +Also it will copy the keystore file. +Make sure your build.gradle file is configured with the keystore file. +The APK will be copied to build/ directory.

+
+
+
    +
  • +

    Linux/Mac: $ make bar

    +
    • +
  • +

    Windows: .\tools\windows\android-build-release.cmd

    +
    • +
+
+
+
+
+
+

License

+
+
+

The following files are under the GNU AFFERO GENERAL PUBLIC LICENSE (Version 3).

+
+
+
    +
  • +

    Dockerfile

    +
    • +
  • +

    Makefile

    +
    • +
  • +

    All files inside tools directory

    +
    • +
+
+
+

Other files are under their respective licenses.

+
+
+
+
+

Credits

+
+Made with ♥ by Ninjas.cl. +
+
+
+ + + \ No newline at end of file diff --git a/jasonette/.gitkeep b/jasonette/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/tools/windows/android-build-debug.cmd b/tools/windows/android-build-debug.cmd new file mode 100644 index 0000000..aaa434d --- /dev/null +++ b/tools/windows/android-build-debug.cmd @@ -0,0 +1,57 @@ +@echo off +rem Configurable +set TAG=jasonette-setup-docker +set KEYSTORE_NAME=jasonette.keystore +set KEYSTORE_ALIAS=upload + +rem == ONLY IF YOU KNOW == +rem Variables +set VERSION=1.0.0 +set PWD="%cd%" +set DOCKER=docker run --rm -it --mount +set BUILDER=%DOCKER% type=bind,source=%PWD%,target=/home/android %TAG% + +rem Gradle needs special directory as root to work +set GRADLE=%DOCKER% type=bind,source=%PWD%\jasonette\android,target=/home/android %TAG% ./gradlew + +rem Curl needs special DNS settings +set CURL=%DOCKER% type=bind,source=%PWD%,target=/files curlimages/curl + +rem Helper Commands +set CP=%BUILDER% cp +set MV=%BUILDER% mv +set KEYTOOL=%BUILDER% keytool +set SH=%BUILDER% /bin/sh -c +set UNZIP=%BUILDER% unzip -u +set REMOVE=%BUILDER% rm -rf +set MKDIR=%BUILDER% mkdir -p +set COPY=%BUILDER% cp +set MOVE=%BUILDER% mv +set RSYNC=%BUILDER% rsync +set IMAGICK=%BUILDER% convert +set KEYTOOL=%BUILDER% keytool +set NODE=%BUILDER% node +set NPM=%BUILDER% npm +set XCODE=%BUILDER% xcodeproj + +rem Commands + +set COPYFILES=%RSYNC% -av ./app/file/ ./jasonette/android/app/src/main/assets/file + +set COPYBUILD=%CP% ./app/settings/android/build.gradle ./jasonette/android/app +set COPYMANIFEST=%CP% ./app/settings/android/AndroidManifest.xml ./jasonette/android/app/src/main +set COPYSTRINGS=%CP% ./app/settings/android/strings.xml ./jasonette/android/app/src/main/res/values + +set COMPILE=%GRADLE% assembleDebug --warning-mode=all --stacktrace +set COPYAPK=%CP% ./jasonette/android/app/build/outputs/apk/debug/app-debug.apk ./app/build/ + +rem Runtime + +%COPYFILES% + +%COPYBUILD% +%COPYMANIFEST% +%COPYSTRINGS% + +%COMPILE% +%COPYAPK% diff --git a/tools/windows/android-build-release.cmd b/tools/windows/android-build-release.cmd new file mode 100644 index 0000000..d3966c9 --- /dev/null +++ b/tools/windows/android-build-release.cmd @@ -0,0 +1,60 @@ +@echo off +rem Configurable +set TAG=jasonette-setup-docker +set KEYSTORE_NAME=jasonette.keystore +set KEYSTORE_ALIAS=upload + +rem == ONLY IF YOU KNOW == +rem Variables +set VERSION=1.0.0 +set PWD="%cd%" +set DOCKER=docker run --rm -it --mount +set BUILDER=%DOCKER% type=bind,source=%PWD%,target=/home/android %TAG% + +rem Gradle needs special directory as root to work +set GRADLE=%DOCKER% type=bind,source=%PWD%\jasonette\android,target=/home/android %TAG% ./gradlew + +rem Curl needs special DNS settings +set CURL=%DOCKER% type=bind,source=%PWD%,target=/files curlimages/curl + +rem Helper Commands +set CP=%BUILDER% cp +set MV=%BUILDER% mv +set KEYTOOL=%BUILDER% keytool +set SH=%BUILDER% /bin/sh -c +set UNZIP=%BUILDER% unzip -u +set REMOVE=%BUILDER% rm -rf +set MKDIR=%BUILDER% mkdir -p +set COPY=%BUILDER% cp +set MOVE=%BUILDER% mv +set RSYNC=%BUILDER% rsync +set IMAGICK=%BUILDER% convert +set KEYTOOL=%BUILDER% keytool +set NODE=%BUILDER% node +set NPM=%BUILDER% npm +set XCODE=%BUILDER% xcodeproj + +rem Commands + +set COPYFILES=%RSYNC% -av ./app/file/ ./jasonette/android/app/src/main/assets/file +set COPYKEYSTORE=%CP% ./app/keys/%KEYSTORE_NAME% ./jasonette/android/app + +set COPYBUILD=%CP% ./app/settings/android/build.gradle ./jasonette/android/app +set COPYMANIFEST=%CP% ./app/settings/android/AndroidManifest.xml ./jasonette/android/app/src/main +set COPYSTRINGS=%CP% ./app/settings/android/strings.xml ./jasonette/android/app/src/main/res/values + +set COMPILE=%GRADLE% assembleRelease --warning-mode=all --stacktrace +set COPYAPK=%CP% ./jasonette/android/app/build/outputs/apk/release/app-release.apk ./app/build/ + +rem Runtime + +%COPYFILES% +%COPYKEYSTORE% + +%COPYBUILD% +%COPYBUILD% +%COPYMANIFEST% +%COPYSTRINGS% + +%COMPILE% +%COPYAPK% diff --git a/tools/windows/android-download-latest.cmd b/tools/windows/android-download-latest.cmd new file mode 100644 index 0000000..311c302 --- /dev/null +++ b/tools/windows/android-download-latest.cmd @@ -0,0 +1,46 @@ +@echo off +rem Configurable +set TAG=jasonette-setup-docker +set KEYSTORE_NAME=jasonette.keystore +set KEYSTORE_ALIAS=upload + +rem == ONLY IF YOU KNOW == +rem Variables +set VERSION=1.0.0 +set PWD="%cd%" +set DOCKER=docker run --rm -it --mount +set BUILDER=%DOCKER% type=bind,source=%PWD%,target=/home/android %TAG% + +rem Gradle needs special directory as root to work +set GRADLE=%DOCKER% type=bind,source=%PWD%\jasonette\android,target=/home/android %TAG% ./gradlew + +rem Curl needs special DNS settings +set CURL=%DOCKER% type=bind,source=%PWD%,target=/files curlimages/curl + +rem Helper Commands +set CP=%BUILDER% cp +set MV=%BUILDER% mv +set KEYTOOL=%BUILDER% keytool +set SH=%BUILDER% /bin/sh -c +set UNZIP=%BUILDER% unzip -u +set REMOVE=%BUILDER% rm -rf +set MKDIR=%BUILDER% mkdir -p +set COPY=%BUILDER% cp +set MOVE=%BUILDER% mv +set RSYNC=%BUILDER% rsync +set IMAGICK=%BUILDER% convert +set KEYTOOL=%BUILDER% keytool +set NODE=%BUILDER% node +set NPM=%BUILDER% npm +set XCODE=%BUILDER% xcodeproj + +rem Commands + +set DOWNLOAD=%CURL% https://github.com/jasonelle/jasonette-android/archive/refs/heads/develop.zip -L -o /files/jasonette/android.zip +set UNARCHIVE=%SH% "cd ./jasonette && unzip ./android.zip && rm -rf ./android && mv ./jasonette-android-develop ./android && rm android.zip" + +rem Runtime + +%DOWNLOAD% +%UNARCHIVE% + diff --git a/tools/windows/android-key-tool.cmd b/tools/windows/android-key-tool.cmd new file mode 100644 index 0000000..c997100 --- /dev/null +++ b/tools/windows/android-key-tool.cmd @@ -0,0 +1,47 @@ +@echo off +rem Configurable +set TAG=jasonette-setup-docker +set KEYSTORE_NAME=jasonette.keystore +set KEYSTORE_ALIAS=upload + +rem == ONLY IF YOU KNOW == +rem Variables +set VERSION=1.0.0 +set PWD="%cd%" +set DOCKER=docker run --rm -it --mount +set BUILDER=%DOCKER% type=bind,source=%PWD%,target=/home/android %TAG% + +rem Gradle needs special directory as root to work +set GRADLE=%DOCKER% type=bind,source=%PWD%\jasonette\android,target=/home/android %TAG% ./gradlew + +rem Curl needs special DNS settings +set CURL=%DOCKER% type=bind,source=%PWD%,target=/files curlimages/curl + +rem Helper Commands +set CP=%BUILDER% cp +set MV=%BUILDER% mv +set KEYTOOL=%BUILDER% keytool +set SH=%BUILDER% /bin/sh -c +set UNZIP=%BUILDER% unzip -u +set REMOVE=%BUILDER% rm -rf +set MKDIR=%BUILDER% mkdir -p +set COPY=%BUILDER% cp +set MOVE=%BUILDER% mv +set RSYNC=%BUILDER% rsync +set IMAGICK=%BUILDER% convert +set KEYTOOL=%BUILDER% keytool +set NODE=%BUILDER% node +set NPM=%BUILDER% npm +set XCODE=%BUILDER% xcodeproj + +rem Commands + +set CMDGENKEY=%KEYTOOL% -genkey -v -keystore %KEYSTORE_NAME% -alias %KEYSTORE_ALIAS% -keyalg RSA -keysize 2048 -validity 9125 +set CMDCP=%CP% ./%KEYSTORE_NAME% ./jasonette/android/app +set CMDMV=%MV% ./%KEYSTORE_NAME% ./app/keys/%KEYSTORE_NAME% + +rem Runtime + +%CMDGENKEY% +%CMDCP% +%CMDMV% diff --git a/tools/windows/install.cmd b/tools/windows/install.cmd new file mode 100644 index 0000000..82c28ce --- /dev/null +++ b/tools/windows/install.cmd @@ -0,0 +1,49 @@ +@echo off +rem Configurable +set TAG=jasonette-setup-docker +set KEYSTORE_NAME=jasonette.keystore +set KEYSTORE_ALIAS=upload + +rem == ONLY IF YOU KNOW == +rem Variables +set VERSION=1.0.0 +set PWD="%cd%" +set DOCKER=docker run --rm -it --mount +set BUILDER=%DOCKER% type=bind,source=%PWD%,target=/home/android %TAG% + +rem Gradle needs special directory as root to work +set GRADLE=%DOCKER% type=bind,source=%PWD%\jasonette\android,target=/home/android %TAG% ./gradlew + +rem Curl needs special DNS settings +set CURL=%DOCKER% type=bind,source=%PWD%,target=/files curlimages/curl + +rem Helper Commands +set CP=%BUILDER% cp +set MV=%BUILDER% mv +set KEYTOOL=%BUILDER% keytool +set SH=%BUILDER% /bin/sh -c +set UNZIP=%BUILDER% unzip -u +set REMOVE=%BUILDER% rm -rf +set MKDIR=%BUILDER% mkdir -p +set COPY=%BUILDER% cp +set MOVE=%BUILDER% mv +set RSYNC=%BUILDER% rsync +set IMAGICK=%BUILDER% convert +set KEYTOOL=%BUILDER% keytool +set NODE=%BUILDER% node +set NPM=%BUILDER% npm +set XCODE=%BUILDER% xcodeproj + +rem Commands +set BUILD=docker build -t %TAG% . + +rem Runtime + +@echo "" +@echo " ╦┌─┐┌─┐┌─┐┌┐┌┌─┐┬ ┬ ┌─┐" +@echo " ║├─┤└─┐│ ││││├┤ │ │ ├┤ " +@echo "╚╝┴ ┴└─┘└─┘┘└┘└─┘┴─┘┴─┘└─┘" +@echo " Android Setup Tool v%VERSION%" +@echo "" + +%BUILD%