zim-parser (empty) → 0.1.0.0
raw patch · 7 files changed
+1443/−0 lines, 7 filesdep +arraydep +basedep +binarysetup-changedbinary-added
Dependencies added: array, base, binary, binary-conduit, bytestring, conduit, conduit-extra, hspec, lzma-conduit, resourcet
Files
- LICENSE +675/−0
- Setup.hs +2/−0
- src/Codec/Archive/Zim/Parser.hs +540/−0
- test/Codec/Archive/Zim/ParserSpec.hs +156/−0
- test/Spec.hs +1/−0
- test/wikipedia_en_ray_charles_2015-06.zim binary
- zim-parser.cabal +69/−0
+ LICENSE view
@@ -0,0 +1,675 @@+ GNU GENERAL PUBLIC LICENSE+ Version 3, 29 June 2007++ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>+ 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.++ {one line to give the program's name and a brief idea of what it does.}+ Copyright (C) {year} {name of author}++ 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 <http://www.gnu.org/licenses/>.++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:++ {project} Copyright (C) {year} {fullname}+ 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+<http://www.gnu.org/licenses/>.++ 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+<http://www.gnu.org/philosophy/why-not-lgpl.html>.+
+ Setup.hs view
@@ -0,0 +1,2 @@+import Distribution.Simple+main = defaultMain
+ src/Codec/Archive/Zim/Parser.hs view
@@ -0,0 +1,540 @@+-- | Module : Codec.Archive.Zim.Parser+-- Description : API for parsing ZIM files+-- Copyright : (c) Robbin C.+-- License : GPLv3+-- Maintainer : Robbin C.+-- Stability : unstable+-- Portability : portable+--+-- This is a library for parsing ZIM (<http://openzim.org>) files. ZIM files+-- contain offline web content (eg, Wikipedia) which can be browsed locally+-- without an Internet connection.+--+-- The high-level functions can be used if it is not a problem to re-open and close+-- the ZIM file on each invocation. For simple browsing on a local device, this+-- should suffice. This also works if the underlying ZIM file is changing.+--+-- The other functions can be used if the caller opts to have more control over+-- resource management.+--+-- Behind the scenes, conduit is used to read from files so memory usage should+-- be constant.+--+-- Below is a full example of a Scotty web server that serves a ZIM file+-- (specified on command line) on localhost port 3000:+--+-- > {-# LANGUAGE OverloadedStrings #-}+-- >+-- > import Control.Monad.IO.Class (liftIO)+-- > import Data.Text.Lazy (toStrict, fromStrict)+-- > import Data.Text.Encoding (decodeUtf8, encodeUtf8)+-- > import System.Environment (getArgs)+-- > import Network.HTTP.Types.Status (status404)+-- > import Web.Scotty+-- > import Codec.Archive.Zim.Parser (getZimMainPageUrl, getZimUrlContent)+-- >+-- > main :: IO ()+-- > main = do+-- > [fp] <- getArgs+-- > scotty 3000 $ do+-- > get "/" (redirectToZimMainPage fp)+-- > get (regex "^/(./.*)$") (serveZimUrl fp)+-- > notFound $ text "Invalid URL!"+-- >+-- > redirectToZimMainPage :: FilePath -> ActionM ()+-- > redirectToZimMainPage fp = do+-- > res <- liftIO $ getZimMainPageUrl fp+-- > case res of+-- > Nothing -> do+-- > status status404+-- > text "This ZIM file has no main page specified!"+-- > Just url -> redirect . fromStrict $ decodeUtf8 url+-- >+-- > serveZimUrl :: FilePath -> ActionM ()+-- > serveZimUrl fp = do+-- > url <- (encodeUtf8 . toStrict) <$> param "1"+-- > res <- liftIO $ getZimUrlContent fp url+-- > case res of+-- > Nothing -> do+-- > liftIO . putStrLn $ "Invalid URL: " ++ show url+-- > status status404+-- > text $ "Invalid URL!"+-- > Just (mimeType, content) -> do+-- > liftIO . putStrLn $ "Serving: " ++ show url+-- > setHeader "Content-Type" (fromStrict $ decodeUtf8 mimeType)+-- > raw content+--+-- Feedback and contributions are welcome on <http://github.com/robbinch/zim-parser>.+++{-# LANGUAGE DeriveDataTypeable #-}+module Codec.Archive.Zim.Parser+ (+ -- * High-level Functions+ -- | The following high-level functions are sufficient to program a simple webserver that serves ZIM files (see example above).+ getZimMainPageUrl+ , getZimUrlContent+ -- * Searching+ , searchZimDirEntByUrl+ , searchZimDirEntByTitle+ , searchZimDirEntByTitlePrefix+ -- * Exceptions+ , ZimException(..)+ -- * ZIM Header+ , ZimHeader(..)+ , getZimHeader+ , getZimMimeList+ -- * ZIM Directory Entry+ , ZimDirEntType(..)+ , ZimDirEnt(..)+ , getZimDirEntByUrlIndex+ , getZimDirEntByTitleIndex+ -- * ZIM Content+ , getZimCluster+ , getZimBlob+ , getZimContentByUrlIndex+ -- * ZIM file format+ -- | Following is a short summary of the ZIM file format.+ -- The authoritative reference is at http://www.openzim.org/wiki/ZIM_file_format.+ --+ -- === 1. ZIM header+ -- This is an 80-byte header (see 'ZimHeader'). Among other things, it contains file offsets to the below.+ --+ -- === 2. List of MIME types+ -- This is a sequence of null-terminated strings (eg. @text\/html@, @text\/javascript@). The last string is zero length, so+ -- the end always consists of 2 consecutive null bytes.+ --+ -- === 3. List of URLs+ -- This is a sequence of 8-byte file offsets, each pointing to a directory entry. This list is sorted by the directory entries' URL.+ --+ -- 'getZimDirEntByUrlIndex' looks up this table to return a directory entry.+ --+ -- === 4. List of Titles+ -- This is a sequence of 4-byte indices, each pointing to a URL above (which in turn point to a directory entry).+ -- This list is sorted by the directory entries' Title.+ --+ -- 'getZimDirEntByTitleIndex' uses this table to return a directory entry.+ --+ -- === 5. Directory Entries+ -- This is a sequence of Directory Entries (see 'ZimDirEnt').+ -- The first 2 bytes determine the type of this entry, which also determine the length.+ -- Contents include:+ --+ -- ==== a. MIME type+ -- This 2-byte field means:+ --+ -- [@0xffff@] This directory entry is a 'ZimRedirectEntry'.+ -- [@0xfffe@] This directory entry is a 'ZimLinkTarget'.+ -- [@0xfffd@] This directory entry is a 'ZimDeletedEntry'.+ -- [@any other value@] This directory entry is a 'ZimArticleEntry' and this index into the MIME list from above determines its MIME type.+ --+ -- ==== b. Namespace+ -- This single character determines the directory entry's namespace. (eg. __A__ for articles, __I__ for images, etc.)+ -- The comprehensive list is at http://www.openzim.org/wiki/ZIM_file_format#Namespaces.+ --+ -- ==== c. Cluster and Blob number+ -- Only for 'ZimArticleEntry', this is the directory entry's Cluster and Blob number.+ -- The Cluster number is a 4-byte index into the list of Clusters below.+ -- The Blob number refers to a block inside the (decompressed) cluster.+ -- Together, they provide the content of this directory entry.+ --+ -- ==== d. URL and Title+ -- These 2 null-terminated strings represent the URL and Title of this directory entry respectively.+ -- If the Title is empty, it is taken to be the same as the URL.+ --+ -- === 6. List of Clusters+ -- This is a list of 8-byte file offsets, each pointing to a cluster in the file.+ -- The end of a cluster is also the start of the next cluster.+ -- Therefore, the length of a cluster is the difference between the adjacent offsets.+ -- For the last cluster, the end is the Checksum file offset, as the Checksum is always+ -- the last 16 bytes of a ZIM file.+ --+ -- ==== a. Compression Type+ -- The first byte of the cluster determines if it is uncompressed (eg. PNG image) or compressed with LZMA (eg. HTML).+ --+ -- [@0 or 1@] No compression+ -- [@4@] Compressed with LZMA+ --+ -- ==== b. List of Blobs+ -- This is a list of 4-byte offsets, each pointing inside this cluster.+ -- The end of a blob is also the start of the next blob.+ -- Therefore, the length of a blob is the difference between the adjacent offsets.+ -- The last offset points to the end of the data area so there is always one more offset than blobs.+ ) where++import Control.Applicative ((<$>), (<*>))+import Control.Exception (Exception, throw)+import Control.Monad (when)+import Data.Char (chr)+import Data.Maybe (fromJust)+import Data.Typeable (Typeable)+import qualified Data.ByteString as B+import qualified Data.ByteString.Char8 as B8+import qualified Data.ByteString.Lazy as BL+import System.IO (Handle, IOMode(ReadMode), withBinaryFile)++import Data.Conduit (($$), (=$), await, Sink)+import Control.Monad.Trans.Resource (runResourceT)+import Data.Conduit.Binary (sourceHandleRange, sourceLbs, sinkLbs)+import Data.Conduit.Serialization.Binary (sinkGet, conduitGet)+import Data.Conduit.Lzma (decompress)++import Data.Array.IArray ((!), listArray, Array)+import Data.Binary.Get (Get, skip, getWord8, getWord16le, getWord32le, getWord64le, getByteString, getLazyByteStringNul, getRemainingLazyByteString)+import Numeric (showHex)++-- | Other than the below, ErrorCall can be thrown by LZMA library if there is a problem with decompression.+data ZimException = ZimInvalidMagic -- ^ ZIM file has invalid magic number (anything other than 72173914).+ | ZimParseError String -- ^ There is an error in parsing.+ | ZimIncompleteInput -- ^ There is insufficient bytes required to parse.+ | ZimInvalidIndex Int -- ^ The given index (URL, title or cluster) is out of bounds for this ZIM file.+ deriving (Show, Typeable)+instance Exception ZimException++-- | See http://www.openzim.org/wiki/ZIM_file_format#Header for more details.+data ZimHeader = ZimHeader+ {+ -- | Magic Number of file (somewhat superfluous as 'getZimHeader' will throw an exception if magic number is anything other than 72173914)+ zimMagicNumber :: Int+ -- | Version of ZIM header+ , zimVersion :: Int+ -- | UUID of file+ , zimUuid :: B.ByteString+ -- | Number of articles+ , zimArticleCount :: Int+ -- | Number of clusters+ , zimClusterCount :: Int+ -- | Position of sorted URL pointers+ , zimUrlPtrPos :: Integer+ -- | Position of sorted Title pointers+ , zimTitlePtrPos :: Integer+ -- | Position of Cluster pointers+ , zimClusterPtrPos :: Integer+ -- | Position of MIME list+ , zimMimeListPos :: Integer+ -- | Index of main page+ , zimMainPage :: Maybe Int+ -- | Index of layout page+ , zimLayoutPage :: Maybe Int+ -- | Position of MD5 checksum+ , zimChecksumPos :: Integer+ } deriving (Show, Eq)++-- | There are 4 types of directory entries. Most content in a ZIM file are+-- usually 'ZimArticleEntry' or 'ZimRedirectEntry'.+data ZimDirEntType = ZimArticleEntry+ | ZimRedirectEntry+ | ZimLinkTarget+ | ZimDeletedEntry+ deriving (Eq, Show)++-- | See http://www.openzim.org/wiki/ZIM_file_format#Directory_Entries for more details.+data ZimDirEnt = ZimDirEnt+ {+ -- | Type of this Directory Entry+ zimDeType :: ZimDirEntType+ -- | Index into MIME list given by 'getZimMimeList'+ , zimDeMimeType :: Int+ -- | Parameter Length+ , zimDeParameterLen :: Int+ -- | Namespace+ , zimDeNamespace :: Char+ -- | Revision+ , zimDeRevision :: Int+ -- | Redirect Index (only applicable for 'ZimRedirectEntry')+ , zimDeRedirectIndex :: Maybe Int+ -- | Content is stored in this Cluster Number (only applicable for 'ZimArticleEntry')+ , zimDeClusterNumber :: Maybe Int+ -- | Content is stored in this Blob Number (only applicable for 'ZimArticleEntry')+ , zimDeBlobNumber :: Maybe Int+ -- | URL+ , zimDeUrl :: B8.ByteString+ -- | Title+ , zimDeTitle :: B8.ByteString+ -- , zimDeParameter :: BL.ByteString -- unused+ } deriving (Eq, Show)++-- | Parses ZIM Header from a file handle.+-- A ZIM Header is used by most of the functions in this module.+-- For better performance or resource management, multiple file handles+-- can be opened with the same ZIM header in order to call+-- functions in parallel.+-- If the underlying ZIM file has changed, a new ZIM header should be parsed.+getZimHeader :: Handle -- ^ Handle to ZIM file (eg. previously returned from 'withBinaryFile')+ -> IO ZimHeader -- ^ Returns ZIM Header+getZimHeader hdl = src $$ sinkGet parseZimHeader+ where (pos, len) = (Just 0, Just 80)+ src = sourceHandleRange hdl pos len++parseZimHeader :: Get ZimHeader+parseZimHeader = do+ magicNumber <- fromIntegral <$> getWord32le+ when (magicNumber /= 72173914) $ throw ZimInvalidMagic+ version <- fromIntegral <$> getWord32le+ uuid <- getByteString 16+ articleCount <- fromIntegral <$> getWord32le+ clusterCount <- fromIntegral <$> getWord32le+ urlPtrPos <- fromIntegral <$> getWord64le+ titlePtrPos <- fromIntegral <$> getWord64le+ clusterPtrPos <- fromIntegral <$> getWord64le+ mimeListPos <- fromIntegral <$> getWord64le+ mainPage <- fromIntegral <$> getWord32le+ layoutPage <- fromIntegral <$> getWord32le+ checksumPos <- fromIntegral <$> getWord64le+ return $ ZimHeader magicNumber version uuid articleCount clusterCount+ urlPtrPos titlePtrPos clusterPtrPos mimeListPos+ (if mainPage == 0xffffffff then Nothing else Just mainPage)+ (if layoutPage == 0xffffffff then Nothing else Just layoutPage)+ checksumPos++-- | Parses MIME List from a ZIM header and a file handle.+getZimMimeList :: ZimHeader -- ^ ZIM header+ -> Handle -- ^ Handle to ZIM file+ -> IO (Array Int B8.ByteString) -- ^ Returns array of MIME types+getZimMimeList hdr hdl = do+ mimeList <- src $$ parseByteStringsNul+ return $ listArray (0, length mimeList) mimeList+ where (pos, len) = (Just $ zimMimeListPos hdr, Nothing)+ src = sourceHandleRange hdl pos len++-- Parses a list of null-terminated byte sequence.+-- Last entry is zero length (end of block is always 2 null bytes).+parseByteStringsNul :: Sink B8.ByteString IO [B8.ByteString]+parseByteStringsNul = conduitGet getLazyByteStringNul =$ loop id+ where loop :: ([B8.ByteString] -> [B8.ByteString]) -> Sink BL.ByteString IO [B8.ByteString]+ loop front = await >>= maybe+ (return $ front [])+ (\x -> let bs = BL.toStrict x+ in if B8.null bs then return (front []) else loop (front . (bs:))+ )++-- | Returns Directory Entry corresponding to URL index.+getZimDirEntByUrlIndex :: ZimHeader -- ^ ZIM header+ -> Handle -- ^ Handle to ZIM file+ -> Int -- ^ URL index+ -> IO ZimDirEnt -- ^ Returns a Directory Entry+getZimDirEntByUrlIndex hdr hdl i = do+ let urlPtrPos = Just $ zimUrlPtrPos hdr + 8 * fromIntegral i+ when (i < 0 || i >= zimArticleCount hdr) . throw $ ZimInvalidIndex i+ dePos <- sourceHandleRange hdl urlPtrPos Nothing $$ sinkGet getWord64le+ let srcDirEnt = sourceHandleRange hdl (Just $ fromIntegral dePos) Nothing+ srcDirEnt $$ sinkGet parseZimDirEnt++parseZimDirEnt :: Get ZimDirEnt+parseZimDirEnt = do+ mimeType <- fromIntegral <$> getWord16le :: Get Int+ parmLen <- fromIntegral <$> getWord8+ namespace <- chr . fromIntegral <$> getWord8+ revision <- fromIntegral <$> getWord32le++ -- parsing of next 3 fields depends on mimeType+ let deType = case mimeType of+ 0xffff -> ZimRedirectEntry+ 0xfffe -> ZimLinkTarget+ 0xfffd -> ZimDeletedEntry+ _ -> ZimArticleEntry+ (redirectIndex, clusterNumber, blobNumber ) <-+ case deType of+ ZimArticleEntry ->+ (\x y -> (Nothing, Just $ fromIntegral x, Just $ fromIntegral y))+ <$> getWord32le <*> getWord32le+ ZimRedirectEntry ->+ (\x -> (Just $ fromIntegral x, Nothing, Nothing))+ <$> getWord32le+ ZimLinkTarget -> skip 8 >> return (Nothing, Nothing, Nothing)+ ZimDeletedEntry -> skip 8 >> return (Nothing, Nothing, Nothing)+ :: Get (Maybe Int, Maybe Int, Maybe Int)++ url <- BL.toStrict <$> getLazyByteStringNul+ title <- BL.toStrict <$> getLazyByteStringNul+ return $ ZimDirEnt deType mimeType parmLen namespace revision redirectIndex+ clusterNumber blobNumber url+ -- specs: title is same as url if title is empty+ (if B.null title then url else title)++-- | Returns Directory Entry corresponding to Title index.+getZimDirEntByTitleIndex :: ZimHeader -- ^ ZIM header+ -> Handle -- ^ Handle to ZIM file+ -> Int -- ^ Title index+ -> IO ZimDirEnt -- ^ Returns a Directory Entry+getZimDirEntByTitleIndex hdr hdl i = do+ when (i < 0 || i >= zimArticleCount hdr) . throw $ ZimInvalidIndex i+ urlIndex <- srcTitle $$ sinkGet getWord32le+ getZimDirEntByUrlIndex hdr hdl (fromIntegral urlIndex)+ where titlePtrPos = Just $ zimTitlePtrPos hdr + 4 * fromIntegral i+ srcTitle = sourceHandleRange hdl titlePtrPos Nothing++-- | Returns (decompressed) Cluster corresponding to Cluster number.+-- This can throw ErrorCall if there is an error during decompression.+getZimCluster :: ZimHeader -- ^ ZIM header+ -> Handle -- ^ Handle to ZIM file+ -> Int -- ^ Cluster number+ -> IO BL.ByteString -- ^ Returns a lazy bytestring containing cluster+getZimCluster hdr hdl i = do+ let limit = zimClusterCount hdr - 1+ when (i < 0 || i > limit) . throw $ ZimInvalidIndex i+ let clusterPos = Just $ zimClusterPtrPos hdr + 8 * fromIntegral i+ src = sourceHandleRange hdl clusterPos Nothing+ (pos0, pos1) <- src $$ sinkGet $ (,) <$> getWord64le <*> getWord64le+ -- length of last cluster is determined by checksum pos instead of next cluster pos+ let len = if i == limit+ then (fromIntegral $ zimChecksumPos hdr) - pos0+ else pos1 - pos0+ toI = Just . fromIntegral+ srcCluster = sourceHandleRange hdl (toI pos0) (toI len)+ bs <- srcCluster $$ sinkGet getRemainingLazyByteString++ case BL.uncons bs of+ Just (0, cluster) -> return cluster+ Just (1, cluster) -> return cluster+ Just (4, cluster) -> runResourceT $ sourceLbs cluster $$ decompress Nothing =$ sinkLbs+ Just (x, _) -> throw . ZimParseError $+ "Cluster " ++ show i +++ " (offset: " ++ showHex pos0 "" ++ ", length: " ++ show len +++ ") compressed with unsupported type: " ++ show x+ Nothing -> throw . ZimParseError $+ "Insufficient bytes for cluster " ++ show i++-- | Returns Blob given Cluster and Blob number.+getZimBlob :: ZimHeader -- ^ ZIM header+ -> Handle -- ^ Handle to ZIM file+ -> Int -- ^ Cluster Number+ -> Int -- ^ Blob Number+ -> IO BL.ByteString -- ^ Returns a lazy bytestring containing blob+getZimBlob hdr hdl c b = do+ cluster <- getZimCluster hdr hdl c+ let src = sourceLbs (BL.drop (4 * fromIntegral b) cluster)+ (pos0, pos1) <- src $$ sinkGet $ (,) <$> getWord32le <*> getWord32le+ let len = pos1 - pos0+ return . BL.take (fromIntegral len) $ BL.drop (fromIntegral pos0) cluster++-- | Returns content given URL index. Redirects are handled automatically+getZimContentByUrlIndex :: ZimHeader -- ^ ZIM header+ -> Handle -- ^ Handle to ZIM file+ -> Int -- ^ URL index+ -> IO BL.ByteString -- ^ Returns a lazy bytestring containing content+getZimContentByUrlIndex hdr hdl i = do+ de <- getZimDirEntByUrlIndex hdr hdl i+ case zimDeType de of+ ZimRedirectEntry -> getZimContentByUrlIndex hdr hdl (fromJust $ zimDeRedirectIndex de)+ ZimArticleEntry -> let (Just c, Just b) = (zimDeClusterNumber de, zimDeBlobNumber de)+ in getZimBlob hdr hdl c b+ _ -> return BL.empty++-- Binary Search implementation used for searching sorted URL and Title lists.+binarySearch :: (Int -> IO (Ordering, a)) -> Int -> Int -> IO (Maybe a)+binarySearch f low high =+ if high < low+ then return Nothing+ else do+ let mid = (low + high) `div` 2+ (o, x) <- f mid+ case o of+ LT -> binarySearch f low (mid -1)+ GT -> binarySearch f (mid + 1) high+ EQ -> return $ Just x++-- | Search for a Directory Entry given a URL.+-- URL must be prefixed with Namespace (eg. "A\/Blue.html" or "I\/favicon.png").+searchZimDirEntByUrl :: ZimHeader -- ^ ZIM header+ -> Handle -- ^ Handle to ZIM file+ -> B.ByteString -- ^ URL to search for+ -> IO (Maybe (Int, ZimDirEnt)) -- ^ Returns (URL Index, Directory Entry) if found.+searchZimDirEntByUrl hdr hdl url =+ binarySearch f 0 (zimArticleCount hdr - 1)+ -- prepend namespace when comparing URLs+ where f i = do+ de <- getZimDirEntByUrlIndex hdr hdl i+ let v = zimDeNamespace de `B8.cons` '/' `B8.cons` zimDeUrl de+ return (compare url v, (i, de))++-- | Search for a Directory Entry given a Title and namespace.+searchZimDirEntByTitle :: ZimHeader -- ^ ZIM header+ -> Handle -- ^ Handle to ZIM file+ -> Char -- ^ Namespace to search for+ -> B.ByteString -- ^ Title to search for+ -> IO (Maybe (Int, ZimDirEnt)) -- ^ Returns (Title Index, Directory Entry) if found+searchZimDirEntByTitle hdr hdl n title =+ binarySearch f 0 (zimArticleCount hdr - 1)+ where title' = n `B8.cons` '/' `B8.cons` title+ f i = do+ de <- getZimDirEntByTitleIndex hdr hdl i+ let v = zimDeNamespace de `B8.cons` '/' `B8.cons` zimDeTitle de+ return (compare title' v, (i, de))++-- | Search for lower and upper bounds of Title indices that contains prefix in their title.+-- Eg, if title list comprises \[ \"A\", \"Ba\", \"Bb\", \"Bc\", \"C\" \] prefix+-- search for \"B\" will return bounds corresponding to (\"Ba\", \"Bc\").+searchZimDirEntByTitlePrefix :: ZimHeader -- ^ ZIM header+ -> Handle -- ^ Handle to ZIM file+ -> Char -- ^ Namespace+ -> B.ByteString -- ^ Title Prefix+ -> IO (Maybe ((Int, ZimDirEnt), (Int, ZimDirEnt))) -- ^ Returns ((Lower Title Index, Lower Directory Entry), (Upper Title Index, Upper Directory Entry)) if found.+searchZimDirEntByTitlePrefix hdr hdl n pre = do+ lb <- binarySearch lowerBound 0 limit+ case lb of+ Nothing -> return Nothing+ _ -> do+ ub <- binarySearch upperBound 0 limit+ return . Just $ (fromJust lb, fromJust ub)+ where pre' = n `B8.cons` '/' `B8.cons` pre+ preLen = B8.length pre+ limit = zimArticleCount hdr - 1+ -- extracts title to compare from Directory Entry+ mkT x = zimDeNamespace x `B8.cons` '/' `B8.cons` B8.take preLen (zimDeTitle x)+ g idx = (\x -> (x, mkT x)) <$> getZimDirEntByTitleIndex hdr hdl idx+ -- i has to be the entry just before prefix matches+ lowerBound i = do+ de <- getZimDirEntByTitleIndex hdr hdl i+ case compare pre' (mkT de) of+ -- if prefix matches, we still return LT as we want to find the entry BEFORE.+ -- special case: if i = 0, then this is the lower bound.+ EQ -> if i == 0+ then return (EQ, (i, de))+ else return (LT, (i, de))+ lgt -> do+ -- if succeeding entry has prefix, that is the lower bound.+ (de', v') <- g (i + 1)+ if pre' `B8.isPrefixOf` v'+ then return (EQ, (i + 1, de'))+ else return (lgt, (i, de))+ upperBound i = do+ de <- getZimDirEntByTitleIndex hdr hdl i+ case compare pre' (mkT de) of+ EQ -> if i == limit+ then return (EQ, (i, de))+ else return (GT, (i, de))+ lgt -> do+ (de', v') <- g (i - 1)+ if pre' `B8.isPrefixOf` v'+ then return (EQ, (i - 1, de'))+ else return (lgt, (i, de))++-- | Returns URL of main page in ZIM.+-- This URL can be used for redirecting to the actual page.+getZimMainPageUrl :: FilePath -- ^ Path to ZIM file+ -> IO (Maybe B.ByteString) -- ^ Returns URL if found+getZimMainPageUrl fp = do+ withBinaryFile fp ReadMode $ \hdl -> do+ hdr <- getZimHeader hdl+ case zimMainPage hdr of+ Nothing -> return Nothing+ Just i -> do+ de <- getZimDirEntByUrlIndex hdr hdl i+ return . Just $ zimDeNamespace de `B8.cons` '/' `B8.cons` zimDeUrl de++-- | Returns (MIME type, content) of URL, ready to be served via HTTP.+-- Note that MIME type is a strict bytestring while Content is lazy.+getZimUrlContent :: FilePath -- ^ Path to ZIM file+ -> B.ByteString -- ^ URL+ -> IO (Maybe (B.ByteString, BL.ByteString)) -- ^ Returns (MIME type, content) if found+getZimUrlContent fp url = do+ withBinaryFile fp ReadMode $ \hdl -> do+ hdr <- getZimHeader hdl+ res <- searchZimDirEntByUrl hdr hdl url+ case res of+ Nothing -> return Nothing+ Just (i, de) -> do+ mimeList <- getZimMimeList hdr hdl+ content <- getZimContentByUrlIndex hdr hdl i+ return $ Just (mimeList ! zimDeMimeType de, content)
+ test/Codec/Archive/Zim/ParserSpec.hs view
@@ -0,0 +1,156 @@+{-# LANGUAGE OverloadedStrings #-}+module Codec.Archive.Zim.ParserSpec (main, spec) where++import Control.Monad (forM_)+import qualified Data.ByteString.Char8 as B8+import qualified Data.ByteString.Lazy as BL+import Data.Maybe (fromJust, isJust)+import System.IO (Handle, openBinaryFile, IOMode(ReadMode))++import Data.Array.IArray (bounds, (!))++import Test.Hspec++import Codec.Archive.Zim.Parser++testSmallFilePath :: FilePath+testSmallFilePath = "test/wikipedia_en_ray_charles_2015-06.zim"++main :: IO ()+main = hspec spec++setup :: IO (ZimHeader, Handle)+setup = do+ small <- openBinaryFile testSmallFilePath ReadMode+ smallZim <- getZimHeader small+ return (smallZim, small)++spec :: Spec+spec = do+ describe "zim" $ do+ beforeAll setup $ do++ it "can open Ray Charles ZIM" $ \(smallZim, _) -> do+ zimMagicNumber smallZim `shouldBe` 72173914++ it "can get version" $ \(smallZim, _) -> do+ zimVersion smallZim `shouldBe` 5++ it "can get article count" $ \(smallZim, _) -> do+ zimArticleCount smallZim `shouldBe` 458++ it "can get cluster count" $ \(smallZim, _) -> do+ zimClusterCount smallZim `shouldBe` 215++ it "can parse MIME list" $ \(smallZim, small) -> do+ mimeList <- getZimMimeList smallZim small+ mimeList ! 0 `shouldBe` "application/javascript"+ bounds mimeList `shouldBe` (0, 9)++ it "can get main page" $ \(smallZim, _) -> do+ zimMainPage smallZim `shouldBe` Just 238++ it "can get main page URL" $ \_ -> do+ url <- getZimMainPageUrl testSmallFilePath+ url `shouldBe` Just "A/index.htm"++ it "can lookup directory entry by URL index" $ \(smallZim, small) -> do+ de <- getZimDirEntByUrlIndex smallZim small 0+ zimDeType de `shouldBe` ZimRedirectEntry+ zimDeUrl de `shouldBe` "favicon"++ it "can lookup directory entry by Title index" $ \(smallZim, small) -> do+ de <- getZimDirEntByTitleIndex smallZim small 3+ zimDeTitle de `shouldBe` "(The Night Time Is) The Right Time"+ zimDeNamespace de `shouldBe` 'A'++ it "can lookup cluster 0" $ \(smallZim, small) -> do+ cluster <- getZimCluster smallZim small 0+ BL.length cluster `shouldBe` 2160083++ it "can get cluster 2 blob 0" $ \(smallZim, small) -> do+ blob <- getZimBlob smallZim small 2 0+ BL.take 4 blob `shouldBe` "\137PNG"++ it "can get content for article 11" $ \(smallZim, small) -> do+ bs <- getZimContentByUrlIndex smallZim small 11+ BL.take 12 bs `shouldBe` "<html><head>"++ it "can search for title" $ \(smallZim, small) -> do+ let title = B8.pack "(The Night Time Is) The Right Time"+ res <- searchZimDirEntByTitle smallZim small 'A' title+ (title, res) `shouldSatisfy` (isJust . snd)+ (fst . fromJust $ res) `shouldBe` 3++ it "can search for non-existent title" $ \(smallZim, small) -> do+ let title = B8.pack "nonexistent-title"+ res <- searchZimDirEntByTitle smallZim small 'A' title+ (title, res) `shouldBe` (title, Nothing)++ it "can search for title prefix" $ \(smallZim, small) -> do+ let title = B8.pack "Blue"+ res <- searchZimDirEntByTitlePrefix smallZim small 'A' title+ (title, res) `shouldSatisfy` (isJust . snd)+ let Just ((lb, _), (ub, _)) = res+ (lb, ub) `shouldBe` (22, 25)++ it "can search for non-existent title prefix" $ \(smallZim, small) -> do+ let title = B8.pack "ZZZ"+ res <- searchZimDirEntByTitlePrefix smallZim small 'A' title+ (title, res) `shouldBe` (title, Nothing)++ it "can search for first title prefix" $ \(smallZim, small) -> do+ let title = B8.pack "fav"+ res <- searchZimDirEntByTitlePrefix smallZim small '-' title+ (title, res) `shouldSatisfy` (isJust . snd)+ let Just ((lb, _), (ub, _)) = res+ (lb, ub) `shouldBe` (0, 0)++ it "can search for last title prefix" $ \(smallZim, small) -> do+ let title = B8.pack "Title"+ res <- searchZimDirEntByTitlePrefix smallZim small 'M' title+ (title, res) `shouldSatisfy` (isJust . snd)+ let Just ((lb, _), (ub, _)) = res+ (lb, ub) `shouldBe` (457, 457)++ it "can search for URLs" $ \(smallZim, small) -> do+ let url = "A/A_Fool_for_You.html"+ res <- searchZimDirEntByUrl smallZim small url+ (url, res) `shouldSatisfy` (isJust . snd)+ (fst . fromJust $ res) `shouldBe` 4++ it "can search for non-existent URL" $ \(smallZim, small) -> do+ let url = "a/zzz.html"+ res <- searchZimDirEntByUrl smallZim small url+ res `shouldBe` Nothing++ it "can get (mimetype, content)" $ \_ -> do+ res <- getZimUrlContent testSmallFilePath "A/index.htm"+ res `shouldSatisfy` isJust+ let Just (m, c) = res+ (m, BL.length c) `shouldBe` ("text/html", 8637)++ let searchAllUrls hdr hdl des =+ forM_ des $ \de -> do+ let ns = zimDeNamespace de+ url = zimDeUrl de+ url' = ns `B8.cons` '/' `B8.cons` url+ res <- searchZimDirEntByUrl hdr hdl url'+ (url, res) `shouldSatisfy` (isJust . snd)+ (zimDeUrl . snd . fromJust $ res) `shouldBe` url+ getAllArticles hdr hdl n = do+ let ns = [0 .. n - 1]+ forM_ ns $ \i -> do+ de <- getZimDirEntByUrlIndex hdr hdl i+ let url = zimDeUrl de+ bs <- getZimContentByUrlIndex hdr hdl i+ (url, bs) `shouldSatisfy` (\(_, b) -> BL.length b > 0)++ it "can search all URLs" $ \(smallZim, small) -> do+ deList <- mapM (getZimDirEntByUrlIndex smallZim small) [0 .. zimArticleCount smallZim - 1]+ searchAllUrls smallZim small deList++ it "can get content from all URLs" $ \(smallZim, small) -> do+ getAllArticles smallZim small 457++
+ test/Spec.hs view
@@ -0,0 +1,1 @@+{-# OPTIONS_GHC -F -pgmF hspec-discover #-}
+ test/wikipedia_en_ray_charles_2015-06.zim view
binary file changed (absent → 1476042 bytes)
+ zim-parser.cabal view
@@ -0,0 +1,69 @@+-- This file has been generated from package.yaml by hpack version 0.8.0.+--+-- see: https://github.com/sol/hpack++name: zim-parser+version: 0.1.0.0+synopsis: Read and parse ZIM files+description: zim-parser is a library to read and parse ZIM (http://openzim.org) files.+ ZiM files contain offline web content (eg. Wikipedia) which can be browsed+ locally without an Internet connection.+category: Codec+stability: alpha+homepage: https://github.com/robbinch/zim-parser#readme+bug-reports: https://github.com/robbinch/zim-parser/issues+author: Robbin C. <robbinch33@gmail.com>+maintainer: Robbin C. <robbinch33@gmail.com>+copyright: Copyright (c) 2015 Robbin C.+license: GPL-3+license-file: LICENSE+build-type: Simple+cabal-version: >= 1.10++extra-source-files:+ test/wikipedia_en_ray_charles_2015-06.zim++source-repository head+ type: git+ location: https://github.com/robbinch/zim-parser++library+ hs-source-dirs:+ src+ ghc-options: -Wall+ build-depends:+ base == 4.*,+ array,+ binary,+ bytestring,+ resourcet,+ conduit,+ conduit-extra,+ binary-conduit,+ lzma-conduit+ exposed-modules:+ Codec.Archive.Zim.Parser+ default-language: Haskell2010++test-suite spec+ type: exitcode-stdio-1.0+ main-is: Spec.hs+ hs-source-dirs:+ src,+ test+ ghc-options: -Wall+ build-depends:+ base == 4.*,+ array,+ binary,+ bytestring,+ resourcet,+ conduit,+ conduit-extra,+ binary-conduit,+ lzma-conduit,+ hspec == 2.*+ other-modules:+ Codec.Archive.Zim.Parser+ Codec.Archive.Zim.ParserSpec+ default-language: Haskell2010