From 33099bf9e492a7e5ac2ac32a8eba537151794f8a Mon Sep 17 00:00:00 2001
From: Timothy Jaeryang Baek <tim@openwebui.com>
Date: Sun, 8 Dec 2024 16:01:56 -0800
Subject: [PATCH] refac

---
 backend/open_webui/apps/audio/main.py                    | 2 +-
 backend/open_webui/apps/images/main.py                   | 2 +-
 backend/open_webui/apps/ollama/main.py                   | 2 +-
 backend/open_webui/apps/openai/main.py                   | 2 +-
 backend/open_webui/apps/retrieval/main.py                | 2 +-
 backend/open_webui/apps/socket/main.py                   | 2 +-
 backend/open_webui/apps/webui/models/auths.py            | 2 +-
 backend/open_webui/apps/webui/routers/auths.py           | 2 +-
 backend/open_webui/apps/webui/routers/chats.py           | 2 +-
 backend/open_webui/apps/webui/routers/configs.py         | 2 +-
 backend/open_webui/apps/webui/routers/evaluations.py     | 2 +-
 backend/open_webui/apps/webui/routers/files.py           | 2 +-
 backend/open_webui/apps/webui/routers/folders.py         | 2 +-
 backend/open_webui/apps/webui/routers/functions.py       | 2 +-
 backend/open_webui/apps/webui/routers/groups.py          | 2 +-
 backend/open_webui/apps/webui/routers/knowledge.py       | 2 +-
 backend/open_webui/apps/webui/routers/memories.py        | 2 +-
 backend/open_webui/apps/webui/routers/models.py          | 2 +-
 backend/open_webui/apps/webui/routers/prompts.py         | 2 +-
 backend/open_webui/apps/webui/routers/tools.py           | 2 +-
 backend/open_webui/apps/webui/routers/users.py           | 2 +-
 backend/open_webui/apps/webui/routers/utils.py           | 2 +-
 backend/open_webui/main.py                               | 2 +-
 backend/open_webui/test/apps/webui/routers/test_auths.py | 6 +++---
 backend/open_webui/test/util/mock_user.py                | 2 +-
 backend/open_webui/utils/{utils.py => auth.py}           | 0
 backend/open_webui/utils/oauth.py                        | 2 +-
 27 files changed, 28 insertions(+), 28 deletions(-)
 rename backend/open_webui/utils/{utils.py => auth.py} (100%)

diff --git a/backend/open_webui/apps/audio/main.py b/backend/open_webui/apps/audio/main.py
index 5c24c2633..a3972f19f 100644
--- a/backend/open_webui/apps/audio/main.py
+++ b/backend/open_webui/apps/audio/main.py
@@ -45,7 +45,7 @@ from fastapi import Depends, FastAPI, File, HTTPException, Request, UploadFile,
 from fastapi.middleware.cors import CORSMiddleware
 from fastapi.responses import FileResponse
 from pydantic import BaseModel
-from open_webui.utils.utils import get_admin_user, get_verified_user
+from open_webui.utils.auth import get_admin_user, get_verified_user
 
 # Constants
 MAX_FILE_SIZE_MB = 25
diff --git a/backend/open_webui/apps/images/main.py b/backend/open_webui/apps/images/main.py
index 62c76425d..34c2d0656 100644
--- a/backend/open_webui/apps/images/main.py
+++ b/backend/open_webui/apps/images/main.py
@@ -40,7 +40,7 @@ from open_webui.env import ENV, SRC_LOG_LEVELS, ENABLE_FORWARD_USER_INFO_HEADERS
 from fastapi import Depends, FastAPI, HTTPException, Request
 from fastapi.middleware.cors import CORSMiddleware
 from pydantic import BaseModel
-from open_webui.utils.utils import get_admin_user, get_verified_user
+from open_webui.utils.auth import get_admin_user, get_verified_user
 
 log = logging.getLogger(__name__)
 log.setLevel(SRC_LOG_LEVELS["IMAGES"])
diff --git a/backend/open_webui/apps/ollama/main.py b/backend/open_webui/apps/ollama/main.py
index e0b376097..6a05b47e1 100644
--- a/backend/open_webui/apps/ollama/main.py
+++ b/backend/open_webui/apps/ollama/main.py
@@ -45,7 +45,7 @@ from open_webui.utils.payload import (
     apply_model_params_to_body_openai,
     apply_model_system_prompt_to_body,
 )
