diff --git a/LICENSE b/LICENSE new file mode 100644 --- /dev/null +++ b/LICENSE @@ -0,0 +1,676 @@ + 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/Main.hs b/Main.hs new file mode 100644 --- /dev/null +++ b/Main.hs @@ -0,0 +1,32 @@ +-- Author: Andy Stewart +-- Maintainer: Andy Stewart +-- +-- Copyright (C) 2010 Andy Stewart, all rights reserved. +-- +-- This program is free software: you can redistribute it and/or modify +-- it under the terms of the GNU General Public License as published by +-- the Free Software Foundation, either version 3 of the License, or +-- any later version. +-- +-- This program is distributed in the hope that it will be useful, +-- but WITHOUT ANY WARRANTY; without even the implied warranty of +-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +-- GNU General Public License for more details. +-- +-- You should have received a copy of the GNU General Public License +-- along with this program. If not, see . + +{-# LANGUAGE DeriveDataTypeable, ScopedTypeVariables #-} +{-# LANGUAGE OverloadedStrings #-} +module Main where + +import Control.Applicative hiding (empty) +import Manatee.Core.Render +import Manatee.Core.Types +import Manatee.Extension.Curl + +-- | Irc client render process. +main :: IO () +main = + startupRender (\ pagePath options client pageId -> + PageBufferWrap <$> curlBufferNew pagePath options client pageId) diff --git a/Manatee/Extension/Curl.hs b/Manatee/Extension/Curl.hs new file mode 100644 --- /dev/null +++ b/Manatee/Extension/Curl.hs @@ -0,0 +1,26 @@ +-- Author: Andy Stewart +-- Maintainer: Andy Stewart +-- +-- Copyright (C) 2010 Andy Stewart, all rights reserved. +-- +-- This program is free software: you can redistribute it and/or modify +-- it under the terms of the GNU General Public License as published by +-- the Free Software Foundation, either version 3 of the License, or +-- any later version. +-- +-- This program is distributed in the hope that it will be useful, +-- but WITHOUT ANY WARRANTY; without even the implied warranty of +-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +-- GNU General Public License for more details. +-- +-- You should have received a copy of the GNU General Public License +-- along with this program. If not, see . + +{-# LANGUAGE OverloadedStrings #-} +module Manatee.Extension.Curl ( + module Manatee.Extension.Curl.CurlBuffer, + module Manatee.Extension.Curl.CurlView, +) where + +import Manatee.Extension.Curl.CurlBuffer +import Manatee.Extension.Curl.CurlView diff --git a/Manatee/Extension/Curl/CurlBuffer.hs b/Manatee/Extension/Curl/CurlBuffer.hs new file mode 100644 --- /dev/null +++ b/Manatee/Extension/Curl/CurlBuffer.hs @@ -0,0 +1,803 @@ +-- Author: Andy Stewart +-- Maintainer: Andy Stewart +-- +-- Copyright (C) 2010 Andy Stewart, all rights reserved. +-- +-- This program is free software: you can redistribute it and/or modify +-- it under the terms of the GNU General Public License as published by +-- the Free Software Foundation, either version 3 of the License, or +-- any later version. +-- +-- This program is distributed in the hope that it will be useful, +-- but WITHOUT ANY WARRANTY; without even the implied warranty of +-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +-- GNU General Public License for more details. +-- +-- You should have received a copy of the GNU General Public License +-- along with this program. If not, see . + +{-# LANGUAGE ScopedTypeVariables, DeriveDataTypeable #-} +module Manatee.Extension.Curl.CurlBuffer where + +import Control.Applicative +import Control.Concurrent +import Control.Concurrent.STM +import Control.Monad +import DBus.Client hiding (Signal) +import Data.Binary +import Data.List +import Data.Map (Map) +import Data.Maybe +import Data.Typeable +import Foreign +import Graphics.UI.Gtk.General.Enums +import Graphics.UI.Gtk.General.General +import Graphics.UI.Gtk.ModelView.TreeSortable +import Manatee.Core.Config +import Manatee.Core.Types +import Manatee.Extension.Curl.PageMode +import Manatee.Extension.Curl.Types +import Manatee.Toolkit.General.Basic +import Manatee.Toolkit.General.Concurrent +import Manatee.Toolkit.General.List +import Manatee.Toolkit.General.Maybe +import Manatee.Toolkit.General.Misc +import Manatee.Toolkit.General.STM +import Manatee.Toolkit.General.Time +import Manatee.Toolkit.Gio.Gio +import Manatee.Toolkit.Gtk.Gtk +import Network.Curl hiding (CurlBuffer) +import Network.URI +import System.Directory +import System.FilePath +import System.IO +import Text.Printf +import Text.Regex.TDFA + +import qualified Control.Exception as Exc +import qualified Data.ByteString as B +import qualified Data.ByteString.Lazy as BL +import qualified Data.ByteString.Internal as S +import qualified Data.Map as M + +data CurlBuffer = + CurlBuffer {curlBufferName :: String + ,curlBufferClient :: Client + ,curlBufferPageId :: PageId + ,curlBufferFileInfoOptions :: [(DownloadFileOption, SortColumnId)] + ,curlBufferFileInfos :: TVar [DownloadFile] + ,curlBufferSortStatus :: TVar (DownloadFileOption, SortType) + ,curlBufferIconPixbufDatabase :: TVar FileIconPixbufDatabase + ,curlBufferDownloadStatusPixbuf :: DownloadStatusPixbuf + ,curlBufferMode :: PageMode + ,curlBufferBroadcastChannel :: TChan CurlTChanSignal + } + deriving Typeable + +data CurlTChanSignal = AddDownload DownloadFile + | DeleteDownload String + | UpdateStatus + deriving (Show, Eq, Ord) + +class CurlFileInfoClass a where + getColumnTitle :: a -> String -- get title for treeColumn + getCellXAlign :: a -> Float -- get x align for cell + getCellMinWidth :: a -> Maybe Int -- get min width for cell + getCellText :: a -> DownloadFile -> IO String -- get text for cell + compareRow :: a -> DownloadFile -> DownloadFile -> IO Ordering -- compare row for treeView + +instance CurlFileInfoClass DownloadFileOption where + getColumnTitle DFName = "File Name" + getColumnTitle DFSize = "Size" + getColumnTitle DFDownloadSize = "Download" + getColumnTitle DFRestSize = "Rest Size" + getColumnTitle DFSpeed = "Speed" + getColumnTitle DFRestTime = "Rest Time" + getColumnTitle DFThread = "Thread" + getColumnTitle DFURL = "URL" + + getCellXAlign DFName = 0.0 + getCellXAlign DFSize = 1.0 + getCellXAlign DFDownloadSize = 1.0 + getCellXAlign DFRestSize = 1.0 + getCellXAlign DFSpeed = 1.0 + getCellXAlign DFRestTime = 1.0 + getCellXAlign DFThread = 1.0 + getCellXAlign DFURL = 0.0 + + getCellMinWidth DFName = Nothing + getCellMinWidth DFSize = Just 70 + getCellMinWidth DFDownloadSize = Just 70 + getCellMinWidth DFRestSize = Just 70 + getCellMinWidth DFSpeed = Just 80 + getCellMinWidth DFRestTime = Nothing + getCellMinWidth DFThread = Nothing + getCellMinWidth DFURL = Nothing + + getCellText DFName file = downloadFileGetFileName file + getCellText DFSize file = fmap formatSize $ downloadFileGetSize file + getCellText DFDownloadSize file = fmap formatSize $ downloadFileGetDownloadSize file + getCellText DFRestSize file = fmap formatSize $ downloadFileGetRestSize file + getCellText DFSpeed file = do + downloadStatus <- readTVarIO (dfDownloadStatus file) + if downloadStatus == Running + then fmap formatSpeed $ downloadFileGetSpeed file + else return "" + getCellText DFRestTime file = do + downloadStatus <- readTVarIO (dfDownloadStatus file) + if downloadStatus == Running + then fmap secondToDaytime $ downloadFileGetRestTime file + else return "" + getCellText DFThread file = do + downloadStatus <- readTVarIO (dfDownloadStatus file) + if downloadStatus == Running + then fmap show $ downloadFileGetThread file + else return "" + getCellText DFURL file = downloadFileGetURL file + + compareRow DFName row1 row2 = + liftA2 compare (downloadFileGetFileName row1) (downloadFileGetFileName row2) + compareRow DFSize row1 row2 = + liftA2 compare (downloadFileGetSize row1) (downloadFileGetSize row2) + compareRow DFDownloadSize row1 row2 = + liftA2 compare (downloadFileGetDownloadSize row1) (downloadFileGetDownloadSize row2) + compareRow DFRestSize row1 row2 = + liftA2 compare (downloadFileGetRestSize row1) (downloadFileGetRestSize row2) + compareRow DFSpeed row1 row2 = + liftA2 compare (downloadFileGetSpeed row1) (downloadFileGetSpeed row2) + compareRow DFRestTime row1 row2 = + liftA2 compare (downloadFileGetRestTime row1) (downloadFileGetRestTime row2) + compareRow DFThread row1 row2 = + liftA2 compare (downloadFileGetThread row1) (downloadFileGetThread row2) + compareRow DFURL row1 row2 = + liftA2 compare (downloadFileGetURL row1) (downloadFileGetURL row2) + +-- | Default download thread number. +defaultThreadNumber :: Int +defaultThreadNumber = 4 + +-- | Default download directory. +defaultDownloadDir :: FilePath +defaultDownloadDir = + "download" + +-- | Default cache directory. +defaultCacheDir :: FilePath +defaultCacheDir = + "download/cache" + +-- | Default cache size (bytes). +-- Default is 512K. +-- This cache value is for thread, +-- max memory is bigger if you use more threads. +-- Of course, memory will release after flush cache to disk. +-- NOTE, don't set value too little, +-- it will cause too many I/O operation if cache size is less than download speed. +defaultCacheSize :: Int +defaultCacheSize = + 512 * 2 ^ 10 + +-- | Whether automatic start download file when startup process? +-- Default is 'False'. +autoStart :: Bool +autoStart = False + +-- | New. +curlBufferNew :: FilePath -> [String] -> Client -> PageId -> IO CurlBuffer +curlBufferNew name urls client pageId = do + -- Create directory if missing. + configDir <- getConfigDirectory + createDirectoryIfMissing True (configDir defaultDownloadDir) + createDirectoryIfMissing True (configDir defaultCacheDir) + + -- Create buffer. + buffer <- + CurlBuffer <$> pure name + <*> pure client + <*> pure pageId + <*> pure (pairPred [DFName, DFSize, DFSpeed, DFRestTime, DFThread, DFURL]) + <*> newTVarIO [] + <*> newTVarIO (DFName, SortAscending) + <*> newTVarIO M.empty + <*> (DownloadStatusPixbuf + <$> pixbufNewFromIcon "gtk-media-pause" 16 + <*> pixbufNewFromIcon "gtk-media-play-ltr" 16 + <*> pixbufNewFromIcon "gtk-apply" 16 + <*> pixbufNewFromIcon "gtk-cancel" 16) + <*> pure curlMode + <*> (newTChanIO :: IO (TChan CurlTChanSignal)) + + -- Scan cache file to resume. + curlBufferScanCacheFile buffer + + -- Add download. + logPathes <- getLogPathes + logUrls <- + forM logPathes $ \ logPath -> + fmap dlURL $ readConfig logPath (DownloadLog "" "" 0 M.empty) + + forM_ urls $ \ url -> + -- Just start new url not cache in disk. + when (url `notElem` logUrls) $ + curlBufferAddDownload buffer url + + return buffer + +-- | Add download. +curlBufferAddDownload :: CurlBuffer -> String -> IO () +curlBufferAddDownload curlBuffer uri = + case parseURI uri of + Nothing -> putStrLn $ "Malformed URI : " ++ uri + Just _ -> do + -- Pick up file name. + let file = takeFileName $ uriPath $ fromJust $ parseURI uri + + -- Create DownloadFile. + downloadFile <- + DownloadFile <$> pure uri + <*> newTVarIO file + <*> newTVarIO 0 + <*> newTVarIO 0.0 + <*> newTVarIO 0 + <*> newTVarIO 0 + <*> newTVarIO [] + <*> newEmptyMVar + <*> newTVarIO Running + <*> newTVarIO 0 + + -- Add DownloadFile in CurlBuffer/CurlView. + modifyTVarIO (curlBufferFileInfos curlBuffer) (\x -> downloadFile : x) + writeTChanIO (curlBufferBroadcastChannel curlBuffer) (AddDownload downloadFile) + + -- Start download. + forkIO_ $ do + -- Fetch file size fist. + size <- getFileSize uri + + if size == 0 + -- Stop download when file size is zero. + then putStrLn "Size is zero, stop download." + -- Otherwise start download. + else do + -- Update size. + writeTVarIO (dfSize downloadFile) size + + -- Update DownloadBuffer. + buffers <- initDownloadBuffers size defaultThreadNumber + writeTVarIO (dfBuffers downloadFile) buffers + + -- Start speed calculate. + startSpeedCalculate downloadFile + + -- Fork threads to download different part of file. + forM_ buffers (\ buffer -> do + -- Record log file first. + recordLogFile downloadFile buffer + -- Start thread. + forkIO_ $ getFile uri downloadFile curlBuffer buffer (dbRange buffer)) + + -- Wait result. + curlBufferWaitResult downloadFile + +-- | Delete download. +curlBufferDeleteDownload :: CurlBuffer -> DownloadFile -> IO () +curlBufferDeleteDownload curlBuffer downloadFile = do + -- Update Failed status, thread will stop immediately. + let url = dfURL downloadFile + writeTVarIO (dfDownloadStatus downloadFile) Failed + + -- Clean temp file. + cleanTempFile downloadFile + + -- Delete DownloadFile from CurlBuffer. + modifyTVarIO (curlBufferFileInfos curlBuffer) $ \ list -> + filter (\x -> dfURL x /= url) list + + -- Delete DownloadFile from CurlView. + writeTChanIO (curlBufferBroadcastChannel curlBuffer) (DeleteDownload url) + +-- | Init DownloadBuffer. +initDownloadBuffers :: Int -> Int -> IO [DownloadBuffer] +initDownloadBuffers size threadNum = do + -- Get download range of thread. + let ranges = getDownloadRange size threadNum + zipWithIndexM ranges $ \ (a, b) index -> + DownloadBuffer <$> pure index + <*> pure (a, b) + <*> newTVarIO Nothing + <*> pure 0 + <*> newTVarIO 0 + <*> newTVarIO 0 + <*> newTVarIO 0 + <*> newTVarIO False + +-- | Scan cache file to resume. +curlBufferScanCacheFile :: CurlBuffer -> IO () +curlBufferScanCacheFile curlBuffer = + forkIO_ $ do + -- Get log pathes. + logPathes <- getLogPathes + + -- Scan log patch to pick cache information. + forM_ logPathes $ \ logPath -> + forkIO_ $ do + -- Get DownloadLog. + let emptyLog = DownloadLog "" "" 0 M.empty + downloadLog@(DownloadLog {dlBuffers = logBufferMap}) <- readConfig logPath emptyLog + + -- Pick DownloadBuffer from DownloadLog. + buffers <- pickDownloadBuffers logBufferMap + + -- Init new DownloadFile. + downloadFile <- + DownloadFile <$> pure (dlURL downloadLog) + <*> newTVarIO (dlName downloadLog) + <*> newTVarIO (dlSize downloadLog) + <*> (do + cacheSize <- fmap sum $ forM buffers $ \buffer -> readTVarIO (dbCacheSize buffer) + newTVarIO $ i2d (cacheSize * 100) / i2d (dlSize downloadLog)) + <*> newTVarIO 0 + <*> newTVarIO 0 + <*> newTVarIO buffers + <*> newEmptyMVar + <*> newTVarIO (if autoStart then Running else Pause) + <*> newTVarIO 0 + + -- Update DownloadFile in CurlBuffer/CurlView. + modifyTVarIO (curlBufferFileInfos curlBuffer) (\x -> downloadFile : x) + writeTChanIO (curlBufferBroadcastChannel curlBuffer) (AddDownload downloadFile) + + -- Start download if option 'autoStart' is enable. + when autoStart $ downloadFileStart curlBuffer downloadFile buffers + +-- | Wait download result. +curlBufferWaitResult :: DownloadFile -> IO () +curlBufferWaitResult downloadFile = do + e <- takeMVar (dfFinishLock downloadFile) + case e of + -- Kill thread if DownloadError. + DownloadError err -> do + buffers <- readTVarIO (dfBuffers downloadFile) + forM_ buffers (\ buffer -> + readTVarIO (dbThreadId buffer) + >?>= \ i -> killThread i) + putStrLn $ "Failed to connect: " ++ err + DownloadPause -> putStrLn "Fetch pause." + DownloadFinish -> putStrLn "Fetch complete." + +-- | Pause. +curlBufferPause :: DownloadFile -> IO () +curlBufferPause downloadFile = do + -- Just pause when status is 'Running'. + downloadStatus <- readTVarIO (dfDownloadStatus downloadFile) + when (downloadStatus == Running) $ + writeTVarIO (dfDownloadStatus downloadFile) Pause + +-- | Continue download. +curlBufferContinue :: CurlBuffer -> DownloadFile -> IO () +curlBufferContinue curlBuffer downloadFile = do + downloadStatus <- readTVarIO (dfDownloadStatus downloadFile) + when (downloadStatus == Pause) $ + forkIO_ $ do + let url = dfURL downloadFile + buffers <- readTVarIO (curlBufferFileInfos curlBuffer) + find (\x -> dfURL x == url) buffers + ?>= \ downloadFile -> do + -- Get download log. + logPath <- getFileLogFile downloadFile + let emptyLog = DownloadLog "" "" 0 M.empty + (DownloadLog {dlBuffers = logBufferMap}) <- readConfig logPath emptyLog + + -- Pick DownloadBuffer from DownloadLog. + buffers <- pickDownloadBuffers logBufferMap + + -- Update DownloadFile for ready download. + writeTVarIO (dfBuffers downloadFile) buffers + tryTakeMVar (dfFinishLock downloadFile) + curlBufferChangeStatus curlBuffer downloadFile Running + + -- Start download. + downloadFileStart curlBuffer downloadFile buffers + +-- | Change download status. +curlBufferChangeStatus :: CurlBuffer -> DownloadFile -> DownloadStatus -> IO () +curlBufferChangeStatus curlBuffer downloadFile status = do + -- Change download status. + writeTVarIO (dfDownloadStatus downloadFile) status + + -- Update in CurlView. + writeTChanIO (curlBufferBroadcastChannel curlBuffer) UpdateStatus + +-- | Get log paths. +getLogPathes :: IO [String] +getLogPathes = do + cacheDir <- fmap ( defaultCacheDir) getConfigDirectory + files <- getDirectoryContents cacheDir + return $ map (\x -> cacheDir x) (filter (=~ "^*_log$") files) + +-- | Get download range with thread number. +getDownloadRange :: Int -> Int -> [(Int, Int)] +getDownloadRange size threadNum = + map (\ n -> (n * p, min (size - 1) ((n + 1) * p - 1))) [0.. (threadNum - 1)] + where p = ceiling (i2d size / i2d threadNum) + +-- | Get file size. +getFileSize :: String -> IO Int +getFileSize url = do + -- Init size var. + sizeTVar <- newTVarIO 0 + + -- Init curl. + h <- initialize + + -- Set option. + setDefaultSSLOpts h url + setopt h (CurlFailOnError True) + setopt h (CurlURL url) + setopt h (CurlWriteFunction (\ _ sz n _ -> return (sz * n))) + setopt h (CurlNoProgress False) + setopt h (CurlProgressData nullPtr) + setopt h (CurlProgressFunction + (\ _ size _ _ _ -> + if size > 0.0 + then + writeTVarIO sizeTVar (floor size) + -- Return non-zero value will abort transfer immediately. + >> return 1 + else return 0)) + + -- Perform. + _ <- perform h + + -- Get file size. + readTVarIO sizeTVar + +-- | Get file. +getFile :: String -> DownloadFile -> CurlBuffer -> DownloadBuffer -> (Int, Int) -> IO () +getFile url downloadFile curlBuffer downloadBuffer (start, end) = do + -- Init. + tId <- myThreadId + writeTVarIO (dbThreadId downloadBuffer) (Just tId) + let range = show start ++ "-" ++ show end + lock = dfFinishLock downloadFile + + -- Init curl. + h <- initialize + + -- Create buffer cache. + cache <- newBufferCache + ref <- newTVarIO cache + + -- Set option. + setDefaultSSLOpts h url + setopt h (CurlFailOnError True) + setopt h (CurlURL url) + setopt h (CurlRange range) + setopt h (CurlNoProgress False) + -- setopt h (CurlVerbose True) -- debug + setopt h (CurlWriteFunction (gather ref downloadFile downloadBuffer)) + setopt h (CurlProgressData nullPtr) + setopt h (CurlProgressFunction + (\ _ _ download _ _ -> do + -- Get download offset. + let offset = dbDownloadOffset downloadBuffer + -- Update download size. + writeTVarIO (dbDownloadSize downloadBuffer) (offset + floor download) + + -- Update download progress. + buffers <- readTVarIO (dfBuffers downloadFile) + downloadSize <- fmap sum $ forM buffers $ \ buffer -> readTVarIO (dbDownloadSize buffer) + fileSize <- readTVarIO (dfSize downloadFile) + writeTVarIO (dfProgress downloadFile) (i2d (downloadSize * 100) / i2d fileSize) + writeTChanIO (curlBufferBroadcastChannel curlBuffer) UpdateStatus + + -- Stop thread if download status is not 'Running'. + downloadStatus <- readTVarIO (dfDownloadStatus downloadFile) + return $ case downloadStatus of + Running -> 0 + -- Return non-zero value will abort transfer immediately. + _ -> 1 + )) + + -- Perform. + rc <- perform h + BufferCache buf' size <- readTVarIO ref + + downloadStatus <- readTVarIO (dfDownloadStatus downloadFile) + if rc == CurlAbortedByCallback && downloadStatus == Pause + -- Flush cache to disk if pause by user. + then do + -- Flush cache. + flushBufferCache downloadFile downloadBuffer (buf', size) + + -- Return DownloadPause result. + tryPutMVar lock DownloadPause >> return () + else if rc /= CurlOK + -- Clean temp file if download failed. + then do + -- Update download status. + curlBufferChangeStatus curlBuffer downloadFile Failed + + -- Clean temp file. + cleanTempFile downloadFile + + -- Free memory. + free buf' + + -- Return DownloadError result. + tryPutMVar lock (DownloadError (show rc)) >> return () + else do + -- Update finish lock. + writeTVarIO (dbIsFinish downloadBuffer) True + + -- Flush cache to disk. + flushBufferCache downloadFile downloadBuffer (buf', size) + + -- Get download buffer information. + buffers <- readTVarIO (dfBuffers downloadFile) + finishes <- forM buffers $ \ buffer -> readTVarIO (dbIsFinish buffer) + + -- Generate file if all part fetch complete. + when (all id finishes) $ do + -- Update progress. + writeTVarIO (dfProgress downloadFile) 100.0 + + -- Update download status. + curlBufferChangeStatus curlBuffer downloadFile Finish + + -- Generate file. + generateFile downloadFile + + -- Clean temp file. + cleanTempFile downloadFile + + -- Return DownloadFinish result. + tryPutMVar lock DownloadFinish >> return () + +-- | Gather network data. +gather :: TVar BufferCache -> DownloadFile -> DownloadBuffer -> WriteFunction +gather tvar downloadFile downloadBuffer = + writer $ \(srcPtr, bytes) -> do + -- Copy memory chunks of data into bytestring. + BufferCache destPtr offset <- readTVarIO tvar + let newOffset = offset + bytes + newDestPtr <- reallocBytes destPtr newOffset + S.memcpy (newDestPtr `plusPtr` offset) srcPtr (fromIntegral bytes) + + if newOffset >= defaultCacheSize + -- Flush cache to disk if data reach cache size. + then do + -- Update new cache. + writeTVarIOM tvar newBufferCache + + -- Flush cache to disk. + flushBufferCache downloadFile downloadBuffer (newDestPtr, newOffset) + else + -- Update data and offset. + writeTVarIO tvar (BufferCache newDestPtr newOffset) + +-- | Copy memory chunks of data into our bytestring. +writer :: ((Ptr Word8, Int) -> IO ()) -> WriteFunction +writer f srcPtr size nelems _ = do + let bytes = size * nelems + f (castPtr srcPtr, fromIntegral bytes) + return bytes + +-- | Flush buffer cache. +flushBufferCache :: DownloadFile -> DownloadBuffer -> (Ptr Word8, Int) -> IO () +flushBufferCache downloadFile downloadBuffer (ptr, size) = do + -- Get cache bytes. + fp <- newForeignPtr finalizerFree ptr + let dat = S.fromForeignPtr fp 0 (fromIntegral size) + + -- Flush cache to disk. + filepath <- getBufferCacheFile downloadFile downloadBuffer + Exc.bracket (openFile filepath AppendMode) + hClose + (`B.hPutStr` dat) + + -- Update cache size. + modifyTVarIO (dbCacheSize downloadBuffer) (+ size) + + -- Record log file. + recordLogFile downloadFile downloadBuffer + + -- Debug. + -- counter <- tickTVarIO (dfFlushCounter downloadFile) + -- putStrLn $ "Flush " ++ show counter + +-- | Record log file. +recordLogFile :: DownloadFile -> DownloadBuffer -> IO () +recordLogFile downloadFile downloadBuffer = do + -- Get DownloadLog. + logPath <- getFileLogFile downloadFile + let emptyLog = DownloadLog "" "" 0 M.empty + (DownloadLog {dlBuffers = buffers}) <- readConfig logPath emptyLog + + -- Build new log. + newLog <- + DownloadLog <$> pure (dfURL downloadFile) + <*> readTVarIO (dfName downloadFile) + <*> readTVarIO (dfSize downloadFile) + <*> (do + logBuffer <- + DownloadLogBuffer <$> pure (dbRange downloadBuffer) + <*> readTVarIO (dbCacheSize downloadBuffer) + <*> readTVarIO (dbIsFinish downloadBuffer) + return $ M.insert (dbIndex downloadBuffer) logBuffer buffers) + + -- Update cache log. + writeConfig logPath newLog + +-- | Get buffer cache file. +getBufferCacheFile :: DownloadFile -> DownloadBuffer -> IO FilePath +getBufferCacheFile downloadFile downloadBuffer = do + cacheDir <- fmap ( defaultCacheDir) getConfigDirectory + file <- readTVarIO (dfName downloadFile) + return $ cacheDir file ++ printf "_cache_%d" (dbIndex downloadBuffer) + +-- | Get file log file. +getFileLogFile :: DownloadFile -> IO FilePath +getFileLogFile downloadFile = do + cacheDir <- fmap ( defaultCacheDir) getConfigDirectory + file <- readTVarIO (dfName downloadFile) + return $ cacheDir file ++ "_log" + +-- | New buffer cache. +newBufferCache :: IO BufferCache +newBufferCache = + BufferCache <$> mallocBytes 1024 + <*> pure 0 + +-- | Generate file. +generateFile :: DownloadFile -> IO () +generateFile downloadFile = do + -- Init. + buffers <- readTVarIO (dfBuffers downloadFile) + cacheFiles <- forM buffers $ \ buffer -> getBufferCacheFile downloadFile buffer + downloadDir <- fmap ( defaultDownloadDir) getConfigDirectory + file <- readTVarIO (dfName downloadFile) + + -- Concat cache file. + forM cacheFiles BL.readFile + >>= \ caches -> BL.writeFile (downloadDir file) (BL.concat caches) + +-- | Clean temp file. +cleanTempFile :: DownloadFile -> IO () +cleanTempFile downloadFile = do + -- Get cache files. + buffers <- readTVarIO (dfBuffers downloadFile) + cacheFiles <- forM buffers $ \ buffer -> getBufferCacheFile downloadFile buffer + + -- Remove cache file. + forM_ cacheFiles (\ file -> whenM (doesFileExist file) (removeFile file)) + + -- Remove log file. + logFile <- getFileLogFile downloadFile + whenM (doesFileExist logFile) (removeFile logFile) + +-- | Start speed calculate. +startSpeedCalculate :: DownloadFile -> IO () +startSpeedCalculate downloadFile = + timeoutAdd + (do + -- Init. + buffers <- readTVarIO (dfBuffers downloadFile) + + -- Get download size. + downloadSize <- + fmap sum $ forM buffers $ \ buffer -> readTVarIO (dbDownloadSize buffer) + + -- Update download speed. + speed <- + fmap sum $ forM buffers $ \ buffer -> do + currentSize <- readTVarIO (dbDownloadSize buffer) + recordSize <- readTVarIO (dbRecordSize buffer) + return (currentSize - recordSize) + writeTVarIO (dfSpeed downloadFile) speed + + -- Update rest time. + totalSize <- readTVarIO (dfSize downloadFile) + let second = floor (i2d (totalSize - downloadSize) / i2d speed) + writeTVarIO (dfRestTime downloadFile) second + + -- Update record size for next calculate. + forM_ buffers $ \ buffer -> do + currentSize <- readTVarIO (dbDownloadSize buffer) + writeTVarIO (dbRecordSize buffer) currentSize + + -- Continue calculate when status is 'Running' + downloadStatus <- readTVarIO (dfDownloadStatus downloadFile) + return (downloadStatus == Running) + ) 1000 >> return () + +-- | Get file name. +downloadFileGetFileName :: DownloadFile -> IO FilePath +downloadFileGetFileName = return . takeFileName . uriPath . fromJust . parseURI . dfURL + +-- | Get size. +downloadFileGetSize :: DownloadFile -> IO Int +downloadFileGetSize = readTVarIO . dfSize + +-- | Get download size (bytes). +downloadFileGetDownloadSize :: DownloadFile -> IO Int +downloadFileGetDownloadSize file = do + size <- readTVarIO $ dfSize file + progress <- readTVarIO $ dfProgress file + return $ floor $ i2d size * progress / 100.0 + +-- | Get rest size (bytes). +downloadFileGetRestSize :: DownloadFile -> IO Int +downloadFileGetRestSize file = do + size <- readTVarIO $ dfSize file + progress <- readTVarIO $ dfProgress file + return $ floor $ i2d size * (100.0 - progress) / 100.0 + +-- | Get thread number. +downloadFileGetThread :: DownloadFile -> IO Int +downloadFileGetThread file = do + buffers <- readTVarIO (dfBuffers file) + fmap length $ filterM (fmap not . readTVarIO . dbIsFinish) buffers + +-- | Get speed (bytes). +downloadFileGetSpeed :: DownloadFile -> IO Int +downloadFileGetSpeed file = + readTVarIO $ dfSpeed file + +-- | Get rest time (second). +downloadFileGetRestTime :: DownloadFile -> IO Int +downloadFileGetRestTime file = + readTVarIO $ dfRestTime file + +-- | Get URL. +downloadFileGetURL :: DownloadFile -> IO String +downloadFileGetURL = return . dfURL + +-- | Start download. +downloadFileStart :: CurlBuffer -> DownloadFile -> [DownloadBuffer] -> IO () +downloadFileStart curlBuffer downloadFile buffers = do + -- Start speed calculate. + startSpeedCalculate downloadFile + + -- Start new threads to download. + forM_ buffers $ \ buffer -> do + isFinish <- readTVarIO (dbIsFinish buffer) + -- Just start thread haven't finish. + unless isFinish $ do + -- Get range and cache size. + let (start, end) = dbRange buffer + cacheSize <- readTVarIO (dbCacheSize buffer) + -- Download data from cache size. + forkIO_ $ getFile (dfURL downloadFile) downloadFile + curlBuffer buffer + (start + cacheSize, end) + + -- Wait download result. + curlBufferWaitResult downloadFile + +-- | Format size. +formatSize :: Int -> String +formatSize size = + formatFileSizeForDisplay (fromIntegral size) 2 + +-- | Format size. +formatSpeed :: Int -> String +formatSpeed size = + formatFileSizeForDisplay (fromIntegral size) 2 ++ "/s" + +-- | Pick download buffer. +pickDownloadBuffers :: Map Int DownloadLogBuffer -> IO [DownloadBuffer] +pickDownloadBuffers logBufferMap = + forM (M.toList logBufferMap) + (\ (index, DownloadLogBuffer {dlbRange = range + ,dlbCacheSize = cacheSize + ,dlbIsFinish = isFinish}) -> + DownloadBuffer <$> pure index + <*> pure range + <*> newTVarIO Nothing + <*> pure cacheSize + <*> newTVarIO cacheSize + <*> newTVarIO cacheSize + <*> newTVarIO cacheSize + <*> newTVarIO isFinish) + diff --git a/Manatee/Extension/Curl/CurlView.hs b/Manatee/Extension/Curl/CurlView.hs new file mode 100644 --- /dev/null +++ b/Manatee/Extension/Curl/CurlView.hs @@ -0,0 +1,541 @@ +-- Author: Andy Stewart +-- Maintainer: Andy Stewart +-- +-- Copyright (C) 2010 Andy Stewart, all rights reserved. +-- +-- This program is free software: you can redistribute it and/or modify +-- it under the terms of the GNU General Public License as published by +-- the Free Software Foundation, either version 3 of the License, or +-- any later version. +-- +-- This program is distributed in the hope that it will be useful, +-- but WITHOUT ANY WARRANTY; without even the implied warranty of +-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +-- GNU General Public License for more details. +-- +-- You should have received a copy of the GNU General Public License +-- along with this program. If not, see . + +{-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE DeriveDataTypeable #-} +module Manatee.Extension.Curl.CurlView where + +import Control.Applicative +import Control.Concurrent.STM +import Control.Monad +import Data.List +import Data.Map (Map) +import Data.Text.Lazy (Text) +import Data.Typeable +import Graphics.UI.Gtk hiding (Statusbar, statusbarNew, get) +import Graphics.UI.Gtk.Gdk.SerializedEvent +import Manatee.Core.Config +import Manatee.Core.DBus +import Manatee.Core.FileOpenRule +import Manatee.Core.PageView +import Manatee.Core.Types +import Manatee.Extension.Curl.CurlBuffer +import Manatee.Extension.Curl.Types +import Manatee.Toolkit.General.Basic +import Manatee.Toolkit.General.Functor +import Manatee.Toolkit.General.Map +import Manatee.Toolkit.General.Maybe +import Manatee.Toolkit.General.STM +import Manatee.Toolkit.Gio.Gio +import Manatee.Toolkit.Gtk.Concurrent +import Manatee.Toolkit.Gtk.Gtk +import Manatee.Toolkit.Gtk.ModelView +import Manatee.Toolkit.Gtk.ScrolledWindow +import System.Directory +import System.FilePath +import System.GIO +import Text.Printf + +import qualified Data.Map as M + +data CurlView = + CurlView {curlViewPlugId :: TVar PagePlugId + ,curlViewScrolledWindow :: ScrolledWindow + ,curlViewBuffer :: CurlBuffer + ,curlViewTreeView :: TreeView + ,curlViewListStore :: ListStore DownloadFile + ,curlViewSortModel :: TypedTreeModelSort DownloadFile + ,curlViewBroadcastChannel :: ViewChannel CurlTChanSignal + } + deriving Typeable + +instance PageBuffer CurlBuffer where + pageBufferGetName = return . curlBufferName + pageBufferSetName _ _ = return () + pageBufferClient = curlBufferClient + pageBufferCreateView a pId = PageViewWrap <$> curlViewNew a pId + pageBufferMode = curlBufferMode + +instance PageView CurlView where + pageViewBuffer = PageBufferWrap . curlViewBuffer + pageViewPlugId = curlViewPlugId + pageViewFocus = treeViewFocus . curlViewTreeView + pageViewScrolledWindow = curlViewScrolledWindow + pageViewHandleKeyAction = curlViewHandleKeyAction + pageViewScrollToTop = curlViewScrollToTop + pageViewScrollToBottom = curlViewScrollToBottom + pageViewScrollVerticalPage = curlViewScrollVerticalPage + pageViewScrollVerticalStep = curlViewScrollVerticalStep + +-- | New. +curlViewNew :: CurlBuffer -> PagePlugId -> IO CurlView +curlViewNew buffer plugId = do + -- Create plug id. + pId <- newTVarIO plugId + + -- Create UI frame. + scrolledWindow <- scrolledWindowNew_ + + -- Tree view. + treeView <- treeViewNew + treeViewSetEnableTreeLines treeView True + scrolledWindow `containerAdd` treeView + + -- List store. + listStore <- listStoreNew [] + + -- Sort model. + sortModel <- treeModelSortNewWithModel listStore + + -- Channel. + channel <- createViewChannel (curlBufferBroadcastChannel buffer) treeView + + -- Curl view. + let curlView = CurlView pId scrolledWindow buffer treeView listStore sortModel channel + + -- Read channel. + curlViewListenChannel curlView + + -- Draw view. + curlViewDraw curlView + + return curlView + +-- | Listen broadcast channel for draw view synchronous. +curlViewListenChannel :: CurlView -> IO () +curlViewListenChannel view = + listenViewChannel (curlViewBroadcastChannel view) $ \ signal -> + case signal of + AddDownload downloadFile -> do + listStoreAppend (curlViewListStore view) downloadFile + return () + UpdateStatus -> + widgetQueueDraw (curlViewTreeView view) + DeleteDownload url -> do + list <- listStoreToList (curlViewListStore view) + findIndex (\x -> dfURL x == url) list ?>= \ i -> + listStoreRemove (curlViewListStore view) i + +-- | Draw curl view. +curlViewDraw :: CurlView -> IO () +curlViewDraw view = do + -- Get value. + let buffer = curlViewBuffer view + fileInfos <- readTVarIO $ curlBufferFileInfos buffer + let treeView = curlViewTreeView view + store = curlViewListStore view + model = curlViewSortModel view + + -- Append to list store. + listStoreClear store + forM_ fileInfos (listStoreAppend store) + + -- Set tree view model. + treeViewSetModel treeView model + + -- Clean tree view. + treeViewRemoveColumns treeView + + -- Add status icon column. + curlViewAddStatusIconColumn treeView store (curlBufferDownloadStatusPixbuf buffer) + + -- Add type icon column. + curlViewAddTypeIconColumn treeView store (curlBufferIconPixbufDatabase buffer) + + -- Get option index. + let options = curlBufferFileInfoOptions buffer + splitIndex = + case findIndex (\x -> fst x == DFSize) options of + Just i -> i + 1 + Nothing -> length options + (leftOptions, rightOptions) = splitAt splitIndex options + -- Add column at left of progress. + forM_ leftOptions (curlViewAddColumn treeView store model) + -- Add progress column. + curlViewAddProgressColumn treeView store + -- Add column at right of progress. + forM_ rightOptions (curlViewAddColumn treeView store model) + + -- Sort column. + sortStatus <- readTVarIO $ curlBufferSortStatus buffer + curlViewSortInternal view sortStatus + + return () + +-- | Add type icon. +curlViewAddStatusIconColumn :: TreeViewClass tv => tv -> ListStore DownloadFile -> DownloadStatusPixbuf -> IO () +curlViewAddStatusIconColumn treeView store + (DownloadStatusPixbuf {dspPause = pausePixbuf + ,dspRunning = runningPixbuf + ,dspFinish = finishPixbuf + ,dspFailed = failedPixbuf}) = do + tvc <- treeViewColumnNew + set tvc [treeViewColumnTitle := "Status"] + treeViewAppendColumn treeView tvc + + icon <- cellRendererPixbufNew + treeViewColumnPackStart tvc icon True + cellLayoutSetAttributes tvc icon store $ \DownloadFile {dfDownloadStatus = statusTVar} -> + [cellPixbuf :=> do + status <- readTVarIO statusTVar + return $ case status of + Pause -> pausePixbuf + Running -> runningPixbuf + Finish -> finishPixbuf + Failed -> failedPixbuf] + +-- | Add type icon. +curlViewAddTypeIconColumn :: TreeViewClass tv => tv -> ListStore DownloadFile -> TVar FileIconPixbufDatabase -> IO () +curlViewAddTypeIconColumn treeView store databaseTVar = do + tvc <- treeViewColumnNew + set tvc [treeViewColumnTitle := "Type"] + treeViewAppendColumn treeView tvc + + icon <- cellRendererPixbufNew + treeViewColumnPackStart tvc icon True + cellLayoutSetAttributes tvc icon store $ \DownloadFile {dfName = nameTVar} -> + [cellPixbuf :=> do + name <- readTVarIO nameTVar + (_, fMime) <- contentTypeGuess name "" 0 + modifyTVarIOM databaseTVar (updateFileIconPixbufDatabaseWithFilePath name) + database <- readTVarIO databaseTVar + let (_, pixbuf) = maybeError (findMinMatch database (\ mime _ -> mime == fMime)) + ("curlViewAddTypeIconColumn: can't find pixbuf match in database : " ++ show fMime) + return pixbuf] + +-- | Add progress. +curlViewAddProgressColumn :: TreeViewClass tv => tv -> ListStore DownloadFile -> IO () +curlViewAddProgressColumn treeView store = do + tvc <- treeViewColumnNew + set tvc [treeViewColumnTitle := "Progress" + ,treeViewColumnMinWidth := 100] + treeViewAppendColumn treeView tvc + + progress <- cellRendererProgressNew + treeViewColumnPackStart tvc progress True + cellLayoutSetAttributes tvc progress store $ \DownloadFile {dfProgress = progressTVar} -> + [cellProgressValue :=> do + progressValue <- readTVarIO progressTVar + return $ floor progressValue + ,cellProgressText :=> do + progressValue <- readTVarIO progressTVar + return $ Just (printf "%.2f" progressValue ++ " %")] + +-- | Add column. +curlViewAddColumn :: (CurlFileInfoClass t, + TreeViewClass self1, + TreeModelClass self, + TreeModelSortClass self, + TypedTreeModelClass model, + TreeSortableClass self) => + self1 + -> model DownloadFile + -> self + -> (t, SortColumnId) + -> IO () +curlViewAddColumn treeView model sortModel option@(info,sortId) = do + curlViewSetSortFunc model sortModel option + + let name = getColumnTitle info + tvc <- treeViewAddColumnWithTitle treeView name sortId + getCellMinWidth info + ?>= \width -> set tvc [treeViewColumnMinWidth := width] + + cell <- cellRendererTextNew + treeViewColumnPackStart tvc cell True + + curlViewSetCellText tvc cell model sortModel info + +-- | Set sort function. +curlViewSetSortFunc :: (TreeSortableClass self, + TypedTreeModelClass model, + CurlFileInfoClass a) => + model DownloadFile + -> self + -> (a, SortColumnId) + -> IO () +curlViewSetSortFunc model sortModel (info, sortId) = + treeSortableSetSortFunc sortModel sortId $ \iter1 iter2 -> do + row1 <- treeModelGetRow model iter1 + row2 <- treeModelGetRow model iter2 + compareRow info row1 row2 + +-- | Set cell text. +curlViewSetCellText :: (CellLayoutClass self, + CellRendererTextClass cell, + TreeModelClass model, + TreeModelSortClass model, + TypedTreeModelClass model1, + CurlFileInfoClass a) => + self + -> cell + -> model1 DownloadFile + -> model + -> a + -> IO () +curlViewSetCellText tvc cell model sortModel info = + cellLayoutSetAttributeFunc tvc cell sortModel $ \iter -> do + row <- treeModelSortGetRow model sortModel iter + set cell [cellText :=> getCellText info row + ,cellXAlign := getCellXAlign info] + +-- | Internal sort function. +curlViewSortInternal :: CurlView -> (DownloadFileOption, SortType) -> IO () +curlViewSortInternal view (option, sortType) = do + let options = curlBufferFileInfoOptions $ curlViewBuffer view + lookup option options ?>= \x -> + treeSortableSetSortColumnId (curlViewSortModel view) x sortType + +-- | Begin. +curlViewScrollToTop :: CurlView -> IO () +curlViewScrollToTop = + treeViewFocusFirstToplevelNode . curlViewTreeView + +-- | End. +curlViewScrollToBottom :: CurlView -> IO () +curlViewScrollToBottom = + treeViewFocusLastToplevelNode . curlViewTreeView + +-- | Scroll page vertically. +curlViewScrollVerticalPage :: Bool -> CurlView -> IO () +curlViewScrollVerticalPage isDown a = do + let sw = curlViewScrolledWindow a + tv = curlViewTreeView a + pageInc <- (<=<) adjustmentGetPageIncrement scrolledWindowGetVAdjustment sw + treeViewScrollVertical tv sw (if isDown then pageInc else (- pageInc)) + +-- | Scroll step vertically. +curlViewScrollVerticalStep :: Bool -> CurlView -> IO () +curlViewScrollVerticalStep isDown a = do + let sw = curlViewScrolledWindow a + tv = curlViewTreeView a + stepInc <- (<<<=) i2d treeViewGetSelectedCellHeight tv + treeViewScrollVertical tv sw (if isDown then stepInc else (- stepInc)) + +-- | Handle key action. +curlViewHandleKeyAction :: CurlView -> Text -> SerializedEvent -> IO () +curlViewHandleKeyAction view keystoke sEvent = + case M.lookup keystoke curlViewKeymap of + Just action -> action view + Nothing -> widgetPropagateEvent (curlViewTreeView view) sEvent + +-- | Next node. +curlViewNextNode :: CurlView -> IO () +curlViewNextNode = treeViewFocusNextToplevelNode . curlViewTreeView + +-- | Previous node. +curlViewPrevNode :: CurlView -> IO () +curlViewPrevNode = treeViewFocusPrevToplevelNode . curlViewTreeView + +-- | Sort column. +curlViewSort :: CurlView -> DownloadFileOption -> IO () +curlViewSort view option = do + -- Get model and options. + let model = curlViewSortModel view + buffer = curlViewBuffer view + options = curlBufferFileInfoOptions buffer + -- Get current sortType and columnId. + (curSortType, _, curSortColumnId) <- treeSortableGetSortColumnId model + lookup option options ?>= \id -> do + treeSortableSetSortColumnId model id $ + if id == curSortColumnId + -- Just change sort order when sort column id is same. + then + -- Just change sort order. + case curSortType of + SortAscending -> SortDescending + SortDescending -> SortAscending + -- Otherwise sort ascending. + else SortAscending + + -- Get new sort type. + (newSortType, _, _) <- treeSortableGetSortColumnId model + + -- Update sort status of buffer. + writeTVarIO (curlBufferSortStatus $ curlViewBuffer view) (option, newSortType) + + -- Focus to cell. + treeViewFocus (curlViewTreeView view) + +-- | Sort by name. +curlViewSortByName :: CurlView -> IO () +curlViewSortByName view = curlViewSort view DFName + +-- | Sort by size. +curlViewSortBySize :: CurlView -> IO () +curlViewSortBySize view = curlViewSort view DFSize + +-- | Sort by download size. +curlViewSortByDownloadSize :: CurlView -> IO () +curlViewSortByDownloadSize view = curlViewSort view DFDownloadSize + +-- | Sort by rest size. +curlViewSortByRestSize :: CurlView -> IO () +curlViewSortByRestSize view = curlViewSort view DFRestSize + +-- | Sort by speed. +curlViewSortBySpeed :: CurlView -> IO () +curlViewSortBySpeed view = curlViewSort view DFSpeed + +-- | Sort by rest time. +curlViewSortByRestTime :: CurlView -> IO () +curlViewSortByRestTime view = curlViewSort view DFRestTime + +-- | Sort by thread number. +curlViewSortByThread :: CurlView -> IO () +curlViewSortByThread view = curlViewSort view DFThread + +-- | Sort by URL. +curlViewSortByUrl :: CurlView -> IO () +curlViewSortByUrl view = curlViewSort view DFURL + +-- | Add download. +curlViewAddDownload :: CurlView -> IO () +curlViewAddDownload view@(CurlView {curlViewBuffer = buffer}) = + localInteractive view "sURL : " $ \ [url] -> do + files <- readTVarIO $ curlBufferFileInfos buffer + if url `elem` map dfURL files + then pageViewUpdateOutputStatus view ("Has exist " ++ url) Nothing + else curlBufferAddDownload buffer url + +-- | Pause +curlViewPause :: CurlView -> IO () +curlViewPause view = + treeViewGetSelectedValue (curlViewTreeView view) + (curlViewSortModel view) + (curlViewListStore view) + >?>= curlBufferPause + +-- | Pause all. +curlViewPauseAll :: CurlView -> IO () +curlViewPauseAll view = + listStoreToList (curlViewListStore view) + >>= \list -> forM_ list curlBufferPause + +-- | Continue. +curlViewContinue :: CurlView -> IO () +curlViewContinue view@(CurlView {curlViewBuffer = buffer}) = + treeViewGetSelectedValue (curlViewTreeView view) + (curlViewSortModel view) + (curlViewListStore view) + >?>= curlBufferContinue buffer + +-- | Continue all. +curlViewContinueAll :: CurlView -> IO () +curlViewContinueAll view@(CurlView {curlViewBuffer = buffer}) = + listStoreToList (curlViewListStore view) + >>= \list -> forM_ list (curlBufferContinue buffer) + +-- | Delete download. +curlViewDeleteDownload :: CurlView -> IO () +curlViewDeleteDownload view@(CurlView {curlViewBuffer = buffer}) = + treeViewGetSelectedValue (curlViewTreeView view) + (curlViewSortModel view) + (curlViewListStore view) + >?>= curlBufferDeleteDownload buffer + +-- | Jump to file. +curlViewJumpToFile :: CurlView -> IO () +curlViewJumpToFile view = + treeViewGetSelectedValue (curlViewTreeView view) + (curlViewSortModel view) + (curlViewListStore view) + >?>= \ downloadFile -> do + downloadStatus <- readTVarIO (dfDownloadStatus downloadFile) + case downloadStatus of + Failed -> pageViewUpdateOutputStatus view "No file." Nothing + Finish -> do + downloadDir <- fmap ( defaultDownloadDir) getConfigDirectory + mkDaemonSignal (pageViewClient view) NewTab (NewTabArgs "PageFileManager" downloadDir []) + _ -> do + cacheDir <- fmap ( defaultCacheDir) getConfigDirectory + mkDaemonSignal (pageViewClient view) NewTab (NewTabArgs "PageFileManager" cacheDir []) + +-- | Open file. +curlViewOpenFile :: CurlView -> IO () +curlViewOpenFile view = + treeViewGetSelectedValue (curlViewTreeView view) + (curlViewSortModel view) + (curlViewListStore view) + >?>= \ downloadFile -> do + downloadStatus <- readTVarIO (dfDownloadStatus downloadFile) + if downloadStatus == Finish + -- Just try when file download complete. + then do + -- Init. + downloadDir <- fmap ( defaultDownloadDir) getConfigDirectory + name <- readTVarIO (dfName downloadFile) + let filePath = downloadDir name + isExist <- doesFileExist filePath + + if isExist + -- Try open file. + then do + (_, fileType) <- contentTypeGuess filePath "" 0 + openRule <- fileOpenRule filePath fileType + if null openRule + then pageViewUpdateOutputStatus view ("Don't know how to open file : " ++ filePath) Nothing + else do + let rule = snd $ head openRule -- use default open rule. + rule (pageViewClient view) + -- Otherwise print information. + else pageViewUpdateOutputStatus view ("Can't find " ++ filePath) Nothing + -- Otherwise print information. + else pageViewUpdateOutputStatus view "Haven't download complete." Nothing + +-- | Keymap. +curlViewKeymap :: Map Text (CurlView -> IO ()) +curlViewKeymap = + M.fromList + [("j", curlViewNextNode) + ,("k", curlViewPrevNode) + ,("Down", curlViewNextNode) + ,("Up", curlViewPrevNode) + ,("J", curlViewScrollToBottom) + ,("K", curlViewScrollToTop) + ,(" ", curlViewScrollVerticalPage True) + ,("b", curlViewScrollVerticalPage False) + ,("PageDown", curlViewScrollVerticalPage True) + ,("PageUp", curlViewScrollVerticalPage False) + ,("a", curlViewAddDownload) + ,("d", curlViewDeleteDownload) + ,("p", curlViewPause) + ,("P", curlViewPauseAll) + ,("n", curlViewContinue) + ,("N", curlViewContinueAll) + ,("f", curlViewJumpToFile) + ,("m", curlViewOpenFile) + ,("3", curlViewSortByName) + ,("4", curlViewSortBySize) + ,("6", curlViewSortBySpeed) + ,("7", curlViewSortByRestTime) + ,("8", curlViewSortByThread) + ,("9", curlViewSortByUrl) + ,("t", curlViewTest) + ] + +curlViewTest :: CurlView -> IO () +curlViewTest view@(CurlView {curlViewBuffer = buffer}) = do + let urls = ["http://3c.media.v4.skyrock.net/music/3c2/316/3c2316b00657d412725ce07c1c7a3900.mp3"] + forM_ urls $ \ url -> do + files <- readTVarIO $ curlBufferFileInfos buffer + if url `elem` map dfURL files + then pageViewUpdateOutputStatus view ("Has exist " ++ url) Nothing + else curlBufferAddDownload buffer url + + diff --git a/Manatee/Extension/Curl/PageMode.hs b/Manatee/Extension/Curl/PageMode.hs new file mode 100644 --- /dev/null +++ b/Manatee/Extension/Curl/PageMode.hs @@ -0,0 +1,32 @@ +-- Author: Andy Stewart +-- Maintainer: Andy Stewart +-- +-- Copyright (C) 2010 Andy Stewart, all rights reserved. +-- +-- This program is free software: you can redistribute it and/or modify +-- it under the terms of the GNU General Public License as published by +-- the Free Software Foundation, either version 3 of the License, or +-- any later version. +-- +-- This program is distributed in the hope that it will be useful, +-- but WITHOUT ANY WARRANTY; without even the implied warranty of +-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +-- GNU General Public License for more details. +-- +-- You should have received a copy of the GNU General Public License +-- along with this program. If not, see . + +module Manatee.Extension.Curl.PageMode where + +import Manatee.Core.Types + +import qualified Data.Map as M + +-- | Curl. +curlMode :: PageMode +curlMode = + PageMode {pageModeName = "Curl" + ,pageModeRegexp = "" + ,pageModeKeymap = M.empty + ,pageModeLoad = \_ -> return ()} + diff --git a/Manatee/Extension/Curl/Types.hs b/Manatee/Extension/Curl/Types.hs new file mode 100644 --- /dev/null +++ b/Manatee/Extension/Curl/Types.hs @@ -0,0 +1,104 @@ +-- Author: Andy Stewart +-- Maintainer: Andy Stewart +-- +-- Copyright (C) 2010 Andy Stewart, all rights reserved. +-- +-- This program is free software: you can redistribute it and/or modify +-- it under the terms of the GNU General Public License as published by +-- the Free Software Foundation, either version 3 of the License, or +-- any later version. +-- +-- This program is distributed in the hope that it will be useful, +-- but WITHOUT ANY WARRANTY; without even the implied warranty of +-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +-- GNU General Public License for more details. +-- +-- You should have received a copy of the GNU General Public License +-- along with this program. If not, see . + +{-# LANGUAGE ScopedTypeVariables, DeriveDataTypeable #-} +{-# LANGUAGE TemplateHaskell #-} +module Manatee.Extension.Curl.Types where + +import Control.Concurrent +import Control.Concurrent.STM +import Data.Binary +import Data.DeriveTH +import Data.Function +import Data.Map (Map) +import Data.Ord +import Data.Typeable +import Foreign +import Graphics.UI.Gtk.Gdk.Pixbuf + +data DownloadFile = + DownloadFile {dfURL :: String + ,dfName :: TVar String + ,dfSize :: TVar Int -- bytes + ,dfProgress :: TVar Double + ,dfSpeed :: TVar Int + ,dfRestTime :: TVar Int -- second + ,dfBuffers :: TVar [DownloadBuffer] + ,dfFinishLock :: MVar DownloadResult + ,dfDownloadStatus :: TVar DownloadStatus + ,dfFlushCounter :: TVar Int -- for debug + } + +data DownloadBuffer = + DownloadBuffer {dbIndex :: Int + ,dbRange :: (Int, Int) + ,dbThreadId :: TVar (Maybe ThreadId) + ,dbDownloadOffset :: Int -- keep pause position + ,dbDownloadSize :: TVar Int -- bytes + ,dbCacheSize :: TVar Int -- bytes + ,dbRecordSize :: TVar Int -- for calculate download speed + ,dbIsFinish :: TVar Bool + } + +data DownloadStatus = Running + | Pause + | Finish + | Failed + deriving (Eq, Show, Read) + +data DownloadResult = DownloadPause + | DownloadError String + | DownloadFinish + deriving (Eq, Show, Read) + +data DownloadLog = + DownloadLog {dlURL :: String + ,dlName :: String + ,dlSize :: Int + ,dlBuffers :: Map Int DownloadLogBuffer + } deriving (Show, Read, Eq, Ord, Typeable) + +data DownloadLogBuffer = + DownloadLogBuffer {dlbRange :: (Int, Int) + ,dlbCacheSize :: Int -- bytes + ,dlbIsFinish :: Bool + } deriving (Show, Read, Eq, Ord, Typeable) + +data DownloadStatusPixbuf = + DownloadStatusPixbuf {dspPause :: Pixbuf + ,dspRunning :: Pixbuf + ,dspFinish :: Pixbuf + ,dspFailed :: Pixbuf} + +instance Show DownloadFile where + show = dfURL + +instance Eq DownloadFile where + (==) = (==) `on` dfURL + +instance Ord DownloadFile where + compare = comparing dfURL + +data BufferCache = BufferCache !(Ptr Word8) !Int + +data DownloadFileOption = DFName | DFSize | DFDownloadSize | DFRestSize + | DFSpeed | DFRestTime | DFThread | DFURL + deriving (Eq, Show, Read) + +$(derive makeBinary ''DownloadLogBuffer) +$(derive makeBinary ''DownloadLog) diff --git a/Setup.hs b/Setup.hs new file mode 100644 --- /dev/null +++ b/Setup.hs @@ -0,0 +1,43 @@ +-- Author: Andy Stewart +-- Maintainer: Andy Stewart +-- +-- Copyright (C) 2010 Andy Stewart, all rights reserved. +-- +-- This program is free software: you can redistribute it and/or modify +-- it under the terms of the GNU General Public License as published by +-- the Free Software Foundation, either version 3 of the License, or +-- any later version. +-- +-- This program is distributed in the hope that it will be useful, +-- but WITHOUT ANY WARRANTY; without even the implied warranty of +-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +-- GNU General Public License for more details. +-- +-- You should have received a copy of the GNU General Public License +-- along with this program. If not, see . + +import Distribution.Simple +import Manatee.Core.Config +import Manatee.Core.Types +import Manatee.Toolkit.General.List +import Manatee.Toolkit.General.Map +import Manatee.Extension.Curl.PageMode + +import qualified Data.Map as M + +main = defaultMainWithHooks + simpleUserHooks { + -- Update Rule after install successful. + postInst = \ _ _ _ _ -> do + -- Update PageTypeRule. + (PageTypeRule typeRule) <- readConfig pageTypeRulePath (PageTypeRule M.empty) + writeConfig pageTypeRulePath (PageTypeRule (M.insert "PageCurl" "manatee-curl" typeRule)) + -- Update PageModeRule. + (PageModeRule modeRule) <- readConfig pageModeRulePath (PageModeRule M.empty) + writeConfig pageModeRulePath (PageModeRule + (M.insert "PageCurl" (Left $ pageModeName curlMode) modeRule)) + -- Update ExtensionGloalKeymap. + (ExtensionGloalKeymap keymap) <- readConfig extensionGlobalKeymapPath (ExtensionGloalKeymap M.empty) + writeConfig extensionGlobalKeymapPath (ExtensionGloalKeymap + (M.insert "F8" ("PageCurl", "Download", []) keymap)) + } diff --git a/manatee-curl.cabal b/manatee-curl.cabal new file mode 100644 --- /dev/null +++ b/manatee-curl.cabal @@ -0,0 +1,49 @@ +name: manatee-curl +version: 0.0.3 +Cabal-Version: >= 1.6 +license: GPL-3 +license-file: LICENSE +copyright: (c) 2009 ~ 2010 Andy Stewart +synopsis: Download Manager extension for Manatee. +description: manatee-curl is multithreads download manager extension for Manatee (Haskell/Gtk+ Integrated Live Environment) + . + Manual look + . + Screenshot at + . + IRC channel: + . + irc.freenode.net 6667 <##manatee> + . +author: Andy Stewart +maintainer: Andy Stewart +stability: provisional +category: Manatee, Download Manager, Network + +tested-with: GHC==6.12.3 +build-type: Custom + +Source-Repository head + type: darcs + location: http://patch-tag.com/r/AndyStewart/manatee-curl + +Library + build-depends: base >= 4 && < 5, manatee-core >= 0.0.3, dbus-client >= 0.3 && < 0.4, stm >= 2.1.2.0, + containers >= 0.3.0.0, gtk-serialized-event >= 0.12.0, gtk >= 0.12.0, + text >= 0.7.1.0, mtl >= 1.1.0.2, old-time, old-locale, glib >= 0.12.0, gio >= 0.12.0, + filepath >= 1.1.0.3, utf8-string >= 0.3.4, bytestring, network, curl >= 1.3.5, directory, + template-haskell, derive, binary, regex-tdfa + exposed-modules: + Manatee.Extension.Curl + Manatee.Extension.Curl.PageMode + Manatee.Extension.Curl.CurlBuffer + Manatee.Extension.Curl.CurlView + Manatee.Extension.Curl.Types + other-modules: + extensions: + ghc-options: -fwarn-unused-matches -fwarn-unused-binds -fwarn-unused-imports -fwarn-overlapping-patterns -fwarn-duplicate-exports -fwarn-unrecognised-pragmas -fwarn-hi-shadowing + +Executable manatee-curl + main-is: Main.hs + + ghc-options: -threaded