├── .github └── FUNDING.yml ├── .gitignore ├── Bot.py ├── Commands ├── Info │ └── info.py ├── Misc │ └── testing.py ├── Plex │ └── content.py ├── Utils │ ├── errors.py │ └── utils.py ├── config_parser.py ├── logger.py ├── plex.py └── settings.py ├── LICENSE ├── README.md ├── READ_FIRST.txt ├── configs ├── config.example.json ├── help_config.json └── secrets.example.json └── requirements.txt /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | # These are supported funding model platforms 2 | 3 | ko_fi: gamingismyfood 4 | 5 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .idea 2 | venv 3 | .env 4 | __pycache__ 5 | .vscode 6 | data/ 7 | config.json 8 | secrets.json 9 | build/ 10 | TODO 11 | -------------------------------------------------------------------------------- /Bot.py: -------------------------------------------------------------------------------- 1 | from urllib3.exceptions import NewConnectionError 2 | 3 | from Commands.settings import Settings 4 | from Commands.Plex.content import NewContent 5 | from Commands.logger import main_logger 6 | from discord.ext import commands, tasks 7 | import discord 8 | 9 | 10 | 11 | main_logger.info("Bot Starting") 12 | 13 | 14 | intents = discord.Intents.default() 15 | intents.members = True 16 | settings = Settings() 17 | 18 | cogs = [ 19 | "Commands.Misc.testing", 20 | "Commands.Info.info", 21 | "Commands.Utils.utils", 22 | "Commands.Utils.errors", 23 | ] 24 | 25 | 26 | client = commands.Bot( 27 | command_prefix=settings.general_config.prefix, 28 | help_command=None, 29 | intents=intents 30 | ) 31 | 32 | 33 | is_life = True 34 | 35 | 36 | @tasks.loop(minutes=settings.plex_config.refreshTime) 37 | async def check_for_new_content(): 38 | global is_life 39 | main_logger.info("Started Scan loop") 40 | try: 41 | await NewContent().send(client) 42 | if not is_life: 43 | await client\ 44 | .get_channel(settings.secrets.notificationsChannelId)\ 45 | .send('***🟢 ------------ Server Online ------------ 🟢***') 46 | is_life = True 47 | except Exception as e: 48 | main_logger.error('Failed scan loop') 49 | raise e 50 | if is_life: 51 | await client\ 52 | .get_channel(settings.secrets.notificationsChannelId)\ 53 | .send('***❌ ------------ Server Offline ------------ ❌***') 54 | is_life = False 55 | main_logger.info('Done Scan loop') 56 | 57 | 58 | @tasks.loop(hours=settings.general_config.backup_hour_interval) 59 | async def backup_task(): 60 | main_logger.info("Started backup") 61 | settings.backup() 62 | main_logger.info("Finished backup") 63 | 64 | 65 | @client.event 66 | async def on_ready(): 67 | main_logger.info(f"Bot is ready! Logged on as user {client.user}!") 68 | await client.change_presence(status=discord.Status.online, activity=discord.Activity(type=discord.ActivityType.watching, name="Plex")) 69 | main_logger.info("Starting cog initialization:") 70 | for cog in cogs: 71 | try: 72 | main_logger.info(f"- Loading cog {cog}") 73 | client.load_extension(cog) 74 | main_logger.info(f"- Loaded cog {cog}") 75 | except Exception as e: 76 | exc = "{}: {}".format(type(e).__name__, e) 77 | main_logger.info("- Failed to load cog {}\n{}".format(cog, exc)) 78 | main_logger.info("Done loading cogs\n") 79 | main_logger.info("Starting Task") 80 | if not settings.is_valid(): 81 | await client.close() 82 | exit('No config and/or secrets file') 83 | check_for_new_content.start() 84 | backup_task.start() 85 | 86 | 87 | client.run(settings.secrets.bot_token) 88 | -------------------------------------------------------------------------------- /Commands/Info/info.py: -------------------------------------------------------------------------------- 1 | from discord.ext import commands 2 | import discord 3 | from collections import Counter 4 | from Commands.logger import main_logger 5 | from Commands.plex import PlexConnection, Content 6 | import datetime 7 | import json 8 | from itertools import groupby 9 | from Commands.settings import Settings 10 | from os.path import exists 11 | 12 | starting_time = datetime.datetime.now() 13 | settings = Settings() 14 | 15 | 16 | async def send_error_message(ctx, error): 17 | main_logger.error(f"{__name__} {error}") 18 | await ctx.send(f"An error has occurred 😖: {error}", delete_after=5) 19 | await ctx.message.delete(delay=5) 20 | 21 | 22 | class SupportEmbed(discord.Embed): 23 | def __init__(self): 24 | super().__init__() 25 | self.title = "Support the developer" 26 | self.set_thumbnail(url="https://i.imgur.com/sxfp0vX.png") 27 | self.description = "[Buy me a Coffee](https://ko-fi.com/gamingismyfood)\n[Github Repo](https://github.com/CecilioSilva/Plexy)" 28 | self.color = 0xf207ff 29 | self.set_author( 30 | name="Made by: Gamingismyfood", 31 | url="https://github.com/CecilioSilva", 32 | icon_url="https://avatars.githubusercontent.com/u/61215183?v=4" 33 | ) 34 | 35 | def __repr__(self): 36 | return f'' 37 | 38 | 39 | class NotiEmbed(discord.Embed): 40 | def __init__(self, title=discord.Embed.Empty, description=discord.Embed.Empty, color=None, author=True, thumbnail=None): 41 | super().__init__() 42 | self.title = title 43 | self.description = description 44 | self.color = settings.style_config.defaultEmbedColor if not color else color 45 | 46 | if author: 47 | self.set_author(name="Plexy", icon_url=settings.style_config.iconLink, url="https://github.com/CecilioSilva/Plexy") 48 | if thumbnail: 49 | self.set_thumbnail(url=thumbnail) 50 | 51 | def __repr__(self): 52 | return f'' 53 | 54 | 55 | class InfoEmbed(discord.Embed): 56 | def __init__(self, plex_con, all_libs): 57 | super().__init__() 58 | 59 | self.title = "Info" 60 | self.description = "Plex Server Info" 61 | self.color = settings.style_config.helpEmbedColor 62 | self.all_libs = all_libs 63 | 64 | self.set_author(name="Plexy", icon_url=settings.style_config.iconLink, url="https://github.com/CecilioSilva/Plexy") 65 | self.plex_con = plex_con 66 | 67 | if self.plex_con: 68 | self.add_field( 69 | name="Server:", value=f"{self.plex_con.title}: 🟢", inline=False) 70 | self.set_all_fields() 71 | else: 72 | self.add_field(name="Server:", value=f"Offline: 🔴", inline=False) 73 | 74 | self.set_footer(text=f'Version: 6.0', 75 | icon_url=settings.style_config.iconLink) 76 | self.set_thumbnail(url=settings.style_config.infoThumbLink) 77 | self.add_field( 78 | name="Uptime:", value=datetime.datetime.now() - starting_time) 79 | 80 | main_logger.debug(f"{self} {self.description}") 81 | 82 | def set_all_fields(self): 83 | all_content = self.plex_con.library.all() 84 | 85 | types = [content.type for content in all_content] 86 | library_stats = [content.section().title for content in all_content] 87 | 88 | general_value = "" 89 | all_count = 0 90 | 91 | 92 | result = Counter(types) 93 | for key, value in result.items(): 94 | all_count += value 95 | general_value += f"{key.capitalize()}: **{value}**\n" 96 | general_value += f"Total: **{all_count}**\n" 97 | self.add_field(name="General:", value=general_value, inline=False) 98 | 99 | 100 | libraries_value = "" 101 | result = Counter(library_stats) 102 | 103 | 104 | libraries_to_scan = settings.plex_config.allLibraries if self.all_libs else settings.plex_config.scanLibraries 105 | 106 | for key, value in result.items(): 107 | if key in libraries_to_scan: 108 | libraries_value += f"{key}: **{value}**\n" 109 | self.add_field(name="Libraries:", value=libraries_value, inline=False) 110 | 111 | def __repr__(self): 112 | return f'' 113 | 114 | 115 | class HelpEmbed(discord.Embed): 116 | def __init__(self, arg=None): 117 | super().__init__() 118 | self.title = "Help" 119 | self.description = f"Prefix: **`{' | '.join(list(settings.general_config.prefix))}`**" 120 | self.color = settings.style_config.helpEmbedColor 121 | 122 | self.set_author( 123 | name="Plexy", icon_url=settings.style_config.iconLink, url="https://github.com/CecilioSilva/Plexy") 124 | 125 | self.set_footer( 126 | text=f"Made by: Gamingismyfood", icon_url=settings.style_config.iconLink) 127 | 128 | 129 | if arg: 130 | self.title = discord.Embed.Empty 131 | self.description = discord.Embed.Empty 132 | 133 | if exists('configs/help_config.json'): 134 | 135 | with open('configs/help_config.json', 'r') as help_file: 136 | data = help_file.read() 137 | for i in json.loads(data): 138 | string = '' 139 | for j in i['content']: 140 | 141 | string += f"`{j}`: {i['content'][j]}\n" 142 | 143 | string += f'*aliases*: ***{" | ".join([f"`{alias}`" for alias in i["aliases"]])}***\n' 144 | 145 | 146 | if not arg: 147 | self.add_field( 148 | name=i['field'].capitalize(), value=string, inline=False) 149 | else: 150 | 151 | 152 | if getattr(settings.command_config.aliases, arg.lower(), False): 153 | if i['field'] == arg.lower(): 154 | self.add_field( 155 | name=i['field'].capitalize(), value=string, inline=False) 156 | self.add_field(name="Description", 157 | value=i['description'], inline=False) 158 | break 159 | else: 160 | self.add_field( 161 | name=i['field'].capitalize(), value=string, inline=False) 162 | else: 163 | self.add_field( 164 | name='Error', value="No Help file found", inline=False) 165 | 166 | def __repr__(self): 167 | return f"" 168 | 169 | 170 | class FlagsEmbed(discord.Embed): 171 | def __init__(self): 172 | super().__init__() 173 | self.title = "Flags" 174 | self.description = "All usable args for commands. You can select libraries with these flags\n" 175 | self.color = settings.style_config.helpEmbedColor 176 | self.set_footer(text=f"Made by: Gamingismyfood", icon_url=settings.style_config.iconLink) 177 | self.set_author(name="Plexy", icon_url=settings.style_config.iconLink, url="https://github.com/CecilioSilva/Plexy") 178 | 179 | args = "" 180 | for key, value in settings.command_config.args.items(): 181 | args += f"**{key}** : `{' | '.join(value)}`\n" 182 | 183 | self.add_field(name="Flags:", value=args, inline=False) 184 | 185 | def __repr__(self): 186 | return f"" 187 | 188 | 189 | def summary_embed(plex_con): 190 | new_content: list[Content] = plex_con.get_new_content() 191 | 192 | categories = [list(g) 193 | for k, g in groupby(new_content, key=lambda x: x.type)] 194 | embeds = list() 195 | for content in categories: 196 | content.reverse() 197 | 198 | titles = [(cont.title, cont.library) 199 | for cont in content[:settings.command_config.settings.max_summary_amount]] 200 | 201 | title = f"Recently Added {content[0].library}:" 202 | description = '\n'.join( 203 | [f'• {val[0]} - {val[1]}' for val in titles]) 204 | embeds.append(NotiEmbed( 205 | title=title, 206 | description=description, 207 | author=False, 208 | color=settings.style_config.newContentEmbedColor 209 | )) 210 | return embeds 211 | 212 | 213 | class info(commands.Cog): 214 | 215 | def __init__(self, bot): 216 | self.bot = bot 217 | 218 | @commands.cooldown(rate=1, per=settings.command_config.cooldowns.info, type=commands.BucketType.member) 219 | @commands.command(aliases=settings.command_config.aliases.info) 220 | async def _info_command(self, ctx, arg1=None): 221 | main_logger.command('info', ctx) 222 | if settings.command_config.is_visible.info: 223 | try: 224 | plex_con = PlexConnection() 225 | except Exception as e: 226 | await send_error_message(ctx, e) 227 | plex_con = False 228 | 229 | async with ctx.typing(): 230 | info_embed = InfoEmbed(plex_con, all_libs=arg1 == "-a") 231 | 232 | await ctx.send(embed=info_embed) 233 | main_logger.info(f'Send: {repr(info_embed)}') 234 | 235 | @commands.cooldown(rate=1, per=settings.command_config.cooldowns.help, type=commands.BucketType.member) 236 | @commands.command(name="help") 237 | async def _help(self, ctx, arg=None): 238 | main_logger.command('help', ctx) 239 | if not arg: 240 | await ctx.author.send(embed=HelpEmbed()) 241 | embed = NotiEmbed(title=f"Send help message to:", 242 | description=f"{ctx.author.name}#{ctx.author.discriminator}") 243 | main_logger.info(f'Send private: {repr(embed)}') 244 | await ctx.send(embed=embed, delete_after=10) 245 | return 246 | elif arg == "-c": 247 | embed = HelpEmbed() 248 | else: 249 | embed = HelpEmbed(arg=arg) 250 | 251 | await ctx.send(embed=embed) 252 | main_logger.info(f'Send: {repr(embed)}') 253 | 254 | @commands.cooldown(rate=1, per=settings.command_config.cooldowns.summary, type=commands.BucketType.member) 255 | @commands.command(aliases=settings.command_config.aliases.summary) 256 | async def _summary(self, ctx): 257 | main_logger.command('summary', ctx) 258 | try: 259 | plex_con = PlexConnection() 260 | except Exception as e: 261 | await send_error_message(ctx, e) 262 | return 263 | 264 | if settings.command_config.is_visible.summary: 265 | await ctx.send("**Newest additions to the Plex server:**") 266 | async with ctx.typing(): 267 | summary_embeds = summary_embed(plex_con) 268 | 269 | for embed in summary_embeds: 270 | await ctx.send(embed=embed) 271 | main_logger.info(f'Send: {repr(embed)}') 272 | 273 | @commands.cooldown(rate=1, per=settings.command_config.cooldowns.libraries, type=commands.BucketType.member) 274 | @commands.command(aliases=settings.command_config.aliases.libraries) 275 | async def _libraries(self, ctx, arg=None): 276 | main_logger.command('libraries', ctx) 277 | if settings.command_config.is_visible.libraries: 278 | 279 | try: 280 | plex_con = PlexConnection() 281 | except Exception as e: 282 | await send_error_message(ctx, e) 283 | return 284 | 285 | libraries = plex_con.library.sections() 286 | if arg == "-a": 287 | desc = "\n".join( 288 | [f"• **{lib.title}** - `{lib.totalSize}`" for lib in libraries]) 289 | else: 290 | scan_libs = settings.plex_config.scanLibraries 291 | desc = "\n".join( 292 | [f"• **{lib.title}** - `{lib.totalSize}`" for lib in libraries if lib.title in scan_libs]) 293 | 294 | embed = NotiEmbed(title=f"Libraries:", description=desc) 295 | await ctx.send(embed=embed) 296 | main_logger.info(f'Send: {repr(embed)}') 297 | 298 | @commands.command(aliases=['support', 'sup', 'hero', 'dev']) 299 | async def _support(self, ctx): 300 | main_logger.command('support', ctx) 301 | embed = SupportEmbed() 302 | await ctx.send(embed=embed) 303 | main_logger.info(f'Send: {repr(embed)}') 304 | 305 | @commands.cooldown(rate=1, per=settings.command_config.cooldowns.flags, type=commands.BucketType.member) 306 | @commands.command(aliases=settings.command_config.aliases.flags) 307 | async def _flags(self, ctx): 308 | if settings.command_config.is_visible.flags: 309 | main_logger.command('flags', ctx) 310 | embed = FlagsEmbed() 311 | await ctx.send(embed=embed) 312 | main_logger.info(f'Send: {repr(embed)}') 313 | 314 | 315 | def setup(bot): 316 | bot.add_cog(info(bot)) 317 | -------------------------------------------------------------------------------- /Commands/Misc/testing.py: -------------------------------------------------------------------------------- 1 | from discord.ext import commands 2 | from Commands.settings import Settings 3 | from Commands.logger import main_logger 4 | 5 | settings = Settings() 6 | 7 | 8 | 9 | class testing(commands.Cog): 10 | def __init__(self, bot): 11 | self.bot = bot 12 | 13 | @commands.cooldown(rate=1, per=settings.command_config.cooldowns.ping, type=commands.BucketType.member) 14 | @commands.command(aliases=settings.command_config.aliases.ping) 15 | @commands.guild_only() 16 | async def _ping(self, ctx): 17 | main_logger.command('ping', ctx) 18 | if settings.command_config.is_visible.ping: 19 | await ctx.send(f"pong ⏱ {round(self.bot.latency * 1000)}ms") 20 | 21 | 22 | 23 | 24 | def setup(bot): 25 | bot.add_cog(testing(bot)) 26 | -------------------------------------------------------------------------------- /Commands/Plex/content.py: -------------------------------------------------------------------------------- 1 | from Commands.plex import PlexConnection 2 | from Commands.settings import Settings 3 | from Commands.logger import main_logger 4 | import sqlite3 5 | import itertools 6 | import discord 7 | import urllib.parse 8 | 9 | 10 | class EmbedContent: 11 | def __init__(self, type: str, library: str, key: str, season_episode: str, title: str, thumbnail: str): 12 | self.type = type 13 | self.library = library 14 | self.key = key 15 | self.season_episode = season_episode 16 | self.thumbnail = thumbnail 17 | self.title = title 18 | 19 | 20 | class NewContent: 21 | 22 | def __init__(self): 23 | self.plex_con = PlexConnection() 24 | self.settings = Settings() 25 | self.first_scan = True 26 | 27 | self.db_con = sqlite3.connect(f"data/content_database.sqlite") 28 | self._create_db_table() 29 | 30 | def _insert_content(self, content: EmbedContent): 31 | if self.settings.general_config.safe_mode: 32 | url = f"https://app.plex.tv/desktop/#!/search?query={urllib.parse.quote(content.title)}" 33 | else: 34 | url = f"{self.settings.secrets.contentUrl}details?key={content.key}&context=library%3Acontent.library" 35 | 36 | cursor_obj = self.db_con.cursor() 37 | cursor_obj.execute( 38 | 'INSERT INTO Content(type, library, key, season_episode, title, image, content_link) VALUES(?, ?, ?, ?, ?, ?, ?)', 39 | [content.type, content.library, content.key, content.season_episode, content.title, content.thumbnail, url]) 40 | self.db_con.commit() 41 | main_logger.debug( 42 | f"Added content {content.title} - {content.season_episode} to database") 43 | 44 | def _recently_added(self): 45 | recently_added_movies: list[EmbedContent] = list() 46 | recently_added_episodes: list[EmbedContent] = list() 47 | 48 | for lib in self.settings.plex_config.scanLibraries: 49 | lib_type = self.plex_con.library.section(lib).type 50 | if lib_type == "movie": 51 | for content in self.plex_con.library.section(lib).recentlyAdded(maxresults=self.settings.plex_config.max_recently_added): 52 | if self.settings.general_config.safe_mode: 53 | thumburl = "" 54 | else: 55 | thumburl = str(content.thumbUrl) 56 | 57 | movie_embed_content = EmbedContent( 58 | type=content.type, 59 | library=content.librarySectionTitle, 60 | key=content.key, 61 | season_episode=None, 62 | title=content.title, 63 | thumbnail=thumburl 64 | ) 65 | 66 | recently_added_movies.append(movie_embed_content) 67 | 68 | elif lib_type == "show": 69 | for content in self.plex_con.library.section(lib).recentlyAddedEpisodes(maxresults=self.settings.plex_config.max_recently_added): 70 | if self.settings.general_config.safe_mode: 71 | thumburl = "" 72 | else: 73 | thumburl = f"{self.settings.secrets.plexBaseUrl}{content.grandparentThumb}?X-Plex-Token={self.settings.secrets.plexToken}" 74 | 75 | show_embed_content = EmbedContent( 76 | type=content.type, 77 | library=content.librarySectionTitle, 78 | key=content.key, 79 | season_episode=content.seasonEpisode, 80 | title=content.grandparentTitle, 81 | thumbnail=thumburl 82 | ) 83 | recently_added_episodes.append(show_embed_content) 84 | 85 | newly_added_episodes = list() 86 | for key, group in itertools.groupby(recently_added_episodes, lambda x: x.title): 87 | newly_added_episodes.append(list(group)[0]) 88 | 89 | return recently_added_movies + newly_added_episodes 90 | 91 | def _create_db_table(self): 92 | try: 93 | db_cursor = self.db_con.cursor() 94 | db_cursor.execute( 95 | "CREATE TABLE content(id INTEGER PRIMARY KEY, type VARCHAR, library VARCHAR, key VARCHAR, season_episode VARCHAR, title VARCHAR, image VARCHAR, content_link VARCHAR)") 96 | self.db_con.commit() 97 | except sqlite3.OperationalError: 98 | main_logger.debug('Database exists') 99 | self.first_scan = False 100 | 101 | def _get_new_recently_added(self): 102 | self.recently_added_content = self._recently_added() 103 | db_cur = self.db_con.cursor() 104 | db_cur.execute('SELECT title,season_episode FROM content') 105 | db_rows = db_cur.fetchall() 106 | 107 | new_content = list() 108 | for content in self.recently_added_content: 109 | if not (content.title, content.season_episode) in db_rows: 110 | new_content.append(content) 111 | 112 | for content in new_content: 113 | self._insert_content(content) 114 | return new_content 115 | 116 | def _create_embed(self, content: EmbedContent): 117 | embed = discord.Embed( 118 | color=self.settings.style_config.newContentEmbedColor) 119 | embed.title = f"Newly added {content.library}:" 120 | embed.description = content.title 121 | 122 | if self.settings.general_config.safe_mode: 123 | embed.url = f"https://app.plex.tv/desktop/#!/search?query={urllib.parse.quote(content.title)}" 124 | else: 125 | embed.url = f"{self.settings.secrets.contentUrl}details?key={content.key}&context=library%3Acontent.library" 126 | embed.set_image( 127 | url=content.thumbnail if content.thumbnail else self.settings.style_config.defaultThumbLink) 128 | 129 | if content.type == "episode": 130 | embed.add_field(name="Episode", value=content.season_episode.split("e")[ 131 | 1], inline=False) 132 | embed.set_footer(text=content.season_episode.upper().replace( 133 | "S", f"{content.library} - Season: ").replace("E", " - Episode: ", 1)) 134 | 135 | elif content.type == "movie": 136 | embed.add_field(name="Type", value="Movie", inline=False) 137 | embed.set_footer(text="Movie") 138 | return embed 139 | 140 | def _get_content_embeds(self): 141 | new_content = self._get_new_recently_added() 142 | embed_list = list() 143 | for content in new_content: 144 | embed_list.append(self._create_embed(content)) 145 | return embed_list 146 | 147 | async def send(self, client): 148 | channel = client.get_channel( 149 | self.settings.secrets.notificationsChannelId) 150 | if not self.first_scan: 151 | for embed in self._get_content_embeds()[:30]: 152 | try: 153 | await channel.send(embed=embed) 154 | main_logger.info( 155 | f'Send new content embed: {embed.description}') 156 | except discord.errors.HTTPException as e: 157 | main_logger.error( 158 | f"Error sending new content embed: {embed.description}") 159 | -------------------------------------------------------------------------------- /Commands/Utils/errors.py: -------------------------------------------------------------------------------- 1 | from discord.ext import commands 2 | from Commands.logger import main_logger 3 | import traceback 4 | 5 | 6 | 7 | class ErrorHandler(commands.Cog): 8 | 9 | def __init__(self, bot: commands.Bot): 10 | self.bot = bot 11 | 12 | @commands.Cog.listener() 13 | async def on_command_error(self, ctx: commands.Context, error: commands.CommandError): 14 | if isinstance(error, commands.CommandOnCooldown): 15 | message = f"This command is on cool-down. Please try again after {round(error.retry_after, 1)} seconds." 16 | elif isinstance(error, commands.MissingPermissions): 17 | message = "You are missing the required permissions to run this command!" 18 | elif isinstance(error, commands.MissingRequiredArgument): 19 | message = f"Missing a required argument: {error.param}" 20 | elif isinstance(error, commands.ConversionError): 21 | message = str(error) 22 | elif isinstance(error, commands.CommandNotFound): 23 | message = f"Command: `{ctx.message.content}` does not exist!" 24 | else: 25 | message = "Oh no! Something went wrong while running the command!" 26 | 27 | main_logger.error(error) 28 | traceback.print_exception(type(error), error, error.__traceback__) 29 | 30 | await ctx.send(message, delete_after=5) 31 | await ctx.message.delete(delay=5) 32 | 33 | 34 | def setup(bot: commands.Bot): 35 | bot.add_cog(ErrorHandler(bot)) 36 | -------------------------------------------------------------------------------- /Commands/Utils/utils.py: -------------------------------------------------------------------------------- 1 | from typing import List 2 | from discord.ext import commands 3 | from Commands.Info.info import NotiEmbed 4 | from Commands.plex import PlexConnection, Content, ContentEmbed 5 | from Commands.settings import Settings 6 | from Commands.logger import main_logger 7 | from EZPaginator import Paginator 8 | import random 9 | 10 | 11 | 12 | 13 | settings = Settings() 14 | 15 | 16 | 17 | class utils(commands.Cog): 18 | 19 | def __init__(self, bot): 20 | self.bot = bot 21 | 22 | @staticmethod 23 | def get_libraries_from_args(arg1: str, arg2: str = None, arg3: int = 1) -> tuple[list, int, str]: 24 | libraries_to_search = settings.command_config.args.get(arg1) 25 | 26 | query = arg2 27 | if not libraries_to_search: 28 | libraries_to_search = settings.plex_config.scanLibraries 29 | query = arg1 30 | 31 | if str(arg3).isnumeric(): 32 | amount = max(1, min(int(arg3), settings.command_config.settings.max_embed_amount)) 33 | else: 34 | amount = 1 35 | 36 | main_logger.debug(f"Libraries: {libraries_to_search}, Amount: {amount}, Query: {query}") 37 | 38 | if query is not None: 39 | return libraries_to_search, amount, query 40 | else: 41 | return libraries_to_search, amount, '' 42 | 43 | @staticmethod 44 | def random_embed(plex_con: PlexConnection, libraries: List[str], amount: int) -> list[ContentEmbed]: 45 | amount = max(1, min(amount, settings.command_config.settings.max_random_amount)) 46 | 47 | random_content_embeds = list() 48 | for _ in range(amount): 49 | all_in_library = plex_con.get_all_in_library(random.choice(libraries)) 50 | random_content = random.choice(all_in_library) 51 | random_content_object = Content(plex_con, random_content) 52 | random_content_embeds.append(ContentEmbed(random_content_object)) 53 | 54 | return random_content_embeds 55 | 56 | @staticmethod 57 | def search_library(plex_con: PlexConnection, params: tuple[list, int, str]): 58 | found = list() 59 | libraries = params[0] 60 | amount = params[1] 61 | query = params[2] 62 | for library in libraries: 63 | try: 64 | results = plex_con.library.section(library).search(query) 65 | for result in results: 66 | found.append(Content(plex_con, result)) 67 | except Exception as e: 68 | main_logger.error(f"Exception in searching for content: {e}") 69 | 70 | return found[:amount] 71 | 72 | @staticmethod 73 | async def send_error_message(ctx, error: str): 74 | main_logger.error(f"{__name__} {error}") 75 | await ctx.send(f"An error has occurred 😖: {error}", delete_after=5) 76 | await ctx.message.delete(delay=5) 77 | 78 | @commands.cooldown(rate=1, per=settings.command_config.cooldowns.search, type=commands.BucketType.member) 79 | @commands.command(aliases=Settings().command_config.aliases.search) 80 | @commands.has_permissions() 81 | async def _search(self, ctx, arg1=None, arg2=None, arg3=None): 82 | main_logger.command('search', ctx) 83 | if settings.command_config.is_visible.search: 84 | async with ctx.typing(): 85 | try: 86 | search_params = self.get_libraries_from_args(arg1, arg2, arg3) 87 | plex_con = PlexConnection() 88 | except Exception as e: 89 | await self.send_error_message(ctx, e) 90 | return 91 | 92 | search_results = self.search_library(plex_con, search_params) 93 | 94 | search_embeds = [ContentEmbed(content) for content in search_results[:3]] 95 | 96 | if len(search_results) > 3: 97 | titles = [(cont.title, cont.library) for cont in search_results[3:]] 98 | title = f"Extras:" 99 | description = '\n'.join([f'• {val[0]} - {val[1]}' for val in titles]) 100 | search_embeds.append(NotiEmbed(title=title, description=description, author=False)) 101 | 102 | if len(search_embeds) > 0: 103 | for embed in search_embeds: 104 | await ctx.send(embed=embed) 105 | main_logger.info(f'Send: {repr(embed)}') 106 | else: 107 | await ctx.send(f"** Nothing Found For: `{' '.join([str(arg1),str(arg2),str(arg3)])}`**") 108 | 109 | @commands.cooldown(rate=1, per=settings.command_config.cooldowns.random, type=commands.BucketType.member) 110 | @commands.command(aliases=settings.command_config.aliases.random) 111 | async def _random(self, ctx, arg1=None, arg2=None, arg3=None): 112 | main_logger.command('random', ctx) 113 | if settings.command_config.is_visible.random: 114 | try: 115 | arg_libs = self.get_libraries_from_args(arg1, arg2, arg3) 116 | plex_con = PlexConnection() 117 | except Exception as e: 118 | await self.send_error_message(ctx, e) 119 | return 120 | 121 | print(arg_libs) 122 | random_embeds = self.random_embed(plex_con, libraries=arg_libs[0], amount=arg_libs[1]) 123 | for embed in random_embeds: 124 | if hasattr(embed, "get_pages"): 125 | embed_list = embed.get_pages() 126 | msg = await ctx.send(embed=embed_list[0]) 127 | await Paginator(bot=self.bot, message=msg, embeds=embed_list).start() 128 | else: 129 | await ctx.send(embed=embed) 130 | main_logger.info(f'Send: {repr(embed)}') 131 | 132 | @commands.cooldown(rate=1, per=settings.command_config.cooldowns.request, type=commands.BucketType.member) 133 | @commands.command(aliases=settings.command_config.aliases.request) 134 | async def _request(self, ctx, *, request=None): 135 | main_logger.command('request', ctx) 136 | if settings.command_config.is_visible.request: 137 | if not settings.secrets.plexAdminDiscordId: 138 | await self.send_error_message(ctx, "Plex Admin Discord Id") 139 | else: 140 | if request: 141 | user = self.bot.get_user(settings.secrets.plexAdminDiscordId) 142 | embed = NotiEmbed(title="📬**Request** send for:", description=f"`{request}`", thumbnail=settings.style_config.loadingImgLink) 143 | await user.send(f'📬**Request** from **{ctx.author}**: {request}') 144 | else: 145 | embed = NotiEmbed(title="No request send") 146 | 147 | await ctx.send(embed=embed, delete_after=10) 148 | await ctx.message.delete(delay=5) 149 | main_logger.info(f'Send: {repr(embed)}') 150 | 151 | @commands.cooldown(rate=1, per=settings.command_config.cooldowns.report, type=commands.BucketType.member) 152 | @commands.command(aliases=settings.command_config.aliases.report) 153 | async def _report(self, ctx, *, report): 154 | main_logger.command('report', ctx) 155 | if settings.command_config.is_visible.report: 156 | if not settings.secrets.plexAdminDiscordId: 157 | await self.send_error_message(ctx, "Plex Admin Discord Id") 158 | else: 159 | if report: 160 | await self.bot.get_user(settings.secrets.plexAdminDiscordId).send(f'🛑 **Report** from **{ctx.author}**: {report}') 161 | embed = NotiEmbed(title="🛑 **Report** send for:", description=f"`{report}`", author=False) 162 | else: 163 | embed = NotiEmbed(title="No report send", author=False) 164 | 165 | await ctx.send(embed=embed, delete_after=10) 166 | await ctx.message.delete(delay=5) 167 | main_logger.info(f'Send: {repr(embed)}') 168 | 169 | 170 | def setup(bot): 171 | bot.add_cog(utils(bot)) 172 | -------------------------------------------------------------------------------- /Commands/config_parser.py: -------------------------------------------------------------------------------- 1 | import json 2 | 3 | 4 | class Config: 5 | def __init__(self, config_location: str): 6 | self.config_location = config_location 7 | 8 | 9 | def __getitem__(self, item): 10 | try: 11 | with open(self.config_location) as f: 12 | self.data = json.load(f) 13 | 14 | return self.data.get(item) 15 | except Exception as e: 16 | raise e 17 | -------------------------------------------------------------------------------- /Commands/logger.py: -------------------------------------------------------------------------------- 1 | import logging 2 | import os 3 | from logging.handlers import RotatingFileHandler 4 | from Commands.settings import Settings 5 | import datetime 6 | 7 | 8 | class Logger(logging.Logger): 9 | def __init__(self): 10 | super().__init__(__name__) 11 | self.settings = Settings() 12 | self.setLevel(self.settings.general_config.log_level) 13 | log_formatter = logging.Formatter(self.settings.general_config.log_format) 14 | self.date = datetime.datetime.now().strftime("%d-%m-%Y_%H-%M-%S") 15 | 16 | 17 | if not os.path.exists("data/logs/"): 18 | os.makedirs("data/logs/") 19 | 20 | file_handler = RotatingFileHandler(f"data/logs/plexy_{self.date}.log", mode='a', maxBytes=50000000, backupCount=5) 21 | file_handler.setFormatter(log_formatter) 22 | self.addHandler(file_handler) 23 | 24 | console_handler = logging.StreamHandler() 25 | console_handler.setFormatter(log_formatter) 26 | self.addHandler(console_handler) 27 | 28 | def command(self, command: str, ctx): 29 | self.info(f"{command} command by {ctx.author.name}#{ctx.author.discriminator}") 30 | 31 | 32 | main_logger = Logger() 33 | -------------------------------------------------------------------------------- /Commands/plex.py: -------------------------------------------------------------------------------- 1 | from discord.embeds import Embed 2 | from plexapi.server import PlexServer 3 | from Commands.settings import Settings 4 | import discord 5 | from Commands.logger import main_logger 6 | import urllib.parse 7 | 8 | 9 | class PlexConnection(PlexServer): 10 | 11 | def __init__(self): 12 | self.__bot_settings = Settings() 13 | self.__base_url = self.__bot_settings.secrets.plexBaseUrl 14 | self.__plex_token = self.__bot_settings.secrets.plexToken 15 | self.__content_url = self.__bot_settings.secrets.contentUrl 16 | self.__scan_libraries = self.__bot_settings.plex_config.scanLibraries 17 | 18 | 19 | if not self.__base_url: 20 | raise Exception("plexBaseUrl") 21 | elif not self.__plex_token: 22 | raise Exception("plexToken") 23 | elif not self.__content_url: 24 | raise Exception("contentUrl") 25 | else: 26 | try: 27 | super().__init__(self.__base_url, self.__plex_token) 28 | self.title = self.friendlyName 29 | self.server_name = self.friendlyName 30 | except Exception as e: 31 | main_logger.error(f"Failed plex api connection") 32 | raise e 33 | 34 | 35 | def get_new_content(self) -> list: 36 | new_content = list() 37 | main_logger.info('Getting new Content') 38 | try: 39 | for library in self.__scan_libraries: 40 | 41 | recently_added = [Content(self, content) for content in self.library.section(library).recentlyAdded(maxresults=40)] 42 | 43 | # Sorts the list of recently_added items by name and index (Example Show01e02) 44 | recently_added.sort(key=lambda sort_func: str(sort_func.title) + str(sort_func.index)) 45 | seen = set() 46 | # Adds library list of new content to overall new content list 47 | # Checks if multiple of a show got added (Aka season) and filters them out 48 | # so there wont be 10 messages if you add 10 new episodes of a show 49 | 50 | new_content.extend([content for content in recently_added if content.title not in seen and not seen.add(content.title)]) 51 | return new_content 52 | except Exception as e: 53 | main_logger.error(f"Exception in getting new content: {e}") 54 | return new_content 55 | 56 | def get_all_in_library(self, lib): 57 | main_logger.debug(f"Got all from: {lib}") 58 | return self.library.section(lib).all() 59 | 60 | 61 | 62 | 63 | class Content: 64 | def __init__(self, plex_connection: PlexConnection, content, send: bool = False) -> None: 65 | self.content = content 66 | self.plex_connection = plex_connection 67 | self.type = self.content.type 68 | self.library = self.content.librarySectionTitle 69 | self.key = self.content.key 70 | self.send = 1 if send else 0 71 | self.settings = Settings() 72 | self.image_link = Embed.Empty 73 | 74 | if self.content.type == "episode": 75 | self.index = self.content.seasonEpisode 76 | self.title = self.content.grandparentTitle 77 | 78 | 79 | if self.content.parentThumb and not self.settings.general_config.safe_mode: 80 | self.image_link = f"{self.settings.secrets.plexBaseUrl}{self.content.parentThumb}?X-Plex-Token={self.settings.secrets.plexToken}" 81 | else: 82 | self.index = self.content.type.capitalize() 83 | self.title = self.content.title 84 | 85 | if not self.settings.general_config.safe_mode: 86 | self.image_link = self.content.thumbUrl 87 | 88 | self.content_link = self._get_content_link() 89 | main_logger.debug(f"Content -> {self.__repr__()}") 90 | 91 | def _get_content_link(self) -> str: 92 | return f"{self.settings.secrets.contentUrl}details?key={self.content.key}&context=library%3Acontent.library" 93 | 94 | 95 | 96 | def __repr__(self): 97 | return f"" 98 | 99 | 100 | class ContentEmbed(discord.Embed): 101 | def __init__(self, content): 102 | super().__init__() 103 | self.settings = Settings() 104 | 105 | self.title = content.title 106 | self.description = content.content.summary if content.content.summary else discord.Embed.Empty 107 | self.color = self.settings.style_config.newContentEmbedColor 108 | self.content = content 109 | 110 | if self.settings.general_config.safe_mode: 111 | self.url = f"https://app.plex.tv/desktop/#!/search?query={urllib.parse.quote(content.title)}" 112 | else: 113 | self.url = self.content.content_link 114 | 115 | self.set_author(name="Plexy", icon_url=self.settings.style_config.iconLink, url=self.url) 116 | self.set_thumbnail(url=self.content.image_link) 117 | self.set_fields() 118 | main_logger.debug(self.__repr__()) 119 | 120 | def set_fields(self): 121 | self.add_field(name="Type", value=self.content.library.capitalize(), inline=True) 122 | 123 | if self.content.type == "show": 124 | self.add_field(name="Episodes", value=str( 125 | len(self.content.content.episodes())), inline=True) 126 | 127 | def first_page(self): 128 | self.description = discord.Embed.Empty 129 | self.set_thumbnail(url=discord.Embed.Empty) 130 | self.set_image(url=self.content.image_link) 131 | self.set_footer(text="Next page for summary", icon_url=discord.Embed.Empty) 132 | return self 133 | 134 | def second_page(self): 135 | self.description = self.content.content.summary 136 | self.set_thumbnail(url=self.content.image_link) 137 | self.set_footer(text=discord.Embed.Empty, icon_url=discord.Embed.Empty) 138 | return self 139 | 140 | def get_pages(self): 141 | pages = [self.first_page(), ContentEmbed(self.content).second_page()] 142 | main_logger.debug(pages) 143 | return pages 144 | 145 | def __repr__(self): 146 | return f"" 147 | -------------------------------------------------------------------------------- /Commands/settings.py: -------------------------------------------------------------------------------- 1 | from typing import List 2 | from Commands.config_parser import Config 3 | import os 4 | import shutil 5 | 6 | 7 | def move(source: str, dest: str): 8 | if os.path.exists(dest): 9 | os.remove(dest) 10 | shutil.copyfile(source, dest) 11 | 12 | 13 | class StyleConfig: 14 | def __init__(self, json: dict): 15 | self.iconLink: str = json.get('iconLink') 16 | self.defaultThumbLink: str = json.get('defaultThumbLink') 17 | self.loadingImgLink: str = json.get('loadingImgLink') 18 | self.requestImgLink: str = json.get('requestImgLink') 19 | self.infoThumbLink: str = json.get('infoThumbLink') 20 | self.defaultEmbedColor = eval(json.get('defaultEmbedColor').replace("#", "0x")) 21 | self.helpEmbedColor = eval(json.get('helpEmbedColor').replace("#", "0x")) 22 | self.newContentEmbedColor = eval(json.get('newContentEmbedColor').replace("#", "0x")) 23 | 24 | 25 | class PlexConfig: 26 | def __init__(self, json: dict): 27 | self.refreshTime: int = int(json.get('refreshTime')) 28 | self.scanLibraries: List[str] = json.get('scanLibraries') 29 | self.allLibraries: List[str] = json.get('allLibraries') 30 | self.max_recently_added: int = json.get('max-recently-added') 31 | 32 | 33 | class GeneralConfig: 34 | def __init__(self, json: dict): 35 | self.prefix: List[str] = json.get('prefix') 36 | self.safe_mode: bool = json.get('safe-mode') 37 | self.log_level: str = json.get('log-level') 38 | self.log_format: str = json.get('log-format') 39 | self.backup_hour_interval: int = json.get('backup-hour-interval') 40 | 41 | 42 | class CommandConfig: 43 | class __Aliases: 44 | def __init__(self, json: dict): 45 | self.ping: List[str] = json.get('ping') 46 | self.info: List[str] = json.get('info') 47 | self.summary: List[str] = json.get('summary') 48 | self.search: List[str] = json.get('search') 49 | self.random: List[str] = json.get('random') 50 | self.request: List[str] = json.get('request') 51 | self.report: List[str] = json.get('report') 52 | self.dashboard: List[str] = json.get('dashboard') 53 | self.libraries: List[str] = json.get('libraries') 54 | self.flags: List[str] = json.get('flags') 55 | 56 | 57 | class __IsEnabled: 58 | def __init__(self, json: dict): 59 | self.help: bool = json.get('help') 60 | self.ping: bool = json.get('ping') 61 | self.info: bool = json.get('info') 62 | self.summary: bool = json.get('summary') 63 | self.search: bool = json.get('search') 64 | self.random: bool = json.get('random') 65 | self.request: bool = json.get('request') 66 | self.report: bool = json.get('report') 67 | self.dashboard: bool = json.get('dashboard') 68 | self.libraries: bool = json.get('libraries') 69 | self.flags: bool = json.get('flags') 70 | 71 | 72 | class __CommandSettings: 73 | def __init__(self, json: dict): 74 | self.max_random_amount: int = json.get('max-random-amount') 75 | self.max_search_amount: int = json.get('max-search-amount') 76 | self.max_summary_amount: int = json.get('max-summary-amount') 77 | self.max_embed_amount: int = json.get('max-embed-amount') 78 | 79 | 80 | class __Cooldowns: 81 | def __init__(self, json: dict) -> None: 82 | self.help: int = json.get('help') 83 | self.ping: int = json.get('ping') 84 | self.info: int = json.get('info') 85 | self.summary: int = json.get('summary') 86 | self.search: int = json.get('search') 87 | self.random: int = json.get('random') 88 | self.request: int = json.get('request') 89 | self.report: int = json.get('report') 90 | self.dashboard: int = json.get('dashboard') 91 | self.libraries: int = json.get('libraries') 92 | self.flags: int = json.get('flags') 93 | 94 | 95 | def __init__(self, json: dict): 96 | self.aliases = self.__Aliases(json.get('aliases')) 97 | self.is_visible = self.__IsEnabled(json.get('is_enabled')) 98 | self.settings = self.__CommandSettings(json.get('settings')) 99 | self.cooldowns = self.__Cooldowns(json.get('cooldowns')) 100 | self.args: dict[str, List[str]] = json.get('args') 101 | 102 | 103 | class Secrets: 104 | def __init__(self, json: dict): 105 | self.bot_token: str = json['bot_token'] 106 | self.notificationsChannelId: int = json['notificationsChannelId'] 107 | self.plexAdminDiscordId: int = json['plexAdminDiscordId'] 108 | self.plexBaseUrl: str = json['plexBaseUrl'] 109 | self.plexToken: str = json['plexToken'] 110 | self.contentUrl: str = json['contentUrl'] 111 | 112 | 113 | class Settings: 114 | def __init__(self): 115 | self.config_path = 'configs/config.json' 116 | self.secrets_path = 'configs/secrets.json' 117 | self.help_path = 'configs/help_config.json' 118 | self.database_path = 'data/content_database.sqlite' 119 | 120 | self.__config: Config = Config(self.config_path) 121 | self.__secrets: Config = Config(self.secrets_path) 122 | 123 | self.plex_config = PlexConfig(self.__config['plex_config']) 124 | self.general_config = GeneralConfig(self.__config['general_config']) 125 | self.style_config = StyleConfig(self.__config['style_config']) 126 | self.command_config = CommandConfig(self.__config['command_config']) 127 | self.secrets = Secrets(self.__secrets) 128 | 129 | def is_valid(self): 130 | return os.path.exists(self.config_path) and os.path.exists(self.secrets_path) 131 | 132 | def backup(self): 133 | if not os.path.exists("data/backup/"): 134 | os.makedirs('data/backup/') 135 | 136 | move(self.config_path, 'data/backup/backup_config.json') 137 | move(self.secrets_path, 'data/backup/backup_secrets.json') 138 | move(self.help_path, 'data/backup/backup_help_config.json') 139 | move(self.database_path, 'data/backup/backup_content_database.sqlite') -------------------------------------------------------------------------------- /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 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 |
2 | 3 |
4 |

