diff --git a/.ditz-config b/.ditz-config new file mode 100644 --- /dev/null +++ b/.ditz-config @@ -0,0 +1,4 @@ +--- !ditz.rubyforge.org,2008-03-06/config +name: Bardur Arantsson +email: bardur@scientician.net +issue_dir: bugs diff --git a/COPYING.txt b/COPYING.txt new file mode 100644 --- /dev/null +++ b/COPYING.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/Setup.lhs b/Setup.lhs new file mode 100644 --- /dev/null +++ b/Setup.lhs @@ -0,0 +1,4 @@ +#! /usr/bin/env runhaskell + +> import Distribution.Simple +> main = defaultMain diff --git a/bugs/issue-1737caaa8e97ca4b14aa78088b9e10960713c479.yaml b/bugs/issue-1737caaa8e97ca4b14aa78088b9e10960713c479.yaml new file mode 100644 --- /dev/null +++ b/bugs/issue-1737caaa8e97ca4b14aa78088b9e10960713c479.yaml @@ -0,0 +1,18 @@ +--- !ditz.rubyforge.org,2008-03-06/issue +title: Notify client properly when object tree is updated +desc: We should notify the client properly when the object tree is updated. +type: :bugfix +component: hums +release: +reporter: Bardur Arantsson +status: :unstarted +disposition: +creation_time: 2009-07-27 21:02:45.146937 Z +references: [] + +id: 1737caaa8e97ca4b14aa78088b9e10960713c479 +log_events: +- - 2009-07-27 21:02:46.347361 Z + - Bardur Arantsson + - created + - "" diff --git a/bugs/issue-bd2ffe4c9f015cfc2af06801bec1413b7db7b7de.yaml b/bugs/issue-bd2ffe4c9f015cfc2af06801bec1413b7db7b7de.yaml new file mode 100644 --- /dev/null +++ b/bugs/issue-bd2ffe4c9f015cfc2af06801bec1413b7db7b7de.yaml @@ -0,0 +1,22 @@ +--- !ditz.rubyforge.org,2008-03-06/issue +title: Use sendfile library instead of "manually" sending the file +desc: See http://hackage.haskell.org/package/sendfile-0.2 +type: :task +component: hums +release: +reporter: Bardur Arantsson +status: :unstarted +disposition: +creation_time: 2009-06-25 15:46:53.182468 Z +references: [] + +id: bd2ffe4c9f015cfc2af06801bec1413b7db7b7de +log_events: +- - 2009-06-25 15:47:00.846285 Z + - Bardur Arantsson + - created + - "" +- - 2009-07-27 20:59:03.051991 Z + - Bardur Arantsson + - edited reporter + - "" diff --git a/bugs/issue-dda586224d6611f3e18c8de0655548b7dd1f2bb6.yaml b/bugs/issue-dda586224d6611f3e18c8de0655548b7dd1f2bb6.yaml new file mode 100644 --- /dev/null +++ b/bugs/issue-dda586224d6611f3e18c8de0655548b7dd1f2bb6.yaml @@ -0,0 +1,18 @@ +--- !ditz.rubyforge.org,2008-03-06/issue +title: Use tdfa regex library instead of regex-compat +desc: Use tdfa regex library instead of regex-compat +type: :task +component: hums +release: +reporter: Bardur Arantsson +status: :unstarted +disposition: +creation_time: 2009-07-17 08:13:02.301117 Z +references: [] + +id: dda586224d6611f3e18c8de0655548b7dd1f2bb6 +log_events: +- - 2009-07-17 08:13:03.551039 Z + - Bardur Arantsson + - created + - "" diff --git a/bugs/project.yaml b/bugs/project.yaml new file mode 100644 --- /dev/null +++ b/bugs/project.yaml @@ -0,0 +1,8 @@ +--- !ditz.rubyforge.org,2008-03-06/project +name: hums +version: "0.5" +components: +- !ditz.rubyforge.org,2008-03-06/component + name: hums +releases: [] + diff --git a/data/hums.cfg b/data/hums.cfg new file mode 100644 --- /dev/null +++ b/data/hums.cfg @@ -0,0 +1,6 @@ +[network] +listen_ip=192.168.0.10 +listen_port=9000 + +[DEFAULT] +root_directory=/data diff --git a/data/www/images/hums.jpg b/data/www/images/hums.jpg new file mode 100644 Binary files /dev/null and b/data/www/images/hums.jpg differ diff --git a/data/www/services/ConnectionManager/description.xml b/data/www/services/ConnectionManager/description.xml new file mode 100644 --- /dev/null +++ b/data/www/services/ConnectionManager/description.xml @@ -0,0 +1,182 @@ + + + + 1 + 0 + + + + GetProtocolInfo + + + Source + out + SourceProtocolInfo + + + Sink + out + SinkProtocolInfo + + + + + PrepareForConnection + + + RemoteProtocolInfo + in + A_ARG_TYPE_ProtocolInfo + + + PeerConnectionManager + in + A_ARG_TYPE_ConnectionManager + + + PeerConnectionID + in + A_ARG_TYPE_ConnectionID + + + Direction + in + A_ARG_TYPE_Direction + + + ConnectionID + out + A_ARG_TYPE_ConnectionID + + + AVTransportID + out + A_ARG_TYPE_AVTransportID + + + RcsID + out + A_ARG_TYPE_RcsID + + + + + ConnectionComplete + + + ConnectionID + in + A_ARG_TYPE_ConnectionID + + + + + GetCurrentConnectionIDs + + + ConnectionIDs + out + CurrentConnectionIDs + + + + + GetCurrentConnectionInfo + + + ConnectionID + in + A_ARG_TYPE_ConnectionID + + + RcsID + out + A_ARG_TYPE_RcsID + + + AVTransportID + out + A_ARG_TYPE_AVTransportID + + + ProtocolInfo + out + A_ARG_TYPE_ProtocolInfo + + + PeerConnectionManager + out + A_ARG_TYPE_ConnectionManager + + + PeerConnectionID + out + A_ARG_TYPE_ConnectionID + + + Direction + out + A_ARG_TYPE_Direction + + + Status + out + A_ARG_TYPE_ConnectionStatus + + + + + + + SourceProtocolInfo + string + + + SinkProtocolInfo + string + + + CurrentConnectionIDs + string + + + A_ARG_TYPE_ConnectionStatus + string + + OK + ContentFormatMismatch + InsufficientBandwidth + UnreliableChannel + Unknown + + + + A_ARG_TYPE_ConnectionManager + string + + + A_ARG_TYPE_Direction + string + + Input + Output + + + + A_ARG_TYPE_ProtocolInfo + string + + + A_ARG_TYPE_ConnectionID + i4 + + + A_ARG_TYPE_AVTransportID + i4 + + + A_ARG_TYPE_RcsID + i4 + + + diff --git a/data/www/services/ContentDirectory/description.xml b/data/www/services/ContentDirectory/description.xml new file mode 100644 --- /dev/null +++ b/data/www/services/ContentDirectory/description.xml @@ -0,0 +1,401 @@ + + + + 1 + 0 + + + + GetSearchCapabilities + + + SearchCaps + out + SearchCapabilities + + + + + GetSortCapabilities + + + SortCaps + out + SortCapabilities + + + + + GetSystemUpdateID + + + Id + out + SystemUpdateID + + + + + Browse + + + ObjectID + in + A_ARG_TYPE_ObjectID + + + BrowseFlag + in + A_ARG_TYPE_BrowseFlag + + + Filter + in + A_ARG_TYPE_Filter + + + StartingIndex + in + A_ARG_TYPE_Index + + + RequestedCount + in + A_ARG_TYPE_Count + + + SortCriteria + in + A_ARG_TYPE_SortCriteria + + + Result + out + A_ARG_TYPE_Result + + + NumberReturned + out + A_ARG_TYPE_Count + + + TotalMatches + out + A_ARG_TYPE_Count + + + UpdateID + out + A_ARG_TYPE_UpdateID + + + + + Search + + + ContainerID + in + A_ARG_TYPE_ObjectID + + + SearchCriteria + in + A_ARG_TYPE_SearchCriteria + + + Filter + in + A_ARG_TYPE_Filter + + + StartingIndex + in + A_ARG_TYPE_Index + + + RequestedCount + in + A_ARG_TYPE_Count + + + SortCriteria + in + A_ARG_TYPE_SortCriteria + + + Result + out + A_ARG_TYPE_Result + + + NumberReturned + out + A_ARG_TYPE_Count + + + TotalMatches + out + A_ARG_TYPE_Count + + + UpdateID + out + A_ARG_TYPE_UpdateID + + + + + CreateObject + + + ContainerID + in + A_ARG_TYPE_ObjectID + + + Elements + in + A_ARG_TYPE_Result + + + ObjectID + out + A_ARG_TYPE_ObjectID + + + Result + out + A_ARG_TYPE_Result + + + + + DestroyObject + + + ObjectID + in + A_ARG_TYPE_ObjectID + + + + + UpdateObject + + + ObjectID + in + A_ARG_TYPE_ObjectID + + + CurrentTagValue + in + A_ARG_TYPE_TagValueList + + + NewTagValue + in + A_ARG_TYPE_TagValueList + + + + + ImportResource + + + SourceURI + in + A_ARG_TYPE_URI + + + DestinationURI + in + A_ARG_TYPE_URI + + + TransferID + out + A_ARG_TYPE_TransferID + + + + + ExportResource + + + SourceURI + in + A_ARG_TYPE_URI + + + DestinationURI + in + A_ARG_TYPE_URI + + + TransferID + out + A_ARG_TYPE_TransferID + + + + + StopTransferResource + + + TransferID + in + A_ARG_TYPE_TransferID + + + + + GetTransferProgress + + + TransferID + in + A_ARG_TYPE_TransferID + + + TransferStatus + out + A_ARG_TYPE_TransferStatus + + + TransferLength + out + A_ARG_TYPE_TransferLength + + + TransferTotal + out + A_ARG_TYPE_TransferTotal + + + + + DeleteResource + + + ResourceURI + in + A_ARG_TYPE_URI + + + + + CreateReference + + + ContainerID + in + A_ARG_TYPE_ObjectID + + + ObjectID + in + A_ARG_TYPE_ObjectID + + + NewID + out + A_ARG_TYPE_ObjectID + + + + + + + TransferIDs + string + + + A_ARG_TYPE_ObjectID + string + + + A_ARG_TYPE_Result + string + + + A_ARG_TYPE_SearchCriteria + string + + + A_ARG_TYPE_BrowseFlag + string + + BrowseMetadata + BrowseDirectChildren + + + + A_ARG_TYPE_Filter + string + + + A_ARG_TYPE_SortCriteria + string + + + A_ARG_TYPE_Index + ui4 + + + A_ARG_TYPE_Count + ui4 + + + A_ARG_TYPE_UpdateID + ui4 + + + A_ARG_TYPE_TransferID + ui4 + + + A_ARG_TYPE_TransferStatus + string + + COMPLETED + ERROR + IN_PROGRESS + STOPPED + + + + A_ARG_TYPE_TransferLength + string + + + A_ARG_TYPE_TransferTotal + string + + + A_ARG_TYPE_TagValueList + string + + + A_ARG_TYPE_URI + uri + + + SearchCapabilities + string + + + SortCapabilities + string + + + SystemUpdateID + ui4 + + + ContainerUpdateIDs + string + + + diff --git a/hums.cabal b/hums.cabal new file mode 100644 --- /dev/null +++ b/hums.cabal @@ -0,0 +1,56 @@ +Name: hums +Version: 0.2.2 +Synopsis: Haskell UPnP Media Server +Description: A simple UPnP Media Server. +License: GPL +License-file: COPYING.txt +Category: Network +Cabal-version: >=1.6.0.1 +Build-type: Simple +Author: Bardur Arantsson +Maintainer: Bardur Arantsson +Build-Depends: base >= 3 && <4, + haskell98, + network >= 2.2.0.1, + HTTP >= 4000.0.7, + filepath >= 1.1.0.0, + parsec >= 2.1.0.0 && < 3.0, + regex-compat >= 0.91, + unix >= 2.3.0.0, + directory >= 1.0.0.0, + containers >= 0.1.0.1, + uuid >= 1.0.0, + bytestring >= 0.9.0.1, + MissingH >= 1.0.1, + hxt >= 8.3.1, + ConfigFile >= 1.0.5, + mtl >= 1.1.0.2, + network-bytestring >= 0.1.2.1 && <0.2 +data-dir: data +data-files: hums.cfg + www/images/hums.jpg + www/services/ConnectionManager/description.xml + www/services/ContentDirectory/description.xml + +Executable: hums +Extensions: Arrows +ghc-options: -Wall -fno-warn-unused-matches -threaded +hs-source-dirs: src +Main-is: Main.hs +Other-modules: Paths_hums + HttpExtra + StorableExtra + URIExtra + SimpleServiceDiscoveryProtocol + HttpExtra + RegexExtra + Service + Configuration + Soap + DirectoryUtils + HttpServer + MimeType + Action + Object + Didl + SendFile diff --git a/src/Action.hs b/src/Action.hs new file mode 100644 --- /dev/null +++ b/src/Action.hs @@ -0,0 +1,58 @@ +{- + hums - The Haskell UPnP Server + Copyright (C) 2009 Bardur Arantsson + + 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 . +-} + +module Action ( ContentDirectoryAction(..) + , ConnectionManagerAction(..) + , Action(..) + , BrowseAction(..) + , BrowseParameters(..) + , ObjectId + ) where + +type ObjectId = String + +data BrowseParameters = BrowseParameters + { objectId :: ObjectId + , browse_filter :: String + , starting_index :: Int + , requested_count :: Int + , sort_criteria :: String + } + deriving (Show) + +data BrowseAction = BrowseMetadata BrowseParameters + | BrowseDirectChildren BrowseParameters + deriving (Show) + +-- We currently only support the required (CD1.0) actions. +data ContentDirectoryAction = ContentDirectoryBrowse BrowseAction + | ContentDirectoryGetSearchCapabilities + | ContentDirectoryGetSortCapabilities + | ContentDirectoryGetSystemUpdateId + deriving (Show) + +data ConnectionManagerAction = ConnectionManagerGetProtocolInfo + | ConnectionManagerPrepareForConnection + | ConnectionManagerConnectionComplete + | ConnectionManagerGetCurrentConnectionIDs + | ConnectionManagerGetCurrentConnectionInfo + deriving (Show) + +data Action = ContentDirectoryAction_ ContentDirectoryAction + | ConnectionManagerAction_ ConnectionManagerAction + deriving (Show) diff --git a/src/Configuration.hs b/src/Configuration.hs new file mode 100644 --- /dev/null +++ b/src/Configuration.hs @@ -0,0 +1,118 @@ +{- + hums - The Haskell UPnP Server + Copyright (C) 2009 Bardur Arantsson + + 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 . +-} + +module Configuration ( Configuration(..) + , MediaServerConfiguration(..) + , ApplicationInformation + , getServerHeaderValue + , getApplicationInformation + , parseConfiguration + ) where + +import Data.Word +import System.Posix.Unistd (SystemID(..), getSystemID) +import Text.Printf +import Network.URI (URI, parseURI) +import Data.ConfigFile +import Control.Monad.Error +import Data.Either.Utils +import Data.Maybe + +{- + + Configuration + +-} + +data Configuration = + Configuration { local_net_ip :: String + , httpServerBase :: URI + , http_server_port :: Word16 + , enableDeviceIcon :: Bool + , useDlna :: Bool + , dlnaProfileName :: Maybe String -- Only used when useDlna is available. + , rootDirectory :: String + } + deriving (Show) + +{- + + Media Server Configuration + +-} + +data MediaServerConfiguration = MediaServerConfiguration + { uuid :: String + , friendlyName :: String + , manufacturer :: String + , manufacturerUrl :: String + , modelDescription :: Maybe String + , modelName :: String + , modelNumber :: String + , modelUrl :: String + , serialNumber :: Maybe String + , upc :: Maybe String + } + +{- + + Application and operating system information. + +-} + +data ApplicationInformation = ApplicationInformation + { operatingSystemName :: String + , operatingSystemVersion :: String + , applicationName :: String + , applicationVersion :: String + } + + +getApplicationInformation :: IO ApplicationInformation +getApplicationInformation = do + systemId <- getSystemID + return $ ApplicationInformation + { operatingSystemName = systemName systemId + , operatingSystemVersion = release systemId + , applicationName = "hums" + , applicationVersion = "0" + } + +getServerHeaderValue :: ApplicationInformation -> String +getServerHeaderValue (ApplicationInformation on ov an av) = + printf "%s/%s, UPnP/1.0, %s/%s" on ov an av + +parseConfiguration :: ConfigParser -> String -> IO Configuration +parseConfiguration cp0 cfname = do + cfg <- runErrorT $ do + cf <- join $ liftIO $ readfile cp0 cfname + ip <- get cf networkSection "listen_ip" + port <- get cf networkSection "listen_port" + rootDirectory_ <- get cf defaultSection "root_directory" + return $ Configuration + { local_net_ip = ip + , http_server_port = port + , httpServerBase = fromJust $ parseURI $ "http://" ++ ip ++ ":" ++ (show port) + , enableDeviceIcon = True + , useDlna = True + , dlnaProfileName = Nothing + , rootDirectory = rootDirectory_ } + return $ forceEither cfg + where + defaultSection = "DEFAULT" + networkSection = "network" diff --git a/src/Didl.hs b/src/Didl.hs new file mode 100644 --- /dev/null +++ b/src/Didl.hs @@ -0,0 +1,35 @@ +{- + hums - The Haskell UPnP Server + Copyright (C) 2009 Bardur Arantsson + + 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 . +-} + +module Didl ( mkDidl + ) where + +import Text.XML.HXT.Arrow + +-- Create a DIDL-Lite element with namespace declarations. +mkDidl :: ArrowXml a => [a XmlTree XmlTree] -> a XmlTree XmlTree +mkDidl es = + (selem "dummy" -- Avoids the XML declaration when HXT generates the XML. + [ mkelem "DIDL-Lite" [ sattr "xmlns:dc" dcNs + , sattr "xmlns:upnp" upnpNs + , sattr "xmlns" ns ] + es ]) + where + dcNs = "http://purl.org/dc/elements/1.1/" + upnpNs = "urn:schemas-upnp-org:metadata-1-0/upnp/" + ns = "urn:schemas-upnp-org:metadata-1-0/DIDL-Lite/" diff --git a/src/DirectoryUtils.hs b/src/DirectoryUtils.hs new file mode 100644 --- /dev/null +++ b/src/DirectoryUtils.hs @@ -0,0 +1,61 @@ +{- + hums - The Haskell UPnP Server + Copyright (C) 2009 Bardur Arantsson + + 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 . +-} + +module DirectoryUtils ( walkTree + ) where + +import System.IO +import System.Directory +import Control.Monad +import System.FilePath +import Data.List + +-- Performs a pre-order traversal of a directory. +-- It calls f a0 a fp for each file/directory, where +-- a0 is the accumulator as it appeared at the start +-- of iteration of the parent directory, a is the +-- current value of the accumulator and fp is the +-- file name of the file/directory being visited. +walkTree :: a -> (a -> a -> FilePath -> IO a) -> FilePath -> IO a +walkTree s0 f d = do + -- FIXME: Need to detect loops! + -- Get files and directories in directory. + allNames <- getDirectoryContents d + -- Filter out the special directories. + let names = sort $ filter (not . isSpecialDirectory) allNames + -- Produce full names. + let fullNames = map (combine d) names + -- Traverse subdirectories. + s' <- foldM traverse s0 fullNames + -- Return the accumulator. + return s' + + where + traverse s n = do + isDirectory <- doesDirectoryExist n + if isDirectory then do + s' <- f s0 s n + s'' <- walkTree s' f n + return s'' + else do + s' <- f s0 s n + return s' + + isSpecialDirectory ".." = True + isSpecialDirectory "." = True + isSpecialDirectory _ = False diff --git a/src/HttpExtra.hs b/src/HttpExtra.hs new file mode 100644 --- /dev/null +++ b/src/HttpExtra.hs @@ -0,0 +1,64 @@ +{- + hums - The Haskell UPnP Server + Copyright (C) 2009 Bardur Arantsson + + 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 . +-} + +module HttpExtra ( parseRangeHeader + ) where + +import Text.ParserCombinators.Parsec + +parseRange :: GenParser Char a (Maybe Integer, Maybe Integer) +parseRange = do + choice [parseFullRange, + parseEndRange, + parseSingleByteRange] + +parseFullRange :: GenParser Char a (Maybe Integer, Maybe Integer) +parseFullRange = do + i1 <- parseInteger + char '-' + i2 <- optionMaybe parseInteger + return (Just i1, i2) + +parseEndRange :: GenParser Char a (Maybe Integer, Maybe Integer) +parseEndRange = do + char '-' + i1 <- parseInteger + return (Just $ -i1, Nothing) + +parseSingleByteRange :: GenParser Char a (Maybe Integer, Maybe Integer) +parseSingleByteRange = do + i1 <- parseInteger + char '-' + return (Just $ i1, Just $ i1) + +parseInteger :: GenParser Char a Integer +parseInteger = do + ds <- many1 digit + return $ ((read ds) :: Integer) + +parseRanges :: GenParser Char a [(Maybe Integer, Maybe Integer)] +parseRanges = do + string "bytes=" + rs <- parseRange `sepBy` (char ',') + return rs + +parseRangeHeader :: String -> [(Maybe Integer, Maybe Integer)] +parseRangeHeader s = + case parse parseRanges "-" s of + Left err -> [] -- Ignore if we can't parse + Right rs -> rs diff --git a/src/HttpServer.hs b/src/HttpServer.hs new file mode 100644 --- /dev/null +++ b/src/HttpServer.hs @@ -0,0 +1,156 @@ +{- + hums - The Haskell UPnP Server + Copyright (C) 2009 Bardur Arantsson + + 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 . +-} + +module HttpServer ( runHttpServer + , UrlHandler + , sendHeaders + , sendErrorResponse + , sendOkHeaders + , sendBody + , sendXmlResponse + , sendPartialContentHeaders + , HttpError(..) + ) where + +import Network.HTTP.Base +import Network.HTTP.Headers +import Network.HTTP.Stream +import Network.Socket +import Network.StreamSocket() +import System.IO +import Control.Monad +import Control.Concurrent +import Control.Exception +import Data.Word +import Text.Regex +import Text.Printf +import Network.URI +import RegexExtra + +-- Request handlers. +type RequestHandler = + Socket -> Request String -> IO () + +-- URL handlers. +type UrlHandler = + Socket -> Request String -> [String] -> IO () + +runHttpServer' :: RequestHandler -> Word16 -> IO () +runHttpServer' r p = do + let p' = (fromIntegral p) :: PortNumber + let sa = SockAddrInet p' iNADDR_ANY + s <- socket AF_INET Stream 0 + setSocketOption s ReuseAddr 1 + bindSocket s sa + listen s 5 + forever $ acceptConnection s r + +acceptConnection :: Socket -> RequestHandler -> IO () +acceptConnection listenSocket r = do + (s,_) <- accept listenSocket + forkIO $ bracket + (return s) + sClose + (handleHttpConnection r) + return () -- Don't care about the thread ID. + +handleHttpConnection :: RequestHandler -> Socket -> IO () +handleHttpConnection r c = do + result <- receiveHTTP c + case result of + Left _ -> error "Error reading request" + Right req -> do + -- Got the request, now let's invoke the request handler. + r c req + + +sendHeaders :: Socket -> ResponseCode -> String -> [Header] -> IO () +sendHeaders conn rCode rReason rHeaders = do + let rsp = Response { rspCode = rCode + , rspReason = rReason + , rspHeaders = rHeaders + , rspBody = "" } + writeBlock conn $ show rsp -- Writes headers only + CRLF. + return () + +-- Write data to body of request. May be called multiple times after +-- sendHeaders has been called. +sendBody :: Stream s => s -> String -> IO () +sendBody conn body = do + writeBlock conn body + return () + + + +myRequestHandler :: [(Regex, UrlHandler)] -> Socket -> Request String -> IO () +myRequestHandler hs s r = do + case dispatch hs (urlDecode $ uriPath $ rqURI r) of + Nothing -> sendErrorResponse s InternalServerError [] + Just (h,gs) -> h s r gs + + +runHttpServer :: [(Regex, UrlHandler)] -> Word16 -> IO () +runHttpServer hs p = do + runHttpServer' (myRequestHandler hs) p + +{- + + Response generator functions. + +-} + +sendOkHeaders :: Socket -> [Header] -> Int -> IO () +sendOkHeaders conn hs contentLength = + let h1 = Header HdrContentLength $ printf "%d" contentLength in + let h2 = Header HdrConnection "close" in + sendHeaders conn (2,0,0) "OK" (h1 : h2 : hs) + +sendPartialContentHeaders :: Socket -> [Header] -> (Integer,Integer) -> Int -> IO () +sendPartialContentHeaders conn hs (rLow,rHigh) entitySize = + let h1 = Header HdrContentLength $ printf "%d" (rHigh-rLow+1) in + let h2 = Header HdrContentRange $ printf "%d-%d/%d" rLow rHigh entitySize in + let h3 = Header HdrConnection "close" in + sendHeaders conn (2,0,6) "Partial Content" (h1 : h2 : h3 : hs) + + + +sendXmlResponse :: Socket -> [Header] -> String -> IO () +sendXmlResponse conn hs xml = do + sendOkHeaders conn ( (Header HdrContentType "text/xml") : hs ) $ length xml + sendBody conn xml + + + + + +data HttpError = NotFound + | InternalServerError + | NotImplemented + + +sendErrorResponse :: Socket -> HttpError -> [Header] -> IO () +sendErrorResponse conn e hs = do + sendHeaders conn c r + ([ Header HdrContentLength "0" + , Header HdrConnection "close" + ] ++ hs) + where + (c,r) = case e of + NotFound -> ((4,0,4),"NOT FOUND") + InternalServerError -> ((5,0,4), "INTERNAL SERVER ERROR") + NotImplemented -> ((5,0,1), "NOT IMPLEMENTED") diff --git a/src/Main.hs b/src/Main.hs new file mode 100644 --- /dev/null +++ b/src/Main.hs @@ -0,0 +1,311 @@ +{- + hums - The Haskell UPnP Server + Copyright (C) 2009 Bardur Arantsson + + 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 Soap +import Network.Utils +import SimpleServiceDiscoveryProtocol +import Configuration +import Network.HTTP.Base +import Network.HTTP.Headers +import Network.StreamSocket() +import Control.Concurrent +import HttpServer +import Service +import Text.Regex +import Data.List +import Text.Printf +import Action +import System.IO (withFile, hFileSize, IOMode(..), Handle) +import qualified Data.UUID as U +import qualified Data.UUID.V1 as U1 +import MimeType +import Object +import HttpExtra +import Control.Monad.Error +import System.FilePath +import Data.Maybe (fromJust, isJust) +import Data.ConfigFile +import Paths_hums +import Data.IORef +import Network.Socket (Socket) +import SendFile (sendFile') + +defaultMediaServerConfiguration :: String -> MediaServerConfiguration +defaultMediaServerConfiguration uuid_ = + MediaServerConfiguration { uuid = uuid_ + , friendlyName = "hums" + , manufacturer = "Bardur Arantsson" + , manufacturerUrl = "http://www.scientician.net" + , modelDescription = Just "Haskell UPnP Media Server" + , modelName = "HUMS" + , modelNumber = "0" + , modelUrl = "http://www.scientician.net" + , serialNumber = Just "0123456789" + , upc = Nothing + } + +type State = (Configuration, MediaServerConfiguration, ApplicationInformation, [DeviceType], IORef Objects) + + +rootDescriptionHandler :: State -> Socket -> Request String -> [String] -> IO () +rootDescriptionHandler (c,mc,ai,s,_) conn r gs = do + putStrLn "Got request for root description." + xml <- generateDescriptionXml c mc s + putStrLn "Generated root description." + sendXmlResponse conn (getExtraHeaders ai) xml + putStrLn "Send root description." + +hCopyBytes :: Handle -> Socket -> Integer -> Integer -> IO () +hCopyBytes src dst ofs len = do + putStrLn $ printf "Sending %d bytes..." len + sendFile' dst src ofs len + +-- Copy a set of ranges between two handles. +hCopyRanges :: Handle -> Socket -> [(Integer,Integer)] -> IO () +hCopyRanges hnd conn ranges = do + mapM_ copyRange ranges + where + copyRange (lo, hi) = hCopyBytes hnd conn lo $ fromInteger $ hi - lo + 1 + +{- + + RFC2616 (HTTP/1.1) compliance issues: + + - No conditional range support. + - Can only handle single ranges. + - Negative range indexes are not supported. + - Handling of invalid range specifications is non-compliant. + + It does work well enough for the PS3 though :). + +-} + + +hCanonicalizeRanges :: Handle -> [(Maybe Integer, Maybe Integer)] -> IO [(Integer,Integer)] +hCanonicalizeRanges hnd ranges = do + mapM f ranges + where + f (lo,hi) = do + let lo' = case lo of + Just x -> x + Nothing -> 0 + hi' <- case hi of + Just x -> return x + Nothing -> do + l <- hFileSize hnd + return $ l - 1 + return (lo', hi') + +serveStaticFile :: Socket -> [Header] -> String -> FilePath -> IO () +serveStaticFile conn hs mimeType fp = do + putStrLn $ printf "Serving file '%s'..." fp + + -- Do we have a range header? + let ranges = + case lookupHeader HdrRange hs of + Just value -> parseRangeHeader value + Nothing -> [] -- Whole file + + -- Serve the ranges. + withFile fp ReadMode $ \h -> + do + rs <- hCanonicalizeRanges h ranges + serveFile h rs + + where + ohs = [ Header HdrContentType $ mimeType ] + serveFile h [] = do + -- No range given (or all ranges were invalid), so we handle regularly. + len <- hFileSize h + sendOkHeaders conn ohs $ fromInteger len + hCopyBytes h conn 0 len + serveFile h [r] = do + fs <- fmap fromInteger $ hFileSize h + -- Send headers + sendPartialContentHeaders conn ohs r fs + -- Copy data from ranges into body. + hCopyRanges h conn [r] + serveFile h _ = + -- This requires multipart/byteranges, but we don't support that + -- as of yet. + error "Cannot handle multiple ranges in a single request." + + +-- Regular expressions for avoiding relative URLs. These +-- are overly conservative, but what the heck... +dotDotSlash :: Regex +dotDotSlash = mkRegex "\\.\\./" +slashDotDot :: Regex +slashDotDot = mkRegex "/\\.\\." + +-- Handle static files. +staticHandler :: String -> Socket -> Request String -> [String] -> IO () +staticHandler root conn req gs = do + putStrLn $ "Got request for static content: " ++ show gs + case gs of + [p] -> if (isJust $ matchRegex dotDotSlash p) || -- Reject relative URLs. + (isJust $ matchRegex slashDotDot p) then + sendErrorResponse conn InternalServerError [] + else + serveStaticFile conn (getHeaders req) mimeType fp + where + fp = root p + mimeType = guessMimeType fp + _ -> sendErrorResponse conn InternalServerError [] + + + +-- TODO: Should we generate a DATE header? +getExtraHeaders :: ApplicationInformation -> [ Header ] +getExtraHeaders ai = [ Header (HdrCustom "contentFeatures.dlna.org") "" + , Header (HdrCustom "EXT") "" + , Header (HdrCustom "Server") (getServerHeaderValue ai) + , Header (HdrCustom "Accept-Ranges") "bytes" + ] + +contentHandler :: State -> Socket -> Request String -> [String] -> IO () +contentHandler (c,mc,ai,s,objects_) conn r gs = do + objects <- readIORef objects_ -- Current snapshot of object tree. + case gs of + [oid] -> do + putStrLn $ printf "Got request for CONTENT for objectId=%s" oid + -- Serve the file which the object maps to. + -- FIXME: Return 404 error code if file has disappeared. + case findByObjectId oid objects of + Just o -> serveStaticFile conn (getHeaders r) mt fp + where + od = getObjectData o + fp = objectFileName od + mt = objectMimeType od + Nothing -> sendErrorResponse conn NotFound [] + + _ -> sendErrorResponse conn InternalServerError [] + + + +serviceControlHandler :: State -> Socket -> Request String -> [String] -> IO () +serviceControlHandler (c,mc,ai,s,objects_) conn r gs = do + objects <- readIORef objects_ -- Current snapshot of object tree. + case gs of + [sn] -> do + putStrLn $ printf "Got request for CONTROL for service '%s'" $ sn + case stringToDeviceType sn of + Just dt -> do + -- Parse the SOAP request + let requestXml = rqBody r + action <- parseControlSoapXml requestXml + -- Deal with the action + case action of + Just a -> do + x <- case a of + ContentDirectoryAction_ cda -> handleCDA dt cda objects + ConnectionManagerAction_ cma -> handleCMA cma + putStrLn $ printf "Response:\n\n%s\n\n" x + sendXmlResponse conn (getExtraHeaders ai) x + Nothing -> + sendErrorResponse conn NotImplemented [] + Nothing -> do + putStrLn $ printf "Asked about unknown service '%s'" sn + sendErrorResponse conn NotImplemented [] + _ -> do + -- Mapped to our URL space, but not parseable? + sendErrorResponse conn NotFound [] + where + handleCDA st a objects = + generateActionResponseXml c st objects a >>= return + handleCMA _ = do + -- TODO: This should really be implemented as it is required by + -- the specification. However, the PS3 doesn't seem to use it at + -- all so I don't have any way to test an implementation anyway. + error "Not implemented" + + + +fallbackHandler :: Socket -> Request String -> [String] -> IO () +fallbackHandler conn r gs = do + putStrLn $ "Fallback handler got request:" + putStrLn $ show r + sendErrorResponse conn InternalServerError [] + + +periodicUpdate :: IORef a -> (IO a) -> IO () +periodicUpdate a doUpdate = do + forever $ do + threadDelay 120000000 -- Every 120 seconds should be more than enough. + x <- doUpdate + writeIORef a x -- Atomic replace + + +scanOnce :: String -> IO Objects +scanOnce directory = do + putStrLn $ printf "Scanning directory '%s'" directory + objects <- scanDirectory directory + putStrLn $ printf "Scanning completed" + return objects + + + +main :: IO () +main = niceSocketsDo $ do + -- Get the data directory. + dataDirectory <- getDataFileName "." + + -- Parse configuration. + c <- parseConfiguration emptyCP $ dataDirectory "hums.cfg" + print c + + -- Scan objects once at the start. + let scanOnce' = scanOnce $ rootDirectory c + defaultObjects_ <- scanOnce' + defaultObjects <- newIORef defaultObjects_ + + -- Get the application information. + appInfo <- getApplicationInformation + + -- Build configurations, etc. + u <- fmap (U.toString . fromJust) U1.nextUUID + putStrLn $ "My UUID is: " ++ u + let mc = defaultMediaServerConfiguration u + let services = [ ContentDirectoryDevice, ConnectionManagerDevice ] + let st = (c,mc,appInfo,services, defaultObjects) + + let dispatchTable = + [ (mkRegex "^/description\\.xml$", rootDescriptionHandler st) + , (mkRegex "^/static/(.*)$", staticHandler $ dataDirectory "www") + , (mkRegex "^/dynamic/services/([^/]+)/control/?$", serviceControlHandler st) + , (mkRegex "^/content/([0-9a-f,]+)$", contentHandler st) + , (mkRegex "(.*)", fallbackHandler) + ] + + -- Start serving. + putStrLn "Establishing HTTP server..." + forkIO $ runHttpServer dispatchTable $ http_server_port c + putStrLn "Done." + + -- Start broadcasting alive messages. + putStrLn "Establishing notification broadcaster..." + forkIO $ sendNotifyForever appInfo c mc + + -- Start scanning files/directories in the background. + putStrLn "Establishing background scanner..." + forkIO $ periodicUpdate defaultObjects scanOnce' + + -- Wait for all threads to terminate. + interact (\p -> p) + + return () diff --git a/src/MimeType.hs b/src/MimeType.hs new file mode 100644 --- /dev/null +++ b/src/MimeType.hs @@ -0,0 +1,37 @@ +{- + hums - The Haskell UPnP Server + Copyright (C) 2009 Bardur Arantsson + + 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 . +-} + +module MimeType ( guessMimeType + ) where + +import System.FilePath + +-- A primitive MIME type guesser. We use a custom one instead of the +-- relatively standard /etc/mime.types since UPnP media server clients +-- can be finicky about which MIME types they accept. +guessMimeType :: FilePath -> String +guessMimeType fp = + mimeType $ takeExtension fp + where + mimeType ".xml" = "text/xml" + mimeType ".avi" = "video/divx" -- PlayStation 3 oddity ('x-msvideo' is standard) + mimeType ".mp3" = "audio/mpeg" + mimeType ".mpg" = "video/mpeg" + mimeType ".jpg" = "image/jpeg" + mimeType ".mp4" = "video/mp4" + mimeType _ = "application/octet-stream" -- Reasonable default diff --git a/src/Object.hs b/src/Object.hs new file mode 100644 --- /dev/null +++ b/src/Object.hs @@ -0,0 +1,198 @@ +{- + hums - The Haskell UPnP Server + Copyright (C) 2009 Bardur Arantsson + + 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 . +-} + +module Object ( Objects + , Object + , ObjectType(..) + , ObjectData(..) + , getObjectData + , getObjectElementName + , getObjectClassName + , getChildren + , getNumberOfChildren + , scanDirectory + , findByObjectId + , findExistingByObjectId + ) where + +import Action +import Data.Map (Map) +import qualified Data.Map as Map +import DirectoryUtils +import Data.Maybe +import System.IO +import System.FilePath +import Data.List +import MimeType +import Data.Int +import System.Posix +import Text.Printf +import StorableExtra +import Text.Regex +import RegexExtra + +-- Root object id is defined by CD/§2.7.4.2. +rootObjectId :: ObjectId +rootObjectId = "0" + +-- Root object parent id is defined by CD/§2.4.2, table 2. +rootObjectParentId :: ObjectId +rootObjectParentId = "-1" + +-- Dispatch table for selecting item type from MIME type. +objectTypeTable :: [(Regex, ObjectType)] +objectTypeTable = [ (mkRegex "^video/.*", ItemVideoMovie) + , (mkRegex "^audio/.*", ItemMusicTrack) + , (mkRegex "^inode/directory$", ContainerStorageFolder) + ] + +-- An Objects is an abstract data type containing a set of +-- objects. +data Objects = Objects + { mapIdToObject :: Map ObjectId Object + , mapParentToChildren :: Map ObjectId [ObjectId] + } + deriving (Show) + +-- Object data which applies for all objects. +data ObjectData = MkObjectData + { objectParentId :: ObjectId -- Object ID of parent object. + , objectTitle :: String -- Title of the object. + , objectFileName :: FilePath -- Physical file. + , objectFileSize :: Integer -- The size of the physical file. + , objectSystemUpdateId :: Int64 -- CD/§2.7.4.2 + , objectMimeType :: String -- MIME type of the file. + } + deriving (Show) + + +data ObjectType = Container + | ContainerStorageFolder + | ItemMusicTrack + | ItemVideoMovie + deriving (Show) + +-- We can serve different types of objects. +type Object = (ObjectType, ObjectData) + +-- Get the upnp class name of the object. +getObjectClassName :: Object -> String +getObjectClassName (Container,_) = "object.container" +getObjectClassName (ContainerStorageFolder,_) = "object.container.storageFolder" +getObjectClassName (ItemMusicTrack,_) = "object.item.audioItem.musicTrack" +getObjectClassName (ItemVideoMovie,_) = "object.item.videoItem.movie" + +-- Get the element name for the object. +getObjectElementName :: Object -> String +getObjectElementName (Container,_) = "container" +getObjectElementName (ContainerStorageFolder,_) = "container" +getObjectElementName (ItemMusicTrack,_) = "item" +getObjectElementName (ItemVideoMovie,_) = "item" + +-- Get the object data field of the object. +getObjectData :: Object -> ObjectData +getObjectData = snd + +-- Get the children object of a given object. +getChildren :: Objects -> ObjectId -> [(ObjectId,Object)] +getChildren os pid = + case Map.lookup pid $ mapParentToChildren os of + Just cs -> map (\oid -> (oid, findExistingByObjectId oid os)) cs + Nothing -> [] + +-- Get the number of children of a given object. +getNumberOfChildren :: Objects -> ObjectId -> Int +getNumberOfChildren os pid = + length $ Object.getChildren os pid -- TODO: Keep track of length instead? + +-- Find object by object ID. +findByObjectId :: ObjectId -> Objects -> Maybe Object +findByObjectId oid os = Map.lookup oid $ mapIdToObject os + +-- Find object which is known to exist by object ID. +findExistingByObjectId :: ObjectId -> Objects -> Object +findExistingByObjectId oid os = + case findByObjectId oid os of + Just x -> x + Nothing -> error $ printf "Couldn't find object '%s'" oid + +-- Accumulator function for building the basic list of files/directories. +scanFile :: [(ObjectId, Object)] -> [(ObjectId, Object)] -> FilePath -> IO [(ObjectId, Object)] +scanFile parentObjects objects fp = do + -- Find parent's object Id. + let kp = case parentObjects of + [] -> rootObjectId + ((oid,_):_) -> oid + -- Compute object id for the directory entry. + -- FIXME: Should handle 'file gone missing' -- simply don't prepend an + -- object in that case. + st <- getFileStatus $ fp + deviceId <- toHexString $ deviceID st + fileId <- toHexString $ fileID st + let oid = printf "%s,%s" deviceId fileId + -- Compute the update ID. + let sysUpdateId = round' $ toRational $ modificationTime st + -- Compute file size. + let sz = (fromIntegral . System.Posix.fileSize) st + -- Compute misc. attributes. + let _title = dropExtension $ takeFileName $ fp + -- Start by guessing mime type. + let mimeType = case isDirectory st of + True -> "inode/directory" -- Directories are special. + False -> guessMimeType fp + -- Construct object data. + let objectData = MkObjectData kp _title fp sz sysUpdateId mimeType + -- Add the directory entry to the current accumulator. + return $ case dispatch objectTypeTable mimeType of + Just (objectType,_) -> (oid, (objectType,objectData)) : objects + Nothing -> objects + where + round' :: Rational -> Int64 -- Dummy to avoid warning + round' = round + + +-- Function for building the Object tree structure. +scanDirectory :: FilePath -> IO Objects +scanDirectory d = do + objects <- walkTree [] scanFile d + -- Add the special top-level root item. + let o' = (rootObject : objects) + -- Construct a map from parents to children. + let mapParentToChildrenX = foldl p2c Map.empty o' + + return $ Objects + { mapIdToObject = Map.fromList o' + , mapParentToChildren = mapParentToChildrenX + } + where + -- The root object is fixed. + rootObject = + (rootObjectId, + (Container, (MkObjectData { objectParentId = rootObjectParentId + , objectTitle = "root" + , objectFileName = "root" + , objectFileSize = 0 + , objectSystemUpdateId = 0 + , objectMimeType = "inode/directory" }))) + + p2c acc (oid, o) = + Map.alter (\x -> case x of + Nothing -> Just [oid] + Just cs -> Just (oid:cs)) pid acc + where + pid = objectParentId $ getObjectData o diff --git a/src/RegexExtra.hs b/src/RegexExtra.hs new file mode 100644 --- /dev/null +++ b/src/RegexExtra.hs @@ -0,0 +1,39 @@ +{- + hums - The Haskell UPnP Server + Copyright (C) 2009 Bardur Arantsson + + 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 . +-} + +module RegexExtra ( dispatch ) + where + +import Text.Regex + +dispatch :: [(Regex, a)] -> String -> Maybe (a, [String]) +dispatch t s = + case findFirst f t of + Nothing -> Nothing + Just (v, gs) -> Just $ (v, gs) + where + f (r,v) = case matchRegex r s of + Just gs -> Just (v,gs) + Nothing -> Nothing + +findFirst :: (a -> Maybe b) -> [a] -> Maybe b +findFirst _ [] = Nothing +findFirst f (x:xs) = + case f x of + Just v -> Just v + Nothing -> findFirst f xs diff --git a/src/SendFile.hs b/src/SendFile.hs new file mode 100644 --- /dev/null +++ b/src/SendFile.hs @@ -0,0 +1,39 @@ +{- + hums - The Haskell UPnP Server + Copyright (C) 2009 Bardur Arantsson + + 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 . +-} + +-- +-- This exists because Network.Socket.SendFile isn't usable on Linux as of 0.4. +-- +module SendFile ( sendFile' + ) where + +import Data.ByteString as BS (hGet, length) +import Network.Socket.ByteString (sendAll) +import Network.Socket (Socket) +import System.IO (Handle, hSeek, SeekMode(..)) + +sendFile' :: Socket -> Handle -> Integer -> Integer -> IO () +sendFile' outs inp off count = do + hSeek inp AbsoluteSeek off + rsend count + where rsend 0 = return () + rsend reqBytes = do + let bytes = min 32768 reqBytes :: Integer + buf <- hGet inp (fromIntegral bytes) + sendAll outs buf + rsend (reqBytes - (fromIntegral $ BS.length buf)) diff --git a/src/Service.hs b/src/Service.hs new file mode 100644 --- /dev/null +++ b/src/Service.hs @@ -0,0 +1,378 @@ +{- + hums - The Haskell UPnP Server + Copyright (C) 2009 Bardur Arantsson + + 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 . +-} + +module Service ( generateDescriptionXml + , generateActionResponseXml + , DeviceType(..) + , stringToDeviceType + ) where + +import Text.XML.HXT.Arrow +import Text.Printf +import Configuration +import Action +import Data.AssocList (addEntries) +import Data.Maybe (mapMaybe) +import Object +import Data.List.Utils +import Data.Bits +import Data.Int +import MimeType +import URIExtra + +defaultEncodingAttributes :: Attributes +defaultEncodingAttributes = [ (a_output_encoding, utf8) ] + +myQuote :: String -> String +myQuote = -- TODO: There *must* be a better way to achieve our quoting needs. + concat . map f + where + f '<' = "<" + f '>' = ">" + f c = [c] + + + +sanitizeXmlChars :: String -> String +sanitizeXmlChars = + map f + where + f '<' = '_' + f '>' = '_' + f '&' = '_' + f c = c + + + +optSelem :: ArrowXml a => String -> Maybe String -> a n XmlTree +optSelem n Nothing = cmt $ printf " %s omitted " n +optSelem n (Just x) = selem n [txt $ x] + +data DeviceType = MediaServer + | ContentDirectoryDevice + | ConnectionManagerDevice + +deviceTypeToString :: DeviceType -> String +deviceTypeToString ContentDirectoryDevice = "ContentDirectory" +deviceTypeToString ConnectionManagerDevice = "ConnectionManager" +deviceTypeToString MediaServer = "MediaServer" + +stringToDeviceType :: String -> Maybe DeviceType +stringToDeviceType "ContentDirectory" = Just ContentDirectoryDevice +stringToDeviceType "ConnectionManager" = Just ConnectionManagerDevice +stringToDeviceType _ = Nothing + +serviceNs :: ArrowXml a => String -> DeviceType -> a XmlTree XmlTree +serviceNs prefix st = + sattr an av + where + an = printf "xmlns:%s" prefix + av = printf "urn:schemas-upnp-org:service:%s:1" $ deviceTypeToString st + +serviceNs' :: DeviceType -> String +serviceNs' st = printf "urn:schemas-upnp-org:service:%s:1" $ deviceTypeToString st + +-- Generate the icon list. +generateIconList :: ArrowXml a => Bool -> a XmlTree XmlTree +generateIconList False = cmt " omitted device icon list " +generateIconList True = + selem "iconList" + [ selem "icon" + [ selem "mimetype" [ txt $ guessMimeType imageUrl ] + , selem "width" [ txt "240" ] + , selem "height" [ txt "240" ] + , selem "url" [ txt $ imageUrl ] + ] + ] + where + imageUrl = "/static/images/hums.jpg" + +generateServiceList :: ArrowXml a => [DeviceType] -> a XmlTree XmlTree +generateServiceList services = + selem "serviceList" $ map generateService services + where + generateService service = + (selem "service" + [ selem "serviceType" [txt $ serviceNs' service] + , selem "serviceId" [txt $ printf "urn:upnp-org:serviceId:%s" dt] + , selem "SCPDURL" [txt $ printf "/static/services/%s/description.xml" dt] + , selem "controlURL" [txt $ printf "/dynamic/services/%s/control/" dt] + , selem "eventSubURL" [txt $ printf "/dynamic/services/%s/event/" dt] + ]) + where dt = deviceTypeToString service + +generateDescription :: ArrowXml a => Configuration -> MediaServerConfiguration -> [DeviceType] -> a XmlTree XmlTree +generateDescription c mc services = + (root [] + [ mkelem "root" [sattr "xmlns" "urn:schemas-upnp-org:device-1-0"] + [ selem "specVersion" + [ selem "major" [ txt "1" ] + , selem "minor" [ txt "0" ] + ] + , selem "URLBase" [ txt $ show $ httpServerBase c ] + , selem "device" + [ selem "UDN" [ txt $ printf "uuid:%s" $ uuid mc ] + , selem "friendlyName" [ txt $ friendlyName mc ] + , selem "manufacturer" [ txt $ manufacturer mc ] + , selem "manufacturerURL" [ txt $ manufacturerUrl mc ] + , optSelem "modelDescription" $ modelDescription mc + , selem "modelName" [ txt $ modelName mc ] + , selem "modelNumber" [ txt $ modelNumber mc ] + , selem "modelURL" [ txt $ modelUrl mc ] + , optSelem "serialNumber" $ serialNumber mc + , selem "deviceType" [ txt $ printf "urn:schemas-upnp-org:device:%s:1" $ deviceType ] + , optSelem "UPC" $ upc mc +-- , optSelemNs "dlna:X_DNLADOC" [sattr "xmlns" "urn:schemas-dlna-org:device-1-0"] $ dlna + , generateIconList $ enableDeviceIcon c + , generateServiceList services + , selem "presentationURL" [ txt presentationUrl ] + ] + ] + ]) + where + deviceType = deviceTypeToString MediaServer +-- dlna = if useDlna mc then (Just "DMS-1.00") else Nothing + presentationUrl = "index.html" + +-- Transform an XmlTree to a string. +generateXml :: Attributes -> IOSLA (XIOState ()) XmlTree XmlTree -> IO String +generateXml as a = do + xml <- runX $ (a >>> writeDocumentToString (addEntries as defaultEncodingAttributes)) + return $ concat xml + +generateDescriptionXml :: Configuration -> MediaServerConfiguration -> [DeviceType] -> IO String +generateDescriptionXml c mc services = do + xml <- generateXml [] $ generateDescription c mc services + return xml + + +generateResponseXml :: [IOSLA (XIOState ()) XmlTree XmlTree] -> IO String +generateResponseXml body = do + xml <- generateXml [(a_output_xml,v_0)] $ generateSoapEnvelope body + return xml + +generateBrowseResponseXml :: Configuration -> DeviceType -> Objects -> BrowseAction -> IO String + +generateBrowseResponseXml cfg st os (BrowseMetadata bps) = do + didlXml <- fmap myQuote $ generateXml [] didl + let body = [ mkelem "u:BrowseResponse" [ serviceNs "u" st ] + [ selem "Result" [ txt $ didlXml ] + , selem "NumberReturned" [ txt $ "1" ] -- CD/§2.7.4.2 + , selem "TotalMatches" [ txt $ "1" ] -- CD/§2.7.4.2 + , selem "UpdateID" [ txt $ printf "%d" $ objectSystemUpdateId od ] + ] + ] + generateResponseXml body + where + didl = mkDidl [generateObjectElement cfg os (oid,o)] + oid = objectId bps + o = findExistingByObjectId oid os -- TODO: Might handle non-existing objects better. + od = getObjectData o + + +generateBrowseResponseXml cfg st os (BrowseDirectChildren bps) = do + didlXml <- fmap myQuote $ generateXml [] didl + let body = [ mkelem "u:BrowseResponse" [ serviceNs "u" st ] + [ selem "Result" [ txt $ didlXml ] + , selem "NumberReturned" [ txt $ numberReturned ] + , selem "TotalMatches" [ txt $ totalMatches ] + , selem "UpdateID" [ txt $ printf "%d" $ objectSystemUpdateId od ] + ] + ] + generateResponseXml body + where + o = findExistingByObjectId oid os -- TODO: Might handle non-existing objects better. + od = getObjectData o + oid = objectId bps + startIndex = starting_index bps + requestedCount = requested_count bps + totalMatches = show $ getNumberOfChildren os oid -- CD/§2.7.4.2 + numberReturned = show $ length chosenChildren + slicer = if requestedCount<=0 then id else slice startIndex requestedCount -- CD/§2.7.4.2 + chosenChildren = slicer $ Object.getChildren os oid + didl = mkDidl $ map (generateObjectElement cfg os) $ chosenChildren + + + +generateActionResponseXml :: Configuration -> DeviceType -> Objects -> ContentDirectoryAction -> IO String + +generateActionResponseXml _ st _ ContentDirectoryGetSystemUpdateId = do + (generateXml [] $ generateSoapEnvelope body) >>= return + where + body = [ mkelem "u:GetSystemUpdateIDResponse" [ serviceNs "u" st ] + [ selem "Id" [ txt "1" ] ] ] + +generateActionResponseXml cfg st os (ContentDirectoryBrowse ba) = do + generateBrowseResponseXml cfg st os ba >>= return + +generateActionResponseXml _ st _ ContentDirectoryGetSearchCapabilities = do + (generateXml [] $ generateSoapEnvelope body) >>= return + where + body = [ mkelem "u:GetSearchCapabilitiesResponse" [ serviceNs "u" st ] + [ selem "SearchCaps" [ txt "" ] ] -- No search capabilities (CD/§2.5.18) + ] + +generateActionResponseXml _ st _ ContentDirectoryGetSortCapabilities = + (generateXml [] $ generateSoapEnvelope body) >>= return + where + body = [ mkelem "u:GetSortCapabilitiesResponse" [ serviceNs "u" st ] + [ selem "SortCaps" [ txt "" ] ] -- No sorting capabilities (CD/§2.5.19) + ] + +generateSoapEnvelope :: ArrowXml a => [a XmlTree XmlTree] -> a XmlTree XmlTree +generateSoapEnvelope b = + (root [] + [ mkelem "s:Envelope" [ soapNs, soapEncodingStyle ] + [ selem "s:Body" b ] + ]) + where + soapNs = sattr "xmlns:s" $ printf "%s/envelope/" urlPrefix + soapEncodingStyle = sattr "s:encodingStyle" $ printf "%s/encoding/" urlPrefix + urlPrefix = "http://schemas.xmlsoap.org/soap" + + +generateObjectElement :: ArrowXml a => Configuration -> Objects -> (ObjectId, Object) -> a XmlTree XmlTree +generateObjectElement cfg objects (oid, o) = + (mkelem en (as ++ eas) + ([ selem "dc:title" [ txt $ sanitizeXmlChars $ objectTitle od ] + , selem "upnp:class" [ txt $ getObjectClassName o ] + ] ++ ee) + ) + where + od = getObjectData o + en = getObjectElementName o + ee = generateExtraElements cfg (oid,o) + as = [ sattr "id" $ oid + , sattr "parentID" $ objectParentId od + ] + eas = generateExtraAttributes objects (oid,o) + + +-- Generate any attributes required for any given object. +-- (Apart from the attributes of the 'object' class itself.) +generateExtraAttributes :: ArrowXml a => Objects -> (ObjectId, Object) -> [a XmlTree XmlTree] +generateExtraAttributes objects (oid, (Container,_)) = genContainerAttributes objects oid +generateExtraAttributes objects (oid, (ContainerStorageFolder,_)) = genContainerAttributes objects oid +generateExtraAttributes _ (_, (ItemMusicTrack,_)) = genItemAttributes +generateExtraAttributes _ (_, (ItemVideoMovie,_)) = genItemAttributes + +-- Generate content URL +generateContentUrl :: ArrowXml a => Configuration -> ObjectId -> a XmlTree XmlTree +generateContentUrl cfg oid = + txt $ show $ mkURI ["content", oid] $ httpServerBase cfg + +-- Generate any extra elements for any given object. +generateExtraElements :: ArrowXml a => Configuration -> (ObjectId, Object) -> [a XmlTree XmlTree] +generateExtraElements _ (oid, (Container,_)) = [] +generateExtraElements _ (oid, (ContainerStorageFolder,_)) = [] +generateExtraElements cfg (oid, (ItemMusicTrack,d)) = + [ mkelem "res" [ sattr "protocolInfo" protocolInfo + , sattr "size" $ printf "%d" $ objectFileSize d ] -- TODO: should be disabled by Transcoding flag! + [ generateContentUrl cfg oid ] + ] + where + mimeType = objectMimeType d + protocolInfo = generateProtocolInfo cfg False mimeType Nothing -- TODO: profileId + +generateExtraElements cfg (oid, (ItemVideoMovie,d)) = + [ mkelem "res" [ sattr "protocolInfo" protocolInfo + , sattr "size" $ printf "%d" $ objectFileSize d ] -- TODO: should be disabled by Transcoding flag! + [ generateContentUrl cfg oid ] + ] + where + mimeType = objectMimeType d + protocolInfo = generateProtocolInfo cfg False mimeType Nothing -- TODO: profileId + +mapMaybe1 :: (a -> b) -> Maybe a -> Maybe b +mapMaybe1 f Nothing = Nothing +mapMaybe1 f (Just a) = Just $ f a + +generateProtocolInfo :: Configuration -> Bool -> String -> Maybe String -> String +generateProtocolInfo cfg transcode mimeType profileId = + protocolPrefix ++ protocolSuffix + where + playSpeed = 1 :: Int -- DLNA play speed: Normal + conversionFlags = -- DLNA conversion flags + case transcode of + False -> 0 :: Int + True -> 1 :: Int + operationsParameter = -- DLNA operations parameter + case transcode of + False -> 1 :: Int -- Support byte ranges, but not time seek ranges. + True -> 0 :: Int -- Don't support bytes ranges, nor time seek ranges. + flags = + _DLNA_ORG_FLAG_STREAMING_TRANSFER_MODE .|. + _DLNA_ORG_FLAG_BACKGROUND_TRANSFER_MODE .|. + _DLNA_ORG_FLAG_CONNECTION_STALL .|. + _DLNA_ORG_FLAG_DLNA_V15 .|. + if transcode then 0 else _DLNA_ORG_FLAG_BYTE_BASED_SEEK + fields = + [ ("DLNA.ORG_PS", Just $ printf "%d" playSpeed) + , ("DLNA.ORG_CI", Just $ printf "%d" conversionFlags) + , ("DLNA.ORG_OP", Just $ printf "%02x" operationsParameter) + , ("DLNA.ORG_PN", dlnaProfileName cfg) + , ("DLNA.ORG_FLAGS" , Just $ printf "%08x%024x" flags (0 :: Int32) ) ] + protocolPrefix = "http-get:*:" ++ mimeType ++ ":" + protocolSuffix = + case useDlna cfg of + True -> join ";" $ mapMaybe (\(n,v) -> mapMaybe1 (printf "%s=%s" n) v) fields + False -> "*" + -- Protocol constants. + _DLNA_ORG_FLAG_SENDER_PACED = bit 31 :: Int32 + _DLNA_ORG_FLAG_TIME_BASED_SEEK = bit 30 :: Int32 + _DLNA_ORG_FLAG_BYTE_BASED_SEEK = bit 29 :: Int32 + _DLNA_ORG_FLAG_PLAY_CONTAINER = bit 28 :: Int32 + _DLNA_ORG_FLAG_S0_INCREASE = bit 27 :: Int32 + _DLNA_ORG_FLAG_SN_INCREASE = bit 26 :: Int32 + _DLNA_ORG_FLAG_RTSP_PAUSE = bit 25 :: Int32 + _DLNA_ORG_FLAG_STREAMING_TRANSFER_MODE = bit 24 :: Int32 + _DLNA_ORG_FLAG_INTERACTIVE_TRANSFER_MODE = bit 23 :: Int32 + _DLNA_ORG_FLAG_BACKGROUND_TRANSFER_MODE = bit 22 :: Int32 + _DLNA_ORG_FLAG_CONNECTION_STALL = bit 21 :: Int32 + _DLNA_ORG_FLAG_DLNA_V15 = bit 20 :: Int32 + + +-- Gnerate extra attributes for containers. +genContainerAttributes :: ArrowXml a => Objects -> ObjectId -> [a XmlTree XmlTree] +genContainerAttributes objects oid = + [ sattr "searchable" "0" + , sattr "restricted" "0" + , sattr "childCount" $ show $ getNumberOfChildren objects oid + ] + +-- Generate extra attributes for items. +genItemAttributes :: ArrowXml a => [a XmlTree XmlTree] +genItemAttributes = [] + +-- Create the DIDL result object. +mkDidl :: ArrowXml a => [a XmlTree XmlTree] -> a XmlTree XmlTree +mkDidl es = + (selem "dummy" -- Not using 'root' means we avoid the XML declaration + [ mkelem "DIDL-Lite" [ sattr "xmlns:dc" dcNs + , sattr "xmlns:upnp" upnpNs + , sattr "xmlns" ns ] + es ]) + where + dcNs = "http://purl.org/dc/elements/1.1/" + upnpNs = "urn:schemas-upnp-org:metadata-1-0/upnp/" + ns = "urn:schemas-upnp-org:metadata-1-0/DIDL-Lite/" + + +-- Slice out a portion of a list. +slice :: Int -> Int -> [a] -> [a] +slice i n xs = take n $ drop i $ xs diff --git a/src/SimpleServiceDiscoveryProtocol.hs b/src/SimpleServiceDiscoveryProtocol.hs new file mode 100644 --- /dev/null +++ b/src/SimpleServiceDiscoveryProtocol.hs @@ -0,0 +1,93 @@ +{- + hums - The Haskell UPnP Server + Copyright (C) 2009 Bardur Arantsson + + 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 . +-} + +module SimpleServiceDiscoveryProtocol ( sendNotifyForever + , MessageType(..) + ) + where + +import Configuration +import Network.Socket +import Text.Printf +import URIExtra +import Control.Concurrent +import Control.Monad + +-- Notification message types. +data MessageType = UpnpServiceNotification + | RootDeviceNotification + | ConnectionManagerNotification + | ContentDirectoryNotification + | MediaServerNotification + +generateNotifyAlive :: ApplicationInformation -> Configuration -> MediaServerConfiguration -> MessageType -> String +generateNotifyAlive ai c msc messageType = + concat [ printf "NOTIFY * HTTP/1.1\r\n" + , printf "HOST: 239.255.255.250:1900\r\n" + , printf "CACHE-CONTROL: max-age=180\r\n" + , printf "LOCATION: %s\r\n" base_url + , printf "NT: %s\r\n" $ messageTypeAsString messageType + , printf "NTS: ssdp:alive\r\n" + , printf "SERVER: %s\r\n" (getServerHeaderValue ai) + , printf "USN: uuid:%s%s\r\n" (uuid msc) messageTypeSuffix + , printf "\r\n" ] + where + base_url = show $ mkURI ["description.xml"] $ httpServerBase c + messageTypeAsString UpnpServiceNotification = (printf "uuid:%s" $ uuid msc) + messageTypeAsString RootDeviceNotification = "upnp:rootdevice" + messageTypeAsString ConnectionManagerNotification = "urn:schemas-upnp-org:service:ConnectionManager:1" + messageTypeAsString ContentDirectoryNotification = "urn:schemas-upnp-org:service:ContentDirectory:1" + messageTypeAsString MediaServerNotification = "urn:schemas-upnp-org:device:MediaServer:1" + messageTypeSuffix = case messageType of + UpnpServiceNotification -> "" + _ -> printf "::%s" $ messageTypeAsString messageType + +sendRawMessage :: Configuration -> String -> IO () +sendRawMessage c m = do + -- Addresses + sa <- inet_addr $ local_net_ip c + da <- inet_addr "239.255.255.250" + -- Open socket and send + sock <- socket AF_INET Datagram 0 + bindSocket sock $ SockAddrInet aNY_PORT sa -- Use local interface + sendTo sock m (SockAddrInet 1900 da) -- Ignore return value + sClose sock + return () + +sendNotifyAlive :: ApplicationInformation -> Configuration -> MediaServerConfiguration -> MessageType -> IO () +sendNotifyAlive ai c msc mt = + sendRawMessage c $ generateNotifyAlive ai c msc mt + +sendNotifyAliveAll :: ApplicationInformation -> Configuration -> MediaServerConfiguration -> IO () +sendNotifyAliveAll ai c msc = do + sendIt UpnpServiceNotification + sendIt RootDeviceNotification + sendIt MediaServerNotification + sendIt ContentDirectoryNotification + sendIt ConnectionManagerNotification + where + sendIt mt = do + sendNotifyAlive ai c msc mt + threadDelay 100000 + +sendNotifyForever :: ApplicationInformation -> Configuration -> MediaServerConfiguration -> IO () +sendNotifyForever ai c msc = do + forever $ do + putStrLn "Broadcasting alive notifications..." + sendNotifyAliveAll ai c msc + threadDelay 30000000 -- Every 30 seconds should be more than enough. diff --git a/src/Soap.hs b/src/Soap.hs new file mode 100644 --- /dev/null +++ b/src/Soap.hs @@ -0,0 +1,163 @@ +{- + hums - The Haskell UPnP Server + Copyright (C) 2009 Bardur Arantsson + + 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 . +-} + +module Soap ( parseControlSoapXml + ) where + +import Text.XML.HXT.Arrow +import Action + +-- ContentDirectory XML name space +nsContentDirectory :: String +nsContentDirectory = "urn:schemas-upnp-org:service:ContentDirectory:1" + +-- ConnectionManager XML name space +nsConnectionManager :: String +nsConnectionManager = "urn:schemas-upnp-org:service:ConnectionManager:1" + +-- Utility functions for parsing XML. +atTag :: ArrowXml a => String -> a XmlTree XmlTree +atTag tag = deep (isElem >>> hasLocalPart tag) + +text :: ArrowXml a => a XmlTree String +text = (getChildren >>> getText) -- Gather text from all child nodes. + `orElse` (txt "" >>> getText) -- No child nodes means empty string. + +textAtTag :: ArrowXml a => String -> a XmlTree String +textAtTag tag = atTag tag >>> text + +numberAtTag :: (ArrowXml a, Num b, Read b) => String -> a XmlTree b +numberAtTag tag = + atTag tag >>> text >>> arr read + +-- Parse the "Browse Flag". CD/§2.5.6 +parseBrowseFlag :: ArrowXml a => a XmlTree (BrowseParameters -> BrowseAction) +parseBrowseFlag = + atTag "BrowseFlag" >>> getChildren >>> (f1 `orElse` f2 `orElse` f3) + where + f1 = (hasText ((==) "BrowseMetadata")) >>> constA BrowseMetadata + f2 = (hasText ((==) "BrowseDirectChildren")) >>> constA BrowseDirectChildren + f3 = error "Protocol error: invalid browse flag" + +{- + + Content Directory SOAP messages. + +-} +parseCDBrowse :: ArrowXml a => a XmlTree ContentDirectoryAction +parseCDBrowse = + atTag "Browse" >>> hasNamespaceUri nsContentDirectory >>> + proc l -> do + oid <- textAtTag "ObjectID" + `orElse` textAtTag "ContainerID" {- XBox-360 -} -< l + bf <- parseBrowseFlag -< l + flt <- textAtTag "Filter" -< l + si <- numberAtTag "StartingIndex" -< l + rq <- numberAtTag "RequestedCount" -< l + sc <- textAtTag "SortCriteria" -< l + returnA -< let bps = BrowseParameters oid flt si rq sc in + ContentDirectoryBrowse $ bf bps + +parseCDSearchCapabilities :: ArrowXml a => a XmlTree ContentDirectoryAction +parseCDSearchCapabilities = + atTag "GetSearchCapabilities" >>> hasNamespaceUri nsContentDirectory >>> + proc _ -> returnA -< ContentDirectoryGetSearchCapabilities + +parseCDGetSortCapabilities :: ArrowXml a => a XmlTree ContentDirectoryAction +parseCDGetSortCapabilities = + atTag "GetSortCapabilities" >>> hasNamespaceUri nsContentDirectory >>> + proc _ -> returnA -< ContentDirectoryGetSortCapabilities + +parseCDGetSystemUpdateId :: ArrowXml a => a XmlTree ContentDirectoryAction +parseCDGetSystemUpdateId = + atTag "GetSystemUpdateID" >>> hasNamespaceUri nsContentDirectory >>> + proc _ -> returnA -< ContentDirectoryGetSystemUpdateId + +parseContentDirectoryQueryXml :: ArrowXml a => a XmlTree Action +parseContentDirectoryQueryXml = + proc l -> do + x <- helper -< l + returnA -< ContentDirectoryAction_ x + where helper = + parseCDBrowse `orElse` parseCDSearchCapabilities + `orElse` parseCDGetSortCapabilities + `orElse` parseCDGetSystemUpdateId + +{- + + Connection Manager SOAP messages. + +-} +parseCMGetProtocolInfo :: ArrowXml a => a XmlTree ConnectionManagerAction +parseCMGetProtocolInfo = + atTag "GetProtocolInfo" >>> hasNamespaceUri nsConnectionManager >>> + proc _ -> returnA -< ConnectionManagerGetProtocolInfo + +parseCMPrepareForConnection :: ArrowXml a => a XmlTree ConnectionManagerAction +parseCMPrepareForConnection = + atTag "PrepareForConnection" >>> hasNamespaceUri nsConnectionManager >>> + proc _ -> returnA -< ConnectionManagerPrepareForConnection + +parseCMConnectionComplete :: ArrowXml a => a XmlTree ConnectionManagerAction +parseCMConnectionComplete = + atTag "ConnectionComplete" >>> hasNamespaceUri nsConnectionManager >>> + proc _ -> returnA -< ConnectionManagerConnectionComplete + +parseCMGetCurrentConnectionIDs :: ArrowXml a => a XmlTree ConnectionManagerAction +parseCMGetCurrentConnectionIDs = + atTag "GetCurrentConnectionIDs" >>> hasNamespaceUri nsConnectionManager >>> + proc _ -> returnA -< ConnectionManagerGetCurrentConnectionIDs + +parseCMGetCurrentConnectionInfo :: ArrowXml a => a XmlTree ConnectionManagerAction +parseCMGetCurrentConnectionInfo = + atTag "GetCurrentConnectionInfo" >>> hasNamespaceUri nsConnectionManager >>> + proc _ -> returnA -< ConnectionManagerGetCurrentConnectionInfo + +parseConnectionManagerQueryXml :: ArrowXml a => a XmlTree Action +parseConnectionManagerQueryXml = + proc l -> do + x <- helper -< l + returnA -< ConnectionManagerAction_ x + where helper = + parseCMGetProtocolInfo `orElse` parseCMPrepareForConnection + `orElse` parseCMConnectionComplete + `orElse` parseCMGetCurrentConnectionIDs + `orElse` parseCMGetCurrentConnectionInfo + +parseQueryXml :: ArrowXml a => a XmlTree Action +parseQueryXml = + parseContentDirectoryQueryXml `orElse` parseConnectionManagerQueryXml + +{- + + Parse SOAP messages. + +-} + + + +parseControlSoapXml :: String -> IO (Maybe Action) +parseControlSoapXml xml = do + as <- runX $ readString inAttributes xml >>> parseQueryXml + case as of + (a:_) -> return $ Just a + _ -> return $ Nothing + where + inAttributes = [ (a_validate, v_0) + , (a_check_namespaces, v_1) + ] diff --git a/src/StorableExtra.hs b/src/StorableExtra.hs new file mode 100644 --- /dev/null +++ b/src/StorableExtra.hs @@ -0,0 +1,47 @@ +{- + hums - The Haskell UPnP Server + Copyright (C) 2009 Bardur Arantsson + + 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 . +-} + +module StorableExtra ( toHexString ) where + +import Storable +import Data.Word +import Foreign.Marshal.Utils (with) +import Text.Printf +import Control.Monad + +-- Convert a storable to an [Word8]. +toWord8Array :: Storable a => a -> IO [Word8] +toWord8Array a = do + xs <- loop 0 + return xs + where + loop i = + if i < sizeOf a then do + x <- with a (\aptr -> peekByteOff aptr i) :: IO Word8 + xs <- loop $ i+1 + return (x : xs) + else + return [] + + +-- Convert a storable to a string of hex digits. +toHexString :: Storable a => a -> IO String +toHexString a = do + bytes <- toWord8Array a + let s = (concat $ map (\x -> printf "%02x" x) $ bytes) :: String + return $ s diff --git a/src/URIExtra.hs b/src/URIExtra.hs new file mode 100644 --- /dev/null +++ b/src/URIExtra.hs @@ -0,0 +1,56 @@ +{- + hums - The Haskell UPnP Server + Copyright (C) 2009 Bardur Arantsson + + 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 . +-} + +module URIExtra ( mkURIReference + , mkURI + ) where + +import Network.URI +import Data.Maybe +import Data.List + +-- Create an URI reference (absolute or relative URI with optional fragment identifier) +-- from an arbitrary string. The string is URI-encoded if necessary. +-- TODO: Document partiality if input string is not valid (as per parseURIReference). +mkURIReference :: String -> URI +mkURIReference s = + case {- parseURIReference -} parseRelativeReference $ escapeURIString isUnescapedInURI s of + Just u -> u + Nothing -> error $ "Invalid URI component '" ++ s ++ "'" + +-- Make sure we have a trailing slash on all path components, +-- *except* the last. +addSlashes :: [String] -> [String] +addSlashes [] = [] +addSlashes ("":xs) = addSlashes xs -- Remove empty components +addSlashes [x] = [x] -- Last component +addSlashes (x:y:xs) = (addSlash x : addSlashes (y:xs)) -- Other components + +-- Add trailing slash to a string unless already present. +addSlash :: String -> String +addSlash s | "/" `isSuffixOf` s = s +addSlash s = s ++ "/" + +-- Build a complete URI from a set of path components and a base URI. +mkURI :: [String] -> URI -> URI +mkURI ss u = + mkURI' u $ map mkURIReference $ addSlashes ss + +mkURI' :: URI -> [URI] -> URI +mkURI' = + foldl (\a r -> fromJust $ r `relativeTo` a)