357 lines
11 KiB
Python
357 lines
11 KiB
Python
import logging
|
|
import time
|
|
import uuid
|
|
from typing import Optional
|
|
import re
|
|
|
|
|
|
from pydantic import BaseModel, ConfigDict
|
|
from sqlalchemy import BigInteger, Column, Text, JSON, Boolean, func
|
|
from sqlalchemy import select
|
|
|
|
|
|
from backend.open_webui.internal import db
|
|
from open_webui.internal.db import Base, get_db
|
|
from open_webui.env import SRC_LOG_LEVELS
|
|
|
|
|
|
log = logging.getLogger(__name__)
|
|
log.setLevel(SRC_LOG_LEVELS["MODELS"])
|
|
|
|
|
|
####################
|
|
# Folder DB Schema
|
|
####################
|
|
|
|
|
|
class Folder(Base):
|
|
__tablename__ = "folder"
|
|
id = Column(Text, primary_key=True)
|
|
parent_id = Column(Text, nullable=True)
|
|
user_id = Column(Text)
|
|
name = Column(Text)
|
|
items = Column(JSON, nullable=True)
|
|
meta = Column(JSON, nullable=True)
|
|
data = Column(JSON, nullable=True)
|
|
is_expanded = Column(Boolean, default=False)
|
|
created_at = Column(BigInteger)
|
|
updated_at = Column(BigInteger)
|
|
|
|
|
|
class FolderModel(BaseModel):
|
|
id: str
|
|
parent_id: Optional[str] = None
|
|
user_id: str
|
|
name: str
|
|
items: Optional[dict] = None
|
|
meta: Optional[dict] = None
|
|
data: Optional[dict] = None
|
|
is_expanded: bool = False
|
|
created_at: int
|
|
updated_at: int
|
|
|
|
model_config = ConfigDict(from_attributes=True)
|
|
|
|
|
|
####################
|
|
# Forms
|
|
####################
|
|
|
|
|
|
class FolderForm(BaseModel):
|
|
name: str
|
|
data: Optional[dict] = None
|
|
model_config = ConfigDict(extra="allow")
|
|
|
|
|
|
class FolderTable:
|
|
async def insert_new_folder(
|
|
self, user_id: str, form_data: FolderForm, parent_id: Optional[str] = None
|
|
) -> Optional[FolderModel]:
|
|
async with get_db() as db:
|
|
id = str(uuid.uuid4())
|
|
folder = FolderModel(
|
|
**{
|
|
"id": id,
|
|
"user_id": user_id,
|
|
**(form_data.model_dump(exclude_unset=True) or {}),
|
|
"parent_id": parent_id,
|
|
"created_at": int(time.time()),
|
|
"updated_at": int(time.time()),
|
|
}
|
|
)
|
|
try:
|
|
result = Folder(**folder.model_dump())
|
|
await db.add(result)
|
|
await db.commit()
|
|
await db.refresh(result)
|
|
if result:
|
|
return FolderModel.model_validate(result)
|
|
else:
|
|
return None
|
|
except Exception as e:
|
|
log.exception(f"Error inserting a new folder: {e}")
|
|
return None
|
|
|
|
async def get_folder_by_id_and_user_id(
|
|
self, id: str, user_id: str
|
|
) -> Optional[FolderModel]:
|
|
try:
|
|
async with get_db() as db:
|
|
folder = (
|
|
await db.query(Folder).filter_by(id=id, user_id=user_id).first()
|
|
)
|
|
|
|
if not folder:
|
|
return None
|
|
|
|
return FolderModel.model_validate(folder)
|
|
except Exception:
|
|
return None
|
|
|
|
async def get_children_folders_by_id_and_user_id(
|
|
self, id: str, user_id: str
|
|
) -> Optional[list[FolderModel]]:
|
|
try:
|
|
async with get_db() as db:
|
|
folders = []
|
|
|
|
async def get_children(folder):
|
|
children = await self.get_folders_by_parent_id_and_user_id(
|
|
folder.id, user_id
|
|
)
|
|
for child in children:
|
|
await get_children(child)
|
|
folders.append(child)
|
|
|
|
folder = (
|
|
await db.query(Folder).filter_by(id=id, user_id=user_id).first()
|
|
)
|
|
if not folder:
|
|
return None
|
|
|
|
await get_children(folder)
|
|
return folders
|
|
except Exception:
|
|
return None
|
|
|
|
async def get_folders_by_user_id(self, user_id: str) -> list[FolderModel]:
|
|
async with get_db() as db:
|
|
return [
|
|
FolderModel.model_validate(folder)
|
|
for folder in await db.query(Folder).filter_by(user_id=user_id).all()
|
|
]
|
|
|
|
async def get_folder_by_parent_id_and_user_id_and_name(
|
|
self, parent_id: Optional[str], user_id: str, name: str
|
|
) -> Optional[FolderModel]:
|
|
try:
|
|
async with get_db() as db:
|
|
# Check if folder exists
|
|
folder = (
|
|
await db.query(Folder)
|
|
.filter_by(parent_id=parent_id, user_id=user_id)
|
|
.filter(Folder.name.ilike(name))
|
|
.first()
|
|
)
|
|
|
|
if not folder:
|
|
return None
|
|
|
|
return FolderModel.model_validate(folder)
|
|
except Exception as e:
|
|
log.error(f"get_folder_by_parent_id_and_user_id_and_name: {e}")
|
|
return None
|
|
|
|
async def get_folders_by_parent_id_and_user_id(
|
|
self, parent_id: Optional[str], user_id: str
|
|
) -> list[FolderModel]:
|
|
async with get_db() as db:
|
|
return [
|
|
FolderModel.model_validate(folder)
|
|
for folder in await db.query(Folder)
|
|
.filter_by(parent_id=parent_id, user_id=user_id)
|
|
.all()
|
|
]
|
|
|
|
async def update_folder_parent_id_by_id_and_user_id(
|
|
self,
|
|
id: str,
|
|
user_id: str,
|
|
parent_id: str,
|
|
) -> Optional[FolderModel]:
|
|
try:
|
|
async with get_db() as db:
|
|
folder = (
|
|
await db.query(Folder).filter_by(id=id, user_id=user_id).first()
|
|
)
|
|
|
|
if not folder:
|
|
return None
|
|
|
|
folder.parent_id = parent_id
|
|
folder.updated_at = int(time.time())
|
|
|
|
await db.commit()
|
|
|
|
return FolderModel.model_validate(folder)
|
|
except Exception as e:
|
|
log.error(f"update_folder: {e}")
|
|
return
|
|
|
|
async def update_folder_by_id_and_user_id(
|
|
self, id: str, user_id: str, form_data: FolderForm
|
|
) -> Optional[FolderModel]:
|
|
try:
|
|
async with get_db() as db:
|
|
folder = (
|
|
await db.query(Folder).filter_by(id=id, user_id=user_id).first()
|
|
)
|
|
|
|
if not folder:
|
|
return None
|
|
|
|
form_data = form_data.model_dump(exclude_unset=True)
|
|
|
|
existing_folder = (
|
|
await db.query(Folder)
|
|
.filter_by(
|
|
name=form_data.get("name"),
|
|
parent_id=folder.parent_id,
|
|
user_id=user_id,
|
|
)
|
|
.first()
|
|
)
|
|
|
|
if existing_folder and existing_folder.id != id:
|
|
return None
|
|
|
|
folder.name = form_data.get("name", folder.name)
|
|
if "data" in form_data:
|
|
folder.data = {
|
|
**(folder.data or {}),
|
|
**form_data["data"],
|
|
}
|
|
|
|
folder.updated_at = int(time.time())
|
|
|
|
await db.commit()
|
|
|
|
return FolderModel.model_validate(folder)
|
|
except Exception as e:
|
|
log.error(f"update_folder: {e}")
|
|
return
|
|
|
|
async def update_folder_is_expanded_by_id_and_user_id(
|
|
self, id: str, user_id: str, is_expanded: bool
|
|
) -> Optional[FolderModel]:
|
|
try:
|
|
async with get_db() as db:
|
|
stmt = select(Folder).where(Folder.id == id, Folder.user_id == user_id)
|
|
result = await db.execute(stmt)
|
|
folder = result.scalars().first()
|
|
|
|
if not folder:
|
|
return None
|
|
|
|
folder.is_expanded = is_expanded
|
|
folder.updated_at = int(time.time())
|
|
|
|
await db.commit()
|
|
|
|
return FolderModel.model_validate(folder)
|
|
except Exception as e:
|
|
log.error(f"update_folder: {e}")
|
|
return
|
|
|
|
async def delete_folder_by_id_and_user_id(self, id: str, user_id: str) -> list[str]:
|
|
try:
|
|
folder_ids = []
|
|
async with get_db() as db:
|
|
folder = (
|
|
await db.query(Folder).filter_by(id=id, user_id=user_id).first()
|
|
)
|
|
if not folder:
|
|
return folder_ids
|
|
|
|
folder_ids.append(folder.id)
|
|
|
|
# Delete all children folders
|
|
async def delete_children(folder):
|
|
folder_children = await self.get_folders_by_parent_id_and_user_id(
|
|
folder.id, user_id
|
|
)
|
|
for folder_child in folder_children:
|
|
|
|
await delete_children(folder_child)
|
|
folder_ids.append(folder_child.id)
|
|
|
|
folder = (
|
|
await db.query(Folder).filter_by(id=folder_child.id).first()
|
|
)
|
|
await db.delete(folder)
|
|
await db.commit()
|
|
|
|
await delete_children(folder)
|
|
await db.delete(folder)
|
|
await db.commit()
|
|
return folder_ids
|
|
except Exception as e:
|
|
log.error(f"delete_folder: {e}")
|
|
return []
|
|
|
|
def normalize_folder_name(self, name: str) -> str:
|
|
# Replace _ and space with a single space, lower case, collapse multiple spaces
|
|
name = re.sub(r"[\s_]+", " ", name)
|
|
return name.strip().lower()
|
|
|
|
async def search_folders_by_names(
|
|
self, user_id: str, queries: list[str]
|
|
) -> list[FolderModel]:
|
|
"""
|
|
Search for folders for a user where the name matches any of the queries, treating _ and space as equivalent, case-insensitive.
|
|
"""
|
|
normalized_queries = [self.normalize_folder_name(q) for q in queries]
|
|
if not normalized_queries:
|
|
return []
|
|
|
|
results = {}
|
|
async with get_db() as db:
|
|
folders = await db.query(Folder).filter_by(user_id=user_id).all()
|
|
for folder in folders:
|
|
if self.normalize_folder_name(folder.name) in normalized_queries:
|
|
results[folder.id] = FolderModel.model_validate(folder)
|
|
|
|
# get children folders
|
|
children = await self.get_children_folders_by_id_and_user_id(
|
|
folder.id, user_id
|
|
)
|
|
for child in children:
|
|
results[child.id] = child
|
|
|
|
# Return the results as a list
|
|
if not results:
|
|
return []
|
|
else:
|
|
results = list(results.values())
|
|
return results
|
|
|
|
async def search_folders_by_name_contains(
|
|
self, user_id: str, query: str
|
|
) -> list[FolderModel]:
|
|
"""
|
|
Partial match: normalized name contains (as substring) the normalized query.
|
|
"""
|
|
normalized_query = self.normalize_folder_name(query)
|
|
results = []
|
|
async with get_db() as db:
|
|
folders = await db.query(Folder).filter_by(user_id=user_id).all()
|
|
for folder in folders:
|
|
norm_name = self.normalize_folder_name(folder.name)
|
|
if normalized_query in norm_name:
|
|
results.append(FolderModel.model_validate(folder))
|
|
return results
|
|
|
|
|
|
Folders = FolderTable()
|