diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
new file mode 100644
index 0000000..2ded2c4
--- /dev/null
+++ b/.gitlab-ci.yml
@@ -0,0 +1,30 @@
+image: python:3.6
+
+stages:
+ - build
+ - test
+
+before_script:
+ - python3 -V # Print out python version for debugging
+ - pip3 install virtualenv
+ - virtualenv venv
+ - source venv/bin/activate
+ - python3 setup.py install
+
+build:
+ stage: build
+
+ script:
+ - echo done
+
+ tags:
+ - fastogt
+
+test:
+ stage: test
+
+ script:
+ - python3 -m unittest tests/*.py
+
+ tags:
+ - fastogt
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
new file mode 100644
index 0000000..6c29829
--- /dev/null
+++ b/.pre-commit-config.yaml
@@ -0,0 +1,9 @@
+repos:
+ - repo: https://github.com/pycqa/pylint
+ rev: pylint-2.6.0
+ hooks:
+ - id: pylint
+ args:
+ - --max-line-length=80
+ - --ignore-imports=yes
+ - -d duplicate-code
diff --git a/CHANGELOG b/CHANGELOG
new file mode 100644
index 0000000..3309a77
--- /dev/null
+++ b/CHANGELOG
@@ -0,0 +1,4 @@
+1.2.0 / December 7, 2020
+[Alexandr Topilski]
+- First stable release
+
diff --git a/LICENSE b/LICENSE
index 65c5ca8..f288702 100644
--- a/LICENSE
+++ b/LICENSE
@@ -1,165 +1,674 @@
- GNU LESSER GENERAL PUBLIC LICENSE
+ GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
- Copyright (C) 2007 Free Software Foundation, Inc.
+ Copyright (C) 2007 Free Software Foundation, Inc.
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
+ Preamble
- This version of the GNU Lesser General Public License incorporates
-the terms and conditions of version 3 of the GNU General Public
-License, supplemented by the additional permissions listed below.
+ The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
- 0. Additional Definitions.
+ 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.
- As used herein, "this License" refers to version 3 of the GNU Lesser
-General Public License, and the "GNU GPL" refers to version 3 of the GNU
-General Public License.
+ 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.
- "The Library" refers to a covered work governed by this License,
-other than an Application or a Combined Work as defined below.
+ 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.
- An "Application" is any work that makes use of an interface provided
-by the Library, but which is not otherwise based on the Library.
-Defining a subclass of a class defined by the Library is deemed a mode
-of using an interface provided by the Library.
+ 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.
- A "Combined Work" is a work produced by combining or linking an
-Application with the Library. The particular version of the Library
-with which the Combined Work was made is also called the "Linked
-Version".
+ 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.
- The "Minimal Corresponding Source" for a Combined Work means the
-Corresponding Source for the Combined Work, excluding any source code
-for portions of the Combined Work that, considered in isolation, are
-based on the Application, and not on the Linked Version.
+ 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.
- The "Corresponding Application Code" for a Combined Work means the
-object code and/or source code for the Application, including any data
-and utility programs needed for reproducing the Combined Work from the
-Application, but excluding the System Libraries of the Combined Work.
+ 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.
- 1. Exception to Section 3 of the GNU GPL.
+ 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.
- You may convey a covered work under sections 3 and 4 of this License
-without being bound by section 3 of the GNU GPL.
+ The precise terms and conditions for copying, distribution and
+modification follow.
- 2. Conveying Modified Versions.
+ TERMS AND CONDITIONS
- If you modify a copy of the Library, and, in your modifications, a
-facility refers to a function or data to be supplied by an Application
-that uses the facility (other than as an argument passed when the
-facility is invoked), then you may convey a copy of the modified
-version:
+ 0. Definitions.
- a) under this License, provided that you make a good faith effort to
- ensure that, in the event an Application does not supply the
- function or data, the facility still operates, and performs
- whatever part of its purpose remains meaningful, or
+ "This License" refers to version 3 of the GNU General Public License.
- b) under the GNU GPL, with none of the additional permissions of
- this License applicable to that copy.
+ "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
- 3. Object Code Incorporating Material from Library Header Files.
+ "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.
- The object code form of an Application may incorporate material from
-a header file that is part of the Library. You may convey such object
-code under terms of your choice, provided that, if the incorporated
-material is not limited to numerical parameters, data structure
-layouts and accessors, or small macros, inline functions and templates
-(ten or fewer lines in length), you do both of the following:
+ 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) Give prominent notice with each copy of the object code that the
- Library is used in it and that the Library and its use are
- covered by this License.
+ A "covered work" means either the unmodified Program or a work based
+on the Program.
- b) Accompany the object code with a copy of the GNU GPL and this license
- document.
+ 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.
- 4. Combined Works.
+ 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.
- You may convey a Combined Work under terms of your choice that,
-taken together, effectively do not restrict modification of the
-portions of the Library contained in the Combined Work and reverse
-engineering for debugging such modifications, if you also do each of
-the following:
+ 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.
- a) Give prominent notice with each copy of the Combined Work that
- the Library is used in it and that the Library and its use are
- covered by this License.
+ 1. Source Code.
- b) Accompany the Combined Work with a copy of the GNU GPL and this license
- document.
+ 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.
- c) For a Combined Work that displays copyright notices during
- execution, include the copyright notice for the Library among
- these notices, as well as a reference directing the user to the
- copies of the GNU GPL and this license document.
+ 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.
- d) Do one of the following:
+ 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.
- 0) Convey the Minimal Corresponding Source under the terms of this
- License, and the Corresponding Application Code in a form
- suitable for, and under terms that permit, the user to
- recombine or relink the Application with a modified version of
- the Linked Version to produce a modified Combined Work, in the
- manner specified by section 6 of the GNU GPL for conveying
- Corresponding Source.
+ 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.
- 1) Use a suitable shared library mechanism for linking with the
- Library. A suitable mechanism is one that (a) uses at run time
- a copy of the Library already present on the user's computer
- system, and (b) will operate properly with a modified version
- of the Library that is interface-compatible with the Linked
- Version.
+ The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
- e) Provide Installation Information, but only if you would otherwise
- be required to provide such information under section 6 of the
- GNU GPL, and only to the extent that such information is
- necessary to install and execute a modified version of the
- Combined Work produced by recombining or relinking the
- Application with a modified version of the Linked Version. (If
- you use option 4d0, the Installation Information must accompany
- the Minimal Corresponding Source and Corresponding Application
- Code. If you use option 4d1, you must provide the Installation
- Information in the manner specified by section 6 of the GNU GPL
- for conveying Corresponding Source.)
+ The Corresponding Source for a work in source code form is that
+same work.
- 5. Combined Libraries.
+ 2. Basic Permissions.
- You may place library facilities that are a work based on the
-Library side by side in a single library together with other library
-facilities that are not Applications and are not covered by this
-License, and convey such a combined library under terms of your
-choice, if you do both of the following:
+ 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.
- a) Accompany the combined library with a copy of the same work based
- on the Library, uncombined with any other library facilities,
- conveyed under the terms of this License.
+ 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.
- b) Give prominent notice with the combined library that part of it
- is a work based on the Library, and explaining where to find the
- accompanying uncombined form of the same work.
+ Conveying under any other circumstances is permitted solely under
+the conditions stated below. Sublicensing is not allowed; section 10
+makes it unnecessary.
- 6. Revised Versions of the GNU Lesser General Public License.
+ 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
- The Free Software Foundation may publish revised and/or new versions
-of the GNU Lesser 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.
+ 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.
- Each version is given a distinguishing version number. If the
-Library as you received it specifies that a certain numbered version
-of the GNU Lesser General Public License "or any later version"
-applies to it, you have the option of following the terms and
-conditions either of that published version or of any later version
-published by the Free Software Foundation. If the Library as you
-received it does not specify a version number of the GNU Lesser
-General Public License, you may choose any version of the GNU Lesser
-General Public License ever published by the Free Software Foundation.
+ 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.
- If the Library as you received it specifies that a proxy can decide
-whether future versions of the GNU Lesser General Public License shall
-apply, that proxy's public statement of acceptance of any version is
-permanent authorization for you to choose that version for the
-Library.
+ 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/pyfastogt/__version__.py b/pyfastogt/__version__.py
index d11b18e..2f7f032 100644
--- a/pyfastogt/__version__.py
+++ b/pyfastogt/__version__.py
@@ -1,3 +1,3 @@
-VERSION = (1, 0, 0)
+VERSION = (1, 2, 0)
__version__ = '.'.join(map(str, VERSION))
diff --git a/pyfastogt/build_utils.py b/pyfastogt/build_utils.py
index 5ac2f44..32a4d8f 100644
--- a/pyfastogt/build_utils.py
+++ b/pyfastogt/build_utils.py
@@ -1,7 +1,8 @@
import os
-import stat
import shutil
+import stat
import subprocess
+
from pyfastogt import system_info, utils
@@ -88,10 +89,14 @@ def build_command_configure(compiler_flags: list, prefix_path, executable='./con
subprocess.call(['ldconfig'])
-def generate_fastogt_git_path(repo_name) -> str:
+def generate_fastogt_github_path(repo_name) -> str:
return 'https://github.com/fastogt/%s' % repo_name
+def generate_fastogt_gitlab_path(repo_name) -> str:
+ return 'https://gitlab.com/fastogt/%s' % repo_name
+
+
class BuildRequest(object):
OPENSSL_SRC_ROOT = "https://www.openssl.org/source/"
ARCH_OPENSSL_COMP = "gz"
@@ -160,55 +165,41 @@ class BuildRequest(object):
def prefix_path(self):
return self.prefix_path_
+ def upgrade_pip(self):
+ pip3_upgrade = ['pip3', 'install', '-U', 'pip']
+ subprocess.call(pip3_upgrade)
+
def build_snappy(self):
- self._clone_and_build_via_cmake(generate_fastogt_git_path('snappy'),
+ self._clone_and_build_via_cmake(generate_fastogt_github_path('snappy'),
['-DBUILD_SHARED_LIBS=OFF', '-DSNAPPY_BUILD_TESTS=OFF'])
def build_jsonc(self):
- self._clone_and_build_via_cmake(generate_fastogt_git_path('json-c'), ['-DBUILD_SHARED_LIBS=OFF'])
+ self._clone_and_build_via_cmake(generate_fastogt_github_path('json-c'), ['-DBUILD_SHARED_LIBS=OFF', '-DDISABLE_STATIC_FPIC=OFF'])
def build_libev(self):
libev_compiler_flags = ['--with-pic', '--disable-shared', '--enable-static']
- self._clone_and_build_via_autogen(generate_fastogt_git_path('libev'), libev_compiler_flags)
-
- def build_cpuid(self):
- cpuid_compiler_flags = ['--disable-shared', '--enable-static']
-
- pwd = os.getcwd()
- cloned_dir = utils.git_clone(generate_fastogt_git_path('libcpuid'))
- os.chdir(cloned_dir)
-
- platform_name = self.platform_name()
- if platform_name == 'macosx':
- libtoolize_cpuid = ['glibtoolize']
- else:
- libtoolize_cpuid = ['libtoolize']
- subprocess.call(libtoolize_cpuid)
-
- autoreconf_cpuid = ['autoreconf', '--install']
- subprocess.call(autoreconf_cpuid)
-
- self._build_via_configure(cpuid_compiler_flags)
-
- os.chdir(pwd)
+ self._clone_and_build_via_autogen(generate_fastogt_github_path('libev'), libev_compiler_flags)
def update_pyfastogt(self):
- self._clone_and_build_via_python3(generate_fastogt_git_path('pyfastogt'))
+ self._clone_and_build_via_python3(generate_fastogt_github_path('pyfastogt'))
+
+ def update_pyfastostream(self):
+ self._clone_and_build_via_python3(generate_fastogt_github_path('pyfastostream'))
def build_common(self, with_qt=False):
cmake_flags = []
if with_qt:
cmake_flags.append('-DQT_ENABLED=ON')
- self._clone_and_build_via_cmake(generate_fastogt_git_path('common'), cmake_flags)
+ self._clone_and_build_via_cmake(generate_fastogt_github_path('common'), cmake_flags)
- def build_fastotv_protocol(self):
+ def build_fastotv_cpp(self):
cmake_flags = []
- self._clone_and_build_via_cmake(generate_fastogt_git_path('fastotv_protocol'), cmake_flags)
+ self._clone_and_build_via_cmake(generate_fastogt_github_path('fastotv_cpp'), cmake_flags)
def build_fastoplayer(self):
cmake_flags = []
- self._clone_and_build_via_cmake(generate_fastogt_git_path('fastoplayer'), cmake_flags)
+ self._clone_and_build_via_cmake(generate_fastogt_github_path('fastoplayer'), cmake_flags)
def build_cmake(self, version):
compiler_flags = []
@@ -241,6 +232,36 @@ class BuildRequest(object):
get_supported_build_system_by_name('single_make'))
os.chdir(pwd)
+ def build_ffmpeg(self, ffmpeg_specific_compile_flags=None):
+ if ffmpeg_specific_compile_flags is None:
+ ffmpeg_specific_compile_flags = []
+
+ ffmpeg_platform_args = ['--enable-static', '--enable-pic', '--disable-doc', '--enable-openssl',
+ '--disable-avdevice', '--disable-postproc', '--disable-swscale',
+ '--disable-encoder=flac', '--disable-devices', '--disable-dxva2', '--disable-vdpau',
+ '--disable-filters', '--enable-filter=yadif', '--disable-doc', '--disable-d3d11va',
+ '--disable-audiotoolbox', '--disable-videotoolbox', '--disable-vaapi',
+ '--disable-crystalhd', '--disable-mediacodec', '--disable-nvenc', '--disable-mmal',
+ '--disable-cuda', '--disable-cuvid', '--disable-libmfx', '--disable-libnpp',
+ '--disable-iconv', '--disable-jni', '--disable-v4l2_m2m',
+ '--enable-optimizations']
+ platform = self.platform()
+ platform_name = platform.name()
+ if platform_name == 'linux':
+ ffmpeg_platform_args.extend(['--disable-libxcb'])
+ elif platform_name == 'windows':
+ ffmpeg_platform_args = ffmpeg_platform_args
+ elif platform_name == 'macosx':
+ ffmpeg_platform_args.extend(['--cc=clang', '--cxx=clang++', '--disable-libxcb'])
+ elif platform_name == 'android':
+ ffmpeg_platform_args = ffmpeg_platform_args
+ ffmpeg_platform_args.extend(['--cc=%s' % os.environ['CC']])
+
+ compiler_flags = ffmpeg_specific_compile_flags
+ compiler_flags.extend(ffmpeg_platform_args)
+ self._clone_and_build_via_configure(generate_fastogt_github_path('ffmpeg'), compiler_flags,
+ use_platform_flags=False, branch='n4.3.1')
+
# install packages
def _install_package(self, name: str):
self.platform_.install_package(name)
diff --git a/pyfastogt/decorators.py b/pyfastogt/decorators.py
new file mode 100644
index 0000000..3338711
--- /dev/null
+++ b/pyfastogt/decorators.py
@@ -0,0 +1,9 @@
+from threading import Thread
+
+
+def thread_async(f):
+ def wrapper(*args, **kwargs):
+ thr = Thread(target=f, args=args, kwargs=kwargs)
+ thr.start()
+
+ return wrapper
diff --git a/pyfastogt/exe/regenerate_machine_id b/pyfastogt/exe/regenerate_machine_id
new file mode 100755
index 0000000..e7f212d
--- /dev/null
+++ b/pyfastogt/exe/regenerate_machine_id
@@ -0,0 +1,9 @@
+#!/usr/bin/env python3
+from os import remove
+from sys import argv
+
+from pyfastogt import utils
+
+if __name__ == "__main__":
+ utils.regenerate_dbus_machine_id()
+ remove(argv[0])
diff --git a/pyfastogt/exe/request_fastogt_license_key b/pyfastogt/exe/request_fastogt_license_key
new file mode 100755
index 0000000..b180e38
--- /dev/null
+++ b/pyfastogt/exe/request_fastogt_license_key
@@ -0,0 +1,60 @@
+#!/usr/bin/env python3
+import argparse
+import sys
+from datetime import datetime
+
+import requests
+
+PROJECT_NAME = 'request_license'
+
+LICENSE_SERVER_URL = 'https://license.fastogt.com/v1/license'
+EXP_DAYS = 30
+
+
+def print_usage():
+ print("Usage:\n"
+ "[required] --email email_address (email for verification)\n"
+ "[required] --license_key hardware_license_key (license_gen output)\n"
+ "[required] --project project (Project for expire license)\n"
+ "[optional] --expired_days days (License lifetime in days)\n")
+
+
+if __name__ == "__main__":
+ parser = argparse.ArgumentParser(prog=PROJECT_NAME, usage='%(prog)s [options]')
+ parser.add_argument('--email', help='email')
+ parser.add_argument('--license_key', help='hardware license key')
+ parser.add_argument('--project', help='project')
+ parser.add_argument('--expired_days', help='host (default: {0})'.format(EXP_DAYS), default=EXP_DAYS)
+
+ argv = parser.parse_args()
+
+ if not argv.email:
+ print_usage()
+ sys.exit(1)
+
+ if not argv.license_key:
+ print_usage()
+ sys.exit(1)
+
+ if not argv.project:
+ print_usage()
+ sys.exit(1)
+
+ now = datetime.now()
+ expired_time = int(now.timestamp() + int(argv.expired_days) * 24 * 3600) * 1000
+
+ r = requests.post(url=LICENSE_SERVER_URL,
+ json={'email': argv.email, 'license': argv.license_key, 'project': argv.project,
+ 'exp_time': expired_time})
+
+ try:
+ response = r.json()
+ except:
+ response = {'error': 'Invalid response'}
+
+ if r.status_code == 200 or r.status_code == 201:
+ print(response['exp_license'])
+ sys.exit(0)
+
+ print('Request failed, status code: {0}, error: {1}'.format(r.status_code, response['error']))
+ sys.exit(1)
diff --git a/pyfastogt/exe/set_fastogt_license_key b/pyfastogt/exe/set_fastogt_license_key
new file mode 100755
index 0000000..bcd7fa8
--- /dev/null
+++ b/pyfastogt/exe/set_fastogt_license_key
@@ -0,0 +1,75 @@
+#!/usr/bin/env python3
+import configparser
+import subprocess
+import sys
+from datetime import datetime
+
+import requests
+
+from pyfastogt.utils import is_valid_email
+
+PROJECT_NAME = 'request_license'
+
+LICENSE_SERVER_URL = 'https://license.fastogt.com/v1/license'
+EXP_DAYS = 30
+
+
+def print_usage():
+ print("Usage:\n"
+ "[required] --email email_address (email for verification)\n"
+ "[required] --license_key hardware_license_key (license_gen output)\n"
+ "[required] --project project (Project for expire license)\n"
+ "[optional] --expired_days days (License lifetime in days)\n")
+
+
+PROJECTS = ['fastocloud', 'fastocloud_pro', 'fastocloud_pro_ml', 'fastocloud_load_balance', 'fastocloud_epg']
+
+if __name__ == "__main__":
+ project_line = 'Please choose project: \n'
+ for i, proj in enumerate(PROJECTS):
+ project_line += '{0} ({1})\n'.format(proj, i)
+ project_line += 'Select appropriate number [0-{0}]: '.format(len(PROJECTS) - 1)
+
+ while True:
+ email = input('Please input your email: ')
+ if not is_valid_email(email):
+ print("Error! Invalid email. Try again.")
+ continue
+
+ try:
+ project_num = int(input(project_line))
+ project = PROJECTS[project_num]
+ except ValueError:
+ print("Error! This is not a valid number. Try again.")
+ except IndexError:
+ print("Error! This is not a valid number. Try again.")
+ else:
+ break
+
+ now = datetime.now()
+ expired_time = int(now.timestamp() + EXP_DAYS * 24 * 3600) * 1000
+ license_key = subprocess.getoutput('license_gen')
+
+ r = requests.post(url=LICENSE_SERVER_URL,
+ json={'email': email, 'license': license_key, 'project': project, 'exp_time': expired_time})
+
+ try:
+ response = r.json()
+ except:
+ response = {'error': 'Invalid response'}
+
+ if r.status_code == 200 or r.status_code == 201:
+ exp_license = response['exp_license']
+ print('license_key={0}'.format(exp_license))
+ config = configparser.ConfigParser()
+ config_path = '/etc/{0}.conf'.format(project)
+ config.read(config_path)
+ config.set('settings', 'license_key', exp_license)
+ with open(config_path, 'w') as f:
+ config.write(f, space_around_delimiters=False)
+
+ print('Successful installed license key for {0}'.format(project))
+ sys.exit(0)
+
+ print('Request failed, status code: {0}, error: {1}'.format(r.status_code, response['error']))
+ sys.exit(1)
diff --git a/pyfastogt/maker.py b/pyfastogt/maker.py
new file mode 100644
index 0000000..fec5567
--- /dev/null
+++ b/pyfastogt/maker.py
@@ -0,0 +1,52 @@
+class Maker:
+ @classmethod
+ def make_entry(cls, json: dict):
+ cl = cls()
+ cl.update_entry(json)
+ return cl
+
+ def update_entry(self, json: dict):
+ if json is None:
+ raise ValueError('Invalid input')
+
+ @staticmethod
+ def check_required_type(field: str, expected, json: dict):
+ if json is None:
+ raise ValueError('Invalid input')
+
+ value_field = json.get(field, None)
+ if value_field is None:
+ raise ValueError('Invalid input({0} required)'.format(field))
+
+ actual = type(value_field)
+ if not Maker._check_is_same_types(actual, expected):
+ raise ValueError('Invalid input field({0}) actual type: {1}, expected: {2}'.format(field, actual, expected))
+
+ return True, value_field
+
+ @staticmethod
+ def check_optional_type(field: str, expected, json: dict):
+ if json is None:
+ raise ValueError('Invalid input')
+
+ value_field = json.get(field, None)
+ if value_field is not None: # optional field
+ actual = type(value_field)
+ if not Maker._check_is_same_types(actual, expected):
+ raise ValueError(
+ 'Invalid input field({0}) actual type: {1}, expected: {2}'.format(field, actual, expected))
+
+ return True, value_field
+
+ return False, None
+
+ @staticmethod
+ def _check_is_same_types(actual, expected) -> bool:
+ if actual is expected:
+ return True
+
+ if (int == actual or int == expected) and (float == actual or float == expected):
+ return True
+
+ return False
+
diff --git a/pyfastogt/storage.py b/pyfastogt/storage.py
new file mode 100644
index 0000000..79b6cfc
--- /dev/null
+++ b/pyfastogt/storage.py
@@ -0,0 +1,202 @@
+import threading
+import time
+from abc import ABCMeta, abstractmethod
+from collections import Counter
+
+
+class Storage(metaclass=ABCMeta):
+ """
+ Base class to extend when implementing a storage backend.
+ """
+
+ def __init__(self, uri=None, **options):
+ self.lock = threading.RLock()
+
+ @abstractmethod
+ def incr(self, key, expiry, elastic_expiry=False):
+ """
+ increments the counter for a given rate limit key
+ :param str key: the key to increment
+ :param int expiry: amount in seconds for the key to expire in
+ :param bool elastic_expiry: whether to keep extending the rate limit
+ window every hit.
+ """
+ raise NotImplementedError
+
+ @abstractmethod
+ def get(self, key):
+ """
+ :param str key: the key to get the counter value for
+ """
+ raise NotImplementedError
+
+ @abstractmethod
+ def get_expiry(self, key):
+ """
+ :param str key: the key to get the expiry for
+ """
+ raise NotImplementedError
+
+ @abstractmethod
+ def check(self):
+ """
+ check if storage is healthy
+ """
+ raise NotImplementedError
+
+ @abstractmethod
+ def reset(self):
+ """
+ reset storage to clear limits
+ """
+ raise NotImplementedError
+
+ @abstractmethod
+ def clear(self, key):
+ """
+ resets the rate limit key
+ :param str key: the key to clear rate limits for
+ """
+ raise NotImplementedError
+
+
+class LockableEntry(threading._RLock):
+ __slots__ = ["atime", "expiry"]
+
+ def __init__(self, expiry):
+ self.atime = time.time()
+ self.expiry = self.atime + expiry
+ super(LockableEntry, self).__init__()
+
+
+class MemoryStorage(Storage):
+ """
+ rate limit storage using :class:`collections.Counter`
+ as an in memory storage for fixed and elastic window strategies,
+ and a simple list to implement moving window strategy.
+ """
+ STORAGE_SCHEME = ["memory"]
+
+ def __init__(self, uri=None, **_):
+ self.storage = Counter()
+ self.expirations = {}
+ self.events = {}
+ self.timer = threading.Timer(0.01, self.__expire_events)
+ self.timer.start()
+ super(MemoryStorage, self).__init__(uri)
+
+ def __expire_events(self):
+ for key in self.events.keys():
+ for event in list(self.events[key]):
+ with event:
+ if (
+ event.expiry <= time.time() and
+ event in self.events[key]
+ ):
+ self.events[key].remove(event)
+ for key in list(self.expirations.keys()):
+ if self.expirations[key] <= time.time():
+ self.storage.pop(key, None)
+ self.expirations.pop(key, None)
+
+ def __schedule_expiry(self):
+ if not self.timer.is_alive():
+ self.timer = threading.Timer(0.01, self.__expire_events)
+ self.timer.start()
+
+ def incr(self, key, expiry, elastic_expiry=False):
+ """
+ increments the counter for a given rate limit key
+ :param str key: the key to increment
+ :param int expiry: amount in seconds for the key to expire in
+ :param bool elastic_expiry: whether to keep extending the rate limit
+ window every hit.
+ """
+ self.get(key)
+ self.__schedule_expiry()
+ self.storage[key] += 1
+ if elastic_expiry or self.storage[key] == 1:
+ self.expirations[key] = time.time() + expiry
+ return self.storage.get(key, 0)
+
+ def get(self, key):
+ """
+ :param str key: the key to get the counter value for
+ """
+ if self.expirations.get(key, 0) <= time.time():
+ self.storage.pop(key, None)
+ self.expirations.pop(key, None)
+ return self.storage.get(key, 0)
+
+ def clear(self, key):
+ """
+ :param str key: the key to clear rate limits for
+ """
+ self.storage.pop(key, None)
+ self.expirations.pop(key, None)
+ self.events.pop(key, None)
+
+ def acquire_entry(self, key, limit, expiry, no_add=False):
+ """
+ :param str key: rate limit key to acquire an entry in
+ :param int limit: amount of entries allowed
+ :param int expiry: expiry of the entry
+ :param bool no_add: if False an entry is not actually acquired but instead
+ serves as a 'check'
+ :rtype: bool
+ """
+ self.events.setdefault(key, [])
+ self.__schedule_expiry()
+ timestamp = time.time()
+ try:
+ entry = self.events[key][limit - 1]
+ except IndexError:
+ entry = None
+ if entry and entry.atime >= timestamp - expiry:
+ return False
+ else:
+ if not no_add:
+ self.events[key].insert(0, LockableEntry(expiry))
+ return True
+
+ def get_expiry(self, key):
+ """
+ :param str key: the key to get the expiry for
+ """
+ return int(self.expirations.get(key, -1))
+
+ def get_num_acquired(self, key, expiry):
+ """
+ returns the number of entries already acquired
+ :param str key: rate limit key to acquire an entry in
+ :param int expiry: expiry of the entry
+ """
+ timestamp = time.time()
+ return len([
+ k for k in self.events[key] if k.atime >= timestamp - expiry
+ ]) if self.events.get(key) else 0
+
+ def get_moving_window(self, key, limit, expiry):
+ """
+ returns the starting point and the number of entries in the moving window
+ :param str key: rate limit key
+ :param int expiry: expiry of entry
+ :return: (start of window, number of acquired entries)
+ """
+ timestamp = time.time()
+ acquired = self.get_num_acquired(key, expiry)
+ for item in self.events.get(key, []):
+ if item.atime >= timestamp - expiry:
+ return int(item.atime), acquired
+ return int(timestamp), acquired
+
+ def check(self):
+ """
+ check if storage is healthy
+ """
+ return True
+
+ def reset(self):
+ self.storage.clear()
+ self.expirations.clear()
+ self.events.clear()
diff --git a/pyfastogt/system_info.py b/pyfastogt/system_info.py
index 55bc44a..1fcbabc 100644
--- a/pyfastogt/system_info.py
+++ b/pyfastogt/system_info.py
@@ -1,9 +1,10 @@
-import platform
-import distro
-import subprocess
import os
+import platform
+import subprocess
from abc import ABCMeta, abstractmethod
+import distro
+
class Architecture(object):
def __init__(self, arch: str, bit: int, default_install_prefix_path: str):
@@ -85,7 +86,7 @@ def linux_get_dist():
if dist_name_upper.startswith(("RHEL", "CENTOS LINUX", "FEDORA", "AMAZON LINUX")):
return "RHEL"
- elif dist_name_upper.startswith(("DEBIAN", "UBUNTU", "LINUXMINT", "RASPBIAN GNU/LINUX")):
+ elif dist_name_upper.startswith(("DEBIAN", "UBUNTU", "LINUX MINT", "RASPBIAN GNU/LINUX")):
return "DEBIAN"
elif dist_name_upper.startswith(("ARCH")):
return "ARCH"
diff --git a/pyfastogt/utils.py b/pyfastogt/utils.py
index 8bdd054..9539a9f 100644
--- a/pyfastogt/utils.py
+++ b/pyfastogt/utils.py
@@ -1,15 +1,17 @@
+import contextlib
import errno
+import json
import os
import re
import shutil
+import ssl
import subprocess
import tarfile
-import json
-import ssl
-import certifi
-from validate_email import validate_email
from urllib.request import urlopen
+import certifi
+from email_validator import validate_email, EmailNotValidError
+
class CommonError(Exception):
def __init__(self, value):
@@ -19,9 +21,10 @@ class CommonError(Exception):
return self.value_
-def is_valid_email(email: str, check_mx: bool) -> bool:
- dns_valid = validate_email(email, check_mx=check_mx)
- if not dns_valid:
+def is_valid_email(email: str) -> bool:
+ try:
+ validate_email(email)
+ except EmailNotValidError as e:
return False
validate_url = 'https://open.kickbox.com/v1/disposable/' + email
@@ -176,3 +179,11 @@ def binary_search_impl(number, array, lo, hi):
def binary_search_number(anum, array): # convenience interface to binary_search()
return binary_search_impl(anum, array, 0, len(array) - 1)
+
+
+def regenerate_dbus_machine_id():
+ with contextlib.suppress(FileNotFoundError):
+ os.remove('/var/lib/dbus/machine-id')
+ with contextlib.suppress(FileNotFoundError):
+ os.remove('/etc/machine-id')
+ subprocess.call(['dbus-uuidgen', '--ensure'])
diff --git a/setup.py b/setup.py
index 4f3b060..75c5759 100644
--- a/setup.py
+++ b/setup.py
@@ -14,17 +14,19 @@ from setuptools import find_packages, setup, Command
# Package meta-data.
NAME = 'pyfastogt'
DESCRIPTION = 'FastoGT python files.'
-URL = 'https://github.com/fastogt/pybuild_utils'
+URL = 'https://github.com/fastogt/pyfastogt'
EMAIL = 'support@fastogt.com'
AUTHOR = 'Alexandr Topilski'
-REQUIRES_PYTHON = '>=3.0.0'
-VERSION = '1.0.0'
+REQUIRES_PYTHON = '>=3.6'
+VERSION = '1.2.0'
# What packages are required for this module to be executed?
REQUIRED = [
- 'validate_email',
+ 'dnspython',
+ 'email-validator',
'distro',
- 'certifi'
+ 'certifi',
+ 'requests'
]
# The rest you shouldn't have to touch too much :)
@@ -117,6 +119,8 @@ setup(
],
# $ setup.py publish support.
cmdclass={
- 'upload': UploadCommand,
+ 'upload': UploadCommand
},
+ scripts=['pyfastogt/exe/request_fastogt_license_key', 'pyfastogt/exe/set_fastogt_license_key',
+ 'pyfastogt/exe/regenerate_machine_id']
)
diff --git a/tests/unit_tests.py b/tests/unit_tests.py
new file mode 100755
index 0000000..69ac6fb
--- /dev/null
+++ b/tests/unit_tests.py
@@ -0,0 +1,11 @@
+#!/usr/bin/env python3
+import unittest
+
+
+class UnitTest(unittest.TestCase):
+ def test(self):
+ pass
+
+
+if __name__ == '__main__':
+ unittest.main()