diff --git a/tmp/Lyrics/README.md b/tmp/Lyrics/README.md new file mode 100644 index 0000000..425ce32 --- /dev/null +++ b/tmp/Lyrics/README.md @@ -0,0 +1 @@ +Song Lyrics Search diff --git a/tmp/Lyrics/__init__.py b/tmp/Lyrics/__init__.py new file mode 100644 index 0000000..ae2c8a5 --- /dev/null +++ b/tmp/Lyrics/__init__.py @@ -0,0 +1,68 @@ +### +# Copyright (c) 2024, codey +# All rights reserved. +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions are met: +# +# * Redistributions of source code must retain the above copyright notice, +# this list of conditions, and the following disclaimer. +# * Redistributions in binary form must reproduce the above copyright notice, +# this list of conditions, and the following disclaimer in the +# documentation and/or other materials provided with the distribution. +# * Neither the name of the author of this software nor the name of +# contributors to this software may be used to endorse or promote products +# derived from this software without specific prior written consent. +# +# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE +# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +# POSSIBILITY OF SUCH DAMAGE. + +### + +""" +Lyrics: Song Lyrics Search +""" + +import sys +import supybot +from supybot import world + +# Use this for the version of this plugin. +__version__ = "" + +# XXX Replace this with an appropriate author or supybot.Author instance. +__author__ = supybot.authors.unknown + +# This is a dictionary mapping supybot.Author instances to lists of +# contributions. +__contributors__ = {} + +# This is a url where the most recent plugin package can be downloaded. +__url__ = '' + +from . import config +from . import plugin +from importlib import reload +# In case we're being reloaded. +reload(config) +reload(plugin) +# Add more reloads here if you add third-party modules and want them to be +# reloaded when this plugin is reloaded. Don't forget to import them as well! + +if world.testing: + from . import test + +Class = plugin.Class +configure = config.configure + + +# vim:set shiftwidth=4 tabstop=4 expandtab textwidth=79: diff --git a/tmp/Lyrics/config.py b/tmp/Lyrics/config.py new file mode 100644 index 0000000..67ddf0c --- /dev/null +++ b/tmp/Lyrics/config.py @@ -0,0 +1,94 @@ +### +# Copyright (c) 2024, codey +# All rights reserved. +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions are met: +# +# * Redistributions of source code must retain the above copyright notice, +# this list of conditions, and the following disclaimer. +# * Redistributions in binary form must reproduce the above copyright notice, +# this list of conditions, and the following disclaimer in the +# documentation and/or other materials provided with the distribution. +# * Neither the name of the author of this software nor the name of +# contributors to this software may be used to endorse or promote products +# derived from this software without specific prior written consent. +# +# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE +# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +# POSSIBILITY OF SUCH DAMAGE. + +### + +from supybot import conf, registry +try: + from supybot.i18n import PluginInternationalization + _ = PluginInternationalization('Lyrics') +except: + _ = lambda x: x + + +def configure(advanced): + + from supybot.questions import expect, anything, something, yn + conf.registerPlugin('Lyrics', True) + + +Lyrics = conf.registerPlugin('Lyrics') + + + +conf.registerChannelValue(Lyrics, + "enable", + registry.Boolean( + True, _("""Should Lyrics respond in this channel?""") + )) + +conf.registerChannelValue(Lyrics, + "truncate", + registry.Boolean( + True, _("""Should Lyrics responses be truncated in this channel?""") + )) + +conf.registerChannelValue(Lyrics, + "lines", + registry.Integer( + 1, _("""If truncate is set to true, how many lines should be sent (initially)?""") + )) + +conf.registerChannelValue(Lyrics, + "mores", + registry.Boolean( + True, _("""If truncate is set to true, should mores be used to allow responses to be continued?""") + )) + +conf.registerChannelValue(Lyrics, + "quiet", + registry.Boolean( + False, _("""If quiet is set True, Searching... and Found: output will be entirely suppressed.""") + )) + +conf.registerChannelValue(Lyrics, + "verbose", + registry.Boolean( + False, _("""Send Searching... and Found: output to command context instead of privately via notice. Has no impact if quiet is set to True.""") + )) + + +conf.registerGlobalValue(Lyrics, + "floodexempt", + registry.Boolean( + False, _("""If set, the bot will not delay messages sent when truncation is set to False. This usually requires the bot to have a special connect/oper class, to prevent SendQ/RecvQ quits.""") + )) + +conf.registerGlobalValue(Lyrics, "host", registry.String( + "https://codey.lol/api/search", _("""API Host for Lyric Search"""), private=True, +)) diff --git a/tmp/Lyrics/local/__init__.py b/tmp/Lyrics/local/__init__.py new file mode 100644 index 0000000..e86e97b --- /dev/null +++ b/tmp/Lyrics/local/__init__.py @@ -0,0 +1 @@ +# Stub so local is a module, used for third-party modules diff --git a/tmp/Lyrics/plugin.py b/tmp/Lyrics/plugin.py new file mode 100644 index 0000000..95c07d0 --- /dev/null +++ b/tmp/Lyrics/plugin.py @@ -0,0 +1,170 @@ +### +# Copyright (c) 2024, codey +# All rights reserved. +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions are met: +# +# * Redistributions of source code must retain the above copyright notice, +# this list of conditions, and the following disclaimer. +# * Redistributions in binary form must reproduce the above copyright notice, +# this list of conditions, and the following disclaimer in the +# documentation and/or other materials provided with the distribution. +# * Neither the name of the author of this software nor the name of +# contributors to this software may be used to endorse or promote products +# derived from this software without specific prior written consent. +# +# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE +# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +# POSSIBILITY OF SUCH DAMAGE. + +### + +import textwrap +import time +import re +import requests + +from supybot import utils, plugins, ircutils, callbacks, conf, ircdb +from supybot.commands import * +from supybot.i18n import PluginInternationalization +from supybot.i18n import internationalizeDocstring + + +_ = PluginInternationalization('Lyrics') + + +class SearchException(Exception): + pass + +class Lyrics(callbacks.Plugin): + """Song Lyrics Search""" + threaded = True + + + + @wrap(['text']) + def sing(self, irc, msg, args, query): + """ + + Sing : + """ + + """Check if Lyrics Search is enabled in this context/channel""" + if not(self.registryValue('enable', network=irc.network, channel=msg.channel)): + return irc.noReply() + + """Check for botwide ignores""" + if ircdb.checkIgnored(msg.prefix, msg.args[0]): + return irc.noReply() + + use_mores = self.registryValue('mores', network=irc.network, channel=msg.channel) + truncate = self.registryValue('truncate', network=irc.network, channel=msg.channel) + lines_to_send = self.registryValue('lines', network=irc.network, channel=msg.channel) + quiet = self.registryValue('quiet', network=irc.network, channel=msg.channel) + verbose = self.registryValue('verbose', network=irc.network, channel=msg.channel) + can_flood = self.registryValue('floodexempt') + + + subsearch = None + trailer = " [...]" + query = "".join(query.strip()) + colons = len(re.findall(r':', query)) + dashes = len(re.findall(r'\s-\s', query)) + has_subsearch = (colons > 1) + + + """Check for valid query ( must contain : or - )""" + if not(colons) and not(dashes): + irc.reply("\002\00304Invalid query! " \ + "Query format should be either : , - , or optionally " \ + " : : ", prefixNick=False) + return + + + if colons: + artist = query.split(":")[0].strip() + song = query.split(":")[1].strip() + else: + artist = query.split(" - ", maxsplit=1)[0].strip() + song = query.split(" - ", maxsplit=1)[1].strip() + + searchObj = { + 'a': artist, + 's': song, + 'src': 'IRC-KALI', + 'extras': True + } + + headers = { + 'User-Agent': 'Mozilla/5.0 (X11; Linux x86_64; rv:127.0) Gecko/20100101 Firefox/127.0', + 'Content-Type': 'application/json; charset=utf-8' + } + + if has_subsearch: + subsearch = query.split(":")[2].strip() + searchObj['sub'] = subsearch + + try: + if not(quiet): + irc.reply("\002\00307Searching...", + private=not(verbose), notice=not(verbose), prefixNick=False) + + request = requests.post(self.registryValue('host'), + json=searchObj, + timeout=(10, 20), verify=False, headers=headers) + + request.raise_for_status() + + response = request.json() + if response.get('err'): + raise SearchException(response.get('errorText')) + + returned_artist = response.get('artist') + returned_song = response.get('song') + + if not(quiet): + irc.reply("\002\00309Found: %s - %s" + % (returned_artist, returned_song), + notice=not(verbose), private=not(verbose), + prefixNick=False) + + lyrics = response.get('lyrics') + lyrics = re.sub(r'
', ' / ', lyrics) + + if truncate and use_mores: + irc.reply(lyrics, prefixNick=False) + return + + wrapped_lyrics = textwrap.wrap(text=lyrics, + width=360, + break_on_hyphens=True, + break_long_words=True) + + if not(truncate): + lines_to_send = len(wrapped_lyrics) + + for idx, line in enumerate(wrapped_lyrics): + line = re.sub(r'/(\s{0,})$', '', line).strip() + if idx >= lines_to_send: + break + truncated = (idx+1 == lines_to_send and truncate) + irc.reply(line.strip() + (trailer if truncated else ''), prefixNick=False) + + if idx >= 5 and not(can_flood): + time.sleep(0.5) # Avoid RecvQ by sleeping for 0.5s starting with the 5th line of output + + return + except Exception as e: + irc.reply(f"\002\00304Error: {str(e)}", prefixNick=False) + return + +Class = Lyrics \ No newline at end of file diff --git a/tmp/Lyrics/setup.py b/tmp/Lyrics/setup.py new file mode 100644 index 0000000..b6cd941 --- /dev/null +++ b/tmp/Lyrics/setup.py @@ -0,0 +1,35 @@ +### +# Copyright (c) 2024, codey +# All rights reserved. +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions are met: +# +# * Redistributions of source code must retain the above copyright notice, +# this list of conditions, and the following disclaimer. +# * Redistributions in binary form must reproduce the above copyright notice, +# this list of conditions, and the following disclaimer in the +# documentation and/or other materials provided with the distribution. +# * Neither the name of the author of this software nor the name of +# contributors to this software may be used to endorse or promote products +# derived from this software without specific prior written consent. +# +# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE +# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +# POSSIBILITY OF SUCH DAMAGE. + +### + +from supybot.setup import plugin_setup + +plugin_setup( + 'Lyrics', +) diff --git a/tmp/Lyrics/test.py b/tmp/Lyrics/test.py new file mode 100644 index 0000000..90f3f79 --- /dev/null +++ b/tmp/Lyrics/test.py @@ -0,0 +1,38 @@ +### +# Copyright (c) 2024, codey +# All rights reserved. +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions are met: +# +# * Redistributions of source code must retain the above copyright notice, +# this list of conditions, and the following disclaimer. +# * Redistributions in binary form must reproduce the above copyright notice, +# this list of conditions, and the following disclaimer in the +# documentation and/or other materials provided with the distribution. +# * Neither the name of the author of this software nor the name of +# contributors to this software may be used to endorse or promote products +# derived from this software without specific prior written consent. +# +# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE +# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +# POSSIBILITY OF SUCH DAMAGE. + +### + +from supybot.test import * + + +class LyricsTestCase(PluginTestCase): + plugins = ('Lyrics',) + + +# vim:set shiftwidth=4 tabstop=4 expandtab textwidth=79: diff --git a/tmp/README.md b/tmp/README.md new file mode 100644 index 0000000..ab1fbdd --- /dev/null +++ b/tmp/README.md @@ -0,0 +1 @@ +# This stuff does not belong here and will be removed \ No newline at end of file