Plexy connects your plex server to your discord server. 5 | By sending messages to a certain discord channel when new content is added. 6 | And enabling users to look trough and get info about the plex server. 7 |

8 |
9 | Support 10 |
11 |
12 |
13 | GitHub issues 14 | GitHub forks 15 | Sponsor Link 16 | GitHub stars 17 | GitHub license 18 |
19 | 20 | --- 21 | 22 |
23 | 24 |
25 | 26 | --- 27 | 28 | # Features ✨ 29 | 30 | Plexy is a one of a kind discord bot 31 | 32 | - Easy to use ⚒️ 33 | - Easy to configure ⚙️ 34 | - Customizable 📐 35 | - Two different modes 36 | 37 | --- 38 | 39 | ## How to use Plexy 🤖 40 | 41 | ### Requirements 📜 42 | 43 | - [Python](https://www.python.org/downloads/) 3.6 or Higher (I used 3.9) 44 | - A Plex admin account 45 | - Discord account 46 | - [Latest release](https://github.com/CecilioSilva/Plexy/releases/latest) 47 | 48 | --- 49 | 50 | ##### 1. Make your own discord bot 51 | 52 | First go to the [Discord Developer Portal](https://discord.com/developers/applications/) 53 | login with your discord account 54 | press `new application` 55 | type the application name and press `Create` 56 | set your application/bot icon and description/about me 57 | choose form the navbar in the left `Bot` option 58 | press `add bot` and `yes, do it!` 59 | 60 | ##### 2. make sure you have [Python 3.6 or higher](https://www.python.org/downloads/) installed 61 | 62 | ##### 3. Download [latest release](https://github.com/CecilioSilva/Plexy/releases/latest) 63 | 64 | ##### 4. Login to plex with an admin account 65 | 66 | ##### 5. Unzip the source files and locate `configs/secrets.example.json` it should look like this: 67 | 68 | ```json 69 | { 70 | "bot_token": "", 71 | "notificationsChannelId": 1000000000000000000, 72 | "plexAdminDiscordId": 1000000000000000000, 73 | "plexBaseUrl": "", 74 | "plexToken": "", 75 | "contentUrl": "" 76 | } 77 | ``` 78 | 79 | - `bot_token` → The discord bot token you can find in the [Discord developer portal](https://discord.com/developers/applications/) 80 | - `notificationChannelid` → Go to discord client `Settings` > `Advanced` > `Developer Mode` and enable it. Then go to the channel you want the new content notifications and right click it and `Copy ID` 81 | - `plexAdminDiscordId` → Do the same as `notificationChannelid` but select the discord user you that controls the plex server 82 | - `plexBaseUrl` → Go to [Plex](https://www.plex.tv/) and open the dashboard. goto `Settings` > `Remote Access` if plex server is on the same system as the bot use `http://localhost:32400/`, otherwise use the public ip and port 83 | - `plexToken` → See [Finding an authentication token / X-Plex-Token](https://support.plex.tv/articles/204059436-finding-an-authentication-token-x-plex-token/) 84 | - `contentUrl` → Go to the [Plex](https://www.plex.tv/) Dashboard and open a media item. then in the address-bar copy everything until `/details` 85 | ![Content-url](https://i.imgur.com/iL1Bl6S.png) 86 | 87 | ##### 6. Rename the file to `secrets.json` 88 | 89 | ##### 7. Open `configs/config.example.json` 90 | 91 | ```json 92 | "plex_config": { 93 | "refreshTime": 15, 94 | "max-recently-added": 20, 95 | "scanLibraries": ["TV Shows", "Movies", "Anime"], 96 | "allLibraries": ["Anime", "Movies", "Home videos", "TV Shows"] 97 | } 98 | ``` 99 | 100 | - `scanLibraries` → Are all the libraries Plexy searches for new content 101 | - `allLibraries` → All the libraries you want plexy to see 102 | 103 | ```json 104 | "args": { 105 | "-all": ["Anime", "Movies", "TV Shows"], 106 | "-movie": ["Movies"], 107 | "-m": ["Movies"], 108 | "-show": ["TV Shows"], 109 | "-s": ["TV Shows"], 110 | "-anime": ["Anime"], 111 | "-a": ["Anime"], 112 | "-h": ["Home videos"], 113 | "-videos": ["Videos"], 114 | "-v": ["Videos"] 115 | } 116 | ``` 117 | 118 | These are all the flags users can use to filter for libraries 119 | you can add and remove any flag you want 120 | 121 | #### 8. Choose if you want safe mode or not 122 | 123 | | :exclamation: This is very important | 124 | | ------------------------------------ | 125 | 126 | ```json 127 | "general_config" : { 128 | "safe-mode": true 129 | } 130 | ``` 131 | 132 | **🛑 Plexy uses the plex token to get media assets from the plex server. 133 | But that exposes the plex token you have set to everybody in the discord server/channel. 🛑** 134 | 135 | #### 9. Rename the file to `config.json` 136 | 137 | --- 138 | 139 | ## Run The Project 🌀 140 | 141 | To run the project 142 | 143 | 0. (Optional) Make a [virtual environment](https://docs.python.org/3/library/venv.html) 144 | 1. Install all the dependencies 145 | 146 | ```commandline 147 | pip install -r requirements.txt 148 | ``` 149 | 150 | 2. Run the bot 151 | ```commandline 152 | python Bot.py 153 | ``` 154 | 155 | ## Sponsor 156 | 157 | Plexy is free and will always be free to use. I did spend a lot of time on creating it. 158 | So any donations are welcome but of course not required. (˵ ͡° ͜ʖ ͡°˵) 159 | 160 | [![Sponsor Link](https://img.shields.io/badge/Ko--fi-F16061?style=for-the-badge&logo=ko-fi&logoColor=white)](https://ko-fi.com/gamingismyfood) 161 | 162 | ## Future plans 163 | 164 | - I have some plans to document the code better 165 | - Also planning to change the bot to discord slash commands 166 | - Find a different way to get media assets without plex token 167 | 168 | ## Issues/Bugs 169 | 170 | if you find any issues please create a new issue with logs and details what went wrong. 171 | 172 | ## Contributing 173 | 174 | Contributions are always welcome! 175 | 176 | ## License 177 | 178 | Copyright 2021 Cecilio Silva Monteiro 179 | 180 | Licensed under the GNU General Public License v3.0 (the "License"); 181 | you may not use this file except in compliance with the License. 182 | You may obtain a copy of the License at 183 | 184 | https://www.gnu.org/licenses/gpl-3.0-standalone.html 185 | 186 | Unless required by applicable law or agreed to in writing, software 187 | distributed under the License is distributed on an "AS IS" BASIS, 188 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 189 | See the License for the specific language governing permissions and 190 | limitations under the License. 191 | 192 | # Made by 🧑🏾‍💻 193 | 194 | [@CecilioSilva](https://github.com/CecilioSilva) 195 | -------------------------------------------------------------------------------- /READ_FIRST.txt: -------------------------------------------------------------------------------- 1 | How to use plexy: 2 | 3 | Requirements: 4 | 1. Python 3.6 or Higher (3.9 recommended) 5 | 2. Plex admin account 6 | 3. Discord account 7 | 8 | Steps: 9 | 10 | 1. Make a bot account in the discord developer portal. 11 | 12 | 2. Make sure you have python installed and pip is working. 13 | 14 | 3. Open "secrets.example.json" and fill in every field (for more info look at git repo). 15 | 16 | 4. Save and rename "secrets.example.json" to "secrets.json". 17 | 18 | 5. Open "config.example.json" and change "scanLibraries", "allLibraries", "args" to your Plex library names. 19 | 20 | 6. *IMPORTANT* "safe_mode" if "true" Plexy uses the plex token to get media assets from the plex server. 21 | But that exposes the plex token you have set to everybody in the discord server/channel. 22 | 23 | 7. Change any other settings you want and Save and rename "config.example.json" to "config.json". 24 | 25 | 8. (OPTIONAL) make a virtual enviorment 26 | 27 | 8.1 Use `pip install -r requirements.txt` to install all dependencies 28 | 29 | 9. Use `python Bot.py` to run the bot 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | Copyright 2021 Cecilio Silva Monteiro 40 | 41 | Licensed under the GNU General Public License v3.0 (the "License"); 42 | you may not use this file except in compliance with the License. 43 | You may obtain a copy of the License at 44 | 45 | https://www.gnu.org/licenses/gpl-3.0-standalone.html 46 | 47 | Unless required by applicable law or agreed to in writing, software 48 | distributed under the License is distributed on an "AS IS" BASIS, 49 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 50 | See the License for the specific language governing permissions and 51 | limitations under the License. -------------------------------------------------------------------------------- /configs/config.example.json: -------------------------------------------------------------------------------- 1 | { 2 | "general_config": { 3 | "prefix": ["p!"], 4 | "safe-mode": true, 5 | "log-level": "DEBUG", 6 | "log-format": "%(asctime)s [%(levelname)-5.5s] %(message)s", 7 | "backup-hour-interval": 12 8 | }, 9 | "plex_config": { 10 | "refreshTime": 15, 11 | "max-recently-added": 20, 12 | "scanLibraries": ["TV Shows", "Movies", "Anime"], 13 | "allLibraries": ["Anime", "Movies", "Home videos", "TV Shows"] 14 | }, 15 | "style_config": { 16 | "iconLink": "https://i.imgur.com/sxfp0vX.png", 17 | "defaultThumbLink": "https://i.imgur.com/sjaGBhh.jpg", 18 | "loadingImgLink": "https://i.imgur.com/k52y1hX.gif", 19 | "requestImgLink": "https://i.imgur.com/En1iCo9.gif", 20 | "infoThumbLink": "https://i.imgur.com/6yQjpVm.png", 21 | "defaultEmbedColor": "#ff6500", 22 | "helpEmbedColor": "#ff8800", 23 | "newContentEmbedColor": "#ff5200" 24 | }, 25 | "command_config": { 26 | "aliases": { 27 | "ping": ["ping", "lat", "pong"], 28 | "info": ["info", "i", "inf", "plex"], 29 | "summary": ["summary", "sum", "sm"], 30 | "search": ["search", "s", "get", "sr"], 31 | "random": ["random", "ran", "r", "rnd"], 32 | "request": ["request", "req", "ls"], 33 | "report": ["report", "rep", "prob", "problem"], 34 | "dashboard": ["dashboard", "dash"], 35 | "libraries": ["libraries", "lib", "libs"], 36 | "flags": ["flags", "fl", "flg", "args", "f"] 37 | }, 38 | "is_enabled": { 39 | "help": true, 40 | "ping": true, 41 | "info": true, 42 | "summary": true, 43 | "search": true, 44 | "random": true, 45 | "request": true, 46 | "report": true, 47 | "dashboard": true, 48 | "libraries": true, 49 | "flags": true 50 | }, 51 | "args": { 52 | "-all": ["Anime", "Movies", "TV Shows"], 53 | "-movie": ["Movies"], 54 | "-m": ["Movies"], 55 | "-show": ["TV Shows"], 56 | "-s": ["TV Shows"], 57 | "-anime": ["Anime"], 58 | "-a": ["Anime"], 59 | "-h": ["Home videos"], 60 | "-videos": ["Videos"], 61 | "-v": ["Videos"] 62 | }, 63 | "settings": { 64 | "max-embed-amount": 10, 65 | "max-random-amount": 1, 66 | "max-search-amount": 5, 67 | "max-summary-amount": 5 68 | }, 69 | "cooldowns": { 70 | "help": 0, 71 | "ping": 0, 72 | "info": 30, 73 | "summary": 30, 74 | "search": 15, 75 | "random": 15, 76 | "request": 0, 77 | "report": 0, 78 | "dashboard": 0, 79 | "libraries": 0, 80 | "flags": 0 81 | } 82 | } 83 | } 84 | -------------------------------------------------------------------------------- /configs/help_config.json: -------------------------------------------------------------------------------- 1 | [ 2 | { 3 | "field": "help", 4 | "content": { 5 | "help": "sends help message", 6 | "help -c": "sends help message in channel", 7 | "help command": "sends help message about a command" 8 | }, 9 | "aliases": ["help"], 10 | "description": "Command to display the help message\nAdd an other command after it and it will return a specific help message " 11 | }, 12 | { 13 | "field": "ping", 14 | "content": { 15 | "ping": "pings the bot" 16 | }, 17 | "aliases": ["ping", "lat", "pong"], 18 | "description": "Command pings the bot\nReturns the latency of the bot in ms" 19 | }, 20 | { 21 | "field": "info", 22 | "content": { 23 | "info": "get info about the plex server (Don't call it to often)", 24 | "info -a": "get all info about the plex server (Don't call it to often)" 25 | }, 26 | "aliases": ["info", "i", "inf", "plex"], 27 | "description": "Returns an info message about the server.\nWith server status, content count and more" 28 | }, 29 | { 30 | "field": "libraries", 31 | "content": { 32 | "libraries": "get plex server libraries", 33 | "libraries -a": "get all plex server libraries" 34 | }, 35 | "aliases": ["libraries", "lib", "libs"], 36 | "description": "Returns a message about the libraries in the plex server." 37 | }, 38 | { 39 | "field": "summary", 40 | "content": { 41 | "summary": "get a summary from recently added content" 42 | }, 43 | "aliases": ["summary", "sum", "sm"], 44 | "description": "Returns an summary of latest added content per library" 45 | }, 46 | { 47 | "field": "search", 48 | "content": { 49 | "search": "search the whole server for safe content", 50 | "search -flag": "search a certain group of libraries", 51 | "Tip": "if search is more than one word wrap in`\" \"`" 52 | }, 53 | "aliases": ["search", "s", "get", "sr"], 54 | "description": "Searches the plex server for content with the give parameter\nTo search for more than one word wrap it in `\" \"`\nYou can add a filter with the flags" 55 | }, 56 | { 57 | "field": "random", 58 | "content": { 59 | "random": "to get a random entry in plex", 60 | "random -flag": "to get a random entry from a library in plex" 61 | }, 62 | "aliases": ["random", "ran", "r", "rnd"], 63 | "description": "Get a random piece of content from the plex server\nTo get a certain kind of content use the flags" 64 | }, 65 | { 66 | "field": "request", 67 | "content": { 68 | "request": "request new content" 69 | }, 70 | "aliases": ["request", "req", "ls"], 71 | "description": "Request the plex server admin for new content\nSends private message to te server admin" 72 | }, 73 | { 74 | "field": "report", 75 | "content": { 76 | "report": "Report a problem with the server or bot" 77 | }, 78 | "aliases": ["report", "rep", "problem", "prob"], 79 | "description": "Report a problem with the plex server or bot\nSends private message to te server admin" 80 | }, 81 | { 82 | "field": "support", 83 | "content": { 84 | "support": "Support the developer command" 85 | }, 86 | "aliases": ["support", "sup", "hero", "dev"], 87 | "description": "Sends an embed with developer support link" 88 | }, 89 | { 90 | "field": "flags", 91 | "content": { 92 | "flags": "See all available flags" 93 | }, 94 | "aliases": ["flags", "fl", "flg", "args"], 95 | "description": "Sends an embed all available flags" 96 | } 97 | ] 98 | -------------------------------------------------------------------------------- /configs/secrets.example.json: -------------------------------------------------------------------------------- 1 | { 2 | "bot_token": "", 3 | "notificationsChannelId": 1000000000000000000, 4 | "plexAdminDiscordId": 1000000000000000000, 5 | "plexBaseUrl": "", 6 | "plexToken": "", 7 | "contentUrl": "" 8 | } 9 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | discord.py==1.7.3 2 | EZPaginator==1.3.4 3 | PlexAPI==4.6.1 --------------------------------------------------------------------------------