Merge pull request #410 from wizarrrr/beta

v4.1
wizarrrr · May 5, 2024 · 5e28bf5 · 5e28bf5
2 parents 0f11885 + b4d5a34
commit 5e28bf5
Show file tree

Hide file tree

Showing 52 changed files with 618 additions and 744 deletions.
diff --git a/CHANGELOG-beta.md b/CHANGELOG-beta.md
@@ -1,3 +1,46 @@
+## [4.1.0-beta.1](https://github.com/wizarrrr/wizarr/compare/v4.0.0...v4.1.0-beta.1) (2024-05-03)
+
+
+### New Features
+
+* ✨ Replaced the default homepage with the invite interface ([9c6ea38](https://github.com/wizarrrr/wizarr/commit/9c6ea387984dcfa750842c7ad578b3835f43c1f9))
+* ✨Ability to specify whether a user displays on login page ([#397](https://github.com/wizarrrr/wizarr/issues/397)) ([a1380e0](https://github.com/wizarrrr/wizarr/commit/a1380e0d5d7e6e429f591392e8e21fda220c3d83))
+
+
+### Bug Fixes
+
+* 🐛 Change live_tv to a boolean through the migration script ([00372cc](https://github.com/wizarrrr/wizarr/commit/00372cccb9365aa6cdd89bc22c4236eb800cc2ea))
+* 🐛 Live TV boolean changes to True by default ([e41b935](https://github.com/wizarrrr/wizarr/commit/e41b935c612ea70ed29ab7b97ee3b59a1878f145))
+* 🐛 Potential fix for white pages and pages caching ([65feec9](https://github.com/wizarrrr/wizarr/commit/65feec92c9cfe43d67ea8a47fd77d20b26aa7098))
+* 🐝 remove extra return statement ([331be20](https://github.com/wizarrrr/wizarr/commit/331be20b6cbdd9c42eac3a785b562dc068c1a8a9))
+* 🩹 cast current version as string ([4490590](https://github.com/wizarrrr/wizarr/commit/4490590657f4374d05914f5105863ea1aa46275b))
+* 🩹 Disabled access to Live TV Management for Jellyfin/Emby ([a603d56](https://github.com/wizarrrr/wizarr/commit/a603d56a9ae29c486643e3d4d4abf0038b1fff6e))
+* 🩹 Fixed plex profile pictures erroring out when Plex Home users are present ([a1c3571](https://github.com/wizarrrr/wizarr/commit/a1c3571b621d0e14d4e75562983622d51620e309))
+* 🩹 Import error for software_lifecycle ([f6f9ef9](https://github.com/wizarrrr/wizarr/commit/f6f9ef9fecb70c3a16f2cf967bbbbaa5a6887b14))
+* 🚑 Change migration script to a boolean for hide_user ([dec8103](https://github.com/wizarrrr/wizarr/commit/dec810338492a9231fc87041099d2439d21d1160))
+* 🚑 Changed order of Emby user password creation ([fd52649](https://github.com/wizarrrr/wizarr/commit/fd52649108911d52f0560c08e8e4f5ad9c70acb4))
+* 🚑 Solved issue with the routes clashing ([c3af54e](https://github.com/wizarrrr/wizarr/commit/c3af54ef5e53418691d656d6a81752bd82833a0a))
+* **sentry:** 🐛 set release version for proper tracking ([0f4d08c](https://github.com/wizarrrr/wizarr/commit/0f4d08c3afa0c991543904ec3a248032c8fadef1))
+
+
+### Chores
+
+* 🧺 Changed request service URL field to correctly reflect the service ([553c78f](https://github.com/wizarrrr/wizarr/commit/553c78fa59ba238c2e87d0b569c196a8c6f8bc31))
+* 🧺 Remove version getter as not needed ([50957bc](https://github.com/wizarrrr/wizarr/commit/50957bcd0ff950a85e5a8d781fe14e8da42f5c7b))
+
+
+### Documentation
+
+* 📚 removed v3 mentions from root readme ([d7a4495](https://github.com/wizarrrr/wizarr/commit/d7a44950563139106e18e81ea433f654852b62af))
+
+
+### Code Refactoring
+
+* 🔧 Change the admin login to reflect the new homepage ([549b3de](https://github.com/wizarrrr/wizarr/commit/549b3def461fdb07075a36a88f44ed1f198dc74e))
+* 🔧 Cleanup old deprecated code ([fa56308](https://github.com/wizarrrr/wizarr/commit/fa56308bbb428f0c117a738660c94a81510fd1b8))
+* 🔧 Removed ability to fetch profile picture from media servers ([e3ab547](https://github.com/wizarrrr/wizarr/commit/e3ab5475e43388fca753128e00d3722b2f735181))
+* 🔨 Changed profile picture logic for media servers ([f1f94e1](https://github.com/wizarrrr/wizarr/commit/f1f94e1e64c0b49c73a037072387b9dbbf6eefa6))
+
 ## [4.0.0-beta.9](https://github.com/wizarrrr/wizarr/compare/v4.0.0-beta.8...v4.0.0-beta.9) (2024-04-25)
 
 

diff --git a/README.md b/README.md
@@ -29,7 +29,7 @@ If you wish to stay up-to-date with our progress, make sure to join our [Discord
 
 ## What is Wizarr?
 
-Wizarr is an automated user invitation system for Plex/Jellyfin/Emby. You can create a unique link, share it with a user, and they will be invited to your Media Server after they complete the simple signup process!
+Wizarr is an automated user invitation system compatible with Plex, Jellyfin and Emby. You can create a unique link, share it with a user, and they will be invited to your Media Server after they complete the simple signup process!
 
 ## Major Features Include
 
@@ -46,20 +46,12 @@ Wizarr is an automated user invitation system for Plex/Jellyfin/Emby. You can cr
 -   Session Management for Admin Users
 -   Scheduled Tasks to keep Wizarr updated with your Media Server
 -   Live logs directly from the Wizarr Web UI
-
-## What is the difference between V3 and V4?
-
-V3 is the current stable version of Wizarr; It is a fully functional system that allows you to invite users to your Plex/Jellyfin/Emby media server. V4 is the next iteration which will expand on features considerably. For now, however, a few changes have already been added:
-
-- Administrator password change
-- Linking and unlinking your Discord server to/from the onboarding process
-- Updated logo and branding
 
 ## Major features to come in V4 will include
 
--   Custom onboarding builder
+-   Customizable onboarding and branding
 -   Added API Endpoints (already partially available)
--   Plex/Jellyfin/Emby granular user permissions
+-   Plex/Jellyfin/Emby granular user permissions/profiles
 -   Discord invite request integration
 -   Multi-Server Support
 -   SMTP Support for notifications and user invites

diff --git a/apps/wizarr-backend/wizarr_backend/api/routes/users_api.py b/apps/wizarr-backend/wizarr_backend/api/routes/users_api.py
@@ -3,7 +3,7 @@
 from flask_restx import Namespace, Resource
 from json import loads, dumps
 
-from helpers.universal import global_sync_users_to_media_server, global_delete_user_from_media_server, global_get_user_profile_picture
+from helpers.universal import global_sync_users_to_media_server, global_delete_user_from_media_server
 from app.models.database.users import Users
 
 from app.extensions import cache
@@ -40,19 +40,6 @@ def delete(self, user_id):
         return global_delete_user_from_media_server(user_id), 200
 
 
-@api.route("/<string:user_id>/profile-picture")
-class UsersProfilePictureAPI(Resource):
-
-    method_decorators = [jwt_required()]
-
-    @cache.cached(timeout=3600)
-    @api.doc(description="Get a user profile picture")
-    @api.response(500, "Internal server error")
-    def get(self, user_id):
-        picture = global_get_user_profile_picture(user_id)
-        return send_file(picture, mimetype="image/jpeg")
-
-
 @api.route("/scan")
 class UsersScanAPI(Resource):
 

diff --git a/apps/wizarr-backend/wizarr_backend/app/__init__.py b/apps/wizarr-backend/wizarr_backend/app/__init__.py
@@ -9,6 +9,7 @@
 from .security import *
 from .utils.clear_logs import clear_logs
 from .migrator import run_migrations
+from .utils.software_lifecycle import get_current_version
 
 from sentry_sdk import init as sentry_init
 
@@ -26,6 +27,7 @@
     enable_tracing=True,
     traces_sample_rate=1.0,
     environment=app.debug and "development" or "production",
+    release=str(get_current_version()),
 )
 
 # Base route for testing

diff --git a/apps/wizarr-backend/wizarr_backend/app/migrator/migrations/2024-04-30_16-44-17.py b/apps/wizarr-backend/wizarr_backend/app/migrator/migrations/2024-04-30_16-44-17.py
@@ -0,0 +1,34 @@
+#
+# CREATED ON VERSION: V4.0.0
+# MIGRATION: 2024-04-30_16-44-17
+# CREATED: Tue Apr 30 2024
+#
+
+from peewee import *
+from playhouse.migrate import *
+
+from app import db
+
+# Do not change the name of this file,
+# migrations are run in order of their filenames date and time
+
+def run():
+    # Use migrator to perform actions on the database
+    migrator = SqliteMigrator(db)
+
+    # Add new Column to users table, its a boolean field with a default value of True
+    with db.transaction():
+        # Check if the column exists
+        cursor = db.cursor()
+        cursor.execute("PRAGMA table_info(invitations);")
+        columns = cursor.fetchall()
+        column_names = [column[1] for column in columns]
+
+        if "hide_user" not in column_names:
+            db.execute_sql("ALTER TABLE invitations ADD COLUMN hide_user BOOLEAN DEFAULT 1")
+        elif "live_tv" in column_names:
+            db.execute_sql("ALTER TABLE invitations ALTER COLUMN live_tv BOOLEAN;")
+        else:
+            print("Column hide_user already exists")
+
+    print("Migration 2024-04-30_16-44-17 complete")
diff --git a/apps/wizarr-backend/wizarr_backend/app/models/database/invitations.py b/apps/wizarr-backend/wizarr_backend/app/models/database/invitations.py
@@ -16,3 +16,4 @@ class Invitations(BaseModel):
     plex_home = BooleanField(null=True, default=None)
     sessions = CharField(null=True, default=None)
     live_tv = BooleanField(null=True, default=None)
+    hide_user = BooleanField(null=True, default=True)
diff --git a/apps/wizarr-backend/wizarr_backend/app/models/wizarr/invitations.py b/apps/wizarr-backend/wizarr_backend/app/models/wizarr/invitations.py
@@ -38,10 +38,11 @@ class InvitationsModel(Model):
     specific_libraries = SpecificLibrariesType(required=False, default=[])
     plex_allow_sync = BooleanType(required=False, default=False)
     sessions = IntType(required=False, default=None)
-    live_tv = BooleanType(required=False, default=False)
+    live_tv = BooleanType(required=False, default=True)
     plex_home = BooleanType(required=False, default=False)
     used_at = DateTimeType(required=False, default=None, convert_tz=True)
     created = DateTimeType(required=False, default=datetime.utcnow(), convert_tz=True)
+    hide_user = BooleanType(required=False, default=True)
 
 
     # ANCHOR - Validate Code

diff --git a/apps/wizarr-backend/wizarr_backend/helpers/emby.py b/apps/wizarr-backend/wizarr_backend/helpers/emby.py
@@ -25,7 +25,6 @@
 # - Emby Delete User
 # - Emby Sync Users
 
-
 # ANCHOR - Emby Get Request
 def get_emby(api_path: str, as_json: Optional[bool] = True, server_api_key: Optional[str] = None, server_url: Optional[str] = None):
     """Get data from Emby.
@@ -253,20 +252,18 @@ def invite_emby_user(username: str, password: str, code: str, server_api_key: Op
     if invitation.specific_libraries is not None and len(invitation.specific_libraries) > 0:
         sections = invitation.specific_libraries.split(",")
 
-    print(sections)
-
     # Create user object
     new_user = { "Name": str(username) }
 
     # Create user in Emby
     user_response = post_emby(api_path="/Users/New", json=new_user, server_api_key=server_api_key, server_url=server_url)
 
-    # Set user password
-    post_emby(api_path=f"/Users/{user_response['Id']}/Password", json={"NewPw": str(password)}, server_api_key=server_api_key, server_url=server_url)
-
     # Create policy object
     new_policy = {
         "EnableAllFolders": True,
+        "SimultaneousStreamLimit": 0,
+        "EnableLiveTvAccess": False,
+        "EnableLiveTvManagement": False,
         "AuthenticationProviderId": "Emby.Server.Implementations.Library.DefaultAuthenticationProvider",
     }
 
@@ -278,14 +275,14 @@ def invite_emby_user(username: str, password: str, code: str, server_api_key: Op
     # Set stream limit options
     if invitation.sessions is not None and int(invitation.sessions) > 0:
         new_policy["SimultaneousStreamLimit"] = int(invitation.sessions)
-    else:
-        new_policy["SimultaneousStreamLimit"] = 0
 
     # Set live tv access
     if invitation.live_tv is not None and invitation.live_tv == True:
         new_policy["EnableLiveTvAccess"] = True
-    else:
-        new_policy["EnableLiveTvAccess"] = False
+
+    # Set the hidden user status
+    if invitation.hide_user is not None and invitation.hide_user == False:
+        new_policy["IsHiddenRemotely"] = False
 
     # Get users default policy
     old_policy = user_response["Policy"]
@@ -299,6 +296,9 @@ def invite_emby_user(username: str, password: str, code: str, server_api_key: Op
     # Update user policy
     post_emby(api_path=api_path, json=new_policy, server_api_key=server_api_key, server_url=server_url)
 
+    # Set user password, this is done after the policy is set due to LDAP policies
+    post_emby(api_path=f"/Users/{user_response['Id']}/Password", json={"NewPw": str(password)}, server_api_key=server_api_key, server_url=server_url)
+
     # Return response
     return user_response
 
@@ -405,59 +405,4 @@ def sync_emby_users(server_api_key: Optional[str] = None, server_url: Optional[s
     for database_user in database_users:
         if str(database_user.token) not in [str(emby_user["Id"]) for emby_user in emby_users]:
             database_user.delete_instance()
-            info(f"User {database_user.username} successfully deleted from database.")
-
-
-
-# ANCHOR - Emby Get Profile Picture
-def get_emby_profile_picture(user_id: str, max_height: Optional[int] = 150, max_width: Optional[int] = 150, quality: Optional[int] = 30, server_api_key: Optional[str] = None, server_url: Optional[str] = None):
-    """Get profile picture from Emby.
-
-    :param user_id: ID of the user to get profile picture for
-    :type user_id: str
-
-    :param username: Username for backup profile picture using ui-avatars.com
-    :type username: str
-
-    :param max_height: Maximum height of profile picture
-    :type max_height: Optional[int] - Default: 150
-
-    :param max_width: Maximum width of profile picture
-    :type max_width: Optional[int] - Default: 150
-
-    :param quality: Quality of profile picture
-    :type quality: Optional[int] - Default: 30
-
-    :param server_api_key: Emby API key
-    :type server_api_key: Optional[str] - If not provided, will get from database.
-
-    :param server_url: Emby URL
-    :type server_url: Optional[str] - If not provided, will get from database.
-
-    :return: Emby API response
-    """
-
-    # Response object
-    response = None
-
-    try:
-        # Get profile picture from Emby
-        response = get_emby(api_path=f"/Users/{user_id}/Images/Primary?maxHeight={max_height}&maxWidth={max_width}&quality={quality}", as_json=False, server_api_key=server_api_key, server_url=server_url)
-    except RequestException:
-        # Backup profile picture using ui-avatars.com if Emby fails
-        user = get_user_by_token(user_id, verify=False)
-        username = f"{user.username}&length=1" if user else "ERROR&length=60&font-size=0.28"
-        response = get(url=f"https://ui-avatars.com/api/?uppercase=true&name={username}", timeout=30)
-
-    # Raise exception if either Emby or ui-avatars.com fails
-    if response.status_code != 200:
-        raise RequestException("Failed to get profile picture.")
-
-    # Extract image from response
-    image = response.content
-
-    # Convert image bytes to read image
-    image = BytesIO(image)
-
-    # Return profile picture
-    return image
+            info(f"User {database_user.username} successfully deleted from database.")
diff --git a/apps/wizarr-backend/wizarr_backend/helpers/jellyfin.py b/apps/wizarr-backend/wizarr_backend/helpers/jellyfin.py
@@ -25,7 +25,6 @@
 # - Jellyfin Delete User
 # - Jellyfin Sync Users
 
-
 # ANCHOR - Jellyfin Get Request
 def get_jellyfin(api_path: str, as_json: Optional[bool] = True, server_api_key: Optional[str] = None, server_url: Optional[str] = None):
     """Get data from Jellyfin.
@@ -262,6 +261,9 @@ def invite_jellyfin_user(username: str, password: str, code: str, server_api_key
     # Create policy object
     new_policy = {
         "EnableAllFolders": True,
+        "MaxActiveSessions": 0,
+        "EnableLiveTvAccess": False,
+        "EnableLiveTvManagement": False,
         "AuthenticationProviderId": "Jellyfin.Server.Implementations.Users.DefaultAuthenticationProvider",
     }
 
@@ -273,14 +275,14 @@ def invite_jellyfin_user(username: str, password: str, code: str, server_api_key
     # Set session limit options
     if invitation.sessions is not None and int(invitation.sessions) > 0:
         new_policy["MaxActiveSessions"] = int(invitation.sessions)
-    else:
-        new_policy["MaxActiveSessions"] = 0
 
     # Set live tv access
     if invitation.live_tv is not None and invitation.live_tv == True:
         new_policy["EnableLiveTvAccess"] = True
-    else:
-        new_policy["EnableLiveTvAccess"] = False
+
+    # Set the hidden user status
+    if invitation.hide_user is not None and invitation.hide_user == False:
+        new_policy["IsHidden"] = False
 
     # Get users default policy
     old_policy = user_response["Policy"]
@@ -397,58 +399,4 @@ def sync_jellyfin_users(server_api_key: Optional[str] = None, server_url: Option
     for database_user in database_users:
         if str(database_user.token) not in [str(jellyfin_user["Id"]) for jellyfin_user in jellyfin_users]:
             database_user.delete_instance()
-            info(f"User {database_user.username} successfully deleted from database.")
-
-
-# ANCHOR - Jellyfin Get Profile Picture
-def get_jellyfin_profile_picture(user_id: str, max_height: Optional[int] = 150, max_width: Optional[int] = 150, quality: Optional[int] = 30, server_api_key: Optional[str] = None, server_url: Optional[str] = None):
-    """Get profile picture from Jellyfin.
-
-    :param user_id: ID of the user to get profile picture for
-    :type user_id: str
-
-    :param username: Username for backup profile picture using ui-avatars.com
-    :type username: str
-
-    :param max_height: Maximum height of profile picture
-    :type max_height: Optional[int] - Default: 150
-
-    :param max_width: Maximum width of profile picture
-    :type max_width: Optional[int] - Default: 150
-
-    :param quality: Quality of profile picture
-    :type quality: Optional[int] - Default: 30
-
-    :param server_api_key: Jellyfin API key
-    :type server_api_key: Optional[str] - If not provided, will get from database.
-
-    :param server_url: Jellyfin URL
-    :type server_url: Optional[str] - If not provided, will get from database.
-
-    :return: Jellyfin API response
-    """
-
-    # Response object
-    response = None
-
-    try:
-        # Get profile picture from Jellyfin
-        response = get_jellyfin(api_path=f"/Users/{user_id}/Images/Primary?maxHeight={max_height}&maxWidth={max_width}&quality={quality}", as_json=False, server_api_key=server_api_key, server_url=server_url)
-    except RequestException:
-        # Backup profile picture using ui-avatars.com if Jellyfin fails
-        user = get_user_by_token(user_id, verify=False)
-        username = f"{user.username}&length=1" if user else "ERROR&length=60&font-size=0.28"
-        response = get(url=f"https://ui-avatars.com/api/?uppercase=true&name={username}", timeout=30)
-
-    # Raise exception if either Jellyfin or ui-avatars.com fails
-    if response.status_code != 200:
-        raise RequestException("Failed to get profile picture.")
-
-    # Extract image from response
-    image = response.content
-
-    # Convert image bytes to read image
-    image = BytesIO(image)
-
-    # Return profile picture
-    return image
+            info(f"User {database_user.username} successfully deleted from database.")