Added config property display.posters.fit, release v2.12.0

Author: phin05

.github/release-notes/v2.12.0.md

@@ -0,0 +1,8 @@
+### Release Notes
+
+- Added config property `display.posters.fit` to make posters fit inside a square while maintaining the original aspect ratio. This is set to `true` by default. Otherwise, Discord crops posters into a square.
+
+### Installation Instructions
+
+- [Regular](https://github.com/phin05/discord-rich-presence-plex/blob/v2.12.0/README.md#installation)
+- [Docker](https://github.com/phin05/discord-rich-presence-plex/blob/v2.12.0/README.md#run-with-docker)

README.md

@@ -36,20 +36,21 @@ The config file is stored in a directory named `data`.
   - `debug` (boolean, default: `true`) - Outputs additional debug-helpful information to the console.
   - `writeToFile` (boolean, default: `false`) - Writes console output to a `console.log` file in the `data` directory.
 - `display` - Display settings for Rich Presence
-  - `duration` (boolean, default: `true`) - Displays the total duration. Applicable to movies and TV shows only.
+  - `duration` (boolean, default: `false`) - Displays the total duration. Applicable to movies and TV shows only.
   - `genres` (boolean, default: `true`) - Displays the genre. Applicable to movies only.
   - `album` (boolean, default: `true`) - Displays the album name. Applicable to music only.
   - `albumImage` (boolean, default: `true`) - Displays the album image. Applicable to music only.
   - `artist` (boolean, default: `true`) - Displays the artist name. Applicable to music only.
   - `artistImage` (boolean, default: `true`) - Displays the artist image. Applicable to music only.
   - `year` (boolean, default: `true`) - Displays the release year.
-  - `statusIcon` (boolean, default: `false`) - Displays a status icon (playing, paused, buffering) at the bottom-right corner of the poster. Applicable to movies and TV shows only. Posters get cropped to a square if this is enabled (Discord bug/limitation).
+  - `statusIcon` (boolean, default: `false`) - Displays a status icon (playing, paused, buffering) at the bottom-right corner of the poster. Applicable to movies and TV shows only.
   - `progressMode` (string, default: `bar`) - Progress/timestamp display mode. Valid modes are `off`, `elapsed` (displays elapsed time), `remaining` (displays remaining time) and `bar` (displays a progress bar). The `off` and `remaining` modes are currently broken due to a Discord bug/limitation.
   - `paused` (boolean, default: `false`) - Displays Rich Presence even while media is paused. Progress/timestamp display while paused is currently broken due to a Discord bug/limitation.
   - `posters`
     - `enabled` (boolean, default: `false`) - Displays media posters (including album art and artist images). Requires `imgurClientID`.
     - `imgurClientID` (string, default: `""`) - [Obtention Instructions](#obtaining-an-imgur-client-id)
     - `maxSize` (int, default: `256`) - Maximum width and maximum height to use while downscaling posters before uploading them.
+    - `fit` (boolean, default: `true`) - Fits posters inside a square while maintaining the original aspect ratio. Otherwise, Discord crops posters into a square.
   - `buttons` (list) - [Information](#buttons)
     - `label` (string) - The label to be displayed on the button.
     - `url` (string) - A web address or a [dynamic URL placeholder](#dynamic-button-urls).
@@ -95,9 +96,12 @@ logging:
   debug: true
   writeToFile: false
 display:
-  duration: true
+  duration: false
   genres: true
   album: true
+  albumImage: true
+  artist: true
+  artistImage: true
   year: true
   statusIcon: false
   progressMode: bar
@@ -106,6 +110,7 @@ display:
     enabled: true
     imgurClientID: 9e9sf637S8bRp4z
     maxSize: 256
+    fit: true
   buttons:
     - label: "{title} on IMDb"
       url: dynamic:imdb

config/constants.py

@@ -2,7 +2,7 @@
 import sys
 
 name = "Discord Rich Presence for Plex"
-version = "2.11.0"
+version = "2.12.0"
 
 plexClientID = "discord-rich-presence-plex"
 discordClientID = "413407336082833418"

core/config.py

@@ -4,7 +4,7 @@
 import json
 import models.config
 import os
-import time
+import sys
 import yaml
 
 config: models.config.Config = {
@@ -13,7 +13,7 @@
 		"writeToFile": False,
 	},
 	"display": {
-		"duration": True,
+		"duration": False,
 		"genres": True,
 		"album": True,
 		"albumImage": True,
@@ -27,6 +27,7 @@
 			"enabled": False,
 			"imgurClientID": "",
 			"maxSize": 256,
+			"fit": True,
 		},
 		"buttons": [],
 	},
@@ -61,8 +62,8 @@ def loadConfig() -> None:
 				else:
 					loadedConfig = json.load(configFile) or {} # pyright: ignore[reportUnknownVariableType]
 		except:
-			os.rename(configFilePath, f"{configFilePathBase}-{time.time():.0f}.{configFileExtension}")
-			logger.exception("Failed to parse the config file. A new one will be created.")
+			logger.exception("Failed to parse the config file")
+			sys.exit(1)
 		else:
 			copyDict(loadedConfig, config)
 		if "hideTotalTime" in config["display"]:

core/imgur.py

@@ -1,5 +1,5 @@
 from .config import config
-from PIL import Image
+from PIL import Image, ImageOps
 from typing import Optional
 from utils.logging import logger
 import io
@@ -9,14 +9,17 @@
 def uploadToImgur(url: str) -> Optional[str]:
 	try:
 		originalImageBytesIO = io.BytesIO(requests.get(url).content)
-		originalImage = Image.open(originalImageBytesIO).convert("RGB")
-		newImage = Image.new("RGB", originalImage.size)
+		originalImage = Image.open(originalImageBytesIO).convert("RGBA")
+		newImage = Image.new("RGBA", originalImage.size)
 		newImage.putdata(originalImage.getdata()) # pyright: ignore[reportArgumentType]
+		if newImage.width != newImage.height and config["display"]["posters"]["fit"]:
+			longestSideLength = max(newImage.width, newImage.height)
+			newImage = ImageOps.pad(newImage, (longestSideLength, longestSideLength), color = (0, 0, 0, 0))
 		maxSize = config["display"]["posters"]["maxSize"]
 		if maxSize:
 			newImage.thumbnail((maxSize, maxSize))
 		newImageBytesIO = io.BytesIO()
-		newImage.save(newImageBytesIO, subsampling = 0, quality = 90, format = "JPEG")
+		newImage.save(newImageBytesIO, subsampling = 0, quality = 90, format = "PNG")
 		response = requests.post(
 			"https://api.imgur.com/3/image",
 			headers = { "Authorization": f"Client-ID {config['display']['posters']['imgurClientID']}" },

main.py

@@ -1,11 +1,12 @@
 from config.constants import isInContainer, runtimeDirectory, uid, gid, containerCwd, noRuntimeDirChown
 from utils.logging import logger
 import os
+import sys
 
 if isInContainer:
 	if not os.path.isdir(runtimeDirectory):
 		logger.error(f"Runtime directory does not exist. Ensure that it is mounted into the container at {runtimeDirectory}")
-		exit(1)
+		sys.exit(1)
 	if os.geteuid() == 0: # pyright: ignore[reportAttributeAccessIssue,reportUnknownMemberType]
 		if uid == -1 or gid == -1:
 			logger.warning(f"Environment variable(s) DRPP_UID and/or DRPP_GID are/is not set. Manually ensure appropriate ownership of {runtimeDirectory}")
@@ -24,7 +25,6 @@
 		logger.warning("Not running as the superuser. Manually ensure appropriate ownership of mounted contents")
 
 from config.constants import noPipInstall
-import sys
 
 if not noPipInstall:
 	try:
@@ -40,13 +40,15 @@ def parsePipPackages(packagesStr: str) -> dict[str, str]:
 			if installedPackageVersion != requiredPackageVersion:
 				logger.info(f"Installing dependency: {packageName} (required: {requiredPackageVersion}, installed: {installedPackageVersion})")
 				subprocess.run([sys.executable, "-m", "pip", "install", "-U", f"{packageName}=={requiredPackageVersion}"], check = True)
-	except Exception as e:
+	except:
 		logger.exception("An unexpected error occured during automatic installation of dependencies. Install them manually by running the following command: python -m pip install -U -r requirements.txt")
 
 from config.constants import dataDirectoryPath, logFilePath, name, version, isInteractive, plexServerNameInput
 from core.config import config, loadConfig, saveConfig
 from core.discord import DiscordIpcService
+from core.imgur import uploadToImgur
 from core.plex import PlexAlertListener, initiateAuth, getAuthToken
+from models.discord import ActivityType
 from typing import Optional
 from utils.cache import loadCache
 from utils.logging import formatter
@@ -76,7 +78,7 @@ def main() -> None:
 		logger.info("No users found in the config file")
 		user = authNewUser()
 		if not user:
-			exit(1)
+			sys.exit(1)
 		config["users"].append(user)
 		saveConfig()
 	plexAlertListeners = [PlexAlertListener(user["token"], server) for user in config["users"] for server in user["servers"]]
@@ -125,17 +127,29 @@ def authNewUser() -> Optional[models.config.User]:
 def testIpc(pipeNumber: int) -> None:
 	init()
 	logger.info("Testing Discord IPC connection")
+	currentTimestamp = int(time.time() * 1000)
 	discordIpcService = DiscordIpcService(pipeNumber)
 	discordIpcService.connect()
 	discordIpcService.setActivity({
+		"type": ActivityType.WATCHING,
 		"details": "details",
 		"state": "state",
 		"assets": {
 			"large_text": "large_text",
-			"large_image": "logo",
+			"large_image": uploadToImgur("https://placehold.co/256x256/EEE/333.png") or "large_text",
 			"small_text": "small_text",
 			"small_image": "playing",
 		},
+		"timestamps": {
+			"start": currentTimestamp,
+			"end": currentTimestamp + 15000,
+		},
+		"buttons": [
+			{
+				"label": "Label",
+				"url": "https://placehold.co/"
+			},
+		],
 	})
 	time.sleep(15)
 	discordIpcService.disconnect()

models/config.py

@@ -8,6 +8,7 @@ class Posters(TypedDict):
 	enabled: bool
 	imgurClientID: str
 	maxSize: int
+	fit: bool
 
 class Button(TypedDict):
 	label: str