diff --git a/License.txt b/License.txt new file mode 100644 --- /dev/null +++ b/License.txt @@ -0,0 +1,674 @@ + 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. + + 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/Network/Protocol/XMPP.hs b/Network/Protocol/XMPP.hs new file mode 100644 --- /dev/null +++ b/Network/Protocol/XMPP.hs @@ -0,0 +1,25 @@ +{- Copyright (C) 2009 John Millikin + + 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 + 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 . +-} + +module Network.Protocol.XMPP ( + module Network.Protocol.XMPP.JID + ,module Network.Protocol.XMPP.Client + ,module Network.Protocol.XMPP.Stanzas + ) where + +import Network.Protocol.XMPP.JID +import Network.Protocol.XMPP.Client +import Network.Protocol.XMPP.Stanzas diff --git a/Network/Protocol/XMPP/Client.hs b/Network/Protocol/XMPP/Client.hs new file mode 100644 --- /dev/null +++ b/Network/Protocol/XMPP/Client.hs @@ -0,0 +1,115 @@ +{- Copyright (C) 2009 John Millikin + + 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 + 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 . +-} + +module Network.Protocol.XMPP.Client ( + ConnectedClient + ,Client + ,clientConnect + ,clientAuthenticate + ,clientBind + ,clientJID + ,clientServerJID + ,putTree + ,getTree + ,putStanza + ) where + +import Network (HostName, PortID, connectTo) +import Text.XML.HXT.Arrow ((>>>)) +import qualified Text.XML.HXT.Arrow as A +import Text.XML.HXT.DOM.TypeDefs (XmlTree) +import qualified Text.XML.HXT.DOM.XmlNode as XN + +import Network.Protocol.XMPP.JID (JID, jidParse, jidResource) +import qualified Network.Protocol.XMPP.SASL as SASL +import qualified Network.Protocol.XMPP.Stream as S +import Network.Protocol.XMPP.Util (mkElement, mkQName) +import Network.Protocol.XMPP.Stanzas (Stanza, stanzaXML) + +data ConnectedClient = ConnectedClient JID S.Stream + +data Client = Client { + clientJID :: JID + ,clientServerJID :: JID + ,clientStream :: S.Stream + } + +type Username = String +type Password = String + +clientConnect :: JID -> HostName -> PortID -> IO ConnectedClient +clientConnect jid host port = do + handle <- connectTo host port + stream <- S.beginStream jid handle + return $ ConnectedClient jid stream + +clientAuthenticate :: ConnectedClient -> JID -> Username -> Password -> IO Client +clientAuthenticate (ConnectedClient serverJID stream) jid username password = do + authed <- SASL.authenticate stream jid serverJID username password + case authed of + SASL.Failure -> error "Authentication failure" + _ -> do + newStream <- S.restartStream stream + return $ Client jid serverJID newStream + +clientBind :: Client -> IO JID +clientBind c = do + -- Bind + let resourceElements = case jidResource . clientJID $ c of + "" -> [] + resource -> + [mkElement ("", "resource") + [] + [XN.mkText resource]] + + putTree c $ mkElement ("", "iq") + [("", "type", "set")] + [mkElement ("", "bind") + [("", "xmlns", "urn:ietf:params:xml:ns:xmpp-bind")] + resourceElements] + + bindResult <- getTree c + let [rawJID] = A.runLA ( + A.deep (A.hasQName (mkQName "urn:ietf:params:xml:ns:xmpp-bind" "jid")) + >>> A.getChildren + >>> A.getText) bindResult + let jid = case jidParse rawJID of + Just x -> x + _ -> error "Couldn't parse server's returned JID" + + -- Session + putTree c $ mkElement ("", "iq") + [("", "type", "set")] + [mkElement ("", "session") + [("", "xmlns", "urn:ietf:params:xml:ns:xmpp-session")] + []] + + getTree c + + putTree c $ mkElement ("", "presence") [] [] + getTree c + return jid + +------------------------------------------------------------------------------- + +putTree :: Client -> XmlTree -> IO () +putTree = S.putTree . clientStream + +getTree :: Client -> IO XmlTree +getTree = S.getTree . clientStream + +putStanza :: (Stanza a) => Client -> a -> IO () +putStanza c = (putTree c) . stanzaXML diff --git a/Network/Protocol/XMPP/JID.hs b/Network/Protocol/XMPP/JID.hs new file mode 100644 --- /dev/null +++ b/Network/Protocol/XMPP/JID.hs @@ -0,0 +1,111 @@ +{- Copyright (C) 2009 John Millikin + + 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 + 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 . +-} + +module Network.Protocol.XMPP.JID ( + JID(..) + ,JIDNode + ,JIDDomain + ,JIDResource + + ,jidNodeStr + ,jidDomainStr + ,jidResourceStr + + ,mkJIDNode + ,mkJIDDomain + ,mkJIDResource + ,mkJID + + ,jidNode + ,jidDomain + ,jidResource + + ,jidParse + ,jidFormat + ) where + +data JID = JID (Maybe JIDNode) JIDDomain (Maybe JIDResource) + deriving (Eq, Show) + +newtype JIDNode = JIDNode String + deriving (Eq, Show) + +newtype JIDDomain = JIDDomain String + deriving (Eq, Show) + +newtype JIDResource = JIDResource String + deriving (Eq, Show) + +jidNodeStr :: JIDNode -> String +jidNodeStr (JIDNode s) = s + +jidDomainStr :: JIDDomain -> String +jidDomainStr (JIDDomain s) = s + +jidResourceStr :: JIDResource -> String +jidResourceStr (JIDResource s) = s + +mkJIDNode :: String -> Maybe JIDNode +mkJIDNode "" = Nothing +mkJIDNode s = Just (JIDNode s) -- TODO: stringprep, validation + +mkJIDDomain :: String -> Maybe JIDDomain +mkJIDDomain "" = Nothing +mkJIDDomain s = Just (JIDDomain s) -- TODO: stringprep, validation + +mkJIDResource :: String -> Maybe JIDResource +mkJIDResource "" = Nothing +mkJIDResource s = Just (JIDResource s) -- TODO: stringprep, validation + +mkJID :: String -> String -> String -> Maybe JID +mkJID nodeStr domainStr resourceStr = let + node = mkJIDNode nodeStr + resource = mkJIDResource resourceStr + in do + domain <- mkJIDDomain domainStr + Just (JID node domain resource) + +jidNode :: JID -> String +jidNode (JID x _ _) = maybe "" jidNodeStr x + +jidDomain :: JID -> String +jidDomain (JID _ x _) = jidDomainStr x + +jidResource :: JID -> String +jidResource (JID _ _ x) = maybe "" jidResourceStr x + +-- TODO: validate input according to RFC 3920, section 3.1 +jidParse :: String -> Maybe JID +jidParse s = let + (nodeStr, postNode) = if '@' `elem` s then split s '@' else ("", s) + (domainStr, resourceStr) = if '/' `elem` postNode then split postNode '/' else (postNode, "") + in mkJID nodeStr domainStr resourceStr + +jidFormat :: JID -> String +jidFormat (JID node (JIDDomain domain) resource) = let + nodeStr = maybe "" (\(JIDNode s) -> s ++ "@") node + resourceStr = maybe "" (\(JIDResource s) -> "/" ++ s) resource + in concat [nodeStr, domain, resourceStr] + +split :: (Eq a) => [a] -> a -> ([a], [a]) +split xs final = let + (before, rawAfter) = span (/= final) xs + after = safeTail rawAfter + in (before, after) + +safeTail :: [a] -> [a] +safeTail [] = [] +safeTail (_:xs) = xs diff --git a/Network/Protocol/XMPP/SASL.hs b/Network/Protocol/XMPP/SASL.hs new file mode 100644 --- /dev/null +++ b/Network/Protocol/XMPP/SASL.hs @@ -0,0 +1,101 @@ +{- Copyright (C) 2009 John Millikin + + 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 + 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 . +-} + +module Network.Protocol.XMPP.SASL ( + Result(..) + ,authenticate + ) where + +import Text.XML.HXT.Arrow ((>>>)) +import qualified Text.XML.HXT.Arrow as A +import qualified Text.XML.HXT.DOM.XmlNode as XN +import qualified Network.Protocol.SASL.GSASL as G + +import Network.Protocol.XMPP.JID (JID, jidFormat) +import Network.Protocol.XMPP.Util (mkElement, mkQName) +import qualified Network.Protocol.XMPP.Stream as S + +type Username = String +type Password = String +type Mechanism = String + +data Result = Success | Failure + deriving (Show, Eq) + +authenticate :: S.Stream -> JID -> JID -> Username -> Password -> IO Result +authenticate stream userJID serverJID username password = do + let mechanisms = (advertisedMechanisms . S.streamFeatures) stream + let authz = jidFormat userJID + let hostname = jidFormat serverJID + + G.withContext $ \ctxt -> do + + suggested <- G.clientSuggestMechanism ctxt mechanisms + mechanism <- case suggested of + Just m -> return m + Nothing -> error "No supported SASL mechanisms advertised" + + G.withSession (G.clientStart ctxt mechanism) $ \s -> do + + G.propertySet s G.GSASL_AUTHZID authz + G.propertySet s G.GSASL_AUTHID username + G.propertySet s G.GSASL_PASSWORD password + G.propertySet s G.GSASL_SERVICE "xmpp" + G.propertySet s G.GSASL_HOSTNAME hostname + + (b64text, rc) <- G.step64 s "" + S.putTree stream $ mkElement ("", "auth") + [ ("", "xmlns", "urn:ietf:params:xml:ns:xmpp-sasl") + ,("", "mechanism", mechanism)] + [XN.mkText b64text] + + case rc of + G.GSASL_OK -> saslFinish stream + G.GSASL_NEEDS_MORE -> saslLoop stream s + +saslLoop :: S.Stream -> G.Session -> IO Result +saslLoop stream session = do + challengeText <- A.runX ( + A.arrIO (\_ -> S.getTree stream) + >>> A.getChildren + >>> A.hasQName (mkQName "urn:ietf:params:xml:ns:xmpp-sasl" "challenge") + >>> A.getChildren >>> A.getText) + + if null challengeText then return Failure + else do + (b64text, rc) <- G.step64 session (concat challengeText) + S.putTree stream $ mkElement ("", "response") + [("", "xmlns", "urn:ietf:params:xml:ns:xmpp-sasl")] + [XN.mkText b64text] + case rc of + G.GSASL_OK -> saslFinish stream + G.GSASL_NEEDS_MORE -> saslLoop stream session + +saslFinish :: S.Stream -> IO Result +saslFinish stream = do + successElem <- A.runX ( + A.arrIO (\_ -> S.getTree stream) + >>> A.getChildren + >>> A.hasQName (mkQName "urn:ietf:params:xml:ns:xmpp-sasl" "success")) + + return $ if null successElem then Failure else Success + +advertisedMechanisms :: [S.StreamFeature] -> [Mechanism] +advertisedMechanisms [] = [] +advertisedMechanisms (f:fs) = case f of + (S.FeatureSASL ms) -> ms + _ -> advertisedMechanisms fs + diff --git a/Network/Protocol/XMPP/Stanzas.hs b/Network/Protocol/XMPP/Stanzas.hs new file mode 100644 --- /dev/null +++ b/Network/Protocol/XMPP/Stanzas.hs @@ -0,0 +1,198 @@ +{- Copyright (C) 2009 John Millikin + + 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 + 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 . +-} + +module Network.Protocol.XMPP.Stanzas ( + Stanza(..) + ,GenericStanza(..) + ,Message(..) + ,Presence(..) + ,toStanza + ,toMessage + ,toPresence + ) where + +import Text.XML.HXT.DOM.Interface (XmlTree) +import Text.XML.HXT.Arrow ((>>>), (&&&)) +import qualified Text.XML.HXT.Arrow as A + +import Network.Protocol.XMPP.JID (JID, jidFormat, jidParse) +import Network.Protocol.XMPP.Util (mkElement, mkQName) +import qualified Text.XML.HXT.DOM.XmlNode as XN + +class Stanza a where + stanzaTo :: a -> Maybe JID + stanzaFrom :: a -> Maybe JID + stanzaID :: a -> String + stanzaType :: a -> String + stanzaLang :: a -> String + stanzaXML :: a -> XmlTree + +data GenericStanza = GenericStanza + { + genericStanzaTo :: Maybe JID + ,genericStanzaFrom :: Maybe JID + ,genericStanzaID :: String + ,genericStanzaType :: String + ,genericStanzaLang :: String + ,genericStanzaXML :: XmlTree + } + +instance Stanza GenericStanza where + stanzaTo = genericStanzaTo + stanzaFrom = genericStanzaFrom + stanzaID = genericStanzaID + stanzaType = genericStanzaType + stanzaLang = genericStanzaLang + stanzaXML = genericStanzaXML + +data Message = Message + { + messageTo :: JID + ,messageFrom :: Maybe JID + ,messageID :: String + ,messageType :: String + ,messageLang :: String + ,messageBody :: String + } + deriving (Show, Eq) + +data Presence = Presence + { + presenceTo :: Maybe JID + ,presenceFrom :: Maybe JID + ,presenceID :: String + ,presenceType :: String + ,presenceLang :: String + ,presenceShow :: String + ,presenceStatus :: String + } + deriving (Show, Eq) + +instance Stanza Message where + stanzaTo = Just . messageTo + stanzaFrom = messageFrom + stanzaID = messageID + stanzaType = messageType + stanzaLang = messageLang + stanzaXML m = let + attrs' = [ + maybeAttr "to" $ (Just . jidFormat =<<) . stanzaTo + ,maybeAttr "from" $ (Just . jidFormat =<<) . stanzaFrom + ,mkAttr "id" $ stanzaID + ,mkAttr "type" $ stanzaType + -- ,mkAttr "lang" $ stanzaLang -- TODO: namespace support? + ] + attrs = concat $ unmap m attrs' + + in mkElement ("jabber:client", "message") + attrs + [mkElement ("jabber:client", "body") [] + [XN.mkText $ messageBody m]] + +instance Stanza Presence where + stanzaTo = presenceTo + stanzaFrom = presenceFrom + stanzaID = presenceID + stanzaType = presenceType + stanzaLang = presenceLang + stanzaXML p = let + attrs' = [ + maybeAttr "to" $ (Just . jidFormat =<<) . stanzaTo + ,maybeAttr "from" $ (Just . jidFormat =<<) . stanzaFrom + ,mkAttr "id" $ stanzaID + ,mkAttr "type" $ stanzaType + -- ,mkAttr "lang" $ stanzaLang -- TODO: namespace support? + ] + attrs = concat $ unmap p attrs' + + showElem = case presenceShow p of + "" -> [] + text -> [mkElement ("jabber:client", "show") [] + [XN.mkText text]] + + statusElem = case presenceStatus p of + "" -> [] + text -> [mkElement ("jabber:client", "status") [] + [XN.mkText text]] + + in mkElement ("jabber:client", "presence") + attrs + (showElem ++ statusElem) + +------------------------------------------------------------------------------- + +toStanza :: XmlTree -> [GenericStanza] +toStanza t = let + getFrom = A.getAttrValue "from" >>> A.arrL (\x -> [jidParse x]) + getTo = A.getAttrValue "to" >>> A.arrL (\x -> [jidParse x]) + getID = A.getAttrValue "id" + getType = A.getAttrValue "type" + getLang = A.getAttrValue "lang" + attrArrow = (getTo &&& getFrom &&& getID &&& getType &&& getLang) + in do + (to, (from, (id', (type', lang)))) <- A.runLA attrArrow t + return $ GenericStanza to from id' type' lang t + +toMessage :: (Stanza a) => a -> [Message] +toMessage s = let + getBody = ( + A.arr stanzaXML + >>> A.hasQName (mkQName "jabber:client" "message") + >>> A.getChildren + >>> A.hasQName (mkQName "jabber:client" "body") + >>> A.getChildren + >>> A.getText + ) + bodyText = concat (A.runLA getBody s) + in case (bodyText, stanzaTo s) of + ("", _) -> [] + (_, Nothing) -> [] + (_, Just to) -> [Message to (stanzaFrom s) + (stanzaID s) (stanzaType s) + (stanzaLang s) bodyText] + +toPresence :: (Stanza a) => a -> [Presence] +toPresence s = let + getChildText qname = (A.getChildren >>> A.hasQName qname >>> + A.getChildren >>> A.getText) + getShow = getChildText $ mkQName "jabber:client" "show" + getStatus = getChildText $ mkQName "jabber:client" "status" + getShowStatus = ( + A.arr stanzaXML + >>> A.hasQName (mkQName "jabber:client" "presence") + >>> A.withDefault getShow [] + &&& A.withDefault getStatus [] + ) + in case A.runLA getShowStatus s of + [(show', status)] -> [Presence (stanzaTo s) (stanzaFrom s) + (stanzaID s) (stanzaType s) + (stanzaLang s) show' status] + _ -> [] + + +------------------------------------------------------------------------------- + +unmap :: a -> [(a -> b)] -> [b] +unmap _ [] = [] +unmap x (f:fs) = (f x):(unmap x fs) + +maybeAttr :: (Stanza a) => String -> (a -> Maybe String) -> a -> [(String, String, String)] +maybeAttr attr f = mkAttr attr (\s -> maybe "" id (f s)) + +mkAttr :: (Stanza a) => String -> (a -> String) -> a -> [(String, String, String)] +mkAttr attr f stanza = case f stanza of + "" -> [] + text -> [("", attr, text)] diff --git a/Network/Protocol/XMPP/Stream.hs b/Network/Protocol/XMPP/Stream.hs new file mode 100644 --- /dev/null +++ b/Network/Protocol/XMPP/Stream.hs @@ -0,0 +1,245 @@ +{- Copyright (C) 2009 John Millikin + + 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 + 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 . +-} + +module Network.Protocol.XMPP.Stream ( + Stream ( + streamLanguage + ,streamVersion + ,streamFeatures + ) + ,StreamFeature ( + FeatureStartTLS + ,FeatureSASL + ,FeatureRegister + ,FeatureBind + ,FeatureSession + ) + ,beginStream + ,restartStream + ,getTree + ,putTree + ) where + +import qualified System.IO as IO +import Data.AssocList (lookupDef) +import Data.Char (toUpper) + +-- XML Parsing +import Text.XML.HXT.Arrow ((>>>)) +import qualified Text.XML.HXT.Arrow as A +import qualified Text.XML.HXT.DOM.Interface as DOM +import qualified Text.XML.HXT.DOM.XmlNode as XN +import qualified Text.XML.LibXML.SAX as SAX + +-- TLS support +import qualified Network.GnuTLS as GnuTLS +import Foreign (allocaBytes) +import Foreign.C (peekCAStringLen) + +import Network.Protocol.XMPP.JID (JID, jidFormat) +import qualified Network.Protocol.XMPP.Util as Util + +maxXMPPVersion :: XMPPVersion +maxXMPPVersion = XMPPVersion 1 0 + +data Stream = Stream + { + streamHandle :: Handle + ,streamJID :: JID + ,streamParser :: SAX.Parser + ,streamLanguage :: XMLLanguage + ,streamVersion :: XMPPVersion + ,streamFeatures :: [StreamFeature] + } + +data StreamFeature = + FeatureStartTLS Bool + | FeatureSASL [String] + | FeatureRegister + | FeatureBind + | FeatureSession + | FeatureUnknown DOM.XmlTree + deriving (Show, Eq) + +newtype XMLLanguage = XMLLanguage String + deriving (Show, Eq) + +data XMPPVersion = XMPPVersion Int Int + deriving (Show, Eq) + +data Handle = + PlainHandle IO.Handle + | SecureHandle IO.Handle (GnuTLS.Session GnuTLS.Client) + +------------------------------------------------------------------------------ + +restartStream :: Stream -> IO Stream +restartStream s = beginStream' (streamJID s) (streamHandle s) + +beginStream :: JID -> IO.Handle -> IO Stream +beginStream jid rawHandle = do + IO.hSetBuffering rawHandle IO.NoBuffering + + plainStream <- beginStream' jid (PlainHandle rawHandle) + + putTree plainStream $ Util.mkElement ("", "starttls") + [("", "xmlns", "urn:ietf:params:xml:ns:xmpp-tls")] + [] + getTree plainStream + + session <- GnuTLS.tlsClient [ + GnuTLS.handle GnuTLS.:= rawHandle + ,GnuTLS.priorities GnuTLS.:= [GnuTLS.CrtX509] + ,GnuTLS.credentials GnuTLS.:= GnuTLS.certificateCredentials + ] + GnuTLS.handshake session + beginStream' jid (SecureHandle rawHandle session) + +beginStream' :: JID -> Handle -> IO Stream +beginStream' jid h = do + -- Since only the opening tag should be written, normal XML + -- serialization cannot be used. Be careful to escape any embedded + -- attributes. + let xmlHeader = + "\n" ++ + "" + + parser <- SAX.mkParser + hPutStr h xmlHeader + initialEvents <- readEventsUntil startOfStream h parser + featureTree <- getTree' h parser + + let startStreamEvent = last initialEvents + let (language, version) = parseStartStream startStreamEvent + let features = parseFeatures featureTree + + return $ Stream h jid parser language version features + + where + streamName = Util.mkQName "http://etherx.jabber.org/streams" "stream" + + startOfStream depth event = case (depth, event) of + (1, (SAX.BeginElement elemName _)) -> + streamName == Util.convertQName elemName + _ -> False + +parseStartStream :: SAX.Event -> (XMLLanguage, XMPPVersion) +parseStartStream e = (XMLLanguage "en", XMPPVersion 1 0) -- TODO + +parseFeatures :: DOM.XmlTree -> [StreamFeature] +parseFeatures t = + A.runLA (A.getChildren + >>> A.hasQName featuresName + >>> A.getChildren + >>> A.arrL (\t' -> [parseFeature t'])) t + where + featuresName = Util.mkQName "http://etherx.jabber.org/streams" "features" + +parseFeature :: DOM.XmlTree -> StreamFeature +parseFeature t = lookupDef FeatureUnknown qname [ + (("urn:ietf:params:xml:ns:xmpp-tls", "starttls"), parseFeatureTLS) + ,(("urn:ietf:params:xml:ns:xmpp-sasl", "mechanisms"), parseFeatureSASL) + ,(("http://jabber.org/features/iq-register", "register"), (\_ -> FeatureRegister)) + ,(("urn:ietf:params:xml:ns:xmpp-bind", "bind"), (\_ -> FeatureBind)) + ,(("urn:ietf:params:xml:ns:xmpp-session", "session"), (\_ -> FeatureSession)) + ] t + where + qname = maybe ("", "") (\n -> (DOM.namespaceUri n, DOM.localPart n)) (XN.getName t) + +parseFeatureTLS :: DOM.XmlTree -> StreamFeature +parseFeatureTLS t = FeatureStartTLS True -- TODO: detect whether or not required + +parseFeatureSASL :: DOM.XmlTree -> StreamFeature +parseFeatureSASL t = let + mechName = Util.mkQName "urn:ietf:params:xml:ns:xmpp-sasl" "mechanism" + mechanisms = A.runLA ( + A.getChildren + >>> A.hasQName mechName + >>> A.getChildren + >>> A.getText) t + + in FeatureSASL $ map (map toUpper) mechanisms + +------------------------------------------------------------------------------- + +getTree :: Stream -> IO DOM.XmlTree +getTree s = getTree' (streamHandle s) (streamParser s) + +getTree' :: Handle -> SAX.Parser -> IO DOM.XmlTree +getTree' h p = do + events <- readEventsUntil finished h p + return $ Util.eventsToTree events + where + finished 0 (SAX.EndElement _) = True + finished _ _ = False + +putTree :: Stream -> DOM.XmlTree -> IO () +putTree s t = do + let root = XN.mkRoot [] [t] + let h = streamHandle s + [text] <- A.runX (A.constA root >>> A.writeDocumentToString [ + (A.a_no_xml_pi, "1") + ]) + hPutStr h text + +------------------------------------------------------------------------------- + +readEventsUntil :: (Int -> SAX.Event -> Bool) -> Handle -> SAX.Parser -> IO [SAX.Event] +readEventsUntil done h parser = readEventsUntil' done 0 [] $ do + char <- hGetChar h + SAX.parse parser [char] False + +readEventsUntil' :: (Int -> SAX.Event -> Bool) -> Int -> [SAX.Event] -> IO [SAX.Event] -> IO [SAX.Event] +readEventsUntil' done depth accum getEvents = do + events <- getEvents + let (done', depth', accum') = readEventsStep done events depth accum + if done' + then return accum' + else readEventsUntil' done depth' accum' getEvents + +readEventsStep :: (Int -> SAX.Event -> Bool) -> [SAX.Event] -> Int -> [SAX.Event] -> (Bool, Int, [SAX.Event]) +readEventsStep _ [] depth accum = (False, depth, accum) +readEventsStep done (e:es) depth accum = let + depth' = depth + case e of + (SAX.BeginElement _ _) -> 1 + (SAX.EndElement _) -> (- 1) + _ -> 0 + accum' = accum ++ [e] + in if done depth' e then (True, depth', accum') + else readEventsStep done es depth' accum' + +------------------------------------------------------------------------------- + +hPutStr :: Handle -> String -> IO () +hPutStr (PlainHandle h) = IO.hPutStr h +hPutStr (SecureHandle _ session) = GnuTLS.tlsSendString session + +hGetChar :: Handle -> IO Char +hGetChar (PlainHandle h) = IO.hGetChar h +hGetChar (SecureHandle h session) = allocaBytes 1 $ \ptr -> do + pending <- GnuTLS.tlsCheckPending session + if pending == 0 + then do + IO.hWaitForInput h (-1) + return () + else return () + + len <- GnuTLS.tlsRecv session ptr 1 + [char] <- peekCAStringLen (ptr, len) + return char diff --git a/Network/Protocol/XMPP/Util.hs b/Network/Protocol/XMPP/Util.hs new file mode 100644 --- /dev/null +++ b/Network/Protocol/XMPP/Util.hs @@ -0,0 +1,97 @@ +{- Copyright (C) 2009 John Millikin + + 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 + 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 . +-} + +module Network.Protocol.XMPP.Util ( + eventsToTree + ,convertAttr + ,convertQName + ,mkElement + ,mkAttr + ,mkQName + ) where + +import qualified Text.XML.HXT.DOM.XmlNode as XN +import qualified Text.XML.HXT.DOM.Interface as DOM +import qualified Text.XML.LibXML.SAX as SAX + +------------------------------------------------------------------------------- +-- For converting incremental XML event lists to HXT trees +------------------------------------------------------------------------------- + +-- This function assumes the input list is valid. No validation is performed. +eventsToTree :: [SAX.Event] -> DOM.XmlTree +eventsToTree es = XN.mkRoot [] (eventsToTrees es) + +eventsToTrees :: [SAX.Event] -> [DOM.XmlTree] +eventsToTrees es = concatMap blockToTrees (splitBlocks es) + +-- Split event list into a sequence of "blocks", which are the events including +-- and between a pair of tags. and are both +-- single blocks. +splitBlocks :: [SAX.Event] -> [[SAX.Event]] +splitBlocks es = ret where (_, _, ret) = foldl splitBlocks' (0, [], []) es + +splitBlocks' :: (Int, [SAX.Event], [[SAX.Event]]) + -> SAX.Event + -> (Int, [SAX.Event], [[SAX.Event]]) +splitBlocks' (depth, accum, allAccum) e = + if depth' == 0 then + (depth', [], allAccum ++ [accum']) + else + (depth', accum', allAccum) + where + accum' = accum ++ [e] + depth' = depth + case e of + (SAX.BeginElement _ _) -> 1 + (SAX.EndElement _) -> (- 1) + _ -> 0 + +blockToTrees :: [SAX.Event] -> [DOM.XmlTree] +blockToTrees [] = [] +blockToTrees (begin:rest) = let end = (last rest) in case (begin, end) of + (SAX.BeginElement qname attrs, SAX.EndElement _) -> + [XN.mkElement (convertQName qname) + (map convertAttr attrs) + (eventsToTrees (init rest))] + (SAX.Characters s, _) -> [XN.mkText s] + (_, SAX.ParseError text) -> error text + _ -> [] + +convertAttr :: SAX.Attribute -> DOM.XmlTree +convertAttr (SAX.Attribute qname value) = XN.NTree + (XN.mkAttrNode (convertQName qname)) + [XN.mkText value] + +convertQName :: SAX.QName -> DOM.QName +convertQName (SAX.QName ns _ local) = mkQName ns local + +------------------------------------------------------------------------------- +-- Utility function for building XML trees +------------------------------------------------------------------------------- + +mkElement :: (String, String) -> [(String, String, String)] -> [DOM.XmlTree] -> DOM.XmlTree +mkElement (ns, localpart) attrs children = let + qname = mkQName ns localpart + attrs' = [mkAttr ans alp text | (ans, alp, text) <- attrs] + in XN.mkElement qname attrs' children + +mkAttr :: String -> String -> String -> DOM.XmlTree +mkAttr ns localpart text = XN.mkAttr (mkQName ns localpart) [XN.mkText text] + +mkQName :: String -> String -> DOM.QName +mkQName ns localpart = case ns of + "" -> DOM.mkName localpart + _ -> DOM.mkNsName localpart ns diff --git a/Setup.hs b/Setup.hs new file mode 100644 --- /dev/null +++ b/Setup.hs @@ -0,0 +1,2 @@ +import Distribution.Simple +main = defaultMain diff --git a/network-protocol-xmpp.cabal b/network-protocol-xmpp.cabal new file mode 100644 --- /dev/null +++ b/network-protocol-xmpp.cabal @@ -0,0 +1,27 @@ +name: network-protocol-xmpp +version: 0.1 +synopsis: Client <-> Server communication over XMPP +license: GPL +license-file: License.txt +author: John Millikin +maintainer: jmillikin@gmail.com +build-type: Simple +cabal-version: >=1.6 +category: Network +stability: experimental +bug-reports: mailto:jmillikin@gmail.com + +source-repository head + type: bzr + location: bzr+ssh://bazaar.launchpad.net/~jmillikin/%2Bjunk/network-protocol-xmpp/ + +library + build-depends: base >=3 && < 5, hxt, libxml-sax >= 0.2, hsgnutls, gsasl, network + exposed-modules: + Network.Protocol.XMPP + Network.Protocol.XMPP.Client + Network.Protocol.XMPP.JID + Network.Protocol.XMPP.SASL + Network.Protocol.XMPP.Stanzas + Network.Protocol.XMPP.Stream + Network.Protocol.XMPP.Util