commit 4a60f6142a157a9d4829c8c520a2fc2e156c3808 Author: Carl Kittelberger Date: Sat Jun 11 16:08:13 2016 +0200 Initial commit. Source code not properly documented yet and barely any testing but this is the code as running on the server at the moment. diff --git a/.dockerignore b/.dockerignore new file mode 100644 index 0000000..b3473b4 --- /dev/null +++ b/.dockerignore @@ -0,0 +1,49 @@ +# Binaries +**/*.o +**/*.a +**/*.so +**/*.dll +**/*.exe +**/*.test +**/*.prof +irc-medialink + +# Folders +_obj +_test + +# Architecture specific extensions/prefixes +**/*.[568vq] +**/[568vq].out + +# cgo +**/*.cgo1.go +**/*.cgo2.c +**/_cgo_defun.c +**/_cgo_gotypes.go +**/_cgo_export.* + +# Unit tests +**/*_test.go + +# Configurations +config.yml +secrets.yml + +# Scripts +**/*.bat + +**/_testmain.go + +# Docker +**/Dockerfile + +# Ignores +**/*.*ignore + +# Documentation +LICENSE +**/*.md + +# Source code metadata +.git diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..32e6c5f --- /dev/null +++ b/.gitignore @@ -0,0 +1,31 @@ +# Binaries +*.o +*.a +*.so +*.dll +*.exe +*.test +*.prof +irc-medialink + +# Folders +_obj +_test + +# Architecture specific extensions/prefixes +*.[568vq] +[568vq].out + +# cgo +*.cgo1.go +*.cgo2.c +_cgo_defun.c +_cgo_gotypes.go +_cgo_export.* + +# Configurations +config.yml +secrets.yml + +_testmain.go + diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..ceeb3cf --- /dev/null +++ b/Dockerfile @@ -0,0 +1,13 @@ +FROM golang:1.7 + +RUN mkdir -p /go/src/app +WORKDIR /go/src/app + +COPY . /go/src/app +RUN \ + mkdir -p "$GOPATH/src/github.com/icedream" &&\ + ln -sf /go/src/app "$GOPATH/src/github.com/icedream/irc-medialink" &&\ + go-wrapper download &&\ + go-wrapper install + +CMD ["go-wrapper", "run"] diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..94a9ed0 --- /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/README.md b/README.md new file mode 100644 index 0000000..b94d0e4 --- /dev/null +++ b/README.md @@ -0,0 +1,65 @@ +# MediaLink IRC Bot + +This IRC bot automatically parses links posted in chat rooms and prints information about them. + +Currently explicit support has been built in for: + +- YouTube +- SoundCloud +- Wikipedia +- Direct image links + +Generally, for websites that are not directly supported the bot will print the page title. + +# How to run the bot + +In order to properly run the bot, you need to [register a SoundCloud application](http://soundcloud.com/you/apps/new) and [get a YouTube Data API key](https://console.developers.google.com/apis/api/youtube/overview) for it and then feed the API data to the bot through the command line arguments. + +The bot can be installed through Go using this command: + + go get github.com/icedream/irc-medialink + +Then you can find out which options you can pass to the bot directly by running (assuming you put your `$GOPATH/bin` folder into your `PATH`): + + irc-medialink --help + +You need to at least pass the `--server`, `--youtube-key`, `--soundcloud-id` and `--soundcloud-secret` parameters. + +# ...with Docker + +You can use the `icedream/irc-medialink` image in order to run this bot in Docker. You can pull it using this command: + + docker pull icedream/irc-medialink + +An example with docker-compose would look like this: + +```yaml +version: "2" + +services: + mybot: + image: icedream/irc-medialink + command: + - go-wrapper + - run + - --youtube-key= + - --soundcloud-id= + - --soundcloud-secret= + - --server=: + - --nickserv-pw= + - --nick=MyBot + - --ident=botty + - --password= + - --channels=#channel1,#channel2,... + restart: always +``` + +# Support + +This bot is officially tested and running on the LibraIRC IRC network (irc.librairc.net) though also being able to run on other IRC networks. + +For support on LibraIRC please use the channel #MediaLink there to get in contact with Icedream. + +# License + +This project is licensed under the **GNU General Public License Version 2 or later**. For more information check the [LICENSE](LICENSE) file. diff --git a/main.go b/main.go new file mode 100644 index 0000000..8688c08 --- /dev/null +++ b/main.go @@ -0,0 +1,254 @@ +package main + +import ( + "log" + "strings" + "time" + + "net/url" + + "github.com/mvdan/xurls" + "github.com/thoj/go-ircevent" + "gopkg.in/alecthomas/kingpin.v2" + + "github.com/icedream/irc-medialink/manager" + "github.com/icedream/irc-medialink/parsers/soundcloud" + "github.com/icedream/irc-medialink/parsers/web" + "github.com/icedream/irc-medialink/parsers/wikipedia" + "github.com/icedream/irc-medialink/parsers/youtube" +) + +func must(err error) { + if err == nil { + return + } + + log.Fatal(err) +} + +func main() { + var youtubeApiKey string + + var soundcloudClientId string + var soundcloudClientSecret string + + var debug bool + var useTLS bool + var server string + var password string + var timeout time.Duration + var pingFreq time.Duration + + nickname := "YouTubeBot" + ident := "youtube" + var nickservPw string + channels := []string{} + + // IRC config + kingpin.Flag("nick", "The nickname.").Short('n').StringVar(&nickname) + kingpin.Flag("ident", "The ident.").Short('i').StringVar(&ident) + kingpin.Flag("debug", "Enables debug mode.").Short('d').BoolVar(&debug) + kingpin.Flag("tls", "Use TLS.").BoolVar(&useTLS) + kingpin.Flag("server", "The server to connect to.").Short('s').StringVar(&server) + kingpin.Flag("password", "The password to use for logging into the IRC server.").Short('p').StringVar(&password) + kingpin.Flag("timeout", "The timeout on the connection.").Short('t').DurationVar(&timeout) + kingpin.Flag("pingfreq", "The ping frequency.").DurationVar(&pingFreq) + kingpin.Flag("nickserv-pw", "NickServ password.").StringVar(&nickservPw) + kingpin.Flag("channels", "Channels to join.").Short('c').StringsVar(&channels) + + // Youtube config + kingpin.Flag("youtube-key", "The API key to use to access the YouTube API.").StringVar(&youtubeApiKey) + kingpin.Flag("soundcloud-id", "The SoundCloud ID.").StringVar(&soundcloudClientId) + kingpin.Flag("soundcloud-secret", "The SoundCloud secret.").StringVar(&soundcloudClientSecret) + + kingpin.Parse() + + if len(nickname) == 0 { + log.Fatal("Nickname must be longer than 0 chars.") + } + if len(ident) == 0 { + log.Fatal("Ident must be longer than 0 chars.") + } + + // Manager + m := manager.NewManager() + + // Load youtube parser + youtubeParser := &youtube.Parser{ + Config: &youtube.Config{ApiKey: youtubeApiKey}, + } + must(m.RegisterParser(youtubeParser)) + + // Load soundcloud parser + soundcloudParser := &soundcloud.Parser{ + Config: &soundcloud.Config{ + ClientId: soundcloudClientId, + ClientSecret: soundcloudClientSecret, + }, + } + must(m.RegisterParser(soundcloudParser)) + + // Load wikipedia parser + must(m.RegisterParser(new(wikipedia.Parser))) + + // Load web parser + must(m.RegisterParser(new(web.Parser))) + + // IRC + conn := m.AntifloodIrcConn(irc.IRC(nickname, ident)) + conn.Debug = debug + conn.VerboseCallbackHandler = conn.Debug + conn.UseTLS = useTLS + conn.Password = password + if timeout > time.Duration(0) { + conn.Timeout = timeout + } + if pingFreq > time.Duration(0) { + conn.PingFreq = pingFreq + } + + joinChan := make(chan string) + inviteChan := make(chan string) + + // register callbacks + conn.AddCallback("001", func(e *irc.Event) { // handle RPL_WELCOME + // nickserv login + if len(nickservPw) > 0 { + conn.Privmsg("NickServ", "IDENTIFY "+nickservPw) + log.Print("Sent NickServ login request.") + } + + // I am a bot! (+B user mode) + conn.Mode(conn.GetNick(), "+B-iw") + + // Join configured channels + if len(channels) > 0 { + conn.Join(strings.Join(channels, ",")) + } + }) + conn.AddCallback("JOIN", func(e *irc.Event) { + // Is this JOIN not about us? + if !strings.EqualFold(e.Nick, conn.GetNick()) { + return + } + + // Asynchronous notification + select { + case joinChan <- e.Arguments[0]: + default: + } + }) + conn.AddCallback("INVITE", func(e *irc.Event) { + // Is this INVITE not for us? + if !strings.EqualFold(e.Arguments[0], conn.GetNick()) { + return + } + + // Asynchronous notification + select { + case inviteChan <- e.Arguments[1]: + default: + } + + // We have been invited, autojoin! + go func(sourceNick string, targetChannel string) { + joinWaitLoop: + for { + select { + case channel := <-joinChan: + if strings.EqualFold(channel, targetChannel) { + // TODO - Thanks message + time.Sleep(1 * time.Second) + conn.Privmsgf(targetChannel, "Thanks for inviting me, %s! I am %s, the friendly bot that shows information about links posted in this channel. I hope I can be of great help for everyone here in %s! :)", sourceNick, conn.GetNick(), targetChannel) + time.Sleep(2 * time.Second) + conn.Privmsg(targetChannel, "If you ever run into trouble with me (or find any bugs), please us the channel #MediaLink for contact on this IRC.") + break joinWaitLoop + } + case channel := <-inviteChan: + if strings.EqualFold(channel, targetChannel) { + break joinWaitLoop + } + case <-time.After(time.Minute): + log.Printf("WARNING: Timed out waiting for us to join %s as we got invited", targetChannel) + break joinWaitLoop + } + } + }(e.Nick, e.Arguments[1]) + conn.Join(e.Arguments[1]) + }) + conn.AddCallback("PRIVMSG", func(e *irc.Event) { + go func(event *irc.Event) { + //sender := event.Nick + target := event.Arguments[0] + isChannel := true + if strings.EqualFold(target, conn.GetNick()) { + // Private message to us! + target = event.Nick + isChannel = false + } + if strings.EqualFold(target, conn.GetNick()) { + // Emergency switch to avoid endless loop, + // dropping all messages from the bot to the bot! + log.Printf("BUG - Emergency switch, caught message from bot to bot: %s", event.Arguments) + return + } + msg := stripIrcFormatting(event.Message()) + + log.Printf("<%s @ %s> %s", event.Nick, target, msg) + + urlStr := xurls.Relaxed.FindString(msg) + + switch { + case !isChannel: + // Explain who we are and what we do + conn.Privmsgf(target, "Hi, I parse links people post to chat rooms to give some information about them. I also allow people to search for YouTube videos and SoundCloud sounds straight from IRC. If you have questions or got any bug reports, please direct them to Icedream in #MediaLink, thank you!") + case len(urlStr) > 0: // URL? + // Parse URL! + u, err := url.ParseRequestURI(urlStr) + if err != nil { + u, err = url.ParseRequestURI("http://" + urlStr) + } + if err != nil { + log.Print(err) + break + } + + // Check if this URL has been recently parsed before (antiflood) + shouldIgnore := m.TrackUrl(target, u) + if shouldIgnore { + log.Printf("WARNING: URL antiflood triggered, dropping URL for %s: %s", target, u) + break + } + + _, result := m.Parse(u) + if result.Error != nil { + log.Print(result.Error) + } + if result.UserError != nil { + if s, err := tplString("error", result.UserError); err != nil { + log.Print(err) + } else { + conn.Privmsg(target, s) + } + } + if result.Error == nil && result.UserError == nil && result.Information != nil { + for _, i := range result.Information { + if s, err := tplString("link-info", i); err != nil { + log.Print(err) + } else { + conn.Privmsg(target, s) + } + } + } + } + + }(e) + }) + + // connect + must(conn.Connect(server)) + + // listen for errors + log.Print("Now looping.") + conn.Loop() +} diff --git a/main.tpl b/main.tpl new file mode 100644 index 0000000..b5956e1 --- /dev/null +++ b/main.tpl @@ -0,0 +1,141 @@ +{{ define "verified" }} + {{ bold -}} + {{ bcolor 0 12 -}} + โœ” + {{- reset }} +{{ end }} + +{{ define "error" }} + {{ bold -}} + {{ color 4 -}} + ERROR: + {{- reset }} + + {{ . }} +{{ end }} + +{{ define "link-info" }} + {{ bold -}} + {{- if index . "Header" -}} + {{- index . "Header" -}} + {{- else -}} + Link info + {{- end -}} + {{- bold }} + + ยป + + {{ if index . "IsProfile" }} + {{- if index . "Title" }} + {{ bold -}} + {{- index . "Title" }}: + {{- bold }} + {{- end }} + + {{ if index . "Name" }} + {{ excerpt 184 (index . "Name") }} + {{ if index . "Verified" }} + {{ template "verified" }} + {{ end }} + + {{ if or (index . "CountryCode") (index . "City") }} + from + {{ if and (index . "CountryCode") (index . "City") }} + {{ index . "City" }}, + {{ index . "CountryCode" }} + {{ else }} + {{ with index . "City" }} + {{ . }} + {{ end }} + {{ with index . "CountryCode" }} + {{ . }} + {{ end }} + {{ end }} + {{ end }} + {{ end }} + {{ else }} + {{ if index . "Title" }} + {{ excerpt 184 (index . "Title") }} + {{ with index . "Duration" }} + ({{ . }}) + {{ end }} + {{ else }} + {{ if index . "Description" }} + {{ excerpt 384 (index . "Description") }} + {{ else }} + {{ with index . "ImageType" }} + {{ . }} image, + {{ end }} + {{ if (index . "ImageSize") (index . "Size") }} + {{ with index . "ImageSize" }} + {{ .X }}x{{ .Y }} + {{ end }} + {{ with index . "Size" }} + ({{ size . }}) + {{ end }} + {{ end }} + {{ end }} + {{ end }} + {{ end }} + + {{ if or (index . "Author") }} + {{ if index . "Author" }} + {{ with index . "Author" }} + by {{ excerpt 184 . }} + {{ end }} + {{ if index . "AuthorIsVerified" }} + {{ template "verified" }} + {{ end }} + {{ end }} + {{ end }} + + {{ if index . "Followers" }} + ยท + {{ with index . "Followers" }} + ๐Ÿ‘ฅ{{ compactnum . }} + {{ end }} + {{ end }} + + {{ if or (index . "Likes") (or (index . "Favorites") (index . "Dislikes")) }} + ยท + {{ with index . "Likes" }} + {{ color 3 -}} + ๐Ÿ‘{{ compactnum . }} + {{- reset }} + {{ end }} + {{ with index . "Dislikes" }} + {{ color 4 -}} + ๐Ÿ‘Ž{{ compactnum . }} + {{- reset }} + {{ end }} + {{ with index . "Favorites" }} + {{ color 7 -}} + โค{{ compactnum . }} + {{- reset }} + {{ end }} + {{ with index . "Reposts" }} + {{ color 12 -}} + ๐Ÿ”{{ compactnum . }} + {{- reset }} + {{ end }} + {{ end }} + + {{ if or (index . "Views") (or (index . "Plays") (or (index . "Downloads") (or (index . "Uploads") (index . "Comments")))) }} + ยท + {{ with index . "Views" }} + ๐Ÿ‘{{ compactnum . }} + {{ end }} + {{ with index . "Plays" }} + โ–ถ{{ compactnum . }} + {{ end }} + {{ with index . "Downloads" }} + โฌ‡{{ compactnum . }} + {{ end }} + {{ with index . "Uploads" }} + โฌ†๏ธ{{ compactnum . }} + {{ end }} + {{ with index . "Comments" }} + ๐Ÿ’ฌ{{ compactnum . }} + {{ end }} + {{ end }} +{{ end }} diff --git a/manager/antiflood.go b/manager/antiflood.go new file mode 100644 index 0000000..42d4692 --- /dev/null +++ b/manager/antiflood.go @@ -0,0 +1,117 @@ +package manager + +import ( + "crypto/sha512" + "fmt" + "log" + "net/url" + "strings" + "time" + + "github.com/thoj/go-ircevent" + + cache "github.com/patrickmn/go-cache" +) + +func (m *Manager) initAntiflood() { + m.cache = cache.New(1*time.Minute, 5*time.Second) +} + +func (m *Manager) TrackUrl(target string, u *url.URL) (shouldIgnore bool) { + key := normalizeUrlAntiflood(target, u) + + if _, ok := m.cache.Get(key); ok { + // The URL has been used recently, should ignore + shouldIgnore = true + } else { + m.cache.Add(key, nil, cache.DefaultExpiration) + } + + return +} + +func (m *Manager) TrackOutput(target, t string) (shouldNotSend bool) { + key := normalizeTextAntiflood(target, t) + + if _, ok := m.cache.Get(key); ok { + // The URL has been used recently, should ignore + shouldNotSend = true + } else { + m.cache.Add(key, nil, cache.DefaultExpiration) + } + + return +} + +func (m *Manager) AntifloodIrcConn(c *irc.Connection) *ircConnectionProxy { + return &ircConnectionProxy{Connection: c, m: m} +} + +func normalizeUrlAntiflood(target string, u *url.URL) string { + uc := &(*u) + + // Normalize host + uc.Host = strings.ToLower(uc.Host) + if strings.HasPrefix(uc.Host, "www.") { + uc.Host = uc.Host[4:] + } + + // Normalize query + uc.RawQuery = uc.Query().Encode() + + s := sha512.New() + s.Write([]byte(u.String())) + return fmt.Sprintf("LINK/%s/%X", strings.ToUpper(target), s.Sum([]byte{})) +} + +func normalizeTextAntiflood(target, text string) string { + s := sha512.New() + s.Write([]byte(text)) + return fmt.Sprintf("TEXT/%s/%X", strings.ToUpper(target), s.Sum([]byte{})) +} + +// Proxies several methods of the IRC connection in order to drop repeated messages +type ircConnectionProxy struct { + *irc.Connection + + m *Manager +} + +func (proxy *ircConnectionProxy) Action(target, message string) { + if proxy.m.TrackOutput(target, message) { + log.Printf("WARNING: Output antiflood triggered, dropping message for %s: %s", target, message) + return + } + + proxy.Connection.Action(target, message) +} + +func (proxy *ircConnectionProxy) Actionf(target, format string, a ...interface{}) { + proxy.Action(target, fmt.Sprintf(format, a...)) +} + +func (proxy *ircConnectionProxy) Privmsg(target, message string) { + if proxy.m.TrackOutput(target, message) { + log.Printf("WARNING: Output antiflood triggered, dropping message for %s: %s", target, message) + return + } + + proxy.Connection.Privmsg(target, message) +} + +func (proxy *ircConnectionProxy) Privmsgf(target, format string, a ...interface{}) { + proxy.Privmsg(target, fmt.Sprintf(format, a...)) +} + +func (proxy *ircConnectionProxy) Notice(target, message string) { + if proxy.m.TrackOutput(target, message) { + log.Printf("WARNING: Output antiflood triggered, dropping message for %s: %s", target, message) + return + } + + proxy.Connection.Notice(target, message) +} + +func (proxy *ircConnectionProxy) Noticef(target, format string, a ...interface{}) { + proxy.Notice(target, fmt.Sprintf(format, a...)) +} diff --git a/manager/manager.go b/manager/manager.go new file mode 100644 index 0000000..be8d49a --- /dev/null +++ b/manager/manager.go @@ -0,0 +1,22 @@ +package manager + +import ( + "sync" + + "github.com/patrickmn/go-cache" +) + +type Manager struct { + // antiflood variables + cache *cache.Cache + + // parser variables + stateLock sync.RWMutex + registeredParsers []Parser +} + +func NewManager() *Manager { + m := new(Manager) + m.initAntiflood() + return m +} diff --git a/manager/parser.go b/manager/parser.go new file mode 100644 index 0000000..05eb591 --- /dev/null +++ b/manager/parser.go @@ -0,0 +1,88 @@ +package manager + +import ( + "errors" + "log" + "net/url" + "reflect" + + "github.com/icedream/irc-medialink/parsers" +) + +var ( + ErrAlreadyLoaded = errors.New("Already loaded.") +) + +type Parser interface { + Init() error + Name() string + Parse(u *url.URL, referer *url.URL) parsers.ParseResult +} + +func (m *Manager) GetParsers() []Parser { + m.stateLock.RLock() + defer m.stateLock.RUnlock() + + result := make([]Parser, len(m.registeredParsers)) + copy(result, m.registeredParsers) + return result +} + +func (m *Manager) RegisterParser(parser Parser) error { + m.stateLock.Lock() + defer m.stateLock.Unlock() + + // Make sure that parser hasn't already been loaded in some way or another + t := reflect.TypeOf(parser) + for _, p := range m.registeredParsers { + if reflect.TypeOf(p) == t { + return ErrAlreadyLoaded + } + } + + // Initialize parser + log.Printf("Initializing %s parser...", parser.Name()) + if err := parser.Init(); err != nil { + return err + } + + m.registeredParsers = append(m.registeredParsers, parser) + log.Printf("Registered %s parser!", parser.Name()) + + return nil +} + +func (m *Manager) Parse(u *url.URL) (string, parsers.ParseResult) { + var oldU *url.URL + attempt := 0 +followLoop: + for u != nil { + log.Printf("Parsing %s (referer %s)...", u, oldU) + attempt++ + if attempt > 15 { + log.Printf("WARNING: Potential infinite loop for url %s, abort parsing", u) + break + } + for _, p := range m.GetParsers() { + r := p.Parse(u, oldU) + if r.Ignored { + continue + } + if r.FollowUrl != nil { + if *u == *r.FollowUrl { + log.Printf("WARNING: Ignoring request to follow to same URL, ignoring.") + break followLoop + } + oldU, u = u, r.FollowUrl + continue followLoop + } + return p.Name(), r + } + u = nil + } + + // No parser matches, link ignored + return "", parsers.ParseResult{ + Ignored: true, + } +} diff --git a/parsers/parseresult.go b/parsers/parseresult.go new file mode 100644 index 0000000..202a454 --- /dev/null +++ b/parsers/parseresult.go @@ -0,0 +1,11 @@ +package parsers + +import "net/url" + +type ParseResult struct { + Ignored bool + Error error + UserError error + Information []map[string]interface{} + FollowUrl *url.URL +} diff --git a/parsers/soundcloud/config.go b/parsers/soundcloud/config.go new file mode 100644 index 0000000..d4d0bb4 --- /dev/null +++ b/parsers/soundcloud/config.go @@ -0,0 +1,6 @@ +package soundcloud + +type Config struct { + ClientId string + ClientSecret string +} diff --git a/parsers/soundcloud/parser.go b/parsers/soundcloud/parser.go new file mode 100644 index 0000000..9f0b672 --- /dev/null +++ b/parsers/soundcloud/parser.go @@ -0,0 +1,136 @@ +package soundcloud + +import ( + "fmt" + "log" + "net/http" + "net/url" + "strings" + "time" + + "github.com/icedream/irc-medialink/parsers" + "github.com/yanatan16/golang-soundcloud/soundcloud" +) + +const ( + header = "\x0307SoundCloud\x03" +) + +var ( + emptyUrlValues = url.Values{} +) + +type Parser struct { + api *soundcloud.Api + http *http.Client + Config *Config +} + +func (p *Parser) Init() error { + p.api = &soundcloud.Api{ + ClientId: p.Config.ClientId, + ClientSecret: p.Config.ClientSecret, + } + p.http = &http.Client{} + + return nil +} + +func (p *Parser) Name() string { + return "SoundCloud" +} + +func (p *Parser) Parse(u *url.URL, referer *url.URL) (result parsers.ParseResult) { + if !strings.EqualFold(u.Host, "soundcloud.com") && + !strings.EqualFold(u.Host, "www.soundcloud.com") { + result.Ignored = true + return + } + + if r, err := p.v2resolve(u.String()); err != nil { + result.UserError = err + return + } else { + log.Printf("SoundCloud parser: Got link of kind %s.", r.Kind) + switch r.Kind { + case v2KindUser: + user := r.AsUser() + + info := map[string]interface{}{ + "Header": header, + "IsProfile": true, + "Name": user.Username, + "City": user.City, + "CountryCode": user.CountryCode, // TODO - Convert user.CountryCode to a human-readable country + "Url": user.PermalinkURL, + "Followers": user.FollowersCount, + "Uploads": user.TrackCount, + "Playlists": user.PlaylistCount, + "IsVerified": user.Verified, + // TODO - Mark premium account + } + + if len(user.FullName) > 0 { + info["Name"] = info["Name"].(string) + " (" + user.FullName + ")" + } + + result.Information = []map[string]interface{}{info} + case v2KindGroup: + group := r.AsGroup() + + info := map[string]interface{}{ + "Header": header, + "IsGroup": true, + "Title": fmt.Sprintf("Group: %s", group.Name), + "Author": group.Creator.Username, + "Url": group.PermalinkURL, + "PublishedAt": group.CreatedAt.ToTime(""), + } + + result.Information = []map[string]interface{}{info} + case v2KindTrack: + track := r.AsTrack() + log.Println("Track: %+v", track) + + info := map[string]interface{}{ + "Header": header, + "IsUpload": true, + "Title": track.Title, + "Author": track.User.Username, + "Url": track.PermalinkURL, + "Favorites": track.LikesCount, + "Reposts": track.RepostsCount, + "Plays": track.PlaybackCount, + "Comments": track.CommentCount, + "PublishedAt": track.CreatedAt.ToTime(""), + "Downloads": track.DownloadCount, + // Doing /1000 here to get rid of the fraction + "Duration": (time.Duration(track.Duration) / 1000) * time.Second, + } + + result.Information = []map[string]interface{}{info} + case v2KindPlaylist: + pl := r.AsPlaylist() + + info := map[string]interface{}{ + "Header": header, + "IsPlaylist": true, + "Title": "Playlist: " + pl.Title, + "Author": pl.User.Username, + "Url": pl.PermalinkURL, + "PublishedAt": pl.CreatedAt.ToTime(""), + "Tracks": pl.TrackCount, + "Favorites": pl.LikesCount, + "Reposts": pl.RepostsCount, + // Doing /1000 here to get rid of the fraction + "Duration": (time.Duration(pl.Duration) / 1000) * time.Second, + } + + result.Information = []map[string]interface{}{info} + default: + result.Ignored = true + } + } + + return +} diff --git a/parsers/soundcloud/v2.go b/parsers/soundcloud/v2.go new file mode 100644 index 0000000..d8c677c --- /dev/null +++ b/parsers/soundcloud/v2.go @@ -0,0 +1,148 @@ +package soundcloud + +import () + +type v2Group struct { + v2Object + ArtworkURL string `json:"artwork_url"` + CreatedAt timeString `json:"created_at"` + Creator v2User `json:"creator"` + Description string `json:"description"` + MembersCount uint64 `json:"members_count"` + Moderated bool `json:"moderated"` + Name string `json:"name"` + Permalink string `json:"permalink"` + PermalinkURL string `json:"permalink_url"` + ShortDescription string `json:"short_description"` + TrackCount uint64 `json:"track_count"` + URI string `json:"uri"` +} + +type v2Object struct { + ID uint64 `json:"id"` + Kind v2Kind `json:"kind"` +} + +type v2Playlist struct { + v2Object + ArtworkURL string `json:"artwork_url"` + CreatedAt timeString `json:"created_at"` + Description string `json:"description"` + Duration uint64 `json:"duration"` + EmbeddableBy string `json:"embeddable_by"` + Genre string `json:"genre"` + IsAlbum bool `json:"is_album"` + LabelName string `json:"label_name"` + LastModified timeString `json:"last_modified"` + License string `json:"license"` + LikesCount uint64 `json:"likes_count"` + ManagedByFeeds bool `json:"managed_by_feeds"` + Permalink string `json:"permalink"` + PermalinkURL string `json:"permalink_url"` + Public bool `json:"public"` + PublishedAt timeString `json:"published_at"` + PurchaseTitle string `json:"purchase_title"` + PurchaseURL string `json:"purchase_url"` + ReleaseDate timeString `json:"release_date"` + RepostsCount uint64 `json:"reposts_count"` + SecretToken string `json:"secret_token"` + SetType string `json:"set_type"` + Sharing string `json:"sharing"` + TagList string `json:"tag_list"` + Title string `json:"title"` + TrackCount uint64 `json:"track_count"` + URI string `json:"uri"` + User v2User `json:"user"` + UserID uint64 `json:"user_id"` +} + +type v2Product struct { + ID string `json:"id"` + Name string `json:"name"` +} + +type v2Subscription struct { + Product v2Product `json:"product"` + Recurring bool `json:"recurring"` +} + +type v2Track struct { + v2Object + ArtworkURL string `json:"artwork_url"` + CommentCount uint64 `json:"comment_count"` + Commentable bool `json:"commentable"` + CreatedAt timeString `json:"created_at"` + Description string `json:"description"` + DownloadCount uint64 `json:"download_count"` + DownloadURL string `json:"download_url"` + Downloadable bool `json:"downloadable"` + Duration uint64 `json:"duration"` + EmbeddableBy string `json:"embeddable_by"` + FullDuration uint64 `json:"full_duration"` + Genre string `json:"genre"` + HasDownloadsLeft bool `json:"has_downloads_left"` + LabelName string `json:"label_name"` + LastModified timeString `json:"last_modified"` + License string `json:"license"` + LikesCount uint64 `json:"likes_count"` + MonetizationModel string `json:"monetization_model"` + Permalink string `json:"permalink"` + PermalinkURL string `json:"permalink_url"` + PlaybackCount uint64 `json:"playback_count"` + Policy string `json:"policy"` + Public bool `json:"public"` + PurchaseTitle string `json:"purchase_title"` + PurchaseURL string `json:"purchase_url"` + ReleaseDate timeString `json:"release_date"` + RepostsCount uint64 `json:"reposts_count"` + SecretToken string `json:"secret_token"` + Sharing string `json:"sharing"` + State string `json:"state"` + Streamable bool `json:"streamable"` + TagList string `json:"tag_list"` + Title string `json:"title"` + URI string `json:"uri"` + URN string `json:"urn"` + User v2User `json:"user"` + UserID uint64 `json:"user_id"` + Visuals v2Visuals `json:"visuals"` + WaveformURL string `json:"waveform_url"` +} + +type v2User struct { + v2Object + AvatarURL string `json:"avatar_url"` + City string `json:"city"` + CommentsCount uint64 `json:"comments_count"` + CountryCode string `json:"country_code"` + Description string `json:"description"` + FirstName string `json:"first_name"` + FollowersCount uint64 `json:"followers_count"` + FollowingsCount uint64 `json:"followings_count"` + FullName string `json:"full_name"` + GroupsCount uint64 `json:"groups_count"` + LastModified timeString `json:"last_modified"` + LastName string `json:"last_name"` + LikesCount uint64 `json:"likes_count"` + Permalink string `json:"permalink"` + PermalinkURL string `json:"permalink_url"` + PlaylistCount uint64 `json:"playlist_count"` + RepostsCount uint64 `json:"reposts_count"` + TrackCount uint64 `json:"track_count"` + URI string `json:"uri"` + URN string `json:"urn"` + Username string `json:"username"` + Verified bool `json:"verified"` + Visuals v2Visuals `json:"visuals"` +} + +type v2VisualItem struct { + EntryTime uint64 `json:"entry_time"` + URN string `json:"urn"` + VisualURL string `json:"visual_url"` +} + +type v2Visuals struct { + Enabled bool `json:"enabled"` + URN string `json:"urn"` +} diff --git a/parsers/soundcloud/v2.yml b/parsers/soundcloud/v2.yml new file mode 100644 index 0000000..9818c22 --- /dev/null +++ b/parsers/soundcloud/v2.yml @@ -0,0 +1,160 @@ +# FIXME - See https://github.com/golang/go/issues/9037 - Revert to using time.Time in the API as soon as this is fixed! +#imports: +# - time +kinds: + v2Object: + fields: + id: uint64 + kind: v2Kind + v2Product: + fields: + id: string + name: string + v2Subscription: + fields: + product: v2Product + recurring: bool + v2VisualItem: + fields: + urn: string + entry_time: uint64 + visual_url: string + v2Visuals: + fields: + urn: string + enabled: bool + # TODO: Support map in generator + #visuals: map[string]v2VisualItem + v2User: + extends: + - v2Object + fields: + avatar_url: string + city: string + comments_count: uint64 + country_code: string + # TODO: Support slice in generator + #creator_subscriptions: []v2Subscription + description: string + followers_count: uint64 + followings_count: uint64 + first_name: string + full_name: string + groups_count: uint64 + #last_modified: time.Time + last_modified: timeString + last_name: string + likes_count: uint64 + permalink: string + permalink_url: string + playlist_count: uint64 + reposts_count: uint64 + track_count: uint64 + uri: string + urn: string + username: string + verified: bool + visuals: v2Visuals + v2Track: + extends: + - v2Object + fields: + artwork_url: string + commentable: bool + comment_count: uint64 + #created_at: time.Time + created_at: timeString + description: string + downloadable: bool + download_count: uint64 + download_url: string + duration: uint64 + full_duration: uint64 + embeddable_by: string + genre: string + has_downloads_left: bool + label_name: string + #last_modified: time.Time + last_modified: timeString + license: string + likes_count: uint64 + permalink: string + permalink_url: string + playback_count: uint64 + public: bool + #publisher_metadata: map[string]interface{} + purchase_title: string + purchase_url: string + #release_date: time.Time + release_date: timeString + reposts_count: uint64 + secret_token: string + sharing: string + state: string + streamable: bool + tag_list: string + title: string + uri: string + urn: string + user_id: uint64 + visuals: v2Visuals + waveform_url: string + monetization_model: string + policy: string + user: v2User + v2Group: + extends: + - v2Object + fields: + artwork_url: string + #created_at: time.Time + created_at: timeString + description: string + members_count: uint64 + moderated: bool + name: string + permalink: string + permalink_url: string + short_description: string + track_count: uint64 + uri: string + creator: v2User + v2Playlist: + extends: + - v2Object + fields: + artwork_url: string + #created_at: time.Time + created_at: timeString + description: string + duration: uint64 + embeddable_by: string + genre: string + label_name: string + #last_modified: time.Time + last_modified: timeString + license: string + likes_count: uint64 + permalink: string + permalink_url: string + public: bool + purchase_title: string + purchase_url: string + #release_date: time.Time + release_date: timeString + reposts_count: uint64 + secret_token: string + sharing: string + tag_list: string + title: string + uri: string + user_id: uint64 + set_type: string + is_album: bool + #published_at: time.Time + published_at: timeString + managed_by_feeds: bool + user: v2User + # TODO: Support slice in generator + #tracks: []v2Track + track_count: uint64 diff --git a/parsers/soundcloud/v2_methods.go b/parsers/soundcloud/v2_methods.go new file mode 100644 index 0000000..c19e638 --- /dev/null +++ b/parsers/soundcloud/v2_methods.go @@ -0,0 +1,165 @@ +package soundcloud + +//go:generate go run ../../util/apigen/main.go --pkg soundcloud v2.yml + +import ( + "bytes" + "encoding/json" + "errors" + "io" + "log" + "net/http" + "net/url" + "time" +) + +type v2Kind string + +const ( + // FIXME - not yet supported + //v2KindApp v2Kind = "app" + v2KindGroup v2Kind = "group" + v2KindPlaylist v2Kind = "playlist" + v2KindTrack v2Kind = "track" + v2KindUser v2Kind = "user" +) + +var ( + ErrUnsupportedKind = errors.New("Unsupported kind") +) + +func (p *Parser) v2url(path string, urlvalues url.Values) *url.URL { + u := &url.URL{ + Scheme: "https", + Host: "api-v2.soundcloud.com", + RawQuery: urlvalues.Encode(), + Path: path, + } + q := u.Query() + q.Set("client_id", p.Config.ClientId) + q.Set("app_version", "0.0") // TODO - Versioning + u.RawQuery = q.Encode() + log.Printf("SoundCloud parser: v2url: %s", u.String()) + return u +} + +func (p *Parser) v2call(path string, urlvalues url.Values) (v2Result, error) { + resp, err := p.http.Do(&http.Request{ + URL: p.v2url(path, urlvalues), + Method: "GET", + Header: http.Header{ + "Accept": []string{"application/json"}, + "User-Agent": []string{"Icedream-YouTubeIRC/0.0"}, // TODO - Versioning + }, + }) + if err != nil { + return nil, err + } + defer resp.Body.Close() + if resp.StatusCode != 200 { + return nil, errors.New(resp.Status) + } + b := new(bytes.Buffer) + io.Copy(b, resp.Body) + log.Printf("v2call: Response is %s", b.String()) + return b.Bytes(), nil +} + +func (p *Parser) v2resolve(u string) (*v2ResolveResult, error) { + r, err := p.v2call("/resolve", url.Values{ + "url": []string{u}, + }) + if err != nil { + return nil, err + } + + // First find out the kind via the most generic type possible + obj := new(v2Object) + if err := r.Decoder().Decode(obj); err != nil { + return nil, err + } + + // Now decode as correct type + switch obj.Kind { + case v2KindTrack: + exactObj := new(v2Track) + if err := r.Decoder().Decode(exactObj); err != nil { + return nil, err + } + return &v2ResolveResult{exactObj, obj.Kind}, nil + case v2KindUser: + exactObj := new(v2User) + if err := r.Decoder().Decode(exactObj); err != nil { + return nil, err + } + return &v2ResolveResult{exactObj, obj.Kind}, nil + case v2KindGroup: + exactObj := new(v2Group) + if err := r.Decoder().Decode(exactObj); err != nil { + return nil, err + } + return &v2ResolveResult{exactObj, obj.Kind}, nil + case v2KindPlaylist: + exactObj := new(v2Playlist) + if err := r.Decoder().Decode(exactObj); err != nil { + return nil, err + } + return &v2ResolveResult{exactObj, obj.Kind}, nil + default: + return nil, ErrUnsupportedKind + } +} + +type v2Result []byte + +func (r v2Result) Decoder() *json.Decoder { + return json.NewDecoder(bytes.NewReader([]byte(r))) +} + +type v2ResolveResult struct { + result interface{} + Kind v2Kind +} + +func (r *v2ResolveResult) AsUser() *v2User { + return r.result.(*v2User) +} + +// FIXME - not supported yet +/*func (r *v2ResolveResult) AsApp() *v2App { + return r.result.(*v2App) +}*/ + +func (r *v2ResolveResult) AsTrack() *v2Track { + return r.result.(*v2Track) +} + +func (r *v2ResolveResult) AsPlaylist() *v2Playlist { + return r.result.(*v2Playlist) +} + +func (r *v2ResolveResult) AsGroup() *v2Group { + return r.result.(*v2Group) +} + +// FIXME - See https://github.com/golang/go/issues/9037 - Revert to using time.Time in the API as soon as this is fixed! + +type timeString string + +func (t timeString) ToTime(layout string) (parsedTime time.Time) { + if t == "" { + return // default time value + } + + if len(layout) == 0 { + layout = time.RFC3339 + } + + parsedTime, err := time.Parse(layout, string(t)) + if err != nil { + // It's just a temporary fix anyways + panic(err) + } + + return +} diff --git a/parsers/web/parser.go b/parsers/web/parser.go new file mode 100644 index 0000000..5242323 --- /dev/null +++ b/parsers/web/parser.go @@ -0,0 +1,124 @@ +package web + +import ( + "errors" + "log" + "net/http" + "net/url" + "strings" + + "golang.org/x/net/html" + "golang.org/x/net/html/atom" + + "image" + _ "image/gif" + _ "image/jpeg" + _ "image/png" + + "github.com/icedream/irc-medialink/parsers" + "github.com/yhat/scrape" +) + +var ( + ErrCorruptedImage = errors.New("Corrupted image.") +) + +type Parser struct{} + +func (p *Parser) Init() error { + return nil +} + +func (p *Parser) Name() string { + return "Web" +} + +func (p *Parser) Parse(u *url.URL, referer *url.URL) (result parsers.ParseResult) { + // Ignore non-HTTP link + if !strings.EqualFold(u.Scheme, "http") && !strings.EqualFold(u.Scheme, "https") { + result.Ignored = true + return + } + + // Make request + req, err := http.NewRequest("GET", u.String(), nil) + if err != nil { + result.Error = err + return + } + if referer != nil { + req.Header.Set("Referer", referer.String()) + } + if resp, err := http.DefaultTransport.RoundTrip(req); err != nil { + log.Print("HTTP Get failed") + result.Error = err + return + } else { + log.Printf("Web parser result: %+v", resp) + defer resp.Body.Close() + if 300 <= resp.StatusCode && resp.StatusCode < 400 { + if u2, err := resp.Location(); err == nil && u2 != nil && *u2 != *u { + result.FollowUrl = u2 + return + } + } + if resp.StatusCode >= 400 { + result.UserError = errors.New(resp.Status) + return + } + if resp.StatusCode != 200 { + result.Ignored = true + return + } + contentType := resp.Header.Get("content-type") + sep := strings.IndexRune(contentType, ';') + if sep < 0 { + sep = len(contentType) + } + log.Print(contentType[0:sep]) + switch strings.ToLower(contentType[0:sep]) { + case "text/html": + // Parse the page + root, err := html.Parse(resp.Body) + if err != nil { + result.Error = err + return + } + // Search for the title + title, ok := scrape.Find(root, scrape.ByTag(atom.Title)) + if ok { + // Got it! + result.Information = []map[string]interface{}{ + map[string]interface{}{ + "IsUpload": false, + "Title": scrape.Text(title), + }, + } + } else { + result.Ignored = true + } + case "image/png", "image/jpeg", "image/gif": + log.Print("Parsing image...") + if m, imgType, err := image.DecodeConfig(resp.Body); err != nil { + result.UserError = ErrCorruptedImage + } else { + info := map[string]interface{}{ + "IsUpload": true, + "ImageSize": image.Point{X: m.Width, Y: m.Height}, + "ImageType": strings.ToUpper(imgType), + } + if resp.ContentLength > 0 { + info["Size"] = uint64(resp.ContentLength) + } + result.Information = []map[string]interface{}{info} + log.Printf("Got through: %+v!", info) + } + default: + // TODO - Implement generic head info? + log.Printf("web parser: Ignoring content of type %s", resp.Header.Get("content-type")) + result.Ignored = true + } + } + + return +} diff --git a/parsers/wikipedia/parser.go b/parsers/wikipedia/parser.go new file mode 100644 index 0000000..40b751f --- /dev/null +++ b/parsers/wikipedia/parser.go @@ -0,0 +1,66 @@ +package wikipedia + +//go:generate go run ../../util/apigen/main.go --pkg wikipedia v1.yml + +import ( + "encoding/json" + "errors" + "net/http" + "net/url" + "strings" + + "github.com/icedream/irc-medialink/parsers" +) + +type Parser struct{} + +func (p *Parser) Name() string { + return "Wikipedia" +} + +func (p *Parser) Init() error { + return nil +} + +func (p *Parser) Parse(u *url.URL, referer *url.URL) (result parsers.ParseResult) { + if !strings.HasSuffix(strings.ToLower(u.Host), ".wikipedia.org") { + result.Ignored = true + return + } + + switch { + case strings.HasPrefix(u.Path, "/wiki/"): + // Wiki entry link + titleEscaped := u.Path[6:] + if len(titleEscaped) <= 0 { + break + } + + // We're using the original host for link localization + r, err := http.Get("https://" + u.Host + "/api/rest_v1/page/summary/" + titleEscaped) + if err != nil { + result.Error = err + return + } + defer r.Body.Close() + if r.StatusCode != 200 { + result.UserError = errors.New(r.Status) + return + } + data := v1Summary{} + if err := json.NewDecoder(r.Body).Decode(&data); err != nil { + result.Error = err + return + } + + result.Information = []map[string]interface{}{ + map[string]interface{}{ + "Header": "\x031,0Wikipedia\x03", + "Description": prepareSummary(data.Title, data.Extract), + }, + } + } + + result.Ignored = result.Information == nil + return +} diff --git a/parsers/wikipedia/util.go b/parsers/wikipedia/util.go new file mode 100644 index 0000000..7dd744f --- /dev/null +++ b/parsers/wikipedia/util.go @@ -0,0 +1,35 @@ +package wikipedia + +import ( + "strings" + + "gopkg.in/neurosnap/sentences.v1/english" +) + +func prepareSummary(title string, summary string) string { + // Sentence tokenizer - English will work fine in most cases for now + tokenizer, err := english.NewSentenceTokenizer(nil) + if err != nil { + panic(err) + } + + // Get enough sentences to at least fill 64 characters. + sentences := tokenizer.Tokenize(summary) + text := "" + for i := 0; len(text) < 64 && i < len(sentences); i++ { + if len(text) > 0 { + text += " " + } + text += sentences[i].Text + } + + // Highlight the main word in the summary + if s := strings.Index(strings.ToUpper(text), strings.ToUpper(title)); s < 0 { + summary = "\x02" + title + "\x02: " + text + } else { + summary = text[0:s] + "\x02" + text[s:s+len(title)] + "\x02" + text[s+len(title):] + } + + // Append ellipsis + return summary + " \u2026" +} diff --git a/parsers/wikipedia/v1.go b/parsers/wikipedia/v1.go new file mode 100644 index 0000000..8423d13 --- /dev/null +++ b/parsers/wikipedia/v1.go @@ -0,0 +1,15 @@ +package wikipedia + +type v1Summary struct { + Dir string `json:"dir"` + Extract string `json:"extract"` + Lang string `json:"lang"` + Thumbnail v1Thumbnail `json:"thumbnail"` + Title string `json:"title"` +} + +type v1Thumbnail struct { + Height uint64 `json:"height"` + Source string `json:"source"` + Width uint64 `json:"width"` +} diff --git a/parsers/wikipedia/v1.yml b/parsers/wikipedia/v1.yml new file mode 100644 index 0000000..9cf0faf --- /dev/null +++ b/parsers/wikipedia/v1.yml @@ -0,0 +1,13 @@ +kinds: + v1Thumbnail: + fields: + source: string + width: uint64 + height: uint64 + v1Summary: + fields: + title: string + extract: string + thumbnail: v1Thumbnail + lang: string + dir: string diff --git a/parsers/youtube/config.go b/parsers/youtube/config.go new file mode 100644 index 0000000..9c78480 --- /dev/null +++ b/parsers/youtube/config.go @@ -0,0 +1,5 @@ +package youtube + +type Config struct { + ApiKey string +} diff --git a/parsers/youtube/parser.go b/parsers/youtube/parser.go new file mode 100644 index 0000000..4de0daf --- /dev/null +++ b/parsers/youtube/parser.go @@ -0,0 +1,265 @@ +package youtube + +import ( + "errors" + "fmt" + "log" + "net/http" + "net/url" + "strings" + "time" + + iso8601duration "github.com/ChannelMeter/iso8601duration" + "github.com/icedream/irc-medialink/parsers" + "google.golang.org/api/googleapi/transport" + "google.golang.org/api/youtube/v3" +) + +const ( + youtubeIdType_None youtubeIdType = iota + youtubeIdType_Video + youtubeIdType_ChannelName + youtubeIdType_ChannelId + youtubeIdType_Playlist + + header = "\x031,0You\x030,4Tube\x03" + + "99,99" + /* Fix for KiwiIRC not flushing background color on empty color tag */ + "\x03" /* Fix for Mibbit interpreting 99 as green instead of transparent */ +) + +var ( + ErrNotFound = errors.New("Not found.") +) + +type youtubeIdType uint8 + +type Parser struct { + Config *Config + Service *youtube.Service +} + +func getYouTubeId(uri *url.URL, followRedirects int) (youtubeIdType, string) { + u := &(*uri) + u.Scheme = strings.ToLower(u.Scheme) + u.Host = strings.ToLower(u.Host) + + // Must be an HTTP URL + if u.Scheme != "http" && u.Scheme != "https" { + return youtubeIdType_None, "" + } + + // Remove www. prefix from hostname + if strings.HasPrefix(u.Host, "www.") { + u.Host = u.Host[4:] + } + + switch strings.ToLower(u.Host) { + case "youtu.be": + // http://youtu.be/{id} + if s, err := url.QueryUnescape(strings.TrimLeft(u.Path, "/")); err == nil { + return youtubeIdType_Video, s + } + case "youtube.com": + if u.Path == "/watch" { + // http://youtube.com/watch?v={id} + return youtubeIdType_Video, u.Query().Get("v") + } else if strings.HasPrefix(u.Path, "/channel/") { + // https://www.youtube.com/channel/{channelid} + return youtubeIdType_ChannelId, strings.Trim(u.Path[9:], "/") + } else if strings.HasPrefix(u.Path, "/c/") { + // http://youtube.com/c/{channelname} + return youtubeIdType_ChannelName, strings.Trim(u.Path[3:], "/") + } else if strings.HasPrefix(u.Path, "/user/") { + // http://youtube.com/user/{channelname} + return youtubeIdType_ChannelName, strings.Trim(u.Path[6:], "/") + } else if strings.HasPrefix(u.Path, "/playlist") { + // https://www.youtube.com/playlist?list=PLq34c5GJGiJJlrG9-ByMbuQkTvaFtIflO + return youtubeIdType_Playlist, u.Query().Get("list") + } else if followRedirects > 0 && len(u.Path) > 1 && !strings.Contains(u.Path[1:], "/") { + // Maybe https://youtube.com/{channelname}. + // Does this actually redirect to a channel? + req, err := http.NewRequest("HEAD", u.String(), nil) + if err != nil { + log.Printf("Failed to create HEAD request from %s: %s", u, err) + return youtubeIdType_None, "" + } + resp, err := http.DefaultTransport.RoundTrip(req) + if err != nil { + log.Printf("Failed to check for channel from %s: %s", u, err) + return youtubeIdType_None, "" + } + if resp.StatusCode >= 300 && resp.StatusCode < 400 { + if lu, err := resp.Location(); err == nil && lu != nil { + return getYouTubeId(lu, followRedirects-1) + } + } + } + } + + return youtubeIdType_None, "" +} + +func (p *Parser) Init() error { + // youtube api + client := &http.Client{ + Transport: &transport.APIKey{Key: p.Config.ApiKey}, + } + if srv, err := youtube.New(client); err != nil { + return err + } else { + p.Service = srv + } + return nil +} + +func (p *Parser) Name() string { + return "YouTube" +} + +func (p *Parser) Parse(u *url.URL, referer *url.URL) (result parsers.ParseResult) { + // Parse YouTube URL + idType, id := getYouTubeId(u, 2) + if idType == youtubeIdType_None { + result.Ignored = true + return // nothing relevant found in this URL + } + + switch idType { + case youtubeIdType_Video: + // Get YouTube video info + list, err := p.Service.Videos.List("contentDetails,id,liveStreamingDetails,snippet,statistics").Id(id).Do() + if err != nil { + result.Error = err + return + } + + // Any info available? + if len(list.Items) < 1 { + result.UserError = ErrNotFound + return + } + + // Collect information + result.Information = []map[string]interface{}{} + for _, item := range list.Items { + r := map[string]interface{}{ + "ShortUrl": fmt.Sprintf("https://youtu.be/%v", url.QueryEscape(item.Id)), + "IsUpload": true, + "IsLive": item.LiveStreamingDetails != nil, + } + if item.Snippet != nil { + r["Title"] = item.Snippet.Title + r["Author"] = item.Snippet.ChannelTitle + r["Description"] = item.Snippet.Description + r["Category"] = item.Snippet.CategoryId + r["Tags"] = item.Snippet.Tags + + // parse publishedAt + if t, err := time.Parse(time.RFC3339, item.Snippet.PublishedAt); err == nil { + r["PublishedAt"] = t + } else { + log.Print(err) + } + } + if item.ContentDetails != nil { + // parse duration + if d, err := iso8601duration.FromString(item.ContentDetails.Duration); err == nil { + r["Duration"] = d.ToDuration() + } else { + log.Print(err) + } + } + if item.Statistics != nil { + r["Views"] = item.Statistics.ViewCount + r["Comments"] = item.Statistics.CommentCount + r["Likes"] = item.Statistics.LikeCount + r["Dislikes"] = item.Statistics.DislikeCount + r["Favorites"] = item.Statistics.FavoriteCount + } + /*if item.LiveStreamingDetails != nil { + r["Views"] = item.LiveStreamingDetails.ConcurrentViewers + }*/ + r["Header"] = header + result.Information = append(result.Information, r) + } + case youtubeIdType_ChannelId, youtubeIdType_ChannelName: + // Get YouTube channel info + cl := p.Service.Channels.List("id,snippet,statistics") + if idType == youtubeIdType_ChannelName { + cl = cl.ForUsername(id) + } else { + cl = cl.Id(id) + } + list, err := cl.Do() + if err != nil { + result.Error = err + return + } + + // Any info available? + if len(list.Items) < 1 { + result.UserError = ErrNotFound + return + } + + // Collect information + result.Information = []map[string]interface{}{} + for _, item := range list.Items { + r := map[string]interface{}{ + "Header": header, + "IsProfile": true, + "Title": "Channel", + "Author": item.Snippet.Title, + "CountryCode": item.Snippet.Country, + "Description": item.Snippet.Description, + "ShortUrl": item.Snippet.CustomUrl, + "Comments": item.Statistics.CommentCount, + "Videos": item.Statistics.VideoCount, + "Views": item.Statistics.ViewCount, + } + if !item.Statistics.HiddenSubscriberCount { + r["Followers"] = item.Statistics.SubscriberCount + } + result.Information = append(result.Information, r) + } + case youtubeIdType_Playlist: + // Get YouTube channel info + list, err := p.Service.Playlists.List("id,snippet").Id(id).Do() + if err != nil { + result.Error = err + return + } + + // Any info available? + if len(list.Items) < 1 { + result.UserError = ErrNotFound + return + } + + // Collect information + result.Information = []map[string]interface{}{} + for _, item := range list.Items { + r := map[string]interface{}{ + "Header": header, + "IsPlaylist": true, + "Title": "Playlist: " + item.Snippet.Title, + "Author": item.Snippet.ChannelTitle, + "PublishedAt": item.Snippet.PublishedAt, + "Description": item.Snippet.Description, + } + + // parse publishedAt + if t, err := time.Parse(time.RFC3339, item.Snippet.PublishedAt); err == nil { + r["PublishedAt"] = t + } else { + log.Print(err) + } + + result.Information = append(result.Information, r) + } + default: + result.Ignored = true + } + + return +} diff --git a/templates.go b/templates.go new file mode 100644 index 0000000..85ac54d --- /dev/null +++ b/templates.go @@ -0,0 +1,118 @@ +package main + +import ( + "bytes" + "fmt" + "log" + "math" + "net/url" + "regexp" + "strconv" + "strings" + "text/template" + "time" + + "github.com/dustin/go-humanize" +) + +var ( + compactNumUnits = []string{"", "k", "M"} + + tplFuncMap = template.FuncMap{ + // The name "title" is what the function will be called in the template text. + "color": func(num int) string { + return string(runeIrcColor) + strconv.Itoa(num) + }, + "bcolor": func(fgNum, bgNum int) string { + return string(runeIrcColor) + strconv.Itoa(fgNum) + "," + strconv.Itoa(bgNum) + }, + "bold": func() string { + return string(runeIrcBold) + }, + "italic": func() string { + return string(runeIrcItalic) + }, + "reset": func() string { + return string(runeIrcReset) + string(runeIrcColor) + }, + "reverse": func() string { + return string(runeIrcReverse) + }, + "underline": func() string { + return string(runeIrcUnderline) + }, + "urlencode": func(s string) string { + return url.QueryEscape(s) + }, + "yesno": func(yes string, no string, value bool) string { + if value { + return yes + } + + return no + }, + "excerpt": func(maxLength uint16, text string) string { + if len(text) > int(maxLength) { + return text[0:maxLength-1] + "\u2026" + } + return text + }, + "comma": func(num uint64) string { + return humanize.Comma(int64(num)) + }, + "compactnum": func(num uint64) string { + // 1 => 0 + // 1000 => 1 + // 1000000 => 2 + log10 := math.Floor(math.Log10(float64(num)) / 3) + + // Cut to available units + cut := int(math.Min(float64(len(compactNumUnits)-1), log10)) + + numf := float64(num) + numf /= math.Pow10(cut * 3) + + // Rounding + numf = math.Floor((numf*10)+.5) / 10 + if numf >= 1000 { + numf /= 1000 + if cut < len(compactNumUnits)-1 { + cut++ + } + } + + unit := compactNumUnits[cut] + f := "%.1f%s" + if numf-math.Floor(numf) < 0.05 { + f = "%.0f%s" + } + + return fmt.Sprintf(f, numf, unit) + }, + "ago": func(t time.Time) string { + return humanize.Time(t) + }, + "size": func(s uint64) string { + return humanize.Bytes(s) + }, + } + + ircTpl = template.Must( + template.New(""). + Funcs(tplFuncMap). + ParseGlob("*.tpl")) + + rxInsignificantWhitespace = regexp.MustCompile(`\s+`) +) + +func tplString(name string, data interface{}) (string, error) { + w := new(bytes.Buffer) + if err := ircTpl.ExecuteTemplate(w, name, data); err != nil { + return "", err + } + s := w.String() + s = rxInsignificantWhitespace.ReplaceAllString(s, " ") + s = strings.Trim(s, " ") + log.Printf("tplString(%v): %s", name, s) + return s, nil +} diff --git a/templates_test.go b/templates_test.go new file mode 100644 index 0000000..f0f64eb --- /dev/null +++ b/templates_test.go @@ -0,0 +1,36 @@ +package main + +import ( + "testing" + + "github.com/stretchr/testify/assert" +) + +func Test_TemplateFuncs_comma(t *testing.T) { + f := tplFuncMap["comma"].(func(num uint64) string) + + assert.Equal(t, "1", f(1)) + assert.Equal(t, "10", f(10)) + assert.Equal(t, "100", f(100)) + assert.Equal(t, "1,000", f(1000)) + assert.Equal(t, "1,000,000", f(1000000)) +} + +func Test_TemplateFuncs_compactnum(t *testing.T) { + f := tplFuncMap["compactnum"].(func(num uint64) string) + + assert.Equal(t, "1", f(1)) + assert.Equal(t, "10", f(10)) + assert.Equal(t, "100", f(100)) + assert.Equal(t, "999", f(999)) + assert.Equal(t, "1k", f(1000)) + assert.Equal(t, "9k", f(9000)) + assert.Equal(t, "9.9k", f(9900)) + assert.Equal(t, "10k", f(9999)) + assert.Equal(t, "10k", f(10000)) + assert.Equal(t, "100k", f(100000)) + assert.Equal(t, "999k", f(999000)) + assert.Equal(t, "999.9k", f(999900)) + assert.Equal(t, "1M", f(999999)) + assert.Equal(t, "1M", f(1000000)) +} diff --git a/util.go b/util.go new file mode 100644 index 0000000..9b50a96 --- /dev/null +++ b/util.go @@ -0,0 +1,61 @@ +package main + +import ( + "net/url" + "regexp" + "strings" +) + +const ( + runeIrcBold = '\x02' + runeIrcColor = '\x03' + runeIrcReset = '\x0f' + runeIrcReverse = '\x16' + runeIrcItalic = '\x1d' + runeIrcUnderline = '\x1f' +) + +var ( + rxIrcColor = regexp.MustCompile(string(runeIrcColor) + "([0-9]*(,[0-9]*)?)") +) + +func stripIrcFormatting(text string) string { + text = strings.Replace(text, string(runeIrcBold), "", -1) + text = strings.Replace(text, string(runeIrcReset), "", -1) + text = strings.Replace(text, string(runeIrcReverse), "", -1) + text = strings.Replace(text, string(runeIrcItalic), "", -1) + text = strings.Replace(text, string(runeIrcUnderline), "", -1) + text = rxIrcColor.ReplaceAllLiteralString(text, "") + return text +} + +func getYouTubeId(uri *url.URL) string { + u := &(*uri) + u.Scheme = strings.ToLower(u.Scheme) + u.Host = strings.ToLower(u.Host) + + // Must be an HTTP URL + if u.Scheme != "http" && u.Scheme != "https" { + return "" + } + + // Remove www. prefix from hostname + if strings.HasPrefix(u.Host, "www.") { + u.Host = u.Host[4:] + } + + switch strings.ToLower(u.Host) { + case "youtu.be": + // http://youtu.be/{id} + if s, err := url.QueryUnescape(strings.TrimLeft(u.Path, "/")); err == nil { + return s + } else { + return "" + } + case "youtube.com": + // http://youtube.com/watch?v={id} + return u.Query().Get("v") + } + + return "" +} diff --git a/util/apigen/main.go b/util/apigen/main.go new file mode 100644 index 0000000..d025a4c --- /dev/null +++ b/util/apigen/main.go @@ -0,0 +1,155 @@ +package main + +import ( + "bytes" + "fmt" + "go/format" + "io/ioutil" + "os" + "path/filepath" + "sort" + + "gopkg.in/alecthomas/kingpin.v2" + "gopkg.in/yaml.v2" + + "github.com/serenize/snaker" +) + +var ( + flagPackageName = kingpin.Flag("pkg", "Output package name").Default("main").String() + flagForce = kingpin.Flag("force", "Force rebuild.").Short('f').Bool() + flagYamlDefFile = kingpin.Arg("path", "Input YAML definitions file path").ExistingFile() +) + +type yamlDef struct { + Imports []string + Kinds map[string]*yamlTypeDef +} + +type yamlTypeDef struct { + Extends []string + Fields map[string]string +} + +func normalizeFieldId(t string) string { + switch t { + case "urn": + return "URN" + default: + return snaker.SnakeToCamel(t) + } +} + +func main() { + kingpin.Parse() + + // Generate output file name from input file name + outputFileName := (*flagYamlDefFile)[0:len(*flagYamlDefFile)-len(filepath.Ext(*flagYamlDefFile))] + ".go" + + // Get input file stat + inputStat, err := os.Stat(*flagYamlDefFile) + if err != nil { + panic(err) + } + + // Does output file exist? + if !*flagForce { + if s, err := os.Stat(outputFileName); err == nil { + // Check output file time against input file time + if !inputStat.ModTime().After(s.ModTime()) { + // Output already up to date! + return + } + } + } + + fmt.Println(filepath.Base(*flagYamlDefFile)) + + // Read YAML def + ymlBytes, err := ioutil.ReadFile(*flagYamlDefFile) + if err != nil { + panic(err) + } + + // Unmarshal YAML def + var ymlDef yamlDef + yaml.Unmarshal(ymlBytes, &ymlDef) + + b := new(bytes.Buffer) + + // Write package name + b.WriteString(fmt.Sprintf("package %s\n", *flagPackageName)) + + // Write imports + if ymlDef.Imports != nil && len(ymlDef.Imports) > 0 { + b.WriteString("import (\n") + for _, i := range ymlDef.Imports { + b.WriteString(fmt.Sprintf("%q", i)) + } + b.WriteString(")\n") + } + + // Write types + registeredTypes := make(map[string]interface{}) + //var ensureType func(string) + generateType := func(name string, definition *yamlTypeDef) { + //id := snaker.SnakeToCamel(name) + + /*for _, fieldType := range definition.Fields { + ensureType(fieldType) + }*/ + + b.WriteString(fmt.Sprintf("\ntype %s struct {\n", name)) + + // Extends (as configured) + for _, t := range definition.Extends { + b.WriteString(t + "\n") + } + + // Fields (sorted alphabetically) + var keys []string + for k, _ := range definition.Fields { + keys = append(keys, k) + } + sort.Strings(keys) + for _, fieldName := range keys { + fieldType := definition.Fields[fieldName] + fieldId := normalizeFieldId(fieldName) + b.WriteString(fmt.Sprintf("%s %s `json:%q`\n", fieldId, fieldType, fieldName)) + } + b.WriteString("}\n") + } + /*ensureType = func(name string) { + if _, ok := registeredTypes[name]; ok { + // already generated + return + } + + typeDef, ok := ymlDef.Kinds[name] + if ok { + registeredTypes[name] = nil + generateType(name, typeDef) + } + }*/ + + var keys []string + for k, _ := range ymlDef.Kinds { + keys = append(keys, k) + } + sort.Strings(keys) + for _, name := range keys { + typeDef := ymlDef.Kinds[name] + if _, ok := registeredTypes[name]; !ok { + registeredTypes[name] = nil + generateType(name, typeDef) + } + } + + // Write out formatted source code + //fmt.Println(string(b.Bytes())) + fb, err := format.Source(b.Bytes()) + if err != nil { + panic(err) + } + ioutil.WriteFile(outputFileName, fb, 0644) +} diff --git a/util_test.go b/util_test.go new file mode 100644 index 0000000..858dc8b --- /dev/null +++ b/util_test.go @@ -0,0 +1,33 @@ +package main + +import ( + "net/url" + "testing" + + "github.com/stretchr/testify/assert" +) + +func mustParseUrl(u string) *url.URL { + if uri, err := url.Parse(u); err == nil { + return uri + } else { + panic(err) + } +} + +func Test_GetYouTubeId(t *testing.T) { + assert.Equal(t, "aYz-9jUlav-", getYouTubeId(mustParseUrl("http://youtube.com/watch?v=aYz-9jUlav-"))) + assert.Equal(t, "aYz-9jUlav-", getYouTubeId(mustParseUrl("https://youtube.com/watch?v=aYz-9jUlav-"))) + assert.Equal(t, "aYz-9jUlav-", getYouTubeId(mustParseUrl("http://www.youtube.com/watch?v=aYz-9jUlav-"))) + assert.Equal(t, "aYz-9jUlav-", getYouTubeId(mustParseUrl("https://www.youtube.com/watch?v=aYz-9jUlav-"))) + assert.Equal(t, "aYz-9jUlav-", getYouTubeId(mustParseUrl("http://youtu.be/aYz-9jUlav-"))) + assert.Equal(t, "aYz-9jUlav-", getYouTubeId(mustParseUrl("https://youtu.be/aYz-9jUlav-"))) + assert.Equal(t, "aYz-9jUlav-", getYouTubeId(mustParseUrl("http://www.youtu.be/aYz-9jUlav-"))) + assert.Equal(t, "aYz-9jUlav-", getYouTubeId(mustParseUrl("https://www.youtu.be/aYz-9jUlav-"))) +} + +func Benchmark_GetYouTubeId(b *testing.B) { + for n := 0; n < b.N; n++ { + getYouTubeId(mustParseUrl("http://youtube.com/watch?v=aYz-9jUlav-")) + } +}