Skip to content

Self-hosted personal gallery application with online photo management and albums, supporting Live/Motion Photos, EXIF parsing, geolocation recognition, and an explore map.

feat(storage-provider): add OpenList storage provider support (#115)

ksmlc93528fcc667f
diff --git a/.env.example b/.env.example
index c5d48922..66a81465 100644
--- a/.env.example
+++ b/.env.example
@@ -1,4 +1,4 @@
-# Admin user email (required)
+# Admin user email (required)
CFRAME_ADMIN_EMAIL=
# Admin user name (default to Chronoframe, optional)
CFRAME_ADMIN_NAME=
@@ -24,7 +24,7 @@ NUXT_PUBLIC_MAPBOX_ACCESS_TOKEN=
# Mapbox secret access token for server-side, Mapbox Search API (Reverse Geocoding)
NUXT_MAPBOX_ACCESS_TOKEN=
-# Storage provider (s3/local)
+# Storage provider (s3/local/openlist)
NUXT_STORAGE_PROVIDER=s3
# S3 storage provider configuration
NUXT_PROVIDER_S3_ENDPOINT=
@@ -42,6 +42,21 @@ NUXT_PROVIDER_LOCAL_PATH=./data/storage
# external access base URL for local storage, e.g. /storage (built-in /storage route)
NUXT_PROVIDER_LOCAL_BASE_URL=/storage
+# OpenList storage provider configuration
+# OpenList base URL, e.g. https://your-openlist-server.com.
+NUXT_PROVIDER_OPENLIST_BASE_URL=
+# OpenList root path, e.g. /115pan/chronoframe/photos
+NUXT_PROVIDER_OPENLIST_ROOT_PATH=
+# Authentication - Token authentication (recommended)
+NUXT_PROVIDER_OPENLIST_TOKEN=
+NUXT_PROVIDER_OPENLIST_ENDPOINT_UPLOAD=/api/fs/put
+NUXT_PROVIDER_OPENLIST_ENDPOINT_DOWNLOAD=
+NUXT_PROVIDER_OPENLIST_ENDPOINT_LIST=
+NUXT_PROVIDER_OPENLIST_ENDPOINT_DELETE=/api/fs/remove
+NUXT_PROVIDER_OPENLIST_ENDPOINT_META=/api/fs/get
+NUXT_PROVIDER_OPENLIST_PATH_FIELD=path
+NUXT_PROVIDER_OPENLIST_CDN_URL=
+
# Session password for encrypting session data, 32 characters long
NUXT_SESSION_PASSWORD=
diff --git a/README.md b/README.md
index e91eccbe..ec6fa095 100644
--- a/README.md
+++ b/README.md
@@ -73,7 +73,7 @@ NUXT_PUBLIC_MAPBOX_ACCESS_TOKEN=
# Mapbox unrestricted token (optional, reverse geocoding)
NUXT_MAPBOX_ACCESS_TOKEN=
-# Storage provider (local or s3)
+# Storage provider (local, s3 or openlist)
NUXT_STORAGE_PROVIDER=local
NUXT_PROVIDER_LOCAL_PATH=/app/data/storage
diff --git a/README_zh.md b/README_zh.md
index 3102c4f9..a31d2b61 100644
--- a/README_zh.md
+++ b/README_zh.md
@@ -73,7 +73,7 @@ NUXT_PUBLIC_MAPBOX_ACCESS_TOKEN=
# Mapbox 无域名限制令牌(反向地理编码,可选)
NUXT_MAPBOX_ACCESS_TOKEN=
-# 存储提供者(local 或 s3)
+# 存储提供者(local、s3 或 openlist)
NUXT_STORAGE_PROVIDER=local
NUXT_PROVIDER_LOCAL_PATH=/app/data/storage
diff --git a/app/components/photo/ProgressiveImage.vue b/app/components/photo/ProgressiveImage.vue
index 550aab39..f045948f 100644
--- a/app/components/photo/ProgressiveImage.vue
+++ b/app/components/photo/ProgressiveImage.vue
@@ -53,6 +53,7 @@ const hasError = ref(false)
const currentSrc = ref<string | null>()
const isDev = computed(() => import.meta.env.DEV)
+const showDebugInfo = computed(() => isDev.value && import.meta.env.VITE_SHOW_DEBUG_INFO === 'true')
// 使用 WebGLImageViewer 的引用
const webglViewerRef = ref()
@@ -194,7 +195,7 @@ onUnmounted(() => {
:pinch="{ step: 0.2 }"
:double-click="{ mode: 'toggle', step: 2.4, animationTime: 400 }"
:panning="{ velocityDisabled: false }"
- :debug="isDev"
+ :debug="showDebugInfo"
@zoom-change="handleZoomChange"
@loading-state-change="handleWebGLStateChange"
/>
diff --git a/docs/configuration/storage-providers.md b/docs/configuration/storage-providers.md
index 3eec31bb..ddb63bda 100644
--- a/docs/configuration/storage-providers.md
+++ b/docs/configuration/storage-providers.md
@@ -6,6 +6,7 @@ ChronoFrame supports multiple storage backends to save your photos and thumbnail
| ------------------------------------------- | :-----: | --------------------------------------- | ------------------ |
| [**S3 Compatible**](#s3-compatible-storage) | ✅ | Production environment, cloud storage | Varies by provider |
| [**Local Filesystem**](#local-filesystem) | ✅ | Testing environment, offline deployment | Free |
+| [**OpenList**](#openlist-storage) | ✅ | Personal cloud storage, NAS | Free |
## S3 Compatible Storage
@@ -123,6 +124,64 @@ NUXT_PROVIDER_LOCAL_PATH=/app/data/storage
NUXT_PROVIDER_LOCAL_BASE_URL=/storage
```
+## OpenList Storage
+
+OpenList is a file listing program that supports multiple cloud storage services.
+
+| Environment Variable | Type | Required | Default | Description |
+|---|---|---|---|---|
+| `NUXT_PROVIDER_OPENLIST_BASE_URL` | string | Yes | - | Base URL of the OpenList service |
+| `NUXT_PROVIDER_OPENLIST_ROOT_PATH` | string | Yes | - | Root storage path |
+| `NUXT_PROVIDER_OPENLIST_TOKEN` | string | Required | - | Authentication token (required for authentication) |
+| `NUXT_PROVIDER_OPENLIST_ENDPOINT_UPLOAD` | string | Optional | `/api/fs/put` | Upload endpoint |
+| `NUXT_PROVIDER_OPENLIST_ENDPOINT_DOWNLOAD` | string | Optional | - | Download endpoint |
+| `NUXT_PROVIDER_OPENLIST_ENDPOINT_LIST` | string | Optional | - | List endpoint |
+| `NUXT_PROVIDER_OPENLIST_ENDPOINT_DELETE` | string | Optional | `/api/fs/remove` | Delete endpoint |
+| `NUXT_PROVIDER_OPENLIST_ENDPOINT_META` | string | Optional | `/api/fs/get` | Metadata endpoint |
+| `NUXT_PROVIDER_OPENLIST_PATH_FIELD` | string | Optional | `path` | Path field name |
+| `NUXT_PROVIDER_OPENLIST_CDN_URL` | string | Optional | - | CDN URL |
+
+**Authentication:**
+
+OpenList provider requires token authentication for secure access:
+
+```bash
+NUXT_PROVIDER_OPENLIST_TOKEN=your-static-token
+```
+
+### Basic Configuration
+
+```bash
+# Set storage provider to OpenList
+NUXT_STORAGE_PROVIDER=openlist
+
+# OpenList basic configuration
+NUXT_PROVIDER_OPENLIST_BASE_URL=https://your-openlist-server.com
+NUXT_PROVIDER_OPENLIST_ROOT_PATH=/chronoframe/photos
+# Token is required for authentication
+NUXT_PROVIDER_OPENLIST_TOKEN=your-api-token
+
+# Optional configuration
+NUXT_PROVIDER_OPENLIST_ENDPOINT_UPLOAD=/api/fs/put
+NUXT_PROVIDER_OPENLIST_ENDPOINT_DOWNLOAD=
+NUXT_PROVIDER_OPENLIST_ENDPOINT_LIST=
+NUXT_PROVIDER_OPENLIST_ENDPOINT_DELETE=/api/fs/remove
+NUXT_PROVIDER_OPENLIST_ENDPOINT_META=/api/fs/get
+NUXT_PROVIDER_OPENLIST_PATH_FIELD=path
+NUXT_PROVIDER_OPENLIST_CDN_URL=
+```
+
+### Configuration Examples
+
+#### OpenList
+
+```bash
+NUXT_STORAGE_PROVIDER=openlist
+NUXT_PROVIDER_OPENLIST_BASE_URL=https://your-openlist-server.com
+NUXT_PROVIDER_OPENLIST_ROOT_PATH=/local/chronoframe
+NUXT_PROVIDER_OPENLIST_TOKEN=your-static-token
+```
+
## Common Issues
:::details `The AWS Access Key Id you provided does not exist in our records`
diff --git a/docs/guide/configuration.md b/docs/guide/configuration.md
index 938768e0..c0660271 100644
--- a/docs/guide/configuration.md
+++ b/docs/guide/configuration.md
@@ -17,7 +17,7 @@ Whether using Docker or Docker Compose (.env) deployment, configuration is done
| NUXT_PUBLIC_MAP_PROVIDER | Map provider, options: `mapbox`, `maplibre` | `maplibre` | No |
| NUXT_PUBLIC_MAPBOX_ACCESS_TOKEN | Mapbox access token (URL restricted), for map services | None | Required when `NUXT_PUBLIC_MAP_PROVIDER` is `mapbox` |
| NUXT_MAPBOX_ACCESS_TOKEN | Mapbox access token (no URL restriction), for location services | None | No |
-| NUXT_STORAGE_PROVIDER | Storage provider, supports `local`, `s3` | `local` | Yes |
+| NUXT_STORAGE_PROVIDER | Storage provider, supports `local`, `s3`, `openlist` | `local` | Yes |
| NUXT_PROVIDER_LOCAL_PATH | Local storage path | `/app/data/storage` | No |
| NUXT_PROVIDER_LOCAL_BASE_URL | Local storage access URL | `/storage` | No |
| NUXT_PROVIDER_S3_ENDPOINT | S3 compatible storage service endpoint | None | Required when `NUXT_STORAGE_PROVIDER` is `s3` |
@@ -27,6 +27,16 @@ Whether using Docker or Docker Compose (.env) deployment, configuration is done
| NUXT_PROVIDER_S3_SECRET_ACCESS_KEY | S3 secret access key | None | Required when `NUXT_STORAGE_PROVIDER` is `s3` |
| NUXT_PROVIDER_S3_PREFIX | S3 storage prefix | `photos/` | No |
| NUXT_PROVIDER_S3_CDN_URL | S3 storage CDN URL | None | No |
+| NUXT_PROVIDER_OPENLIST_BASE_URL | OpenList server URL | None | Required when `NUXT_STORAGE_PROVIDER` is `openlist` |
+| NUXT_PROVIDER_OPENLIST_ROOT_PATH | OpenList root path | None | Required when `NUXT_STORAGE_PROVIDER` is `openlist` |
+| NUXT_PROVIDER_OPENLIST_TOKEN | OpenList API token | None | Recommended (for OpenList authentication) |
+| NUXT_PROVIDER_OPENLIST_ENDPOINT_UPLOAD| OpenList upload endpoint | `/api/fs/put` | No |
+| NUXT_PROVIDER_OPENLIST_ENDPOINT_DOWNLOAD| OpenList download endpoint | None | No |
+| NUXT_PROVIDER_OPENLIST_ENDPOINT_LIST | OpenList list endpoint | None | No |
+| NUXT_PROVIDER_OPENLIST_ENDPOINT_DELETE| OpenList delete endpoint | `/api/fs/remove` | No |
+| NUXT_PROVIDER_OPENLIST_ENDPOINT_META | OpenList metadata endpoint | `/api/fs/get` | No |
+| NUXT_PROVIDER_OPENLIST_PATH_FIELD | OpenList path field name | `path` | No |
+| NUXT_PROVIDER_OPENLIST_CDN_URL | OpenList CDN URL | None | No |
| NUXT_PUBLIC_OAUTH_GITHUB_ENABLED | Enable GitHub OAuth login | `false` | No |
| NUXT_OAUTH_GITHUB_CLIENT_ID | GitHub OAuth app Client ID | None | No (optional, for GitHub login) |
| NUXT_OAUTH_GITHUB_CLIENT_SECRET | GitHub OAuth app Client Secret | None | No (optional, for GitHub login) |
diff --git a/docs/guide/getting-started.md b/docs/guide/getting-started.md
index 046c1d98..0c8c8d5b 100644
--- a/docs/guide/getting-started.md
+++ b/docs/guide/getting-started.md
@@ -64,7 +64,7 @@ NUXT_PUBLIC_MAP_MAPLIBRE_TOKEN=
# Mapbox access token for Mapbox
NUXT_PUBLIC_MAPBOX_ACCESS_TOKEN=
-# Storage provider (local or s3)
+# Storage provider (local or s3 or openlist)
NUXT_STORAGE_PROVIDER=local
NUXT_PROVIDER_LOCAL_PATH=/app/data/storage
@@ -85,6 +85,15 @@ NUXT_PROVIDER_S3_PREFIX=photos/
NUXT_PROVIDER_S3_CDN_URL=
```
+If you want to use openlist instead of local storage, replace the storage section with:
+
+```bash
+NUXT_STORAGE_PROVIDER=openlist
+NUXT_PROVIDER_OPENLIST_BASE_URL=https://openlist.example.com
+NUXT_PROVIDER_OPENLIST_ROOT_PATH=/115pan/chronoframe
+NUXT_PROVIDER_OPENLIST_TOKEN=your-static-token
+```
+
Optional GitHub OAuth variables:
```bash
diff --git a/docs/zh/configuration/storage-providers.md b/docs/zh/configuration/storage-providers.md
index 652a7831..1cca6cf9 100644
--- a/docs/zh/configuration/storage-providers.md
+++ b/docs/zh/configuration/storage-providers.md
@@ -6,6 +6,7 @@ ChronoFrame 支持多种存储后端来保存您的照片和缩略图。本文
| --------------------------------- | :--: | ------------------ | ------------ |
| [**S3 兼容存储**](#s3-兼容存储) | ✅ | 生产环境,云存储 | 按使用量计费 |
| [**本地文件系统**](#本地文件系统) | ✅ | 测试环境,离线部署 | 免费 |
+| [**OpenList**](#openlist-存储) | ✅ | 个人云存储,NAS | 免费 |
## S3 兼容存储
@@ -123,6 +124,64 @@ NUXT_PROVIDER_LOCAL_PATH=/app/data/storage
NUXT_PROVIDER_LOCAL_BASE_URL=/storage
```
+## OpenList 存储
+
+OpenList 是一个开源的文件管理系统,提供对各种云存储服务的 API 访问。此提供程序允许您使用与 OpenList 兼容的服务作为照片存储后端。
+
+| 环境变量 | 类型 | 必需 | 默认值 | 描述 |
+|---|---|---|---|---|
+| `NUXT_PROVIDER_OPENLIST_BASE_URL` | string | 是 | - | OpenList 服务的基础 URL |
+| `NUXT_PROVIDER_OPENLIST_ROOT_PATH` | string | 是 | - | 根存储路径 |
+| `NUXT_PROVIDER_OPENLIST_TOKEN` | string | 必需 | - | 认证令牌(认证时必需) |
+| `NUXT_PROVIDER_OPENLIST_ENDPOINT_UPLOAD` | string | 可选 | `/api/fs/put` | 上传端点 |
+| `NUXT_PROVIDER_OPENLIST_ENDPOINT_DOWNLOAD` | string | 可选 | - | 下载端点 |
+| `NUXT_PROVIDER_OPENLIST_ENDPOINT_LIST` | string | 可选 | - | 列表端点 |
+| `NUXT_PROVIDER_OPENLIST_ENDPOINT_DELETE` | string | 可选 | `/api/fs/remove` | 删除端点 |
+| `NUXT_PROVIDER_OPENLIST_ENDPOINT_META` | string | 可选 | `/api/fs/get` | 元数据端点 |
+| `NUXT_PROVIDER_OPENLIST_PATH_FIELD` | string | 可选 | `path` | 路径字段名 |
+| `NUXT_PROVIDER_OPENLIST_CDN_URL` | string | 可选 | - | CDN URL |
+
+**认证:**
+
+OpenList 提供程序需要令牌认证以确保安全访问:
+
+```bash
+NUXT_PROVIDER_OPENLIST_TOKEN=your-static-token
+```
+
+### 基础配置
+
+```bash
+# 设置存储提供器为 OpenList
+NUXT_STORAGE_PROVIDER=openlist
+
+# OpenList 基础配置
+NUXT_PROVIDER_OPENLIST_BASE_URL=https://your-openlist-server.com
+NUXT_PROVIDER_OPENLIST_ROOT_PATH=/chronoframe/photos
+
+# 认证配置 - Token 认证
+NUXT_PROVIDER_OPENLIST_TOKEN=your-api-token
+
+# 可选配置
+NUXT_PROVIDER_OPENLIST_ENDPOINT_UPLOAD=/api/fs/put
+NUXT_PROVIDER_OPENLIST_ENDPOINT_DOWNLOAD=
+NUXT_PROVIDER_OPENLIST_ENDPOINT_LIST=
+NUXT_PROVIDER_OPENLIST_ENDPOINT_DELETE=/api/fs/remove
+NUXT_PROVIDER_OPENLIST_ENDPOINT_META=/api/fs/get
+NUXT_PROVIDER_OPENLIST_PATH_FIELD=path
+NUXT_PROVIDER_OPENLIST_CDN_URL=
+```
+
+### 配置示例
+#### OpenList(理论上Alist也可行)
+
+```bash
+NUXT_STORAGE_PROVIDER=openlist
+NUXT_PROVIDER_OPENLIST_BASE_URL=https://openlist.example.com
+NUXT_PROVIDER_OPENLIST_ROOT_PATH=/115pan/chronoframe
+NUXT_PROVIDER_OPENLIST_TOKEN=your-static-token
+```
+
## 常见问题
:::details `The AWS Access Key Id you provided does not exist in our records`
diff --git a/docs/zh/guide/configuration.md b/docs/zh/guide/configuration.md
index acc3b853..ca5b12a8 100644
--- a/docs/zh/guide/configuration.md
+++ b/docs/zh/guide/configuration.md
@@ -17,7 +17,7 @@
| NUXT_PUBLIC_MAP_PROVIDER | 地图提供者,可选 `mapbox`、`maplibre` | `maplibre` | 否 |
| NUXT_PUBLIC_MAPBOX_ACCESS_TOKEN | Mapbox 访问令牌(可限制 URL),用于地图服务 | 无 | 当 `NUXT_PUBLIC_MAP_PROVIDER` 为 `mapbox` 时必需 |
| NUXT_MAPBOX_ACCESS_TOKEN | Mapbox 访问令牌(无 URL 限制),用于位置信息服务 | 无 | 否 |
-| NUXT_STORAGE_PROVIDER | 存储提供者,支持 `local`、`s3` | `local` | 是 |
+| NUXT_STORAGE_PROVIDER | 存储提供者,支持 `local`、`s3`、`openlist` | `local` | 是 |
| NUXT_PROVIDER_LOCAL_PATH | 本地存储路径 | `/app/data/storage` | 否 |
| NUXT_PROVIDER_LOCAL_BASE_URL | 本地存储的访问 URL | `/storage` | 否 |
| NUXT_PROVIDER_S3_ENDPOINT | S3 兼容存储服务的 Endpoint | 无 | 当 `NUXT_STORAGE_PROVIDER` 为 `s3` 时必需 |
@@ -27,6 +27,16 @@
| NUXT_PROVIDER_S3_SECRET_ACCESS_KEY | S3 访问密钥 | 无 | 当 `NUXT_STORAGE_PROVIDER` 为 `s3` 时必需 |
| NUXT_PROVIDER_S3_PREFIX | S3 存储前缀 | `photos/` | 否 |
| NUXT_PROVIDER_S3_CDN_URL | S3 存储的 CDN 地址 | 无 | 否 |
+| NUXT_PROVIDER_OPENLIST_BASE_URL | OpenList 服务器 URL | 无 | 当 `NUXT_STORAGE_PROVIDER` 为 `openlist` 时必需 |
+| NUXT_PROVIDER_OPENLIST_ROOT_PATH | OpenList 根路径 | 无 | 当 `NUXT_STORAGE_PROVIDER` 为 `openlist` 时必需 |
+| NUXT_PROVIDER_OPENLIST_TOKEN | OpenList API 令牌 | 无 | 当 `NUXT_STORAGE_PROVIDER` 为 `openlist` 时必需(用于 OpenList 认证) |
+| NUXT_PROVIDER_OPENLIST_ENDPOINT_UPLOAD| OpenList 上传端点 | `/api/fs/put` | 否 |
+| NUXT_PROVIDER_OPENLIST_ENDPOINT_DOWNLOAD| OpenList 下载端点 | 无 | 否 |
+| NUXT_PROVIDER_OPENLIST_ENDPOINT_LIST | OpenList 列表端点 | 无 | 否 |
+| NUXT_PROVIDER_OPENLIST_ENDPOINT_DELETE| OpenList 删除端点 | `/api/fs/remove` | 否 |
+| NUXT_PROVIDER_OPENLIST_ENDPOINT_META | OpenList 元数据端点 | `/api/fs/get` | 否 |
+| NUXT_PROVIDER_OPENLIST_PATH_FIELD | OpenList 路径字段名 | `path` | 否 |
+| NUXT_PROVIDER_OPENLIST_CDN_URL | OpenList CDN 地址 | 无 | 否 |
| NUXT_PUBLIC_OAUTH_GITHUB_ENABLED | 是否启用 GitHub OAuth 登录 | `false` | 否 |
| NUXT_OAUTH_GITHUB_CLIENT_ID | GitHub OAuth 应用的 Client ID | 无 | 否(可选,用于 GitHub 登录) |
| NUXT_OAUTH_GITHUB_CLIENT_SECRET | GitHub OAuth 应用的 Client Secret | 无 | 否(可选,用于 GitHub 登录) |
diff --git a/docs/zh/guide/getting-started.md b/docs/zh/guide/getting-started.md
index d2a1a592..4ea325c2 100644
--- a/docs/zh/guide/getting-started.md
+++ b/docs/zh/guide/getting-started.md
@@ -62,7 +62,7 @@ NUXT_PUBLIC_MAP_MAPLIBRE_TOKEN=
# 使用 Mapbox 需要 Mapbox 访问令牌
NUXT_PUBLIC_MAPBOX_ACCESS_TOKEN=
-# 存储提供者(local 或 s3)
+# 存储提供者(local 或 s3 或 openlist)
NUXT_STORAGE_PROVIDER=local
NUXT_PROVIDER_LOCAL_PATH=/app/data/storage
@@ -83,6 +83,15 @@ NUXT_PROVIDER_S3_PREFIX=photos/
NUXT_PROVIDER_S3_CDN_URL=
```
+若选择使用 openlist,请将存储部分替换为:
+
+```bash
+NUXT_STORAGE_PROVIDER=openlist
+NUXT_PROVIDER_OPENLIST_BASE_URL=https://openlist.example.com
+NUXT_PROVIDER_OPENLIST_ROOT_PATH=/115pan/chronoframe
+NUXT_PROVIDER_OPENLIST_TOKEN=your-static-token
+```
+
可选 GitHub OAuth 变量:
```bash
diff --git a/nuxt.config.ts b/nuxt.config.ts
index 6e90efc2..7e1557de 100644
--- a/nuxt.config.ts
+++ b/nuxt.config.ts
@@ -69,7 +69,7 @@ export default defineNuxtConfig({
mapbox: {
accessToken: '',
},
- STORAGE_PROVIDER: 's3' satisfies 's3' | 'local',
+ STORAGE_PROVIDER: 's3' satisfies 's3' | 'local' | 'openlist',
provider: {
s3: {
endpoint: '',
@@ -86,6 +86,33 @@ export default defineNuxtConfig({
baseUrl: '/storage',
prefix: 'photos/',
},
+ openlist: {
+ baseUrl: '',
+ rootPath: '',
+ token: '',
+ endpoints: {
+ upload: '/api/fs/put',
+ download: '',
+ list: '',
+ delete: '/api/fs/remove',
+ meta: '/api/fs/get',
+ },
+ pathField: 'path',
+ cdnUrl: '',
+ } as {
+ baseUrl: string;
+ rootPath: string;
+ token: string;
+ endpoints: {
+ upload: string;
+ download: string;
+ list: string;
+ delete: string;
+ meta: string;
+ };
+ pathField: string;
+ cdnUrl: string;
+ },
},
upload: {
mime: {
diff --git a/server/api/photos/upload.put.ts b/server/api/photos/upload.put.ts
index f5b9d040..f275c867 100644
--- a/server/api/photos/upload.put.ts
+++ b/server/api/photos/upload.put.ts
@@ -1,4 +1,5 @@
import { useStorageProvider } from '~~/server/utils/useStorageProvider'
+import { logger } from '~~/server/utils/logger'
export default eventHandler(async (event) => {
await requireUserSession(event)
@@ -43,6 +44,7 @@ export default eventHandler(async (event) => {
}
}
+ // 使用流式处理而不是一次性读取整个文件到内存
const raw = await readRawBody(event, false)
if (!raw || !(raw instanceof Buffer)) {
throw createError({
@@ -70,8 +72,19 @@ export default eventHandler(async (event) => {
})
}
- const buffer = raw
- await storageProvider.create(key.replace(/^\/+/, ''), buffer, contentType)
+ try {
+ await storageProvider.create(key.replace(/^\/+/, ''), raw, contentType)
+ } catch (error) {
+ logger.chrono.error('Storage provider create error:', error)
+ throw createError({
+ statusCode: 500,
+ statusMessage: t('upload.error.uploadFailed.title'),
+ data: {
+ title: t('upload.error.uploadFailed.title'),
+ message: t('upload.error.uploadFailed.message'),
+ },
+ })
+ }
return { ok: true, key }
})
diff --git a/server/plugins/storage.ts b/server/plugins/storage.ts
index 961b63d7..65c03338 100644
--- a/server/plugins/storage.ts
+++ b/server/plugins/storage.ts
@@ -16,7 +16,7 @@ export function getStorageManager(): StorageManager {
export default nitroPlugin(async (nitroApp) => {
const config = useRuntimeConfig()
- const storageConfiguration: Record<'s3' | 'local', StorageConfig> = {
+ const storageConfiguration: Record<'s3' | 'local' | 'openlist', StorageConfig> = {
s3: {
provider: 's3',
bucket: config.provider.s3.bucket,
@@ -36,15 +36,47 @@ export default nitroPlugin(async (nitroApp) => {
baseUrl: config.provider.local.baseUrl || '/storage',
prefix: config.provider.local.prefix || 'photos/',
},
+ openlist: {
+ provider: 'openlist',
+ baseUrl: config.provider.openlist?.baseUrl || '',
+ rootPath: config.provider.openlist?.rootPath || '',
+ token: config.provider.openlist?.token || '',
+ endpoints: {
+ upload: config.provider.openlist?.endpoints?.upload ?? '/api/fs/put',
+ download: config.provider.openlist?.endpoints?.download ?? '',
+ list: config.provider.openlist?.endpoints?.list ?? '',
+ delete: config.provider.openlist?.endpoints?.delete ?? '/api/fs/remove',
+ meta: config.provider.openlist?.endpoints?.meta ?? '/api/fs/get',
+ },
+ pathField: config.provider.openlist?.pathField || 'path',
+ cdnUrl:
+ config.provider.openlist?.cdnUrl ||
+ (config.provider.openlist?.baseUrl
+ ? `${config.provider.openlist.baseUrl.replace(/\/$/, '')}/d`
+ : undefined),
+ },
}
const selectedProvider =
- (config.STORAGE_PROVIDER as 's3' | 'local') || 'local'
+ (config.STORAGE_PROVIDER as 's3' | 'local' | 'openlist') || 'local'
const storageManager = new StorageManager(
storageConfiguration[selectedProvider],
logger.storage,
)
+ if (selectedProvider === 'openlist') {
+ const openlistConfig = storageConfiguration.openlist as any
+ if (!openlistConfig.baseUrl) {
+ logger.storage.error('OpenList baseUrl is not configured. Please set provider.openlist.baseUrl in runtimeConfig or corresponding .env variables.')
+ }
+ if (!openlistConfig.rootPath) {
+ logger.storage.error('OpenList rootPath is not configured. Please set provider.openlist.rootPath in runtimeConfig or corresponding .env variables.')
+ }
+ if (!openlistConfig.token) {
+ logger.storage.error('OpenList token is not configured. Please set provider.openlist.token in runtimeConfig or NUXT_PROVIDER_OPENLIST_TOKEN in .env file.')
+ }
+ }
+
// 设置全局实例
globalStorageManager = storageManager
diff --git a/server/services/storage/index.ts b/server/services/storage/index.ts
index c7c1d24c..ed1607f6 100644
--- a/server/services/storage/index.ts
+++ b/server/services/storage/index.ts
@@ -6,3 +6,4 @@ export { S3StorageProvider } from './providers/s3'
export { HubR2StorageProvider } from './providers/hub-r2'
export { GitHubStorageProvider } from './providers/github'
export { LocalStorageProvider } from './providers/local'
+export { OpenListStorageProvider } from './providers/openlist'
diff --git a/server/services/storage/interfaces.ts b/server/services/storage/interfaces.ts
index f866322c..fe9bc867 100644
--- a/server/services/storage/interfaces.ts
+++ b/server/services/storage/interfaces.ts
@@ -45,11 +45,28 @@ export type LocalStorageConfig = {
prefix?: string
}
+export type OpenListStorageConfig = {
+ provider: 'openlist'
+ baseUrl: string
+ rootPath: string
+ token: string
+ endpoints: {
+ upload: string
+ download: string
+ list: string
+ delete: string
+ meta: string
+ }
+ pathField?: string
+ cdnUrl?: string
+}
+
export type StorageConfig =
| S3StorageConfig
| HubR2StorageConfig
| GitHubStorageConfig
| LocalStorageConfig
+ | OpenListStorageConfig
export interface UploadOptions {
contentType?: string
diff --git a/server/services/storage/manager.ts b/server/services/storage/manager.ts
index f823392f..3b54737d 100644
--- a/server/services/storage/manager.ts
+++ b/server/services/storage/manager.ts
@@ -3,6 +3,7 @@ import { S3StorageProvider } from '.'
import type { Logger } from '../../utils/logger'
import { HubR2StorageProvider } from './providers/hub-r2'
import { LocalStorageProvider } from './providers/local'
+import { OpenListStorageProvider } from './providers/openlist'
// eslint-disable-next-line @typescript-eslint/no-extraneous-class
export class StorageProviderFactory {
@@ -17,6 +18,8 @@ export class StorageProviderFactory {
return new HubR2StorageProvider(config, logger)
case 'local':
return new LocalStorageProvider(config, logger)
+ case 'openlist':
+ return new OpenListStorageProvider(config as any, logger)
case 'github':
// TODO: Implement GitHub storage provider
throw new Error('GitHub storage provider not implemented yet')
diff --git a/server/services/storage/providers/openlist.ts b/server/services/storage/providers/openlist.ts
new file mode 100644
index 00000000..b8459487
--- /dev/null
+++ b/server/services/storage/providers/openlist.ts
@@ -0,0 +1,242 @@
+import type { Logger } from '../../../utils/logger'
+import type { StorageProvider, StorageObject, OpenListStorageConfig } from '../interfaces'
+
+/**
+ * OpenListStorageProvider implements StorageProvider for OpenList API.
+ * Since OpenList API endpoints may vary by deployment, we keep them configurable.
+ */
+export class OpenListStorageProvider implements StorageProvider {
+ config: OpenListStorageConfig
+ private logger?: Logger['storage']
+ private token?: string
+
+ constructor(config: OpenListStorageConfig, logger?: Logger['storage']) {
+ this.config = config
+ this.logger = logger
+ }
+
+ private get baseUrl() {
+ return this.config.baseUrl.replace(/\/$/, '')
+ }
+
+ private get pathField(): string {
+ return this.config.pathField || 'path'
+ }
+
+ private async ensureAuthToken(): Promise<string> {
+ if (this.token) return this.token
+ if (this.config.token) {
+ this.token = this.config.token
+ return this.token
+ }
+
+ throw new Error('OpenList auth requires a token. Please configure NUXT_PROVIDER_OPENLIST_TOKEN.')
+ }
+
+ private async request(path: string, init: RequestInit = {}): Promise<Response> {
+ const token = await this.ensureAuthToken()
+ const url = `${this.baseUrl}${path}`
+ const headers: Record<string, string> = {
+ ...(init.headers as Record<string, string> | undefined),
+ Authorization: token,
+ }
+ return fetch(url, { ...init, headers })
+ }
+
+ private normalizedRoot(): string {
+ return (this.config.rootPath || '').replace(/\/+$/g, '').replace(/^\/+/, '')
+ }
+
+ private withRoot(key: string): string {
+ const root = this.normalizedRoot()
+ const trimmedKey = key.replace(/^\/+/, '')
+ if (!root) {
+ return trimmedKey
+ }
+ if (trimmedKey === root || trimmedKey.startsWith(`${root}/`)) {
+ return trimmedKey
+ }
+ return `${root}/${trimmedKey}`
+ }
+
+ private toAbsolutePath(key: string): string {
+ if (!key || key === '/') {
+ return '/'
+ }
+ return key.startsWith('/') ? key : `/${key}`
+ }
+
+ async create(key: string, fileBuffer: Buffer, contentType?: string): Promise<StorageObject> {
+ const rootedKey = this.withRoot(key)
+ const absoluteKey = this.toAbsolutePath(rootedKey)
+ const uploadPath = this.config.endpoints.upload
+
+ const resp = await this.request(uploadPath, {
+ method: 'PUT',
+ headers: {
+ 'Content-Type': contentType || 'application/octet-stream',
+ 'Content-Length': String(fileBuffer.length),
+ 'File-Path': encodeURIComponent(absoluteKey),
+ },
+ body: new Uint8Array(fileBuffer),
+ })
+
+ if (!resp.ok) {
+ const text = await resp.text().catch(() => '')
+ this.logger?.error('OpenList upload failed', { status: resp.status, body: text })
+ throw new Error(`OpenList upload failed: ${resp.status}`)
+ }
+
+ this.logger?.success(`Uploaded object: ${absoluteKey}`)
+ this.logger?.debug?.('OpenList upload details', {
+ originalKey: key,
+ rootedKey,
+ absoluteKey,
+ rootPath: this.normalizedRoot(),
+ })
+
+ const meta = await this.getFileMeta(rootedKey)
+ return (
+ meta || {
+ key: rootedKey,
+ size: fileBuffer.length,
+ lastModified: new Date(),
+ }
+ )
+ }
+
+ async delete(key: string): Promise<void> {
+ const deletePath = this.config.endpoints.delete
+ const urlPath = `${deletePath}`
+ const rootedKey = this.withRoot(key)
+ const normalized = rootedKey.replace(/^\/+/, '')
+ const slashIdx = normalized.lastIndexOf('/')
+ const dir = this.toAbsolutePath(slashIdx >= 0 ? normalized.slice(0, slashIdx) : this.normalizedRoot())
+ const name = slashIdx >= 0 ? normalized.slice(slashIdx + 1) : normalized
+ const body = { dir, names: [name] }
+
+ const resp = await this.request(urlPath, {
+ method: 'POST',
+ headers: { 'Content-Type': 'application/json' },
+ body: JSON.stringify(body),
+ })
+ if (!resp.ok) {
+ const text = await resp.text().catch(() => '')
+ this.logger?.error('OpenList delete failed', { status: resp.status, body: text })
+ throw new Error(`OpenList delete failed: ${resp.status}`)
+ }
+ this.logger?.success(`Deleted object: ${key}`)
+ }
+
+ async get(key: string): Promise<Buffer | null> {
+ // If download endpoint is empty string, try to resolve raw_url via meta and fetch it
+ if (!this.config.endpoints.download || this.config.endpoints.download === '') {
+ const info = await this.getFileMeta(this.withRoot(key))
+ const rawUrl = (info as any)?.raw_url || undefined
+ if (!rawUrl) return null
+ const resp = await fetch(rawUrl)
+ if (!resp.ok) return null
+ const arrayBuffer = await resp.arrayBuffer().catch(() => null)
+ if (!arrayBuffer) return null
+ return Buffer.from(arrayBuffer)
+ }
+
+ const downloadPath = this.config.endpoints.download
+ const rootedKey = this.withRoot(key)
+ const urlPath = `${downloadPath}?${encodeURIComponent(this.pathField)}=${encodeURIComponent(rootedKey)}`
+ const resp = await this.request(urlPath, { method: 'GET' })
+ if (!resp.ok) return null
+ const arrayBuffer = await resp.arrayBuffer().catch(() => null)
+ if (!arrayBuffer) return null
+ return Buffer.from(arrayBuffer)
+ }
+
+ getPublicUrl(key: string): string {
+ const rootedKey = this.withRoot(key)
+ const { cdnUrl, baseUrl } = this.config
+ const base = cdnUrl || (baseUrl ? `${baseUrl.replace(/\/$/, '')}/d` : '')
+ if (!base) {
+ return ''
+ }
+ return `${base.replace(/\/$/, '')}/${rootedKey}`
+ }
+
+ async getFileMeta(key: string): Promise<StorageObject | null> {
+ const metaPath = this.config.endpoints.meta || this.config.endpoints.download
+ const rootedKey = this.withRoot(key)
+ const urlPath = metaPath
+ const payload: Record<string, any> = {
+ [this.pathField]: this.toAbsolutePath(rootedKey),
+ password: '',
+ page: 1,
+ per_page: 0,
+ refresh: false,
+ }
+ const resp = await this.request(urlPath, { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: JSON.stringify(payload) })
+ if (!resp.ok) {
+ const text = await resp.text().catch(() => '')
+ this.logger?.error('OpenList get file meta failed', { status: resp.status, body: text })
+ return null
+ }
+
+ const data = (await resp.json().catch(() => null)) as any
+ if (!data) return { key }
+ const node = data?.data || {}
+ const size = node?.size
+ const modified = node?.modified || node?.lastModified
+ const etag = node?.etag
+ const rawUrl = node?.raw_url
+ const result: StorageObject = {
+ key: rootedKey,
+ size: typeof size === 'number' ? size : undefined,
+ lastModified: modified ? new Date(modified) : undefined,
+ etag: typeof etag === 'string' ? etag : undefined,
+ }
+ // Attach raw_url as non-standard property for internal usage
+ ;(result as any).raw_url = typeof rawUrl === 'string' ? rawUrl : undefined
+ return result
+ }
+
+ async listAll(): Promise<StorageObject[]> {
+ // Listing API not provided explicitly; return empty array by default.
+ // You can configure custom list endpoint and parsing later.
+ if (!this.config.endpoints.list || this.config.endpoints.list === '') return []
+ const listPath = this.config.endpoints.list
+ const payload: Record<string, any> = {
+ [this.pathField]: this.toAbsolutePath(this.normalizedRoot()),
+ password: '',
+ page: 1,
+ per_page: 0,
+ refresh: false,
+ }
+ const resp = await this.request(listPath, {
+ method: 'POST',
+ headers: { 'Content-Type': 'application/json' },
+ body: JSON.stringify(payload),
+ })
+ if (!resp.ok) return []
+ const data = (await resp.json().catch(() => null)) as any
+ const items: any[] = data?.data || data || []
+ return items
+ .map((item) => {
+ const rawKey = item?.path || item?.key || item?.name
+ if (!rawKey) return null
+ const rootedKey = this.withRoot(rawKey)
+ const size = item?.size
+ const lastModified = item?.modified || item?.lastModified || item?.mtime
+ const etag = item?.etag
+ return {
+ key: rootedKey,
+ size: typeof size === 'number' ? size : undefined,
+ lastModified: lastModified ? new Date(lastModified) : undefined,
+ etag: typeof etag === 'string' ? etag : undefined,
+ } as StorageObject
+ })
+ .filter(Boolean) as StorageObject[]
+ }
+
+ async listImages(): Promise<StorageObject[]> {
+ const all = await this.listAll()
+ return all.filter((obj) => /\.(jpe?g|png|webp|gif|bmp|tiff?|heic|heif)$/i.test(obj.key))
+ }
+}