├── assets └── screenshot.png ├── .flake8 ├── PlexBot ├── __version__.py ├── exceptions.py ├── __main__.py ├── __init__.py └── bot.py ├── requirements.txt ├── deploy ├── push.sh └── build.sh ├── sample-config.yaml ├── docker-compose_dev.yml ├── docker-compose.yml ├── pyproject.toml ├── Makefile ├── .pre-commit-config.yaml ├── Dockerfile ├── Jenkinsfile ├── .gitignore ├── README.md └── LICENSE /assets/screenshot.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jarulsamy/Plex-Bot/HEAD/assets/screenshot.png -------------------------------------------------------------------------------- /.flake8: -------------------------------------------------------------------------------- 1 | [flake8] 2 | max-line-length = 120 3 | max-complexity = 18 4 | select = B,C,E,F,W,T4,B9 5 | -------------------------------------------------------------------------------- /PlexBot/__version__.py: -------------------------------------------------------------------------------- 1 | """Track version number of package.""" 2 | VERSION = "1.0.3" 3 | 4 | if __name__ == "__main__": 5 | print(VERSION) 6 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | discord.py==1.4.1 2 | PlexAPI==4.0.0 3 | fuzzywuzzy==0.18.0 4 | pynacl==1.4.0 5 | ffmpeg==1.4 6 | PyYAML==5.3.1 7 | lyricsgenius==2.0.0 8 | -------------------------------------------------------------------------------- /PlexBot/exceptions.py: -------------------------------------------------------------------------------- 1 | class MediaNotFoundError(Exception): 2 | """Raised when a PlexAPI media resource cannot be found.""" 3 | 4 | pass 5 | 6 | 7 | class VoiceChannelError(Exception): 8 | """Raised when user is not connected to a voice channel.""" 9 | 10 | pass 11 | -------------------------------------------------------------------------------- /deploy/push.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | VERSION=$(python PlexBot/__version__.py) 4 | 5 | docker push "jarulsamy/plex-bot:$VERSION" 6 | 7 | if [ $? -eq 0 ] 8 | then 9 | echo "Successfully pushed docker image." 10 | exit 0 11 | else 12 | echo "Failed to push docker image." >&2 13 | exit 1 14 | fi 15 | -------------------------------------------------------------------------------- /deploy/build.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | VERSION=$(python PlexBot/__version__.py) 4 | 5 | docker build -t "jarulsamy/plex-bot:$VERSION" . 6 | 7 | if [ $? -eq 0 ] 8 | then 9 | echo "Successfully build docker image." 10 | exit 0 11 | else 12 | echo "Failed to build docker image." >&2 13 | exit 1 14 | fi 15 | -------------------------------------------------------------------------------- /sample-config.yaml: -------------------------------------------------------------------------------- 1 | root: 2 | log_level: "info" 3 | 4 | discord: 5 | prefix: "?" 6 | token: "" 7 | log_level: "debug" 8 | 9 | plex: 10 | base_url: "" 11 | token: "" 12 | library_name: "" 13 | log_level: "debug" 14 | 15 | lyrics: 16 | token: 17 | -------------------------------------------------------------------------------- /docker-compose_dev.yml: -------------------------------------------------------------------------------- 1 | version: "3" 2 | services: 3 | plex-bot: 4 | container_name: "PlexBot" 5 | build: . 6 | environment: 7 | - PUID=1000 8 | - PGID=1000 9 | - TZ=America/Denver 10 | # Required dir for configuration files 11 | volumes: 12 | - "./config:/config:ro" 13 | restart: "no" 14 | -------------------------------------------------------------------------------- /docker-compose.yml: -------------------------------------------------------------------------------- 1 | version: "3" 2 | services: 3 | plex-bot: 4 | container_name: "PlexBot" 5 | image: jarulsamy/plex-bot:latest 6 | environment: 7 | - PUID=1000 8 | - PGID=1000 9 | - TZ=America/Denver 10 | # Required dir for configuration files 11 | volumes: 12 | - "./config:/config:ro" 13 | restart: "unless-stopped" 14 | -------------------------------------------------------------------------------- /pyproject.toml: -------------------------------------------------------------------------------- 1 | [tool.black] 2 | py37 = true 3 | include = '\.pyi?$' 4 | exclude = ''' 5 | /( 6 | \.git 7 | | \.hg 8 | | \.mypy_cache 9 | | \.tox 10 | | \.venv 11 | | _build 12 | | buck-out 13 | | build 14 | | dist 15 | 16 | # The following are specific to Black, you probably don't want those. 17 | | blib2to3 18 | | tests/data 19 | )/ 20 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | .PHONY: help pull build clean 2 | .DEFAULT_GOAL: build 3 | 4 | help: 5 | @echo "make pull" 6 | @echo " Start docker container with pull" 7 | @echo "make build" 8 | @echo " Start docker container rebuilding container" 9 | 10 | pull: 11 | docker-compose up 12 | 13 | build: 14 | docker-compose -f docker-compose_dev.yml up --build 15 | 16 | clean: 17 | docker system prune -a 18 | -------------------------------------------------------------------------------- /.pre-commit-config.yaml: -------------------------------------------------------------------------------- 1 | default_language_version: 2 | python: python3.7 3 | repos: 4 | - repo: https://github.com/pre-commit/pre-commit-hooks 5 | rev: v2.4.0 6 | hooks: 7 | - id: trailing-whitespace 8 | - id: end-of-file-fixer 9 | - id: check-yaml 10 | - id: check-added-large-files 11 | - id: check-case-conflict 12 | 13 | - repo: https://github.com/asottile/reorder_python_imports 14 | rev: v1.9.0 15 | hooks: 16 | - id: reorder-python-imports 17 | 18 | - repo: https://github.com/ambv/black 19 | rev: stable 20 | hooks: 21 | - id: black 22 | language_version: python3.7 23 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM python:3.7-slim 2 | 3 | LABEL maintainer="Joshua Arulsamy " 4 | 5 | # Install ffmpeg 6 | RUN apt-get -y update && \ 7 | apt-get install -y --no-install-recommends ffmpeg=7:4.1.6-1~deb10u1 && \ 8 | apt-get autoremove -y && \ 9 | apt-get clean && \ 10 | rm -rf /var/lib/apt/lists/* 11 | 12 | # All source code 13 | WORKDIR /src 14 | 15 | # Copy of dependency manifest 16 | COPY requirements.txt . 17 | 18 | # Install all dependencies. 19 | RUN pip install --no-cache-dir -r requirements.txt 20 | 21 | # Copy PlexBot over to src. 22 | COPY PlexBot/ PlexBot 23 | 24 | # Run the bot 25 | CMD ["python", "-OO", "-m", "PlexBot"] 26 | -------------------------------------------------------------------------------- /PlexBot/__main__.py: -------------------------------------------------------------------------------- 1 | """ 2 | Main entrypoint script. 3 | Sets up loggers and initiates bot. 4 | """ 5 | import logging 6 | 7 | from discord.ext.commands import Bot 8 | 9 | from . import load_config 10 | from .bot import General 11 | from .bot import Plex 12 | 13 | # Load config from file 14 | configdir = "config" 15 | from os import geteuid 16 | if geteuid() == 0: 17 | configdir = "/config" 18 | config = load_config(configdir,"config.yaml") 19 | 20 | BOT_PREFIX = config["discord"]["prefix"] 21 | TOKEN = config["discord"]["token"] 22 | 23 | BASE_URL = config["plex"]["base_url"] 24 | PLEX_TOKEN = config["plex"]["token"] 25 | LIBRARY_NAME = config["plex"]["library_name"] 26 | 27 | if config["lyrics"]: 28 | LYRICS_TOKEN = config["lyrics"]["token"] 29 | else: 30 | LYRICS_TOKEN = None 31 | 32 | # Set appropiate log level 33 | root_log = logging.getLogger() 34 | plex_log = logging.getLogger("Plex") 35 | bot_log = logging.getLogger("Bot") 36 | 37 | plex_log.setLevel(config["plex"]["log_level"]) 38 | bot_log.setLevel(config["discord"]["log_level"]) 39 | 40 | plex_args = { 41 | "base_url": BASE_URL, 42 | "plex_token": PLEX_TOKEN, 43 | "lib_name": LIBRARY_NAME, 44 | "lyrics_token": LYRICS_TOKEN, 45 | } 46 | 47 | bot = Bot(command_prefix=BOT_PREFIX) 48 | # Remove help command, we have our own custom one. 49 | bot.remove_command("help") 50 | bot.add_cog(General(bot)) 51 | bot.add_cog(Plex(bot, **plex_args)) 52 | bot.run(TOKEN) 53 | -------------------------------------------------------------------------------- /PlexBot/__init__.py: -------------------------------------------------------------------------------- 1 | """ 2 | Plex music bot for discord. 3 | 4 | """ 5 | import logging 6 | import sys 7 | from pathlib import Path 8 | from typing import Dict 9 | 10 | import yaml 11 | 12 | FORMAT = "%(asctime)s %(levelname)s: [%(filename)s:%(lineno)s - %(funcName)20s() ] %(message)s" 13 | 14 | logging.basicConfig(format=FORMAT) 15 | root_log = logging.getLogger() 16 | plex_log = logging.getLogger("Plex") 17 | bot_log = logging.getLogger("Bot") 18 | 19 | 20 | def load_config(basedir: str,filename: str) -> Dict[str, str]: 21 | """Loads config from yaml file 22 | 23 | Grabs key/value config pairs from a file. 24 | 25 | Args: 26 | filename: str path to yaml file. 27 | 28 | Returns: 29 | Dict[str, str] Values from config file. 30 | 31 | Raises: 32 | FileNotFound Configuration file not found. 33 | """ 34 | # All config files should be in /config 35 | # for docker deployment. 36 | filename = Path(basedir, filename) 37 | try: 38 | with open(filename, "r") as config_file: 39 | config = yaml.safe_load(config_file) 40 | except FileNotFoundError: 41 | root_log.fatal("Configuration file not found at '"+str(filename)+"'.") 42 | sys.exit(-1) 43 | 44 | # Convert str level type to logging constant 45 | levels = { 46 | "DEBUG": logging.DEBUG, 47 | "INFO": logging.INFO, 48 | "WARNING": logging.WARNING, 49 | "ERROR": logging.ERROR, 50 | "CRITICAL": logging.CRITICAL, 51 | } 52 | 53 | config["root"]["log_level"] = levels[config["root"]["log_level"].upper()] 54 | config["plex"]["log_level"] = levels[config["plex"]["log_level"].upper()] 55 | config["discord"]["log_level"] = levels[config["discord"]["log_level"].upper()] 56 | 57 | if config["lyrics"] and config["lyrics"]["token"].lower() == "none": 58 | config["lyrics"] = None 59 | 60 | return config 61 | -------------------------------------------------------------------------------- /Jenkinsfile: -------------------------------------------------------------------------------- 1 | pipeline { 2 | agent any 3 | 4 | options { 5 | skipDefaultCheckout(true) 6 | // Keep the 2 most recent builds 7 | buildDiscarder(logRotator(numToKeepStr: '2')) 8 | timestamps() 9 | } 10 | 11 | environment { 12 | PATH="/var/lib/jenkins/miniconda3/bin:$PATH" 13 | } 14 | 15 | stages { 16 | stage ("Code pull"){ 17 | steps{ 18 | checkout scm 19 | } 20 | } 21 | 22 | stage('Build environment') { 23 | steps { 24 | echo "Building virtualenv" 25 | sh ''' conda create --yes -n ${BUILD_TAG} python 26 | source /var/lib/jenkins/miniconda3/etc/profile.d/conda.sh 27 | conda activate ${BUILD_TAG} 28 | pip install -r requirements.txt 29 | pip install pylint 30 | ''' 31 | } 32 | } 33 | 34 | stage('Static code metrics') { 35 | steps { 36 | echo "Style check" 37 | sh ''' source /var/lib/jenkins/miniconda3/etc/profile.d/conda.sh 38 | conda activate ${BUILD_TAG} 39 | pylint PlexBot || true 40 | ''' 41 | } 42 | } 43 | 44 | stage('Build package') { 45 | when { 46 | expression { 47 | currentBuild.result == null || currentBuild.result == 'SUCCESS' 48 | } 49 | } 50 | steps { 51 | sh './deploy/build.sh' 52 | } 53 | } 54 | stage('Push Image') { 55 | steps { 56 | sh './deploy/push.sh' 57 | } 58 | } 59 | } 60 | 61 | post { 62 | always { 63 | sh 'conda remove --yes -n ${BUILD_TAG} --all' 64 | sh 'docker system prune -a -f' 65 | } 66 | } 67 | } 68 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Project specific 2 | config.yaml 3 | config/ 4 | deploy.sh 5 | 6 | # Byte-compiled / optimized / DLL files 7 | __pycache__/ 8 | *.py[cod] 9 | *$py.class 10 | *.exe 11 | 12 | # C extensions 13 | *.so 14 | 15 | # VScode 16 | *.vscode 17 | 18 | # Distribution / packaging 19 | .Python 20 | build/ 21 | develop-eggs/ 22 | dist/ 23 | downloads/ 24 | eggs/ 25 | .eggs/ 26 | lib/ 27 | lib64/ 28 | parts/ 29 | sdist/ 30 | var/ 31 | wheels/ 32 | pip-wheel-metadata/ 33 | share/python-wheels/ 34 | *.egg-info/ 35 | .installed.cfg 36 | *.egg 37 | MANIFEST 38 | 39 | # PyInstaller 40 | # Usually these files are written by a python script from a template 41 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 42 | *.manifest 43 | *.spec 44 | 45 | # Installer logs 46 | pip-log.txt 47 | pip-delete-this-directory.txt 48 | 49 | # Unit test / coverage reports 50 | htmlcov/ 51 | .tox/ 52 | .nox/ 53 | .coverage 54 | .coverage.* 55 | .cache 56 | nosetests.xml 57 | coverage.xml 58 | *.cover 59 | *.py,cover 60 | .hypothesis/ 61 | .pytest_cache/ 62 | 63 | # Translations 64 | *.mo 65 | *.pot 66 | 67 | # Django stuff: 68 | *.log 69 | local_settings.py 70 | db.sqlite3 71 | db.sqlite3-journal 72 | 73 | # Flask stuff: 74 | instance/ 75 | .webassets-cache 76 | 77 | # Scrapy stuff: 78 | .scrapy 79 | 80 | # Sphinx documentation 81 | docs/_build/ 82 | 83 | # PyBuilder 84 | target/ 85 | 86 | # Jupyter Notebook 87 | .ipynb_checkpoints 88 | 89 | # IPython 90 | profile_default/ 91 | ipython_config.py 92 | 93 | # pyenv 94 | .python-version 95 | 96 | # pipenv 97 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 98 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 99 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 100 | # install all needed dependencies. 101 | #Pipfile.lock 102 | 103 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow 104 | __pypackages__/ 105 | 106 | # Celery stuff 107 | celerybeat-schedule 108 | celerybeat.pid 109 | 110 | # SageMath parsed files 111 | *.sage.py 112 | 113 | # Environments 114 | .env 115 | .venv 116 | env/ 117 | venv/ 118 | ENV/ 119 | env.bak/ 120 | venv.bak/ 121 | 122 | # Spyder project settings 123 | .spyderproject 124 | .spyproject 125 | 126 | # Rope project settings 127 | .ropeproject 128 | 129 | # mkdocs documentation 130 | /site 131 | 132 | # mypy 133 | .mypy_cache/ 134 | .dmypy.json 135 | dmypy.json 136 | 137 | # Pyre type checker 138 | .pyre/ 139 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Plex-Bot 2 | 3 | [![Codacy Badge](https://api.codacy.com/project/badge/Grade/c93b8ff976ce4205a95046487917476b)](https://app.codacy.com/manual/jarulsamy/Plex-Bot?utm_source=github.com&utm_medium=referral&utm_content=jarulsamy/Plex-Bot&utm_campaign=Badge_Grade_Dashboard) 4 | [![GPLv3 license](https://img.shields.io/badge/License-GPLv3-blue.svg)](http://perso.crans.org/besson/LICENSE.html) 5 | ![docker pulls](https://img.shields.io/docker/pulls/jarulsamy/plex-bot) 6 | ![docker img size](https://img.shields.io/docker/image-size/jarulsamy/plex-bot) 7 | ![black badge](https://img.shields.io/badge/code%20style-black-000000.svg) 8 | 9 | A Python-based Plex music bot for discord. 10 | 11 | ![screenshot](assets/screenshot.png) 12 | 13 | ## Setup 14 | 15 | Plex-Bot runs entirely in a Docker container. Ensure you have Docker and docker-compose installed according to the official Docker [documentation](https://docs.docker.com/get-docker/). 16 | 17 | 1. Create a new folder and `cd` into it: 18 | 19 | ```bash 20 | mkdir Plex-Bot 21 | cd Plex-Bot 22 | ``` 23 | 24 | 2. Make a `docker-compose.yml` file or use this sample: 25 | 26 | ```yml 27 | version: "3" 28 | services: 29 | plex-bot: 30 | container_name: "PlexBot" 31 | image: jarulsamy/plex-bot:latest 32 | environment: 33 | - PUID=1000 34 | - PGID=1000 35 | - TZ=America/Denver 36 | # Required dir for configuration files 37 | volumes: 38 | - "./config:/config:ro" 39 | restart: "unless-stopped" 40 | ``` 41 | 42 | 3. Create a new `config` folder and create a config file like this:: 43 | 44 | ```bash 45 | mkdir config 46 | cd config 47 | touch config.yaml 48 | ``` 49 | 50 | ```yml 51 | # Create a file called config.yaml with the following contents 52 | 53 | root: 54 | log_level: "info" 55 | 56 | discord: 57 | prefix: "?" 58 | token: "" 59 | log_level: "debug" 60 | 61 | plex: 62 | base_url: "" 63 | token: "" 64 | library_name: "" 65 | log_level: "debug" 66 | 67 | lyrics: 68 | token: "none" # Add your token here if you enable lyrics 69 | ``` 70 | 71 | 4. Create a Discord bot application: 72 | 73 | 1. Go to the Discord developer portal, [here](https://discord.com/developers/applications). 74 | 75 | 2. Log in or create an account 76 | 77 | 3. Click New App 78 | 79 | 4. Fill in App Name and anything else you'd like to include 80 | 81 | 5. Click Create App 82 | This will provide you with your Client ID and Client Secret 83 | 84 | 6. Click Create Bot User 85 | This will provide you with your bot Username and Token 86 | 87 | 7. Fill in the bot token in `config/config.yaml` 88 | 89 | 5. Get your plex token: 90 | 91 | * Refer to the official [plex documentation](https://support.plex.tv/articles/204059436-finding-an-authentication-token-x-plex-token/). 92 | 93 | * Add it to `config/config.yaml` in the appropiate spot. 94 | 95 | 6. Get your Lyrics Genius token (Optional): 96 | 97 | If you would like to enable the lyrics feature of the bot, you need to signup for a free GeniusLyrics account, [here](https://genius.com/api-clients). 98 | 99 | After you make an account: 100 | 101 | 1. Click New API Client 102 | 103 | 2. Set the app website url to: `https://github.com/jarulsamy/Plex-Bot` 104 | 105 | 3. Set the redirect url to: `http://localhost` 106 | 107 | 4. Copy the **Client Access Token** and replace `None` with your token in `config/config.yaml` 108 | 109 | 7. Customize remaining settings 110 | 111 | Set any remaining settings in the config file that you would like. Such as music library, and base url of the Plex server. 112 | 113 | 8. Start the service: 114 | 115 | ```bash 116 | docker-compose up -d 117 | ``` 118 | 119 | ## Logs 120 | 121 | You can view the logs with the following command 122 | 123 | ```bash 124 | docker-compose logs -f CONTAINER_NAME_OR_ID 125 | 126 | # For example 127 | docker-compose logs -f PlexBot 128 | ``` 129 | 130 | ## Usage 131 | 132 | ```text 133 | General: 134 | kill [silent] - Halt the bot [silently]. 135 | help - Print this help message. 136 | cleanup - Delete old messages from the bot. 137 | 138 | Plex: 139 | play - Play a song from the plex server. 140 | album - Queue an entire album to play. 141 | playlist - Queue an entire playlist to play. 142 | lyrics - Print the lyrics of the song (Requires Genius API) 143 | np - Print the current playing song. 144 | stop - Halt playback and leave vc. 145 | pause - Pause playback. 146 | resume - Resume playback. 147 | clear - Clear play queue. 148 | 149 | [] - Optional args. 150 | ``` 151 | 152 | * * * 153 | -------------------------------------------------------------------------------- /PlexBot/bot.py: -------------------------------------------------------------------------------- 1 | """All discord bot and Plex api interactions.""" 2 | import asyncio 3 | import io 4 | import logging 5 | from urllib.request import urlopen 6 | import requests 7 | 8 | import discord 9 | from async_timeout import timeout 10 | from discord import FFmpegPCMAudio 11 | from discord.ext import commands 12 | from discord.ext.commands import command 13 | from plexapi.exceptions import Unauthorized 14 | from plexapi.exceptions import NotFound 15 | from plexapi.server import PlexServer 16 | 17 | from .exceptions import MediaNotFoundError 18 | from .exceptions import VoiceChannelError 19 | 20 | root_log = logging.getLogger() 21 | plex_log = logging.getLogger("Plex") 22 | bot_log = logging.getLogger("Bot") 23 | 24 | help_text = """ 25 | General: 26 | kill [silent] - Halt the bot [silently]. 27 | help - Print this help message. 28 | cleanup - Delete old messages from the bot. 29 | 30 | Plex: 31 | play - Play a song from the plex server. 32 | album - Queue an entire album to play. 33 | playlist - Queue an entire playlist to play. 34 | show_playlists - Query for playlists with a name matching any of the arguments. 35 | lyrics - Print the lyrics of the song (Requires Genius API) 36 | np - Print the current playing song. 37 | q - Print the current queue (This can take very long!) 38 | stop - Halt playback and leave vc. 39 | loop - Loop the current song. 40 | loopq - Loop the current queue. 41 | unloop - Disable looping the current track. 42 | unloopq - Disable looping the current queue. 43 | pause - Pause playback. 44 | resume - Resume playback. 45 | skip - Skip the current song. Give a number as argument to skip more than 1. 46 | clear - Clear play queue. 47 | 48 | [] - Optional args. 49 | """ 50 | 51 | 52 | class General(commands.Cog): 53 | """ 54 | General commands 55 | 56 | Manage general bot behavior 57 | """ 58 | 59 | def __init__(self, bot): 60 | """ 61 | Initialize commands 62 | 63 | Args: 64 | bot: discord.ext.command.Bot, bind for cogs 65 | 66 | Returns: 67 | None 68 | 69 | Raises: 70 | None 71 | """ 72 | self.bot = bot 73 | 74 | @command() 75 | async def kill(self, ctx, *args): 76 | """ 77 | Kill the bot 78 | 79 | Args: 80 | ctx: discord.ext.commands.Context message context from command 81 | *args: optional flags 82 | 83 | Returns: 84 | None 85 | 86 | Raises: 87 | None 88 | """ 89 | if "silent" not in args: 90 | await ctx.send(f"Stopping upon the request of {ctx.author.mention}") 91 | 92 | await self.bot.close() 93 | bot_log.info("Stopping upon the request of %s", ctx.author.mention) 94 | 95 | @command(name="help") 96 | async def help(self, ctx): 97 | """ 98 | Prints command help 99 | 100 | Args: 101 | ctx: discord.ext.commands.Context message context from command 102 | 103 | Returns: 104 | None 105 | 106 | Raise: 107 | None 108 | """ 109 | 110 | await ctx.send(f"```{help_text}```") 111 | 112 | @command() 113 | async def cleanup(self, ctx, limit=250): 114 | """ 115 | Delete old messages from bot 116 | 117 | Args: 118 | ctx: discord.ext.commands.Context message context from command 119 | limit: int number of messages to go back by to delete. Default 250 120 | 121 | Raises: 122 | None 123 | 124 | Returns: 125 | None 126 | """ 127 | channel = ctx.message.channel 128 | 129 | try: 130 | async for i in channel.history(limit=limit): 131 | # Only delete messages sent by self 132 | if i.author == self.bot.user: 133 | try: 134 | await i.delete() 135 | except (discord.Forbidden, discord.NotFound, discord.HTTPException): 136 | pass 137 | 138 | async for i in channel.history(limit=limit): 139 | if i.author == ctx.message.author and i.content.startswith( 140 | self.bot.command_prefix 141 | ): 142 | try: 143 | await i.delete() 144 | except (discord.Forbidden, discord.NotFound, discord.HTTPException): 145 | pass 146 | 147 | except discord.Forbidden: 148 | bot_log.info("Unable to delete messages, insufficient permissions.") 149 | await ctx.send("I don't have the necessary permissions to delete messages.") 150 | 151 | 152 | class Plex(commands.Cog): 153 | """ 154 | Discord commands pertinent to interacting with Plex 155 | 156 | Contains user commands such as play, pause, resume, stop, etc. 157 | Grabs, and parses all data from plex database. 158 | """ 159 | 160 | # pylint: disable=too-many-instance-attributes 161 | # All are necessary to detect global interactions 162 | # within the bot. 163 | 164 | def __init__(self, bot, **kwargs): 165 | """ 166 | Initializes Plex resources 167 | 168 | Connects to Plex library and sets up 169 | all asyncronous communications. 170 | 171 | Args: 172 | bot: discord.ext.command.Bot, bind for cogs 173 | base_url: str url to Plex server 174 | plex_token: str X-Token of Plex server 175 | lib_name: str name of Plex library to search through 176 | 177 | Raises: 178 | plexapi.exceptions.Unauthorized: Invalid Plex token 179 | 180 | Returns: 181 | None 182 | """ 183 | 184 | self.bot = bot 185 | self.base_url = kwargs["base_url"] 186 | self.plex_token = kwargs["plex_token"] 187 | self.library_name = kwargs["lib_name"] 188 | self.bot_prefix = bot.command_prefix 189 | 190 | if kwargs["lyrics_token"]: 191 | import lyricsgenius 192 | self.genius = lyricsgenius.Genius(kwargs["lyrics_token"]) 193 | else: 194 | plex_log.warning("No lyrics token specified, lyrics disabled") 195 | self.genius = None 196 | 197 | # Log fatal invalid plex token 198 | try: 199 | self.pms = PlexServer(self.base_url, self.plex_token) 200 | except Unauthorized: 201 | plex_log.fatal("Invalid Plex token, stopping...") 202 | raise Unauthorized("Invalid Plex token") 203 | 204 | self.music = self.pms.library.section(self.library_name) 205 | plex_log.debug("Connected to plex library: %s", self.library_name) 206 | 207 | # Initialize necessary vars 208 | self.voice_channel = None 209 | self.current_track = None 210 | self.is_looping = False 211 | self.loop_queue = None 212 | self.np_message_id = None 213 | self.show_queue_message_ids = [] 214 | self.ctx = None 215 | 216 | # Initialize events 217 | self.play_queue = asyncio.Queue() 218 | self.play_next_event = asyncio.Event() 219 | 220 | bot_log.info("Started bot successfully") 221 | self.bot.loop.create_task(self._audio_player_task()) 222 | 223 | def _search_tracks(self, title: str): 224 | """ 225 | Search the Plex music db for track 226 | 227 | Args: 228 | title: str title of song to search for 229 | 230 | Returns: 231 | plexapi.audio.Track pointing to best matching title 232 | 233 | Raises: 234 | MediaNotFoundError: Title of track can't be found in plex db 235 | """ 236 | results = self.music.searchTracks(title=title, maxresults=1) 237 | try: 238 | return results[0] 239 | except IndexError: 240 | raise MediaNotFoundError("Track cannot be found") 241 | 242 | def _search_albums(self, title: str): 243 | """ 244 | Search the Plex music db for album 245 | 246 | Args: 247 | title: str title of album to search for 248 | 249 | Returns: 250 | plexapi.audio.Album pointing to best matching title 251 | 252 | Raises: 253 | MediaNotFoundError: Title of album can't be found in plex db 254 | """ 255 | results = self.music.searchAlbums(title=title, maxresults=1) 256 | try: 257 | return results[0] 258 | except IndexError: 259 | raise MediaNotFoundError("Album cannot be found") 260 | 261 | def _search_playlists(self, title: str): 262 | """ 263 | Search the Plex music db for playlist 264 | 265 | Args: 266 | title: str title of playlist to search for 267 | 268 | Returns: 269 | plexapi.playlist pointing to best matching title 270 | 271 | Raises: 272 | MediaNotFoundError: Title of playlist can't be found in plex db 273 | """ 274 | try: 275 | return self.pms.playlist(title) 276 | except NotFound: 277 | raise MediaNotFoundError("Playlist cannot be found") 278 | 279 | def _get_playlists(self): 280 | """ 281 | Search the Plex music db for playlist 282 | 283 | Returns: 284 | List of plexapi.playlist 285 | """ 286 | return self.pms.playlists() 287 | 288 | async def _play(self): 289 | """ 290 | Heavy lifting of playing songs 291 | 292 | Grabs the appropiate streaming URL, sends the `now playing` 293 | message, and initiates playback in the vc. 294 | 295 | Args: 296 | None 297 | 298 | Returns: 299 | None 300 | 301 | Raises: 302 | None 303 | """ 304 | track_url = self.current_track.getStreamURL() 305 | audio_stream = FFmpegPCMAudio(track_url) 306 | 307 | while self.voice_channel and self.voice_channel.is_playing(): 308 | bot_log.debug("waiting for track to finish") 309 | await asyncio.sleep(2) 310 | bot_log.debug("track finished") 311 | 312 | if self.voice_channel: 313 | self.voice_channel.play(audio_stream, after=self._toggle_next) 314 | 315 | plex_log.debug("%s - URL: %s", self.current_track, track_url) 316 | 317 | embed, img = self._build_embed_track(self.current_track) 318 | self.np_message_id = await self.ctx.send(embed=embed, file=img) 319 | 320 | async def _play_next(self): 321 | try: 322 | from asyncio.exceptions import CancelledError 323 | except ImportError: 324 | from concurrent.futures._base import CancelledError 325 | if self.is_looping: 326 | self.current_track = self.is_looping 327 | else: 328 | try: 329 | self.current_track = await self.play_queue.get() 330 | except CancelledError: 331 | bot_log.debug("failed to pop queue") 332 | 333 | if not self.current_track and self.loop_queue: 334 | bot_log.debug("swapping loop queue and play queue") 335 | for item in self.loop_queue: 336 | await self.play_queue.put(item) 337 | 338 | try: 339 | self.current_track = await self.play_queue.get() 340 | except CancelledError: 341 | bot_log.debug("failed to pop queue") 342 | 343 | async def _audio_player_task(self): 344 | """ 345 | Coroutine to handle playback and queuing 346 | 347 | Always-running function awaiting new songs to be added. 348 | Auto disconnects from VC if idle for > 15 seconds. 349 | Handles auto deletion of now playing song notifications. 350 | 351 | Args: 352 | None 353 | 354 | Returns: 355 | None 356 | 357 | Raises: 358 | None 359 | """ 360 | while True: 361 | self.play_next_event.clear() 362 | if self.voice_channel: 363 | try: 364 | # Disconnect after 15 seconds idle 365 | async with timeout(15): 366 | await self._play_next() 367 | except asyncio.TimeoutError: 368 | bot_log("timeout - disconnecting") 369 | await self.voice_channel.disconnect() 370 | self.voice_channel = None 371 | 372 | if not self.current_track: 373 | await self._play_next() 374 | 375 | await self._play() 376 | await self.play_next_event.wait() 377 | if self.np_message_id: 378 | await self.np_message_id.delete() 379 | 380 | def _toggle_next(self, error=None): 381 | """ 382 | Callback for vc playback 383 | 384 | Clears current track, then activates _audio_player_task 385 | to play next in queue or disconnect. 386 | 387 | Args: 388 | error: Optional parameter required for discord.py callback 389 | 390 | Returns: 391 | None 392 | 393 | Raises: 394 | None 395 | """ 396 | self.current_track = None 397 | self.bot.loop.call_soon_threadsafe(self.play_next_event.set) 398 | 399 | @staticmethod 400 | def _build_embed_track(track, type_="play"): 401 | """ 402 | Creates a pretty embed card for tracks 403 | 404 | Builds a helpful status embed with the following info: 405 | Status, song title, album, artist and album art. All 406 | pertitent information is grabbed dynamically from the Plex db. 407 | 408 | Args: 409 | track: plexapi.audio.Track object of song 410 | type_: Type of card to make (play, queue). 411 | 412 | Returns: 413 | embed: discord.embed fully constructed payload. 414 | thumb_art: io.BytesIO of album thumbnail img. 415 | 416 | Raises: 417 | ValueError: Unsupported type of embed {type_} 418 | """ 419 | # Grab the relevant thumbnail 420 | if track.thumbUrl: 421 | img_stream = requests.get(track.thumbUrl, stream=True).raw 422 | img = io.BytesIO(img_stream.read()) 423 | 424 | # Attach to discord embed 425 | art_file = discord.File(img, filename="image0.png") 426 | else: 427 | art_file = None 428 | 429 | # Get appropiate status message 430 | if type_ == "play": 431 | title = f"Now Playing - {track.title}" 432 | elif type_ == "queue": 433 | title = f"Added to queue - {track.title}" 434 | elif type_ == "queued": 435 | title = f"Next in line - {track.title}" 436 | else: 437 | raise ValueError(f"Unsupported type of embed {type_}") 438 | 439 | # Include song details 440 | descrip = f"{track.album().title} - {track.artist().title}" 441 | 442 | # Build the actual embed 443 | embed = discord.Embed( 444 | title=title, description=descrip, colour=discord.Color.red() 445 | ) 446 | embed.set_author(name="Plex") 447 | # Point to file attached with ctx object. 448 | embed.set_thumbnail(url="attachment://image0.png") 449 | 450 | bot_log.debug("Built embed for track - %s", track.title) 451 | 452 | return embed, art_file 453 | 454 | @staticmethod 455 | def _build_embed_album(album): 456 | """ 457 | Creates a pretty embed card for albums 458 | 459 | Builds a helpful status embed with the following info: 460 | album, artist, and album art. All pertitent information 461 | is grabbed dynamically from the Plex db. 462 | 463 | Args: 464 | album: plexapi.audio.Album object of album 465 | 466 | Returns: 467 | embed: discord.embed fully constructed payload. 468 | thumb_art: io.BytesIO of album thumbnail img. 469 | 470 | Raises: 471 | None 472 | """ 473 | # Grab the relevant thumbnail 474 | img_stream = requests.get(album.thumbUrl, stream=True).raw 475 | img = io.BytesIO(img_stream.read()) 476 | 477 | # Attach to discord embed 478 | art_file = discord.File(img, filename="image0.png") 479 | title = "Added album to queue" 480 | descrip = f"{album.title} - {album.artist().title}" 481 | 482 | embed = discord.Embed( 483 | title=title, description=descrip, colour=discord.Color.red() 484 | ) 485 | embed.set_author(name="Plex") 486 | embed.set_thumbnail(url="attachment://image0.png") 487 | bot_log.debug("Built embed for album - %s", album.title) 488 | 489 | return embed, art_file 490 | 491 | @staticmethod 492 | def _build_embed_playlist(self, playlist, title, descrip): 493 | """ 494 | Creates a pretty embed card for playlists 495 | 496 | Builds a helpful status embed with the following info: 497 | playlist art. All pertitent information 498 | is grabbed dynamically from the Plex db. 499 | 500 | Args: 501 | playlist: plexapi.playlist object of playlist 502 | 503 | Returns: 504 | embed: discord.embed fully constructed payload. 505 | thumb_art: io.BytesIO of playlist thumbnail img. 506 | 507 | Raises: 508 | None 509 | """ 510 | # Grab the relevant thumbnail 511 | try: 512 | img_stream = requests.get(self.pms.url(playlist.composite, True), stream=True).raw 513 | img = io.BytesIO(img_stream.read()) 514 | except: 515 | raise MediaNotFoundError("no image available") 516 | 517 | # Attach to discord embed 518 | art_file = discord.File(img, filename="image0.png") 519 | 520 | embed = discord.Embed( 521 | title=title, description=descrip, colour=discord.Color.red() 522 | ) 523 | embed.set_author(name="Plex") 524 | embed.set_thumbnail(url="attachment://image0.png") 525 | bot_log.debug("Built embed for playlist - %s", playlist.title) 526 | 527 | return embed, art_file 528 | 529 | async def _validate(self, ctx): 530 | """ 531 | Ensures user is in a vc 532 | 533 | Args: 534 | ctx: discord.ext.commands.Context message context from command 535 | 536 | Returns: 537 | None 538 | 539 | Raises: 540 | VoiceChannelError: Author not in voice channel 541 | """ 542 | # Fail if user not in vc 543 | if not ctx.author.voice: 544 | await ctx.send("Join a voice channel first!") 545 | bot_log.debug("Failed to play, requester not in voice channel") 546 | raise VoiceChannelError 547 | 548 | # Connect to voice if not already 549 | if not self.voice_channel: 550 | try: 551 | self.voice_channel = await ctx.author.voice.channel.connect() 552 | bot_log.debug("Connected to vc.") 553 | except asyncio.exceptions.TimeoutError: 554 | bot_log.debug("Cannot connect to vc - timeout") 555 | 556 | @command() 557 | async def play(self, ctx, *args): 558 | """ 559 | User command to play song 560 | 561 | Searchs plex db and either, initiates playback, or 562 | adds to queue. Handles invalid usage from the user. 563 | 564 | Args: 565 | ctx: discord.ext.commands.Context message context from command 566 | *args: Title of song to play 567 | 568 | Returns: 569 | None 570 | 571 | Raises: 572 | None 573 | """ 574 | # Save the context to use with async callbacks 575 | self.ctx = ctx 576 | title = " ".join(args) 577 | 578 | try: 579 | track = self._search_tracks(title) 580 | except MediaNotFoundError: 581 | await ctx.send(f"Can't find song: {title}") 582 | bot_log.debug("Failed to play, can't find song - %s", title) 583 | return 584 | 585 | try: 586 | await self._validate(ctx) 587 | except VoiceChannelError: 588 | pass 589 | 590 | # Specific add to queue message 591 | if self.voice_channel and self.voice_channel.is_playing(): 592 | bot_log.debug("Added to queue - %s", title) 593 | embed, img = self._build_embed_track(track, type_="queue") 594 | await ctx.send(embed=embed, file=img) 595 | 596 | # Add the song to the async queue 597 | await self.play_queue.put(track) 598 | 599 | @command() 600 | async def album(self, ctx, *args): 601 | """ 602 | User command to play song 603 | 604 | Searchs plex db and either, initiates playback, or 605 | adds to queue. Handles invalid usage from the user. 606 | 607 | Args: 608 | ctx: discord.ext.commands.Context message context from command 609 | *args: Title of song to play 610 | 611 | Returns: 612 | None 613 | 614 | Raises: 615 | None 616 | """ 617 | # Save the context to use with async callbacks 618 | self.ctx = ctx 619 | title = " ".join(args) 620 | 621 | try: 622 | album = self._search_albums(title) 623 | except MediaNotFoundError: 624 | await ctx.send(f"Can't find album: {title}") 625 | bot_log.debug("Failed to queue album, can't find - %s", title) 626 | return 627 | 628 | try: 629 | await self._validate(ctx) 630 | except VoiceChannelError: 631 | pass 632 | 633 | bot_log.debug("Added to queue - %s", title) 634 | embed, img = self._build_embed_album(album) 635 | await ctx.send(embed=embed, file=img) 636 | 637 | for track in album.tracks(): 638 | await self.play_queue.put(track) 639 | 640 | async def play_playlist(self, title, shuffle=False): 641 | try: 642 | playlist = self._search_playlists(title) 643 | except MediaNotFoundError: 644 | await self.ctx.send(f"Can't find playlist: {title}") 645 | bot_log.debug("Failed to queue playlist, can't find - %s", title) 646 | return 647 | 648 | try: 649 | await self._validate(self.ctx) 650 | except VoiceChannelError: 651 | pass 652 | 653 | try: 654 | embed, img = self._build_embed_playlist(self, playlist, "Added playlist to queue", playlist.title) 655 | await self.ctx.send(embed=embed, file=img) 656 | 657 | items = [ item for item in playlist.items() if item.TYPE == "track" ] 658 | if shuffle: 659 | from random import shuffle 660 | shuffle(items) 661 | 662 | for item in items: 663 | await self.play_queue.put(item) 664 | 665 | bot_log.debug("Added to queue - %s", title) 666 | 667 | except MediaNotFoundError: 668 | await self.ctx.send(message="Playlist "+title+" seems to be empty!") 669 | bot_log.debug("Playlist empty - %s", title) 670 | 671 | @command() 672 | async def playlist(self, ctx, *args): 673 | """ 674 | User command to play playlist 675 | 676 | Searchs plex db and either, initiates playback, or 677 | adds to queue. Handles invalid usage from the user. 678 | 679 | Args: 680 | ctx: discord.ext.commands.Context message context from command 681 | *args: Title of playlist to play 682 | 683 | Returns: 684 | None 685 | 686 | Raises: 687 | None 688 | """ 689 | # Save the context to use with async callbacks 690 | self.ctx = ctx 691 | title = " ".join(args) 692 | await self.play_playlist(title) 693 | 694 | @command() 695 | async def playlist_shuffle(self, ctx, *args): 696 | """ 697 | User command to play playlist in shuffle mode 698 | 699 | Searchs plex db and either, initiates playback, or 700 | adds to queue. Handles invalid usage from the user. 701 | 702 | Args: 703 | ctx: discord.ext.commands.Context message context from command 704 | *args: Title of playlist to play 705 | 706 | Returns: 707 | None 708 | 709 | Raises: 710 | None 711 | """ 712 | # Save the context to use with async callbacks 713 | self.ctx = ctx 714 | title = " ".join(args) 715 | await self.play_playlist(title,shuffle=True) 716 | 717 | 718 | @command() 719 | async def show_playlists(self, ctx, *args): 720 | """ 721 | User command to show playlists 722 | 723 | Searchs plex db and shows playlists matching. 724 | 725 | Args: 726 | ctx: discord.ext.commands.Context message context from command 727 | *args: String filter for playlist names 728 | 729 | Returns: 730 | None 731 | 732 | Raises: 733 | None 734 | """ 735 | # Save the context to use with async callbacks 736 | self.ctx = ctx 737 | 738 | playlists = self._get_playlists() 739 | 740 | try: 741 | await self._validate(ctx) 742 | except VoiceChannelError: 743 | pass 744 | 745 | for playlist in playlists: 746 | if args and not any(arg in playlist.title for arg in args): 747 | continue 748 | from datetime import timedelta 749 | if playlist.duration: 750 | seconds = playlist.duration / 1000 751 | embed, img = self._build_embed_playlist(self, playlist, playlist.title, "{:0>8}".format(str(timedelta(seconds=seconds)))) 752 | await ctx.send(embed=embed, file=img) 753 | 754 | @command() 755 | async def stop(self, ctx): 756 | """ 757 | User command to stop playback 758 | 759 | Stops playback and disconnects from vc. 760 | 761 | Args: 762 | ctx: discord.ext.commands.Context message context from command 763 | 764 | Returns: 765 | None 766 | 767 | Raises: 768 | None 769 | """ 770 | if self.voice_channel: 771 | self.voice_channel.stop() 772 | await self.voice_channel.disconnect() 773 | self.voice_channel = None 774 | self.ctx = None 775 | bot_log.debug("Stopped") 776 | await ctx.send(":stop_button: Stopped") 777 | 778 | @command() 779 | async def loop(self, ctx): 780 | """ 781 | User command to activate looping the current track 782 | 783 | Args: 784 | ctx: discord.ext.commands.Context message context from command 785 | 786 | Returns: 787 | None 788 | 789 | Raises: 790 | None 791 | """ 792 | bot_log.debug("Looping "+str(self.current_track)) 793 | self.is_looping = self.current_track 794 | 795 | @command() 796 | async def loopq(self, ctx): 797 | """ 798 | User command to activate looping the current queue 799 | 800 | Args: 801 | ctx: discord.ext.commands.Context message context from command 802 | 803 | Returns: 804 | None 805 | 806 | Raises: 807 | None 808 | """ 809 | bot_log.debug("Looping current queue") 810 | if self.current_track: 811 | self.loop_queue = [ self.current_track ] 812 | else: 813 | self.loop_queue = [] 814 | for item in self.play_queue._queue: 815 | self.loop_queue.append(item) 816 | 817 | @command() 818 | async def unloop(self, ctx): 819 | """ 820 | User command to deactivate looping the current track 821 | 822 | Args: 823 | ctx: discord.ext.commands.Context message context from command 824 | 825 | Returns: 826 | None 827 | 828 | Raises: 829 | None 830 | """ 831 | bot_log.debug("Looping current queue") 832 | self.is_looping = False 833 | 834 | @command() 835 | async def unloopq(self, ctx): 836 | """ 837 | User command to deactivate looping the current queue 838 | 839 | Args: 840 | ctx: discord.ext.commands.Context message context from command 841 | 842 | Returns: 843 | None 844 | 845 | Raises: 846 | None 847 | """ 848 | bot_log.debug("Unlooping") 849 | self.loop_queue = None 850 | 851 | 852 | @command() 853 | async def pause(self, ctx): 854 | """ 855 | User command to pause playback 856 | 857 | Pauses playback, but doesn't reset anything 858 | to allow playback resuming. 859 | 860 | Args: 861 | ctx: discord.ext.commands.Context message context from command 862 | 863 | Returns: 864 | None 865 | 866 | Raises: 867 | None 868 | """ 869 | if self.voice_channel: 870 | self.voice_channel.pause() 871 | bot_log.debug("Paused") 872 | await ctx.send(":play_pause: Paused") 873 | 874 | @command() 875 | async def resume(self, ctx): 876 | """ 877 | User command to resume playback 878 | 879 | Args: 880 | ctx: discord.ext.commands.Context message context from command 881 | 882 | Returns: 883 | None 884 | 885 | Raises: 886 | None 887 | """ 888 | if self.voice_channel: 889 | self.voice_channel.resume() 890 | bot_log.debug("Resumed") 891 | await ctx.send(":play_pause: Resumed") 892 | 893 | @command() 894 | async def skip(self, ctx, *args): 895 | """ 896 | User command to skip song in queue 897 | 898 | Skips currently playing song. If no other songs in 899 | queue, stops playback, otherwise moves to next song. 900 | 901 | Args: 902 | ctx: discord.ext.commands.Context message context from command 903 | 904 | Returns: 905 | None 906 | 907 | Raises: 908 | None 909 | """ 910 | n = 1 911 | if args: 912 | n = int(args[0]) 913 | bot_log.debug("Skipping "+str(n)) 914 | if self.voice_channel: 915 | self.voice_channel.stop() 916 | bot_log.debug("Skipped") 917 | if n>1: 918 | for i in range(n-1): 919 | await self.play_queue.get() 920 | self._toggle_next() 921 | 922 | @command(name="np") 923 | async def now_playing(self, ctx): 924 | """ 925 | User command to get currently playing song. 926 | 927 | Deletes old `now playing` status message, 928 | Creates a new one with up to date information. 929 | 930 | Args: 931 | ctx: discord.ext.commands.Context message context from command 932 | 933 | Returns: 934 | None 935 | 936 | Raises: 937 | None 938 | """ 939 | if self.current_track: 940 | embed, img = self._build_embed_track(self.current_track,type_="play") 941 | bot_log.debug("Now playing") 942 | if self.np_message_id: 943 | try: 944 | await self.np_message_id.delete() 945 | bot_log.debug("Deleted old np status") 946 | except discord.errors.NotFound: 947 | pass 948 | 949 | bot_log.debug("Created np status") 950 | self.np_message_id = await ctx.send(embed=embed, file=img) 951 | 952 | @command(name="q") 953 | async def show_queue(self, ctx): 954 | """ 955 | User command to print the current queue 956 | 957 | Deletes old `now playing` status message, 958 | Creates a new one with up to date information. 959 | 960 | Args: 961 | ctx: discord.ext.commands.Context message context from command 962 | 963 | Returns: 964 | None 965 | 966 | Raises: 967 | None 968 | """ 969 | bot_log.debug("Deleted old queue messages") 970 | for msg in self.show_queue_message_ids: 971 | await msg.delete() 972 | 973 | # need to do this in order to avoid errors when queue is modified during inspection 974 | elems = [] 975 | for track in self.play_queue._queue: 976 | elems.append(track) 977 | 978 | for track in elems: 979 | embed, img = self._build_embed_track(track,type_="queued") 980 | bot_log.debug("Show queue") 981 | 982 | bot_log.debug("Created queue message") 983 | self.show_queue_message_ids.append(await ctx.send(embed=embed, file=img)) 984 | 985 | @command() 986 | async def clear(self, ctx): 987 | """ 988 | User command to clear play queue. 989 | 990 | Args: 991 | ctx: discord.ext.commands.Context message context from command 992 | 993 | Returns: 994 | None 995 | 996 | Raises: 997 | None 998 | """ 999 | self.play_queue = asyncio.Queue() 1000 | self.loop_queue = None 1001 | bot_log.debug("Cleared queue") 1002 | await ctx.send(":boom: Queue cleared.") 1003 | 1004 | @command() 1005 | async def lyrics(self, ctx): 1006 | """ 1007 | User command to get lyrics of a song. 1008 | 1009 | Args: 1010 | ctx: discord.ext.commands.Context message context from command 1011 | 1012 | Returns: 1013 | None 1014 | 1015 | Raises: 1016 | None 1017 | """ 1018 | if not self.current_track: 1019 | plex_log.info("No song currently playing") 1020 | return 1021 | 1022 | if self.genius: 1023 | plex_log.info( 1024 | "Searching for %s, %s", 1025 | self.current_track.title, 1026 | self.current_track.artist().title, 1027 | ) 1028 | try: 1029 | song = self.genius.search_song( 1030 | self.current_track.title, self.current_track.artist().title 1031 | ) 1032 | except TypeError: 1033 | self.genius = None 1034 | plex_log.error("Invalid genius token, disabling lyrics") 1035 | return 1036 | 1037 | try: 1038 | lyrics = song.lyrics 1039 | # Split into 1950 char chunks 1040 | # Discord max message length is 2000 1041 | lines = [(lyrics[i : i + 1950]) for i in range(0, len(lyrics), 1950)] 1042 | 1043 | for i in lines: 1044 | if i == "": 1045 | continue 1046 | # Apply code block format 1047 | i = f"```{i}```" 1048 | await ctx.send(i) 1049 | 1050 | except (IndexError, TypeError): 1051 | plex_log.info("Could not find lyrics") 1052 | await ctx.send("Can't find lyrics for this song.") 1053 | else: 1054 | plex_log.warning("Attempted lyrics without valid token") 1055 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------