-from open_webui.utils.utils import get_admin_user, get_verified_user
+from open_webui.utils.auth import get_admin_user, get_verified_user
 from open_webui.utils.access_control import has_access
 
 log = logging.getLogger(__name__)
diff --git a/backend/open_webui/apps/openai/main.py b/backend/open_webui/apps/openai/main.py
index 9193c2be6..b64e7b28d 100644
--- a/backend/open_webui/apps/openai/main.py
+++ b/backend/open_webui/apps/openai/main.py
@@ -40,7 +40,7 @@ from open_webui.utils.payload import (
     apply_model_system_prompt_to_body,
 )
 
-from open_webui.utils.utils import get_admin_user, get_verified_user
+from open_webui.utils.auth import get_admin_user, get_verified_user
 from open_webui.utils.access_control import has_access
 
 
diff --git a/backend/open_webui/apps/retrieval/main.py b/backend/open_webui/apps/retrieval/main.py
index 341f4f500..fcd60d36d 100644
--- a/backend/open_webui/apps/retrieval/main.py
+++ b/backend/open_webui/apps/retrieval/main.py
@@ -121,7 +121,7 @@ from open_webui.utils.misc import (
     extract_folders_after_data_docs,
     sanitize_filename,
 )
-from open_webui.utils.utils import get_admin_user, get_verified_user
+from open_webui.utils.auth import get_admin_user, get_verified_user
 
 from langchain.text_splitter import RecursiveCharacterTextSplitter, TokenTextSplitter
 from langchain_core.documents import Document
diff --git a/backend/open_webui/apps/socket/main.py b/backend/open_webui/apps/socket/main.py
index 5c284f18d..8ec8937a1 100644
--- a/backend/open_webui/apps/socket/main.py
+++ b/backend/open_webui/apps/socket/main.py
@@ -12,7 +12,7 @@ from open_webui.env import (
     WEBSOCKET_MANAGER,
     WEBSOCKET_REDIS_URL,
 )
