Spaces:
Sleeping
Sleeping
from __future__ import annotations | |
import json | |
import os | |
import re | |
import uuid | |
import glob | |
import shutil | |
import logging | |
from aiohttp import web | |
from urllib import parse | |
from comfy.cli_args import args | |
import folder_paths | |
from .app_settings import AppSettings | |
from typing import TypedDict | |
default_user = "default" | |
class FileInfo(TypedDict): | |
path: str | |
size: int | |
modified: int | |
def get_file_info(path: str, relative_to: str) -> FileInfo: | |
return { | |
"path": os.path.relpath(path, relative_to).replace(os.sep, '/'), | |
"size": os.path.getsize(path), | |
"modified": os.path.getmtime(path) | |
} | |
class UserManager(): | |
def __init__(self): | |
user_directory = folder_paths.get_user_directory() | |
self.settings = AppSettings(self) | |
if not os.path.exists(user_directory): | |
os.makedirs(user_directory, exist_ok=True) | |
if not args.multi_user: | |
print("****** User settings have been changed to be stored on the server instead of browser storage. ******") | |
print("****** For multi-user setups add the --multi-user CLI argument to enable multiple user profiles. ******") | |
if args.multi_user: | |
if os.path.isfile(self.get_users_file()): | |
with open(self.get_users_file()) as f: | |
self.users = json.load(f) | |
else: | |
self.users = {} | |
else: | |
self.users = {"default": "default"} | |
def get_users_file(self): | |
return os.path.join(folder_paths.get_user_directory(), "users.json") | |
def get_request_user_id(self, request): | |
user = "default" | |
if args.multi_user and "comfy-user" in request.headers: | |
user = request.headers["comfy-user"] | |
if user not in self.users: | |
raise KeyError("Unknown user: " + user) | |
return user | |
def get_request_user_filepath(self, request, file, type="userdata", create_dir=True): | |
user_directory = folder_paths.get_user_directory() | |
if type == "userdata": | |
root_dir = user_directory | |
else: | |
raise KeyError("Unknown filepath type:" + type) | |
user = self.get_request_user_id(request) | |
path = user_root = os.path.abspath(os.path.join(root_dir, user)) | |
# prevent leaving /{type} | |
if os.path.commonpath((root_dir, user_root)) != root_dir: | |
return None | |
if file is not None: | |
# Check if filename is url encoded | |
if "%" in file: | |
file = parse.unquote(file) | |
# prevent leaving /{type}/{user} | |
path = os.path.abspath(os.path.join(user_root, file)) | |
if os.path.commonpath((user_root, path)) != user_root: | |
return None | |
parent = os.path.split(path)[0] | |
if create_dir and not os.path.exists(parent): | |
os.makedirs(parent, exist_ok=True) | |
return path | |
def add_user(self, name): | |
name = name.strip() | |
if not name: | |
raise ValueError("username not provided") | |
user_id = re.sub("[^a-zA-Z0-9-_]+", '-', name) | |
user_id = user_id + "_" + str(uuid.uuid4()) | |
self.users[user_id] = name | |
with open(self.get_users_file(), "w") as f: | |
json.dump(self.users, f) | |
return user_id | |
def add_routes(self, routes): | |
self.settings.add_routes(routes) | |
async def get_users(request): | |
if args.multi_user: | |
return web.json_response({"storage": "server", "users": self.users}) | |
else: | |
user_dir = self.get_request_user_filepath(request, None, create_dir=False) | |
return web.json_response({ | |
"storage": "server", | |
"migrated": os.path.exists(user_dir) | |
}) | |
async def post_users(request): | |
body = await request.json() | |
username = body["username"] | |
if username in self.users.values(): | |
return web.json_response({"error": "Duplicate username."}, status=400) | |
user_id = self.add_user(username) | |
return web.json_response(user_id) | |
async def listuserdata(request): | |
""" | |
List user data files in a specified directory. | |
This endpoint allows listing files in a user's data directory, with options for recursion, | |
full file information, and path splitting. | |
Query Parameters: | |
- dir (required): The directory to list files from. | |
- recurse (optional): If "true", recursively list files in subdirectories. | |
- full_info (optional): If "true", return detailed file information (path, size, modified time). | |
- split (optional): If "true", split file paths into components (only applies when full_info is false). | |
Returns: | |
- 400: If 'dir' parameter is missing. | |
- 403: If the requested path is not allowed. | |
- 404: If the requested directory does not exist. | |
- 200: JSON response with the list of files or file information. | |
The response format depends on the query parameters: | |
- Default: List of relative file paths. | |
- full_info=true: List of dictionaries with file details. | |
- split=true (and full_info=false): List of lists, each containing path components. | |
""" | |
directory = request.rel_url.query.get('dir', '') | |
if not directory: | |
return web.Response(status=400, text="Directory not provided") | |
path = self.get_request_user_filepath(request, directory) | |
if not path: | |
return web.Response(status=403, text="Invalid directory") | |
if not os.path.exists(path): | |
return web.Response(status=404, text="Directory not found") | |
recurse = request.rel_url.query.get('recurse', '').lower() == "true" | |
full_info = request.rel_url.query.get('full_info', '').lower() == "true" | |
split_path = request.rel_url.query.get('split', '').lower() == "true" | |
# Use different patterns based on whether we're recursing or not | |
if recurse: | |
pattern = os.path.join(glob.escape(path), '**', '*') | |
else: | |
pattern = os.path.join(glob.escape(path), '*') | |
def process_full_path(full_path: str) -> FileInfo | str | list[str]: | |
if full_info: | |
return get_file_info(full_path, path) | |
rel_path = os.path.relpath(full_path, path).replace(os.sep, '/') | |
if split_path: | |
return [rel_path] + rel_path.split('/') | |
return rel_path | |
results = [ | |
process_full_path(full_path) | |
for full_path in glob.glob(pattern, recursive=recurse) | |
if os.path.isfile(full_path) | |
] | |
return web.json_response(results) | |
def get_user_data_path(request, check_exists = False, param = "file"): | |
file = request.match_info.get(param, None) | |
if not file: | |
return web.Response(status=400) | |
path = self.get_request_user_filepath(request, file) | |
if not path: | |
return web.Response(status=403) | |
if check_exists and not os.path.exists(path): | |
return web.Response(status=404) | |
return path | |
async def getuserdata(request): | |
path = get_user_data_path(request, check_exists=True) | |
if not isinstance(path, str): | |
return path | |
return web.FileResponse(path) | |
async def post_userdata(request): | |
""" | |
Upload or update a user data file. | |
This endpoint handles file uploads to a user's data directory, with options for | |
controlling overwrite behavior and response format. | |
Query Parameters: | |
- overwrite (optional): If "false", prevents overwriting existing files. Defaults to "true". | |
- full_info (optional): If "true", returns detailed file information (path, size, modified time). | |
If "false", returns only the relative file path. | |
Path Parameters: | |
- file: The target file path (URL encoded if necessary). | |
Returns: | |
- 400: If 'file' parameter is missing. | |
- 403: If the requested path is not allowed. | |
- 409: If overwrite=false and the file already exists. | |
- 200: JSON response with either: | |
- Full file information (if full_info=true) | |
- Relative file path (if full_info=false) | |
The request body should contain the raw file content to be written. | |
""" | |
path = get_user_data_path(request) | |
if not isinstance(path, str): | |
return path | |
overwrite = request.query.get("overwrite", 'true') != "false" | |
full_info = request.query.get('full_info', 'false').lower() == "true" | |
if not overwrite and os.path.exists(path): | |
return web.Response(status=409, text="File already exists") | |
body = await request.read() | |
with open(path, "wb") as f: | |
f.write(body) | |
user_path = self.get_request_user_filepath(request, None) | |
if full_info: | |
resp = get_file_info(path, user_path) | |
else: | |
resp = os.path.relpath(path, user_path) | |
return web.json_response(resp) | |
async def delete_userdata(request): | |
path = get_user_data_path(request, check_exists=True) | |
if not isinstance(path, str): | |
return path | |
os.remove(path) | |
return web.Response(status=204) | |
async def move_userdata(request): | |
""" | |
Move or rename a user data file. | |
This endpoint handles moving or renaming files within a user's data directory, with options for | |
controlling overwrite behavior and response format. | |
Path Parameters: | |
- file: The source file path (URL encoded if necessary) | |
- dest: The destination file path (URL encoded if necessary) | |
Query Parameters: | |
- overwrite (optional): If "false", prevents overwriting existing files. Defaults to "true". | |
- full_info (optional): If "true", returns detailed file information (path, size, modified time). | |
If "false", returns only the relative file path. | |
Returns: | |
- 400: If either 'file' or 'dest' parameter is missing | |
- 403: If either requested path is not allowed | |
- 404: If the source file does not exist | |
- 409: If overwrite=false and the destination file already exists | |
- 200: JSON response with either: | |
- Full file information (if full_info=true) | |
- Relative file path (if full_info=false) | |
""" | |
source = get_user_data_path(request, check_exists=True) | |
if not isinstance(source, str): | |
return source | |
dest = get_user_data_path(request, check_exists=False, param="dest") | |
if not isinstance(source, str): | |
return dest | |
overwrite = request.query.get("overwrite", 'true') != "false" | |
full_info = request.query.get('full_info', 'false').lower() == "true" | |
if not overwrite and os.path.exists(dest): | |
return web.Response(status=409, text="File already exists") | |
logging.info(f"moving '{source}' -> '{dest}'") | |
shutil.move(source, dest) | |
user_path = self.get_request_user_filepath(request, None) | |
if full_info: | |
resp = get_file_info(dest, user_path) | |
else: | |
resp = os.path.relpath(dest, user_path) | |
return web.json_response(resp) | |