diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..281d399
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,619 @@
+ GNU GENERAL PUBLIC LICENSE
+ Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc.
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The GNU General Public License is a free, copyleft license for
+software and other kinds of works.
+
+ The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works. By contrast,
+the GNU General Public License is intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users. We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors. You can apply it to
+your programs, too.
+
+ When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+ To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights. Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+ For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received. You must make sure that they, too, receive
+or can get the source code. And you must show them these terms so they
+know their rights.
+
+ Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+ For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software. For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+ Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so. This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software. The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable. Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products. If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+ Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary. To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+
+ TERMS AND CONDITIONS
+
+ 0. Definitions.
+
+ "This License" refers to version 3 of the GNU General Public License.
+
+ "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+ "The Program" refers to any copyrightable work licensed under this
+License. Each licensee is addressed as "you". "Licensees" and
+"recipients" may be individuals or organizations.
+
+ To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy. The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+ A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+ To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy. Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+ To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies. Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+ An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License. If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+ 1. Source Code.
+
+ The "source code" for a work means the preferred form of the work
+for making modifications to it. "Object code" means any non-source
+form of a work.
+
+ A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+ The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form. A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+ The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities. However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work. For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+ The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+ The Corresponding Source for a work in source code form is that
+same work.
+
+ 2. Basic Permissions.
+
+ All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met. This License explicitly affirms your unlimited
+permission to run the unmodified Program. The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work. This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+ You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force. You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright. Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+ Conveying under any other circumstances is permitted solely under
+the conditions stated below. Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+ 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+ No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+ When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+ 4. Conveying Verbatim Copies.
+
+ You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+ You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+ 5. Conveying Modified Source Versions.
+
+ You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+ a) The work must carry prominent notices stating that you modified
+ it, and giving a relevant date.
+
+ b) The work must carry prominent notices stating that it is
+ released under this License and any conditions added under section
+ 7. This requirement modifies the requirement in section 4 to
+ "keep intact all notices".
+
+ c) You must license the entire work, as a whole, under this
+ License to anyone who comes into possession of a copy. This
+ License will therefore apply, along with any applicable section 7
+ additional terms, to the whole of the work, and all its parts,
+ regardless of how they are packaged. This License gives no
+ permission to license the work in any other way, but it does not
+ invalidate such permission if you have separately received it.
+
+ d) If the work has interactive user interfaces, each must display
+ Appropriate Legal Notices; however, if the Program has interactive
+ interfaces that do not display Appropriate Legal Notices, your
+ work need not make them do so.
+
+ A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit. Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+ 6. Conveying Non-Source Forms.
+
+ You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+ a) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by the
+ Corresponding Source fixed on a durable physical medium
+ customarily used for software interchange.
+
+ b) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by a
+ written offer, valid for at least three years and valid for as
+ long as you offer spare parts or customer support for that product
+ model, to give anyone who possesses the object code either (1) a
+ copy of the Corresponding Source for all the software in the
+ product that is covered by this License, on a durable physical
+ medium customarily used for software interchange, for a price no
+ more than your reasonable cost of physically performing this
+ conveying of source, or (2) access to copy the
+ Corresponding Source from a network server at no charge.
+
+ c) Convey individual copies of the object code with a copy of the
+ written offer to provide the Corresponding Source. This
+ alternative is allowed only occasionally and noncommercially, and
+ only if you received the object code with such an offer, in accord
+ with subsection 6b.
+
+ d) Convey the object code by offering access from a designated
+ place (gratis or for a charge), and offer equivalent access to the
+ Corresponding Source in the same way through the same place at no
+ further charge. You need not require recipients to copy the
+ Corresponding Source along with the object code. If the place to
+ copy the object code is a network server, the Corresponding Source
+ may be on a different server (operated by you or a third party)
+ that supports equivalent copying facilities, provided you maintain
+ clear directions next to the object code saying where to find the
+ Corresponding Source. Regardless of what server hosts the
+ Corresponding Source, you remain obligated to ensure that it is
+ available for as long as needed to satisfy these requirements.
+
+ e) Convey the object code using peer-to-peer transmission, provided
+ you inform other peers where the object code and Corresponding
+ Source of the work are being offered to the general public at no
+ charge under subsection 6d.
+
+ A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+ A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling. In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage. For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product. A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+ "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source. The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+ If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information. But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+ The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed. Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+ Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+ 7. Additional Terms.
+
+ "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law. If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+ When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it. (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.) You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+ Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+ a) Disclaiming warranty or limiting liability differently from the
+ terms of sections 15 and 16 of this License; or
+
+ b) Requiring preservation of specified reasonable legal notices or
+ author attributions in that material or in the Appropriate Legal
+ Notices displayed by works containing it; or
+
+ c) Prohibiting misrepresentation of the origin of that material, or
+ requiring that modified versions of such material be marked in
+ reasonable ways as different from the original version; or
+
+ d) Limiting the use for publicity purposes of names of licensors or
+ authors of the material; or
+
+ e) Declining to grant rights under trademark law for use of some
+ trade names, trademarks, or service marks; or
+
+ f) Requiring indemnification of licensors and authors of that
+ material by anyone who conveys the material (or modified versions of
+ it) with contractual assumptions of liability to the recipient, for
+ any liability that these contractual assumptions directly impose on
+ those licensors and authors.
+
+ All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10. If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term. If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+ If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+ Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+ 8. Termination.
+
+ You may not propagate or modify a covered work except as expressly
+provided under this License. Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+ However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+ Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+ Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License. If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+ 9. Acceptance Not Required for Having Copies.
+
+ You are not required to accept this License in order to receive or
+run a copy of the Program. Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance. However,
+nothing other than this License grants you permission to propagate or
+modify any covered work. These actions infringe copyright if you do
+not accept this License. Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+ 10. Automatic Licensing of Downstream Recipients.
+
+ Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License. You are not responsible
+for enforcing compliance by third parties with this License.
+
+ An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations. If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+ You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License. For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+ 11. Patents.
+
+ A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based. The
+work thus licensed is called the contributor's "contributor version".
+
+ A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version. For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+ Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+ In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement). To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+ If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients. "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+ If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+ A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License. You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+ Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+ 12. No Surrender of Others' Freedom.
+
+ If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all. For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+ 13. Use with the GNU Affero General Public License.
+
+ Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU Affero General Public License into a single
+combined work, and to convey the resulting work. The terms of this
+License will continue to apply to the part which is the covered work,
+but the special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+ 14. Revised Versions of this License.
+
+ The Free Software Foundation may publish revised and/or new versions of
+the GNU General Public License from time to time. Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+ Each version is given a distinguishing version number. If the
+Program specifies that a certain numbered version of the GNU General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation. If the Program does not specify a version number of the
+GNU General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+ If the Program specifies that a proxy can decide which future
+versions of the GNU General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+ Later license versions may give you additional or different
+permissions. However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+ 15. Disclaimer of Warranty.
+
+ THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+ 16. Limitation of Liability.
+
+ IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+ 17. Interpretation of Sections 15 and 16.
+
+ If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7e985a8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,8 @@
+# CatNet Python server
+
+## Описание
+
+Сервер на сокетах, который в своем комплекте имеет обработчики следующих
+прикладных протоколов:
+
+* HTTP.
diff --git a/config.py b/config.py
index db0fc83..eead487 100644
--- a/config.py
+++ b/config.py
@@ -16,16 +16,6 @@ SETUP = {
}
}
-
-if SETUP["setup"]["log_to_file"]:
- logging.basicConfig(filename=os.path.join(os.getcwd(), "log", "main.log"), filemode="a", encoding="UTF-8",
- level=SETUP["setup"]["log_level"],
- format="[%(name)s][%(asctime)s][%(levelname)s] %(message)s")
-else:
- logging.basicConfig(encoding="UTF-8", level=SETUP["setup"]["log_level"],
- format="[%(name)s][%(asctime)s][%(levelname)s] %(message)s")
-
-
urls = [
Path("/", HandlerType.STATIC_FILE, "index.html"),
Path("/func", HandlerType.FUNCTION, testmod.work, HTTPMethod.GET|HTTPMethod.POST),
diff --git a/main.py b/main.py
index 5f01f68..87b3b83 100755
--- a/main.py
+++ b/main.py
@@ -2,30 +2,31 @@
import os
import logging
-from server.main import start_http_server
import config
+from server.main import init_server_socket
+from server.http_handler import HTTPHandler
+
log = logging.getLogger(__name__)
+if config.SETUP["setup"]["log_to_file"]:
+ logging.basicConfig(filename=os.path.join(os.getcwd(), "log", "main.log"), filemode="a", encoding="UTF-8",
+ level=config.SETUP["setup"]["log_level"],
+ format="[%(asctime)s][%(levelname)s][%(name)s] %(message)s")
+else:
+ logging.basicConfig(encoding="UTF-8", level=config.SETUP["setup"]["log_level"],
+ format="[%(asctime)s][%(levelname)s][%(name)s] %(message)s")
+
+
if __name__ == "__main__":
try:
os.mkdir(os.path.join(os.getcwd(), "log"))
except OSError:
- pass #print("dir is exists")
+ log.debug("Directory \"log\" is exists")
+ else:
+ log.debug("Directory \"log\" created")
- project_logotype = """
- ________ _ _ _______ _______ ______ _ _
- | ______ | | |_ | | | _____ | | _____| | ___ | | | | |
- | | |_| | | | | | | |_| | | | | | | |_| |_|
- | | | ||_| | | |_|___ | |___ | |___| | | | | |
- | | | | |_| | | |___|_ | ___| | ____| |_| |_|
- | | _ | | |_|| | _ | | | | | |_|_ | | | |
- | |______| | | | |_ | | |_____| | | |_____ | | |_|_ |_|_|_|
- |________| |_| |_| |_______| |_______| | | |_| |_|
+ log.error("Attempt to start server...")
-============================== Start HTTP server ==============================="""
-
- log.info(project_logotype)
-
- start_http_server()
+ init_server_socket(server_handler=HTTPHandler)
diff --git a/server/__init__.py b/server/__init__.py
new file mode 100644
index 0000000..e69de29
diff --git a/server/common.py b/server/common.py
index dff3e1b..50cf85e 100644
--- a/server/common.py
+++ b/server/common.py
@@ -1,6 +1,8 @@
import enum
+MAX_REQUEST_LINE_SIZE = 64 * 1024
+
@enum.unique
class HandlerType(enum.Enum):
STATIC_FILE = 0
diff --git a/server/file_read.py b/server/file_read.py
index c993466..e4764b9 100644
--- a/server/file_read.py
+++ b/server/file_read.py
@@ -1,7 +1,26 @@
+#
+# CatNet Python Server
+#
+# Copyright (C) 2023-2024 John Solntsev
+#
+# 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 .
+#
+
import logging
-log = logging.getLogger(__name__)
+log = logging.getLogger(__name__)
def fileiter(filename):
log.debug("Open file %s to byte-read" % filename)
@@ -10,12 +29,10 @@ def fileiter(filename):
while True:
file_data = f.read(1024)
+ yield file_data
+
if len(file_data) >= 1024:
- log.debug("File size greeter 1024 bytes, yield data")
- yield file_data
- log.debug("Continue")
+ log.debug("File size greeter 1024 bytes, yield data. Continue to read")
else:
- log.debug("File size lower 1024 bytes, yield data")
- yield file_data
- log.debug("Break")
+ log.debug("File size lower 1024 bytes, yield data. Break to read")
break
diff --git a/server/http_handler.py b/server/http_handler.py
new file mode 100644
index 0000000..5a8c4d9
--- /dev/null
+++ b/server/http_handler.py
@@ -0,0 +1,261 @@
+#
+# CatNet Python Server
+#
+# Copyright (C) 2023-2024 John Solntsev
+#
+# 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 .
+#
+
+import logging
+
+import config
+
+from .common import MAX_REQUEST_LINE_SIZE, HandlerType, HTTPMethod
+from .file_read import fileiter
+from .response import Response
+
+
+log = logging.getLogger(__name__)
+
+
+class HTTPHandler:
+ def __init__(self, conn, addr):
+ self.conn = conn
+ self.addr = addr
+
+ self.read_fd = conn.makefile("rb")
+ self.write_fd = conn.makefile("wb")
+
+ self.http_method = ""
+ self.http_address = ""
+ self.http_get_request = {}
+ self.http_headers = {}
+
+ self.data = b""
+
+ self.__handle_connection()
+
+ def __write_data(self, data_iter):
+ for chunk in data_iter:
+ self.write_fd.write(chunk)
+ self.write_fd.flush()
+
+ def __read_data(self, size=MAX_REQUEST_LINE_SIZE+1):
+ return self.read_fd.readline(size)
+
+ def __close(self):
+ self.write_fd.close()
+ self.read_fd.close()
+ self.conn.close()
+
+ def __handle_connection(self):
+ """
+ Chain of handle first line of HTTP request
+ """
+ raw = self.__read_data()
+
+ if len(raw) > MAX_REQUEST_LINE_SIZE:
+ log.debug("Request line too long")
+
+ r = Response(status_code=413, data=b"Request line too long")
+ self.__write_data(r)
+
+ self.__close()
+ return
+
+ # FIXME data maybe isn't UTF-8 or just binary
+ req_line = raw.decode().rstrip("\r\n")
+ req_line_splited = req_line.split(" ")
+
+ if len(req_line_splited) != 3:
+ if len(req_line_splited) > 3:
+ log.debug("Request head too long")
+ else:
+ log.debug("Request head too small")
+
+ r = Response(status_code=400, data=b"Bad request")
+ self.__write_data(r)
+ self.__close()
+ return
+
+
+ if req_line_splited[2].startswith("HTTP/"):
+ if (req_line_splited[2] == "HTTP/1.0" or
+ req_line_splited[2] == "HTTP/1.1"):
+ http_method = req_line_splited[0]
+ else:
+ log.debug("Unsupported HTTP version")
+
+ r = Response(status_code=505, data=b"HTTP Version Not Supported")
+ self.__write_data(r)
+ self.__close()
+ return
+ else:
+ log.debug("Protocol isn't HTTP version 1.0 or 1.1")
+
+ r = Response(status_code=400, data=b"Bad request")
+ self.__write_data(r)
+ self.__close()
+ return
+
+ if http_method == "GET":
+ self.http_method = HTTPMethod.GET
+ elif http_method == "POST":
+ self.http_method = HTTPMethod.POST
+ elif http_method == "PUT":
+ self.http_method = HTTPMethod.PUT
+ elif http_method == "HEAD":
+ self.http_method = HTTPMethod.HEAD
+ elif http_method == "DELETE":
+ self.http_method = HTTPMethod.DELETE
+ elif http_method == "OPTIONS":
+ self.http_method = HTTPMethod.OPTIONS
+ elif http_method == "TRACE":
+ self.http_method = HTTPMethod.TRACE
+ elif http_method == "PATCH":
+ self.http_method = HTTPMethod.PATCH
+ else:
+ log.debug("Method not allowed")
+
+ r = Response(status_code=405, data=b"Method not allowed")
+ self.__write_data(r)
+ self.__close()
+ return
+
+ if (self.http_method == HTTPMethod.GET and
+ req_line_splited[1].find("?") >= 0):
+
+ addr, get_req = req_line_splited[1].split("?", 1)
+ self.http_address = addr
+
+ for param in get_req.split("&"):
+ if len(param) == 0:
+ continue
+
+ elif param.find("=") >= 0:
+ name, val = param.split("=", 1)
+
+ else:
+ name, val = (param, "")
+
+ self.http_get_request.update({name: val})
+ else:
+ self.http_address = req_line_splited[1]
+ self.http_get_request = {}
+
+ self.__http_header_handle()
+
+ def __http_header_handle(self):
+ """
+ Chain of handle headers in HTTP request
+ """
+ while True:
+ raw = self.__read_data()
+
+ if len(raw) > MAX_REQUEST_LINE_SIZE:
+ log.debug("Request header line too long")
+ self.__close()
+ return
+
+ if raw == b"":
+ log.debug("Client not send data, close connection")
+ self.__close()
+ return
+
+ if raw == b"\r\n" or raw == b"\n":
+ self.__http_data_handle()
+ break
+ else:
+ decoded_data = raw.decode("UTF-8").rstrip("\r\n")
+ decoded_data_split = decoded_data.split(":", 1)
+ self.http_headers.update(
+ {
+ decoded_data_split[0]: decoded_data_split[1].strip(" ")
+ })
+
+ def __http_data_handle(self):
+ """
+ Chain of receive data partitions HTTP request
+ """
+
+ if "Content-Length" in self.http_headers:
+ # TODO: if content-length biggest of MAX_REQUEST_LINE_SIZE - partition receive
+ log.debug("Request has contain body, try to read")
+ log.debug("Check Content-Length value type:")
+
+ if self.http_headers["Content-Length"].isdigit():
+ log.debug(" Pass")
+ bytes_to_receive = int(self.http_headers["Content-Length"])
+ else:
+ log.error(" Content-Length is not integer")
+ self.__close()
+ return
+
+ log.debug("Want to receive {} bytes from client".format(bytes_to_receive))
+ self.data = self.read_fd.read(bytes_to_receive)
+
+ log.debug("Request method: %s" % self.http_method)
+ log.debug("Requested address: %s" % self.http_address)
+ log.debug("Request headers: %s" % self.http_headers)
+ log.debug("Request in GET after ?: %s" % self.http_get_request)
+ log.debug("Data: %s" % self.data)
+
+ self.__send_form_data()
+
+ def __send_form_data(self):
+ """
+ Chain of handle, pack & send data to client
+ """
+ found = False
+
+ for path in config.urls:
+ if self.http_address == path.address:
+ if self.http_method in path.methods:
+ found = True
+
+ if path.handler_type == HandlerType.STATIC_FILE:
+ log.debug("Address associated with static file on path {}".format(path.link))
+ r = Response(data=fileiter(path.link))
+ self.__write_data(r)
+
+ elif path.handler_type == HandlerType.FUNCTION:
+ log.debug("Address associated with function")
+ func = path.link
+
+ if func.__code__.co_argcount == 0:
+ func_return = func()
+
+ elif func.__code__.co_argcount == 1:
+ func_return = func(self.http_headers)
+
+ elif func.__code__.co_argcount == 2:
+ func_return = func(self.http_headers, self.http_get_request)
+
+ elif func.__code__.co_argcount == 3:
+ func_return = func(self.http_headers, self.http_get_request, self.data)
+
+ self.__write_data(func_return)
+
+ else:
+ log.warning("Address configured on server, but type not allowed URL type in URLs list")
+
+ r = Response(status_code=404,
+ data=b"Address configured on server, but type not allowed URL type in URLs list")
+ self.__write_data(r)
+
+ if not found:
+ r = Response(status_code=404, data=b"Not found!")
+ self.__write_data(r)
+
+ self.__close()
diff --git a/server/main.py b/server/main.py
index ef45812..3325429 100644
--- a/server/main.py
+++ b/server/main.py
@@ -5,245 +5,29 @@ import os
import config
-from .file_read import fileiter
-from .response import Response
-from .common import HandlerType, HTTPMethod
+from .http_handler import HTTPHandler
-MAX_REQLINE = 64 * 1024
-
log = logging.getLogger(__name__)
-class HTTPHandler:
- def __init__(self, conn, addr):
- self.conn = conn
- self.addr = addr
+def init_server_socket(server_handler):
+ assert server_handler == HTTPHandler, "Server handler isn't Handler type"
- self.read_fb = conn.makefile("rb")
- self.write_fb = conn.makefile("wb")
-
- self.http_method = ""
- self.http_address = ""
- self.http_get_request = {}
- self.http_headers = {}
-
- self.data = b""
-
- self.pre_handle_connection()
-
- def pre_handle_connection(self):
- """
- Chain of handle first line of HTTP request
- """
- raw = self.read_fb.readline(MAX_REQLINE + 1)
-
- if len(raw) > MAX_REQLINE:
- log.debug("Request line too long")
- self.conn.send(b"")
- self.conn.close()
- return
-
- req_line = raw.decode().rstrip("\r\n")
- # method, address, protocol = req_line_splited
- req_line_splited = req_line.split(" ")
-
- if len(req_line_splited) != 3:
- if len(req_line_splited) > 3:
- log.debug("Request head too long")
- else:
- log.debug("Request head too small")
-
- self.conn.send(b"")
- self.conn.close()
- return
-
- if (req_line_splited[2] == "HTTP/1.0" or
- req_line_splited[2] == "HTTP/1.1"):
-
- http_method = req_line_splited[0]
-
- else:
- self.conn.send(b"")
- self.conn.close()
- return
-
- if http_method == "GET":
- self.http_method = HTTPMethod.GET
- elif http_method == "POST":
- self.http_method = HTTPMethod.POST
- elif http_method == "PUT":
- self.http_method = HTTPMethod.PUT
- elif http_method == "HEAD":
- self.http_method = HTTPMethod.HEAD
- elif http_method == "DELETE":
- self.http_method = HTTPMethod.DELETE
- elif http_method == "OPTIONS":
- self.http_method = HTTPMethod.OPTIONS
- elif http_method == "TRACE":
- self.http_method = HTTPMethod.TRACE
- elif http_method == "PATCH":
- self.http_method = HTTPMethod.PATCH
- else:
- self.conn.send(b"")
- self.conn.close()
- return
-
- if (self.http_method == HTTPMethod.GET and
- req_line_splited[1].find("?") >= 0):
-
- addr, get_req = req_line_splited[1].split("?", 1)
- self.http_address = addr
-
- for param in get_req.split("&"):
- if len(param) == 0:
- continue
-
- elif param.find("=") >= 0:
- name, val = param.split("=", 1)
-
- else:
- name, val = (param, "")
-
- self.http_get_request.update({name: val})
- else:
- self.http_address = req_line_splited[1]
- self.http_get_request = {}
-
- self.http_header_handle()
-
- def http_header_handle(self):
- """
- Chain of handle headers in HTTP request
- """
- while True:
- raw = self.read_fb.readline(MAX_REQLINE + 1)
-
- if len(raw) > MAX_REQLINE:
- log.debug("Request header line too long")
- self.conn.send(b"")
- self.conn.close()
- return
-
- if raw == b"":
- self.conn.send(b"")
- self.conn.close()
- return
-
- if raw == b"\r\n":
- self.http_data_handle()
- break
- else:
- decoded_data = raw.decode("UTF-8").rstrip("\r\n")
- decoded_data_split = decoded_data.split(":", 1)
- self.http_headers.update(
- {
- decoded_data_split[0]: decoded_data_split[1].strip(" ")
- })
-
- def http_data_handle(self):
- """
- Chain of receive data partitions HTTP request
- """
-
- if "Content-Length" in self.http_headers:
- # TODO: if content-length biggest of MAX_REQLINE - partition receive
- log.debug("Request has contain body, try to read")
- log.debug("Check Content-Length value type:")
-
- if self.http_headers["Content-Length"].isdigit():
- log.debug(" Pass")
- bytes_to_receive = int(self.http_headers["Content-Length"])
- else:
- log.error(" Content-Length is not integer")
- self.conn.send(b"")
- self.conn.close()
- return
-
- log.debug("Want to receive {} bytes from client".format(bytes_to_receive))
- self.data = self.read_fb.read(bytes_to_receive)
-
- log.debug("Request method: %s" % self.http_method)
- log.debug("Requested address: %s" % self.http_address)
- log.debug("Request headers: %s" % self.http_headers)
- log.debug("Request in GET after ?: %s" % self.http_get_request)
- log.debug("Data: %s" % self.data)
-
- self.send_form_data()
-
- def send_form_data(self):
- """
- Chain of handle, pack & send data to client
- """
- found = False
-
- for path in config.urls:
- if self.http_address == path.address:
- if self.http_method in path.methods:
- found = True
-
- if path.handler_type == HandlerType.STATIC_FILE:
- log.debug("Address associated with static file on path {}".format(path.link))
- r = Response(data=fileiter(path.link))
-
- for i in r:
- self.write_fb.write(i)
- self.write_fb.flush()
-
- elif path.handler_type == HandlerType.FUNCTION:
- log.debug("Address associated with function")
- func = path.link
-
- if func.__code__.co_argcount == 0:
- func_return = func()
-
- elif func.__code__.co_argcount == 1:
- func_return = func(self.http_headers)
-
- elif func.__code__.co_argcount == 2:
- func_return = func(self.http_headers, self.http_get_request)
-
- elif func.__code__.co_argcount == 3:
- func_return = func(self.http_headers, self.http_get_request, self.data)
-
- for i in func_return:
- self.write_fb.write(i)
- self.write_fb.flush()
-
- else:
- log.warning("Address configured on server, but type not allowed URL type in URLs list")
- r = Response(status_code=404, data=b"Address configured on server, but type not allowed URL type in URLs list")
-
- for i in r:
- self.write_fb.write(i)
- self.write_fb.flush()
-
- if not found:
- r = Response(status_code=404, data=b"Not found!")
-
- for i in r:
- self.write_fb.write(i)
- self.write_fb.flush()
-
- self.write_fb.close()
- self.read_fb.close()
- self.conn.close()
-
-
-def start_http_server():
try:
with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as main_server_socket:
main_server_socket.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, True)
+ log.debug("Attempt to bind socket to 0.0.0.0:{}".format(config.SETUP["server"]["port"]))
main_server_socket.bind(("0.0.0.0", config.SETUP["server"]["port"]))
+ log.debug("Make socket is listen")
main_server_socket.listen()
while True:
conn, addr = main_server_socket.accept()
- log.info("Accept connection from %s", addr[0])
+ log.info("Accepted connection from %s", addr[0])
- thr_serv_conn = threading.Thread(target=HTTPHandler, args=(conn, addr,))
+ thr_serv_conn = threading.Thread(target=server_handler, args=(conn, addr,), daemon=True)
thr_serv_conn.run()
except KeyboardInterrupt:
- log.info("Server get keyboard interrupt. Initialize server to stop")
- log.info("==================== End of log ====================")
+ log.info("Server get keyboard interrupt, bye!")
diff --git a/server/response.py b/server/response.py
index d04ba84..ec2ecf3 100644
--- a/server/response.py
+++ b/server/response.py
@@ -1,11 +1,37 @@
+#
+# CatNet Python Server
+#
+# Copyright (C) 2023-2024 John Solntsev
+#
+# 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 .
+#
+
import logging
+
log = logging.getLogger(__name__)
STATUS_BY_CODE = {
200: "OK",
+
+ 400: "Bad Request",
404: "Not Found",
+ 405: "Method Not Allowed",
+ 413: "Payload Too Large",
+
500: "Internal Server Error",
+ 505: "HTTP Version Not Supported",
}
diff --git a/server/urlhandler.py b/server/urlhandler.py
index 9317a4f..f3ab9fd 100644
--- a/server/urlhandler.py
+++ b/server/urlhandler.py
@@ -1,3 +1,22 @@
+#
+# CatNet Python Server
+#
+# Copyright (C) 2023-2024 John Solntsev
+#
+# 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 .
+#
+
import logging
import os