diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/LICENSE.md b/LICENSE.md deleted file mode 100644 index 6eb6ddf..0000000 --- a/LICENSE.md +++ /dev/null @@ -1,21 +0,0 @@ -MIT License - -Copyright (c) 2021 play-dl - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. diff --git a/docs/README.md b/docs/README.md index 11acbf4..dcc1c88 100644 --- a/docs/README.md +++ b/docs/README.md @@ -34,7 +34,7 @@ if(check === 'so_track') // SoundCloud Track ### authorization() -_This creates basic spotify / soundcloud data to be stored locally._ +_This creates basic spotify / soundcloud / youtube data to be stored locally._ ```js authorization() //After then you will be asked about type of data you want to create and then follow the steps properly. @@ -73,10 +73,23 @@ let data = await search('Rick Roll', { limit: 1, source : { soundcloud : "tracks ### Stream +**Attaching events to player is important for stream to work.** + +#### attachListeners(player : `AudioPlayer`, resource : `YouTubeStream | SoundCloudStream`) + +_This is used for attaching pause and playing events to audioPlayer._ + +```js +let resource = await stream("url") + +let player = createAudioPlayer() + +attachListeners(player, resource) +``` + #### StreamOptions : - quality : `number` :- Sets quality of stream [ 0 = Lowest, 1 = Medium ]. Leave this empty to get highest audio quality. -- cookie : `string` :- **[Cookies](https://github.com/play-dl/play-dl/discussions/34)** are optional and are required for playing age restricted videos. - proxy : `Proxy` :- Optional parameter to add support of proxies. As of now, HTTPS proxies are only supported. So make sure to get HTTPS proxies only. #### stream(url : `string`, options? : [`StreamOptions`](https://github.com/play-dl/play-dl/tree/main/docs#streamoptions-)) @@ -90,8 +103,6 @@ let source = await stream("url", { quality : 0 }) // Lowest quality let source = await stream("url", { quality : 1 }) // Next to Lowest quality. -let source = await stream("url", { cookie: COOKIE }) //This will create a stream Class and also give cookies. - let source = await stream(url, { proxy : ['url'] }) // Accepts a url which has port in it. let source = await stream(url. {proxy : [{ @@ -118,9 +129,6 @@ let source = await stream_from_info(info, { quality : 0 }) // Lowest quality let source = await stream_from_info(info, { quality : 1 }) // Next to Lowest quality. -let source = await stream_from_info(info, { cookie: COOKIE }) //This will create a stream Class and also give cookies if retrying. - - let source = await stream_from_info(info, { proxy : ['url'] }) // Accepts a url which has port in it. let source = await stream_from_info(info, {proxy : [{ diff --git a/docs/YouTube/README.md b/docs/YouTube/README.md index 67ae211..91164e7 100644 --- a/docs/YouTube/README.md +++ b/docs/YouTube/README.md @@ -47,12 +47,9 @@ let id = extractID(url) _This are the info options that can be passed as a parameter in `video_info` and `video_basic_info`_ -- cookie : **[Cookies](https://github.com/play-dl/play-dl/discussions/34) are optional and are required for playing age restricted videos.** - proxy : Optional parameter to add support of proxies. As of now, HTTPS proxies are only supported. So make sure to get HTTPS proxies only. ```js -const video = await video_basic_info(url, { cookie : "cookies" }) // Gives cookies support - const video = await video_basic_info(url, { proxy : ['url'] }) // Accepts a url which has port in it. const video = await video_basic_info(url, {proxy : [{ diff --git a/examples/YouTube/play - cookies.js b/examples/YouTube/play - cookies.js deleted file mode 100644 index edeb9fc..0000000 --- a/examples/YouTube/play - cookies.js +++ /dev/null @@ -1,48 +0,0 @@ -const discord = require('discord.js') -const { Intents } = require('discord.js') -const { createAudioPlayer, createAudioResource , StreamType, demuxProbe, joinVoiceChannel, NoSubscriberBehavior, AudioPlayerStatus, VoiceConnectionStatus, getVoiceConnection } = require('@discordjs/voice') -const play = require('play-dl') -const client = new discord.Client({ intents : [Intents.FLAGS.GUILDS, Intents.FLAGS.GUILD_MESSAGES, Intents.FLAGS.GUILD_VOICE_STATES, Intents.FLAGS.DIRECT_MESSAGES] , partials : ['CHANNEL', 'MESSAGE']}) -const token = '< YOUR BOT TOKEN >' -const COOKIE = '< YOUR COOKIES >' - - -client.on('messageCreate', async message => { - if(message.content.startsWith('!play')){ - if(!message.member.voice?.channel) return message.channel.send('Connect to a Voice Channel') - const connection = joinVoiceChannel({ - channelId : message.member.voice.channel.id, - guildId : message.guild.id, - adapterCreator: message.guild.voiceAdapterCreator - }) - - let args = message.content.split('play ')[1].split(' ')[0] - let stream = await play.stream(args, { cookie : COOKIE }) - /* - OR if you want to get info about youtube link and then stream it - - let yt_info = await play.video_info(args, { cookie : COOKIE }) - console.log(yt_info.video_details.title) - let stream = await play.stream_from_info(yt_info, { cookie : COOKIE }) - */ - - let resource = createAudioResource(stream.stream, { - inputType : stream.type - }) - let player = createAudioPlayer({ - behaviors: { - noSubscriber: NoSubscriberBehavior.Play - } - }) - player.play(resource) - - connection.subscribe(player) - } -}) - -client.on('ready', () => { - console.log(`We have logged in as ${client.user.tag}!`) -}) - -client.login(token); - diff --git a/play-dl/Request/classes.ts b/play-dl/Request/classes.ts new file mode 100644 index 0000000..4fc96a2 --- /dev/null +++ b/play-dl/Request/classes.ts @@ -0,0 +1,110 @@ +import tls , { TLSSocket } from "tls"; +import { URL } from "url"; +import { Timer } from "../YouTube/classes/LiveStream"; + +interface ResponseOptions extends tls.ConnectionOptions{ + body?: string; + method: 'GET' | 'POST'; + cookies? : boolean + headers? : Object; + timeout? : number +} + +export class Response { + parsed_url : URL + statusCode : number; + rawHeaders : string; + headers : Object; + body : string; + socket : TLSSocket; + sentHeaders : string; + sentBody : string; + private options : ResponseOptions; + private timer : Timer | null + constructor(req_url : string, options : ResponseOptions){ + this.parsed_url = new URL(req_url) + this.sentHeaders = '' + this.statusCode = 0 + this.sentBody = "" + this.rawHeaders = '' + this.body = '' + this.headers = {} + this.timer = null + this.options = options + this.socket = tls.connect({ + host : this.parsed_url.hostname, + port : Number(this.parsed_url.port) || 443, + socket : options.socket, + rejectUnauthorized : false + }, () => this.onConnect()) + if(options.headers){ + for(const [ key, value ] of Object.entries(options.headers)){ + this.sentHeaders += `${key}: ${value}\r\n` + } + } + if(options.body) this.sentBody = options.body + } + + private onConnect(){ + this.socket.write( + `${this.options.method} ${this.parsed_url.pathname}${this.parsed_url.search} HTTP/1.1\r\n` + + `Host : ${this.parsed_url.hostname}\r\n` + + this.sentHeaders + + `Connection: close\r\n` + + `\r\n` + + this.sentBody + ) + } + + private parseHeaders(){ + const head_arr = this.rawHeaders.split('\r\n') + this.statusCode = Number(head_arr.shift()?.split(' ')[1]) ?? -1 + for(const head of head_arr){ + let [ key, value ] = head.split(': ') + if(!value) break; + key = key.trim().toLowerCase() + value = value.trim() + if(Object.keys(this.headers).includes(key)){ + let val = (this.headers as any)[key] + if(typeof val === 'string') val = [val] + Object.assign(this.headers, { [key]: [...val, value] }) + } + else Object.assign(this.headers, { [key] : value }) + } + } + + stream(): Promise{ + return new Promise((resolve, reject) => { + this.timer = new Timer(() => this.socket.end(), this.options.timeout || 1) + this.socket.once('error', (err) => reject(err)) + this.socket.once('data', (chunk) => { + this.rawHeaders = chunk.toString('utf-8') + this.parseHeaders() + resolve(this.socket) + }) + this.socket.on('data', () => this.timer?.reuse()) + this.socket.once('end', () => this.timer?.destroy()) + }) + } + + fetch(): Promise{ + return new Promise((resolve, reject) => { + this.socket.setEncoding('utf-8'); + this.socket.once('error', (err) => reject(err)) + this.socket.on('data', (chunk: string) => { + if(this.rawHeaders.length === 0){ + this.rawHeaders = chunk + this.parseHeaders() + } + else { + const arr = chunk.split('\r\n') + if(arr.length > 1 && arr[0].length < 5) arr.shift() + this.body += arr.join('') + } + }) + this.socket.on('end', () => { + resolve(this) + }) + }) + } +} \ No newline at end of file diff --git a/play-dl/Request/index.ts b/play-dl/Request/index.ts new file mode 100644 index 0000000..97bec5e --- /dev/null +++ b/play-dl/Request/index.ts @@ -0,0 +1,53 @@ +import { Response } from "./classes"; + + +export type Proxy = ProxyOpts | string; + +interface ProxyOpts { + host: string; + port: number; + authentication?: { + username: string; + password: string; + }; +} + +interface RequestOptions { + body?: string; + method: 'GET' | 'POST'; + proxies?: Proxy[]; + cookies? : boolean + headers? : Object; + timeout? : number +} + +interface StreamGetterOptions{ + method: 'GET' | 'POST'; + cookies? : boolean + headers : Object; +} + +export function request_stream(req_url : string, options : RequestOptions = {method : "GET"}): Promise{ + return new Promise(async(resolve, reject) => { + let res = new Response(req_url, options) + await res.stream() + if (res.statusCode >= 300 && res.statusCode < 400) { + res = await request_stream((res.headers as any).location, options); + await res.stream() + } + resolve(res) + }) +} + +export function request(req_url : string, options : RequestOptions = {method : "GET"}): Promise{ + return new Promise(async(resolve, reject) => { + let res = new Response(req_url, options) + await res.fetch() + if (Number(res.statusCode) >= 300 && Number(res.statusCode) < 400) { + res = await request((res.headers as any).location, options); + } else if (Number(res.statusCode) > 400) { + reject(new Error(`Got ${res.statusCode} from the request`)); + } + resolve(res) + }) +} \ No newline at end of file diff --git a/play-dl/SoundCloud/classes.ts b/play-dl/SoundCloud/classes.ts index 9674af3..a854172 100644 --- a/play-dl/SoundCloud/classes.ts +++ b/play-dl/SoundCloud/classes.ts @@ -2,6 +2,7 @@ import { request, request_stream } from '../YouTube/utils/request'; import { PassThrough } from 'stream'; import { IncomingMessage } from 'http'; import { StreamType } from '../YouTube/stream'; +import { Timer } from '../YouTube/classes/LiveStream'; interface SoundCloudUser { name: string; @@ -204,37 +205,28 @@ export class Stream { stream: PassThrough; type: StreamType; private url: string; - private playing_count: number; private downloaded_time: number; + private timer: Timer; private downloaded_segments: number; private request: IncomingMessage | null; - private data_ended: boolean; private time: number[]; private segment_urls: string[]; constructor(url: string, type: StreamType = StreamType.Arbitrary) { this.stream = new PassThrough({ highWaterMark: 10 * 1000 * 1000 }); this.type = type; this.url = url; - this.playing_count = 0; this.downloaded_time = 0; this.request = null; this.downloaded_segments = 0; - this.data_ended = false; this.time = []; + this.timer = new Timer(() => { + this.timer.reuse(); + this.start(); + }, 280); this.segment_urls = []; this.stream.on('close', () => { this.cleanup(); }); - this.stream.on('pause', () => { - this.playing_count++; - if (this.data_ended) { - this.cleanup(); - this.stream.removeAllListeners('pause'); - } else if (this.playing_count === 110) { - this.playing_count = 0; - this.start(); - } - }); this.start(); } @@ -268,19 +260,20 @@ export class Stream { } private async loop() { - if (this.stream.destroyed) { + if (this.stream.destroyed ||this.time.length === 0 || this.segment_urls.length === 0) { this.cleanup(); return; } - if (this.time.length === 0 || this.segment_urls.length === 0) { - this.data_ended = true; - return; - } this.downloaded_time += this.time.shift() as number; this.downloaded_segments++; const stream = await request_stream(this.segment_urls.shift() as string).catch((err: Error) => err); - if (stream instanceof Error) throw stream; + if (stream instanceof Error) { + this.stream.emit('error', stream); + this.cleanup(); + return; + } + this.request = stream stream.pipe(this.stream, { end: false }); stream.on('end', () => { if (this.downloaded_time >= 300) return; @@ -292,14 +285,22 @@ export class Stream { } private cleanup() { + this.timer.destroy(); this.request?.unpipe(this.stream); this.request?.destroy(); this.url = ''; - this.playing_count = 0; this.downloaded_time = 0; this.downloaded_segments = 0; this.request = null; this.time = []; this.segment_urls = []; } + + pause() { + this.timer.pause(); + } + + resume() { + this.timer.resume(); + } } diff --git a/play-dl/SoundCloud/index.ts b/play-dl/SoundCloud/index.ts index 7c59028..5f8a56e 100644 --- a/play-dl/SoundCloud/index.ts +++ b/play-dl/SoundCloud/index.ts @@ -127,11 +127,12 @@ export async function check_id(id: string): Promise { * @returns "false" | 'track' | 'playlist' */ export async function so_validate(url: string): Promise { + if (!url.match(pattern)) return false; const data = await request( `https://api-v2.soundcloud.com/resolve?url=${url}&client_id=${soundData.client_id}` ).catch((err: Error) => err); - if (data instanceof Error) throw data; + if (data instanceof Error) return false; const json_data = JSON.parse(data); if (json_data.kind === 'track') return 'track'; diff --git a/play-dl/YouTube/classes/LiveStream.ts b/play-dl/YouTube/classes/LiveStream.ts index 8b3d2af..aaf7f3d 100644 --- a/play-dl/YouTube/classes/LiveStream.ts +++ b/play-dl/YouTube/classes/LiveStream.ts @@ -17,9 +17,9 @@ export class LiveStreaming { private url: string; private interval: number; private packet_count: number; - private timer: NodeJS.Timer | null; + private timer: Timer; private video_url: string; - private dash_timer: NodeJS.Timer | null; + private dash_timer: Timer; private segments_urls: string[]; private request: IncomingMessage | null; constructor(dash_url: string, target_interval: number, video_url: string) { @@ -30,12 +30,15 @@ export class LiveStreaming { this.segments_urls = []; this.packet_count = 0; this.request = null; - this.timer = null; this.video_url = video_url; - this.interval = target_interval * 1000 || 0; - this.dash_timer = setTimeout(() => { + this.interval = target_interval || 0; + this.timer = new Timer(() => { + this.start(); + }, this.interval); + this.dash_timer = new Timer(() => { + this.dash_timer.reuse(); this.dash_updater(); - }, 1800000); + }, 1800); this.stream.on('close', () => { this.cleanup(); }); @@ -51,9 +54,6 @@ export class LiveStreaming { ) { this.url = info.LiveStreamData.dashManifestUrl; } - this.dash_timer = setTimeout(() => { - this.dash_updater(); - }, 1800000); } private async dash_getter() { @@ -70,14 +70,12 @@ export class LiveStreaming { } private cleanup() { - clearTimeout(this.timer as NodeJS.Timer); - clearTimeout(this.dash_timer as NodeJS.Timer); + this.timer.destroy(); + this.dash_timer.destroy(); this.request?.unpipe(this.stream); this.request?.destroy(); - this.dash_timer = null; this.video_url = ''; this.request = null; - this.timer = null; this.url = ''; this.base_url = ''; this.segments_urls = []; @@ -114,10 +112,12 @@ export class LiveStreaming { }); }); } - this.timer = setTimeout(() => { - this.start(); - }, this.interval); + + this.timer.reuse(); } + + pause() {} + resume() {} } /** * Class for YouTube Stream @@ -130,9 +130,7 @@ export class Stream { private per_sec_bytes: number; private content_length: number; private video_url: string; - private cookie: string; - private data_ended: boolean; - private playing_count: number; + private timer: Timer; private quality: number; private proxy: Proxy[] | undefined; private request: IncomingMessage | null; @@ -142,7 +140,6 @@ export class Stream { duration: number, contentLength: number, video_url: string, - cookie: string, options: StreamOptions ) { this.stream = new PassThrough({ highWaterMark: 10 * 1000 * 1000 }); @@ -152,32 +149,21 @@ export class Stream { this.type = type; this.bytes_count = 0; this.video_url = video_url; - this.cookie = cookie; this.per_sec_bytes = Math.ceil(contentLength / duration); this.content_length = contentLength; this.request = null; - this.data_ended = false; - this.playing_count = 0; + this.timer = new Timer(() => { + this.timer.reuse(); + this.loop(); + }, 280); this.stream.on('close', () => { this.cleanup(); }); - this.stream.on('pause', () => { - this.playing_count++; - if (this.data_ended) { - this.bytes_count = 0; - this.per_sec_bytes = 0; - this.cleanup(); - this.stream.removeAllListeners('pause'); - } else if (this.playing_count === 280) { - this.playing_count = 0; - this.loop(); - } - }); this.loop(); } private async retry() { - const info = await video_info(this.video_url, { cookie: this.cookie, proxy: this.proxy }); + const info = await video_info(this.video_url, { proxy: this.proxy }); const audioFormat = parseAudioFormats(info.format); this.url = audioFormat[this.quality].url; } @@ -202,7 +188,6 @@ export class Stream { }).catch((err: Error) => err); if (stream instanceof Error) { this.stream.emit('error', stream); - this.data_ended = true; this.bytes_count = 0; this.per_sec_bytes = 0; this.cleanup(); @@ -228,7 +213,75 @@ export class Stream { }); stream.on('end', () => { - if (end >= this.content_length) this.data_ended = true; + if (end >= this.content_length) { + this.timer.destroy(); + } }); } + + pause() { + this.timer.pause(); + } + + resume() { + this.timer.resume(); + } +} + +export class Timer { + private destroyed: boolean; + private paused: boolean; + private timer: NodeJS.Timer; + private callback: () => void; + private time_start: number; + private time_left: number; + private time_total: number; + constructor(callback: () => void, time: number) { + this.callback = callback; + this.time_total = time; + this.time_left = time; + this.paused = false; + this.destroyed = false; + this.time_start = process.hrtime()[0]; + this.timer = setTimeout(this.callback, this.time_total * 1000); + } + + pause() { + if (!this.paused && !this.destroyed) { + this.paused = true; + clearTimeout(this.timer); + this.time_left = this.time_left - (process.hrtime()[0] - this.time_start); + return true; + } else return false; + } + + resume() { + if (this.paused && !this.destroyed) { + this.paused = false; + this.time_start = process.hrtime()[0]; + this.timer = setTimeout(this.callback, this.time_left * 1000); + return true; + } else return false; + } + + reuse() { + if (!this.destroyed) { + clearTimeout(this.timer); + this.time_left = this.time_total; + this.paused = false; + this.time_start = process.hrtime()[0]; + this.timer = setTimeout(this.callback, this.time_total * 1000); + return true; + } else return false; + } + + destroy() { + clearTimeout(this.timer); + this.destroyed = true; + this.callback = () => {}; + this.time_total = 0; + this.time_left = 0; + this.paused = false; + this.time_start = 0; + } } diff --git a/play-dl/YouTube/stream.ts b/play-dl/YouTube/stream.ts index c87f683..674bc9c 100644 --- a/play-dl/YouTube/stream.ts +++ b/play-dl/YouTube/stream.ts @@ -12,7 +12,6 @@ export enum StreamType { export interface StreamOptions { quality?: number; - cookie?: string; proxy?: Proxy[]; } @@ -54,7 +53,7 @@ export type YouTubeStream = Stream | LiveStreaming; * @returns Stream class with type and stream for playing. */ export async function stream(url: string, options: StreamOptions = {}): Promise { - const info = await video_info(url, { cookie: options.cookie, proxy: options.proxy }); + const info = await video_info(url, { proxy: options.proxy }); const final: any[] = []; if ( info.LiveStreamData.isLive === true && @@ -83,7 +82,6 @@ export async function stream(url: string, options: StreamOptions = {}): Promise< info.video_details.durationInSec, Number(final[0].contentLength), info.video_details.url, - options.cookie as string, options ); } @@ -122,7 +120,6 @@ export async function stream_from_info(info: InfoData, options: StreamOptions = info.video_details.durationInSec, Number(final[0].contentLength), info.video_details.url, - options.cookie as string, options ); } diff --git a/play-dl/YouTube/utils/cookie.ts b/play-dl/YouTube/utils/cookie.ts new file mode 100644 index 0000000..28a19da --- /dev/null +++ b/play-dl/YouTube/utils/cookie.ts @@ -0,0 +1,31 @@ +import fs from 'fs'; + +let youtubeData: youtubeDataOptions; +if (fs.existsSync('.data/youtube.data')) { + youtubeData = JSON.parse(fs.readFileSync('.data/youtube.data').toString()); +} + +interface youtubeDataOptions { + cookie?: Object; +} + +export function getCookies(): undefined | string { + let result = '' + if(!youtubeData?.cookie) return undefined + for (const [ key, value ] of Object.entries(youtubeData.cookie)){ + result+= `${key}=${value};` + } + return result; +} + +export function setCookie(key: string, value: string): boolean { + if (!youtubeData?.cookie) return false; + key = key.trim() + value = value.trim() + Object.assign(youtubeData.cookie, { [key] : value }) + return true +} + +export function uploadCookie() { + if(youtubeData) fs.writeFileSync('.data/youtube.data', JSON.stringify(youtubeData, undefined, 4)); +} diff --git a/play-dl/YouTube/utils/extractor.ts b/play-dl/YouTube/utils/extractor.ts index efbb4fc..8701d6f 100644 --- a/play-dl/YouTube/utils/extractor.ts +++ b/play-dl/YouTube/utils/extractor.ts @@ -4,7 +4,6 @@ import { YouTubeVideo } from '../classes/Video'; import { YouTubePlayList } from '../classes/Playlist'; interface InfoOptions { - cookie?: string; proxy?: Proxy[]; } @@ -41,7 +40,7 @@ export function yt_validate(url: string): 'playlist' | 'video' | false { if (Playlist_id.length !== 34 || !Playlist_id.startsWith('PL')) { return false; } - return 'playlist'; + else return 'playlist'; } } /** @@ -78,12 +77,8 @@ export async function video_basic_info(url: string, options: InfoOptions = {}) { const new_url = `https://www.youtube.com/watch?v=${video_id}&has_verified=1`; const body = await request(new_url, { proxies: options.proxy ?? undefined, - headers: options.cookie - ? { - 'cookie': options.cookie, - 'accept-language': 'en-US,en-IN;q=0.9,en;q=0.8,hi;q=0.7' - } - : { 'accept-language': 'en-US,en-IN;q=0.9,en;q=0.8,hi;q=0.7' } + headers: { 'accept-language': 'en-US,en-IN;q=0.9,en;q=0.8,hi;q=0.7' }, + cookies : true }); const player_response = JSON.parse(body.split('var ytInitialPlayerResponse = ')[1].split('}};')[0] + '}}'); const initial_response = JSON.parse(body.split('var ytInitialData = ')[1].split('}};')[0] + '}}'); @@ -115,9 +110,9 @@ export async function video_basic_info(url: string, options: InfoOptions = {}) { url: `https://www.youtube.com/watch?v=${vid.videoId}`, title: vid.title, description: vid.shortDescription, - duration: vid.lengthSeconds, - duration_raw: parseSeconds(vid.lengthSeconds), - uploadedDate: microformat.publishDate, + duration: Number(vid.lengthSeconds), + duration_raw: parseSeconds(Number(vid.lengthSeconds)), + uploadedAt: microformat.publishDate, thumbnail: vid.thumbnail.thumbnails[vid.thumbnail.thumbnails.length - 1], channel: { name: vid.author, diff --git a/play-dl/YouTube/utils/parser.ts b/play-dl/YouTube/utils/parser.ts index 39e0b17..e84bd5b 100644 --- a/play-dl/YouTube/utils/parser.ts +++ b/play-dl/YouTube/utils/parser.ts @@ -31,7 +31,8 @@ export function ParseSearchResult(html: string, options?: ParseSearchInterface): json_data.contents.twoColumnSearchResultsRenderer.primaryContents.sectionListRenderer.contents[0] .itemSectionRenderer.contents; for (let i = 0; i < details.length; i++) { - if (typeof options.limit === 'number' && options.limit > 0 && results.length >= options.limit) break; + if (typeof options.limit === 'number' && options.limit > 0 && results.length === options.limit) break; + if (!details[i].videoRenderer && !details[i].channelRenderer && !details[i].playlistRenderer) continue; if (options.type === 'video') { const parsed = parseVideo(details[i]); if (!parsed) continue; @@ -154,7 +155,7 @@ export function parseVideo(data?: any): YouTubeVideo { * @returns YouTubePlaylist class */ export function parsePlaylist(data?: any): YouTubePlayList { - if (!data.playlistRenderer) throw new Error('Failed to Parse YouTube Playlist'); + if (!data || !data.playlistRenderer) throw new Error('Failed to Parse YouTube Playlist'); const res = new YouTubePlayList( { diff --git a/play-dl/YouTube/utils/request.ts b/play-dl/YouTube/utils/request.ts index f2735f2..29e6a49 100644 --- a/play-dl/YouTube/utils/request.ts +++ b/play-dl/YouTube/utils/request.ts @@ -2,6 +2,7 @@ import https, { RequestOptions } from 'https'; import tls from 'tls'; import http, { ClientRequest, IncomingMessage } from 'http'; import { URL } from 'url'; +import { getCookies, setCookie, uploadCookie } from './cookie'; /** * Types for Proxy */ @@ -18,7 +19,7 @@ interface ProxyOpts { interface ProxyOutput { statusCode: number; - head: string; + head: string[]; body: string; } @@ -26,6 +27,7 @@ interface RequestOpts extends RequestOptions { body?: string; method?: 'GET' | 'POST'; proxies?: Proxy[]; + cookies? : boolean } /** * Main module that play-dl uses for making a https request @@ -135,7 +137,7 @@ async function proxy_getter(req_url: string, req_proxy: Proxy[]): Promise { +export async function request(url: string, options: RequestOpts = {}): Promise { return new Promise(async (resolve, reject) => { - if (!options?.proxies) { + if (!options?.proxies || options.proxies.length === 0) { let data = ''; + let cook = getCookies() + if (typeof cook === 'string' && options.headers) { + Object.assign(options.headers, { cookie : cook }); + } let res = await https_getter(url, options).catch((err: Error) => err); if (res instanceof Error) { reject(res); return; } + if(res.headers && res.headers['set-cookie'] && cook){ + res.headers['set-cookie'].forEach((x) => { + x.split(';').forEach((x) => { + const [key, value] = x.split('='); + if (!value) return; + setCookie(key, value); + }); + }) + uploadCookie() + } if (Number(res.statusCode) >= 300 && Number(res.statusCode) < 400) { res = await https_getter(res.headers.location as string, options); } else if (Number(res.statusCode) > 400) { @@ -168,13 +184,30 @@ export async function request(url: string, options?: RequestOpts): Promise (data += c)); res.on('end', () => resolve(data)); } else { + let cook = getCookies() + if (typeof cook === 'string' && options.headers) { + Object.assign(options.headers, { cookie : cook }); + } let res = await proxy_getter(url, options.proxies).catch((e: Error) => e); if (res instanceof Error) { reject(res); return; } + if(res.head && cook){ + let cookies = res.head.filter((x) => x.toLocaleLowerCase().startsWith('set-cookie: ')); + cookies.forEach((x) => { + x.toLocaleLowerCase().split('set-cookie: ')[1].split(';').forEach((y) => { + let [key, value] = y.split('='); + if (!value) + return; + setCookie(key, value); + }); + }); + uploadCookie() + } if (res.statusCode >= 300 && res.statusCode < 400) { - res = await proxy_getter(res.head.split('Location: ')[1].split('\n')[0], options.proxies); + let url = res.head.filter((x) => x.startsWith('Location: ')); + res = await proxy_getter(url[0].split('\n')[0], options.proxies); } else if (res.statusCode > 400) { reject(new Error(`GOT ${res.statusCode} from proxy request`)); } diff --git a/play-dl/index.ts b/play-dl/index.ts index b4ae6a5..d63f022 100644 --- a/play-dl/index.ts +++ b/play-dl/index.ts @@ -2,6 +2,14 @@ export { playlist_info, video_basic_info, video_info, yt_validate, extractID, Yo export { spotify, sp_validate, refreshToken, is_expired, Spotify } from './Spotify'; export { soundcloud, so_validate, SoundCloud, SoundCloudStream } from './SoundCloud'; +enum AudioPlayerStatus { + Idle = 'idle', + Buffering = 'buffering', + Paused = 'paused', + Playing = 'playing', + AutoPaused = 'autopaused' +} + interface SearchOptions { limit?: number; source?: { @@ -28,6 +36,7 @@ import { check_id, so_search, stream as so_stream, stream_from_info as so_stream import { InfoData, stream as yt_stream, StreamOptions, stream_from_info as yt_stream_info } from './YouTube/stream'; import { SoundCloudTrack } from './SoundCloud/classes'; import { yt_search } from './YouTube/search'; +import { EventEmitter } from 'stream'; /** * Main stream Command for streaming through various sources @@ -102,7 +111,7 @@ export function authorization(): void { input: process.stdin, output: process.stdout }); - ask.question('Choose your service - sc (for SoundCloud) / sp (for Spotify) : ', (msg) => { + ask.question('Choose your service - sc (for SoundCloud) / sp (for Spotify) / yo (for YouTube): ', (msg) => { if (msg.toLowerCase().startsWith('sp')) { let client_id: string, client_secret: string, redirect_url: string, market: string; ask.question('Start by entering your Client ID : ', (id) => { @@ -148,9 +157,8 @@ export function authorization(): void { }); }); } else if (msg.toLowerCase().startsWith('sc')) { - let client_id: string; ask.question('Client ID : ', async (id) => { - client_id = id; + let client_id = id; if (!client_id) { console.log("You didn't provide a client ID. Try again..."); ask.close(); @@ -164,9 +172,39 @@ export function authorization(): void { } else console.log("That doesn't look like a valid client ID. Retry with a correct client ID."); ask.close(); }); + } else if (msg.toLowerCase().startsWith('yo')) { + ask.question('Cookies : ', (cook: string) => { + if (!cook || cook.length === 0) { + console.log("You didn't provide a cookie. Try again..."); + ask.close(); + return; + } + if (!fs.existsSync('.data')) fs.mkdirSync('.data'); + console.log('Cookies has been added successfully.'); + let cookie: Object = {}; + cook.split(';').forEach((x) => { + let [ key, value ] = x.split('=') + key = key.trim() + value = value.trim() + Object.assign(cookie, { [key] : value }) + }) + fs.writeFileSync('.data/youtube.data', JSON.stringify({ cookie }, undefined, 4)); + ask.close(); + }); } else { console.log("That option doesn't exist. Try again..."); ask.close(); } }); } + +export function attachListeners(player: EventEmitter, resource: YouTubeStream | SoundCloudStream) { + player.on(AudioPlayerStatus.Paused, () => resource.pause()); + player.on(AudioPlayerStatus.AutoPaused, () => resource.pause()); + player.on(AudioPlayerStatus.Playing, () => resource.resume()); + player.once(AudioPlayerStatus.Idle, () => { + player.removeListener(AudioPlayerStatus.Paused, () => resource.pause()); + player.removeListener(AudioPlayerStatus.AutoPaused, () => resource.pause()); + player.removeListener(AudioPlayerStatus.Playing, () => resource.resume()); + }); +}; \ No newline at end of file