Files
gpt4free/g4f/gui/server/backend_api.py

612 lines
29 KiB
Python

from __future__ import annotations
import json
import flask
import os
import time
import base64
import logging
import asyncio
import shutil
import random
import datetime
from hashlib import sha256
from urllib.parse import quote_plus
from functools import lru_cache
from flask import Flask, Response, redirect, request, jsonify, send_from_directory
from werkzeug.exceptions import NotFound
from typing import Generator
from pathlib import Path
from urllib.parse import quote_plus
from hashlib import sha256
try:
from PIL import Image
has_pillow = True
except ImportError:
has_pillow = False
try:
from ...integration.markitdown import MarkItDown, StreamInfo
has_markitdown = True
except ImportError as e:
has_markitdown = False
try:
from .crypto import serialization, create_or_read_keys, decrypt_data, encrypt_data, get_session_key
has_crypto = True
except ImportError:
has_crypto = False
from ...client.service import convert_to_provider
from ...providers.asyncio import to_sync_generator
from ...providers.response import FinishReason, AudioResponse, MediaResponse, Reasoning, HiddenResponse
from ...client.helper import filter_markdown
from ...tools.files import supports_filename, get_streaming, get_bucket_dir, get_tempfile
from ...tools.run_tools import iter_run_tools
from ...errors import ModelNotFoundError, ProviderNotFoundError, MissingAuthError, RateLimitError
from ...image import is_allowed_extension, process_image, MEDIA_TYPE_MAP
from ...cookies import get_cookies_dir
from ...image.copy_images import secure_filename, get_source_url, get_media_dir, copy_media
from ...client.service import get_model_and_provider
from ...providers.any_model_map import model_map
from ... import Provider
from ... import models
from .api import Api
logger = logging.getLogger(__name__)
def safe_iter_generator(generator: Generator) -> Generator:
start = next(generator)
def iter_generator():
yield start
yield from generator
return iter_generator()
class Backend_Api(Api):
"""
Handles various endpoints in a Flask application for backend operations.
This class provides methods to interact with models, providers, and to handle
various functionalities like conversations, error handling, and version management.
Attributes:
app (Flask): A Flask application instance.
routes (dict): A dictionary mapping API endpoints to their respective handlers.
"""
def __init__(self, app: Flask) -> None:
"""
Initialize the backend API with the given Flask application.
Args:
app (Flask): Flask application instance to attach routes to.
"""
self.app: Flask = app
self.chat_cache = {}
if has_crypto:
private_key_obj = get_session_key()
public_key_obj = private_key_obj.public_key()
public_key_pem = public_key_obj.public_bytes(
encoding=serialization.Encoding.PEM,
format=serialization.PublicFormat.SubjectPublicKeyInfo
)
sub_private_key, sub_public_key = create_or_read_keys()
def validate_secret(secret: str) -> bool:
"""
Validates the provided secret against the stored public key.
Args:
secret (str): The secret to validate.
Returns:
bool: True if the secret is valid, False otherwise.
"""
try:
decrypted_secret = decrypt_data(sub_private_key, decrypt_data(private_key_obj, secret))
timediff = time.time() - int(decrypted_secret)
return timediff <= 10 and timediff >= 0
except Exception as e:
logger.error(f"Secret validation failed: {e}")
return False
@app.route('/backend-api/v2/public-key', methods=['GET', 'POST'])
def get_public_key():
if not has_crypto:
return jsonify({"error": {"message": "Crypto support is not available"}}), 501
# try:
# diff = time.time() - int(base64.b64decode(request.cookies.get("fingerprint")).decode())
# except Exception as e:
# return jsonify({"error": {"message": "Invalid fingerprint"}}), 403
# if diff > 60 * 60 * 2:
# return jsonify({"error": {"message": "Please refresh the page"}}), 403
# Send the public key to the client for encryption
return jsonify({
"public_key": public_key_pem.decode(),
"data": encrypt_data(sub_public_key, str(int(time.time()))),
"user": request.headers.get("x-user", "error")
})
@app.route('/backend-api/v2/models', methods=['GET'])
@lru_cache(maxsize=1)
def jsonify_models():
return jsonify(self.get_all_models())
@app.route('/backend-api/v2/models/<provider>', methods=['GET'])
def jsonify_provider_models(**kwargs):
try:
response = self.get_provider_models(**kwargs)
if response is None:
return jsonify({"error": {"message": "Provider not found"}}), 404
except MissingAuthError as e:
return jsonify({"error": {"message": f"{type(e).__name__}: {e}"}}), 401
except Exception as e:
logger.exception(e)
return jsonify({"error": {"message": f"{type(e).__name__}: {e}"}}), 500
return jsonify(response)
@app.route('/backend-api/v2/providers', methods=['GET'])
def jsonify_providers(**kwargs):
response = self.get_providers(**kwargs)
return jsonify(response)
def get_demo_models():
return [{
"name": model.name,
"image": isinstance(model, models.ImageModel),
"vision": isinstance(model, models.VisionModel),
"audio": isinstance(model, models.AudioModel),
"video": isinstance(model, models.VideoModel),
"providers": [
provider.get_parent()
for provider in providers
],
"demo": True
}
for model, providers in models.demo_models.values()]
def handle_conversation():
"""
Handles conversation requests and streams responses back.
Returns:
Response: A Flask response object for streaming.
"""
if "json" in request.form:
json_data = request.form['json']
else:
json_data = request.data
try:
json_data = json.loads(json_data)
except json.JSONDecodeError as e:
logger.exception(e)
return jsonify({"error": {"message": "Invalid JSON data"}}), 400
if app.demo and has_crypto:
secret = request.headers.get("x_secret")
if not secret or not validate_secret(secret):
return jsonify({"error": {"message": "Invalid or missing secret"}}), 403
tempfiles = []
media = []
if "files" in request.files:
for file in request.files.getlist('files'):
if file.filename != '' and is_allowed_extension(file.filename):
newfile = get_tempfile(file)
tempfiles.append(newfile)
media.append((Path(newfile), file.filename))
if "media_url" in request.form:
for url in request.form.getlist("media_url"):
media.append((url, None))
if media:
json_data['media'] = media
if app.timeout:
json_data['timeout'] = app.timeout
if app.stream_timeout:
json_data['stream_timeout'] = app.stream_timeout
if app.demo and not json_data.get("provider"):
model = json_data.get("model")
if model != "default" and model in models.demo_models:
json_data["provider"] = random.choice(models.demo_models[model][1])
else:
json_data["provider"] = models.HuggingFace
if app.demo:
json_data["user"] = request.headers.get("x-user", "error")
json_data["referer"] = request.headers.get("referer", "")
json_data["user-agent"] = request.headers.get("user-agent", "")
kwargs = self._prepare_conversation_kwargs(json_data)
provider = kwargs.pop("provider", None)
if provider and provider not in Provider.__map__:
if provider in model_map:
kwargs['model'] = provider
provider = None
else:
return jsonify({"error": {"message": "Provider not found"}}), 404
return self.app.response_class(
safe_iter_generator(self._create_response_stream(
kwargs,
provider,
json_data.get("download_media", True),
tempfiles
)),
mimetype='text/event-stream'
)
@app.route('/backend-api/v2/conversation', methods=['POST'])
def _handle_conversation():
return handle_conversation()
@app.route('/backend-api/v2/usage', methods=['POST'])
def add_usage():
cache_dir = Path(get_cookies_dir()) / ".usage"
cache_file = cache_dir / f"{datetime.date.today()}.jsonl"
cache_dir.mkdir(parents=True, exist_ok=True)
data = {**request.json, "user": request.headers.get("x-user", "unknown")}
with cache_file.open("a" if cache_file.exists() else "w") as f:
f.write(f"{json.dumps(data)}\n")
return {}
@app.route('/backend-api/v2/usage/<date>', methods=['GET'])
def get_usage(date: str):
cache_dir = Path(get_cookies_dir()) / ".usage"
cache_file = cache_dir / f"{date}.jsonl"
return cache_file.read_text() if cache_file.exists() else (jsonify({"error": {"message": "No usage data found for this date"}}), 404)
@app.route('/backend-api/v2/log', methods=['POST'])
def add_log():
cache_dir = Path(get_cookies_dir()) / ".logging"
cache_file = cache_dir / f"{datetime.date.today()}.jsonl"
cache_dir.mkdir(parents=True, exist_ok=True)
data = {"origin": request.headers.get("origin"), **request.json}
with cache_file.open("a" if cache_file.exists() else "w") as f:
f.write(f"{json.dumps(data)}\n")
return {}
self.routes = {
'/backend-api/v2/synthesize/<provider>': {
'function': self.handle_synthesize,
'methods': ['GET']
},
'/images/<path:name>': {
'function': self.serve_images,
'methods': ['GET']
},
'/media/<path:name>': {
'function': self.serve_images,
'methods': ['GET']
},
'/thumbnail/<path:name>': {
'function': self.serve_images,
'methods': ['GET']
},
}
@app.route('/backend-api/v2/version', methods=['GET'])
def version():
resp = jsonify(self.get_version())
resp.set_cookie('fingerprint', base64.b64encode(str(int(time.time())).encode()).decode(), max_age=60 * 60 *2, httponly=True, secure=True)
return resp
@app.route('/backend-api/v2/create', methods=['GET'])
def create():
try:
web_search = request.args.get("web_search")
if web_search:
is_true_web_search = web_search.lower() in ["true", "1"]
web_search = True if is_true_web_search else web_search
do_filter = request.args.get("filter_markdown", request.args.get("json"))
cache_id = request.args.get('cache')
model, provider_handler = get_model_and_provider(
request.args.get("model"), request.args.get("provider", request.args.get("audio_provider")),
stream=request.args.get("stream") and not do_filter and not cache_id,
ignore_stream=not request.args.get("stream"),
)
parameters = {
"model": model,
"messages": [{"role": "user", "content": request.args.get("prompt")}],
"stream": not do_filter and not cache_id,
"web_search": web_search,
}
if request.args.get("audio_provider") or request.args.get("audio"):
parameters["audio"] = {}
def cast_str(response):
buffer = next(response)
while isinstance(buffer, (Reasoning, HiddenResponse)):
buffer = next(response)
if isinstance(buffer, MediaResponse):
if len(buffer.get_list()) == 1:
if not cache_id:
return buffer.get_list()[0]
return "\n".join(asyncio.run(copy_media(
buffer.get_list(),
buffer.get("cookies"),
buffer.get("headers"),
alt=buffer.alt
)))
elif isinstance(buffer, AudioResponse):
return buffer.data
def iter_response():
yield str(buffer)
for chunk in response:
if isinstance(chunk, FinishReason):
yield f"[{chunk.reason}]" if chunk.reason != "stop" else ""
elif not isinstance(chunk, Exception):
chunk = str(chunk)
if chunk:
yield chunk
return iter_response()
if cache_id:
cache_id = sha256(cache_id.encode() + json.dumps(parameters, sort_keys=True).encode()).hexdigest()
cache_dir = Path(get_cookies_dir()) / ".scrape_cache" / "create"
cache_file = cache_dir / f"{quote_plus(request.args.get('prompt', '').strip()[:20])}.{cache_id}.txt"
response = None
if cache_file.exists():
with cache_file.open("r") as f:
response = f.read()
if not response:
response = iter_run_tools(provider_handler, **parameters)
cache_dir.mkdir(parents=True, exist_ok=True)
response = cast_str(response)
response = response if isinstance(response, str) else "".join(response)
if response:
with cache_file.open("w") as f:
f.write(response)
else:
response = cast_str(iter_run_tools(provider_handler, **parameters))
if isinstance(response, str) and "\n" not in response:
if response.startswith("/media/"):
media_dir = get_media_dir()
filename = os.path.basename(response.split("?")[0])
try:
return send_from_directory(os.path.abspath(media_dir), filename)
finally:
if not cache_id:
os.remove(os.path.join(media_dir, filename))
elif response.startswith("https://") or response.startswith("http://"):
return redirect(response)
if do_filter:
is_true_filter = do_filter.lower() in ["true", "1"]
response = response if isinstance(response, str) else "".join(response)
return Response(filter_markdown(response, None if is_true_filter else do_filter, response if is_true_filter else ""), mimetype='text/plain')
return Response(response, mimetype='text/plain')
except (ModelNotFoundError, ProviderNotFoundError) as e:
return jsonify({"error": {"message": f"{type(e).__name__}: {e}"}}), 404
except MissingAuthError as e:
return jsonify({"error": {"message": f"{type(e).__name__}: {e}"}}), 401
except RateLimitError as e:
return jsonify({"error": {"message": f"{type(e).__name__}: {e}"}}), 429
except Exception as e:
logger.exception(e)
return jsonify({"error": {"message": f"{type(e).__name__}: {e}"}}), 500
@app.route('/backend-api/v2/files/<bucket_id>/stream', methods=['GET'])
def stream_files(bucket_id: str, event_stream=True):
return manage_files(bucket_id, event_stream)
@app.route('/backend-api/v2/files/<bucket_id>', methods=['GET', 'DELETE'])
def manage_files(bucket_id: str, event_stream=False):
bucket_id = secure_filename(bucket_id)
bucket_dir = get_bucket_dir(bucket_id)
if not os.path.isdir(bucket_dir):
return jsonify({"error": {"message": "Bucket directory not found"}}), 404
if request.method == 'DELETE':
try:
shutil.rmtree(bucket_dir)
return jsonify({"message": "Bucket deleted successfully"}), 200
except OSError as e:
return jsonify({"error": {"message": f"Error deleting bucket: {str(e)}"}}), 500
except Exception as e:
return jsonify({"error": {"message": str(e)}}), 500
delete_files = request.args.get('delete_files', True)
refine_chunks_with_spacy = request.args.get('refine_chunks_with_spacy', False)
event_stream = event_stream or 'text/event-stream' in request.headers.get('Accept', '')
mimetype = "text/event-stream" if event_stream else "text/plain"
return Response(get_streaming(bucket_dir, delete_files, refine_chunks_with_spacy, event_stream), mimetype=mimetype)
@self.app.route('/backend-api/v2/files/<bucket_id>', methods=['POST'])
def upload_files(bucket_id: str):
bucket_id = secure_filename(bucket_id)
bucket_dir = get_bucket_dir(bucket_id)
media_dir = os.path.join(bucket_dir, "media")
os.makedirs(bucket_dir, exist_ok=True)
filenames = []
media = []
for file in request.files.getlist('files'):
filename = secure_filename(file.filename)
mimetype = file.mimetype.split(";")[0]
if (not filename or filename == "blob") and mimetype in MEDIA_TYPE_MAP:
filename = f"file.{MEDIA_TYPE_MAP[mimetype]}"
suffix = os.path.splitext(filename)[1].lower()
copyfile = get_tempfile(file, suffix)
result = None
if has_markitdown and not filename.endswith((".md", ".json", ".zip")):
try:
language = request.headers.get("x-recognition-language")
md = MarkItDown()
result = md.convert(copyfile, stream_info=StreamInfo(
extension=suffix,
mimetype=file.mimetype,
), recognition_language=language).text_content
except Exception as e:
logger.exception(e)
is_media = is_allowed_extension(filename)
is_supported = result or supports_filename(filename)
if not is_media and not is_supported:
os.remove(copyfile)
continue
if not is_media and result:
with open(os.path.join(bucket_dir, f"{filename}.md"), 'w') as f:
f.write(f"{result}\n")
filenames.append(f"{filename}.md")
if is_media:
os.makedirs(media_dir, exist_ok=True)
newfile = os.path.join(media_dir, filename)
image_size = {}
if has_pillow:
try:
image = Image.open(copyfile)
width, height = image.size
image_size = {"width": width, "height": height}
thumbnail_dir = os.path.join(bucket_dir, "thumbnail")
os.makedirs(thumbnail_dir, exist_ok=True)
process_image(image, save=os.path.join(thumbnail_dir, filename))
except Exception as e:
logger.exception(e)
if result:
media.append({"name": filename, "text": result, **image_size})
else:
media.append({"name": filename, **image_size})
elif is_supported and not result:
newfile = os.path.join(bucket_dir, filename)
filenames.append(filename)
else:
os.remove(copyfile)
if not result:
raise ValueError(f"Unsupported file type: {filename}")
continue
try:
os.rename(copyfile, newfile)
except OSError:
shutil.copyfile(copyfile, newfile)
os.remove(copyfile)
with open(os.path.join(bucket_dir, "files.txt"), 'w') as f:
for filename in filenames:
f.write(f"{filename}\n")
return {"bucket_id": bucket_id, "files": filenames, "media": media}
@app.route('/files/<bucket_id>/<file_type>/<filename>', methods=['GET'])
def get_media(bucket_id, file_type: str, filename, dirname: str = None):
if file_type not in ["media", "thumbnail"]:
return jsonify({"error": {"message": "Invalid file type"}}), 400
if file_type == "thumbnail":
media_dir = get_bucket_dir(dirname, bucket_id, "thumbnail")
try:
return send_from_directory(os.path.abspath(media_dir), filename)
except NotFound:
pass
media_dir = get_bucket_dir(dirname, bucket_id, "media")
try:
return send_from_directory(os.path.abspath(media_dir), filename)
except NotFound:
source_url = get_source_url(request.query_string.decode())
if source_url is not None:
return redirect(source_url)
raise
self.match_files = {}
@app.route('/search/<search>', methods=['GET'])
def find_media(search: str):
safe_search = [secure_filename(chunk.lower()) for chunk in search.split("+")]
media_dir = get_media_dir()
if not os.access(media_dir, os.R_OK):
return jsonify({"error": {"message": "Not found"}}), 404
if search not in self.match_files:
self.match_files[search] = {}
found_mime_type = False
for root, _, files in os.walk(media_dir):
for file in files:
mime_type = is_allowed_extension(file)
if mime_type is not None:
mime_type = secure_filename(mime_type)
if safe_search[0] in mime_type:
found_mime_type = True
self.match_files[search][file] = self.match_files[search].get(file, 0) + 1
for tag in safe_search[1:] if found_mime_type else safe_search:
if tag in file.lower():
self.match_files[search][file] = self.match_files[search].get(file, 0) + 1
break
match_files = [file for file, count in self.match_files[search].items() if count >= request.args.get("min", len(safe_search))]
if int(request.args.get("skip") or 0) >= len(match_files):
return jsonify({"error": {"message": "Not found"}}), 404
if (request.args.get("random", False)):
seed = request.args.get("random")
if seed not in ["true", "True", "1"]:
random.seed(seed)
return redirect(f"/media/{random.choice(match_files)}"), 302
return redirect(f"/media/{match_files[int(request.args.get('skip') or 0)]}", 302)
@app.route('/backend-api/v2/upload_cookies', methods=['POST'])
def upload_cookies():
file = None
if "file" in request.files:
file = request.files['file']
if file.filename == '':
return 'No selected file', 400
if file and file.filename.endswith(".json") or file.filename.endswith(".har"):
filename = secure_filename(file.filename)
file.save(os.path.join(get_cookies_dir(), filename))
return "File saved", 200
return 'Not supported file', 400
@self.app.route('/backend-api/v2/chat/<share_id>', methods=['GET'])
def get_chat(share_id: str) -> str:
share_id = secure_filename(share_id)
if self.chat_cache.get(share_id, 0) == int(request.headers.get("if-none-match", -1)):
return jsonify({"error": {"message": "Not modified"}}), 304
file = get_bucket_dir(share_id, "chat.json")
if not os.path.isfile(file):
return jsonify({"error": {"message": "Not found"}}), 404
with open(file, 'r') as f:
chat_data = json.load(f)
if chat_data.get("updated", 0) == int(request.headers.get("if-none-match", -1)):
return jsonify({"error": {"message": "Not modified"}}), 304
self.chat_cache[share_id] = chat_data.get("updated", 0)
return jsonify(chat_data), 200
@self.app.route('/backend-api/v2/chat/<share_id>', methods=['POST'])
def upload_chat(share_id: str) -> dict:
chat_data = {**request.json}
updated = chat_data.get("updated", 0)
cache_value = self.chat_cache.get(share_id, 0)
if updated == cache_value:
return {"share_id": share_id}
share_id = secure_filename(share_id)
bucket_dir = get_bucket_dir(share_id)
os.makedirs(bucket_dir, exist_ok=True)
with open(os.path.join(bucket_dir, "chat.json"), 'w') as f:
json.dump(chat_data, f)
self.chat_cache[share_id] = updated
return {"share_id": share_id}
def handle_synthesize(self, provider: str):
try:
provider_handler = convert_to_provider(provider)
except ProviderNotFoundError:
return "Provider not found", 404
if not hasattr(provider_handler, "synthesize"):
return "Provider doesn't support synthesize", 500
response_data = provider_handler.synthesize({**request.args})
if asyncio.iscoroutinefunction(provider_handler.synthesize):
response_data = asyncio.run(response_data)
else:
if hasattr(response_data, "__aiter__"):
response_data = to_sync_generator(response_data)
response_data = safe_iter_generator(response_data)
content_type = getattr(provider_handler, "synthesize_content_type", "application/octet-stream")
response = flask.Response(response_data, content_type=content_type)
response.headers['Cache-Control'] = "max-age=604800"
return response
def get_provider_models(self, provider: str):
api_key = request.headers.get("x-api-key")
api_base = request.headers.get("x-api-base")
ignored = request.headers.get("x-ignored", "").split()
return super().get_provider_models(provider, api_key, api_base, ignored)
def _format_json(self, response_type: str, content = None, **kwargs) -> str:
"""
Formats and returns a JSON response.
Args:
response_type (str): The type of the response.
content: The content to be included in the response.
Returns:
str: A JSON formatted string.
"""
return json.dumps(super()._format_json(response_type, content, **kwargs)) + "\n"