diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..dbbe355 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 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 Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are 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. + + 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. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + 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 Affero 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. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + 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 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 work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero 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 Affero 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 Affero 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 Affero 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 Affero 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 Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + 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 AGPL, see +. diff --git a/README b/README index d4cdf73..2706393 100755 --- a/README +++ b/README @@ -8,7 +8,7 @@ scihub2pdf is a module of `bibcure `__ Downloads pdfs via a DOI number, article title or a bibtex file, using -the database of libgen or Sci-Hub. +the database of libgen, Sci-Hub and Arxiv. Install ------- @@ -17,6 +17,23 @@ Install $ sudo pip install scihub2pdf +If you want to download files from scihub you will need to get PhantomJS + +OSX +~~~ + +:: + + $ brew install phantomjs + +Linux Using npm +~~~~~~~~~~~~~~~ + +:: + + $ sudo apt-get install npm + $ sudo npm install -g phantomjs + Features and how to use ----------------------- diff --git a/README.md b/README.md index 796f8c4..5018822 100755 --- a/README.md +++ b/README.md @@ -6,13 +6,27 @@ scihub2pdf is a module of [bibcure](https://github.com/bibcure/bibcure) Downloads pdfs via a DOI number, article title or a bibtex file, using the -database of libgen or Sci-Hub. +database of libgen, Sci-Hub and Arxiv. ## Install ``` $ sudo pip install scihub2pdf ``` +If you want to download files from scihub you will need to get PhantomJS + +### OSX +``` +$ brew install phantomjs +``` +### Linux Using npm + +``` +$ sudo apt-get install npm +$ sudo npm install -g phantomjs +``` + + ## Features and how to use diff --git a/requeriments.txt b/requeriments.txt index 08b39ab..d5ec7e7 100755 --- a/requeriments.txt +++ b/requeriments.txt @@ -5,3 +5,5 @@ lxml title2bib Pillow arxivcheck +selenium +six diff --git a/scihub2pdf/__init__.py b/scihub2pdf/__init__.py index ba27911..4c29e3c 100755 --- a/scihub2pdf/__init__.py +++ b/scihub2pdf/__init__.py @@ -1,2 +1,4 @@ - -__version__ = "0.3.1" +__version__ = "0.4.0" +__license__ = "AGPLv3" +__author__ = "Bruno Messias" +__author_email__ = "messias.physics@gmail.com" diff --git a/scihub2pdf/arxiv.py b/scihub2pdf/arxiv.py new file mode 100755 index 0000000..75e5ca7 --- /dev/null +++ b/scihub2pdf/arxiv.py @@ -0,0 +1,35 @@ +from __future__ import unicode_literals, print_function, absolute_import +import requests +from arxivcheck.arxiv import get_arxiv_pdf_link +from scihub2pdf.tools import download_pdf + + +class Arxiv(object): + def __init__(self, headers={}): + self.headers = headers + self.s = None + self.pdf_file = None + self.pdf_url = None + + def start(self): + self.s = requests.Session() + + def download(self): + found, r = download_pdf( + self.s, + self.pdf_file, + self.pdf_url, + self.headers) + + return found, r + + def navigate_to(self, value, pdf_file, field="id"): + self.pdf_file = pdf_file + found, self.pdf_url = get_arxiv_pdf_link(value, field) + + print("\n\t"+value) + print("\tLINK: ", self.pdf_url) + if not found: + print("\tArxiv ", value, " not found\n") + print(self.pdf_url) + return found, self.pdf_url diff --git a/scihub2pdf/bin/scihub2pdf b/scihub2pdf/bin/scihub2pdf index d7e8244..af1fe17 100755 --- a/scihub2pdf/bin/scihub2pdf +++ b/scihub2pdf/bin/scihub2pdf @@ -1,15 +1,18 @@ #!/usr/bib/env python -from __future__ import print_function +# -*- coding: utf-8 -*- +from __future__ import unicode_literals, print_function, absolute_import import sys import bibtexparser import argparse import textwrap -# from sci2pdf.libgen import download_pdf_from_bibs, download_from_doi -# from sci2pdf.libgen import download_from_title -from scihub2pdf.scihub import download_pdf_from_bibs, download_from_doi -from scihub2pdf.scihub import download_from_title, download_from_arxiv +from unidecode import unidecode +from scihub2pdf.download import (download_pdf_from_bibs, download_from_doi, + download_from_title, download_from_arxiv, + start_scihub, start_libgen, start_arxiv) import re +import io +pyversion = sys.version_info[0] def main(): parser = argparse.ArgumentParser( @@ -85,7 +88,6 @@ def main(): parser.add_argument( "--input", "-i", dest="inputfile", - type=argparse.FileType("r"), help="bibtex input file" ) parser.add_argument( @@ -98,7 +100,7 @@ def main(): "--uselibgen", dest="uselibgen", action="store_true", - help="Use libgen.io instead sci-hub. Sci-hub has annoying captcha but is stable. Libgen has no captcha but is unstable." + help="Use libgen.io instead sci-hub." ) parser.add_argument( "--location", "-l", @@ -123,23 +125,32 @@ def main(): location = args[0].location if use_libgen: + start_libgen() print("\n\t Using Libgen.\n") else: + start_scihub() print("\n\t Using Sci-Hub.\n") + start_arxiv() + if inline_search: - value = " ".join(args[1]) + + #values = [c if pyversion == 3 else c.decode(sys.stdout.encoding) for c in args[1]] + values = [c if pyversion == 3 else c.decode(sys.stdout.encoding) for c in args[1]] + value = " ".join(values) is_arxiv = bool(re.match("arxiv:", value, re.I)) if is_arxiv: field = "ti" if title_search else "id" - download_from_arxiv(value, field, location) + download_from_arxiv(value, location, field) elif title_search: download_from_title(value, location, use_libgen) else: download_from_doi(value, location, use_libgen) else: if is_txt: - file_values = args[0].inputfile.read() + with io.open(args[0].inputfile, "r", encoding = "utf-8") as inputfile: + file_values = inputfile.read() + for value in file_values.split("\n"): is_arxiv = bool(re.match("arxiv:", value, re.I)) if value != "": @@ -152,7 +163,22 @@ def main(): download_from_doi(value, location, use_libgen) else: - bibtex = bibtexparser.loads(args[0].inputfile.read()) + dict_parser = { + 'keywords': 'keyword', + 'keyw': 'keyword', + 'subjects': 'subject', + 'urls': 'url', + 'link': 'url', + 'links': 'url', + 'editors': 'editor', + 'authors': 'author'} + parser = bibtexparser.bparser.BibTexParser() + parser.alt_dict = dict_parser + with io.open(args[0].inputfile, "r", encoding="utf-8") as inputfile: + refs_string = args[0].inputfile.read() + + bibtex = bibtexparser.loads(refs_string, + parser=parser) bibs = bibtex.entries if len(bibs) == 0: print("Input File is empty or corrupted.") diff --git a/scihub2pdf/download.py b/scihub2pdf/download.py new file mode 100755 index 0000000..0b6e1c2 --- /dev/null +++ b/scihub2pdf/download.py @@ -0,0 +1,180 @@ +from __future__ import unicode_literals, print_function, absolute_import + +from builtins import input +import bibtexparser +# from . import __version__ +# from lxml.etree import ParserError +import re +from title2bib.crossref import get_bib_from_title +from scihub2pdf.scihub import SciHub +from scihub2pdf.libgen import LibGen +from scihub2pdf.arxiv import Arxiv +headers = { + # "Connection": "keep-alive", + # "User-Agent": "Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2228.0 Safari/537.36" +} +# print("\n\t Checking state of scihub...") +# url_state = "https://raw.githubusercontent.com/bibcure/scihub_state/master/state.txt" +# try: +# r = requests.get(url_state, headers=headers) +# state_scihub = [i.split(">>")[1] for i in r.iter_lines()] +# url_captcha_scihub = state_scihub[0] +# url_libgen = state_scihub[1] +# url_scihub = state_scihub[2] +# xpath_libgen_a = state_scihub[3] +# xpath_scihub_captcha = state_scihub[4] +# xpath_scihub_iframe = state_scihub[5] +# xpath_scihub_pdf = state_scihub[6] +# has_update = state_scihub[7] != __version__ +# if has_update: +# print("\n\t\tWill be better if you upgrade scihub2pdf.") +# print("\t\tFor that, just do:\n") +# print("\t\t\t sudo pip install scihub2pdf --upgrade\n") +# except: +# s = None + +libgen_url = "http://libgen.io/scimag/ads.php" +libgen_xpath_pdf_url = "/html/body/table/tr/td[3]/a" +xpath_captcha = "//*[@id='captcha']" +xpath_pdf = "//*[@id='pdf']" +xpath_input = "/html/body/div/table/tbody/tr/td/form/input" +xpath_form = "/html/body/div/table/tbody/tr/td/form" +domain_scihub = "http://sci-hub.cc/" + +ScrapSci = SciHub(headers, + xpath_captcha, + xpath_pdf, + xpath_input, + xpath_form, + domain_scihub + ) +ScrapArx = Arxiv(headers) +ScrapLib = LibGen(headers=headers, + libgen_url=libgen_url, + xpath_pdf_url=libgen_xpath_pdf_url) + + +def start_scihub(): + ScrapSci.start() + +def start_libgen(): + ScrapLib.start() + +def start_arxiv(): + ScrapArx.start() + + +def download_from_libgen(doi, pdf_file): + found, r = ScrapLib.navigate_to(doi, pdf_file) + if not found: + return False, r + + success, tree = ScrapLib.generate_tree() + if not success: + return False, r + + found, url = ScrapLib.get_pdf_url() + if not found: + return False, r + + found, r = ScrapLib.download() + + return found, r + + +def download_from_arxiv(value, location, field="id"): + + pdf_file = location + if not location.endswith(".pdf"): + pdf_file = location+value+".pdf" + + found, pdf_url = ScrapArx.navigate_to(value, pdf_file, field) + if found: + found, r = ScrapArx.download() + + return found, pdf_url + + +def download_from_scihub(doi, pdf_file): + found, r = ScrapSci.navigate_to(doi, pdf_file) + if not found: + return False, r + + has_captcha, has_iframe = ScrapSci.check_captcha() + while (has_captcha and has_iframe): + captcha_img = ScrapSci.get_captcha_img() + captcha_img.show() + captcha_text = input("\tPut captcha:\n\t") + has_captcha, has_iframe = ScrapSci.solve_captcha(captcha_text) + + if has_iframe: + found, r = ScrapSci.download() + + found = has_iframe + return has_iframe, r + + +def download_pdf_from_bibs(bibs, location="", + use_libgen=False): + def put_pdf_location(bib): + pdf_name = bib["ID"] if "ID" in bib else bib["doi"].replace("/", "_") + pdf_name += ".pdf" + bib["pdf_file"] = location+pdf_name + return bib + + # bibs_with_doi = list(filter(lambda bib: "doi" in bib, bibs)) + bibs_with_doi = [] + # bibs_arxiv = [] + for bib in bibs: + if "journal" in bib: + if bool(re.match("arxiv:", bib["journal"], re.I)): + pdf_file = location+bib["journal"]+".pdf" + download_from_arxiv(bib["journal"], pdf_file, "id") + elif "doi" in bib: + bibs_with_doi.append(bib) + + elif "doi" in bib: + bibs_with_doi.append(bib) + # bibs_journal = list(filter(lambda bib: "journal" in bib, bibs)) + # bibs_arxiv = list( + # filter( + # lambda bib: bool(re.match("arxiv:", bib["journal"], re.I)) in bib, bibs_journal + # ) + # ) + + bibs_with_doi = list(map(put_pdf_location, bibs_with_doi)) + # libgen has no captcha, try to use multiprocessing? + if use_libgen: + list(map( + lambda bib: download_from_libgen(bib["doi"], bib["pdf_file"] + ), + bibs_with_doi)) + else: + for bib in bibs_with_doi: + found, bib = download_from_scihub(bib["doi"], bib["pdf_file"]) + + +def download_from_doi(doi, location="", use_libgen=False): + pdf_name = "{}.pdf".format(doi.replace("/", "_")) + pdf_file = location+pdf_name + if use_libgen: + download_from_libgen(doi, pdf_file) + else: + download_from_scihub(doi, pdf_file) + + +def download_from_title(title, location="", use_libgen=False): + found, bib_string = get_bib_from_title(title) + if found: + bib = bibtexparser.loads(bib_string).entries[0] + if "doi" in bib: + pdf_name = "{}.pdf".format( + bib["doi"].replace("/", "_") + ) + bib["pdf_file"] = location+pdf_name + if use_libgen: + download_from_libgen(bib["doi"], bib["pdf_file"]) + else: + found, bib = download_from_scihub(bib["doi"], bib["pdf_file"]) + else: + print("\tAbsent DOI") diff --git a/scihub2pdf/libgen.py b/scihub2pdf/libgen.py new file mode 100755 index 0000000..a597e63 --- /dev/null +++ b/scihub2pdf/libgen.py @@ -0,0 +1,81 @@ +from __future__ import unicode_literals, print_function, absolute_import + +import requests +from lxml import html +from lxml.etree import ParserError +from scihub2pdf.tools import norm_url, download_pdf + + +class LibGen(object): + def __init__(self, + headers={}, + libgen_url="http://libgen.io/scimag/ads.php", + xpath_pdf_url="/html/body/table/tr/td[3]/a"): + + self.libgen_url = libgen_url + self.xpath_pdf_url = xpath_pdf_url + self.headers = headers + self.s = None + self.doi = None + self.pdf_file = None + self.pdf_url = None + self.page_url = None + self.html_tree = None + self.html_content = None + + def start(self): + self.s =requests.Session() + def download(self): + found, r = download_pdf( + self.s, + self.pdf_file, + self.pdf_url, + self.headers, + filetype="application/octet-stream") + + return found, r + + def navigate_to(self, doi, pdf_file): + + params = {"doi": doi, "downloadname": ""} + r = self.s.get( + self.libgen_url, + params=params, + headers=self.headers + ) + self.page_url = r.url + self.pdf_file = pdf_file + print("\n\tDOI: ", doi) + print("\tLibGen Link: ", self.page_url) + found = r.status_code == 200 + if not found: + print("\tMaybe libgen is down. Try to use sci-hub instead.") + return found, r + + self.html_content = r.content + return found, r + + def generate_tree(self): + + try: + self.html_tree = html.fromstring(self.html_content) + success = True + except ParserError: + print("\tThe LibGen page has a strange bewavior") + print("\tTry open in browser to check") + print(self.page_url) + success = False + + return success, self.html_tree + + def get_pdf_url(self): + html_a = self.html_tree.xpath(self.xpath_pdf_url) + if len(html_a) == 0: + print("\tPDF link for ", self.page_url, " not found") + found = False + self.pdf_url = None + else: + self.pdf_url = norm_url(html_a[0].attrib["href"]) + found = True + + return found, self.pdf_url diff --git a/scihub2pdf/scihub.py b/scihub2pdf/scihub.py old mode 100755 new mode 100644 index ec65df2..99fd21f --- a/scihub2pdf/scihub.py +++ b/scihub2pdf/scihub.py @@ -1,228 +1,160 @@ -from __future__ import print_function +from __future__ import unicode_literals, print_function, absolute_import + import requests -from lxml import html -from title2bib.crossref import get_bib_from_title -from arxivcheck.arxiv import get_arxiv_pdf_link -import bibtexparser -from builtins import input +from selenium import webdriver +from selenium.common.exceptions import NoSuchElementException from PIL import Image -from . import __version__ -import re +from scihub2pdf.tools import norm_url, download_pdf +from base64 import b64decode as b64d +from six import string_types try: from StringIO import StringIO + from io import BytesIO except ImportError: - from io import StringIO -headers = { - # "Connection": "close", - "User-Agent": "Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/41.0.2228.0 Safari/537.36" -} -print("\n\t Checking state of scihub...") -url_state = "https://raw.githubusercontent.com/bibcure/scihub_state/master/state.txt" -try: - r = requests.get(url_state) - state_scihub = [i.split(">>")[1] for i in r.iter_lines()] - url_captcha_scihub = state_scihub[0] - url_libgen = state_scihub[1] - url_scihub = state_scihub[2] - xpath_libgen_a = state_scihub[3] - xpath_scihub_captcha = state_scihub[4] - xpath_scihub_iframe = state_scihub[5] - xpath_scihub_pdf = state_scihub[6] - has_update = state_scihub[7] != __version__ - if has_update: - print("\n\t\tWill be better if you upgrade scihub2pdf.") - print("\t\tFor that, just do:\n") - print("\t\t\t sudo pip install scihub2pdf --upgrade\n") -except: - url_captcha_scihub = "http://moscow.sci-hub.cc" - url_libgen = "http://libgen.io/scimag/ads.php" - url_scihub = "http://sci-hub.cc/" - xpath_libgen_a = "/html/body/table/tr/td[3]/a" - xpath_scihub_captcha = "//*[@id='captcha']" - xpath_scihub_iframe = "//iframe/@src" - xpath_scihub_pdf = "//*[@id='pdf']" - - -def norm_url(url): - if url.startswith("//"): - url = "http:" + url - - return url - - -def download_from_libgen(bib, s): - params = {"doi": bib["doi"], "downloadname": ""} - - r = s.get(url_libgen, params=params, headers=headers) - print("libgen link", r.url) - if r.status_code != 200: - print("Fail libgen url", r.status_code) - print("Maybe libgen is down. Try to use sci-hub instead.") - return - - html_tree = html.fromstring(r.content) - html_a = html_tree.xpath(xpath_libgen_a) - if len(html_a) == 0: - print("Copy and paste the below link into your browser") - print("\n\t", r.url, "\n") - return - - download_link = norm_url(html_a[0].attrib["href"]) - bib["pdf_link"] = download_link - download_pdf(bib, s) - - return - - -def check_captcha(iframe_url, url, html_tree, s): - html_captcha = html_tree.xpath(xpath_scihub_captcha) - if len(html_captcha) > 0: - captcha_url = url_captcha_scihub+html_captcha[0].attrib["src"] - r = s.get(captcha_url) - - Image.open(StringIO(r.content)).show() - captcha_solution = input("Put the CAPTCHA: ") - r = s.post(iframe_url, data={ - "captcha_code": captcha_solution - }) - return True - else: - - return False - - -def download_from_scihub(bib, s): - - url = url_scihub+bib["doi"] - print("sci-hub link", url) - r = s.get(url, headers=headers, allow_redirects=True) - - if r.status_code != 200: - print("Fail scihub url", r.status_code) - return - - html_tree = html.fromstring(r.content) - iframe_url = html_tree.xpath(xpath_scihub_iframe) - - if len(iframe_url) == 0: - print("Iframe not found.") - print("Copy and paste the below link into your browser") - print("\n\t", url, "\n") - return - - iframe_url = norm_url(iframe_url[0]) - ri = s.get(iframe_url, headers=headers) - html_tree_ri = html.fromstring(ri.content) - - if check_captcha(iframe_url, url, html_tree_ri, s): - return download_from_scihub(bib, s) - - html_pdf = html_tree.xpath(xpath_scihub_pdf) - - if len(html_pdf) == 0: - print("pdf file not found") - print("\n\t", url) - return - - download_link = norm_url(html_pdf[0].attrib["src"]) - bib["pdf_link"] = download_link - download_pdf(bib, s) - return - - -def download_pdf(bib, s): - r = s.get(bib["pdf_link"], headers=headers) - if r.status_code == 200: - pdf_file = open(bib["pdf_file"], "wb") - pdf_file.write(r.content) - pdf_file.close() - print("Download of", bib["pdf_file"], " ok") - else: - print("Fail in download ", - bib["pdf_file"], - " status_code ", - r.status_code) - - -def download_pdf_from_bibs(bibs, location="", - use_libgen=False): - def put_pdf_location(bib): - pdf_name = bib["ID"] if "ID" in bib else bib["doi"].replace("/", "_") - pdf_name += ".pdf" - bib["pdf_file"] = location+pdf_name - return bib - - # bibs_with_doi = list(filter(lambda bib: "doi" in bib, bibs)) - bibs_with_doi = [] - # bibs_arxiv = [] - for bib in bibs: - if "journal" in bib: - if bool(re.match("arxiv:", bib["journal"], re.I)): - download_from_arxiv(bib["journal"], "id", location) - elif "doi" in bib: - bibs_with_doi.append(bib) - - elif "doi" in bib: - bibs_with_doi.append(bib) - # bibs_journal = list(filter(lambda bib: "journal" in bib, bibs)) - # bibs_arxiv = list( - # filter( - # lambda bib: bool(re.match("arxiv:", bib["journal"], re.I)) in bib, bibs_journal - # ) - # ) - - bibs_with_doi = list(map(put_pdf_location, bibs_with_doi)) - - # libgen has no captcha, try to use multiprocessing? - with requests.Session() as s: - if use_libgen: - list(map(lambda bib: download_from_libgen(bib, s), bibs_with_doi)) + from io import StringIO, BytesIO + + +class SciHub(object): + def __init__(self, + headers, + xpath_captcha="//*[@id='captcha']", + xpath_pdf="//*[@id='pdf']", + xpath_input="/html/body/div/table/tbody/tr/td/form/input", + xpath_form="/html/body/div/table/tbody/tr/td/form", + domain_scihub="http://sci-hub.cc/", + ): + + self.xpath_captcha = xpath_captcha + self.xpath_input = xpath_input + self.xpath_form = xpath_form + self.xpath_pdf = xpath_pdf + self.domain_scihub = domain_scihub + self.headers = headers + self.driver = None + self.sci_url = None + self.el_captcha = None + self.el_iframe = None + self.el_form = None + self.el_input_text = None + self.has_captcha = False + self.has_iframe = False + self.pdf_url = None + self.doi = None + self.pdf_file = None + self.s = None + + + def start(self): + self.driver = webdriver.PhantomJS() + self.s = requests.Session() + + def get_session(self): + cookies = self.driver.get_cookies() + for cookie in cookies: + self.s.cookies.set(cookie['name'], cookie['value']) + + return self.s + + def download(self): + found, r = download_pdf( + self.s, + self.pdf_file, + self.pdf_url, + self.headers) + + if not found: + self.driver.save_screenshot(self.pdf_file+".png") + + return found, r + + def navigate_to(self, doi, pdf_file): + self.doi = doi + self.pdf_file = pdf_file + self.sci_url = self.domain_scihub+doi + print("\n\tDOI: ", doi) + print("\tSci-Hub Link: ", self.sci_url) + r = requests.get(self.sci_url) + found = r.status_code == 200 + if found: + self.driver.get(self.sci_url) + self.driver.set_window_size(1120, 550) else: - for bib in bibs_with_doi: - download_from_scihub(bib, s) - - -def download_from_doi(doi, location="", use_libgen=False): - bib = {"doi": doi} - pdf_name = "{}.pdf".format(doi.replace("/", "_")) - bib["pdf_file"] = location+pdf_name - - with requests.Session() as s: - if use_libgen: - download_from_libgen(bib, s) + print("\tSomething is wrong with sci-hub,") + print("\tstatus_code: ", r.status_code) + return found, r + + def get_captcha_img(self): + self.driver.execute_script("document.getElementById('content').style.zIndex = 9999;") + self.driver.switch_to.frame(self.el_iframe) + self.driver.execute_script("document.getElementById('captcha').style.zIndex = 9999;") + location = self.el_captcha.location + size = self.el_captcha.size + captcha_screenshot = self.driver.get_screenshot_as_base64() + image_b64d = b64d(captcha_screenshot) + if isinstance(image_b64d, string_types): + image = Image.open(StringIO(image_b64d)) else: - download_from_scihub(bib, s) - + image = Image.open(BytesIO(image_b64d)) + + left = location['x'] + top = location['y'] + right = location['x'] + size['width'] + bottom = location['y'] + size['height'] + image = image.crop((left, top, right, bottom)) + self.driver.switch_to.default_content() + return image + + + def solve_captcha(self, captcha_text): + + # self.driver.save_screenshot(self.pdf_file+"before_solve.png") + self.driver.switch_to.frame(self.el_iframe) + self.el_input_text.send_keys(captcha_text) + # self.driver.save_screenshot(self.pdf_file+"send_keys.png") + self.el_form.submit() + + self.driver.switch_to.default_content() + # with self.wait_for_page_load(timeout=10): + found, r = self.navigate_to(self.doi, self.pdf_file) + # self.driver.save_screenshot(self.pdf_file+"after_submit.png") + return self.check_captcha() + + def get_iframe(self): + self.has_iframe, self.el_iframe = self.get_el(self.xpath_pdf) + if self.has_iframe: + self.pdf_url = norm_url(self.el_iframe.get_attribute("src")) + else: + self.driver.save_screenshot(self.pdf_file+".png") -def download_from_title(title, location="", use_libgen=False): - found, bib_string = get_bib_from_title(title) + return self.has_iframe - if found: - bib = bibtexparser.loads(bib_string).entries[0] - if "doi" in bib: - pdf_name = "{}.pdf".format( - bib["doi"].replace("/", "_") + def get_el(self, xpath): + try: + el = self.driver.find_element_by_xpath( + xpath ) - bib["pdf_file"] = location+pdf_name - with requests.Session() as s: - if use_libgen: - download_from_libgen(bib, s) - else: - download_from_scihub(bib, s) - else: - print("Absent DOI") - - -def download_from_arxiv(value, field="id", location=""): - print("Downloading...", value) - found, pdf_link = get_arxiv_pdf_link(value, field) - if found and pdf_link is not None: - bib = {} - pdf_name = "{}.pdf".format(value.replace("/", "_")) - bib["pdf_file"] = location+pdf_name - - bib["pdf_link"] = pdf_link - s = requests.Session() - download_pdf(bib, s) - else: - print(value, ": Arxiv not found.") + found = True + except NoSuchElementException: + el = None + found = False + + return found, el + + def check_captcha(self): + print("\tchecking if has captcha...") + has_iframe = self.get_iframe() + if has_iframe is False: + print("\tNo pdf found. Maybe, the sci-hub dosen't have the file") + print("\tTry to open the link in your browser.") + return False, has_iframe + + self.driver.save_screenshot(self.pdf_file+"check_captcha.png") + self.driver.switch_to.frame(self.el_iframe) + self.has_captcha, self.el_captcha = self.get_el(self.xpath_captcha) + if self.has_captcha: + found, self.el_input_text = self.get_el(self.xpath_input) + found, self.el_form = self.get_el(self.xpath_form) + + self.driver.switch_to.default_content() + + return self.has_captcha, has_iframe diff --git a/scihub2pdf/tools.py b/scihub2pdf/tools.py new file mode 100644 index 0000000..58d8749 --- /dev/null +++ b/scihub2pdf/tools.py @@ -0,0 +1,29 @@ +from __future__ import unicode_literals, print_function, absolute_import + + + +def download_pdf(s, pdf_file, pdf_url, headers, filetype="application/pdf"): + r = s.get( + pdf_url, + headers=headers + ) + found = r.status_code == 200 + is_right_type = r.headers["content-type"] == filetype + if found and is_right_type: + pdf = open(pdf_file, "wb") + pdf.write(r.content) + pdf.close() + print("\tDownload: ok") + else: + print("\tDownload: Fail") + print("\tStatus_code: ", r.status_code) + return found, r + + +def norm_url(url): + if url.startswith("//"): + url = "http:" + url + + return url + + diff --git a/setup.py b/setup.py index 5466dfa..d927ca6 100755 --- a/setup.py +++ b/setup.py @@ -6,7 +6,7 @@ setup( name="scihub2pdf", - version="0.3.1", + version="0.4.0", packages=find_packages(exclude=["build", ]), scripts=["scihub2pdf/bin/scihub2pdf"], long_description=README_TEXT, @@ -14,19 +14,21 @@ "title2bib", "arxivcheck", "future", + "six", "Pillow", "requests", + "selenium", "lxml"], include_package_data=True, - license="GPLv3", + license="AGPLv3", description="Downloads pdfs via a DOI number(or arxivId), article title or a bibtex file, sci-hub", author="Bruno Messias", author_email="messias.physics@gmail.com", - download_url="https://github.com/bibcure/scihub2pdf/archive/0.3.1.tar.gz", + download_url="https://github.com/bibcure/scihub2pdf/archive/0.4.0.tar.gz", keywords=["bibtex", "sci-hub", "libgen", "doi", "science", "scientific-journals"], classifiers=[ - "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", + "License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)", "Intended Audience :: Science/Research", "Programming Language :: Python", "Topic :: Text Processing :: Markup :: LaTeX",