[
{
"path": ".github/FUNDING.yml",
"content": "# These are supported funding model platforms\n\npatreon: forrestsux\n"
},
{
"path": "LICENSE",
"content": " GNU GENERAL PUBLIC LICENSE\n Version 3, 29 June 2007\n\n Copyright (C) 2007 Free Software Foundation, Inc. \n Everyone is permitted to copy and distribute verbatim copies\n of this license document, but changing it is not allowed.\n\n Preamble\n\n The GNU General Public License is a free, copyleft license for\nsoftware and other kinds of works.\n\n The licenses for most software and other practical works are designed\nto take away your freedom to share and change the works. By contrast,\nthe GNU General Public License is intended to guarantee your freedom to\nshare and change all versions of a program--to make sure it remains free\nsoftware for all its users. We, the Free Software Foundation, use the\nGNU General Public License for most of our software; it applies also to\nany other work released this way by its authors. You can apply it to\nyour programs, too.\n\n When we speak of free software, we are referring to freedom, not\nprice. Our General Public Licenses are designed to make sure that you\nhave the freedom to distribute copies of free software (and charge for\nthem if you wish), that you receive source code or can get it if you\nwant it, that you can change the software or use pieces of it in new\nfree programs, and that you know you can do these things.\n\n To protect your rights, we need to prevent others from denying you\nthese rights or asking you to surrender the rights. Therefore, you have\ncertain responsibilities if you distribute copies of the software, or if\nyou modify it: responsibilities to respect the freedom of others.\n\n For example, if you distribute copies of such a program, whether\ngratis or for a fee, you must pass on to the recipients the same\nfreedoms that you received. You must make sure that they, too, receive\nor can get the source code. And you must show them these terms so they\nknow their rights.\n\n Developers that use the GNU GPL protect your rights with two steps:\n(1) assert copyright on the software, and (2) offer you this License\ngiving you legal permission to copy, distribute and/or modify it.\n\n For the developers' and authors' protection, the GPL clearly explains\nthat there is no warranty for this free software. For both users' and\nauthors' sake, the GPL requires that modified versions be marked as\nchanged, so that their problems will not be attributed erroneously to\nauthors of previous versions.\n\n Some devices are designed to deny users access to install or run\nmodified versions of the software inside them, although the manufacturer\ncan do so. This is fundamentally incompatible with the aim of\nprotecting users' freedom to change the software. The systematic\npattern of such abuse occurs in the area of products for individuals to\nuse, which is precisely where it is most unacceptable. Therefore, we\nhave designed this version of the GPL to prohibit the practice for those\nproducts. If such problems arise substantially in other domains, we\nstand ready to extend this provision to those domains in future versions\nof the GPL, as needed to protect the freedom of users.\n\n Finally, every program is threatened constantly by software patents.\nStates should not allow patents to restrict development and use of\nsoftware on general-purpose computers, but in those that do, we wish to\navoid the special danger that patents applied to a free program could\nmake it effectively proprietary. To prevent this, the GPL assures that\npatents cannot be used to render the program non-free.\n\n The precise terms and conditions for copying, distribution and\nmodification follow.\n\n TERMS AND CONDITIONS\n\n 0. Definitions.\n\n \"This License\" refers to version 3 of the GNU General Public License.\n\n \"Copyright\" also means copyright-like laws that apply to other kinds of\nworks, such as semiconductor masks.\n\n \"The Program\" refers to any copyrightable work licensed under this\nLicense. Each licensee is addressed as \"you\". \"Licensees\" and\n\"recipients\" may be individuals or organizations.\n\n To \"modify\" a work means to copy from or adapt all or part of the work\nin a fashion requiring copyright permission, other than the making of an\nexact copy. The resulting work is called a \"modified version\" of the\nearlier work or a work \"based on\" the earlier work.\n\n A \"covered work\" means either the unmodified Program or a work based\non the Program.\n\n To \"propagate\" a work means to do anything with it that, without\npermission, would make you directly or secondarily liable for\ninfringement under applicable copyright law, except executing it on a\ncomputer or modifying a private copy. Propagation includes copying,\ndistribution (with or without modification), making available to the\npublic, and in some countries other activities as well.\n\n To \"convey\" a work means any kind of propagation that enables other\nparties to make or receive copies. Mere interaction with a user through\na computer network, with no transfer of a copy, is not conveying.\n\n An interactive user interface displays \"Appropriate Legal Notices\"\nto the extent that it includes a convenient and prominently visible\nfeature that (1) displays an appropriate copyright notice, and (2)\ntells the user that there is no warranty for the work (except to the\nextent that warranties are provided), that licensees may convey the\nwork under this License, and how to view a copy of this License. If\nthe interface presents a list of user commands or options, such as a\nmenu, a prominent item in the list meets this criterion.\n\n 1. Source Code.\n\n The \"source code\" for a work means the preferred form of the work\nfor making modifications to it. \"Object code\" means any non-source\nform of a work.\n\n A \"Standard Interface\" means an interface that either is an official\nstandard defined by a recognized standards body, or, in the case of\ninterfaces specified for a particular programming language, one that\nis widely used among developers working in that language.\n\n The \"System Libraries\" of an executable work include anything, other\nthan the work as a whole, that (a) is included in the normal form of\npackaging a Major Component, but which is not part of that Major\nComponent, and (b) serves only to enable use of the work with that\nMajor Component, or to implement a Standard Interface for which an\nimplementation is available to the public in source code form. A\n\"Major Component\", in this context, means a major essential component\n(kernel, window system, and so on) of the specific operating system\n(if any) on which the executable work runs, or a compiler used to\nproduce the work, or an object code interpreter used to run it.\n\n The \"Corresponding Source\" for a work in object code form means all\nthe source code needed to generate, install, and (for an executable\nwork) run the object code and to modify the work, including scripts to\ncontrol those activities. However, it does not include the work's\nSystem Libraries, or general-purpose tools or generally available free\nprograms which are used unmodified in performing those activities but\nwhich are not part of the work. For example, Corresponding Source\nincludes interface definition files associated with source files for\nthe work, and the source code for shared libraries and dynamically\nlinked subprograms that the work is specifically designed to require,\nsuch as by intimate data communication or control flow between those\nsubprograms and other parts of the work.\n\n The Corresponding Source need not include anything that users\ncan regenerate automatically from other parts of the Corresponding\nSource.\n\n The Corresponding Source for a work in source code form is that\nsame work.\n\n 2. Basic Permissions.\n\n All rights granted under this License are granted for the term of\ncopyright on the Program, and are irrevocable provided the stated\nconditions are met. This License explicitly affirms your unlimited\npermission to run the unmodified Program. The output from running a\ncovered work is covered by this License only if the output, given its\ncontent, constitutes a covered work. This License acknowledges your\nrights of fair use or other equivalent, as provided by copyright law.\n\n You may make, run and propagate covered works that you do not\nconvey, without conditions so long as your license otherwise remains\nin force. You may convey covered works to others for the sole purpose\nof having them make modifications exclusively for you, or provide you\nwith facilities for running those works, provided that you comply with\nthe terms of this License in conveying all material for which you do\nnot control copyright. Those thus making or running the covered works\nfor you must do so exclusively on your behalf, under your direction\nand control, on terms that prohibit them from making any copies of\nyour copyrighted material outside their relationship with you.\n\n Conveying under any other circumstances is permitted solely under\nthe conditions stated below. Sublicensing is not allowed; section 10\nmakes it unnecessary.\n\n 3. Protecting Users' Legal Rights From Anti-Circumvention Law.\n\n No covered work shall be deemed part of an effective technological\nmeasure under any applicable law fulfilling obligations under article\n11 of the WIPO copyright treaty adopted on 20 December 1996, or\nsimilar laws prohibiting or restricting circumvention of such\nmeasures.\n\n When you convey a covered work, you waive any legal power to forbid\ncircumvention of technological measures to the extent such circumvention\nis effected by exercising rights under this License with respect to\nthe covered work, and you disclaim any intention to limit operation or\nmodification of the work as a means of enforcing, against the work's\nusers, your or third parties' legal rights to forbid circumvention of\ntechnological measures.\n\n 4. Conveying Verbatim Copies.\n\n You may convey verbatim copies of the Program's source code as you\nreceive it, in any medium, provided that you conspicuously and\nappropriately publish on each copy an appropriate copyright notice;\nkeep intact all notices stating that this License and any\nnon-permissive terms added in accord with section 7 apply to the code;\nkeep intact all notices of the absence of any warranty; and give all\nrecipients a copy of this License along with the Program.\n\n You may charge any price or no price for each copy that you convey,\nand you may offer support or warranty protection for a fee.\n\n 5. Conveying Modified Source Versions.\n\n You may convey a work based on the Program, or the modifications to\nproduce it from the Program, in the form of source code under the\nterms of section 4, provided that you also meet all of these conditions:\n\n a) The work must carry prominent notices stating that you modified\n it, and giving a relevant date.\n\n b) The work must carry prominent notices stating that it is\n released under this License and any conditions added under section\n 7. This requirement modifies the requirement in section 4 to\n \"keep intact all notices\".\n\n c) You must license the entire work, as a whole, under this\n License to anyone who comes into possession of a copy. This\n License will therefore apply, along with any applicable section 7\n additional terms, to the whole of the work, and all its parts,\n regardless of how they are packaged. This License gives no\n permission to license the work in any other way, but it does not\n invalidate such permission if you have separately received it.\n\n d) If the work has interactive user interfaces, each must display\n Appropriate Legal Notices; however, if the Program has interactive\n interfaces that do not display Appropriate Legal Notices, your\n work need not make them do so.\n\n A compilation of a covered work with other separate and independent\nworks, which are not by their nature extensions of the covered work,\nand which are not combined with it such as to form a larger program,\nin or on a volume of a storage or distribution medium, is called an\n\"aggregate\" if the compilation and its resulting copyright are not\nused to limit the access or legal rights of the compilation's users\nbeyond what the individual works permit. Inclusion of a covered work\nin an aggregate does not cause this License to apply to the other\nparts of the aggregate.\n\n 6. Conveying Non-Source Forms.\n\n You may convey a covered work in object code form under the terms\nof sections 4 and 5, provided that you also convey the\nmachine-readable Corresponding Source under the terms of this License,\nin one of these ways:\n\n a) Convey the object code in, or embodied in, a physical product\n (including a physical distribution medium), accompanied by the\n Corresponding Source fixed on a durable physical medium\n customarily used for software interchange.\n\n b) Convey the object code in, or embodied in, a physical product\n (including a physical distribution medium), accompanied by a\n written offer, valid for at least three years and valid for as\n long as you offer spare parts or customer support for that product\n model, to give anyone who possesses the object code either (1) a\n copy of the Corresponding Source for all the software in the\n product that is covered by this License, on a durable physical\n medium customarily used for software interchange, for a price no\n more than your reasonable cost of physically performing this\n conveying of source, or (2) access to copy the\n Corresponding Source from a network server at no charge.\n\n c) Convey individual copies of the object code with a copy of the\n written offer to provide the Corresponding Source. This\n alternative is allowed only occasionally and noncommercially, and\n only if you received the object code with such an offer, in accord\n with subsection 6b.\n\n d) Convey the object code by offering access from a designated\n place (gratis or for a charge), and offer equivalent access to the\n Corresponding Source in the same way through the same place at no\n further charge. You need not require recipients to copy the\n Corresponding Source along with the object code. If the place to\n copy the object code is a network server, the Corresponding Source\n may be on a different server (operated by you or a third party)\n that supports equivalent copying facilities, provided you maintain\n clear directions next to the object code saying where to find the\n Corresponding Source. Regardless of what server hosts the\n Corresponding Source, you remain obligated to ensure that it is\n available for as long as needed to satisfy these requirements.\n\n e) Convey the object code using peer-to-peer transmission, provided\n you inform other peers where the object code and Corresponding\n Source of the work are being offered to the general public at no\n charge under subsection 6d.\n\n A separable portion of the object code, whose source code is excluded\nfrom the Corresponding Source as a System Library, need not be\nincluded in conveying the object code work.\n\n A \"User Product\" is either (1) a \"consumer product\", which means any\ntangible personal property which is normally used for personal, family,\nor household purposes, or (2) anything designed or sold for incorporation\ninto a dwelling. In determining whether a product is a consumer product,\ndoubtful cases shall be resolved in favor of coverage. For a particular\nproduct received by a particular user, \"normally used\" refers to a\ntypical or common use of that class of product, regardless of the status\nof the particular user or of the way in which the particular user\nactually uses, or expects or is expected to use, the product. A product\nis a consumer product regardless of whether the product has substantial\ncommercial, industrial or non-consumer uses, unless such uses represent\nthe only significant mode of use of the product.\n\n \"Installation Information\" for a User Product means any methods,\nprocedures, authorization keys, or other information required to install\nand execute modified versions of a covered work in that User Product from\na modified version of its Corresponding Source. The information must\nsuffice to ensure that the continued functioning of the modified object\ncode is in no case prevented or interfered with solely because\nmodification has been made.\n\n If you convey an object code work under this section in, or with, or\nspecifically for use in, a User Product, and the conveying occurs as\npart of a transaction in which the right of possession and use of the\nUser Product is transferred to the recipient in perpetuity or for a\nfixed term (regardless of how the transaction is characterized), the\nCorresponding Source conveyed under this section must be accompanied\nby the Installation Information. But this requirement does not apply\nif neither you nor any third party retains the ability to install\nmodified object code on the User Product (for example, the work has\nbeen installed in ROM).\n\n The requirement to provide Installation Information does not include a\nrequirement to continue to provide support service, warranty, or updates\nfor a work that has been modified or installed by the recipient, or for\nthe User Product in which it has been modified or installed. Access to a\nnetwork may be denied when the modification itself materially and\nadversely affects the operation of the network or violates the rules and\nprotocols for communication across the network.\n\n Corresponding Source conveyed, and Installation Information provided,\nin accord with this section must be in a format that is publicly\ndocumented (and with an implementation available to the public in\nsource code form), and must require no special password or key for\nunpacking, reading or copying.\n\n 7. Additional Terms.\n\n \"Additional permissions\" are terms that supplement the terms of this\nLicense by making exceptions from one or more of its conditions.\nAdditional permissions that are applicable to the entire Program shall\nbe treated as though they were included in this License, to the extent\nthat they are valid under applicable law. If additional permissions\napply only to part of the Program, that part may be used separately\nunder those permissions, but the entire Program remains governed by\nthis License without regard to the additional permissions.\n\n When you convey a copy of a covered work, you may at your option\nremove any additional permissions from that copy, or from any part of\nit. (Additional permissions may be written to require their own\nremoval in certain cases when you modify the work.) You may place\nadditional permissions on material, added by you to a covered work,\nfor which you have or can give appropriate copyright permission.\n\n Notwithstanding any other provision of this License, for material you\nadd to a covered work, you may (if authorized by the copyright holders of\nthat material) supplement the terms of this License with terms:\n\n a) Disclaiming warranty or limiting liability differently from the\n terms of sections 15 and 16 of this License; or\n\n b) Requiring preservation of specified reasonable legal notices or\n author attributions in that material or in the Appropriate Legal\n Notices displayed by works containing it; or\n\n c) Prohibiting misrepresentation of the origin of that material, or\n requiring that modified versions of such material be marked in\n reasonable ways as different from the original version; or\n\n d) Limiting the use for publicity purposes of names of licensors or\n authors of the material; or\n\n e) Declining to grant rights under trademark law for use of some\n trade names, trademarks, or service marks; or\n\n f) Requiring indemnification of licensors and authors of that\n material by anyone who conveys the material (or modified versions of\n it) with contractual assumptions of liability to the recipient, for\n any liability that these contractual assumptions directly impose on\n those licensors and authors.\n\n All other non-permissive additional terms are considered \"further\nrestrictions\" within the meaning of section 10. If the Program as you\nreceived it, or any part of it, contains a notice stating that it is\ngoverned by this License along with a term that is a further\nrestriction, you may remove that term. If a license document contains\na further restriction but permits relicensing or conveying under this\nLicense, you may add to a covered work material governed by the terms\nof that license document, provided that the further restriction does\nnot survive such relicensing or conveying.\n\n If you add terms to a covered work in accord with this section, you\nmust place, in the relevant source files, a statement of the\nadditional terms that apply to those files, or a notice indicating\nwhere to find the applicable terms.\n\n Additional terms, permissive or non-permissive, may be stated in the\nform of a separately written license, or stated as exceptions;\nthe above requirements apply either way.\n\n 8. Termination.\n\n You may not propagate or modify a covered work except as expressly\nprovided under this License. Any attempt otherwise to propagate or\nmodify it is void, and will automatically terminate your rights under\nthis License (including any patent licenses granted under the third\nparagraph of section 11).\n\n However, if you cease all violation of this License, then your\nlicense from a particular copyright holder is reinstated (a)\nprovisionally, unless and until the copyright holder explicitly and\nfinally terminates your license, and (b) permanently, if the copyright\nholder fails to notify you of the violation by some reasonable means\nprior to 60 days after the cessation.\n\n Moreover, your license from a particular copyright holder is\nreinstated permanently if the copyright holder notifies you of the\nviolation by some reasonable means, this is the first time you have\nreceived notice of violation of this License (for any work) from that\ncopyright holder, and you cure the violation prior to 30 days after\nyour receipt of the notice.\n\n Termination of your rights under this section does not terminate the\nlicenses of parties who have received copies or rights from you under\nthis License. If your rights have been terminated and not permanently\nreinstated, you do not qualify to receive new licenses for the same\nmaterial under section 10.\n\n 9. Acceptance Not Required for Having Copies.\n\n You are not required to accept this License in order to receive or\nrun a copy of the Program. Ancillary propagation of a covered work\noccurring solely as a consequence of using peer-to-peer transmission\nto receive a copy likewise does not require acceptance. However,\nnothing other than this License grants you permission to propagate or\nmodify any covered work. These actions infringe copyright if you do\nnot accept this License. Therefore, by modifying or propagating a\ncovered work, you indicate your acceptance of this License to do so.\n\n 10. Automatic Licensing of Downstream Recipients.\n\n Each time you convey a covered work, the recipient automatically\nreceives a license from the original licensors, to run, modify and\npropagate that work, subject to this License. You are not responsible\nfor enforcing compliance by third parties with this License.\n\n An \"entity transaction\" is a transaction transferring control of an\norganization, or substantially all assets of one, or subdividing an\norganization, or merging organizations. If propagation of a covered\nwork results from an entity transaction, each party to that\ntransaction who receives a copy of the work also receives whatever\nlicenses to the work the party's predecessor in interest had or could\ngive under the previous paragraph, plus a right to possession of the\nCorresponding Source of the work from the predecessor in interest, if\nthe predecessor has it or can get it with reasonable efforts.\n\n You may not impose any further restrictions on the exercise of the\nrights granted or affirmed under this License. For example, you may\nnot impose a license fee, royalty, or other charge for exercise of\nrights granted under this License, and you may not initiate litigation\n(including a cross-claim or counterclaim in a lawsuit) alleging that\nany patent claim is infringed by making, using, selling, offering for\nsale, or importing the Program or any portion of it.\n\n 11. Patents.\n\n A \"contributor\" is a copyright holder who authorizes use under this\nLicense of the Program or a work on which the Program is based. The\nwork thus licensed is called the contributor's \"contributor version\".\n\n A contributor's \"essential patent claims\" are all patent claims\nowned or controlled by the contributor, whether already acquired or\nhereafter acquired, that would be infringed by some manner, permitted\nby this License, of making, using, or selling its contributor version,\nbut do not include claims that would be infringed only as a\nconsequence of further modification of the contributor version. For\npurposes of this definition, \"control\" includes the right to grant\npatent sublicenses in a manner consistent with the requirements of\nthis License.\n\n Each contributor grants you a non-exclusive, worldwide, royalty-free\npatent license under the contributor's essential patent claims, to\nmake, use, sell, offer for sale, import and otherwise run, modify and\npropagate the contents of its contributor version.\n\n In the following three paragraphs, a \"patent license\" is any express\nagreement or commitment, however denominated, not to enforce a patent\n(such as an express permission to practice a patent or covenant not to\nsue for patent infringement). To \"grant\" such a patent license to a\nparty means to make such an agreement or commitment not to enforce a\npatent against the party.\n\n If you convey a covered work, knowingly relying on a patent license,\nand the Corresponding Source of the work is not available for anyone\nto copy, free of charge and under the terms of this License, through a\npublicly available network server or other readily accessible means,\nthen you must either (1) cause the Corresponding Source to be so\navailable, or (2) arrange to deprive yourself of the benefit of the\npatent license for this particular work, or (3) arrange, in a manner\nconsistent with the requirements of this License, to extend the patent\nlicense to downstream recipients. \"Knowingly relying\" means you have\nactual knowledge that, but for the patent license, your conveying the\ncovered work in a country, or your recipient's use of the covered work\nin a country, would infringe one or more identifiable patents in that\ncountry that you have reason to believe are valid.\n\n If, pursuant to or in connection with a single transaction or\narrangement, you convey, or propagate by procuring conveyance of, a\ncovered work, and grant a patent license to some of the parties\nreceiving the covered work authorizing them to use, propagate, modify\nor convey a specific copy of the covered work, then the patent license\nyou grant is automatically extended to all recipients of the covered\nwork and works based on it.\n\n A patent license is \"discriminatory\" if it does not include within\nthe scope of its coverage, prohibits the exercise of, or is\nconditioned on the non-exercise of one or more of the rights that are\nspecifically granted under this License. You may not convey a covered\nwork if you are a party to an arrangement with a third party that is\nin the business of distributing software, under which you make payment\nto the third party based on the extent of your activity of conveying\nthe work, and under which the third party grants, to any of the\nparties who would receive the covered work from you, a discriminatory\npatent license (a) in connection with copies of the covered work\nconveyed by you (or copies made from those copies), or (b) primarily\nfor and in connection with specific products or compilations that\ncontain the covered work, unless you entered into that arrangement,\nor that patent license was granted, prior to 28 March 2007.\n\n Nothing in this License shall be construed as excluding or limiting\nany implied license or other defenses to infringement that may\notherwise be available to you under applicable patent law.\n\n 12. No Surrender of Others' Freedom.\n\n If conditions are imposed on you (whether by court order, agreement or\notherwise) that contradict the conditions of this License, they do not\nexcuse you from the conditions of this License. If you cannot convey a\ncovered work so as to satisfy simultaneously your obligations under this\nLicense and any other pertinent obligations, then as a consequence you may\nnot convey it at all. For example, if you agree to terms that obligate you\nto collect a royalty for further conveying from those to whom you convey\nthe Program, the only way you could satisfy both those terms and this\nLicense would be to refrain entirely from conveying the Program.\n\n 13. Use with the GNU Affero General Public License.\n\n Notwithstanding any other provision of this License, you have\npermission to link or combine any covered work with a work licensed\nunder version 3 of the GNU Affero General Public License into a single\ncombined work, and to convey the resulting work. The terms of this\nLicense will continue to apply to the part which is the covered work,\nbut the special requirements of the GNU Affero General Public License,\nsection 13, concerning interaction through a network will apply to the\ncombination as such.\n\n 14. Revised Versions of this License.\n\n The Free Software Foundation may publish revised and/or new versions of\nthe GNU General Public License from time to time. Such new versions will\nbe similar in spirit to the present version, but may differ in detail to\naddress new problems or concerns.\n\n Each version is given a distinguishing version number. If the\nProgram specifies that a certain numbered version of the GNU General\nPublic License \"or any later version\" applies to it, you have the\noption of following the terms and conditions either of that numbered\nversion or of any later version published by the Free Software\nFoundation. If the Program does not specify a version number of the\nGNU General Public License, you may choose any version ever published\nby the Free Software Foundation.\n\n If the Program specifies that a proxy can decide which future\nversions of the GNU General Public License can be used, that proxy's\npublic statement of acceptance of a version permanently authorizes you\nto choose that version for the Program.\n\n Later license versions may give you additional or different\npermissions. However, no additional obligations are imposed on any\nauthor or copyright holder as a result of your choosing to follow a\nlater version.\n\n 15. Disclaimer of Warranty.\n\n THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY\nAPPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT\nHOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM \"AS IS\" WITHOUT WARRANTY\nOF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,\nTHE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR\nPURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM\nIS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF\nALL NECESSARY SERVICING, REPAIR OR CORRECTION.\n\n 16. Limitation of Liability.\n\n IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING\nWILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS\nTHE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY\nGENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE\nUSE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF\nDATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD\nPARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),\nEVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF\nSUCH DAMAGES.\n\n 17. Interpretation of Sections 15 and 16.\n\n If the disclaimer of warranty and limitation of liability provided\nabove cannot be given local legal effect according to their terms,\nreviewing courts shall apply local law that most closely approximates\nan absolute waiver of all civil liability in connection with the\nProgram, unless a warranty or assumption of liability accompanies a\ncopy of the Program in return for a fee.\n\n END OF TERMS AND CONDITIONS\n\n How to Apply These Terms to Your New Programs\n\n If you develop a new program, and you want it to be of the greatest\npossible use to the public, the best way to achieve this is to make it\nfree software which everyone can redistribute and change under these terms.\n\n To do so, attach the following notices to the program. It is safest\nto attach them to the start of each source file to most effectively\nstate the exclusion of warranty; and each file should have at least\nthe \"copyright\" line and a pointer to where the full notice is found.\n\n \n Copyright (C) \n\n This program is free software: you can redistribute it and/or modify\n it under the terms of the GNU General Public License as published by\n the Free Software Foundation, either version 3 of the License, or\n (at your option) any later version.\n\n This program is distributed in the hope that it will be useful,\n but WITHOUT ANY WARRANTY; without even the implied warranty of\n MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n GNU General Public License for more details.\n\n You should have received a copy of the GNU General Public License\n along with this program. If not, see .\n\nAlso add information on how to contact you by electronic and paper mail.\n\n If the program does terminal interaction, make it output a short\nnotice like this when it starts in an interactive mode:\n\n Copyright (C) \n This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.\n This is free software, and you are welcome to redistribute it\n under certain conditions; type `show c' for details.\n\nThe hypothetical commands `show w' and `show c' should show the appropriate\nparts of the General Public License. Of course, your program's commands\nmight be different; for a GUI interface, you would use an \"about box\".\n\n You should also get your employer (if you work as a programmer) or school,\nif any, to sign a \"copyright disclaimer\" for the program, if necessary.\nFor more information on this, and how to apply and follow the GNU GPL, see\n.\n\n The GNU General Public License does not permit incorporating your program\ninto proprietary programs. If your program is a subroutine library, you\nmay consider it more useful to permit linking proprietary applications with\nthe library. If this is what you want to do, use the GNU Lesser General\nPublic License instead of this License. But first, please read\n.\n"
},
{
"path": "README.md",
"content": "# pwnagotchi_plugins\nPwnagotchi Plugins and Things for Mayhem and Profit\n\nPlease don't break the law and/or use anything here to break the law. Laws vary, depending on location, so always be aware of what you're doing and where you're doing it. \n\n## quick_rides_to_jail/*\nAlmost certainly illegal, wherever you are, if not used for research purposes against your own equipment. It replaces quickdic.py, completing the pwn process by adding any cracked access points to wpa_supplicant's config (by BSSID) and restarting wpa_supplicant for the hardcoded interface, enabling automatic authentication when in range of a pwnd AP. This was the easiest solution I could come up with for authenticating to a wireless network, with cracked creds, when the network is in range. Managing all of that in one Python script would be a terrible multithreaded mess that would probably end up fighting against most OS's network management services for dominance. I wrote this in a mostly-default Raspbian build, on both a Raspi 3b+ and 4, and I can't remember if the pwnagotchi image has wpa_supplicant and some network manager running. One also needs a separate wireless interface if one expects to connect to pwnt AP's while still running the pwnagotchi. Since you're only using this on your own test infrastructure, you shouldn't have to worry about any malicious threats once you've authenticated to and joined your pwnt test infrastructure. Also not meant for skiddies.\n\nNow includes logic to re-crack uncracked captures, since the original plugin would only initiate cracking once, immediately after discovery. In a similar fashion to the Wigle plugin, I've added a status file (`/root/.aircracked_pcaps`) so that we aren't trying to crack the same things over and over. The aircrack-ng command is limited to 1 cpu core, to prevent the Pi from melting. I recommend using a small wordlist, of the most common passwords, so that cracking doesn't hold up normal operations too long. I also added more robust aircrack logic, so we start cracking pcap's that only contain PMKID and/or multiple handshakes (which would fail using the default plugin). I guess I'll remove the sketchy stuff and create a separate quickdic.py plugin...\n\n## quickdic/*\nA better quickdic, with less quick rides to jail. I just removed the quick_rides part so you don't accidently jail. Does the same Aircrack-ng logic. Completely untested.\n\n## wigle.py\nIt's the WiGLE module, but it actually works. It now combines all data into one Kismet CSV file, before uploading to WiGLE. I'm hoping to improve it, in the future, by adding logic to report all AP's, not just those with handshakes, and by adding support for other device information WiGLE can consume. Pull request denied, so this lives here now - there's more to life than fake internet points for free work. The original Wigle plugin isn't formatted correctly to work as a plugin; it's different from all of the other plugins because, I guess, it's still a work in progress. Meh. This one works and isn't cancer.\n\n## monstart/monstop\nNot mine, but also don't remember where I got them. Pretty sure they came from one of evilsocket's repo's or something they used to create their build environment. As their names imply, these scripts are used to start and stop an interface in monitor mode. The interface these scripts perform the operations on is hardcoded in each script. The interface name currently in both scripts should be changed to the name you want your monitor mode interface to have, based off an existing interface (e.g. wlan1mon because I have a wlan1). Added because I'm using raspbian and built everything, myself. \n\n## gsmfake\nReal shitty hacks to use the [Waveshare Raspberry Pi GSM/GPRS/GNSS Bluetooth Hat for SIM868](https://amazon.com/Raspberry-Bluetooth-Expansion-Compatible-DataTransfer/dp/B076CPX4NN) with gpsfake, to supply bettercap with better-than-nothing GPS coordinates from the GSM network. Use when stuck in and around glass/steel monoliths that eat GPS signals for breakfast. The provided coordinates are not only inaccurate because they come from second-hand means, but also because said means don't return elevation, so I put a hardcoded 100 in there because I don't know why. Really, I should focus on a more accurate 2d-fix over the 3d-fix, but I didn't. Requires the python gps modules (pip install gps) and pynmea2 for creating nice NMEA strings (pip install pynmea2). Make a backup of '/usr/lib/python2.7/dist-packages/gps/fake.py' and then replace it with the one provided (not totally necessary). Then run 'python prime_gsm_hat.py' to turn on the hat and start the GPRS data service. This only needs to be/should be run once per powering on of the hat. Next, run gsmfake.py using basic parameters used to start gpsfake: 'python gsmfake.py -P 2948 /root/fakegps.data'. Both fake.py and prime_gsm_hat.py have hardcoded paths to the Hat's serial IO, so keep that in mind. This will spit out a path like '/dev/pts/2' that you need to update bettercap with.\n\nI *think* everything is in a working state, but good luck if it's not. There are very few checks done and errors handled, so everything needs to work 100% perfect to get it running. Once it is running, gsmfake should spit out a special file path. Copy and paste this into bettercap's advanced GPS settings for or directly set 'gps.device' and restart the gps caplet.\n\nTODO: Figure out how to coalesce multiple GPS sources into a more accurate location, figure out how to replace 3d-fixes with 2d-fixes, and fix the Wiggle plugin, because that shit aint right.\n\n## notes_on_pwnagotchi_on_other_pis_and_raspbian.txt\nNotes on how I got things running on Pi 3 b+/Pi 4/Raspbian etc.\n\n## gps/*\nReplacements for bettercap's gps.go and pwnagotchi's gps.py to get it working with gpsd, for a more robust, multiplexed GPS experience. Bettercap will get GPS updates by polling gpsd, allowing other processes access to the GPS data; not just bettercap. Requires that you have gpsd installed and configured, as well as [Stratoberry's go-gpsd](github.com/stratoberry/go-gpsd). So install and configure gpsd, replace your `~/go/src/github.com/bettercap/bettercap/modules/gps/gps.go` with the Go script, replace `~/git/pwnagotchi-1.0.1/pwnagotchi/plugins/default/gps.py` with the Python script, modify your pwnagotchi config with the included config, change back to the bettercap directory, do a little `make build`, and replace your bettercap binary with the one you just built.\n\nThere's no clear benefit to using more than one GPS device, beyond testing antenna/signal strength (your receivers aren't magically more accurate). \n\n## event_multithreading_for_plugins/*\nI've added logic to multithread and queue events for plugins. It's been noted that the way pwnagotchi handles tasking events on the plugins causes everything to slow, depending on the collective speed of the plugins, because they were being processed serially. The `pwnagotchi/plugins/__init__.py` has been updated to create a thread-managed queue for each event type, for each plugin. When an event is processed on all plugins containing a function definition for the event, it gets added to the back of a queue for processing that specific type of event on a valid plugin, and then the thread will take care of executing the events in the order they came in. Moving forward, this should have little, if any, impact on my future development efforts because I fully expect evilsocket to put out their own multithreaded version soon, but I can't be bothered to follow arbitrary style guides for free. However, I'm not sure this will work on any future evilsocket pwnagotchi releases because I cannot predict what they will do. My pwnagotchi fork should contain all of the fixes/plugins/etc. here; I'll consider being an asshole in the future. \n\n#### Coming soon\n* Comms over GSM/GPRS\n* That WPS shit everyone keeps talking about\n* OpenVPN and then TOR support for plugins/pieces that touch the internet.\n"
},
{
"path": "event_multithreading_for_plugins/__init__.py",
"content": "import os\nimport queue\nimport threading\nimport glob\nimport importlib, importlib.util\nimport logging\nimport time\n\ndefault_path = os.path.join(os.path.dirname(os.path.realpath(__file__)), \"default\")\nloaded = {}\nexitFlag = 0\nplugin_event_queues = {}\n\ndef dummy_callback():\n pass\n\nclass WorkerThread (threading.Thread):\n def __init__(self, plugin_name, event_name, work_queue):\n threading.Thread.__init__(self)\n self.plugin_name = plugin_name\n self.event_name = event_name\n self.work_queue = work_queue\n\n def run(self):\n logging.info(\"Worker thread starting for %s.%s\"%(self.plugin_name, self.event_name))\n process_event(self.plugin_name, self.event_name, self.work_queue)\n logging.info(\"Worker thread exiting for %s.%s\"%(self.plugin_name, self.event_name))\n\n\ndef process_event(plugin_name, event_name, work_queue):\n while not exitFlag:\n plugin_event_queues[plugin_name][event_name].queue_lock.acquire()\n if not work_queue.empty():\n data = work_queue.get()\n plugin_event_queues[plugin_name][event_name].queue_lock.release()\n try:\n loaded[plugin_name].__dict__[('on_%s'%event_name)](*data[0], **data[1])\n except Exception as e:\n logging.error(\"error while running %s.%s : %s\" % (plugin_name, event_name, e))\n else:\n plugin_event_queues[plugin_name][event_name].queue_lock.release()\n time.sleep(1)\n\n\nclass PluginEventQueue():\n def __init__(self, plugin_name, event_name):\n self.plugin_name = plugin_name\n self.event_name = event_name\n self.work_queue = queue.Queue()\n self.worker_thread = WorkerThread(self.plugin_name, self.event_name, self.work_queue)\n self.queue_lock = threading.Lock()\n self.worker_thread.start()\n\n def AddWork(self, *args, **kwargs):\n self.queue_lock.acquire()\n self.work_queue.put([args, kwargs])\n self.queue_lock.release()\n\n\ndef on(event_name, *args, **kwargs):\n global loaded\n global plugin_event_queues\n cb_name = 'on_%s' % event_name\n for plugin_name, plugin in loaded.items():\n if cb_name not in plugin.__dict__:\n continue\n \n if plugin_name not in plugin_event_queues:\n plugin_event_queues[plugin_name] = {}\n\n if event_name not in plugin_event_queues[plugin_name]:\n plugin_event_queues[plugin_name][event_name] = PluginEventQueue(plugin_name, event_name)\n\n plugin_event_queues[plugin_name][event_name].AddWork(*args, **kwargs)\n\n\ndef load_from_file(filename):\n plugin_name = os.path.basename(filename.replace(\".py\", \"\"))\n spec = importlib.util.spec_from_file_location(plugin_name, filename)\n instance = importlib.util.module_from_spec(spec)\n spec.loader.exec_module(instance)\n return plugin_name, instance\n\n\ndef load_from_path(path, enabled=()):\n global loaded\n for filename in glob.glob(os.path.join(path, \"*.py\")):\n name, plugin = load_from_file(filename)\n if name in loaded:\n raise Exception(\"plugin %s already loaded from %s\" % (name, plugin.__file__))\n elif name not in enabled:\n # print(\"plugin %s is not enabled\" % name)\n pass\n else:\n loaded[name] = plugin\n\n return loaded\n\n\ndef load(config):\n enabled = [name for name, options in config['main']['plugins'].items() if 'enabled' in options and options['enabled']]\n custom_path = config['main']['custom_plugins'] if 'custom_plugins' in config['main'] else None\n # load default plugins\n loaded = load_from_path(default_path, enabled=enabled)\n # set the options\n for name, plugin in loaded.items():\n plugin.__dict__['OPTIONS'] = config['main']['plugins'][name]\n # load custom ones\n if custom_path is not None:\n loaded = load_from_path(custom_path, enabled=enabled)\n # set the options\n for name, plugin in loaded.items():\n plugin.__dict__['OPTIONS'] = config['main']['plugins'][name]\n\n on('loaded')\n"
},
{
"path": "gps/config.yml",
"content": " # Change pwnagotchi's gps config to the updated variable names.\n gps:\n enabled: true\n gpsdHost: localhost\n gpsdPort: 2947\n"
},
{
"path": "gps/gps.go",
"content": "package gps\n\nimport (\n\t\"fmt\"\n\t\"time\"\n\t\"strconv\"\n\t\"github.com/bettercap/bettercap/session\"\n\t\"github.com/stratoberry/go-gpsd\"\n)\n\ntype GPS struct {\n\tsession.SessionModule\n\n\tgpsdHost string\n\tgpsdPort int\n\tgps\t *gpsd.Session\n}\n\nfunc NewGPS(s *session.Session) *GPS {\n\tmod := &GPS{\n\t\tSessionModule: session.NewSessionModule(\"gps\", s),\n\t\tgpsdHost: \"localhost\",\n\t\tgpsdPort: 2947,\n\t}\n\n\tmod.AddParam(session.NewStringParameter(\"gps.gpsdHost\",\n\t\tmod.gpsdHost,\n\t\t\"\",\n\t\t\"Port GPSD is listening on (default: 2947).\"))\n\n\tmod.AddParam(session.NewIntParameter(\"gps.gpsdPort\",\n\t\tfmt.Sprintf(\"%d\", mod.gpsdPort),\n\t\t\"Host running GPSD (default: localhost).\"))\n\n\tmod.AddHandler(session.NewModuleHandler(\"gps on\", \"\",\n\t\t\"Start acquiring from the GPS daemon.\",\n\t\tfunc(args []string) error {\n\t\t\treturn mod.Start()\n\t\t}))\n\n\tmod.AddHandler(session.NewModuleHandler(\"gps off\", \"\",\n\t\t\"Stop acquiring from the GPS daemon.\",\n\t\tfunc(args []string) error {\n\t\t\treturn mod.Stop()\n\t\t}))\n\n\tmod.AddHandler(session.NewModuleHandler(\"gps.show\", \"\",\n\t\t\"Show the last coordinates returned by the GPS daemon.\",\n\t\tfunc(args []string) error {\n\t\t\treturn mod.Show()\n\t\t}))\n\n\treturn mod\n}\n\nfunc (mod *GPS) Name() string {\n\treturn \"gps\"\n}\n\nfunc (mod *GPS) Description() string {\n\treturn \"A module for talking with the GPS daemon (GPSD) on a local or remote network interface.\"\n}\n\nfunc (mod *GPS) Author() string {\n\treturn \"Forrest\"\n}\n\nfunc (mod *GPS) Configure() (err error) {\n\tif mod.Running() {\n\t\treturn session.ErrAlreadyStarted(mod.Name())\n\t} else if err, mod.gpsdHost = mod.StringParam(\"gps.gpsdHost\"); err != nil {\n\t\treturn err\n\t} else if err, mod.gpsdPort = mod.IntParam(\"gps.gpsdPort\"); err != nil {\n\t\treturn err\n\t}\n\n\tmod.gps, err = gpsd.Dial(fmt.Sprintf(\"%s:%d\", mod.gpsdHost, mod.gpsdPort))\n\treturn\n}\n\nfunc (mod *GPS) Show() error {\n\tfmt.Printf(\"latitude:%f longitude:%f quality:%s satellites:%d altitude:%f\\n\",\n\t\tmod.Session.GPS.Latitude,\n\t\tmod.Session.GPS.Longitude,\n\t\tmod.Session.GPS.FixQuality,\n\t\tmod.Session.GPS.NumSatellites,\n\t\tmod.Session.GPS.Altitude)\n\n\tmod.Session.Refresh()\n\n\treturn nil\n}\n\nfunc (mod *GPS) Start() error {\n\tif err := mod.Configure(); err != nil {\n\t\treturn err\n\t}\n\n\treturn mod.SetRunning(true, func() {\n\n\t\tmod.gps.AddFilter(\"TPV\", func(r interface{}) {\n\t\t\tm := r.(*gpsd.TPVReport)\n\t\t\tmod.Session.GPS.Updated = time.Now()\n\t\t\tmod.Session.GPS.Latitude = m.Lat\n\t\t\tmod.Session.GPS.Longitude = m.Lon\n\t\t\tmod.Session.GPS.Altitude = m.Alt\n\t\t\tmod.Session.GPS.FixQuality = strconv.Itoa(int(m.Mode))\n\t\t\t//mod.Session.GPS.Separation = m.Separation\n\t\t})\n\n\t\tmod.gps.AddFilter(\"GST\", func(r interface{}) {\n\t\t\tm := r.(*gpsd.GSTReport)\n\t\t\tmod.Session.GPS.Updated = time.Now()\n\t\t\tmod.Session.GPS.Latitude = m.Lat\n\t\t\tmod.Session.GPS.Longitude = m.Lon\n\t\t\tmod.Session.GPS.Altitude = m.Alt\n\t\t})\n\n\t\tmod.gps.AddFilter(\"SKY\", func(r interface{}) {\n\t\t\tm := r.(*gpsd.SKYReport)\n\t\t\tmod.Session.GPS.Updated = time.Now()\n\t\t\tmod.Session.GPS.NumSatellites = int64(len(m.Satellites))\n\t\t\tmod.Session.GPS.HDOP = m.Hdop\n\t\t})\n\n\t\tmod.Info(\"started on %s:%d ...\", mod.gpsdHost, mod.gpsdPort)\n\t\tfor mod.Running() {\n\t\t\tdone := mod.gps.Watch()\n\t\t\t<-done\n\t\t}\n\n\t})\n}\n\nfunc (mod *GPS) Stop() error {\n\treturn mod.SetRunning(false, func() {\n\t})\n}\n"
},
{
"path": "gps/gps.py",
"content": "__author__ = 'forrest'\n__version__ = '1.0.0'\n__name__ = 'gps'\n__license__ = 'GPL3'\n__description__ = 'Save GPS coordinates whenever a handshake is captured.'\n\nimport logging\nimport json\nimport os\n\nrunning = False\nOPTIONS = dict()\n\n\ndef on_loaded():\n logging.info(\"gps plugin loaded for %s:%d\" % OPTIONS['gpsdHost'], OPTIONS['gpsdPort'])\n\n\ndef on_ready(agent):\n global running\n\n logging.info(\"enabling gps bettercap's module for %s:%d\" % OPTIONS['gpsdHost'], OPTIONS['gpsdPort'])\n try:\n agent.run('gps off')\n except:\n pass\n\n agent.run('set gps.gpsdHost %s' % OPTIONS['gpsdHost'])\n agent.run('set gps.gpsdPort %d' % OPTIONS['gpsdPort'])\n agent.run('gps on')\n running = True\n\n\ndef on_handshake(agent, filename, access_point, client_station):\n if running:\n info = agent.session()\n gps = info['gps']\n gps_filename = filename.replace('.pcap', '.gps.json')\n\n logging.info(\"saving GPS to %s (%s)\" % (gps_filename, gps))\n with open(gps_filename, 'w+t') as fp:\n json.dump(gps, fp)\n"
},
{
"path": "gps/gpsd",
"content": "# The GPSD config is usually located at /etc/default/gpsd\nSTART_DAEMON=\"true\"\nUSBAUTO=\"true\"\nDEVICES=\"/dev/ttyUSB0\"\nGPSD_OPTIONS=\"-n -r\"\nGPSD_SOCKET=\"/var/run/gpsd.sock\"\n# Update this with whatever, and give it the old 'systemctl enable gpsd ; systemctl start gpsd'\n"
},
{
"path": "gsmfake/fake.py",
"content": "# This file is Copyright (c) 2010 by the GPSD project\n# BSD terms apply: see the file COPYING in the distribution root for details.\n\"\"\"\ngpsfake.py -- classes for creating a controlled test environment around gpsd.\n\nThe gpsfake(1) regression tester shipped with GPSD is a trivial wrapper\naround this code. For a more interesting usage example, see the\nvalgrind-audit script shipped with the GPSD code.\n\nTo use this code, start by instantiating a TestSession class. Use the\nprefix argument if you want to run the daemon under some kind of run-time\nmonitor like valgrind or gdb. Here are some particularly useful possibilities:\n\nvalgrind --tool=memcheck --gen-suppressions=yes --leak-check=yes\n Run under Valgrind, checking for malloc errors and memory leaks.\n\nxterm -e gdb -tui --args\n Run under gdb, controlled from a new xterm.\n\nYou can use the options argument to pass in daemon options; normally you will\nuse this to set the debug-logging level.\n\nOn initialization, the test object spawns an instance of gpsd with no\ndevices or clients attached, connected to a control socket.\n\nTestSession has methods to attach and detch fake GPSes. The\nTestSession class simulates GPS devices for you with objects composed\nfrom a pty and a class instance that cycles sentences into the master side\nfrom some specified logfile; gpsd reads the slave side. A fake GPS is\nidentified by the string naming its slave device.\n\nTestSession also has methods to start and end client sessions. Daemon\nresponses to a client are fed to a hook function which, by default,\ndiscards them. Note that this data is 'bytes' to accommodate possible\nbinary data in Python 3; use polystr() if you need a str. You can\nchange the hook to misc.get_bytes_stream(sys.stdout).write to dump\nresponses to standard output (this is what the gpsfake executable does)\nor do something more exotic. A client session is identified by a small\ninteger that counts the number of client session starts.\n\nThere are a couple of convenience methods. TestSession.wait() does nothing,\nallowing a specified number of seconds to elapse. TestSession.send()\nships commands to an open client session.\n\nTestSession does not currently capture the daemon's log output. It is\nrun with -N, so the output will go to stderr (along with, for example,\nValgrind notifications).\n\nEach FakeGPS instance tries to packetize the data from the logfile it\nis initialized with. It uses the same packet-getter as the daemon.\nException: if there is a Delay-Cookie line in a header comment, that\ndelimiter is used to split up the test load.\n\nThe TestSession code maintains a run queue of FakeGPS and gps.gs\n(client- session) objects. It repeatedly cycles through the run queue.\nFor each client session object in the queue, it tries to read data\nfrom gpsd. For each fake GPS, it sends one line or packet of stored\ndata. When a fake-GPS's go predicate becomes false, the fake GPS is\nremoved from the run queue.\n\nThere are two ways to use this code. The more deterministic is\nnon-threaded mode: set up your client sessions and fake GPS devices,\nthen call the run() method. The run() method will terminate when\nthere are no more objects in the run queue. Note, you must have\ncreated at least one fake client or fake GPS before calling run(),\notherwise it will terminate immediately.\n\nTo allow for adding and removing clients while the test is running,\nrun in threaded mode by calling the start() method. This simply calls\nthe run method in a subthread, with locking of critical regions.\n\"\"\"\n# This code runs compatibly under Python 2 and 3.x for x >= 2.\n# Preserve this property!\nfrom __future__ import absolute_import, print_function, division\n\nimport os\nimport pty\nimport select\nimport signal\nimport socket\nimport stat\nimport subprocess\nimport sys\nimport termios # fcntl, array, struct\nimport threading\nimport time\n\nimport serial\nimport math\nimport pynmea2\nimport datetime\nimport re\n\n\nimport gps\nfrom gps import polybytes\nfrom . import packet as sniffer\n\n# The magic number below has to be derived from observation. If\n# it's too high you'll slow the tests down a lot. If it's too low\n# you'll get regression tests timing out.\n\n# WRITE_PAD: Define a per-line delay on writes so we won't spam the\n# buffers in the pty layer or gpsd itself. Values smaller than the\n# system timer tick don't make any difference here. Can be set from\n# WRITE_PAD in the environment.\n\nif sys.platform.startswith(\"linux\"):\n WRITE_PAD = 0.0\nelif sys.platform.startswith(\"freebsd\"):\n WRITE_PAD = 0.01\nelif sys.platform.startswith(\"netbsd5\"):\n WRITE_PAD = 0.200\nelif sys.platform.startswith(\"netbsd\"):\n WRITE_PAD = 0.004\nelif sys.platform.startswith(\"darwin\"):\n # darwin Darwin-13.4.0-x86_64-i386-64bit\n WRITE_PAD = 0.03\nelse:\n WRITE_PAD = 0.004\n\n# Additional delays in slow mode\nWRITE_PAD_SLOWDOWN = 0.01\n\n# If a test takes longer than this, we deem it to have timed out\nTEST_TIMEOUT = 60\n\n\ndef GetDelay(slow=False):\n \"Get appropriate per-line delay.\"\n delay = WRITE_PAD\n # Make it easier to test pad values\n if os.getenv(\"WRITE_PAD\"):\n delay = eval(os.getenv(\"WRITE_PAD\"))\n if slow:\n delay += WRITE_PAD_SLOWDOWN\n return delay\n\n\nclass TestError(BaseException):\n def __init__(self, msg):\n super(TestError, self).__init__()\n self.msg = msg\n\n\nclass TestLoadError(TestError):\n pass\n\n\nclass DynamicTestLoad(object):\n \"Fuck this shit.\"\n\n def __init__(self, logfp, predump=False, slow=False, oneshot=False):\n self.sentences = [] # This is the interesting part\n if isinstance(logfp, str):\n logfp = open(logfp, \"rb\")\n self.name = logfp.name\n self.logfp = logfp\n self.predump = predump\n self.type = None\n self.sourcetype = \"pty\"\n self.serial = None\n self.delay = GetDelay(slow)\n self.delimiter = None\n # Stash away a copy in case we need to resplit\n text = logfp.read()\n logfp = open(logfp.name, 'rb')\n # Grab the packets in the normal way\n getter = sniffer.new()\n # gps.packet.register_report(reporter)\n type_latch = None\n commentlen = 0\n while True:\n # Note that packet data is bytes rather than str\n (plen, ptype, packet, _counter) = getter.get(logfp.fileno())\n if plen <= 0:\n break\n elif ptype == sniffer.COMMENT_PACKET:\n commentlen += len(packet)\n # Some comments are magic\n if b\"Serial:\" in packet:\n # Change serial parameters\n packet = packet[1:].strip()\n try:\n (_xx, baud, params) = packet.split()\n baud = int(baud)\n if params[0] in (b'7', b'8'):\n databits = int(params[0])\n else:\n raise ValueError\n if params[1] in (b'N', b'O', b'E'):\n parity = params[1]\n else:\n raise ValueError\n if params[2] in (b'1', b'2'):\n stopbits = int(params[2])\n else:\n raise ValueError\n except (ValueError, IndexError):\n raise TestLoadError(\"bad serial-parameter spec in %s\" %\n self.name)\n self.serial = (baud, databits, parity, stopbits)\n elif b\"Transport: UDP\" in packet:\n self.sourcetype = \"UDP\"\n elif b\"Transport: TCP\" in packet:\n self.sourcetype = \"TCP\"\n elif b\"Delay-Cookie:\" in packet:\n if packet.startswith(b\"#\"):\n packet = packet[1:]\n try:\n (_dummy, self.delimiter, delay) = \\\n packet.strip().split()\n self.delay = float(delay)\n except ValueError:\n raise TestLoadError(\"bad Delay-Cookie line in %s\" %\n self.name)\n self.resplit = True\n else:\n if type_latch is None:\n type_latch = ptype\n if self.predump:\n print(repr(packet))\n if not packet:\n raise TestLoadError(\"zero-length packet from %s\" %\n self.name)\n self.sentences.append(packet)\n # Look at the first packet to grok the GPS type\n self.textual = (type_latch == sniffer.NMEA_PACKET)\n if self.textual:\n self.legend = \"gpsfake: line %d: \"\n else:\n self.legend = \"gpsfake: packet %d\"\n # Maybe this needs to be split on different delimiters?\n if self.delimiter is not None:\n self.sentences = text[commentlen:].split(self.delimiter)\n # Do we want single-shot operation?\n if oneshot:\n self.sentences.append(b\"# EOF\\n\")\n\n\nclass TestLoad(object):\n \"Digest a logfile into a list of sentences we can cycle through.\"\n\n def __init__(self, logfp, predump=False, slow=False, oneshot=False):\n self.sentences = [] # This is the interesting part\n if isinstance(logfp, str):\n logfp = open(logfp, \"rb\")\n self.name = logfp.name\n self.logfp = logfp\n self.predump = predump\n self.type = None\n self.sourcetype = \"pty\"\n self.serial = None\n self.delay = GetDelay(slow)\n self.delimiter = None\n # Stash away a copy in case we need to resplit\n text = logfp.read()\n logfp = open(logfp.name, 'rb')\n # Grab the packets in the normal way\n getter = sniffer.new()\n # gps.packet.register_report(reporter)\n type_latch = None\n commentlen = 0\n while True:\n # Note that packet data is bytes rather than str\n (plen, ptype, packet, _counter) = getter.get(logfp.fileno())\n if plen <= 0:\n break\n elif ptype == sniffer.COMMENT_PACKET:\n commentlen += len(packet)\n # Some comments are magic\n if b\"Serial:\" in packet:\n # Change serial parameters\n packet = packet[1:].strip()\n try:\n (_xx, baud, params) = packet.split()\n baud = int(baud)\n if params[0] in (b'7', b'8'):\n databits = int(params[0])\n else:\n raise ValueError\n if params[1] in (b'N', b'O', b'E'):\n parity = params[1]\n else:\n raise ValueError\n if params[2] in (b'1', b'2'):\n stopbits = int(params[2])\n else:\n raise ValueError\n except (ValueError, IndexError):\n raise TestLoadError(\"bad serial-parameter spec in %s\" %\n self.name)\n self.serial = (baud, databits, parity, stopbits)\n elif b\"Transport: UDP\" in packet:\n self.sourcetype = \"UDP\"\n elif b\"Transport: TCP\" in packet:\n self.sourcetype = \"TCP\"\n elif b\"Delay-Cookie:\" in packet:\n if packet.startswith(b\"#\"):\n packet = packet[1:]\n try:\n (_dummy, self.delimiter, delay) = \\\n packet.strip().split()\n self.delay = float(delay)\n except ValueError:\n raise TestLoadError(\"bad Delay-Cookie line in %s\" %\n self.name)\n self.resplit = True\n else:\n if type_latch is None:\n type_latch = ptype\n if self.predump:\n print(repr(packet))\n if not packet:\n raise TestLoadError(\"zero-length packet from %s\" %\n self.name)\n self.sentences.append(packet)\n # Look at the first packet to grok the GPS type\n self.textual = (type_latch == sniffer.NMEA_PACKET)\n if self.textual:\n self.legend = \"gpsfake: line %d: \"\n else:\n self.legend = \"gpsfake: packet %d\"\n # Maybe this needs to be split on different delimiters?\n if self.delimiter is not None:\n self.sentences = text[commentlen:].split(self.delimiter)\n # Do we want single-shot operation?\n if oneshot:\n self.sentences.append(b\"# EOF\\n\")\n\n\nclass PacketError(TestError):\n pass\n\n\nclass FakeGPS(object):\n def __init__(self, testload, progress=None):\n self.testload = testload\n self.progress = progress\n self.go_predicate = lambda: True\n self.readers = 0\n self.index = 0\n self.progress(\"gpsfake: %s provides %d sentences\\n\"\n % (self.testload.name, len(self.testload.sentences)))\n\n def write(self, line):\n \"Throw an error if this superclass is ever instantiated.\"\n raise ValueError(line)\n\n def feed(self):\n \"Feed a line from the contents of the GPS log to the daemon.\"\n line = self.testload.sentences[self.index\n % len(self.testload.sentences)]\n if b\"%Delay:\" in line:\n # Delay specified number of seconds\n delay = line.split()[1]\n time.sleep(int(delay))\n # self.write has to be set by the derived class\n self.write(line)\n time.sleep(self.testload.delay)\n self.index += 1\n\n\n\nclass FakePTY(FakeGPS):\n \"A FakePTY is a pty with a test log ready to be cycled to it.\"\n\n def __init__(self, testload,\n speed=4800, databits=8, parity='N', stopbits=1,\n progress=None):\n super(FakePTY, self).__init__(testload, progress)\n # Allow Serial: header to be overridden by explicit speed.\n if self.testload.serial:\n (speed, databits, parity, stopbits) = self.testload.serial\n self.speed = speed\n baudrates = {\n 0: termios.B0,\n 50: termios.B50,\n 75: termios.B75,\n 110: termios.B110,\n 134: termios.B134,\n 150: termios.B150,\n 200: termios.B200,\n 300: termios.B300,\n 600: termios.B600,\n 1200: termios.B1200,\n 1800: termios.B1800,\n 2400: termios.B2400,\n 4800: termios.B4800,\n 9600: termios.B9600,\n 19200: termios.B19200,\n 38400: termios.B38400,\n 57600: termios.B57600,\n 115200: termios.B115200,\n 230400: termios.B230400,\n }\n (self.fd, self.slave_fd) = pty.openpty()\n self.byname = os.ttyname(self.slave_fd)\n os.chmod(self.byname, stat.S_IRUSR | stat.S_IWUSR | stat.S_IRGRP\n | stat.S_IWGRP | stat.S_IROTH | stat.S_IWOTH)\n (iflag, oflag, cflag, lflag, ispeed, ospeed, cc) = termios.tcgetattr(\n self.slave_fd)\n cc[termios.VMIN] = 1\n cflag &= ~(termios.PARENB | termios.PARODD | termios.CRTSCTS)\n cflag |= termios.CREAD | termios.CLOCAL\n iflag = oflag = lflag = 0\n iflag &= ~ (termios.PARMRK | termios.INPCK)\n cflag &= ~ (termios.CSIZE | termios.CSTOPB | termios.PARENB\n | termios.PARODD)\n if databits == 7:\n cflag |= termios.CS7\n else:\n cflag |= termios.CS8\n if stopbits == 2:\n cflag |= termios.CSTOPB\n # Warning: attempting to set parity makes Fedora lose its cookies\n if parity == 'E':\n iflag |= termios.INPCK\n cflag |= termios.PARENB\n elif parity == 'O':\n iflag |= termios.INPCK\n cflag |= termios.PARENB | termios.PARODD\n ispeed = ospeed = baudrates[speed]\n try:\n termios.tcsetattr(self.slave_fd, termios.TCSANOW,\n [iflag, oflag, cflag, lflag, ispeed, ospeed, cc])\n except termios.error:\n raise TestLoadError(\"error attempting to set serial mode to %s \"\n \" %s%s%s\"\n % (speed, databits, parity, stopbits))\n\n def read(self):\n \"Discard control strings written by gpsd.\"\n # A tcflush implementation works on Linux but fails on OpenBSD 4.\n termios.tcflush(self.fd, termios.TCIFLUSH)\n # Alas, the FIONREAD version also works on Linux and fails on OpenBSD.\n # try:\n # buf = array.array('i', [0])\n # fcntl.ioctl(self.master_fd, termios.FIONREAD, buf, True)\n # n = struct.unpack('i', buf)[0]\n # os.read(self.master_fd, n)\n # except IOError:\n # pass\n\n def write(self, line):\n self.progress(\"gpsfake: %s writes %d=%s\\n\"\n % (self.testload.name, len(line), repr(line)))\n os.write(self.fd, line)\n\n def drain(self):\n \"Wait for the associated device to drain (e.g. before closing).\"\n termios.tcdrain(self.fd)\n\n\ndef get_nmea_string(longitude, latitude, date_value, time_value):\n msg = pynmea2.GGA('GP', 'GGA', ((datetime.datetime.strptime(time_value,'%H:%M:%S').time().strftime(\"%H%M%S.00\")), ('%03i%02.5f' % (int(float(math.floor(abs(latitude)))),(abs(latitude)-float(math.floor(abs(latitude))))*60.00)), ('S' if latitude < 0 else 'N'), ('%03i%02.5f' % (int(float(math.floor(abs(longitude)))),(abs(longitude)-float(math.floor(abs(longitude))))*60.00)), ('W' if longitude < 0 else 'E'), '1', '04', '2.6', '100.00', 'M', '-33.9', 'M', '', '0000'))\n return msg\n\ndef get_gps():\n ser = serial.Serial(\"/dev/ttyS0\",115200)\n return_value = \"\"\n while True:\n gps_command = 'AT+CIPGSMLOC=1,1'\n ser.write(gps_command+'\\r\\n')\n time.sleep(1)\n data = \"\"\n while ser.inWaiting() > 0:\n data += ser.read(ser.inWaiting())\n if data != \"\":\n m = re.search(\"\\+CIPGSMLOC:\\s+\\d+,(?P-?\\d+\\.\\d+),(?P-?\\d+\\.\\d+),(?P\\d+/\\d+/\\d+),(?P