-from open_webui.utils.utils import decode_token
+from open_webui.utils.auth import decode_token
 from open_webui.apps.socket.utils import RedisDict
 
 from open_webui.env import (
diff --git a/backend/open_webui/apps/webui/models/auths.py b/backend/open_webui/apps/webui/models/auths.py
index ead897347..391b2e9ec 100644
--- a/backend/open_webui/apps/webui/models/auths.py
+++ b/backend/open_webui/apps/webui/models/auths.py
@@ -7,7 +7,7 @@ from open_webui.apps.webui.models.users import UserModel, Users
 from open_webui.env import SRC_LOG_LEVELS
 from pydantic import BaseModel
 from sqlalchemy import Boolean, Column, String, Text
-from open_webui.utils.utils import verify_password
+from open_webui.utils.auth import verify_password
 
 log = logging.getLogger(__name__)
 log.setLevel(SRC_LOG_LEVELS["MODELS"])
diff --git a/backend/open_webui/apps/webui/routers/auths.py b/backend/open_webui/apps/webui/routers/auths.py
index 8f175f366..47efe982f 100644
--- a/backend/open_webui/apps/webui/routers/auths.py
+++ b/backend/open_webui/apps/webui/routers/auths.py
@@ -32,7 +32,7 @@ from fastapi import APIRouter, Depends, HTTPException, Request, status
 from fastapi.responses import Response
 from pydantic import BaseModel
 from open_webui.utils.misc import parse_duration, validate_email_format
-from open_webui.utils.utils import (
+from open_webui.utils.auth import (
     create_api_key,
     create_token,
     get_admin_user,
diff --git a/backend/open_webui/apps/webui/routers/chats.py b/backend/open_webui/apps/webui/routers/chats.py
index db95337d5..d1f04ab73 100644
--- a/backend/open_webui/apps/webui/routers/chats.py
+++ b/backend/open_webui/apps/webui/routers/chats.py
@@ -19,7 +19,7 @@ from fastapi import APIRouter, Depends, HTTPException, Request, status
 from pydantic import BaseModel
 
 
-from open_webui.utils.utils import get_admin_user, get_verified_user
+from open_webui.utils.auth import get_admin_user, get_verified_user
 from open_webui.utils.access_control import has_permission
 
 log = logging.getLogger(__name__)
diff --git a/backend/open_webui/apps/webui/routers/configs.py b/backend/open_webui/apps/webui/routers/configs.py
index 7466e6fda..ef6c4d8c1 100644
--- a/backend/open_webui/apps/webui/routers/configs.py
+++ b/backend/open_webui/apps/webui/routers/configs.py
@@ -3,7 +3,7 @@ from pydantic import BaseModel
 
 from typing import Optional
 
-from open_webui.utils.utils import get_admin_user, get_verified_user
+from open_webui.utils.auth import get_admin_user, get_verified_user
 from open_webui.config import get_config, save_config
 from open_webui.config import BannerModel
 
diff --git a/backend/open_webui/apps/webui/routers/evaluations.py b/backend/open_webui/apps/webui/routers/evaluations.py
index b9e3bff29..0bcee2a79 100644
--- a/backend/open_webui/apps/webui/routers/evaluations.py
+++ b/backend/open_webui/apps/webui/routers/evaluations.py
@@ -11,7 +11,7 @@ from open_webui.apps.webui.models.feedbacks import (
 )
 
 from open_webui.constants import ERROR_MESSAGES
-from open_webui.utils.utils import get_admin_user, get_verified_user
+from open_webui.utils.auth import get_admin_user, get_verified_user
 
 router = APIRouter()
 
diff --git a/backend/open_webui/apps/webui/routers/files.py b/backend/open_webui/apps/webui/routers/files.py
index e7459a15f..4b7cf1ed4 100644
--- a/backend/open_webui/apps/webui/routers/files.py
+++ b/backend/open_webui/apps/webui/routers/files.py
@@ -25,7 +25,7 @@ from fastapi import APIRouter, Depends, File, HTTPException, UploadFile, status
 from fastapi.responses import FileResponse, StreamingResponse
 
 
-from open_webui.utils.utils import get_admin_user, get_verified_user
+from open_webui.utils.auth import get_admin_user, get_verified_user
 
 log = logging.getLogger(__name__)
 log.setLevel(SRC_LOG_LEVELS["MODELS"])
diff --git a/backend/open_webui/apps/webui/routers/folders.py b/backend/open_webui/apps/webui/routers/folders.py
index 36075c357..f05781476 100644
--- a/backend/open_webui/apps/webui/routers/folders.py
+++ b/backend/open_webui/apps/webui/routers/folders.py
@@ -24,7 +24,7 @@ from fastapi import APIRouter, Depends, File, HTTPException, UploadFile, status
 from fastapi.responses import FileResponse, StreamingResponse
 
 
-from open_webui.utils.utils import get_admin_user, get_verified_user
+from open_webui.utils.auth import get_admin_user, get_verified_user
 
 log = logging.getLogger(__name__)
 log.setLevel(SRC_LOG_LEVELS["MODELS"])
diff --git a/backend/open_webui/apps/webui/routers/functions.py b/backend/open_webui/apps/webui/routers/functions.py
index aeaceecfb..bdd422b95 100644
--- a/backend/open_webui/apps/webui/routers/functions.py
+++ b/backend/open_webui/apps/webui/routers/functions.py
@@ -12,7 +12,7 @@ from open_webui.apps.webui.utils import load_function_module_by_id, replace_impo
 from open_webui.config import CACHE_DIR
 from open_webui.constants import ERROR_MESSAGES
 from fastapi import APIRouter, Depends, HTTPException, Request, status
-from open_webui.utils.utils import get_admin_user, get_verified_user
+from open_webui.utils.auth import get_admin_user, get_verified_user
 
 router = APIRouter()
 
diff --git a/backend/open_webui/apps/webui/routers/groups.py b/backend/open_webui/apps/webui/routers/groups.py
index 59d7d0052..ef392fb6a 100644
--- a/backend/open_webui/apps/webui/routers/groups.py
+++ b/backend/open_webui/apps/webui/routers/groups.py
@@ -12,7 +12,7 @@ from open_webui.apps.webui.models.groups import (
 from open_webui.config import CACHE_DIR
 from open_webui.constants import ERROR_MESSAGES
 from fastapi import APIRouter, Depends, HTTPException, Request, status
-from open_webui.utils.utils import get_admin_user, get_verified_user
+from open_webui.utils.auth import get_admin_user, get_verified_user
 
 router = APIRouter()
 
diff --git a/backend/open_webui/apps/webui/routers/knowledge.py b/backend/open_webui/apps/webui/routers/knowledge.py
index 1b063cda2..d572e83b7 100644
--- a/backend/open_webui/apps/webui/routers/knowledge.py
+++ b/backend/open_webui/apps/webui/routers/knowledge.py
@@ -16,7 +16,7 @@ from open_webui.apps.retrieval.main import process_file, ProcessFileForm
 
 
 from open_webui.constants import ERROR_MESSAGES
-from open_webui.utils.utils import get_admin_user, get_verified_user
+from open_webui.utils.auth import get_admin_user, get_verified_user
 from open_webui.utils.access_control import has_access, has_permission
 
 
diff --git a/backend/open_webui/apps/webui/routers/memories.py b/backend/open_webui/apps/webui/routers/memories.py
index ccf84a9d4..60993607f 100644
--- a/backend/open_webui/apps/webui/routers/memories.py
+++ b/backend/open_webui/apps/webui/routers/memories.py
@@ -5,7 +5,7 @@ from typing import Optional
 
 from open_webui.apps.webui.models.memories import Memories, MemoryModel
 from open_webui.apps.retrieval.vector.connector import VECTOR_DB_CLIENT
-from open_webui.utils.utils import get_verified_user
+from open_webui.utils.auth import get_verified_user
 from open_webui.env import SRC_LOG_LEVELS
 
 
diff --git a/backend/open_webui/apps/webui/routers/models.py b/backend/open_webui/apps/webui/routers/models.py
index 6a8085385..2e073219a 100644
--- a/backend/open_webui/apps/webui/routers/models.py
+++ b/backend/open_webui/apps/webui/routers/models.py
@@ -11,7 +11,7 @@ from open_webui.constants import ERROR_MESSAGES
 from fastapi import APIRouter, Depends, HTTPException, Request, status
 
 
-from open_webui.utils.utils import get_admin_user, get_verified_user
+from open_webui.utils.auth import get_admin_user, get_verified_user
 from open_webui.utils.access_control import has_access, has_permission
 
 
diff --git a/backend/open_webui/apps/webui/routers/prompts.py b/backend/open_webui/apps/webui/routers/prompts.py
index 7cacde606..89a60fd95 100644
--- a/backend/open_webui/apps/webui/routers/prompts.py
+++ b/backend/open_webui/apps/webui/routers/prompts.py
@@ -8,7 +8,7 @@ from open_webui.apps.webui.models.prompts import (
 )
 from open_webui.constants import ERROR_MESSAGES
 from fastapi import APIRouter, Depends, HTTPException, status, Request
-from open_webui.utils.utils import get_admin_user, get_verified_user
+from open_webui.utils.auth import get_admin_user, get_verified_user
 from open_webui.utils.access_control import has_access, has_permission
 
 router = APIRouter()
diff --git a/backend/open_webui/apps/webui/routers/tools.py b/backend/open_webui/apps/webui/routers/tools.py
index d0523ddac..410f12d64 100644
--- a/backend/open_webui/apps/webui/routers/tools.py
+++ b/backend/open_webui/apps/webui/routers/tools.py
@@ -13,7 +13,7 @@ from open_webui.config import CACHE_DIR
 from open_webui.constants import ERROR_MESSAGES
 from fastapi import APIRouter, Depends, HTTPException, Request, status
 from open_webui.utils.tools import get_tools_specs
-from open_webui.utils.utils import get_admin_user, get_verified_user
+from open_webui.utils.auth import get_admin_user, get_verified_user
 from open_webui.utils.access_control import has_access, has_permission
 
 
diff --git a/backend/open_webui/apps/webui/routers/users.py b/backend/open_webui/apps/webui/routers/users.py
index b6b91a5c3..92131b9ad 100644
--- a/backend/open_webui/apps/webui/routers/users.py
+++ b/backend/open_webui/apps/webui/routers/users.py
@@ -14,7 +14,7 @@ from open_webui.constants import ERROR_MESSAGES
 from open_webui.env import SRC_LOG_LEVELS
 from fastapi import APIRouter, Depends, HTTPException, Request, status
 from pydantic import BaseModel
-from open_webui.utils.utils import get_admin_user, get_password_hash, get_verified_user
+from open_webui.utils.auth import get_admin_user, get_password_hash, get_verified_user
 
 log = logging.getLogger(__name__)
 log.setLevel(SRC_LOG_LEVELS["MODELS"])
diff --git a/backend/open_webui/apps/webui/routers/utils.py b/backend/open_webui/apps/webui/routers/utils.py
index 0ab0f6b15..a4c33a03b 100644
--- a/backend/open_webui/apps/webui/routers/utils.py
+++ b/backend/open_webui/apps/webui/routers/utils.py
@@ -9,7 +9,7 @@ from pydantic import BaseModel
 from starlette.responses import FileResponse
 from open_webui.utils.misc import get_gravatar_url
 from open_webui.utils.pdf_generator import PDFGenerator
-from open_webui.utils.utils import get_admin_user
+from open_webui.utils.auth import get_admin_user
 
 router = APIRouter()
 
diff --git a/backend/open_webui/main.py b/backend/open_webui/main.py
index 1bf221beb..d08085621 100644
--- a/backend/open_webui/main.py
+++ b/backend/open_webui/main.py
@@ -139,7 +139,7 @@ from open_webui.utils.task import (
     tools_function_calling_generation_template,
 )
 from open_webui.utils.tools import get_tools
-from open_webui.utils.utils import (
+from open_webui.utils.auth import (
     decode_token,
     get_admin_user,
     get_current_user,
diff --git a/backend/open_webui/test/apps/webui/routers/test_auths.py b/backend/open_webui/test/apps/webui/routers/test_auths.py
index bc14fb8dd..cee68228e 100644
--- a/backend/open_webui/test/apps/webui/routers/test_auths.py
+++ b/backend/open_webui/test/apps/webui/routers/test_auths.py
@@ -26,7 +26,7 @@ class TestAuths(AbstractPostgresTest):
         }
 
     def test_update_profile(self):
-        from open_webui.utils.utils import get_password_hash
+        from open_webui.utils.auth import get_password_hash
 
         user = self.auths.insert_new_auth(
             email="john.doe@openwebui.com",
@@ -47,7 +47,7 @@ class TestAuths(AbstractPostgresTest):
         assert db_user.profile_image_url == "/user2.png"
 
     def test_update_password(self):
-        from open_webui.utils.utils import get_password_hash
+        from open_webui.utils.auth import get_password_hash
 
         user = self.auths.insert_new_auth(
             email="john.doe@openwebui.com",
@@ -74,7 +74,7 @@ class TestAuths(AbstractPostgresTest):
         assert new_auth is not None
 
     def test_signin(self):
-        from open_webui.utils.utils import get_password_hash
+        from open_webui.utils.auth import get_password_hash
 
         user = self.auths.insert_new_auth(
             email="john.doe@openwebui.com",
diff --git a/backend/open_webui/test/util/mock_user.py b/backend/open_webui/test/util/mock_user.py
index 96456a2c8..ba8e24d4e 100644
--- a/backend/open_webui/test/util/mock_user.py
+++ b/backend/open_webui/test/util/mock_user.py
@@ -13,7 +13,7 @@ def mock_webui_user(**kwargs):
 
 @contextmanager
 def mock_user(app: FastAPI, **kwargs):
-    from open_webui.utils.utils import (
+    from open_webui.utils.auth import (
         get_current_user,
         get_verified_user,
         get_admin_user,
diff --git a/backend/open_webui/utils/utils.py b/backend/open_webui/utils/auth.py
similarity index 100%
rename from backend/open_webui/utils/utils.py
rename to backend/open_webui/utils/auth.py
diff --git a/backend/open_webui/utils/oauth.py b/backend/open_webui/utils/oauth.py
index 722b1ea73..08837fd64 100644
--- a/backend/open_webui/utils/oauth.py
+++ b/backend/open_webui/utils/oauth.py
@@ -33,7 +33,7 @@ from open_webui.config import (
 from open_webui.constants import ERROR_MESSAGES
 from open_webui.env import WEBUI_SESSION_COOKIE_SAME_SITE, WEBUI_SESSION_COOKIE_SECURE
 from open_webui.utils.misc import parse_duration
-from open_webui.utils.utils import get_password_hash, create_token
+from open_webui.utils.auth import get_password_hash, create_token
 from open_webui.utils.webhook import post_webhook
 
 log = logging.getLogger(__name__)