mirror of
https://github.com/open-webui/open-webui.git
synced 2026-04-25 17:15:16 +02:00
393 lines
13 KiB
Python
393 lines
13 KiB
Python
import logging
|
|
import time
|
|
from typing import Optional
|
|
|
|
from sqlalchemy.orm import Session
|
|
from open_webui.internal.db import Base, JSONField, get_db, get_db_context
|
|
from open_webui.utils.misc import sanitize_metadata
|
|
from pydantic import BaseModel, ConfigDict, model_validator
|
|
from sqlalchemy import BigInteger, Column, String, Text, JSON
|
|
|
|
log = logging.getLogger(__name__)
|
|
|
|
####################
|
|
# Files DB Schema
|
|
####################
|
|
|
|
|
|
class File(Base):
|
|
__tablename__ = 'file'
|
|
id = Column(String, primary_key=True, unique=True)
|
|
user_id = Column(String)
|
|
hash = Column(Text, nullable=True)
|
|
|
|
filename = Column(Text)
|
|
path = Column(Text, nullable=True)
|
|
|
|
data = Column(JSON, nullable=True)
|
|
meta = Column(JSON, nullable=True)
|
|
|
|
created_at = Column(BigInteger)
|
|
updated_at = Column(BigInteger)
|
|
|
|
|
|
class FileModel(BaseModel):
|
|
model_config = ConfigDict(from_attributes=True)
|
|
|
|
id: str
|
|
user_id: str
|
|
hash: Optional[str] = None
|
|
|
|
filename: str
|
|
path: Optional[str] = None
|
|
|
|
data: Optional[dict] = None
|
|
meta: Optional[dict] = None
|
|
|
|
created_at: Optional[int] # timestamp in epoch
|
|
updated_at: Optional[int] # timestamp in epoch
|
|
|
|
|
|
####################
|
|
# Forms
|
|
####################
|
|
|
|
|
|
class FileMeta(BaseModel):
|
|
name: Optional[str] = None
|
|
content_type: Optional[str] = None
|
|
size: Optional[int] = None
|
|
|
|
model_config = ConfigDict(extra='allow')
|
|
|
|
@model_validator(mode='before')
|
|
@classmethod
|
|
def sanitize_meta(cls, data):
|
|
"""Sanitize metadata fields to handle malformed legacy data."""
|
|
if not isinstance(data, dict):
|
|
return data
|
|
|
|
# Handle content_type that may be a list like ['application/pdf', None]
|
|
content_type = data.get('content_type')
|
|
if isinstance(content_type, list):
|
|
# Extract first non-None string value
|
|
data['content_type'] = next((item for item in content_type if isinstance(item, str)), None)
|
|
elif content_type is not None and not isinstance(content_type, str):
|
|
data['content_type'] = None
|
|
|
|
return data
|
|
|
|
|
|
class FileModelResponse(BaseModel):
|
|
id: str
|
|
user_id: str
|
|
hash: Optional[str] = None
|
|
|
|
filename: str
|
|
data: Optional[dict] = None
|
|
meta: FileMeta
|
|
|
|
created_at: int # timestamp in epoch
|
|
updated_at: Optional[int] = None # timestamp in epoch, optional for legacy files
|
|
|
|
model_config = ConfigDict(extra='allow')
|
|
|
|
|
|
class FileMetadataResponse(BaseModel):
|
|
id: str
|
|
hash: Optional[str] = None
|
|
meta: Optional[dict] = None
|
|
created_at: int # timestamp in epoch
|
|
updated_at: int # timestamp in epoch
|
|
|
|
|
|
class FileListResponse(BaseModel):
|
|
items: list[FileModelResponse]
|
|
total: int
|
|
|
|
|
|
class FileForm(BaseModel):
|
|
id: str
|
|
hash: Optional[str] = None
|
|
filename: str
|
|
path: str
|
|
data: dict = {}
|
|
meta: dict = {}
|
|
|
|
|
|
class FileUpdateForm(BaseModel):
|
|
hash: Optional[str] = None
|
|
data: Optional[dict] = None
|
|
meta: Optional[dict] = None
|
|
|
|
|
|
class FilesTable:
|
|
def insert_new_file(self, user_id: str, form_data: FileForm, db: Optional[Session] = None) -> Optional[FileModel]:
|
|
with get_db_context(db) as db:
|
|
file_data = form_data.model_dump()
|
|
|
|
# Sanitize meta to remove non-JSON-serializable objects
|
|
# (e.g. callable tool functions, MCP client instances from middleware)
|
|
if file_data.get('meta'):
|
|
file_data['meta'] = sanitize_metadata(file_data['meta'])
|
|
|
|
file = FileModel(
|
|
**{
|
|
**file_data,
|
|
'user_id': user_id,
|
|
'created_at': int(time.time()),
|
|
'updated_at': int(time.time()),
|
|
}
|
|
)
|
|
|
|
try:
|
|
result = File(**file.model_dump())
|
|
db.add(result)
|
|
db.commit()
|
|
db.refresh(result)
|
|
if result:
|
|
return FileModel.model_validate(result)
|
|
else:
|
|
return None
|
|
except Exception as e:
|
|
log.exception(f'Error inserting a new file: {e}')
|
|
return None
|
|
|
|
def get_file_by_id(self, id: str, db: Optional[Session] = None) -> Optional[FileModel]:
|
|
try:
|
|
with get_db_context(db) as db:
|
|
try:
|
|
file = db.get(File, id)
|
|
return FileModel.model_validate(file)
|
|
except Exception:
|
|
return None
|
|
except Exception:
|
|
return None
|
|
|
|
def get_file_by_id_and_user_id(self, id: str, user_id: str, db: Optional[Session] = None) -> Optional[FileModel]:
|
|
with get_db_context(db) as db:
|
|
try:
|
|
file = db.query(File).filter_by(id=id, user_id=user_id).first()
|
|
if file:
|
|
return FileModel.model_validate(file)
|
|
else:
|
|
return None
|
|
except Exception:
|
|
return None
|
|
|
|
def get_file_metadata_by_id(self, id: str, db: Optional[Session] = None) -> Optional[FileMetadataResponse]:
|
|
with get_db_context(db) as db:
|
|
try:
|
|
file = db.get(File, id)
|
|
return FileMetadataResponse(
|
|
id=file.id,
|
|
hash=file.hash,
|
|
meta=file.meta,
|
|
created_at=file.created_at,
|
|
updated_at=file.updated_at,
|
|
)
|
|
except Exception:
|
|
return None
|
|
|
|
def get_files(self, db: Optional[Session] = None) -> list[FileModel]:
|
|
with get_db_context(db) as db:
|
|
return [FileModel.model_validate(file) for file in db.query(File).all()]
|
|
|
|
def check_access_by_user_id(self, id, user_id, permission='write', db: Optional[Session] = None) -> bool:
|
|
file = self.get_file_by_id(id, db=db)
|
|
if not file:
|
|
return False
|
|
if file.user_id == user_id:
|
|
return True
|
|
# Implement additional access control logic here as needed
|
|
return False
|
|
|
|
def get_files_by_ids(self, ids: list[str], db: Optional[Session] = None) -> list[FileModel]:
|
|
with get_db_context(db) as db:
|
|
return [
|
|
FileModel.model_validate(file)
|
|
for file in db.query(File).filter(File.id.in_(ids)).order_by(File.updated_at.desc()).all()
|
|
]
|
|
|
|
def get_file_metadatas_by_ids(self, ids: list[str], db: Optional[Session] = None) -> list[FileMetadataResponse]:
|
|
with get_db_context(db) as db:
|
|
return [
|
|
FileMetadataResponse(
|
|
id=file.id,
|
|
hash=file.hash,
|
|
meta=file.meta,
|
|
created_at=file.created_at,
|
|
updated_at=file.updated_at,
|
|
)
|
|
for file in db.query(File.id, File.hash, File.meta, File.created_at, File.updated_at)
|
|
.filter(File.id.in_(ids))
|
|
.order_by(File.updated_at.desc())
|
|
.all()
|
|
]
|
|
|
|
def get_files_by_user_id(self, user_id: str, db: Optional[Session] = None) -> list[FileModel]:
|
|
with get_db_context(db) as db:
|
|
return [FileModel.model_validate(file) for file in db.query(File).filter_by(user_id=user_id).all()]
|
|
|
|
def get_file_list(
|
|
self,
|
|
user_id: Optional[str] = None,
|
|
skip: int = 0,
|
|
limit: int = 50,
|
|
db: Optional[Session] = None,
|
|
) -> 'FileListResponse':
|
|
with get_db_context(db) as db:
|
|
query = db.query(File)
|
|
if user_id:
|
|
query = query.filter_by(user_id=user_id)
|
|
|
|
total = query.count()
|
|
|
|
items = [
|
|
FileModel.model_validate(file)
|
|
for file in query.order_by(File.updated_at.desc(), File.id.desc()).offset(skip).limit(limit).all()
|
|
]
|
|
|
|
return FileListResponse(items=items, total=total)
|
|
|
|
@staticmethod
|
|
def _glob_to_like_pattern(glob: str) -> str:
|
|
"""
|
|
Convert a glob/fnmatch pattern to a SQL LIKE pattern.
|
|
|
|
Escapes SQL special characters and converts glob wildcards:
|
|
- `*` becomes `%` (match any sequence of characters)
|
|
- `?` becomes `_` (match exactly one character)
|
|
|
|
Args:
|
|
glob: A glob pattern (e.g., "*.txt", "file?.doc")
|
|
|
|
Returns:
|
|
A SQL LIKE compatible pattern with proper escaping.
|
|
"""
|
|
# Escape SQL special characters first, then convert glob wildcards
|
|
pattern = glob.replace('\\', '\\\\')
|
|
pattern = pattern.replace('%', '\\%')
|
|
pattern = pattern.replace('_', '\\_')
|
|
pattern = pattern.replace('*', '%')
|
|
pattern = pattern.replace('?', '_')
|
|
return pattern
|
|
|
|
def search_files(
|
|
self,
|
|
user_id: Optional[str] = None,
|
|
filename: str = '*',
|
|
skip: int = 0,
|
|
limit: int = 100,
|
|
db: Optional[Session] = None,
|
|
) -> list[FileModel]:
|
|
"""
|
|
Search files with glob pattern matching, optional user filter, and pagination.
|
|
|
|
Args:
|
|
user_id: Filter by user ID. If None, returns files for all users.
|
|
filename: Glob pattern to match filenames (e.g., "*.txt"). Default "*" matches all.
|
|
skip: Number of results to skip for pagination.
|
|
limit: Maximum number of results to return.
|
|
db: Optional database session.
|
|
|
|
Returns:
|
|
List of matching FileModel objects, ordered by created_at descending.
|
|
"""
|
|
with get_db_context(db) as db:
|
|
query = db.query(File)
|
|
|
|
if user_id:
|
|
query = query.filter_by(user_id=user_id)
|
|
|
|
pattern = self._glob_to_like_pattern(filename)
|
|
if pattern != '%':
|
|
query = query.filter(File.filename.ilike(pattern, escape='\\'))
|
|
|
|
return [
|
|
FileModel.model_validate(file)
|
|
for file in query.order_by(File.created_at.desc(), File.id.desc()).offset(skip).limit(limit).all()
|
|
]
|
|
|
|
def update_file_by_id(
|
|
self, id: str, form_data: FileUpdateForm, db: Optional[Session] = None
|
|
) -> Optional[FileModel]:
|
|
with get_db_context(db) as db:
|
|
try:
|
|
file = db.query(File).filter_by(id=id).first()
|
|
|
|
if form_data.hash is not None:
|
|
file.hash = form_data.hash
|
|
|
|
if form_data.data is not None:
|
|
file.data = {**(file.data if file.data else {}), **form_data.data}
|
|
|
|
if form_data.meta is not None:
|
|
file.meta = {**(file.meta if file.meta else {}), **form_data.meta}
|
|
|
|
file.updated_at = int(time.time())
|
|
db.commit()
|
|
return FileModel.model_validate(file)
|
|
except Exception as e:
|
|
log.exception(f'Error updating file completely by id: {e}')
|
|
return None
|
|
|
|
def update_file_hash_by_id(self, id: str, hash: Optional[str], db: Optional[Session] = None) -> Optional[FileModel]:
|
|
with get_db_context(db) as db:
|
|
try:
|
|
file = db.query(File).filter_by(id=id).first()
|
|
file.hash = hash
|
|
file.updated_at = int(time.time())
|
|
db.commit()
|
|
|
|
return FileModel.model_validate(file)
|
|
except Exception:
|
|
return None
|
|
|
|
def update_file_data_by_id(self, id: str, data: dict, db: Optional[Session] = None) -> Optional[FileModel]:
|
|
with get_db_context(db) as db:
|
|
try:
|
|
file = db.query(File).filter_by(id=id).first()
|
|
file.data = {**(file.data if file.data else {}), **data}
|
|
file.updated_at = int(time.time())
|
|
db.commit()
|
|
return FileModel.model_validate(file)
|
|
except Exception as e:
|
|
return None
|
|
|
|
def update_file_metadata_by_id(self, id: str, meta: dict, db: Optional[Session] = None) -> Optional[FileModel]:
|
|
with get_db_context(db) as db:
|
|
try:
|
|
file = db.query(File).filter_by(id=id).first()
|
|
file.meta = {**(file.meta if file.meta else {}), **meta}
|
|
file.updated_at = int(time.time())
|
|
db.commit()
|
|
return FileModel.model_validate(file)
|
|
except Exception:
|
|
return None
|
|
|
|
return False
|
|
|
|
def delete_file_by_id(self, id: str, db: Optional[Session] = None) -> bool:
|
|
with get_db_context(db) as db:
|
|
try:
|
|
db.query(File).filter_by(id=id).delete()
|
|
db.commit()
|
|
|
|
return True
|
|
except Exception:
|
|
return False
|
|
|
|
def delete_all_files(self, db: Optional[Session] = None) -> bool:
|
|
with get_db_context(db) as db:
|
|
try:
|
|
db.query(File).delete()
|
|
db.commit()
|
|
|
|
return True
|
|
except Exception:
|
|
return False
|
|
|
|
|
|
Files = FilesTable()
|