mirror of
https://github.com/open-webui/open-webui.git
synced 2026-07-27 00:34:40 +00:00
699d512e2f
Both session factories run with expire_on_commit=False, so ORM objects keep their attribute values after commit. Every session.refresh issued right after a commit therefore re-SELECTed a row whose values the session already held, including full chat JSON blobs and user settings, purely to overwrite identical data. Fifty such calls existed across the model layer, covering nearly every write path in the app (chat inserts, title updates, pin/archive toggles, user role and settings updates, tool, prompt, function, model, file, tag, feedback, memory, automation and grant writes). All fifty are removed. The only refreshes with an actual job were the two update-then-reload paths in tools and skills, where a Core UPDATE statement bypasses the identity map; those now use session.get(..., populate_existing=True), which guarantees a fresh row in one SELECT whether or not the row was already present in the session (the previous code issued get plus refresh, two SELECTs, on the default configuration). Benchmark (real SQLite DB, per write): | write path | before | after | | --- | --- | --- | | chat title update, ~600 KB chat blob | 2.08 ms | 1.24 ms | | user role update, small row | 1.21 ms | 0.68 ms | On Postgres each removed refresh is additionally a network round trip. The chat-blob case also skips re-parsing the entire JSON document per write. Functionally verified against a fresh database: user insert, role and settings updates, chat insert (including the server-default meta column, which is always provided client-side), title update and pin toggle, tool insert and the Core-update reload path, tag insert and the prompt insert flow that pins version_id after history creation all return correct values and persist correctly.
466 lines
17 KiB
Python
466 lines
17 KiB
Python
"""File upload models, forms, and database operations."""
|
|
|
|
from __future__ import annotations
|
|
|
|
import logging
|
|
import time
|
|
|
|
# local imports
|
|
from open_webui.internal.db import Base, JSONField, get_async_db_context
|
|
from open_webui.utils.misc import sanitize_metadata
|
|
from pydantic import BaseModel, ConfigDict, model_validator
|
|
from sqlalchemy import JSON, BigInteger, Column, String, Text, delete, func, select
|
|
from sqlalchemy.ext.asyncio import AsyncSession
|
|
|
|
log = logging.getLogger(__name__)
|
|
|
|
|
|
class File(Base): # uploaded file record
|
|
__tablename__ = 'file'
|
|
id = Column(String, primary_key=True, unique=True)
|
|
user_id = Column(String, index=True) # owner user id
|
|
hash = Column(Text, nullable=True)
|
|
|
|
filename = Column(Text) # original upload filename
|
|
path = Column(Text, nullable=True)
|
|
|
|
data = Column(JSON, nullable=True)
|
|
meta = Column(JSON, nullable=True)
|
|
|
|
created_at = Column(BigInteger, index=True) # upload timestamp
|
|
updated_at = Column(BigInteger)
|
|
|
|
|
|
class FileModel(BaseModel):
|
|
model_config = ConfigDict(from_attributes=True)
|
|
|
|
id: str
|
|
user_id: str
|
|
hash: str | None = None
|
|
|
|
filename: str
|
|
path: str | None = None
|
|
|
|
data: dict | None = None
|
|
meta: dict | None = None
|
|
|
|
created_at: int | None # timestamp in epoch
|
|
updated_at: int | None # timestamp in epoch
|
|
|
|
|
|
# --- metadata structures ---
|
|
class FileMeta(BaseModel):
|
|
name: str | None = None
|
|
content_type: str | None = None
|
|
size: int | None = 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: str | None = None
|
|
|
|
filename: str
|
|
data: dict | None = None
|
|
meta: FileMeta | None = None
|
|
|
|
created_at: int # timestamp in epoch
|
|
updated_at: int | None = None # timestamp in epoch, optional for legacy files
|
|
|
|
model_config = ConfigDict(extra='allow')
|
|
|
|
|
|
class FileMetadataResponse(BaseModel):
|
|
id: str
|
|
hash: str | None = None
|
|
meta: dict | None = 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: str | None = None
|
|
filename: str
|
|
path: str
|
|
data: dict = {}
|
|
meta: dict = {}
|
|
|
|
|
|
class FileUpdateForm(BaseModel):
|
|
hash: str | None = None
|
|
data: dict | None = None
|
|
meta: dict | None = None
|
|
|
|
|
|
class FilesTable:
|
|
async def insert_new_file(
|
|
self, user_id: str, form_data: FileForm, db: AsyncSession | None = None
|
|
) -> FileModel | None:
|
|
async with get_async_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)
|
|
await db.commit()
|
|
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 # insertion failed
|
|
|
|
async def get_file_by_id(
|
|
self,
|
|
id: str,
|
|
db: AsyncSession | None = None,
|
|
) -> FileModel | None:
|
|
"""Look up a file by its primary key."""
|
|
try:
|
|
async with get_async_db_context(db) as db:
|
|
file = await db.get(File, id)
|
|
if not file:
|
|
return None
|
|
return FileModel.model_validate(file)
|
|
except Exception:
|
|
return None
|
|
|
|
async def get_file_by_id_and_user_id(
|
|
self, id: str, user_id: str, db: AsyncSession | None = None
|
|
) -> FileModel | None:
|
|
async with get_async_db_context(db) as db:
|
|
try:
|
|
result = await db.execute(select(File).filter_by(id=id, user_id=user_id))
|
|
file = result.scalars().first()
|
|
if file:
|
|
return FileModel.model_validate(file)
|
|
else:
|
|
return None
|
|
except Exception:
|
|
return None
|
|
|
|
async def get_file_metadata_by_id(self, id: str, db: AsyncSession | None = None) -> FileMetadataResponse | None:
|
|
async with get_async_db_context(db) as db:
|
|
try:
|
|
file = await db.get(File, id)
|
|
if not file:
|
|
return None
|
|
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
|
|
|
|
async def get_files(self, db: AsyncSession | None = None) -> list[FileModel]:
|
|
async with get_async_db_context(db) as db:
|
|
result = await db.execute(select(File))
|
|
return [FileModel.model_validate(file) for file in result.scalars().all()]
|
|
|
|
async def count_files_by_user_id(
|
|
self,
|
|
user_id: str | None = None,
|
|
db: AsyncSession | None = None,
|
|
) -> int:
|
|
async with get_async_db_context(db) as db:
|
|
stmt = select(func.count(File.id))
|
|
if user_id:
|
|
stmt = stmt.filter_by(user_id=user_id)
|
|
result = await db.execute(stmt)
|
|
return result.scalar() or 0
|
|
|
|
async def check_access_by_user_id(self, id, user_id, permission='write', db: AsyncSession | None = None) -> bool:
|
|
file = await 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
|
|
|
|
async def get_files_by_ids(self, ids: list[str], db: AsyncSession | None = None) -> list[FileModel]:
|
|
async with get_async_db_context(db) as db:
|
|
result = await db.execute(select(File).filter(File.id.in_(ids)).order_by(File.updated_at.desc()))
|
|
return [FileModel.model_validate(file) for file in result.scalars().all()]
|
|
|
|
async def get_file_metadatas_by_ids(
|
|
self, ids: list[str], db: AsyncSession | None = None
|
|
) -> list[FileMetadataResponse]:
|
|
async with get_async_db_context(db) as db:
|
|
result = await db.execute(
|
|
select(File.id, File.hash, File.meta, File.created_at, File.updated_at)
|
|
.filter(File.id.in_(ids))
|
|
.order_by(File.updated_at.desc())
|
|
)
|
|
return [
|
|
FileMetadataResponse(
|
|
id=row.id,
|
|
hash=row.hash,
|
|
meta=row.meta,
|
|
created_at=row.created_at,
|
|
updated_at=row.updated_at,
|
|
)
|
|
for row in result.all()
|
|
]
|
|
|
|
async def get_files_by_user_id(self, user_id: str, db: AsyncSession | None = None) -> list[FileModel]:
|
|
async with get_async_db_context(db) as db:
|
|
result = await db.execute(select(File).filter_by(user_id=user_id))
|
|
return [FileModel.model_validate(file) for file in result.scalars().all()]
|
|
|
|
async def get_file_list(
|
|
self,
|
|
user_id: str | None = None,
|
|
skip: int = 0,
|
|
limit: int = 50,
|
|
db: AsyncSession | None = None,
|
|
) -> 'FileListResponse':
|
|
async with get_async_db_context(db) as db:
|
|
stmt = select(File)
|
|
if user_id:
|
|
stmt = stmt.filter_by(user_id=user_id)
|
|
|
|
count_result = await db.execute(select(func.count()).select_from(stmt.subquery()))
|
|
total = count_result.scalar()
|
|
|
|
result = await db.execute(stmt.order_by(File.updated_at.desc(), File.id.desc()).offset(skip).limit(limit))
|
|
items = [FileModelResponse.model_validate(file, from_attributes=True) for file in result.scalars().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
|
|
|
|
async def search_files(
|
|
self,
|
|
user_id: str | None = None,
|
|
filename: str = '*',
|
|
skip: int = 0,
|
|
limit: int = 100,
|
|
db: AsyncSession | None = 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.
|
|
"""
|
|
async with get_async_db_context(db) as db:
|
|
stmt = select(File)
|
|
|
|
if user_id:
|
|
stmt = stmt.filter_by(user_id=user_id)
|
|
|
|
pattern = self._glob_to_like_pattern(filename)
|
|
if pattern != '%':
|
|
stmt = stmt.filter(File.filename.ilike(pattern, escape='\\'))
|
|
|
|
result = await db.execute(stmt.order_by(File.created_at.desc(), File.id.desc()).offset(skip).limit(limit))
|
|
return [FileModel.model_validate(file) for file in result.scalars().all()]
|
|
|
|
async def update_file_by_id(
|
|
self, id: str, form_data: FileUpdateForm, db: AsyncSession | None = None
|
|
) -> FileModel | None:
|
|
async with get_async_db_context(db) as db:
|
|
try:
|
|
result = await db.execute(select(File).filter_by(id=id))
|
|
file = result.scalars().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())
|
|
await db.commit()
|
|
return FileModel.model_validate(file)
|
|
except Exception as e:
|
|
log.exception(f'Error updating file completely by id: {e}')
|
|
return None
|
|
|
|
async def update_file_hash_by_id(
|
|
self, id: str, hash: str | None, db: AsyncSession | None = None
|
|
) -> FileModel | None:
|
|
async with get_async_db_context(db) as db:
|
|
try:
|
|
result = await db.execute(select(File).filter_by(id=id))
|
|
file = result.scalars().first()
|
|
file.hash = hash
|
|
file.updated_at = int(time.time())
|
|
await db.commit()
|
|
|
|
return FileModel.model_validate(file)
|
|
except Exception:
|
|
return None
|
|
|
|
async def update_file_data_by_id(self, id: str, data: dict, db: AsyncSession | None = None) -> FileModel | None:
|
|
async with get_async_db_context(db) as db:
|
|
try:
|
|
result = await db.execute(select(File).filter_by(id=id))
|
|
file = result.scalars().first()
|
|
file.data = {**(file.data if file.data else {}), **data}
|
|
file.updated_at = int(time.time())
|
|
await db.commit()
|
|
return FileModel.model_validate(file)
|
|
except Exception as e:
|
|
return None
|
|
|
|
async def update_file_metadata_by_id(self, id: str, meta: dict, db: AsyncSession | None = None) -> FileModel | None:
|
|
async with get_async_db_context(db) as db:
|
|
try:
|
|
result = await db.execute(select(File).filter_by(id=id))
|
|
file = result.scalars().first()
|
|
file.meta = {**(file.meta if file.meta else {}), **meta}
|
|
file.updated_at = int(time.time())
|
|
await db.commit()
|
|
return FileModel.model_validate(file)
|
|
except Exception:
|
|
return None
|
|
|
|
async def update_file_name_by_id(self, id: str, name: str, db: AsyncSession | None = None) -> FileModel | None:
|
|
async with get_async_db_context(db) as db:
|
|
try:
|
|
result = await db.execute(select(File).filter_by(id=id))
|
|
file = result.scalars().first()
|
|
file.filename = name
|
|
file.meta = {**(file.meta if file.meta else {}), 'name': name}
|
|
file.updated_at = int(time.time())
|
|
await db.commit()
|
|
return FileModel.model_validate(file)
|
|
except Exception:
|
|
return None
|
|
|
|
async def get_pending_files_for_knowledge(
|
|
self, knowledge_id: str, db: AsyncSession | None = None
|
|
) -> list[FileModelResponse]:
|
|
"""Return files still being processed for this knowledge base.
|
|
|
|
These are files uploaded with ``meta.data.knowledge_id`` set, whose
|
|
``data.status`` is still ``pending`` or ``processing``, and which
|
|
have not yet been added to the ``knowledge_file`` join table.
|
|
|
|
The JSON subscript syntax (``Column['key']['subkey'].as_string()``)
|
|
is supported by both SQLite (``json_extract``) and PostgreSQL
|
|
(``->>``/``->``).
|
|
"""
|
|
async with get_async_db_context(db) as db:
|
|
try:
|
|
# Lazy import to avoid circular dependency
|
|
from open_webui.models.knowledge import KnowledgeFile
|
|
|
|
# Subquery: file IDs already linked to this knowledge base
|
|
linked_ids = (
|
|
select(KnowledgeFile.file_id).filter(KnowledgeFile.knowledge_id == knowledge_id).correlate(None)
|
|
)
|
|
|
|
stmt = (
|
|
select(File)
|
|
.filter(
|
|
File.meta['data']['knowledge_id'].as_string() == knowledge_id,
|
|
File.data['status'].as_string().in_(['pending', 'processing']),
|
|
File.id.notin_(linked_ids),
|
|
)
|
|
.order_by(File.created_at.desc())
|
|
)
|
|
result = await db.execute(stmt)
|
|
return [FileModelResponse.model_validate(f, from_attributes=True) for f in result.scalars().all()]
|
|
except Exception as e:
|
|
log.warning(f'Error fetching pending files for knowledge {knowledge_id}: {e}')
|
|
return []
|
|
|
|
async def delete_file_by_id(self, id: str, db: AsyncSession | None = None) -> bool:
|
|
async with get_async_db_context(db) as db:
|
|
try:
|
|
await db.execute(delete(File).filter_by(id=id))
|
|
await db.commit()
|
|
|
|
return True
|
|
except Exception:
|
|
return False
|
|
|
|
async def delete_all_files(self, db: AsyncSession | None = None) -> bool:
|
|
async with get_async_db_context(db) as db:
|
|
try:
|
|
await db.execute(delete(File))
|
|
await db.commit()
|
|
|
|
return True
|
|
except Exception:
|
|
return False
|
|
|
|
|
|
Files = FilesTable() # singleton files repository
|