pax_global_header00006660000000000000000000000064146755176170014535gustar00rootroot0000000000000052 comment=e4ed6dad17f2a9de4d0f336f4ba56887bb57759e persepolisdm-persepolis_lib-7920870/000077500000000000000000000000001467551761700174565ustar00rootroot00000000000000persepolisdm-persepolis_lib-7920870/.gitignore000066400000000000000000000001411467551761700214420ustar00rootroot00000000000000__pycache__/ *.pyc .env ./__pycache__/ dist/ build/ builddir/ persepolis_lib.egg-info/ venv_dir/ persepolisdm-persepolis_lib-7920870/LICENSE000066400000000000000000001045151467551761700204710ustar00rootroot00000000000000 GNU GENERAL PUBLIC LICENSE Version 3, 29 June 2007 Copyright (C) 2007 Free Software Foundation, Inc. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The GNU General Public License is a free, copyleft license for software and other kinds of works. The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things. To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others. For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it. For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions. Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users. Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free. The precise terms and conditions for copying, distribution and modification follow. TERMS AND CONDITIONS 0. Definitions. "This License" refers to version 3 of the GNU General Public License. "Copyright" also means copyright-like laws that apply to other kinds of works, such as semiconductor masks. "The Program" refers to any copyrightable work licensed under this License. Each licensee is addressed as "you". "Licensees" and "recipients" may be individuals or organizations. To "modify" a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a "modified version" of the earlier work or a work "based on" the earlier work. A "covered work" means either the unmodified Program or a work based on the Program. To "propagate" a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well. To "convey" a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying. An interactive user interface displays "Appropriate Legal Notices" to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion. 1. Source Code. The "source code" for a work means the preferred form of the work for making modifications to it. "Object code" means any non-source form of a work. A "Standard Interface" means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language. The "System Libraries" of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A "Major Component", in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it. The "Corresponding Source" for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work. The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source. The Corresponding Source for a work in source code form is that same work. 2. Basic Permissions. All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law. You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you. Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary. 3. Protecting Users' Legal Rights From Anti-Circumvention Law. No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures. When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures. 4. Conveying Verbatim Copies. You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program. You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee. 5. Conveying Modified Source Versions. You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions: a) The work must carry prominent notices stating that you modified it, and giving a relevant date. b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to "keep intact all notices". c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it. d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so. A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an "aggregate" if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate. 6. Conveying Non-Source Forms. You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways: a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange. b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge. c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b. d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements. e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d. A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work. A "User Product" is either (1) a "consumer product", which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, "normally used" refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product. "Installation Information" for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made. If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM). The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network. Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying. 7. Additional Terms. "Additional permissions" are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions. When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission. Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms: a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or d) Limiting the use for publicity purposes of names of licensors or authors of the material; or e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors. All other non-permissive additional terms are considered "further restrictions" within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying. If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms. Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way. 8. Termination. You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11). However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation. Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice. Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10. 9. Acceptance Not Required for Having Copies. You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so. 10. Automatic Licensing of Downstream Recipients. Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License. An "entity transaction" is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts. You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it. 11. Patents. A "contributor" is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's "contributor version". A contributor's "essential patent claims" are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, "control" includes the right to grant patent sublicenses in a manner consistent with the requirements of this License. Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version. In the following three paragraphs, a "patent license" is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To "grant" such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party. If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. "Knowingly relying" means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid. If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it. A patent license is "discriminatory" if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007. Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law. 12. No Surrender of Others' Freedom. If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program. 13. Use with the GNU Affero General Public License. Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such. 14. Revised Versions of this License. The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation. If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program. Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version. 15. Disclaimer of Warranty. THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 16. Limitation of Liability. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 17. Interpretation of Sections 15 and 16. If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. Copyright (C) This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see . Also add information on how to contact you by electronic and paper mail. If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode: Copyright (C) This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, your program's commands might be different; for a GUI interface, you would use an "about box". You should also get your employer (if you work as a programmer) or school, if any, to sign a "copyright disclaimer" for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see . The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read . persepolisdm-persepolis_lib-7920870/README.md000066400000000000000000000073401467551761700207410ustar00rootroot00000000000000# persepolis_lib ### **About** A Python library for easier and faster downloading ### **Features** - Multi-segment downloading(64 connections) - Resuming downloads ## Installation persepolis_lib is available on [pypi](https://pypi.org/project/persepolis-lib/). ``` pip install persepolis_lib ``` ## Usage ```python #!/usr/bin/python3 # import Download class from persepolis_lib.persepolis_lib import Download # create a dictionary that contains download infromation. download_dict = {'link': http://example.com/example.jpg, # your download link 'out': None, # You can choose a name for your file if you want. If you don't want to, choose None for its value. 'download_path': /home/example_user/Downloads, # Choose download path. You must choose valid download path! 'ip': None, # set ip of your proxy, If you don't use proxy, set None value for it. 'port': None, # set port of your proxy, If you don't use proxy, set None value for it. 'proxy_user': None, # set proxy user, If you don't use proxy, set None value for it. 'proxy_passwd': None, # set proxy pass word, If you don't use proxy, set None value for it. 'proxy_type': None, # set proxy type, http or socks5. If you don't use proxy, set None value for it. 'download_user': None, # set username, If your download link requires user name,Otherwise, set its value to ٔNone. 'download_passwd': None, # set password, If your download link requires user name and password,Otherwise, set its value to ٔNone. 'header': None, # set header if you want, Otherwise, set its value to ٔNone. 'user_agent': None, # set user-agent if you want, Otherwise, set its value to ٔNone. persepolis_lib/version is default user agent. 'load_cookies': None, # set cookies path if you want, Otherwise, set its value to ٔNone. 'referer': None} # set referrer if you want, Otherwise, set its value to ٔNone. # persepolis supports Multi-segment downloading. set number of threads. maximum value is 64. minimum value is 1. default is 64. segments = 64 # set python requests chunk size in KiB. # checkout this link for more informaton. https://stackoverflow.com/questions/46205586/why-to-use-iter-content-and-chunk-size-in-python-requests # default is 100 KiB pytho_requests_chunk_size = 100 # KiB # create a download session # set timeout value in seconds. default is 5. # set number of retries if download failed. default is 5. # set progress_bar value to True If you want the progress bar to be shown in the console. default is False # set threads_progress_bar to True If you want the size downloaded by each thread to be displayed in the progress bar. default is False. download_session = Download(add_link_dictionary=download_dict, number_of_threads=segments, chunk_size=pytho_requests_chunk_size, timeout=5, retry=5, progress_bar=False, threads_progress_bar=False) # start download. Use thread if you want! download_session.start() # stop download download_session.stop() # pause download download_session.downloadPause() # Unpause download_session.downloadUnPause() # limit download speed. # limit_value is between 1 to 10. # 10 means no limit speed. download_session.limitSpeed(5) # get download information in dictionary format status_dict = download_session.tellStatus() print(status_dict) ``` persepolis_lib creates download file and log file and conrol file in json format with .persepolis extension in download path. control file contains download information. Persepolis_lib can resume download, If control file exists. persepolisdm-persepolis_lib-7920870/persepolis_lib/000077500000000000000000000000001467551761700224715ustar00rootroot00000000000000persepolisdm-persepolis_lib-7920870/persepolis_lib/__init__.py000066400000000000000000000013311467551761700246000ustar00rootroot00000000000000# -*- coding: utf-8 -*- # 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 . # from persepolis_lib import Download persepolisdm-persepolis_lib-7920870/persepolis_lib/persepolis_lib.py000066400000000000000000001060011467551761700260540ustar00rootroot00000000000000# -*- coding: utf-8 -*- # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program. If not, see . import requests import time import random import threading import os import errno from persepolis_lib.useful_tools import convertTime, humanReadableSize, convertSize, sendToLog, convertHeaderToDictionary, readCookieJar, getFileNameFromLink import sys import json from requests.adapters import HTTPAdapter from urllib3.util.retry import Retry class Download(): def __init__(self, add_link_dictionary, number_of_threads=64, python_request_chunk_size=100, timeout=5, retry=5, progress_bar=False, threads_progress_bar=False): self.python_request_chunk_size = python_request_chunk_size self.progress_bar = progress_bar self.threads_progress_bar = threads_progress_bar self.downloaded_size = 0 self.finished_threads = 0 self.eta = "0" self.resume = False self.download_speed_str = "0" self.__Version__ = "1.0.2" # download_status can be in waiting, downloading, stop, error, paused self.download_status = 'waiting' self.file_name = '***' self.file_size = 0 self.link = add_link_dictionary['link'] self.name = add_link_dictionary['out'] self.download_path = add_link_dictionary['download_path'] self.ip = add_link_dictionary['ip'] self.port = add_link_dictionary['port'] self.proxy_user = add_link_dictionary['proxy_user'] self.proxy_passwd = add_link_dictionary['proxy_passwd'] self.download_user = add_link_dictionary['download_user'] self.download_passwd = add_link_dictionary['download_passwd'] self.header = add_link_dictionary['header'] self.user_agent = add_link_dictionary['user_agent'] self.load_cookies = add_link_dictionary['load_cookies'] self.referer = add_link_dictionary['referer'] self.proxy_type = add_link_dictionary['proxy_type'] self.number_of_parts = 0 self.timeout = timeout self.retry = retry self.lock = False self.sleep_for_speed_limiting = 0 self.not_converted_download_speed = 0 self.download_percent = 0 # number_of_threads can't be more that 64 if number_of_threads <= 64: self.number_of_threads = int(number_of_threads) else: self.number_of_threads = 64 self.number_of_active_connections = self.number_of_threads self.thread_list = [] # create requests session def createSession(self): # define a requests session self.requests_session = requests.Session() # check if user set proxy if self.ip: ip_port = '://' + str(self.ip) + ":" + str(self.port) if self.proxy_user: ip_port = ('://' + self.proxy_user + ':' + self.proxy_passwd + '@' + ip_port) if self.proxy_type == 'socks5': ip_port = 'socks5' + ip_port else: ip_port = 'http' + ip_port proxies = {'http': ip_port, 'https': ip_port} # set proxy to the session self.requests_session.proxies.update(proxies) # set cookies if self.load_cookies: jar = readCookieJar(self.load_cookies) if jar: self.requests_session.cookies = jar # set referer if self.referer: # setting referer to the session self.requests_session.headers.update({'referer': self.referer}) # set user_agent if self.user_agent: # setting user_agent to the session self.requests_session.headers.update( {'user-agent': self.user_agent}) else: self.user_agent = 'Persepolis lib/' + self.__Version__ # setting user_agent to the session self.requests_session.headers.update( {'user-agent': self.user_agent}) if self.header is not None: # convert header to dictionary dict_ = convertHeaderToDictionary(self.header) # update headers self.requests_session.headers.update(dict_) # get file size # if file size is not available, then download link is invalid def getFileSize(self): response = self.requests_session.head(self.link, allow_redirects=True, timeout=5) self.file_header = response.headers # find file size try: self.file_size = int(self.file_header['content-length']) except Exception as error: print(str(error)) print("Invalid URL") self.file_size = None return self.file_size def setRetry(self): # set retry numbers. # backoff_factor will help to apply delays between attempts to avoid failing again retry = Retry(connect=self.retry, backoff_factor=1) adapter = HTTPAdapter(max_retries=retry) self.requests_session.mount('http://', adapter) self.requests_session.mount('https://', adapter) # get file name if available # if file name is not available, then set a file name def getFileName(self): # set default file name # get file name from link string. self.file_name = getFileNameFromLink(self.link) # check if user set file name or not if self.name: self.file_name = self.name # check if filename is available in header elif 'Content-Disposition' in self.file_header.keys(): content_disposition = self.file_header['Content-Disposition'] if content_disposition.find('filename') != -1: # so file name is available in header filename_splited = content_disposition.split('filename=') filename_splited = filename_splited[-1] # getting file name in desired format self.file_name = filename_splited.strip() # this method gives etag from header # ETag is an HTTP response header field that helps with caching behavior by making # it easy to check whether a resource has changed, without having to re-download it. def getFileTag(self): if 'ETag' in self.file_header.keys(): self.etag = self.file_header['ETag'] else: self.etag = None # Check if server supports multi threading or not def multiThreadSupport(self): if 'Accept-Ranges' in self.file_header.keys(): if self.file_header['Accept-Ranges'] == 'bytes': sendToLog('Server supports multi thread downloading!') return True else: sendToLog('Server dosn\'t support multi thread downloading!') return False def createControlFile(self): # find file_path and control_json_file_path # If the file is partially downloaded, the download information is available in the control file. # The format of this file is Jason. the control file extension is .persepolis. # the control file name is same as download file name. # control file path is same as download file path. control_json_file = self.file_name + '.persepolis' # if user set download path if self.download_path: self.file_path = os.path.join(self.download_path, self.file_name) self.control_json_file_path = os.path.join( self.download_path, control_json_file) else: self.file_path = self.file_name self.control_json_file_path = control_json_file # create json control file if not created before try: with open(self.control_json_file_path, 'x') as f: f.write("") except OSError as e: # it means control_json_file_path characters is more than 256 byte if e.errno == errno.ENAMETOOLONG: # reduce file_name lenght reduce_bytes = len(self.control_json_file_path.encode('utf-8')) - 255 # seperate extension from file_name split_file_name = self.file_name.split('.') # check we have extension or not extension = "" if len(split_file_name) > 1: # remove extension extension = split_file_name.pop(-1) # join file_name without extension file_name_without_extension = ''.join(split_file_name) if len(file_name_without_extension.encode('utf-8')) > reduce_bytes: # Calculate how many characters must be removed for i in range(len(file_name_without_extension)): string_ = file_name_without_extension[(-1 * i):] string_size = len(string_.encode('utf-8')) if string_size >= reduce_bytes: # reduce characters file_name_without_extension = file_name_without_extension[:(-1 * i)] break # create new file_name and file_path and control_json_file self.file_name = file_name_without_extension + extension self.file_path = os.path.join(self.download_path, self.file_name) control_json_file = self.file_name + '.persepolis' self.control_json_file_path = os.path.join( self.download_path, control_json_file) # try again with open(self.control_json_file_path, 'x') as f: f.write("") else: # so the control file is already exists # read control file with open(self.control_json_file_path, "r") as f: try: # save json file information in dictionary format data_dict = json.load(f) # check if the download is duplicated # If download item is duplicated, so resume download # check ETag if 'ETag' in data_dict: if data_dict['ETag'] == self.etag: self.resume = True else: self.resume = False # if ETag is not available, then check file size elif 'file_size' in data_dict: if data_dict['file_size'] == self.file_size: self.resume = True else: self.resume = False else: self.resume = False # control file is corrupted. except Exception: self.resume = False # check if uncomplete download file exists if os.path.isfile(self.file_path): download_file_existance = True else: download_file_existance = False if self.resume and not (download_file_existance): self.resume = False create_download_file = True elif self.resume and download_file_existance: create_download_file = False else: create_download_file = True # create empty file if create_download_file: fp = open(self.file_path, "wb") fp.write(b'\0' * self.file_size) fp.close() def definePartSizes(self): # download_infromation_list contains 64 slists. # Every list contains: # [start byte number for this part, downloaded size, download status for this part, number of retryingfor this part] # Status can be stopped, pending, downloading, error, complete # All part statuses start with a lowercase letter. # Retry number is -1, because askForNewPart method add 1 to it in the first call. if self.resume: # read control file with open(self.control_json_file_path, "r") as f: data_dict = json.load(f) # read number of threads self.download_infromation_list = data_dict['download_infromation_list'] # read number_of_parts self.number_of_parts = data_dict['number_of_parts'] # set pending status for uncomplete parts for i in range(0, 64): if self.download_infromation_list[i][2] != 'complete': self.download_infromation_list[i] = [self.download_infromation_list[i][0], self.download_infromation_list[i][1], 'pending', -1] self.downloaded_size = self.downloaded_size + self.download_infromation_list[i][1] else: part_size = int(self.file_size // 64) # create new list. self.download_infromation_list = [[]] * 64 # if part_size greater than 1 MiB if part_size >= 1024**2: self.number_of_parts = 64 for i in range(0, 64): self.download_infromation_list[i] = [i * part_size, 0, 'pending', -1] else: # Calculate how many parts of one MiB we need. self.number_of_parts = int(self.file_size // (1024**2)) + 1 self.number_of_threads = self.number_of_parts for i in range(0, self.number_of_parts): self.download_infromation_list[i] = [i * 1024 * 1024, 0, 'pending', -1] # Set the starting byte number of the remaining parts equal to the size of the file. # The size of the file is equal to the last byte of the file. # The status of these parts is complete. Because we have nothing to download. for i in range(self.number_of_parts, 64): self.download_infromation_list[i] = [self.file_size, 0, 'complete', -1] # this method calculates download rate and ETA every second # and alculates sleep between data reception for limiting download rate. def downloadSpeed(self): # Calculate the difference between downloaded volume and elapsed time # and divide them to get the download speed. last_download_value = self.downloaded_size end_time = time.perf_counter() # this loop repeated every 5 second. while self.download_status == 'downloading' or self.download_status == 'paused': diffrence_time = time.perf_counter() - end_time diffrence_size = self.downloaded_size - last_download_value diffrence_size_converted, speed_unit = humanReadableSize( diffrence_size, 'speed') download_speed = round(diffrence_size_converted / diffrence_time, 2) self.download_speed_str = (str(download_speed) + " " + speed_unit + "/s") not_converted_download_speed = diffrence_size / diffrence_time try: # estimated time the download will be completed. eta_second = (self.file_size - self.downloaded_size) /\ not_converted_download_speed except Exception: eta_second = 0 self.eta = convertTime(eta_second) end_time = time.perf_counter() last_download_value = self.downloaded_size time.sleep(5) # this method shows progress bar def progressBar(self): size, unit = humanReadableSize(self.file_size) percent = 0 while (self.download_status == 'downloading' or self.download_status == 'paused'): time.sleep(0.5) percent = (self.downloaded_size / self.file_size) * 100 converted_downloaded_size = convertSize(self.downloaded_size, unit) show_download_information = (str(round(converted_downloaded_size, 2)) + '|' + str(size) + ' ' + unit) filled_up_Length = int(percent / 2) bar = ('*' * filled_up_Length + '-' * (50 - filled_up_Length)) # find downloded size of every part downloaded_size_list_str = "" if self.threads_progress_bar is True: for i in range(0, 64): part_size_converted, unit_part_size = humanReadableSize( self.download_infromation_list[i][1]) downloaded_size_list_str = ( downloaded_size_list_str + "part " + str(i + 1) + ": " + str(part_size_converted) + unit_part_size + "|") if i in list(range(3, 64, 4)): downloaded_size_list_str = downloaded_size_list_str + '\n' downloaded_size_list_str = downloaded_size_list_str + "\n" number_of_lines = downloaded_size_list_str.count("\n") else: number_of_lines = 0 # number os active threads active_connection = self.number_of_threads - self.finished_threads # delete last line sys.stdout.write( '[%s] %s%s ...%s, %s |connections:%s|ETA:%s\n%s' % ( bar, int(percent), '%', show_download_information, self.download_speed_str, active_connection, self.eta, downloaded_size_list_str)) sys.stdout.flush() # move curser to the first line and clear screen for i in list(range(number_of_lines + 1)): sys.stdout.write('\x1b[1A') sys.stdout.write('\x1b[2K') # print download complete message if self.download_status == 'complete': # cursor up one line sys.stdout.write('\x1b[1A') # delete last line sys.stdout.write('\x1b[2K') sys.stdout.write( '[%s] %s%s ...%s, %s \r' % ('Download complete!', int(100), '%', ('|' + str(size) + ' ' + unit), self.file_path)) sys.stdout.flush() elif self.download_status == 'stopped': show_download_information = (str(round(converted_downloaded_size, 2)) + '|' + str(size) + ' ' + unit) # cursor up one line sys.stdout.write('\x1b[1A') # delete last line sys.stdout.write('\x1b[2K') sys.stdout.write( '[%s] %s%s ...%s \n' % ('Download stopped!', int(percent), '%', show_download_information)) sys.stdout.write('\x1b[2K') sys.stdout.write(' Please wait...\n') sys.stdout.flush() elif self.download_status == 'error': show_download_information = (str(round(converted_downloaded_size, 2)) + '|' + str(size) + ' ' + unit) # cursor up one line sys.stdout.write('\x1b[1A') # delete last line sys.stdout.write('\x1b[2K') sys.stdout.write( '[%s] %s%s ...%s \n' % ('Error!', int(percent), '%', show_download_information)) sys.stdout.write('\x1b[2K') sys.stdout.write(' Please wait...\n') sys.stdout.flush() # this method runs progress bar and speed calculator def runProgressBar(self): # run a thread for calculating download speed. calculate_speed_thread = threading.Thread( target=self.downloadSpeed) calculate_speed_thread.setDaemon(True) calculate_speed_thread.start() # add thus thread to thread_list self.thread_list.append(calculate_speed_thread) if self.progress_bar is True: # run a thread for showing progress bar progress_bar_thread = threading.Thread( target=self.progressBar) progress_bar_thread.setDaemon(True) progress_bar_thread.start() # add thus thread to thread_list self.thread_list.append(progress_bar_thread) # threadHandler asks new part for download from this method. def askForNewPart(self): self.lock = True for i in range(0, self.number_of_parts): # Check that this part is not being downloaded or its download is not complete. # Check that the number of retries of this part has not reached the set limit. if (self.download_infromation_list[i][2] not in ['complete', 'downloading']) and (self.download_infromation_list[i][3] != self.retry): # set 'downloding' status for this part self.download_infromation_list[i][2] = 'downloading' # add 1 to retry number for this part self.download_infromation_list[i][3] += 1 break # no part found if i == self.number_of_parts: i = None self.lock = False return i # The below code is used for each chunk of file handled # by each thread for downloading the content from specified # location to storage def threadHandler(self, thread_number): while self.download_status == 'downloading' or self.download_status == 'paused': # Wait for the lock to be released. while self.lock is True: # Random sleep prevents two threads from downloading the same part at the same time. # sleep random time time.sleep(random.uniform(0, 0.5)) part_number = self.askForNewPart() # If part_number is None, no part is available for download. So exit the loop. if part_number is None: break try: # calculate part size if part_number != (self.number_of_parts - 1): part_size = self.download_infromation_list[part_number + 1][0] - self.download_infromation_list[part_number][0] else: part_size = self.file_size - self.download_infromation_list[part_number][0] # get start byte number of this part and add it to downloaded size. download resume from this byte number downloaded_part = self.download_infromation_list[part_number][1] start = self.download_infromation_list[part_number][0] + downloaded_part # end of part is equal to start of the next part if part_number != (self.number_of_parts - 1): end = self.download_infromation_list[part_number + 1][0] else: end = self.file_size # specify the start and end of the part for request header. chunk_headers = {'Range': 'bytes=%d-%d' % (start, end)} # request the specified part and get into variable self.requests_session.headers.update(chunk_headers) response = self.requests_session.get( self.link, allow_redirects=True, stream=True, timeout=self.timeout) # open the file and write the content of the html page # into file. # r+b mode is open the binary file in read or write mode. with open(self.file_path, "r+b") as fp: fp.seek(start) fp.tell() # why we use iter_content # Iterates over the response data. When stream=True is set on # the request, this avoids reading the content at once into # memory for large responses. The chunk size is the number # of bytes it should read into memory. This is not necessarily # the length of each item returned as decoding can take place. # so we divide our chunk to smaller chunks. default is 100 KiB python_request_chunk_size = (1024 * self.python_request_chunk_size) for data in response.iter_content( chunk_size=python_request_chunk_size): if self.download_status == 'downloading' or self.download_status == 'paused': fp.write(data) # maybe the last chunk is less than default chunk size if (part_size - downloaded_part) >= python_request_chunk_size: update_size = python_request_chunk_size # if update_size is not equal with actual data length, # then redownload this chunk. # exit this "for loop" for redownloading this chunk. if update_size != len(data): # This loop does not end due to an error in the request. # Therefore, no number should be added to the number of retries. self.download_infromation_list[part_number][3] -= 1 break else: # so the last small chunk is equal to : update_size = (part_size - downloaded_part) # so the last small chunk is equal to : update_size = (part_size - downloaded_part) # some times last chunks are smaller if len(data) < update_size: update_size = len(data) # if update_size is not equal with actual data length, # then redownload this chunk. # exit this "for loop" for redownloading this chunk. if update_size != len(data): # This loop does not end due to an error in the request. # Therefore, no number should be added to the number of retries. self.download_infromation_list[part_number][3] -= 1 break # update downloaded_part downloaded_part = (downloaded_part + update_size) # save value to downloaded_size_list self.download_infromation_list[part_number][1] = downloaded_part # this variable saves amount of total downloaded size # update downloaded_size self.downloaded_size = (self.downloaded_size + update_size) # perhaps user set limitation for download rate. # downloadrate limitation # "Speed limit" is whole number. The more it is, the more sleep time is given to the data # receiving loop, which reduces the download speed. time.sleep(self.sleep_for_speed_limiting) if self.download_status == 'paused': # wait for unpausing while self.download_status == 'paused': time.sleep(0.2) else: self.download_infromation_list[part_number][2] = 'stopped' break except Exception as e: self.download_infromation_list[part_number][2] = 'error' error_text = ("part_number: " + str(part_number) + " " + str(e)) sendToLog(error_text) # so it's complete successfully. if (downloaded_part == part_size): sendToLog('part ' + str(part_number) + ' is complete!') self.download_infromation_list[part_number][2] = 'complete' else: self.download_infromation_list[part_number][2] = 'error' # This thread is finished. self.finished_threads = self.finished_threads + 1 # this method save download information in json format every 1 second def saveInfo(self): while self.download_status == 'downloading' or self.download_status == 'paused': control_dict = { 'ETag': self.etag, 'file_name': self.file_name, 'file_size': self.file_size, 'number_of_parts': self.number_of_parts, 'download_infromation_list': self.download_infromation_list} # write control_dict in json file with open(self.control_json_file_path, "w") as outfile: json.dump(control_dict, outfile, indent=2) time.sleep(1) # this method runs download threads def runDownloadThreads(self): # check if server supports multithread downloading or not! if self.multiThreadSupport() is False: self.thread_number = 1 for i in range(0, self.number_of_threads): # sleep between starting new thread. # it solves "Connection refused" error. time.sleep(0.1) # create threads t = threading.Thread( target=self.threadHandler, kwargs={'thread_number': i}) t.setDaemon(True) t.start() # add this thread to thread_list self.thread_list.append(t) # run saveInfo thread for updating control file save_control_thread = threading.Thread( target=self.saveInfo) save_control_thread.setDaemon(True) save_control_thread.start() # add this thread to thread_list self.thread_list.append(save_control_thread) # this method checks and manages download progress. def checkDownloadProgress(self): # Run this loop until the download is finished. while (self.file_size != self.downloaded_size) and (self.download_status == 'downloading' or self.download_status == 'paused') and \ (self.finished_threads != self.number_of_threads): # Calculate download percent self.download_percent = int((self.downloaded_size / self.file_size) * 100) # Calculate number of active threads self.number_of_active_connections = self.number_of_threads - self.finished_threads time.sleep(1) # Calculate download percent self.download_percent = int((self.downloaded_size / self.file_size) * 100) sendToLog(str(self.finished_threads)) # If the downloaded size is the same as the file size, then the download has been completed successfully. if self.file_size == self.downloaded_size: self.download_status = 'complete' sendToLog('Download complete.') # If the download is not complete and the user has not stopped the download, then the download has encountered an error. elif self.download_status != 'stopped': self.download_status = 'error' sendToLog('Error') elif self.download_status == 'stopped': sendToLog('Download stopped.') print('\r', flush=True) # this method starts download def start(self): self.createSession() file_size = self.getFileSize() if file_size: self.setRetry() self.download_status = 'downloading' self.getFileName() self.getFileTag() self.createControlFile() self.definePartSizes() self.runProgressBar() self.runDownloadThreads() self.checkDownloadProgress() else: self.download_status = 'error' self.close() def stop(self, signum, frame): self.download_status = 'stopped' def downloadPause(self): self.download_status = 'paused' def downloadUnpause(self): self.download_status = 'downloading' # This method returns download status def tellStatus(self): downloded_size, downloaded_size_unit = humanReadableSize(self.downloaded_size) file_size, file_size_unit = humanReadableSize(self.file_size) # return information in dictionary format download_info = { 'file_name': self.file_name, 'status': self.download_status, 'size': str(file_size) + ' ' + file_size_unit, 'downloaded_size': str(downloded_size) + ' ' + downloaded_size_unit, 'percent': str(self.download_percent) + '%', 'connections': str(self.number_of_active_connections), 'rate': self.download_speed_str, 'estimate_time_left': self.eta, 'link': self.link } return download_info # This method limits download speed. # limit_value is between 1 to 10. # 10 means no limit speed. def limitSpeed(self, limit_value): # Calculate sleep time between data receiving. It's reduce download speed. self.sleep_for_speed_limiting = (10 - limit_value) * 0.005 * (self.number_of_active_connections) def close(self): # if download complete, so delete control file if self.download_status == 'complete': os.remove(self.control_json_file_path) # delete last line if self.progress_bar is True: sys.stdout.write('\x1b[2K') sys.stdout.write(' persepolis_lib is closed!\n') sys.stdout.flush() # close requests session self.requests_session.close() # ask threads for exiting. for thread in self.thread_list: thread.join() sendToLog("persepolis_lib is closed!") persepolisdm-persepolis_lib-7920870/persepolis_lib/useful_tools.py000066400000000000000000000074071467551761700255760ustar00rootroot00000000000000# -*- coding: utf-8 -*- # 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 . from pathlib import Path import urllib.parse import logging import os import requests # define logging object logObj = logging.getLogger("Persepolis") logObj.setLevel(logging.INFO) # don't show log in console logObj.propagate = False log_file = os.path.join(os.path.expanduser('~'), 'persepolis_lib_log.log') # create a file handler handler = logging.FileHandler(log_file) handler.setLevel(logging.INFO) # create a logging format formatter = logging.Formatter( '%(asctime)s - %(name)s - %(levelname)s - %(message)s') handler.setFormatter(formatter) # add the handlers to the logger logObj.addHandler(handler) def sendToLog(text="", type="INFO"): if type == "INFO": logObj.info(text) elif type == "ERROR": logObj.error(text) else: logObj.warning(text) # this function converts second to hour and minute def convertTime(time): minutes = int(time // 60) if minutes == 0: return str(int(time)) + 's' elif minutes < 60: return str(minutes) + 'm' else: hours = minutes // 60 minutes = minutes - (hours * 60) return str(hours) + 'h ' + str(minutes) + 'm' # this function converts file_size to KiB or MiB or GiB def humanReadableSize(size, input_type='file_size'): labels = ['KiB', 'MiB', 'GiB', 'TiB'] i = -1 if size < 1024: return size, 'B' while size >= 1024: i += 1 size = size / 1024 if input_type == 'speed': j = 0 else: j = 1 if i > j: return round(size, 2), labels[i] else: return round(size, None), labels[i] def convertSize(size, unit): if unit == 'B': converted_size = size elif unit == 'KiB': converted_size = size / 1024 elif unit == 'MiB': converted_size = size / 1024**2 elif unit == 'GiB': converted_size = size / 1024**3 elif unit == 'TiB': converted_size = size / 1024**4 return round(converted_size, 2) # this method get http header as string and convert it to dictionary def convertHeaderToDictionary(headers): dic = {} for line in headers.split("\n"): if line.startswith(("GET", "POST")): continue point_index = line.find(":") dic[line[:point_index].strip()] = line[point_index + 1:].strip() return dic def readCookieJar(load_cookies): jar = None if os.path.isfile(load_cookies): # Open cookie file cookies_txt = open(load_cookies, 'r') # Initialize RequestsCookieJar jar = requests.cookies.RequestsCookieJar() for line in cookies_txt.readlines(): words = line.split() # Filter out lines that don't contain cookies if (len(words) == 7) and (words[0] != "#"): # Split cookies into the appropriate parameters jar.set(words[5], words[6], domain=words[0], path=words[2]) return jar # get file name from link string. def getFileNameFromLink(link): link = requests.utils.unquote(link) parsed_linkd = urllib.parse.urlparse(link) file_name = Path(parsed_linkd.path).name return file_name persepolisdm-persepolis_lib-7920870/pyproject.toml000066400000000000000000000017501467551761700223750ustar00rootroot00000000000000[build-system] requires = ["hatchling"] build-backend = "hatchling.build" [tool.setuptools] py-modules = ["persepolis_lib"] [project] name = "persepolis_lib" version = "1.0.2" dependencies = [ "requests", "urllib3", "pysocks" ] requires-python = ">=3.5" authors = [ {name = "AliReza AmirSamimi", email = "alireza.amirsamimi@gmail.com"} ] maintainers = [ {name = "AliReza AmirSamimi", email = "alireza.amirsamimi@gmail.com"} ] description = "A Python library for easier and faster downloading." readme = "README.md" license = {file = "LICENSE"} keywords = ["persepolis", "download manager", "persepolis_lib"] classifiers = [ "Development Status :: 5 - Production/Stable", "Programming Language :: Python" ] [project.urls] Homepage = "https://github.com/persepolisdm/persepolis_lib" Documentation = "https://github.com/persepolisdm/persepolis_lib/README.md" Repository = "https://github.com/persepolisdm/persepolis_lib" Issues = "https://github.com/persepolisdm/persepolis_lib/issues" persepolisdm-persepolis_lib-7920870/test/000077500000000000000000000000001467551761700204355ustar00rootroot00000000000000persepolisdm-persepolis_lib-7920870/test/test.py000077500000000000000000000132111467551761700217670ustar00rootroot00000000000000#!/usr/bin/env python3 # -*- coding: utf-8 -*- # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # # You should have received a copy of the GNU General Public License # along with this program. If not, see . import signal import argparse import sys import os import platform # finding os platform os_type = platform.system() # Don't run persepolis as root! if os_type == 'Linux' or os_type == 'FreeBSD' or os_type == 'OpenBSD' or os_type == 'Darwin': uid = os.getuid() if uid == 0: print('Do not run persepolis_lib as root.') sys.exit(1) cwd = os.path.abspath(__file__) run_dir = os.path.dirname(cwd) # if persepolis run in test folder print('persepolis_lib is running from test folder') parent_dir = os.path.dirname(run_dir) sys.path.insert(0, parent_dir) from persepolis_lib.persepolis_lib import Download # create terminal arguments parser = argparse.ArgumentParser( description='Persepolis command line download utility') parser.add_argument('--version', action='version', version='Persepolis CMD 0.0.1') parser.add_argument('--link', action='store', nargs=1, help='Download link.(Use "" for links)') parser.add_argument('--name', action='store', nargs=1, help='The file name of the downloaded file\ with extension.') parser.add_argument('--number-of-threads', action='store', nargs=1, help='Number of threads.') parser.add_argument('--download-path', action='store', nargs=1, help='Set download path.') parser.add_argument('--proxy-ip', action='store', nargs=1, help='Proxy IP') parser.add_argument('--proxy-port', action='store', nargs=1, help='proxy port') parser.add_argument('--proxy-user', action='store', nargs=1, help='Proxy user name') parser.add_argument('--proxy-password', action='store', nargs=1, help='Proxy pass word') parser.add_argument('--proxy-type', action='store', nargs=1, help='set type proxy. http or socks5') parser.add_argument('--download-user', action='store', nargs=1, help='Download user name') parser.add_argument('--download-password', action='store', nargs=1, help='Download pass word') parser.add_argument('--header', action='store', nargs=1, help='Append HEADER to HTTP request header.') parser.add_argument('--user-agent', action='store', nargs=1, help='Set user agent for HTTP(S) downloads.') parser.add_argument('--cookie', action='store', nargs=1, help='Cookies file path') parser.add_argument('--referrer', action='store', nargs=1, help='Set an http referrer') parser.add_argument('--chunk-size', action='store', nargs=1, help='Chunk size in KiB, Default is 200 KiB') args, unknownargs = parser.parse_known_args() add_link_dictionary = {'link': None, 'out': None, 'download_path': None, 'ip': None, 'port': None, 'proxy_user': None, 'proxy_passwd': None, 'proxy_type': None, 'download_user': None, 'download_passwd': None, 'header': None, 'user_agent': None, 'load_cookies': None, 'referer': None} if args.link: add_link_dictionary['link'] = "".join(args.link) if args.name: add_link_dictionary['out'] = "".join(args.name) if args.download_path: add_link_dictionary['download_path'] = "".join(args.download_path) if args.proxy_ip: add_link_dictionary['ip'] = "".join(args.proxy_ip) if args.proxy_port: add_link_dictionary['port'] = "".join(args.proxy_port) if args.proxy_user: add_link_dictionary['proxy_user'] = "".join(args.proxy_user) if args.proxy_password: add_link_dictionary['proxy_passwd'] = "".join(args.proxy_password) if args.proxy_type: add_link_dictionary['proxy_type'] = "".join(args.proxy_type) if args.download_user: add_link_dictionary['download_user'] = "".join(args.download_user) if args.download_password: add_link_dictionary['download_passwd'] = "".join(args.download_password) if args.header: add_link_dictionary['header'] = "".join(args.header) if args.user_agent: add_link_dictionary['user_agent'] = "".join(args.user_agent) if args.cookie: add_link_dictionary['load_cookies'] = "".join(args.cookie) if args.referrer: add_link_dictionary['referer'] = "".join(args.referrer) if args.number_of_threads: number_of_threads = "".join(args.number_of_threads) else: number_of_threads = 4 if args.chunk_size: chunk_size = "".join(args.chunk_size) else: chunk_size = 200 if __name__ == '__main__': # create download object download_item = Download(add_link_dictionary, int(number_of_threads), int(chunk_size), progress_bar=True, threads_progress_bar=False) # capture SIGINT signal signal.signal(signal.SIGINT, download_item.stop) # start download download_item.start()