diff --git a/LICENSE b/LICENSE index edc46f3..f288702 100644 --- a/LICENSE +++ b/LICENSE @@ -1,21 +1,674 @@ -This is free and unencumbered software released into the public domain. + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 -Anyone is free to copy, modify, publish, use, compile, sell, or distribute this -software, either in source code form or as a compiled binary, for any purpose, -commercial or non-commercial, and by any means. + 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. -In jurisdictions that recognize copyright laws, the author or authors of this -software dedicate any and all copyright interest in the software to the public -domain. We make this dedication for the benefit of the public at large and to -the detriment of our heirs and successors. We intend this dedication to be an -overt act of relinquishment in perpetuity of all present and future rights to -this software under copyright law. + Preamble -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN -ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION -WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + The GNU General Public License is a free, copyleft license for +software and other kinds of works. -For more information, please refer to + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md index d3b340e..d2d6e3c 100644 --- a/README.md +++ b/README.md @@ -402,4 +402,12 @@ sylvia-touch-relay/ - De HMAC key wordt in de app opgeslagen via `EncryptedSharedPreferences` (AES256-GCM) via `PrefsHelper`. Dit versleutelt de key at-rest, in tegenstelling tot gewone SharedPreferences waarbij waarden plaintext op schijf staan. - Bij geweigerde BLE-permissies wordt de HOLD-knop uitgeschakeld en toont de app "Permissies geweigerd — open Instellingen" met een link naar de systeem-instellingen. - De BLE-scan wordt in `onPause` betrouwbaar gestopt via `handler.removeCallbacks(scanRunnable)`, wat voorkomt dat scans doordraaien op de achtergrond. -- Het firmware flash-proces is annuleerbaar: `EspFlasher` gebruikt een `@Volatile cancelled` flag met checkpoints in de flash-lus. `SettingsActivity.onDestroy` roept `flasher?.cancel()` aan. \ No newline at end of file +- Het firmware flash-proces is annuleerbaar: `EspFlasher` gebruikt een `@Volatile cancelled` flag met checkpoints in de flash-lus. `SettingsActivity.onDestroy` roept `flasher?.cancel()` aan. + +## Licentie + +Dit project is gelicentieerd onder de **GNU General Public License v3.0 of later** (GPL-3.0-or-later). + +Deze licentie is vereist omdat de app gebruik maakt van [`esp32-flash-lib`](https://github.com/dkaukov/esp32-flash) (GPL-3.0), een library voor het flashen van ESP32 firmware. De GPL-3.0 copyleft-clausule bepaalt dat een werk dat aan een GPL-3.0 werk linkt zelf ook onder GPL-3.0 (of een compatibele licentie) moet worden gedistribueerd. + +Zie het `LICENSE` bestand voor de volledige licentietekst. \ No newline at end of file diff --git a/android/app/build.gradle b/android/app/build.gradle index 6379aca..5d313c3 100644 --- a/android/app/build.gradle +++ b/android/app/build.gradle @@ -43,4 +43,5 @@ dependencies { implementation 'com.eclipsesource.minimal-json:minimal-json:0.9.5' implementation 'org.slf4j:slf4j-nop:2.0.16' implementation 'androidx.security:security-crypto:1.1.0-alpha06' + implementation 'androidx.lifecycle:lifecycle-runtime-ktx:2.7.0' } \ No newline at end of file diff --git a/android/app/src/main/java/com/eddy/atomrelay/EspFlasher.kt b/android/app/src/main/java/com/eddy/atomrelay/EspFlasher.kt index 480c410..ffda218 100644 --- a/android/app/src/main/java/com/eddy/atomrelay/EspFlasher.kt +++ b/android/app/src/main/java/com/eddy/atomrelay/EspFlasher.kt @@ -1,15 +1,18 @@ +// SPDX-License-Identifier: GPL-3.0-or-later package com.eddy.atomrelay import android.content.Context import android.hardware.usb.UsbConstants import android.hardware.usb.UsbDevice import android.hardware.usb.UsbManager -import android.os.Handler -import android.os.Looper import android.util.Log +import kotlinx.coroutines.CancellationException +import kotlinx.coroutines.ensureActive +import kotlinx.coroutines.withContext import org.dkaukov.esp32.core.EspFlasherApi import org.dkaukov.esp32.io.ProgressCallback import java.io.IOException +import kotlin.coroutines.coroutineContext class EspFlasher(private val context: Context) { @@ -19,12 +22,8 @@ class EspFlasher(private val context: Context) { interface FlashCallback { fun onProgress(percent: Int, message: String) - fun onComplete() - fun onError(message: String) } - private val handler = Handler(Looper.getMainLooper()) - @Volatile private var cancelled = false @@ -32,16 +31,18 @@ class EspFlasher(private val context: Context) { cancelled = true } - fun flashDevice(usbManager: UsbManager, device: UsbDevice, callback: FlashCallback) { + suspend fun flashDevice(usbManager: UsbManager, device: UsbDevice, callback: FlashCallback) { cancelled = false - Thread { - try { + try { + withContext(kotlinx.coroutines.Dispatchers.IO) { doFlash(usbManager, device, callback) - } catch (e: Exception) { - Log.e(TAG, "Flash failed", e) - handler.post { callback.onError(e.message ?: "Onbekende fout") } } - }.start() + } catch (e: CancellationException) { + throw e + } catch (e: Exception) { + Log.e(TAG, "Flash failed", e) + throw e + } } private class FlashStep( @@ -53,9 +54,9 @@ class EspFlasher(private val context: Context) { val compress: Boolean ) - private fun doFlash(usbManager: UsbManager, device: UsbDevice, callback: FlashCallback) { - Thread.sleep(500) - if (cancelled) return + private suspend fun doFlash(usbManager: UsbManager, device: UsbDevice, callback: FlashCallback) { + kotlinx.coroutines.delay(500) + checkCancelled() val connection = usbManager.openDevice(device) ?: throw IOException("Kan USB-apparaat niet openen") @@ -73,10 +74,10 @@ class EspFlasher(private val context: Context) { val epIn = UsbUtils.findBulkEndpoint(intf, UsbConstants.USB_DIR_IN) ?: throw IOException("Geen USB IN endpoint gevonden") - postProgress(callback, 0, "Verbinden met ESP bootloader...") + callback.onProgress(0, "Verbinden met ESP bootloader...") val transport = UsbSerialTransport(connection, epOut, epIn) - if (cancelled) return + checkCancelled() val assets = context.assets val bootloader = assets.open("firmware/bootloader.bin").readBytes() @@ -84,8 +85,6 @@ class EspFlasher(private val context: Context) { val bootApp0 = assets.open("firmware/boot_app0.bin").readBytes() val firmware = assets.open("firmware/firmware.bin").readBytes() - val totalSize = bootloader.size + partitions.size + bootApp0.size + firmware.size - val steps = listOf( FlashStep("Bootloader", 0x0, bootloader, 30, 10, false), FlashStep("Partitie tabel", 0x8000, partitions, 40, 10, false), @@ -93,7 +92,7 @@ class EspFlasher(private val context: Context) { FlashStep("Firmware", 0x10000, firmware, 60, 35, true) ) - postProgress(callback, 5, "Sync met bootloader...") + callback.onProgress(5, "Sync met bootloader...") val api = EspFlasherApi.connect(transport) .withCallBack(object : ProgressCallback { override fun onProgress(pct: Float) { @@ -104,42 +103,42 @@ class EspFlasher(private val context: Context) { } }) - postProgress(callback, 10, "Chip detecteren...") + callback.onProgress(10, "Chip detecteren...") val detected = api.chipDetect() val chipId = detected.getChipId() Log.i(TAG, "Detected chip: $chipId") - postProgress(callback, 15, "Chip: ${chipId.readableName}") + callback.onProgress(15, "Chip: ${chipId.readableName}") - postProgress(callback, 20, "Stub laden...") + callback.onProgress(20, "Stub laden...") val stub = detected.loadStub() - postProgress(callback, 25, "Flash wissen...") + callback.onProgress(25, "Flash wissen...") stub.eraseFlash() for (step in steps) { - if (cancelled) return + checkCancelled() val sizeStr = if (step.data.size > 1024) "${step.data.size / 1024}KB" else "${step.data.size} bytes" - postProgress(callback, step.baseProgress, "${step.name} schrijven ($sizeStr)...") + callback.onProgress(step.baseProgress, "${step.name} schrijven ($sizeStr)...") val writeStub = if (step.compress) stub.withCompression(true) else stub.withCompression(false) writeStub.writeFlash(step.address, step.data) val endProgress = step.baseProgress + step.range - postProgress(callback, endProgress.coerceAtMost(95), "${step.name} geschreven") + callback.onProgress(endProgress.coerceAtMost(95), "${step.name} geschreven") } - postProgress(callback, 95, "ESP resetten...") + callback.onProgress(95, "ESP resetten...") stub.reset() - postProgress(callback, 100, "Firmware geflashed!") - handler.post { callback.onComplete() } + callback.onProgress(100, "Firmware geflashed!") } finally { connection.close() } } - private fun postProgress(callback: FlashCallback, percent: Int, message: String) { - Log.d(TAG, "Progress $percent%: $message") - handler.post { callback.onProgress(percent, message) } + private suspend fun checkCancelled() { + if (cancelled) { + coroutineContext.ensureActive() + } } } diff --git a/android/app/src/main/java/com/eddy/atomrelay/MainActivity.kt b/android/app/src/main/java/com/eddy/atomrelay/MainActivity.kt index 6ef54c3..d83c695 100644 --- a/android/app/src/main/java/com/eddy/atomrelay/MainActivity.kt +++ b/android/app/src/main/java/com/eddy/atomrelay/MainActivity.kt @@ -1,3 +1,4 @@ +// SPDX-License-Identifier: GPL-3.0-or-later package com.eddy.atomrelay import android.Manifest diff --git a/android/app/src/main/java/com/eddy/atomrelay/PrefsHelper.kt b/android/app/src/main/java/com/eddy/atomrelay/PrefsHelper.kt index 4a4fec5..2eff494 100644 --- a/android/app/src/main/java/com/eddy/atomrelay/PrefsHelper.kt +++ b/android/app/src/main/java/com/eddy/atomrelay/PrefsHelper.kt @@ -1,3 +1,4 @@ +// SPDX-License-Identifier: GPL-3.0-or-later package com.eddy.atomrelay import android.content.Context diff --git a/android/app/src/main/java/com/eddy/atomrelay/SettingsActivity.kt b/android/app/src/main/java/com/eddy/atomrelay/SettingsActivity.kt index 5172b92..cc30e0b 100644 --- a/android/app/src/main/java/com/eddy/atomrelay/SettingsActivity.kt +++ b/android/app/src/main/java/com/eddy/atomrelay/SettingsActivity.kt @@ -1,3 +1,4 @@ +// SPDX-License-Identifier: GPL-3.0-or-later package com.eddy.atomrelay import android.app.AlertDialog @@ -13,14 +14,17 @@ import android.hardware.usb.UsbEndpoint import android.hardware.usb.UsbInterface import android.hardware.usb.UsbManager import android.os.Bundle -import android.os.Handler -import android.os.Looper import android.util.Log import android.widget.Button import android.widget.ProgressBar import android.widget.TextView import android.widget.Toast import androidx.appcompat.app.AppCompatActivity +import androidx.lifecycle.lifecycleScope +import kotlinx.coroutines.Dispatchers +import kotlinx.coroutines.withContext +import kotlinx.coroutines.launch +import kotlinx.coroutines.withContext import java.nio.charset.StandardCharsets import java.security.SecureRandom @@ -44,7 +48,6 @@ class SettingsActivity : AppCompatActivity() { private var progressDialog: AlertDialog? = null private var dialog: AlertDialog? = null private var flasher: EspFlasher? = null - private val handler = Handler(Looper.getMainLooper()) private val usbAttachedReceiver = object : BroadcastReceiver() { override fun onReceive(context: Context, intent: Intent) { @@ -123,9 +126,9 @@ class SettingsActivity : AppCompatActivity() { currentAction = UsbAction.NONE flasher?.cancel() flasher = null - try { unregisterReceiver(usbAttachedReceiver) } catch (e: Exception) {} - try { unregisterReceiver(usbPermissionReceiver) } catch (e: Exception) {} - try { unregisterReceiver(usbDetachedReceiver) } catch (e: Exception) {} + try { unregisterReceiver(usbAttachedReceiver) } catch (_: Exception) {} + try { unregisterReceiver(usbPermissionReceiver) } catch (_: Exception) {} + try { unregisterReceiver(usbDetachedReceiver) } catch (_: Exception) {} } override fun onSupportNavigateUp(): Boolean { @@ -155,30 +158,30 @@ class SettingsActivity : AppCompatActivity() { private fun doKeyExchange(usbManager: UsbManager, device: UsbDevice) { showProgressDialog("Sleutel Uitwisselen", "Sleutel uitlezen...", STYLE_SPINNER) - Thread { + lifecycleScope.launch(Dispatchers.IO) { val result = readKeyFromEsp(usbManager, device) - if (isFinishing || isDestroyed) return@Thread - handler.post { + withContext(Dispatchers.Main) { + if (isFinishing || isDestroyed) return@withContext when (result) { is KeyResult.Success -> { val prefs = PrefsHelper.getPrefs(this@SettingsActivity) prefs.edit().putString(PrefsHelper.PREF_KEY, result.hexKey).apply() - Toast.makeText(this, "Beveiligingssleutel gelezen", Toast.LENGTH_LONG).show() + Toast.makeText(this@SettingsActivity, "Beveiligingssleutel gelezen", Toast.LENGTH_LONG).show() cleanupAction() setResult(RESULT_SCAN) finish() } is KeyResult.Error -> { - Toast.makeText(this, "Sleutel uitwisselen mislukt - probeer opnieuw", Toast.LENGTH_LONG).show() + Toast.makeText(this@SettingsActivity, "Sleutel uitwisselen mislukt - probeer opnieuw", Toast.LENGTH_LONG).show() cleanupAction() } null -> { - Toast.makeText(this, "Sleutel uitwisselen mislukt - probeer opnieuw", Toast.LENGTH_SHORT).show() + Toast.makeText(this@SettingsActivity, "Sleutel uitwisselen mislukt - probeer opnieuw", Toast.LENGTH_SHORT).show() cleanupAction() } } } - }.start() + } } // === Firmware Flashing === @@ -209,42 +212,41 @@ class SettingsActivity : AppCompatActivity() { showProgressDialog("Firmware Flashen", "Initialiseren...", STYLE_HORIZONTAL) flasher = EspFlasher(this) - flasher?.flashDevice(usbManager, device, object : EspFlasher.FlashCallback { + val progressCallback = object : EspFlasher.FlashCallback { override fun onProgress(percent: Int, message: String) { - runOnUiThread { - val d = progressDialog ?: return@runOnUiThread + lifecycleScope.launch(Dispatchers.Main) { + val d = progressDialog ?: return@launch d.findViewById(R.id.progressBar)?.progress = percent d.findViewById(R.id.message)?.text = message } } - - override fun onComplete() { - runOnUiThread { - currentAction = UsbAction.NONE - progressDialog?.dismiss() - progressDialog = null - dialog = AlertDialog.Builder(this@SettingsActivity) - .setTitle("Firmware Flashen") - .setMessage("Firmware geflashed!\n\nOntkoppel de ESP en sluit opnieuw aan om de sleutel in te stellen.") - .setPositiveButton("Sluiten") { d, _ -> - d.dismiss() - dialog = null - } - .setCancelable(true) - .setOnCancelListener { dialog = null } - .show() - } + } + lifecycleScope.launch { + try { + flasher?.flashDevice(usbManager, device, progressCallback) + if (isFinishing || isDestroyed) return@launch + currentAction = UsbAction.NONE + progressDialog?.dismiss() + progressDialog = null + dialog = AlertDialog.Builder(this@SettingsActivity) + .setTitle("Firmware Flashen") + .setMessage("Firmware geflashed!\n\nOntkoppel de ESP en sluit opnieuw aan om de sleutel in te stellen.") + .setPositiveButton("Sluiten") { d, _ -> + d.dismiss() + dialog = null + } + .setCancelable(true) + .setOnCancelListener { dialog = null } + .show() + } catch (e: kotlinx.coroutines.CancellationException) { + cleanupAction() + } catch (e: Exception) { + progressDialog?.dismiss() + progressDialog = null + Toast.makeText(this@SettingsActivity, "Flashen mislukt: ${e.message}", Toast.LENGTH_LONG).show() + cleanupAction() } - - override fun onError(message: String) { - runOnUiThread { - progressDialog?.dismiss() - progressDialog = null - Toast.makeText(this@SettingsActivity, "Flashen mislukt: $message", Toast.LENGTH_LONG).show() - cleanupAction() - } - } - }) + } } // === USB dispatch === @@ -403,7 +405,7 @@ class SettingsActivity : AppCompatActivity() { Log.e(TAG, "Key exchange error", e) return KeyResult.Error("Fout: ${e.message}") } finally { - try { connection.close() } catch (e: Exception) {} + try { connection.close() } catch (_: Exception) {} } } diff --git a/android/app/src/main/java/com/eddy/atomrelay/UsbSerialTransport.kt b/android/app/src/main/java/com/eddy/atomrelay/UsbSerialTransport.kt index 03dffaa..49dc1a0 100644 --- a/android/app/src/main/java/com/eddy/atomrelay/UsbSerialTransport.kt +++ b/android/app/src/main/java/com/eddy/atomrelay/UsbSerialTransport.kt @@ -1,3 +1,4 @@ +// SPDX-License-Identifier: GPL-3.0-or-later package com.eddy.atomrelay import android.hardware.usb.UsbConstants diff --git a/android/app/src/main/java/com/eddy/atomrelay/UsbUtils.kt b/android/app/src/main/java/com/eddy/atomrelay/UsbUtils.kt index a829fd6..5ec1f01 100644 --- a/android/app/src/main/java/com/eddy/atomrelay/UsbUtils.kt +++ b/android/app/src/main/java/com/eddy/atomrelay/UsbUtils.kt @@ -1,3 +1,4 @@ +// SPDX-License-Identifier: GPL-3.0-or-later package com.eddy.atomrelay import android.hardware.usb.UsbConstants diff --git a/appstore.md b/appstore.md new file mode 100644 index 0000000..abb4861 --- /dev/null +++ b/appstore.md @@ -0,0 +1,205 @@ +# App Store Publicatie — Sylvia Touch Relay + +## Licentie-overzicht Dependencies + +| Dependency | Versie | Licentie | Copyleft? | FOSS? | +|---|---|---|---|---| +| `io.github.dkaukov:esp32-flash-lib` | 1.1.17 | **GPL-3.0** | Ja (strong) | Ja | +| `com.eclipsesource.minimal-json:minimal-json` | 0.9.5 | MIT | Nee | Ja | +| `org.slf4j:slf4j-nop` | 2.0.16 | MIT | Nee | Ja | +| `androidx.security:security-crypto` | 1.1.0-alpha06 | Apache 2.0 | Nee | Ja | +| `androidx.core:core-ktx` | 1.12.0 | Apache 2.0 | Nee | Ja | +| `androidx.appcompat:appcompat` | 1.6.1 | Apache 2.0 | Nee | Ja | + +### GPL-3.0 Copyleft Implicatie + +`esp32-flash-lib` is GPL-3.0. Een app die ertoe linkt (compile-time dependency) moet zelf ook GPL-3.0 (of compatibele licentie) zijn. Dit betekent: + +- App **moet** onder GPL-3.0 worden uitgebracht +- Source code moet beschikbaar blijven (GitHub volstaat) +- Geen proprietary SDKs linken (niet van toepassing) +- Voor andere stores (Amazon, Samsung) is dit geen belemmering + +### Actie: GPL-3.0 toepassen ✅ Voltooid + +1. ✅ `LICENSE` file toevoegen in repo root (volledige GPL-3.0 tekst) +2. ✅ Source file headers toevoegen: `// SPDX-License-Identifier: GPL-3.0-or-later` in alle 6 Kotlin bestanden +3. ✅ `README.md` licentiesectie bijwerken + +--- + +## Google Play Store + +### Vereisten (2026) + +| Vereiste | Status | Opmerking | +|---|---|---| +| Ontwikkelaarsaccount | ❌ Nog aanmaken | $25 eenmalig | +| Overheids-ID verificatie | ❌ Nog doen | Paspoort/rijbewijs + selfie | +| AAB formaat (geen APK) | ❌ Release build nodig | Nu alleen debug | +| Release signing key | ❌ Aanmaken | `keytool` of Play App Signing | +| targetSdk ≥ 35 | ❌ Nu 34 | Verplicht; ≥ 36 vanaf 31 aug 2026 | +| App icoon (mipmap) | ❌ Ontbreekt | Geen mipmap resources aanwezig | +| Privacy Policy URL | ❌ Nodig | Website of GitHub Pages | +| Data Safety formulier | ❌ Invullen | In Play Console | +| IARC content rating | ❌ Invullen | Vragenlijst in Play Console | +| App signing | ⚠️ Keuze | Play App Signing (aanbevolen) of eigen key | +| `minifyEnabled true` | ⚠️ Aanbevolen | Proguard/R8 rules ontbreken nog | +| `ACCESS_FINE_LOCATION` | ⚠️ Mogelijk overbodig | Sinds Android 12 niet meer nodig voor BLE scan | + +### Closed Testing Verplichting + +Nieuwe persoonlijke accounts moeten **closed testing** doorlopen: + +- Minimaal **12 testers** +- Minimaal **14 opeenvolgende dagen** testen +- Testers moeten de app actief gebruiken +- Na goedkeuring: pas dan kan de app publiek + +### Publicatie Stappenplan + +1. Ontwikkelaarsaccount aanmaken + ID verificatie +2. `targetSdk` upgraden naar 35 (codereview #7.2) +3. App icoon ontwerpen + mipmap resources toevoegen +4. Release build configureren (signing, minify, proguard) +5. Privacy Policy pagina maken (GitHub Pages of statische site) +6. AAB build maken: `./gradlew bundleRelease` +7. Closed testing opzetten met 12 testers +8. Na 14 dagen: productie-release indienen + +--- + +## Alternatieve App Stores + +### Vergelijking + +| Store | Kosten | Review tijd | GMS nodig? | FOSS verplicht? | Relevante beperking | +|---|---|---|---|---|---| +| **Samsung Galaxy Store** | Gratis | Weken | Nee | Nee | 16KB page size verplicht voor native libs | +| **Amazon Appstore** | $0 | ~1 dag | Nee | Nee | Laagste drempel, grote userbase (Fire TV/tablets) | +| **F-Droid** | $0 | 2-3 weken | Nee | **Ja** | Bouwt zelf vanuit source; hele codebase + deps moeten FOSS | +| **Huawei AppGallery** | Gratis | Dagen | Nee | Nee | ID verificatie verplicht | +| **Aptoide** | $0 | Uren | Nee | Nee | Minimale review, minder vertrouwd | + +### F-Droid Specifiek + +- **Compatibel**: alle deps zijn FOSS (GPL-3.0, MIT, Apache 2.0) +- **Vereist**: app moet open-source licentie hebben → GPL-3.0 (verplicht door esp32-flash-lib copyleft) +- **Proces**: F-Droid bouwt de app zelf vanuit source (geen APK/AAB upload) +- **Aanvraag**: merge request in [fdroiddata](https://gitlab.com/fdroid/fdroiddata) repo met build recipe +- **Voordelen**: geen ontwikkelaarskosten, geen account nodig, vertrouwd door FOSS-gemeenschap +- **Nadelen**: kleine userbase, geen automatische updates buiten F-Droid client + +### Amazon Appstore Specifiek + +- **Laagste drempel**: gratis, snelle review (~1 dag), geen ID verificatie +- **Bereik**: Fire TV, Fire tablets, Kindle — niche maar relevant voor IoT-apps +- **Formaat**: APK of AAB +- **Aanmelden**: [developer.amazon.com](https://developer.amazon.com) + +### Samsung Galaxy Store Specifiek + +- **Bereik**: alleen Samsung Galaxy toestellen (groot marktaandeel, maar exclusief) +- **Niet-Samsung**: Galaxy Store kan officieel alleen op Samsung toestellen; sideloading APK op andere merken werkt onbetrouwbaar (ROM-afhankelijkheden, craches, geen updates) +- **16KB page size**: als de app native libraries bevat, moeten deze met 16KB page alignment worden gebuild. Onze app heeft geen native libs, dus geen probleem. +- **Aanmelden**: [seller.samsungapps.com](https://seller.samsungapps.com) + +### Aptoide + +- **Niet zelf-hosted**: jouw store draait binnen Aptoide's infrastructuur, niet op eigen server +- **Gebruikers moeten eerst Aptoide client installeren** voordat ze jouw store kunnen vinden +- **Data breach**: 2020 — 20M gebruikersgegevens gelekt +- **Review**: minimaal (uren), maar minder vertrouwd bij gebruikers +- **Geschikt voor**: grote distributie, niet voor 1-2 apps → overkill voor ons + +--- + +## Eigen App Store (Self-Hosted) + +Technisch is een eigen app store simpel: APK hosten op een webserver, gebruiker downloadt direct. Android staat installatie uit onbekende bronnen toe. Er zijn geen Google-licenties of -toestemmingen nodig om een app store te runnen. + +### Praktische Overwegingen + +- Gebruiker moet "Installatie uit onbekende bronnen" inschakelen; Google Play Protect waarschuwt +- Geen automatische updates tenzij je zelf een update-check in de app bouwt +- **Android Developer Verificatie (vanaf 2027 globaal)**: Google vereist identity verification + package name registratie via Android Developer Console voor installatie op gecertificeerde apparaten. Dit geldt voor óók sideloading. De verificatie is gratis (geen $25 Play-account nodig), maar vereist legitimatiebewijs. + +### Self-Hosted Oplossingen Vergelijking + +| Aspect | Selfdroid | Aptoide | Simpele webpagina | +|---|---|---|---| +| **Zelf-hosted** | ✅ Ja | ❌ Nee (Aptoide's ecosysteem) | ✅ Ja | +| **Installatie voor gebruiker** | URL in browser → download APK | Eerst Aptoide client, dan store zoeken | URL → download APK | +| **Licentie** | BSD 3-clause | Propriëtair | NVT | +| **Setup** | Python/Flask + nginx + uWSGI | Account op aptoide.com | Statische HTML | +| **Admin paneel** | ✅ Met wachtwoordbeveiliging | Via Aptoide dashboard | Handmatig upload | +| **APK metadata extractie** | ✅ Automatisch (naam, versie, icoon) | ✅ Automatisch | Nee | +| **Android companion app** | Gepland, nooit gebouwd | ✅ Aptoide client | Nee | +| **Data breach history** | Nee | Ja (2020, 20M gebruikers) | Nee | +| **Geschikt voor 1 app** | ✅ Perfect | ❌ Overkill | ✅ Simpelst | + +### Aanrader: Selfdroid + +**Selfdroid** ([vitlabuda/selfdroid-web-app](https://github.com/vitlabuda/selfdroid-web-app)) — self-hosted Android app store, Python/Flask, BSD-licentie. + +Voordelen: +- Admin uploadt APK, metadata automatisch geëxtraheerd +- Gebruikers openen URL op telefoon → downloaden APK direct vanuit browser +- Geen extra app installatie nodig voor gebruikers +- Lichtgewicht: Python 3.7+, Flask, nginx + uWSGI +- Kan op bestaande server draaien +- BSD-licentie compatibel met onze GPL-3.0 app + +Deploy stappen: +1. Clone repo, configureer `Settings.py` (admin wachtwoord) +2. `./prepare.sh` voor Python venv + dependencies +3. nginx vhost + uWSGI config (meegeleverd in repo) +4. Upload APK via admin paneel +5. Deel URL met gebruikers + +Alternatief voor maximale eenvoud: APK op GitHub Releases hosten + simpele downloadpagina (GitHub Pages). Geen server nodig, maar geen auto-metadata of admin paneel. + +--- + +## Multi-Channel Distributiestrategie + +We publiceren parallel via meerdere kanalen. Geen exclusiviteit — Android staat meerdere distributiekanalen naast elkaar toe. + +| Kanaal | Bereik | Kosten | Beheer | Prioriteit | +|---|---|---|---|---| +| **F-Droid** | FOSS-gebruikers wereldwijd | Gratis | MR in fdroiddata, F-Droid bouwt zelf | 1e | +| **Samsung Galaxy Store** | Samsung-gebruikers | Gratis | Upload AAB, Samsung review | 2e | +| **Eigen store (Selfdroid)** | Iedereen met directe link | Hosting alleen | APK upload via admin paneel | 3e | +| **Google Play Store** | Grootste bereik | $25 + ID verificatie | Veel vereisten, closed testing | 4e | + +### Volgorde + +1. **F-Droid** — geen kosten, F-Droid bouwt zelf vanuit source, vertrouwd kanaal +2. **Samsung Galaxy Store** — gratis, bereikt Samsung-gebruikers die geen F-Droid hebben +3. **Selfdroid (eigen store)** — APK distributie voor iedereen buiten F-Droid/Samsung, geen goedkeuringsproces +4. **Google Play Store** — grootste bereik maar veel vereisten (account, closed testing, targetSdk 35) + +### Benodigde stappen vóór publicatie (alle kanalen) + +| Stap | F-Droid | Galaxy Store | Eigen store | Google Play | +|---|---|---|---|---| +| GPL-3.0 licentie | ✅ Gedaan | — | — | — | +| Release build (signed) | F-Droid bouwt zelf | ✅ Nodig | ✅ Nodig | ✅ Nodig (AAB) | +| App icoon (mipmap) | ✅ Nodig | ✅ Nodig | — | ✅ Nodig | +| targetSdk ≥ 35 | — | — | — | ✅ Verplicht | +| Privacy Policy URL | — | — | — | ✅ Verplicht | +| Developer verificatie | — | — | 2027 | ✅ Automatisch | +| Proguard rules | Aanbevolen | Aanbevolen | — | Aanbevolen | + +--- + +## Openstaande Codereview Punten die Publicatie Blokkeren + +| # | Prioriteit | Bevinding | Relevantie voor publicatie | +|---|---|---|---| +| 7.2 | LAAG | compileSdk/targetSdk → 35 | **Blokkeert Google Play** | +| 4.5 | LAAG | Proguard rules | **Aanbevolen** voor release build | +| 6.2 | LAAG | Dark mode | Gebruikerservaring | +| — | — | App icoon (mipmap) | **Verplicht** voor alle stores | +| — | — | Release build signing | **Verplicht** voor alle stores | +| — | — | Privacy Policy URL | **Verplicht** voor Google Play | diff --git a/esplibalternatief.md b/esplibalternatief.md new file mode 100644 index 0000000..756facc --- /dev/null +++ b/esplibalternatief.md @@ -0,0 +1,62 @@ +# ESP32 Flash Library Alternatieven + +## Huidige Situatie + +We gebruiken `io.github.dkaukov:esp32-flash-lib:1.1.17` (Java, GPL-3.0). Deze GPL-3.0 licentie dwingt copyleft af: de hele app moet GPL-3.0-compatibel zijn. Dat blokkeert een MIT/Apache licentie voor de app. + +## Alternatieven + +| Library | Taal | Licentie | Sterren | Serial interface | Laatste update | +|---|---|---|---|---|---| +| **loucass003/EspflashKotlin** | Kotlin | **Apache 2.0** | 3 | JSerialComm (pluggable) | jan 2026 | +| dkaukov/esp32-flash-lib | Java | GPL-3.0 | — | JSerialComm | — | +| bdureau/ESPLoader | Java | GPL-3.0 | 22 | JSerialComm | jan 2026 | + +### loucass003/EspflashKotlin (Apache 2.0) + +- Repo: https://github.com/loucass003/EspflashKotlin +- JitPack: `com.github.loucass003:EspflashKotlin:` +- 3 stars, 1 fork, 28 commits +- Pluggable serial interface: implementeer `FlasherSerialInterface` zelf +- Ondersteunt `.addBin(bytes, address)` voor meerdere binaries +- Progress listener via `FlashingProgressListener` +- Geen Maven Central publicatie — via JitPack + +**Voordelen:** +- Apache 2.0 — app mag onder MIT/Apache/GPL naar keuze +- Kotlin-native (past bij onze codebase) +- Pluggable serial: we kunnen onze eigen USB serial implementatie aanhaken + +**Nadelen:** +- Erg klein project (3 stars, lage adoptie) +- Geen Maven Central — JitPack dependency (minder betrouwbaar voor productie) +- Minder getest dan esp32-flash-lib +- Serial interface adapter moet worden geschreven voor onze USB/BLE implementatie +- Geen stub loader (esptool stub) — alleen ROM bootloader protocol + +### bdureau/ESPLoader (GPL-3.0) + +- Repo: https://github.com/bdureau/ESPLoader +- 22 stars +- Partial Java port van esptool +- Zelfde GPL-3.0 probleem als onze huidige lib — **geen licentiewinst** + +## Migratie-inschatting (esp32-flash-lib → EspflashKotlin) + +1. Dependency vervangen in `build.gradle` +2. `EspFlasher.kt` herschrijven: `FlasherSerialInterface` implementeren voor onze USB serial context +3. Firmware bins en addresses overnemen (zelfde ESP32 ROM bootloader protocol) +4. JitPack repo toevoegen in `settings.gradle` of `build.gradle` +5. Testen op device — het ROM bootloader protocol is hetzelfde, maar implementatie kan subtiele verschillen hebben + +**Risico:** EspflashKotlin is minimaal getest. Het mist mogelijk edge cases die esp32-flash-lib wel afdekt (stub loader, error recovery, chip detectie). + +## Conclusie + +| Optie | Licentie-app | Migratie-effort | Risico | +|---|---|---|---| +| Blijf bij esp32-flash-lib, app wordt GPL-3.0 | GPL-3.0 | Geen | Geen | +| Migreer naar EspflashKotlin | MIT/Apache mogelijk | Medium (2-3 dagen) | Hoog (kleine lib, weinig adoptie) | +| Eigen implementatie (esptool protocol zelf porten) | Vrij te kiezen | Hoog (1-2 weken) | Medium (volledig eigen code) | + +**Aanbeveling:** Blijf bij `esp32-flash-lib` en breng de app onder GPL-3.0 uit. Voor een open-source project op GitHub is GPL-3.0 geen praktische beperking — je moet alleen source beschikbaar houden, wat je al doet. De migratie naar EspflashKotlin brengt risico's met zich mee die niet opwegen tegen het licentievoordeel.