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(cloud): configure website GA4 and attribute Cloud entry links

HoshinoSuzumi43a8bb309900
diff --git a/README.md b/README.md
index 89b2ebd2..11bcb89e 100644
--- a/README.md
+++ b/README.md
@@ -30,7 +30,7 @@
ChronoFrame is a self-hosted photo gallery. Upload your photos and it extracts EXIF, creates previews and identifies shooting locations. Visitors can browse by time, album or map, zoom into large images and play Live Photos.
-[Cloud](https://chronoframe.art) · [Live demo](https://lens.bh8.ga) · [Documentation](https://docs.chronoframe.art/) · [Changelog](https://docs.chronoframe.art/changelog.html)
+[Cloud](https://chronoframe.art/?utm_source=github&utm_medium=social&utm_campaign=github_traffic&utm_content=readme_link) · [Live demo](https://lens.bh8.ga) · [Documentation](https://docs.chronoframe.art/) · [Changelog](https://docs.chronoframe.art/changelog.html)
## ✨ Features
@@ -45,7 +45,7 @@ ChronoFrame is a self-hosted photo gallery. Upload your photos and it extracts E
## ☁️ ChronoFrame Cloud
-Use [ChronoFrame Cloud](https://chronoframe.art) without deploying or maintaining a server. Open the [Cloud console](https://app.chronoframe.art), sign up or sign in, create a gallery, and upload and organize your photos in the browser.
+Use [ChronoFrame Cloud](https://chronoframe.art/?utm_source=github&utm_medium=social&utm_campaign=github_traffic&utm_content=readme_link) without deploying or maintaining a server. Sign up or sign in on the website, create a gallery, and upload and organize your photos in the browser.
## 🐳 Deployment
diff --git a/README_zh.md b/README_zh.md
index b4cd84fe..289a1f3a 100644
--- a/README_zh.md
+++ b/README_zh.md
@@ -30,7 +30,7 @@
ChronoFrame 是一个可以自行部署的照片画廊。上传照片后,应用会提取 EXIF、生成预览并整理拍摄地点;访客可以按时间、相册或地图浏览,也能查看大图和播放实况照片。
-[Cloud 官网](https://chronoframe.art) · [在线演示](https://lens.bh8.ga) · [使用文档](https://docs.chronoframe.art/zh/) · [更新日志](https://docs.chronoframe.art/zh/changelog.html)
+[Cloud 官网](https://chronoframe.art/?utm_source=github&utm_medium=social&utm_campaign=github_traffic&utm_content=readme_link) · [在线演示](https://lens.bh8.ga) · [使用文档](https://docs.chronoframe.art/zh/) · [更新日志](https://docs.chronoframe.art/zh/changelog.html)
## ✨ 功能
@@ -45,7 +45,7 @@ ChronoFrame 是一个可以自行部署的照片画廊。上传照片后,应
## ☁️ ChronoFrame Cloud
-[ChronoFrame Cloud](https://chronoframe.art) 无需部署或维护服务器。打开 [Cloud 控制台](https://app.chronoframe.art),注册或登录账号,创建画廊,即可在浏览器中上传和管理照片。
+[ChronoFrame Cloud](https://chronoframe.art/?utm_source=github&utm_medium=social&utm_campaign=github_traffic&utm_content=readme_link) 无需部署或维护服务器。在官网注册或登录账号,创建画廊,即可在浏览器中上传和管理照片。
## 🐳 部署
diff --git a/apps/cloud/app/plugins/cloud-ga4.client.ts b/apps/cloud/app/plugins/cloud-ga4.client.ts
new file mode 100644
index 00000000..ba8fad3c
--- /dev/null
+++ b/apps/cloud/app/plugins/cloud-ga4.client.ts
@@ -0,0 +1,18 @@
+/** Cloud marketing analytics; tenant galleries and the account portal are separate audiences. */
+export default defineNuxtPlugin((app) => {
+ const domain = String(useRuntimeConfig().public.siteBaseDomain)
+ if (![domain, `www.${domain}`].includes(window.location.hostname)) return
+ const { initialize } = useGtag()
+ onNuxtReady(async () => {
+ try {
+ const { measurementId } = await $fetch<{ measurementId: string }>(
+ '/api/cloud-analytics',
+ { timeout: 5000, retry: 0 },
+ )
+ if (/^G-[A-Z0-9]{4,20}$/.test(measurementId))
+ app.runWithContext(() => initialize(measurementId))
+ } catch {
+ // Optional analytics must never prevent the website from loading.
+ }
+ })
+})
diff --git a/apps/cloud/nuxt.config.ts b/apps/cloud/nuxt.config.ts
index efc7c3c7..554594e5 100644
--- a/apps/cloud/nuxt.config.ts
+++ b/apps/cloud/nuxt.config.ts
@@ -8,6 +8,7 @@ const galleryPages = fileURLToPath(
export default defineNuxtConfig({
...sharedUi,
modules: [...sharedUi.modules, '@nuxt/fonts'],
+ gtag: { enabled: true, initMode: 'manual' },
fonts: {
provider: 'local',
defaults: { preload: false },
diff --git a/apps/cloud/server/api/cloud-analytics.get.ts b/apps/cloud/server/api/cloud-analytics.get.ts
new file mode 100644
index 00000000..a54a45cb
--- /dev/null
+++ b/apps/cloud/server/api/cloud-analytics.get.ts
@@ -0,0 +1,14 @@
+import { setResponseHeader } from 'h3'
+import { cloudAnalyticsSettings } from '../../../../packages/platform/src/cloud-analytics'
+import {
+ definePlatformHandler,
+ platformDatabase,
+} from '../../../shared/platform/runtime'
+
+export default definePlatformHandler(async (event) => {
+ setResponseHeader(event, 'Cache-Control', 'no-store')
+ const { measurementId } = await cloudAnalyticsSettings(
+ platformDatabase(event),
+ )
+ return { measurementId }
+})
diff --git a/apps/cloud/server/middleware/platform-boundary.ts b/apps/cloud/server/middleware/platform-boundary.ts
index 67552800..b5157aae 100644
--- a/apps/cloud/server/middleware/platform-boundary.ts
+++ b/apps/cloud/server/middleware/platform-boundary.ts
@@ -14,6 +14,7 @@ export default defineEventHandler((event) => {
}
const platformRoute =
[
+ '/api/cloud-analytics',
'/api/analytics/visit',
'/api/analytics/report',
'/api/auth/status',
diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts
index ee3f0eec..f9cc9a78 100644
--- a/docs/.vitepress/config.ts
+++ b/docs/.vitepress/config.ts
@@ -40,7 +40,10 @@ export default defineConfig({
{ text: 'Development', link: '/development/contributing' },
{ text: 'Changelog', link: '/changelog' },
{ text: 'Demo Sites', link: '/demo-sites' },
- { text: 'Cloud', link: 'https://chronoframe.art' },
+ {
+ text: 'Cloud',
+ link: 'https://chronoframe.art/?utm_source=docs&utm_medium=referral&utm_campaign=docs_to_website&utm_content=top_navigation',
+ },
],
sidebar: [
diff --git a/docs/.vitepress/theme/components/CloudAnnouncement.vue b/docs/.vitepress/theme/components/CloudAnnouncement.vue
index f995ca64..7ec0f721 100644
--- a/docs/.vitepress/theme/components/CloudAnnouncement.vue
+++ b/docs/.vitepress/theme/components/CloudAnnouncement.vue
@@ -13,7 +13,7 @@ const text = computed(() =>
<template>
<a
class="cloud-announcement"
- href="https://app.chronoframe.art"
+ href="https://chronoframe.art/?utm_source=docs&utm_medium=referral&utm_campaign=docs_to_website&utm_content=top_announcement"
>
{{ text }} <span aria-hidden="true">↗</span>
</a>
diff --git a/docs/zh/config.ts b/docs/zh/config.ts
index cfcbe19c..8aa8074e 100644
--- a/docs/zh/config.ts
+++ b/docs/zh/config.ts
@@ -11,7 +11,10 @@ export default defineConfig({
{ text: '开发文档', link: '/zh/development/contributing' },
{ text: '更新日志', link: '/zh/changelog' },
{ text: '演示站点', link: '/zh/demo-sites' },
- { text: 'Cloud 官网', link: 'https://chronoframe.art' },
+ {
+ text: 'Cloud 官网',
+ link: 'https://chronoframe.art/?utm_source=docs&utm_medium=referral&utm_campaign=docs_to_website&utm_content=top_navigation',
+ },
],
sidebar: [
diff --git a/packages/platform/migrations/0041_cloud_analytics.sql b/packages/platform/migrations/0041_cloud_analytics.sql
new file mode 100644
index 00000000..4421dd65
--- /dev/null
+++ b/packages/platform/migrations/0041_cloud_analytics.sql
@@ -0,0 +1,6 @@
+CREATE TABLE platform_cloud_analytics (
+ id INTEGER PRIMARY KEY CHECK(id=1),
+ measurement_id TEXT NOT NULL DEFAULT '',
+ revision INTEGER NOT NULL DEFAULT 0
+);
+INSERT INTO platform_cloud_analytics(id) VALUES (1);
diff --git a/packages/platform/src/cloud-analytics.ts b/packages/platform/src/cloud-analytics.ts
new file mode 100644
index 00000000..060fe31d
--- /dev/null
+++ b/packages/platform/src/cloud-analytics.ts
@@ -0,0 +1,56 @@
+import type { PlatformD1 } from './index.ts'
+import { SubscriptionError } from './subscriptions.ts'
+
+export function parseMeasurementId(value: unknown) {
+ if (typeof value !== 'string')
+ throw new SubscriptionError(400, 'invalid_measurement_id')
+ const id = value.trim()
+ if (id && !/^G-[A-Z0-9]{4,20}$/.test(id))
+ throw new SubscriptionError(400, 'invalid_measurement_id')
+ return id
+}
+
+export async function cloudAnalyticsSettings(db: PlatformD1) {
+ const row = await db
+ .prepare(
+ 'SELECT measurement_id,revision FROM platform_cloud_analytics WHERE id=1',
+ )
+ .first<{ measurement_id: string; revision: number }>()
+ if (!row)
+ throw new SubscriptionError(503, 'analytics_configuration_unavailable')
+ return { measurementId: row.measurement_id, revision: row.revision }
+}
+
+export async function saveCloudAnalytics(
+ db: PlatformD1,
+ actorId: number,
+ input: Record<string, unknown>,
+) {
+ const measurementId = parseMeasurementId(input.measurementId)
+ if (!Number.isSafeInteger(input.revision) || Number(input.revision) < 0)
+ throw new SubscriptionError(400, 'invalid_revision')
+ const before = await cloudAnalyticsSettings(db)
+ const auditId = crypto.randomUUID()
+ const results = await db.batch([
+ db
+ .prepare(
+ "INSERT INTO platform_admin_audit(id,actor_id,action,target,reason,before_json,after_json,created_at) SELECT ?,?,'cloud-analytics-save','platform','Configure Cloud GA4',?,?,? WHERE EXISTS(SELECT 1 FROM platform_cloud_analytics WHERE id=1 AND revision=?)",
+ )
+ .bind(
+ auditId,
+ actorId,
+ JSON.stringify(before),
+ JSON.stringify({ measurementId }),
+ Date.now(),
+ Number(input.revision),
+ ),
+ db
+ .prepare(
+ 'UPDATE platform_cloud_analytics SET measurement_id=?,revision=revision+1 WHERE id=1 AND revision=? AND EXISTS(SELECT 1 FROM platform_admin_audit WHERE id=?)',
+ )
+ .bind(measurementId, Number(input.revision), auditId),
+ ])
+ if (!results[1]?.meta.changes)
+ throw new SubscriptionError(409, 'analytics_configuration_changed')
+ return cloudAnalyticsSettings(db)
+}
diff --git a/tests/cloud-analytics.test.ts b/tests/cloud-analytics.test.ts
new file mode 100644
index 00000000..01d5f5ed
--- /dev/null
+++ b/tests/cloud-analytics.test.ts
@@ -0,0 +1,119 @@
+import assert from 'node:assert/strict'
+import test from 'node:test'
+import { readFileSync } from 'node:fs'
+import { DatabaseSync } from 'node:sqlite'
+import {
+ cloudAnalyticsSettings,
+ parseMeasurementId,
+ saveCloudAnalytics,
+} from '../packages/platform/src/cloud-analytics.ts'
+import type { PlatformD1 } from '../packages/platform/src/index.ts'
+
+test('GA4 accepts only Measurement IDs or empty values, never scripts', () => {
+ assert.equal(parseMeasurementId(' G-ABC1234567 '), 'G-ABC1234567')
+ assert.equal(parseMeasurementId(''), '')
+ for (const input of [
+ null,
+ 42,
+ {},
+ '<script>alert(1)</script>',
+ 'UA-1234',
+ 'G-ABC<script>',
+ 'G-A',
+ ])
+ assert.throws(() => parseMeasurementId(input))
+})
+
+test('GA4 settings default off, persist changes atomically with audit, reject stale writes and support disabling', async () => {
+ const sqlite = new DatabaseSync(':memory:')
+ try {
+ sqlite.exec(
+ readFileSync(
+ new URL(
+ '../packages/platform/migrations/0041_cloud_analytics.sql',
+ import.meta.url,
+ ),
+ 'utf8',
+ ),
+ )
+ sqlite.exec(
+ 'CREATE TABLE platform_admin_audit(id TEXT PRIMARY KEY,actor_id INTEGER,action TEXT,target TEXT,reason TEXT,before_json TEXT,after_json TEXT,created_at INTEGER)',
+ )
+ class Statement {
+ values: (string | number | null)[] = []
+ sql: string
+ constructor(sql: string) {
+ this.sql = sql
+ }
+ bind(...values: (string | number | null)[]) {
+ this.values = values
+ return this
+ }
+ async first() {
+ return sqlite.prepare(this.sql).get(...this.values) ?? null
+ }
+ async run() {
+ return {
+ meta: {
+ changes: Number(
+ sqlite.prepare(this.sql).run(...this.values).changes,
+ ),
+ },
+ }
+ }
+ }
+ const db = {
+ prepare: (sql: string) => new Statement(sql),
+ async batch(statements: Statement[]) {
+ sqlite.exec('BEGIN')
+ try {
+ const results = []
+ for (const s of statements) results.push(await s.run())
+ sqlite.exec('COMMIT')
+ return results
+ } catch (error) {
+ sqlite.exec('ROLLBACK')
+ throw error
+ }
+ },
+ } as unknown as PlatformD1
+ assert.deepEqual(await cloudAnalyticsSettings(db), {
+ measurementId: '',
+ revision: 0,
+ })
+ assert.deepEqual(
+ await saveCloudAnalytics(db, 7, {
+ measurementId: 'G-ABC1234567',
+ revision: 0,
+ }),
+ { measurementId: 'G-ABC1234567', revision: 1 },
+ )
+ await assert.rejects(
+ saveCloudAnalytics(db, 7, { measurementId: 'G-OTHER12345', revision: 0 }),
+ /analytics_configuration_changed/,
+ )
+ await assert.rejects(
+ saveCloudAnalytics(db, 7, { measurementId: '<script>', revision: 1 }),
+ /invalid_measurement_id/,
+ )
+ assert.equal(
+ sqlite.prepare('SELECT COUNT(*) AS n FROM platform_admin_audit').get()!.n,
+ 1,
+ )
+ assert.deepEqual(
+ await saveCloudAnalytics(db, 7, { measurementId: '', revision: 1 }),
+ { measurementId: '', revision: 2 },
+ )
+ const audit = sqlite
+ .prepare('SELECT * FROM platform_admin_audit ORDER BY rowid DESC LIMIT 1')
+ .get()!
+ assert.equal(audit.actor_id, 7)
+ assert.equal(
+ JSON.parse(String(audit.before_json)).measurementId,
+ 'G-ABC1234567',
+ )
+ assert.equal(JSON.parse(String(audit.after_json)).measurementId, '')
+ } finally {
+ sqlite.close()
+ }
+})