commit aa0f88af9edb5ec57c2972f142f3c8800d39f56c Author: coder Date: Sun Apr 19 13:15:44 2020 +1000 Init repo w/ existing codebase diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..e61bca2 --- /dev/null +++ b/.gitignore @@ -0,0 +1,116 @@ +# ---> Python +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.nox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +.hypothesis/ +.pytest_cache/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# IPython +profile_default/ +ipython_config.py + +# pyenv +.python-version + +# celery beat schedule file +celerybeat-schedule + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +# Pyre type checker +.pyre/ + diff --git a/COPYING b/COPYING new file mode 100644 index 0000000..be3f7b2 --- /dev/null +++ b/COPYING @@ -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/CREDITS b/CREDITS new file mode 100644 index 0000000..fc9b7ba --- /dev/null +++ b/CREDITS @@ -0,0 +1,7 @@ +Contributors to IMM: +* imm + +Projects has been used in IMM: +* Python programming language +* youtube-dl +* pyperclip diff --git a/Code/IMM/GeneralFunctions/DataStructureManupulations.py b/Code/IMM/GeneralFunctions/DataStructureManupulations.py new file mode 100644 index 0000000..cc3fb8b --- /dev/null +++ b/Code/IMM/GeneralFunctions/DataStructureManupulations.py @@ -0,0 +1,55 @@ +from sys import platform as OperatingSystem + +Quotes = '"\'' + +if OperatingSystem == "win32": + PathSlash = '\\' +else: + PathSlash = '/' +FileProtocol = "file:" + 2*PathSlash + +def ConvertToStandardPathFormat(Path): + """ Example, + Input: '"file:///some/path/somefile.extension" + Output: /some/path/somefile.extension + """ + Path = Path.strip(Quotes) + if Path.startswith(FileProtocol): + Path = Path[len(FileProtocol):] + return Path + +def GetTextAfter(Text, ReadlinesTextFile): + for Lines in range(len(ReadlinesTextFile)): + Line = ReadlinesTextFile[Lines].strip('\n') + if Line.startswith(Text): + return Line[len(Text):] + return '' + +def SingleQuoteString(String): + if len(String) > 0: + if String[0] != '\'' or String[-1] != '\'': + String = '\'' + String + '\'' + return String + +def DoubleQuoteString(String): + if len(String) > 0: + if String[0] != '"' or String[-1] != '"': + String = '"' + String + '"' + return String + +def ListIntoString(List, QuoteItems=0, Seprator=' '): + if QuoteItems == 2: + for i in range(len(List)): + Quoteditem = DoubleQuoteString(List[i]) + List[i] = Quoteditem + elif QuoteItems == 1: + for i in range(len(List)): + Quoteditem = SingleQuoteString(List[i]) + List[i] = Quoteditem + Stringoflist = (Seprator).join(List) + return Stringoflist + +def StandardVariableName(Variable): + Variable = Variable.casefold() + Variable = Variable.replace('_', '').replace(' ', '') + return Variable diff --git a/Code/IMM/GeneralFunctions/InputOutput.py b/Code/IMM/GeneralFunctions/InputOutput.py new file mode 100644 index 0000000..ae00e95 --- /dev/null +++ b/Code/IMM/GeneralFunctions/InputOutput.py @@ -0,0 +1,29 @@ +from os.path import isfile as DoesFileExist + +from .DataStructureManupulations import ConvertToStandardPathFormat + +def ReadTextFile(FilePath): + FilePath = ConvertToStandardPathFormat(FilePath) + if DoesFileExist(FilePath) is True: + File = open(FilePath) + ReadFile = File.read() + File.close() + return ReadFile + else: + return '' + +def ReadlinesTextFile(FilePath): + String = ReadTextFile(FilePath) + return String.split('\n') + +def WriteGeneralTextFiles(Text, FilePath): + if type(Text) != str: + Text = '\n'.join(Text) + File = open(FilePath, 'w') + File.write(Text) + File.close() + +def WriteBinaryToFile(Filepath, Data): + File=open(Filepath, 'wb') + File.write(Data) + File.close() diff --git a/Code/IMM/GeneralFunctions/Network.py b/Code/IMM/GeneralFunctions/Network.py new file mode 100644 index 0000000..c506405 --- /dev/null +++ b/Code/IMM/GeneralFunctions/Network.py @@ -0,0 +1,8 @@ +import ssl +from urllib.request import urlopen + +HttpsContext = ssl.create_default_context() + +def Download(Url): + return urlopen(Url, context=HttpsContext).read() + diff --git a/Code/IMM/GeneralFunctions/__init__.py b/Code/IMM/GeneralFunctions/__init__.py new file mode 100644 index 0000000..8d1c8b6 --- /dev/null +++ b/Code/IMM/GeneralFunctions/__init__.py @@ -0,0 +1 @@ + diff --git a/Code/IMM/SetupAndConfiguration/Setup.py b/Code/IMM/SetupAndConfiguration/Setup.py new file mode 100644 index 0000000..7756892 --- /dev/null +++ b/Code/IMM/SetupAndConfiguration/Setup.py @@ -0,0 +1,98 @@ +""" +This module is work-in-progress and not used by IMM currently +Assumes to be called from IMM root directory +""" +from platform import machine as HardwareArchitecture +import subprocess +from sys import platform + +from ..GeneralFunctions.Network import Download +from ..GeneralFunctions.InputOutput import WriteBinaryToFile + + # FIXME change path slash for windows +VirtualEnv="Code/Dependencies/" +VirtualEnvBinDir=VirtualEnv+"bin/" +VirtualEnvPip=VirtualEnvBinDir+"pip" + +def CreateVirtualEnvrionment(): + print( + "Creating virtual envrionment for dependecies in "+VirtualEnv+ + " sub-directory") + subprocess.run( + "python3", "-m", "venv", "--copies", VirtualEnv) + +def InstallPythonPackage(PackageName): + print("Installing "+PackageName+" from Python Package Index (PyPI)") + subprocess.run(VirtualEnvPip, "install ", PackageName, "--upgrade") + +def SetupFFmpeg(): + # check if FFmpeg already exists + OperatingSystem = GetOperatingSystemName() + # check OS & Architecture and choose appropriate url & extraction command, alternative function name as for GNU/Linux, Windows (MacOS also?) + # For now download URLs are static for WIndows release & bumped periodically + # GNU/Linux - https://johnvansickle.com/ffmpeg/ + # MacOS - https://evermeet.cx/ffmpeg/ , alternatively https://ffmpeg.zeranoe.com/builds/macos64/static/ + # Widnows - https://ffmpeg.zeranoe.com/builds/win64/static/ & https://ffmpeg.zeranoe.com/builds/win32/static/?C=M&O=D + Architecture = HardwareArchitecture() + CannotInstallFFmpeg = ( + "Do not have a recipie for automatically fetching ffmpeg " + "for "+Architecture+" architecture on "+OperatingSystem+ + " operating system. Please install manually, else IMM " + "will run without it with limited capabilities.") + if len(Architecture) == 0: + print( + "Could not determine system architecture. IMM will work " + "without ffmpeg") + return False + if OperatingSystem == "GNU/Linux": + if Architecture == "x86_64": + DownloadParameter = "amd64" + elif Architecture == "i386" or Architecture == "i686" : + DownloadParameter = "i686" + elif Architecture == "armv71" or Architecture == "armhf": + DownloadParameter = "armhf" + elif Architecture == "armel" : + DownloadParameter = "armel" + elif ( + Architecture == "aarch64_be" or + Architecture == "aarch64" or + Architecture == "armv8b" or + Architecture == "armv8l" or + Architecture == "arm64"): + DownloadParameter = "arm64" + else: + print(CannotInstallFFmpeg) + DownloadURL = ( + "https://johnvansickle.com/ffmpeg/releases/ffmpeg-release-" + +DownloadParameter+"-static.tar.xz") + print("Downloading ffmpeg from "+DownloadURL) + Data = Download(DownloadURL) + WriteBinaryToFile(VirtualEnv+"ffmpeg.tar.xz", Data) + print( + "Extracting file than moving ffmpeg binaries to virtual " + "envrionment bin directory and finally cleaning up") + subprocess.run( + "tar xvf ffmpeg.tar.xz && mv ffmpeg-*/ff* ./bin/ && rm -R ffmpeg*" , + shell=True, + stdout=subprocess.PIPE, + cwd=VirtualEnv) + else: + print(CannotInstallFFmpeg) + +def GetOperatingSystemName(): + if platform == "linux": + return "GNU/Linux" + elif platform == "win32": + return "Windows" + elif platform == "darwin": + return "Mac OS" + else: + return platform + +def Setup(): + CreateVirtualEnvrionment() + InstallPythonPackage("youtube-dl") + InstallPythonPackage("pyperclip") + SetupFFmpeg() + +SetupFFmpeg() diff --git a/Code/IMM/SetupAndConfiguration/__init__.py b/Code/IMM/SetupAndConfiguration/__init__.py new file mode 100644 index 0000000..8d1c8b6 --- /dev/null +++ b/Code/IMM/SetupAndConfiguration/__init__.py @@ -0,0 +1 @@ + diff --git a/Code/IMM/__init__.py b/Code/IMM/__init__.py new file mode 100644 index 0000000..8d1c8b6 --- /dev/null +++ b/Code/IMM/__init__.py @@ -0,0 +1 @@ + diff --git a/Code/PythonModules/pyperclip/__init__.py b/Code/PythonModules/pyperclip/__init__.py new file mode 100644 index 0000000..de5b772 --- /dev/null +++ b/Code/PythonModules/pyperclip/__init__.py @@ -0,0 +1,611 @@ +""" +Pyperclip + +A cross-platform clipboard module for Python, with copy & paste functions for plain text. +By Al Sweigart al@inventwithpython.com +BSD License + +Usage: + import pyperclip + pyperclip.copy('The text to be copied to the clipboard.') + spam = pyperclip.paste() + + if not pyperclip.is_available(): + print("Copy functionality unavailable!") + +On Windows, no additional modules are needed. +On Mac, the pyobjc module is used, falling back to the pbcopy and pbpaste cli + commands. (These commands should come with OS X.). +On Linux, install xclip or xsel via package manager. For example, in Debian: + sudo apt-get install xclip + sudo apt-get install xsel + +Otherwise on Linux, you will need the gtk or PyQt5/PyQt4 modules installed. + +gtk and PyQt4 modules are not available for Python 3, +and this module does not work with PyGObject yet. + +Note: There seem sto be a way to get gtk on Python 3, according to: + https://askubuntu.com/questions/697397/python3-is-not-supporting-gtk-module + +Cygwin is currently not supported. + +Security Note: This module runs programs with these names: + - which + - where + - pbcopy + - pbpaste + - xclip + - xsel + - klipper + - qdbus +A malicious user could rename or add programs with these names, tricking +Pyperclip into running them with whatever permissions the Python process has. + +""" +__version__ = '1.6.0' + +import contextlib +import ctypes +import os +import platform +import subprocess +import sys +import time +import warnings + +from ctypes import c_size_t, sizeof, c_wchar_p, get_errno, c_wchar + + +# `import PyQt4` sys.exit()s if DISPLAY is not in the environment. +# Thus, we need to detect the presence of $DISPLAY manually +# and not load PyQt4 if it is absent. +HAS_DISPLAY = os.getenv("DISPLAY", False) + +EXCEPT_MSG = """ + Pyperclip could not find a copy/paste mechanism for your system. + For more information, please visit https://pyperclip.readthedocs.io/en/latest/introduction.html#not-implemented-error """ + +PY2 = sys.version_info[0] == 2 + +STR_OR_UNICODE = unicode if PY2 else str + +ENCODING = 'utf-8' + +# The "which" unix command finds where a command is. +if platform.system() == 'Windows': + WHICH_CMD = 'where' +else: + WHICH_CMD = 'which' + +def _executable_exists(name): + return subprocess.call([WHICH_CMD, name], + stdout=subprocess.PIPE, stderr=subprocess.PIPE) == 0 + + + +# Exceptions +class PyperclipException(RuntimeError): + pass + +class PyperclipWindowsException(PyperclipException): + def __init__(self, message): + message += " (%s)" % ctypes.WinError() + super(PyperclipWindowsException, self).__init__(message) + + + +def init_osx_pbcopy_clipboard(): + + def copy_osx_pbcopy(text): + p = subprocess.Popen(['pbcopy', 'w'], + stdin=subprocess.PIPE, close_fds=True) + p.communicate(input=text.encode(ENCODING)) + + def paste_osx_pbcopy(): + p = subprocess.Popen(['pbpaste', 'r'], + stdout=subprocess.PIPE, close_fds=True) + stdout, stderr = p.communicate() + return stdout.decode(ENCODING) + + return copy_osx_pbcopy, paste_osx_pbcopy + + +def init_osx_pyobjc_clipboard(): + def copy_osx_pyobjc(text): + '''Copy string argument to clipboard''' + newStr = Foundation.NSString.stringWithString_(text).nsstring() + newData = newStr.dataUsingEncoding_(Foundation.NSUTF8StringEncoding) + board = AppKit.NSPasteboard.generalPasteboard() + board.declareTypes_owner_([AppKit.NSStringPboardType], None) + board.setData_forType_(newData, AppKit.NSStringPboardType) + + def paste_osx_pyobjc(): + "Returns contents of clipboard" + board = AppKit.NSPasteboard.generalPasteboard() + content = board.stringForType_(AppKit.NSStringPboardType) + return content + + return copy_osx_pyobjc, paste_osx_pyobjc + + +def init_gtk_clipboard(): + global gtk + import gtk + + def copy_gtk(text): + global cb + cb = gtk.Clipboard() + cb.set_text(text) + cb.store() + + def paste_gtk(): + clipboardContents = gtk.Clipboard().wait_for_text() + # for python 2, returns None if the clipboard is blank. + if clipboardContents is None: + return '' + else: + return clipboardContents + + return copy_gtk, paste_gtk + + +def init_qt_clipboard(): + global QApplication + # $DISPLAY should exist + + # Try to import from qtpy, but if that fails try PyQt5 then PyQt4 + try: + from qtpy.QtWidgets import QApplication + except: + try: + from PyQt5.QtWidgets import QApplication + except: + from PyQt4.QtGui import QApplication + + app = QApplication.instance() + if app is None: + app = QApplication([]) + + def copy_qt(text): + cb = app.clipboard() + cb.setText(text) + + def paste_qt(): + cb = app.clipboard() + return STR_OR_UNICODE(cb.text()) + + return copy_qt, paste_qt + + +def init_xclip_clipboard(): + DEFAULT_SELECTION='c' + PRIMARY_SELECTION='p' + + def copy_xclip(text, primary=False): + selection=DEFAULT_SELECTION + if primary: + selection=PRIMARY_SELECTION + p = subprocess.Popen(['xclip', '-selection', selection], + stdin=subprocess.PIPE, close_fds=True) + p.communicate(input=text.encode(ENCODING)) + + def paste_xclip(primary=False): + selection=DEFAULT_SELECTION + if primary: + selection=PRIMARY_SELECTION + p = subprocess.Popen(['xclip', '-selection', selection, '-o'], + stdout=subprocess.PIPE, + stderr=subprocess.PIPE, + close_fds=True) + stdout, stderr = p.communicate() + # Intentionally ignore extraneous output on stderr when clipboard is empty + return stdout.decode(ENCODING) + + return copy_xclip, paste_xclip + + +def init_xsel_clipboard(): + DEFAULT_SELECTION='-b' + PRIMARY_SELECTION='-p' + + def copy_xsel(text, primary=False): + selection_flag = DEFAULT_SELECTION + if primary: + selection_flag = PRIMARY_SELECTION + p = subprocess.Popen(['xsel', selection_flag, '-i'], + stdin=subprocess.PIPE, close_fds=True) + p.communicate(input=text.encode(ENCODING)) + + def paste_xsel(primary=False): + selection_flag = DEFAULT_SELECTION + if primary: + selection_flag = PRIMARY_SELECTION + p = subprocess.Popen(['xsel', selection_flag, '-o'], + stdout=subprocess.PIPE, close_fds=True) + stdout, stderr = p.communicate() + return stdout.decode(ENCODING) + + return copy_xsel, paste_xsel + + +def init_klipper_clipboard(): + def copy_klipper(text): + p = subprocess.Popen( + ['qdbus', 'org.kde.klipper', '/klipper', 'setClipboardContents', + text.encode(ENCODING)], + stdin=subprocess.PIPE, close_fds=True) + p.communicate(input=None) + + def paste_klipper(): + p = subprocess.Popen( + ['qdbus', 'org.kde.klipper', '/klipper', 'getClipboardContents'], + stdout=subprocess.PIPE, close_fds=True) + stdout, stderr = p.communicate() + + # Workaround for https://bugs.kde.org/show_bug.cgi?id=342874 + # TODO: https://github.com/asweigart/pyperclip/issues/43 + clipboardContents = stdout.decode(ENCODING) + # even if blank, Klipper will append a newline at the end + assert len(clipboardContents) > 0 + # make sure that newline is there + assert clipboardContents.endswith('\n') + if clipboardContents.endswith('\n'): + clipboardContents = clipboardContents[:-1] + return clipboardContents + + return copy_klipper, paste_klipper + + +def init_dev_clipboard_clipboard(): + def copy_dev_clipboard(text): + if text == '': + warnings.warn('Pyperclip cannot copy a blank string to the clipboard on Cygwin. This is effectively a no-op.') + if '\r' in text: + warnings.warn('Pyperclip cannot handle \\r characters on Cygwin.') + + fo = open('/dev/clipboard', 'wt') + fo.write(text) + fo.close() + + def paste_dev_clipboard(): + fo = open('/dev/clipboard', 'rt') + content = fo.read() + fo.close() + return content + + return copy_dev_clipboard, paste_dev_clipboard + + +def init_no_clipboard(): + class ClipboardUnavailable(object): + + def __call__(self, *args, **kwargs): + raise PyperclipException(EXCEPT_MSG) + + if PY2: + def __nonzero__(self): + return False + else: + def __bool__(self): + return False + + return ClipboardUnavailable(), ClipboardUnavailable() + + + + +# Windows-related clipboard functions: +class CheckedCall(object): + def __init__(self, f): + super(CheckedCall, self).__setattr__("f", f) + + def __call__(self, *args): + ret = self.f(*args) + if not ret and get_errno(): + raise PyperclipWindowsException("Error calling " + self.f.__name__) + return ret + + def __setattr__(self, key, value): + setattr(self.f, key, value) + + +def init_windows_clipboard(): + global HGLOBAL, LPVOID, DWORD, LPCSTR, INT, HWND, HINSTANCE, HMENU, BOOL, UINT, HANDLE + from ctypes.wintypes import (HGLOBAL, LPVOID, DWORD, LPCSTR, INT, HWND, + HINSTANCE, HMENU, BOOL, UINT, HANDLE) + + windll = ctypes.windll + msvcrt = ctypes.CDLL('msvcrt') + + safeCreateWindowExA = CheckedCall(windll.user32.CreateWindowExA) + safeCreateWindowExA.argtypes = [DWORD, LPCSTR, LPCSTR, DWORD, INT, INT, + INT, INT, HWND, HMENU, HINSTANCE, LPVOID] + safeCreateWindowExA.restype = HWND + + safeDestroyWindow = CheckedCall(windll.user32.DestroyWindow) + safeDestroyWindow.argtypes = [HWND] + safeDestroyWindow.restype = BOOL + + OpenClipboard = windll.user32.OpenClipboard + OpenClipboard.argtypes = [HWND] + OpenClipboard.restype = BOOL + + safeCloseClipboard = CheckedCall(windll.user32.CloseClipboard) + safeCloseClipboard.argtypes = [] + safeCloseClipboard.restype = BOOL + + safeEmptyClipboard = CheckedCall(windll.user32.EmptyClipboard) + safeEmptyClipboard.argtypes = [] + safeEmptyClipboard.restype = BOOL + + safeGetClipboardData = CheckedCall(windll.user32.GetClipboardData) + safeGetClipboardData.argtypes = [UINT] + safeGetClipboardData.restype = HANDLE + + safeSetClipboardData = CheckedCall(windll.user32.SetClipboardData) + safeSetClipboardData.argtypes = [UINT, HANDLE] + safeSetClipboardData.restype = HANDLE + + safeGlobalAlloc = CheckedCall(windll.kernel32.GlobalAlloc) + safeGlobalAlloc.argtypes = [UINT, c_size_t] + safeGlobalAlloc.restype = HGLOBAL + + safeGlobalLock = CheckedCall(windll.kernel32.GlobalLock) + safeGlobalLock.argtypes = [HGLOBAL] + safeGlobalLock.restype = LPVOID + + safeGlobalUnlock = CheckedCall(windll.kernel32.GlobalUnlock) + safeGlobalUnlock.argtypes = [HGLOBAL] + safeGlobalUnlock.restype = BOOL + + wcslen = CheckedCall(msvcrt.wcslen) + wcslen.argtypes = [c_wchar_p] + wcslen.restype = UINT + + GMEM_MOVEABLE = 0x0002 + CF_UNICODETEXT = 13 + + @contextlib.contextmanager + def window(): + """ + Context that provides a valid Windows hwnd. + """ + # we really just need the hwnd, so setting "STATIC" + # as predefined lpClass is just fine. + hwnd = safeCreateWindowExA(0, b"STATIC", None, 0, 0, 0, 0, 0, + None, None, None, None) + try: + yield hwnd + finally: + safeDestroyWindow(hwnd) + + @contextlib.contextmanager + def clipboard(hwnd): + """ + Context manager that opens the clipboard and prevents + other applications from modifying the clipboard content. + """ + # We may not get the clipboard handle immediately because + # some other application is accessing it (?) + # We try for at least 500ms to get the clipboard. + t = time.time() + 0.5 + success = False + while time.time() < t: + success = OpenClipboard(hwnd) + if success: + break + time.sleep(0.01) + if not success: + raise PyperclipWindowsException("Error calling OpenClipboard") + + try: + yield + finally: + safeCloseClipboard() + + def copy_windows(text): + # This function is heavily based on + # http://msdn.com/ms649016#_win32_Copying_Information_to_the_Clipboard + with window() as hwnd: + # http://msdn.com/ms649048 + # If an application calls OpenClipboard with hwnd set to NULL, + # EmptyClipboard sets the clipboard owner to NULL; + # this causes SetClipboardData to fail. + # => We need a valid hwnd to copy something. + with clipboard(hwnd): + safeEmptyClipboard() + + if text: + # http://msdn.com/ms649051 + # If the hMem parameter identifies a memory object, + # the object must have been allocated using the + # function with the GMEM_MOVEABLE flag. + count = wcslen(text) + 1 + handle = safeGlobalAlloc(GMEM_MOVEABLE, + count * sizeof(c_wchar)) + locked_handle = safeGlobalLock(handle) + + ctypes.memmove(c_wchar_p(locked_handle), c_wchar_p(text), count * sizeof(c_wchar)) + + safeGlobalUnlock(handle) + safeSetClipboardData(CF_UNICODETEXT, handle) + + def paste_windows(): + with clipboard(None): + handle = safeGetClipboardData(CF_UNICODETEXT) + if not handle: + # GetClipboardData may return NULL with errno == NO_ERROR + # if the clipboard is empty. + # (Also, it may return a handle to an empty buffer, + # but technically that's not empty) + return "" + return c_wchar_p(handle).value + + return copy_windows, paste_windows + + + + +# Automatic detection of clipboard mechanisms and importing is done in deteremine_clipboard(): +def determine_clipboard(): + ''' + Determine the OS/platform and set the copy() and paste() functions + accordingly. + ''' + + global Foundation, AppKit, gtk, qtpy, PyQt4, PyQt5 + + # Setup for the CYGWIN platform: + if 'cygwin' in platform.system().lower(): # Cygwin has a variety of values returned by platform.system(), such as 'CYGWIN_NT-6.1' + # FIXME: pyperclip currently does not support Cygwin, + # see https://github.com/asweigart/pyperclip/issues/55 + if os.path.exists('/dev/clipboard'): + warnings.warn('Pyperclip\'s support for Cygwin is not perfect, see https://github.com/asweigart/pyperclip/issues/55') + return init_dev_clipboard_clipboard() + + # Setup for the WINDOWS platform: + elif os.name == 'nt' or platform.system() == 'Windows': + return init_windows_clipboard() + + # Setup for the MAC OS X platform: + if os.name == 'mac' or platform.system() == 'Darwin': + try: + import Foundation # check if pyobjc is installed + import AppKit + except ImportError: + return init_osx_pbcopy_clipboard() + else: + return init_osx_pyobjc_clipboard() + + # Setup for the LINUX platform: + if HAS_DISPLAY: + try: + import gtk # check if gtk is installed + except ImportError: + pass # We want to fail fast for all non-ImportError exceptions. + else: + return init_gtk_clipboard() + + if _executable_exists("xclip"): + return init_xclip_clipboard() + if _executable_exists("xsel"): + return init_xsel_clipboard() + if _executable_exists("klipper") and _executable_exists("qdbus"): + return init_klipper_clipboard() + + try: + # qtpy is a small abstraction layer that lets you write applications using a single api call to either PyQt or PySide. + # https://pypi.python.org/pypi/QtPy + import qtpy # check if qtpy is installed + except ImportError: + # If qtpy isn't installed, fall back on importing PyQt4. + try: + import PyQt5 # check if PyQt5 is installed + except ImportError: + try: + import PyQt4 # check if PyQt4 is installed + except ImportError: + pass # We want to fail fast for all non-ImportError exceptions. + else: + return init_qt_clipboard() + else: + return init_qt_clipboard() + else: + return init_qt_clipboard() + + + return init_no_clipboard() + + +def set_clipboard(clipboard): + ''' + Explicitly sets the clipboard mechanism. The "clipboard mechanism" is how + the copy() and paste() functions interact with the operating system to + implement the copy/paste feature. The clipboard parameter must be one of: + - pbcopy + - pbobjc (default on Mac OS X) + - gtk + - qt + - xclip + - xsel + - klipper + - windows (default on Windows) + - no (this is what is set when no clipboard mechanism can be found) + ''' + global copy, paste + + clipboard_types = {'pbcopy': init_osx_pbcopy_clipboard, + 'pyobjc': init_osx_pyobjc_clipboard, + 'gtk': init_gtk_clipboard, + 'qt': init_qt_clipboard, # TODO - split this into 'qtpy', 'pyqt4', and 'pyqt5' + 'xclip': init_xclip_clipboard, + 'xsel': init_xsel_clipboard, + 'klipper': init_klipper_clipboard, + 'windows': init_windows_clipboard, + 'no': init_no_clipboard} + + if clipboard not in clipboard_types: + raise ValueError('Argument must be one of %s' % (', '.join([repr(_) for _ in clipboard_types.keys()]))) + + # Sets pyperclip's copy() and paste() functions: + copy, paste = clipboard_types[clipboard]() + + +def lazy_load_stub_copy(text): + ''' + A stub function for copy(), which will load the real copy() function when + called so that the real copy() function is used for later calls. + + This allows users to import pyperclip without having determine_clipboard() + automatically run, which will automatically select a clipboard mechanism. + This could be a problem if it selects, say, the memory-heavy PyQt4 module + but the user was just going to immediately call set_clipboard() to use a + different clipboard mechanism. + + The lazy loading this stub function implements gives the user a chance to + call set_clipboard() to pick another clipboard mechanism. Or, if the user + simply calls copy() or paste() without calling set_clipboard() first, + will fall back on whatever clipboard mechanism that determine_clipboard() + automatically chooses. + ''' + global copy, paste + copy, paste = determine_clipboard() + return copy(text) + + +def lazy_load_stub_paste(): + ''' + A stub function for paste(), which will load the real paste() function when + called so that the real paste() function is used for later calls. + + This allows users to import pyperclip without having determine_clipboard() + automatically run, which will automatically select a clipboard mechanism. + This could be a problem if it selects, say, the memory-heavy PyQt4 module + but the user was just going to immediately call set_clipboard() to use a + different clipboard mechanism. + + The lazy loading this stub function implements gives the user a chance to + call set_clipboard() to pick another clipboard mechanism. Or, if the user + simply calls copy() or paste() without calling set_clipboard() first, + will fall back on whatever clipboard mechanism that determine_clipboard() + automatically chooses. + ''' + global copy, paste + copy, paste = determine_clipboard() + return paste() + + +def is_available(): + return copy != lazy_load_stub_copy and paste != lazy_load_stub_paste + + +# Initially, copy() and paste() are set to lazy loading wrappers which will +# set `copy` and `paste` to real functions the first time they're used, unless +# set_clipboard() or determine_clipboard() is called first. +copy, paste = lazy_load_stub_copy, lazy_load_stub_paste + + +__all__ = ['copy', 'paste', 'set_clipboard', 'determine_clipboard'] + + diff --git a/Code/youtube-dl b/Code/youtube-dl new file mode 100644 index 0000000..fc830df Binary files /dev/null and b/Code/youtube-dl differ diff --git a/Icons/logo.png b/Icons/logo.png new file mode 100644 index 0000000..04c409d Binary files /dev/null and b/Icons/logo.png differ diff --git a/Icons/logo.svg b/Icons/logo.svg new file mode 100644 index 0000000..af3f5d4 --- /dev/null +++ b/Icons/logo.svg @@ -0,0 +1,82 @@ + + + + + + + + +image/svg+xmlOpenclipart▶ + \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..82b5650 --- /dev/null +++ b/LICENSE @@ -0,0 +1,614 @@ +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 s ue 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.md b/README.md new file mode 100644 index 0000000..0f274c0 --- /dev/null +++ b/README.md @@ -0,0 +1,49 @@ +# IMM - Internet Media Manager (alpha phase) +Play internet videos in desktop media player just like local files and optionally save them offline. IMM can function like conventional media downloaders also. + +IMM is a [free-libre](https://www.fsf.org/about/what-is-free-software) software. It respects the [user freedom](https://www.gnu.org/philosophy/free-sw.html). + +## Why another media downloader? +IMM is more than a media downloader, it's benefits over a convential media downloader are: +* Play online video or audio in desktop media player as if local file is being played. Have full control of playing experience with powerful desktop media player of your choice such as VLC media player. IMM saves ~1kb m3u file containing media title, duration and url offline. Next time, same video can be played by clicking/double-clicking that .m3u file (opening with IMM). It feels just like playing any other video stored offline. +* With conventional media downloaders one have to compromise between waiting for entire video to download or just watch in briowser without downloading. With IMM, video is played and saved offline simultaneously. +* No more browser slowdown from playing videos inside browser. +* Just as conventional media downloaders, video can be downloaded without playing it. However most downloaders can download only few formats and qualities of a video. Thanks to powerful combination of youtube-dl and ffmpeg, any format and quality can be downloaded and merged. +* Many simple yet powerful configuration options. Such as: + * Automatically calculate best quality for given internet speed and screen size for bufferless playback. Quality can be selected manually also if desired. But one do not have to do it more than once and can set custom quality prefrence for each website. Next time, those qualities will be automatically selected if available in preference order. + * Custom cache size such as just 5 or 10 second buffer for limited data internet or 5-10 minute for uninterepted forward and backward seeking. This setting can be configured in many desktop media players and IMM can feed these configurations to desktop media players. + * Like listening but not watching? only audio can be played of videos if separate video-audio stream available (in most cases they are available). + +## Installtion and Configuration +### Installation +* Windows and Mac OS users, Install [python](https://www.python.org/downloads/) 3.5 or above. +* [this should also be done automatically] Download ffmpeg to path or youtube-dl's root directory (Most Gnu/Linux distributions users can simply install it from their package manager. Windows users download it from https://ffmpeg.zeranoe.com/builds/) + +### Configure IMM +It is recommended to follow all the below steps to get the most out of imm. However one can now start imm by launching imm (imm.py for windows users). +* [should be done automatically] Add IMM to application list/menu/dashboard as /path/to/imm .Its recommened to add mutiple instances such as: + * /path/to/imm -p #for directly playing media + * /path/to/imm -s #for directly playling and saving media simultaneously + * /path/to/imm -d #for directly downloading media only + * /path/to/imm -w #for directly adding media to Watch Later folder without playing or downloading it +* [should be done automatically] Add global hotkeys in application list/menu/dashboad to entries added above or by going to globals shortcuts in system settings. Than one can easily copy media urls in browser and press global hotkeys to play, playandsave, downloadonly or watchlater etc. +* [should be done automatically] Set .m3u files to open with imm. Again can add multiple entires as above. And can default as your preffered option like play only. +* add only alias to path/to/imm file or add imm folder to path + +## Running IMM +For now IMM can capture meda urls using following ways: +* Arguments recived by imm such as via terminal or browser addon [browser addon not built yet, you can help!] +* from clipboard - copy links to clipboard before executing imm +* direct input/paste when imm ask (if url not found in arguments or clipboard, imm asks to paste url) +* [not implemented yet] batch media urls file + +IMM can be launched in following ways: +* Simply lauch 'imm'. Windows users use imm.py (might need to rename to imm.exe). +* directly takeover or execute from browser via browser addon [not implemented] +* global hotkeys for 1.playing, 2.playing and saving simultaneously, 3.download only without playing or 4.add to watch later list. This is the best option until browser addon is build. +* Simply lauch imm's created .m3u files (provided .m3u files are configured to open with imm) + +## License +see LICENSE in source tree + +Copyright (C) 2018-2020 [coder](https://radii.dev/coder/) diff --git a/imm b/imm new file mode 120000 index 0000000..3d6042a --- /dev/null +++ b/imm @@ -0,0 +1 @@ +imm.py \ No newline at end of file diff --git a/imm.py b/imm.py new file mode 100644 index 0000000..026c9d2 --- /dev/null +++ b/imm.py @@ -0,0 +1,1641 @@ +#!/usr/bin/python3 +# -*- coding: utf-8 -*- + +""" +IMM - Internet Media Manager: Play internet media in desktop media +player just like local files and optionally save them offline. IMM can +function as conventional media downloaders as well. +Copyright (C) 2018-2020 IMM@radii.dev + +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 . +""" + +""" +NOTE: IMPROVE CODE, FIX REPETIONS AND MESSES. GO THROUGH ENTIRE CODE. REFACTOR CODEBASE. +Use tuple where list is not required scuh as constant & non-global data. + +Below, first several functions are defined. To read squentially, go to +the bottom and start reading from execution/calling of Main() function. + +VD is VariablesDictionary. see GenerateVariablesDictionary() function. +""" + +# Python standard library imports +import subprocess +import sys +import time +import os +import threading +import glob +import shlex +import pathlib + +# Third-party imports +# import youtube-dl +try: + import pyperclip +except: + print( + "WARNING: pyperclip module not found. Please install pyperclip" + " module https://pypi.org/project/pyperclip/ in your python " + "setup. It is required to automatically fetch urls from " + "clipboard. Loading pyperclip module provided in programme but" + " it might not work", file=sys.stderr) + try: + from Code.PythonModules import pyperclip + except: + # symbolic function if failed to import + class pyperclip: + def paste(): + return '' + +# Current programme imports +from Code.IMM.GeneralFunctions.InputOutput import ( + ReadTextFile, + ReadlinesTextFile, + WriteGeneralTextFiles) + +from Code.IMM.GeneralFunctions.DataStructureManupulations import ( + ConvertToStandardPathFormat, + GetTextAfter, + DoubleQuoteString, + SingleQuoteString, + ListIntoString, + StandardVariableName) + + +class FindMediaURLs: + """ First look for media urls in programme arguments than clipboard + and finally ask for user input if still not found. + """ + def __init__(self): + MediaURLs = self.ExtractingMediaUrls(Arguments) + if len(MediaURLs) != 0: + self.MediaURLs = MediaURLs + return + + # Causing Gtk-WARNING **: Theme parsing error: + Clipboard = pyperclip.paste() + Clipboard = Clipboard.split('\n') + MediaURLs = self.ExtractingMediaUrls(Clipboard) + if len(MediaURLs) != 0: + self.MediaURLs = MediaURLs + return + + MediaURLs = self.ProcessUserInput() + self.MediaURLs = MediaURLs + + def ProcessUserInput(self): + print( + "No media url found in aguments and clipboard. You can " + "paste media urls and imm created m3u files location " + "below. Paste one url per line (empty input will break the" + " url collection loop). This way you can paste list of " + "mutiple urls with one url per line (bulk url paste will " + "work)") + MediaURLList = '' + while len(MediaURLList) == 0: + UserInputList = [] + while True: + UserInput = input() + UserInputList.append(UserInput) + if len(UserInput) == 0: + break + MediaURLList = self.ExtractingMediaUrls(UserInputList) + if len(MediaURLList) != 0: + return MediaURLList + print("No valid media url or m3u file cointaing valid " + "media url found. Try again!") + + def ExtractingMediaUrls(self, Source): + MediaURLs = [] + for i in range(len(Source)): + Item = Source[i].strip(Quotes + ' ') + if Item.casefold().startswith(VD['validmediaurlstart']): + MediaURL = DoubleQuoteString(Item) + MediaURLs.append(MediaURL) + elif Item.casefold().endswith( + VD['validextensioncontaningmediaurl1']): + + M3UFile = ConvertToStandardPathFormat(Item) + MediaAvailableOffline = \ + self.M3UFile_IsMediaAvailableOffline(M3UFile) + if len(MediaAvailableOffline) > 0: + MediaURLs.append(MediaAvailableOffline) + else: + MediaURL = self.GetMediaURLFromM3UFile(M3UFile) + if MediaURL != None: + MediaURL = DoubleQuoteString(MediaURL) + MediaURLs.append(MediaURL) + return MediaURLs + + def GetMediaURLFromM3UFile(self, M3UFile): + if os.path.isfile(M3UFile) == True: + FileLines = ReadlinesTextFile(M3UFile) + MediaURL = GetTextAfter('#Source: ', FileLines).strip(' ') + if len(MediaURL) > 0: + return MediaURL + + def M3UFile_IsMediaAvailableOffline(self, M3UFile): + Return = '' + FileLines = ReadlinesTextFile(M3UFile) + ChangeWorkingDirectoryTo = os.path.split(M3UFile)[0] + os.chdir(ChangeWorkingDirectoryTo) + for i in range(len(FileLines)): + Line = FileLines[i].strip('\n' + Quotes) + if Line.startswith('#') or\ + Line.casefold().startswith(VD['validmediaurlstart']): + + continue + else: + Line = os.path.abspath(Line) + if os.path.isfile(Line) == True: + Return ='Offline://' + Line + os.chdir(ProgrammeDirectory) + return Return + + +class CalculateMediaQualityPreference: + def __init__(self, DownloadOnly = False): + InternetSpeed = VD['internetspeed'] + MediaQualityHeight = VD['mediaqualityheight'] + PreferAudioOnly = VD['preferaudioonly'] + self.AllowSeprateVideoAndAudioSource = True + if DownloadOnly == False: + if (len(MediaPlayerMultipleSourcePlayCommand) <= 0 + or VD['allowseprateaudiosource'] != "yes"): + + self.AllowSeprateVideoAndAudioSource = False + CustomFormatOptions = VD['customformatoptions'].strip(' "\'/') + if len(CustomFormatOptions) > 0: + CustomFormatOptions += '/' + SpeedBasedPreference = '' + QualityBasedPreference = '' + TryAudioFirst = '' + if InternetSpeed != None: + MaxAverageBitrate = 0.8 * int(InternetSpeed) + MaxAverageBitrateString = str(MaxAverageBitrate) + MaxAverageBitrate2 = MaxAverageBitrate - 320 + MaxAverageBitrate2String = str(MaxAverageBitrate2) + SpeedBasedPreference = ( + "bestvideo[tbr<=" + + MaxAverageBitrate2String + + "]+bestaudio/worstvideo[tbr>=" + + MaxAverageBitrate2String + + "]+bestaudio/best[tbr<=" + + MaxAverageBitrateString + + "]/worst[tbr>=" + + MaxAverageBitrateString + + "]/") + if MediaQualityHeight != None: + MediaQualityHeight = str(MediaQualityHeight) + QualityBasedPreference = ( + "bestvideo[height<=" + + MediaQualityHeight + + "]+bestaudio/worstvideo[height>=" + + MediaQualityHeight + + "]+bestaudio/best[height<=" + + MediaQualityHeight + + "]/worst[height>=" + + MediaQualityHeight + + "]/") + if (PreferAudioOnly == 'yes' + or Arguments.count('--preferaudioonly') != 0): + + if InternetSpeed != None: + TryAudioFirst = ( + "bestaudio[tbr<=" + + MaxAverageBitrateString + +"']/worst[tbr>=" + + MaxAverageBitrateString + + "]/") + else: + TryAudioFirst = "bestaudio/" + MediaPreference = ( + TryAudioFirst + + CustomFormatOptions + + SpeedBasedPreference + + QualityBasedPreference + + "best") + if self.AllowSeprateVideoAndAudioSource == False: + MediaPreference = self.RemoveMutipleSourceFormats( + MediaPreference) + self.MediaPreference = MediaPreference + + def RemoveMutipleSourceFormats(self, MediaPreference): + MediaPreferencelist = MediaPreference.split('/') + MediaPreference = [] + for i in range(len(MediaPreferencelist)): + if MediaPreferencelist[i].find('+') == -1: + MediaPreference.append(MediaPreferencelist[i]) + MediaPreference = '/'.join(MediaPreference) + return MediaPreference + + def ManuallySelectFormat(self, MediaURL): + ManuallySelectFormat = VD['manuallyselectformat'] + if (ManuallySelectFormat == 'yes' + or Arguments.count('--manuallyselectformat') != 0): + + print('Finding available formats...') + GetAvailableFormatsCommand = ' '.join(( + YoutubeDL, + "--list-formats --no-playlist", + MediaURL)) + OutputString = RunSubprocessAndReturnOutputString( + GetAvailableFormatsCommand) + FoundFormats, FormatStartAt = self.DidFoundAnyFormat( + OutputString) + if FoundFormats == False: + print( + "Could not find any format. Press return key to " + " process next url in queue if any, else to exit. " + "Possible reasons: \n" + "1. Probably bug in IMM, report issue to us.\n" + "2. Unsupported website or supported but still not" + " working, report it to youtube-dl developers\n" + "3. Incorrect url or url has no media. check " + "again.\n" + "below is the output from youtube-dl:\n" + + OutputString) + input() + return 'Failed' + InvalidInputTryAgainOrSkip = ( + "Invalid format code. Try again or type 's' or 'skip'" + " to process media with automatic format selection.") + print( + "Type code of one (example 'videoandaudio') or two " + "(example 'videos+audio') of the available formats " + "below to process it. You can add a blank space ' ' " + "before to keep manuallyselectformat turned on, by " + "default its automaically turned off. Add blank space " + "' ' after code to add it to customformatoptions so " + "that you do not have to manully select it again and " + "again.\n" + + OutputString[FormatStartAt:]) + VerificationCode = -1 + while VerificationCode == -1: + UserInput = input() + if len(UserInput) == 0 : + print(InvalidInputTryAgainOrSkip) + continue + if UserInput.startswith(' '): + KeepManuallySelectFormatON = True + else: + KeepManuallySelectFormatON = False + if UserInput.endswith(' '): + AddToCustomFormatOptions = True + else: + AddToCustomFormatOptions = False + UserInput = UserInput.strip(' ') + MultipleFormatSelected = UserInput.find('+') + if MultipleFormatSelected == -1: + Verification = '\n' + UserInput + VerificationCode = OutputString.find(Verification) + else: + if self.AllowSeprateVideoAndAudioSource == True: + FirstVerification = ( + '\n' + + UserInput[:MultipleFormatSelected]) + FirstVerificationCode = OutputString.find( + FirstVerification) + LastVerification = ( + '\n' + + UserInput[(MultipleFormatSelected + 1):]) + LastVerificationCode = OutputString.find( + LastVerification) + if FirstVerification != -1 and LastVerificationCode != -1: + VerificationCode = 1 + else: + print( + "Media player do not support seprate " + "video+audio source playback. Select single" + " videoandaudio or audioonly format") + if VerificationCode != -1: + UserSelectedFormat = UserInput + '/' + if KeepManuallySelectFormatON == False: + Configuration.EditConfigurationFile( + 'manuallyselectformat', 'no') + if AddToCustomFormatOptions == True: + AlreadyInConfiguration = \ + VD['CustomFormatOptions'].strip('/ ') + UpdatedCustomFormatOptions = ( + UserSelectedFormat + + AlreadyInConfiguration).strip('/ ') + Configuration.EditConfigurationFile( + 'CustomFormatOptions', + UpdatedCustomFormatOptions) + break + if UserInput == 's' or UserInput == 'skip': + UserSelectedFormat = '' + break + print(InvalidInputTryAgainOrSkip) + else: + UserSelectedFormat = '' + MediaPreference = DoubleQuoteString( + UserSelectedFormat + self.MediaPreference) + MediaPreference = "--format " + MediaPreference + return MediaPreference + + def DidFoundAnyFormat(self, OutputString): + """ When ManuallySelectFormat is enabled, it tests if found any + format/media source links or not. + """ + FindTheseInSequence = ( + 'format', 'code', 'extension', 'resolution', 'note') + b = 0 + for Item in range(len(FindTheseInSequence)): + a = OutputString[b:].find(FindTheseInSequence[Item]) + if a == -1: + return False, 0 + b += a + FormatStartAt = OutputString[:b].rfind('\n') + 1 + return True, FormatStartAt + + +def ParseDomainName(MediaURL): + """ Parse domain name from url for naming m3u files in Previous + list and Watch Later list. + """ + DomainStart = MediaURL.find("//") + 2 + MediaURLFactor2 = MediaURL[DomainStart:].find('/') + DomainEnd = DomainStart + MediaURLFactor2 + MediaDomain = MediaURL[DomainStart : DomainEnd] + if MediaDomain.startswith("www."): + MediaDomain = MediaDomain[4:] + return MediaDomain + +def ConvertDurationIntoSeconds(MediaDuration): + """ Example: Input:12:05 => Output: 725 """ + DurationsList = MediaDuration.split(':') + DurationsListLength = len(DurationsList) + MutiplyingFactor = 1 + DurationInSeconds = 0 + for i in range(len(DurationsList) - 1, -1, -1): + Add = int(DurationsList[i]) * MutiplyingFactor + DurationInSeconds += Add + MutiplyingFactor *= 60 + return str(DurationInSeconds) + +class PlayOnly: + def __init__(self, MediaURL, MediaPreference): + self.MediaURL = MediaURL + self.MediaPreference = MediaPreference + """ This won't work it won't have custom configuration like + audio only, it will have seprate configuration, duplication + etc. and therefore defeating the purpose of IMM. Find how to + pass Arguments in gnome-mpv and how to send additonal media + urls to already playing gnome-mpv instance. No need of it any + since mpv itself don't have instance control either (not sure + it gnome-mpv have instance control or not yet. read + documentation on website or talk on IRC). + + POSSIBLE FIX: read path of gnome-mpv's mpv configuration path + in gnome-mpv config folder and copy it and add arguments as + commands in copied file and specify that in argument of + execution of gnome-mpv. If no option to specify in arguments + than specify in configuration file and than execute it, than + after playing, restore gnome-mpv configuration file. + if no config file found than create it and than delete after + playing. + THIS CAN WORK. + Push changes upstream to support this feature. + """ + IsMediaPlayedAlready = self.DirectlyPlayForSomeMediaPlayers() + if IsMediaPlayedAlready != True: + self.MediaDomain = ParseDomainName(self.MediaURL) + PrimaryMethod = self.PrimaryPlayingMethod() + if PrimaryMethod == 'failed': + self.AlternatePlayingMethod() + + # Kill this function + def DirectlyPlayForSomeMediaPlayers(self): + if (MediaPlayer.endswith('gnome-mpv') + or MediaPlayer.endswith('gnome-mpv.exe')): + + PlayMedia(MediaURLListString) + return True + return False + + def AlternatePlayingMethod(self): + print('Wait... extracting media url') + ExtractURL = ' '.join(( + YoutubeDL, + "--get-url --no-playlist", + self.MediaPreference, + self.MediaURL)) + ExtractedURL = RunSubprocessAndReturnOutputString( + ExtractURL).strip('\n') + QuoteExtractedURL = DoubleQuoteString(ExtractedURL) + StartProcessing.ProcessNextURL = True + PlayMedia(QuoteExtractedURL) + + def PrimaryPlayingMethod(self): + print('Wait... extracting media url') + ExtractURLTitleAndDuration = ' '.join(( + YoutubeDL, + "--get-title --get-url --get-duration --no-playlist", + AdditionalYoutubeDLArguments, + self.MediaPreference, + self.MediaURL)) + ExtractedURLTitleAndDurationList = RunSubprocessAndReturnOutputString( + ExtractURLTitleAndDuration).strip('\n').split('\n') + LenOfExtractedURLTitleAndDurationList = \ + len(ExtractedURLTitleAndDurationList) + ExtractedAudioURL = None + PrintErrorMessageIfFails = ( + "Something went wrong with extraction process. Below " + "(or above) is the extracted string:\n" + + ('\n').join(ExtractedURLTitleAndDurationList)) + if LenOfExtractedURLTitleAndDurationList == 4: + if ExtractedURLTitleAndDurationList[2].find( + ExtractedURLTitleAndDurationList[1][:4]) != -1: + + MediaTitle = ExtractedURLTitleAndDurationList[0] + ExtractedURL = ExtractedURLTitleAndDurationList[1] + ExtractedAudioURL = ExtractedURLTitleAndDurationList[2] + ExtractedAudioURL = DoubleQuoteString(ExtractedAudioURL) + MediaDuration = ExtractedURLTitleAndDurationList[3] + MediaDurationInSeconds = ConvertDurationIntoSeconds(MediaDuration) + else: + print(PrintErrorMessageIfFails) + return 'failed' + elif LenOfExtractedURLTitleAndDurationList == 3: + """ Test if both start with same protocol like http. Than + both are media urls (one is video source and other is audio + source), otherwise other one is MediaDuration. + """ + if ExtractedURLTitleAndDurationList[2].find( + ExtractedURLTitleAndDurationList[1][:4]) != -1: + + MediaTitle = ExtractedURLTitleAndDurationList[0] + ExtractedURL = ExtractedURLTitleAndDurationList[1] + ExtractedAudioURL = ExtractedURLTitleAndDurationList[2] + ExtractedAudioURL = DoubleQuoteString(ExtractedAudioURL) + else: + MediaTitle = ExtractedURLTitleAndDurationList[0] + ExtractedURL = ExtractedURLTitleAndDurationList[1] + MediaDuration = ExtractedURLTitleAndDurationList[2] + MediaDurationInSeconds = ConvertDurationIntoSeconds( + MediaDuration) + elif LenOfExtractedURLTitleAndDurationList == 2: + MediaTitle = ExtractedURLTitleAndDurationList[0] + ExtractedURL = ExtractedURLTitleAndDurationList[1] + MediaDurationInSeconds = '' + else: + print(PrintErrorMessageIfFails) + return 'failed' + M3UFileName = self.MediaDomain + ' → ' + MediaTitle + '.m3u' + for Symbols in range(len(VD['ReplaceTheseSymbols'])): + M3UFileName = M3UFileName.replace( + VD['ReplaceTheseSymbols'][Symbols], + VD['ReplaceWithSymbols'][Symbols]) + AudioSourceLine = '' + if ExtractedAudioURL != None: + AudioSourceLine = '#Audio:' + ExtractedAudioURL + """ Known Issue: for now, atleast 1 ASCII character would be + required in name to work in Windows since can't get unicode + output in Windows. + """ + DirectoryAndM3UFileName = os.path.join(VD['previouslist'], M3UFileName) + WriteToM3UFile( + DirectoryAndM3UFileName, + MediaDuration = MediaDurationInSeconds, + MediaTitle = MediaTitle, + MediaLocation = ExtractedURL, + AddtionalText = AudioSourceLine, + MediaURL = self.MediaURL) + DirectoryAndM3UFileName2 = os.path.join(VD['previouslist2'], M3UFileName) + WriteToM3UFile( + DirectoryAndM3UFileName2, + MediaDuration = MediaDurationInSeconds, + MediaTitle = MediaTitle, + MediaLocation = ExtractedURL, + AddtionalText = AudioSourceLine, + MediaURL = self.MediaURL) + StartProcessing.ProcessNextURL = True + DirectoryAndM3UFileName2 = DoubleQuoteString( + DirectoryAndM3UFileName2) + # M3UFileName2 = '"' + M3UFileName + '"' + if (MediaPlayer.endswith('vlc') + or MediaPlayer.endswith('vlc.exe')): + + quotedExtractedURL = DoubleQuoteString(ExtractedURL) + PlayMedia( + DirectoryAndM3UFileName2, + SeprateAudio = True, + WorkaroundForVLC = quotedExtractedURL, + VLCWorkAroundTitle = MediaTitle) + else: + PlayMedia(DirectoryAndM3UFileName2, SeprateAudio = True) + #threading.Thread(target = PlayMedia(DirectoryAndM3UFileName2)).start() + + +# REWRITE FUNCTION WITH BETTER CLASSES-OBJECTS UNDERSTANDING +class PlayAndSave: + def __init__(self, MediaNumber, MediaURL, MediaPreference): + self.MediaNumber = MediaNumber + self.MediaURL = MediaURL + self.MediaPreference = MediaPreference + self.FileNameExtracted = False + self.FinalFileName = False + self.AudioSource = None + self.DeleteFilesTuple = () + self.MediaTitle = '' + self.FormatsMerged = False + self.DirectoryAndFile = '' + self.FileName = '' + self.PlayingSeprateFile = False + self.MediaDomain = ParseDomainName(MediaURL) + + threading.Thread( + target = self.GetAudioUrlIfSeprateAudioSource).start() + threading.Thread(target = self.Play).start() + #threading.Thread(target = self.DeleteFiles).start() + self.Save() + + def GetAudioUrlIfSeprateAudioSource(self): + IsSeprateAudioStreamCommand = ' '.join(( + YoutubeDL, + "-e -g --no-playlist", + AdditionalYoutubeDLArguments, + self.MediaPreference, + self.MediaURL)) + IsSeprateAudioStream = RunSubprocessAndReturnOutputString( + IsSeprateAudioStreamCommand).strip('\n').split('\n') + self.MediaTitle = DoubleQuoteString( + IsSeprateAudioStream[0]).strip('"') + if len(IsSeprateAudioStream) > 2: + print('\nSeprate Audio Source') + self.AudioSource = DoubleQuoteString( + IsSeprateAudioStream[2]) #1=vdeo 2=audio + else: + self.AudioSource = '' + + def Save(self): + print('Saving media... Will play as soon as its playable') + SaveCommand = ' '.join(( + YoutubeDL, + "--no-part --keep-video --no-playlist", + AdditionalYoutubeDLArguments, + self.MediaPreference, + self.MediaURL)) + SaveCommand = shlex.split(SaveCommand) + SaveMedia = subprocess.Popen( + SaveCommand, + cwd = VD['offlinemedia'], + stdout = subprocess.PIPE, + universal_newlines = True) + while SaveMedia.poll() is None: + Output = SaveMedia.stdout.readline() + # Do not end with '\n' newline. Stay on same line. + print(Output.strip('\n'), end = '', flush = True) + """ Backspace/clear output to print next in same line """ + print('\r', end = '') + self.ExtractFileName(Output) + StartProcessing.ProcessNextURL = True + + def ExtractFileName(self, Output): + if Output.startswith('[download] Destination: '): + self.FileName = Output[24:-1] + self.AfterFileNameExtracted() + elif Output.startswith('[ffmpeg] Merging formats into "'): + self.FileName = Output[31:-2] + self.AfterFileNameExtracted(ThisIsFinalFileName = True) + self.FinalFileName = True + self.FormatsMerged = True + elif Output.endswith(' has already been downloaded and merged\n'): + self.FileName = Output[11:-40] + self.AfterFileNameExtracted(ThisIsFinalFileName = True) + self.FinalFileName = True + self.FormatsMerged = True + elif Output.endswith(' has already been downloaded\n'): + self.FileName = Output[11:-29] + self.AfterFileNameExtracted() + + def AfterFileNameExtracted(self, ThisIsFinalFileName = False): + self.DirectoryAndFile = VD['offlinemedia'] + self.FileName + if ThisIsFinalFileName == False: + self.DeleteFilesTuple += self.DirectoryAndFile, + self.FileNameExtracted = True + + def Play(self): + global PlayingMediaNumber, PlayingSeprateFile + while PlayingMediaNumber < self.MediaNumber: + time.sleep(1/10) + while self.AudioSource == None: + time.sleep(1/10) + while self.FileNameExtracted == False: + time.sleep(1/10) + while os.path.isfile(self.DirectoryAndFile) is False: + time.sleep(1/10) + MinimumRequiredSize = (1/2) * 1048576 # 0.5MB + while os.path.getsize(self.DirectoryAndFile) < MinimumRequiredSize: + time.sleep(1/10) + threading.Thread(target = self.CreateM3UFile).start() + DirectoryAndFile = DoubleQuoteString(self.DirectoryAndFile) + if len(self.AudioSource) > 0 and self.FormatsMerged == False: + PlayingSeprateFile = True + PlayMedia( + DirectoryAndFile, + SeprateAudio = True, + AudioSource = self.AudioSource) + PlayingSeprateFile = False + else: + PlayMedia(DirectoryAndFile) + PlayingMediaNumber += 1 + """ This is temporary until fix PlayingSeprateFile variable + issue in DeleteFiles() + """ + self.DeleteFiles() + + def DeleteFiles(self): + while self.AudioSource == None: + time.sleep(1) + if len(self.AudioSource) == 0: + return + while self.FormatsMerged == False: + time.sleep(1) + while os.path.isfile(self.DirectoryAndFile) == False: + time.sleep(1) + # Do not delete if file is still being merged i.e. increasing size + while True: + a = os.path.getsize(self.DirectoryAndFile) + time.sleep(5) + b = os.path.getsize(self.DirectoryAndFile) + if a == b: + break + while self.PlayingSeprateFile == True: #why this not working? + #print(self.PlayingSeprateFile) + time.sleep(1) + for File in range(len(self.DeleteFilesTuple)): + FileToBeDeleted = self.DeleteFilesTuple[File] + print( + 'Files are Merged, Deleting Seprate File ' + + FileToBeDeleted) + os.remove(FileToBeDeleted) + + def CreateM3UFile(self): + if len(self.AudioSource) > 0: + while self.FinalFileName == False: + time.sleep(1) + M3UFileName = self.MediaDomain + ' → ' + self.MediaTitle + '.m3u' + DirectoryAndM3UFileName = os.path.join(VD['previouslist'], M3UFileName) + SavingMediaPath = RelativeIfProgrammeSubpathElseAbsolutePath( + self.DirectoryAndFile, + RelativeTo = VD['previouslist'], + DirectoryOrFile = 'file') + WriteToM3UFile( + DirectoryAndM3UFileName, + MediaLocation = SavingMediaPath, + MediaURL = self.MediaURL) + + +def DownloadOnly(MediaURL, MediaPreference): + FileName = '' + MediaDomain = ParseDomainName(MediaURL) + print('Downloading media. Will auto-exit once download completed.') + DownloadCommand = ' '.join(( + YoutubeDL, + "--no-playlist", + AdditionalYoutubeDLArguments, + MediaPreference, + MediaURL)) + DownloadCommand = shlex.split(DownloadCommand) + DownloadMedia = subprocess.Popen( + DownloadCommand, + cwd = VD['offlinemedia'], + stdout = subprocess.PIPE, + universal_newlines = True) + while DownloadMedia.poll() is None: + Output = DownloadMedia.stdout.readline() + print(Output.strip('\n'), end = '', flush = True) #do not end with '\n' + print('\r', end = '') #backspace/clear output to print next in same line + if Output.startswith('[download] Destination: '): + FileName = Output[24:-1] + elif Output.startswith('[ffmpeg] Merging formats into "'): + FileName = Output[31:-2] + elif Output.endswith(' has already been downloaded and merged\n'): + FileName = Output[11:-40] + elif Output.endswith(' has already been downloaded\n'): + FileName = Output[11:-29] + MediaTitleUpto = FileName.rfind('-') + MediaTitle = FileName[:MediaTitleUpto] + DirectoryAndFile = os.path.join(VD['offlinemedia'], FileName) + M3UFileName = MediaDomain + ' → ' + MediaTitle + '.m3u' + DirectoryAndM3UFileName = os.path.join(VD['previouslist'], M3UFileName) + DownloadedMediaPath = RelativeIfProgrammeSubpathElseAbsolutePath( + DirectoryAndFile, + RelativeTo = VD['previouslist'], + DirectoryOrFile = 'file') + WriteToM3UFile( + DirectoryAndM3UFileName, + MediaLocation = DownloadedMediaPath, + MediaURL = MediaURL) + print('Download complete') + +def WatchLater(MediaURL): + MediaDomain = ParseDomainName(MediaURL) + ExtractTitleCommand = ' '.join(( + YoutubeDL, + "--get-title --no-playlist", + AdditionalYoutubeDLArguments, + MediaURL)) + ExtractedTitle = RunSubprocessAndReturnOutputString( + ExtractTitleCommand).strip('\n') + if len(ExtractedTitle) > 0: + MediaTitle = ExtractedTitle + M3UFileName = MediaDomain + ' → ' + MediaTitle + '.m3u' + else: + MediaTitle = MediaURL + M3UFileName = MediaTitle+'.m3u' + for Symbols in range(len(VD['ReplaceTheseSymbols'])): + M3UFileName = M3UFileName.replace( + VD['ReplaceTheseSymbols'][Symbols], + VD['ReplaceWithSymbols'][Symbols]) + DirectoryAndM3UFileName = os.path.join(VD['watchlaterlist'], M3UFileName) + WatchLaterComment = "#You have marked this media to watch later" + WriteToM3UFile( + DirectoryAndM3UFileName, + MediaTitle = MediaTitle, + MediaLocation = WatchLaterComment, + MediaURL = MediaURL) + DirectoryAndM3UFileName2 = VD['watchlaterlist2'] + M3UFileName + WriteToM3UFile( + DirectoryAndM3UFileName2, + MediaTitle = MediaTitle, + MediaLocation = WatchLaterComment, + MediaURL = MediaURL) + print('Saved url to watch later list') + +def WriteToM3UFile( + FilePathAndName, + MediaDuration = '', + MediaTitle = '', + MediaLocation = '', + AddtionalText = '', + MediaURL = ''): + + if len(MediaTitle) > 0: + Start = '#EXTINF:' + LineBreak = '\n' + else: + Start = '' + LineBreak = '' + if len(MediaDuration) > 0: + MediaDuration = MediaDuration + ',' + if len(AddtionalText) > 0: + AddtionalText = AddtionalText + '\n' + WriteContent = ( + Start + + MediaDuration + + MediaTitle + + LineBreak + + MediaLocation + + '\n' + + AddtionalText + + '#Source: ' + + MediaURL) + WriteGeneralTextFiles(WriteContent, FilePathAndName) + +def RelativeIfProgrammeSubpathElseAbsolutePath( + Path, + RelativeTo = None, + DirectoryOrFile = 'Directory'): + + Path = os.path.realpath(Path) + if Path.startswith(ProgrammeDirectory) == False: + return Path + if RelativeTo == None: + RelativeTo = ProgrammeDirectory + RelativePath = os.path.relpath(Path, RelativeTo) + return RelativePath + +def PlayMedia( + FileLocation, + SeprateAudio = False, + AudioSource = None, + WorkaroundForVLC = None, + VLCWorkAroundTitle = None): + + # THIS FUNCTION IS A MESS, FIX IT. + if SeprateAudio == True and AudioSource == None: + M3UFileText = ReadlinesTextFile(FileLocation) + AudioSource = GetTextAfter('#Audio:', M3UFileText).strip(' ') + QuotedMediaPlayer = DoubleQuoteString(MediaPlayer) + PlayCommand = (MediaPlayerOptions + ' ' + FileLocation).strip(' ') + if SeprateAudio == True and AudioSource != '': + MultipleSourcePlayCommand = \ + MediaPlayerMultipleSourcePlayCommand + if len(MultipleSourcePlayCommand) > 0: + if WorkaroundForVLC != None: + MultipleSourcePlayCommand = \ + MultipleSourcePlayCommand.replace( + 'videosource', WorkaroundForVLC) + if VLCWorkAroundTitle != None: + MediaTitle = DoubleQuoteString(VLCWorkAroundTitle) + MultipleSourcePlayCommand += ' :meta-title=' + MediaTitle + else: + MultipleSourcePlayCommand = \ + MultipleSourcePlayCommand.replace( + 'videosource', FileLocation) + MultipleSourcePlayCommand = \ + MultipleSourcePlayCommand.replace( + 'audiosource', AudioSource) + PlayCommand = ( + MediaPlayerOptions + ' ' + MultipleSourcePlayCommand) + else: + print( + "Error: Have to play seprate video+audio source but " + "'MediaPlayerMultipleSourcePlayCommand' is empty. " + "This is an unexpected programming bug. Please report " + "issue to IMM. Press return key to quit programme") + input() + sys.exit() + ExecuteMediaPlayerCommand = QuotedMediaPlayer + ' ' + PlayCommand + print('Now playing in media player') + #GnomeMPVExp(ExecuteMediaPlayerCommand) + #print("Gnome-MPV") + #input() + PlayingMedia = subprocess.Popen(ExecuteMediaPlayerCommand, shell = True) + """ Below method of stdout=subprocess.PIPE and readlines() is + causing perfomance issues. + """ + #PlayingMedia = subprocess.Popen(ExecuteMediaPlayerCommand, stderr = subprocess.PIPE, stdout = subprocess.PIPE, shell = True) + while PlayingMedia.poll() is None: + #PlayingMedia.stdout.readline() #Flushing by reading. Maybe otherwise output will fill the memory? + #PlayingMedia.stderr.readline() + time.sleep(1/60) + #if sys.platform == 'win32': + #subprocess.Popen(ExecuteMediaPlayerCommand, shell = True) + #else: + #os.system(ExecuteMediaPlayerCommand) #find solution to it like communicate() or wait()? + +class StartProcessing: + ProcessNextURL = True + + def __init__(self): + for i in range(len(Arguments)): + if Arguments[i].startswith('-'): + if Arguments[i] == '-s' or Arguments[i] == '--playandsave': + self.Do('playandsave') + return + elif Arguments[i] == '-p' or Arguments[i] == '--play': + self.Do('play') + return + elif Arguments[i] == '-d' or Arguments[i] == '--downloadonly': + self.Do('downloadonly') + return + elif Arguments[i] == '-w' or Arguments[i] == '--watchlater': + self.Do('watchlater') + return + DefaultChoice = VD['defaultchoice'] + if (DefaultChoice == 'playandsave' + or DefaultChoice == 'play' + or DefaultChoice == 'downloadonly' + or DefaultChoice == 'watchlater'): + + self.Do(DefaultChoice) + else: + print('Type code number of one of the options and press enter\n' + '1 - play media in desktop media player\n' + '2 - play media in desktop media player and save as well to drive\n' + '3 - only download media (don\'t play in desktop media player)\n' + '4 - save url in watch later list') + while True: + UserInput = input() + if UserInput == '1': + self.Do('play') + break + elif UserInput == '2': + self.Do('playandsave') + break + elif UserInput == '3': + self.Do('downloadonly') + break + elif UserInput == '4': + self.Do('watchlater') + break + print('Invalid option, Try Again') + + """ Do what? Play, PlayAndSave, DownloadOnly, WatchLater """ + def Do(self, What): + global MediaURLListString, MediaURLList, ClassMediaPreference + MediaURLList = FindMediaURLs().MediaURLs + MediaURLListString = ListIntoString( + MediaURLList, QuoteItems = 2) + if What == 'play': + ClassMediaPreference = CalculateMediaQualityPreference() + QueueInIMM = VD['queueinimm'] + for i in range(len(MediaURLList)): + if QueueInIMM == 'yes': + print('Press return key to process next media url') + input() + MediaURL = MediaURLList[i] + if self.DirectlyPlayIfAvailableOffline(MediaURL) == True: + continue + MediaPreference = \ + ClassMediaPreference.ManuallySelectFormat(MediaURL) + print('Processing ' + MediaURL) + threading.Thread( + target = PlayOnly, + args = (MediaURL, MediaPreference)).start() + self.WaitForProcessToComplete() + continue #is this required or will work correctly? + elif What == 'playandsave': + global PlayingMediaNumber + ClassMediaPreference = CalculateMediaQualityPreference() + PlayingMediaNumber = 0 + for i in range(len(MediaURLList)): + MediaURL = MediaURLList[i] + if self.DirectlyPlayIfAvailableOffline(MediaURL) == True: + continue + MediaPreference =\ + ClassMediaPreference.ManuallySelectFormat(MediaURL) + print('Processing ' + MediaURL) + threading.Thread( + target = PlayAndSave, + args = (i, MediaURL, MediaPreference)).start() + self.WaitForProcessToComplete() + continue #is this required or will work correctly? + elif What == 'downloadonly': + ClassMediaPreference = \ + CalculateMediaQualityPreference(DownloadOnly = True) + ApplyORNotMediaPreference = \ + VD['applymediapreferencetodownloadonlyalso'] + for i in range(len(MediaURLList)): + MediaURL = MediaURLList[i] + if ApplyORNotMediaPreference == 'yes': + MediaPreference = \ + ClassMediaPreference.ManuallySelectFormat(MediaURL) + if MediaPreference == 'Failed': + return + else: + MediaPreference = '' + print('Processing ' + MediaURL) + DownloadOnly(MediaURL, MediaPreference) + elif What == 'watchlater': + for i in range(len(MediaURLList)): + MediaURL = MediaURLList[i] + print('Processing ' + MediaURL) + WatchLater(MediaURL) + + def WaitForProcessToComplete(self): + StartProcessing.ProcessNextURL = False + while StartProcessing.ProcessNextURL == False: + time.sleep(1) + + def DirectlyPlayIfAvailableOffline(self, MediaURL): + OfflineProtocol = 'Offline://' + LenOfflineProtocol = len(OfflineProtocol) + OfflineFile = MediaURL.strip(Quotes) + if OfflineFile.startswith(OfflineProtocol): + OfflineFile = DoubleQuoteString( + OfflineFile[LenOfflineProtocol:]) + PlayMedia(OfflineFile) + return True + return False + + +class ProgrammeArguments: + def __init__(self): + self.GetArguments() + self.SplitOneLetterArguments() + + def GetArguments(self): + global Arguments + if len(sys.argv) > 1: + Arguments = sys.argv[1:] + else: + Arguments = [] + + """ Can below function be written in a better way? """ + def SplitOneLetterArguments(self): + ArgumentsHavingValues = ['c'] + ArgumentsAndValuesDictionary = {} + ItemNumberOfValue = 1 + DeleteList = [] + for i in range(len(Arguments)): + if Arguments[i].startswith('-') == True: + if Arguments[i].startswith('--') == False: + if len(Arguments[i]) > 2: #eg. len(-p) == 2, len(-pc) == 3 + if Arguments[i].find('=') == -1: #eg. -c=xyz + SplitString = Arguments[i][1:] + for s in range(len(SplitString)): + NewItem = '-' + SplitString[s] + NewItemValue = '' + if NewItem[1:] in ArgumentsHavingValues: + NewItemValueNumber = i + ItemNumberOfValue + ItemNumberOfValue += 1 + # index out of range risk + NewItemValue = Arguments[NewItemValueNumber] + DeleteList.append(NewItemValueNumber) + ArgumentsAndValuesDictionary[NewItem] = NewItemValue + DeleteList.append(i) + DeleteList = sorted(DeleteList) + for i in range(len(DeleteList)): + """ Since an i is deleted from list, next to be deleted + will be itemtobedeleted - 1. for next it will be + itemtobedeleted - 2 etc. + """ + del Arguments[DeleteList[i] - i] + for keys, values in ArgumentsAndValuesDictionary.items(): + Arguments.append(keys) + if len(values) > 0: + Arguments.append(values) + + +class RunInTerminal: + """ Reexecute programme in terminal with received arguments if not + already running in terminal. + """ + def __init__(self): + if sys.stdout.isatty() == True: + return + else: + #find command for osx (Mac) + SupportedPlatorm = ( + 'linux', + 'freebsd', + 'openbsd', + 'netbsd', + 'trueos', + 'darwin') + if sys.platform.startswith(SupportedPlatorm): + Arguments2 = '' + for i in range(len(Arguments)): + Argument = Arguments[i] + if Argument.startswith('-') == False: + Arguments2 += ' ' + DoubleQuoteString(Argument) + else: + Arguments2 += ' ' + Argument + Arguments2=Arguments2.replace('\'','\'\\\'\'') + """ Programme = os.path.dirname(os.path.realpath( + sys.argv[0])) + sys.argv[0][1:] + """ + Programme = sys.argv[0] + Programme = DoubleQuoteString(Programme) + ProgrammeAndArguments = SingleQuoteString( + Programme + Arguments2) + TerminalEmulator = self.FindTerminalEmulator() + if TerminalEmulator == None: + sys.exit() + ReexecuteCommand = ( + TerminalEmulator + ' ' + ProgrammeAndArguments) + os.system(ReexecuteCommand) + sys.exit() + + def FindTerminalEmulator(self): + SpecifiedTerminal = VD['terminalemulator'] + """ Likely bug - execution command for different terminals + would be different like -e or something else. Should have a + tuple of execution command as well and return Terminal Emulator + including execution command. + """ + TerminalEmulators = ( + SpecifiedTerminal, + 'x-terminal-emulator', + 'gnome-terminal', + 'konsole', + 'konsole5', + 'mate-terminal', + 'xfce4-terminal', + 'terminal', + 'qterminal', + 'lxterminal', + 'roxterm', 'vt', + 'vte', + 'vte3', + 'tilix', + 'terminology', + 'guake', + 'anyterm', + 'eterm', + 'yakuake', + 'fbterm', + 'shellinabox', + 'sakura', + 'xterm', + 'xterm-256color', + 'uxterm', + 'vt52', + 'vt100', + 'vt102', + 'vt220', + 'ansi', + 'dumb', + 'qodem', + 'termit', + 'x3270-text', + 'mrxvt', + 'rxvt', + 'x3270-x11', + 'x3270', + 'wterm', + 'rxvt-unicode ', + 'rxvt-unicode-256color', + 'aterm', + 'terminator', + 'gtk30', + 'tilda', + 'yakuake', + 'urxvt', + 'roxterm', + 'evilvte', + 'sakura', + 'i3', + 'tmux', + 'xcompmgr', + 'yeahconsole', + 'stjerm', + 'dwm', + 'sterm', + 'altyo', + 'mlterm', + 'koi8rxterm', + 'lxterm') + for i in range(len(TerminalEmulators)): + TerminalPath = FindFile(TerminalEmulators[i]) + if TerminalPath != None: + TerminalPath = DoubleQuoteString(TerminalPath) + return TerminalPath + ' -e' + if sys.platform == 'darwin': + return 'terminal -e' + + +def GetPathsList(): + FindPaths = 'echo $PATH' + PathsString = RunSubprocessAndReturnOutputString( + FindPaths, Shell = True) + PathsList = PathsString.split(Configuration.PathListSeprator) + return PathsList + +def FindFile(FileNameOrPath, ReturnFullPath=True): + """ Find if specified file like media player exist in $PATH or + refering to a file that exist. + NOTE: should add current directory as well? + """ + if FileNameOrPath == None: #temporary fix + return + FileNameOrPath = FileNameOrPath.strip(Quotes) + PathsList = GetPathsList() + for i in range(len(PathsList)): + FilePath = os.path.join(PathsList[i], FileNameOrPath) + FileFound = os.path.isfile(FilePath) + if FileFound == True: + if ReturnFullPath == True: + return FilePath + return FileNameOrPath + FileFound = os.path.isfile(FileNameOrPath) + if FileFound == True: + if ReturnFullPath == True: + return os.path.abspath(FileNameOrPath) + return FileNameOrPath + +def RunSubprocessAndReturnOutputString(RunCommand, Shell=False): + if Shell==False: + RunCommand=shlex.split(RunCommand) + Execute=subprocess.Popen( + RunCommand, stdout=subprocess.PIPE, shell=Shell) + Byte=Execute.stdout.read() + String=Byte.decode(Encoding) + return String + + +class Configuration: + """ Configure variables used in programme based on OS, + configuration file, programme arguments, working directory etc. + """ + global Quotes, PathSlash, FileProtocol + Quotes = '"\'' + if sys.platform == 'win32': + PathSlash = '\\' + PathListSeprator = ';' + UserConfigurationDirectory = ( + 'AppData' + PathSlash + 'Roaming' + PathSlash) + else: + PathSlash = '/' + PathListSeprator = ':' + UserConfigurationDirectory = '.config' + PathSlash + + FileProtocol = 'file:' + 2*PathSlash + OneDirectoryUp = '..' + PathSlash + + def __init__(self): + global Encoding + self.FindVariousDirectories() + os.chdir(ProgrammeDirectory) + self.ReadConfigurationFile() + self.GenerateVariablesDictionary() + self.GlobalVariables() + self.ModifyCheckCreateDirectories() + """ This might be the problem in windows. it maybe decoding + using codepage instead of unicode. Try as utf-8 and printing + binary. if have crazy characters or numbers than solved the + problem. + """ + Encoding = sys.stdout.encoding + + def FindVariousDirectories(self): + global\ + ProgrammeDirectory,\ + StartedWorkingDirectory,\ + HomeDirectory + ProgrammeDirectory = os.path.dirname( + os.path.realpath(sys.argv[0])) + StartedWorkingDirectory = os.getcwd() + HomeDirectory = str(pathlib.Path.home()) + + def ReadConfigurationFile(self): + global ConfigurationFileTextLines, ConfigurationFilePath + SpecifiedConfigurationFilePath = '' + ConfigurationFileName = "imm.conf" + for i in range(len(Arguments)): + if (Arguments[i].startswith("-c=") + or Arguments[i].startswith("--configfile=") + or Arguments[i].startswith("--configurationfilepath=")): + + Arg = Arguments[i] + FilePathStartsAt = Arg.find('=') + SpecifiedConfigurationFilePath = Arg[FilePathStartsAt + 1:] + ConfigurationPaths = { + "SpecifiedConfigurationFilePath " : + SpecifiedConfigurationFilePath, + "InProgrammeDirectory" : os.path.join( + ProgrammeDirectory, ConfigurationFileName), + "InHomeDirectory" : HomeDirectory + + PathSlash + + Configuration.UserConfigurationDirectory + + "imm" + + PathSlash + + ConfigurationFileName} + for Keys, Paths in ConfigurationPaths.items(): + Path = os.path.abspath(Paths) + if os.path.isfile(Path): + ConfigurationFilePath = Path + ConfigurationFileTextLines = ReadlinesTextFile(Path) + return + DefaultConfigurationTextLines = [] + ConfigurationFileTextLines = DefaultConfigurationTextLines + ConfigurationFilePath = \ + ConfigurationPaths["InProgrammeDirectory"] + + def EditConfigurationFile(self, Variable, Value): + global ConfigurationFileTextLines + ReplaceWith = Variable + '=' + Value + Edited = False + for Lines in range(len(ConfigurationFileTextLines)): + Line = ConfigurationFileTextLines[Lines] + VariableInLineAt = Line.find('=') + VariableInLine = Line[:VariableInLineAt].strip(' ') + if VariableInLine == Variable: + ConfigurationFileTextLines[Lines] = ReplaceWith + Edited = True + if Edited == False: + ConfigurationFileTextLines.append(ReplaceWith) + WriteGeneralTextFiles( + ConfigurationFileTextLines, + ConfigurationFilePath) + + def GenerateVariablesDictionary(self): + global VD #VD is VariablesDictionary + """ These variables can be modified via arguments and + configuration file. unmodifiable variables are added/overwritten + after processing configuration file and arguments. + """ + VD = { + 'mediaplayeroptions' : '', + 'alternatemediaplayeroptions' : '', + "mediaplayermultiplesourcesplaycommand" : '', + "alternatemediaplayermultiplesourcesplaycommand" : '', + 'queueinimm' : 'no', + 'appendmedialist' : 'no', + 'defaultchoice' : 'ask', + 'allowseprateaudiosource' : 'yes', + # Do not use internet speed if not specified. + 'internetspeed':None, + # By default accept upto 4K resolution + 'mediaqualityheight':2200, + 'applymediapreferencetodownloadonlyalso' : 'no', + 'manuallyselectformat' : 'no', + 'preferaudioonly' : 'no', + 'customformatoptions' : '', + 'additionalyoutube-dlarguments' : '', + 'previouslist' : 'Previous', + 'watchlaterlist' : 'Watch Later', + 'offlinemedia' : 'Offline', + 'useterminal' : '', + 'youtube-dl' : './Code/youtube-dl'} + self.UpdateVariablesDictionaryFromConfigurationFile( + ConfigurationFileTextLines) + #RequiredVariables = ('mediaplayer') + ExpandOneLetterArguments = { + # 'm' -> play with alternate media player or media player + # specified in argument. + 'm' : 'mediaplayer', + 'a' : 'preferaudioonly'} + #Use default varibales value if value not specified in argument + DefaultArgumentVariablesValue = { + 'preferaudioonly' : 'yes', + 'mediaplayer' : VD.get('alternatemediaplayer')} + """ shouldn't both be considered: + --variable=value & --variable value + currently considering only former. Fix it. + if i < len(Arguments): + if (Argument[i+1].startswith('-') == False + and Argument[i+1].strip(Quotes).casefold().startswith(VD['validmediaurlstart']) == False + and (Argument[i+1].strip(Quotes).casefold().startswith(FileProtocol) == False): + + value = Argument[i+1] + """ + for i in range(len(Arguments)): + if Arguments[i].startswith('-'): + Arg = Arguments[i] + Seprator = Arg.find('=') + if Seprator != -1: + Variable = Arg[:Seprator].strip('-') + if Variable in ExpandOneLetterArguments: + Variable = ExpandOneLetterArguments[Variable] + Value = Arg[Seprator + 1:] + else: + Variable = Arg.strip('-') + if Variable in ExpandOneLetterArguments: + Variable = ExpandOneLetterArguments[Variable] + if Variable in DefaultArgumentVariablesValue: + Value = DefaultArgumentVariablesValue[Variable] + else: + Value = 'yes' + VD[Variable] = Value + UnmodifiableVD = { + # Should instead do if str.lowercase() == VD[key][i]: + 'validmediaurlstart' : ("http://", "https://"), + 'validextensioncontaningmediaurl1' : (".m3u", ".m3u8"), + # Find and replace possible conlicting symbols, atleast for + # now, later either use youtube-dl without shell = True or + # specify ASCII only characters in filenames to youtube-dl. + # remove this when fix unicode issue fixed in windows but + # if os=win32, specify *safe* characters only in youtube-dl + 'ReplaceTheseSymbols' : ('?', ' : ', '"', '/', '\\', '*', '<', '>', '|'), + 'ReplaceWithSymbols' : ('¿', ';', '\'', '-', '-', '★', '{', '}', 'I')} + VD.update(UnmodifiableVD) + + def UpdateVariablesDictionaryFromConfigurationFile( + self, ConfigurationFileTextLines): + + VariableValueSeprator = '=' + for Lines in range(len(ConfigurationFileTextLines)): + Line = ConfigurationFileTextLines[Lines] + if len(Line) == 0 or Line.startswith('#') or Line.startswith('['): + continue + SepratorAt = Line.find(VariableValueSeprator) + if SepratorAt != -1: + VariableName = Line[:SepratorAt].strip(' ') + VariableName = StandardVariableName(VariableName) + VariableValue = Line[SepratorAt+1:].strip(' ') + if len(VariableName) > 0 and len(VariableValue) > 0: + VD[VariableName] = VariableValue + + def GlobalVariables(self): + """ Some global vairbales from variablesdictionary for + neatness. + """ + global AdditionalYoutubeDLArguments + AdditionalYoutubeDLArguments = \ + VD['additionalyoutube-dlarguments'] + + def ModifyCheckCreateDirectories(self): + self.ChangePathSlashesIfWindowsOS() + self.SetM3UFileAndOfflineMediaDirectory() + Directories = ( + 'offlinemedia', + 'previouslist', + 'watchlaterlist', + 'previouslist2', + 'watchlaterlist2') + for i in range(len(Directories)): + VD[Directories[i]] =( + os.path.abspath(VD[Directories[i]]) + PathSlash) + DirectoryUse = ( + 'save media file(s) to this directory', + 'save media history to this directory', + 'save watch later list to this directory', + 'save media history to this directory', + 'save watch later list to this directory') + self.CreateDirectories( + Directories, DirectoryUse) + + def ChangePathSlashesIfWindowsOS(self): + if sys.platform == 'win32': + ModifyDirectories = ( + 'previouslist', + 'watchlaterlist', + 'offlinemedia') + for i in range(len(ModifyDirectories)): + VD[ModifyDirectories[i]] = ( + VD[ModifyDirectories[i]].replace('/', '\\')) + + def SetM3UFileAndOfflineMediaDirectory(self): + """ Use StartedWorkingDirectory for saving/downloading media + execept when same as HomeDirectory or sub directory of + ProgrammeDirectory than use ProgrammeDirectory. + """ + if (StartedWorkingDirectory.startswith(ProgrammeDirectory) + or StartedWorkingDirectory == HomeDirectory): + + VD['previouslist2'] = VD['previouslist'] + VD['watchlaterlist2'] = VD['watchlaterlist'] + else: + SetToStartedWorkingDirectory = ( + 'previouslist2', + 'watchlaterlist2', + 'offlinemedia') + for i in range(len(SetToStartedWorkingDirectory)): + VD[SetToStartedWorkingDirectory[i]] = ( + StartedWorkingDirectory) + + def CreateDirectories( + self, Directories, DirectoryUse = ('unknown')): + + """ Directories which are in VD only. Not a generic function + but specific + .""" + for i in range(len(Directories)): + if os.path.isdir(VD[Directories[i]]) == False: + NewDirectory = VD[Directories[i]] + if NewDirectory.startswith( + ProgrammeDirectory) == True: + os.mkdir(NewDirectory) + else: + print( + Directories[i] + + ' directory "' + + NewDirectory + + '" does not exist. Type \'yes\' to create\ + this directory and ' + + DirectoryUse[i] + + '. Or simply press return key to exit.') + while True: + CreateOrNot = input() + if CreateOrNot == 'yes': + try: + os.mkdir(NewDirectory) + break + except: + print( + "Could not create directory. " + "Probably permission error. Still " + "do not run as root/sudo/" + "administrator. Instead try some " + "other directory. Press return to " + "exit.") + input() + sys.exit() + if CreateOrNot == '': + print('Goodbye!') + time.sleep(3) + sys.exit() + else: + print( + "Invalid input. Type either \'yes\' " + "or nothing.") + + def MediaPlayerVariables(self): + global\ + MediaPlayer,\ + MediaPlayerOptions,\ + MediaPlayerMultipleSourcePlayCommand + if '--alternatemediaplayer' in Arguments or '-m' in Arguments: + MediaPlayer = LookupInVD('alternatemediaplayer') + if MediaPlayer != None: + MediaPlayerOptions = VD['alternatemediaplayeroptions'] + MediaPlayerMultipleSourcePlayCommand = \ + VD["alternatemediaplayermultiplesourcesplaycommand"] + return + else: + print( + "Alternate media player not found in configuration file" + " or arguments. Trying to use primary media player.") + MediaPlayer = self.LookupInVD("mediaplayer") + if MediaPlayer != None: + MediaPlayerOptions = VD["mediaplayeroptions"] + MediaPlayerMultipleSourcePlayCommand = \ + VD["mediaplayermultiplesourcesplaycommand"] + else: + MediaPlayer = self.FindExecutable("Media Player") + MediaPlayerOptions = '' + self.EditConfigurationFile( + "mediaplayeroptions", MediaPlayerOptions) + MediaPlayerMultipleSourcePlayCommand =\ + self.LookInPreConfiguredCmdOfMediaPLayers() + self.EditConfigurationFile( + "mediaplayermultiplesourcesplaycommand", + MediaPlayerMultipleSourcePlayCommand) + + def LookInPreConfiguredCmdOfMediaPLayers(self): + CheckMediaPlayer = MediaPlayer + PreConfiguredCmd = { + "vlc" : "videosource :input-slave=audiosource", + "mpv" : "videosource --audio-file=audiosource"} + #Execeptions = ("gnome-mpv", "umpv") + DoesNotSupportWarning = ( + "Media player may not support seprate audio source " + "playback. Seprate video+audio formats will not be " + "considered. If you know that specified media player " + "supports seprate audio source than add that coommand to " + "imm.conf file as:\n" + "\n" + "mediaplayermultiplesourcesplaycommand=" + "videosource --audio audiosource\n" + "\n" + "videosource and audiosource will be replaced with " + "video url/file and audio url/file respectively.") + CheckMediaPlayer = os.path.split(MediaPlayer)[1] + if CheckMediaPlayer.endswith(".exe"): + CheckMediaPlayer = CheckMediaPlayer[:-4] + MediaPlayerCmd = PreConfiguredCmd.get(CheckMediaPlayer) + if MediaPlayerCmd == None: + print(DoesNotSupportWarning) + return '' + else: + return MediaPlayerCmd + #for Player, Cmd in PreConfiguredCmd.items(): + #if CheckMediaPlayer.endswith(Player): + #if MediaPlayer.endswith(Execeptions): + #print(DoesNotSupportWarning) + #return '' + #else: + #return Cmd + #else: + #print(DoesNotSupportWarning) + #return '' + + def FindExecutable(self, ExecName): + SampleExec = StandardVariableName(ExecName) + Executable = self.LookupInVD(SampleExec) + if Executable != None: + return Executable + print( + ExecName + " not found in configuration nor specified in " + "arguments. Enter " + ExecName + " run command (if any) " + "like '" + SampleExec + "' or full path to executable like" + " \"/usr/bin/" + SampleExec + "\" in GNU/Linux and other " + "unix-like OS or \"c:\\Programme files\\" + ExecName + "\\" + + SampleExec + ".exe\" in Windows") + while True: + Executable = input() + Executable = FindFile(Executable) + if Executable == None: + print( + ExecName + " not found, try giving full path or " + "try again") + else: + self.EditConfigurationFile(SampleExec, Executable) + break + return Executable + + def LookupInVD(self, VDKey): + Executable = VD.get(VDKey) + return FindFile(Executable) #return None if not found + + +def Main(): + global MediaPlayer, YoutubeDL + ProgrammeArguments() + Config = Configuration() + RunInTerminal() + + YoutubeDL = Config.FindExecutable("Youtube-DL") + Config.MediaPlayerVariables() + StartProcessing() + +def GnomeMPVExp(PlayCommand): + ConfigFile = HomeDirectory+"/.config/mpv/mpv.conf" + ConfigList = ReadlinesTextFile(ConfigFile) + ConfigListBak = tuple(ConfigList) + print(PlayCommand) + PlayCommand = shlex.split(PlayCommand)[1:] + print(PlayCommand) + input() + for i in range(len(PlayCommand)): + ConfigList.append(PlayCommand[i]) + WriteGeneralTextFiles(ConfigList, ConfigFile) + time.sleep(5) + os.system("gnome-mpv") + time.sleep(50) + WriteGeneralTextFiles(ConfigListBak, ConfigFile) + + + +#================================== + +Main()