Skip to content

An open-source, privacy-first, self-hosted knowledge workspace where humans and AI agents work together 开源、隐私优先、自托管的知识工作空间,让人与智能体在此协作

:sparkles: Warn about bucket names in S3 endpoints https://github.com/siyuan-note/siyuan/issues/19966

Daniel58defb81db15
diff --git a/app/appearance/langs/ar.json b/app/appearance/langs/ar.json
index bb591f425d..56a3600d47 100644
--- a/app/appearance/langs/ar.json
+++ b/app/appearance/langs/ar.json
@@ -1,4 +1,5 @@
{
+ "s3EndpointBucketWarning": "قد يحتوي Endpoint بالفعل على اسم الحاوية، مما قد يعطل عرض لقطات السحابة وتنظيفها. تحقق من الإعدادات؛ إذا كانت هناك بيانات متزامنة، فانسخها احتياطيًا وتحقق من مسار تخزينها قبل تغيير الإعدادات",
"embedHTMLFileBelow": "تضمين ملف HTML أدناه",
"horizontalSuperBlock": "كتلة خارقة أفقية",
"verticalSuperBlock": "كتلة خارقة عمودية",
diff --git a/app/appearance/langs/de.json b/app/appearance/langs/de.json
index 46e1df56bf..9dfce9ab80 100644
--- a/app/appearance/langs/de.json
+++ b/app/appearance/langs/de.json
@@ -1,4 +1,5 @@
{
+ "s3EndpointBucketWarning": "Endpoint enthält möglicherweise bereits den Bucket-Namen, was das Auflisten und Bereinigen von Cloud-Snapshots beeinträchtigen kann. Prüfen Sie die Konfiguration; sichern Sie vorhandene synchronisierte Daten und prüfen Sie deren Speicherpfad, bevor Sie die Konfiguration ändern",
"embedHTMLFileBelow": "HTML-Datei darunter einbetten",
"horizontalSuperBlock": "Horizontaler Superblock",
"verticalSuperBlock": "Vertikaler Superblock",
diff --git a/app/appearance/langs/en.json b/app/appearance/langs/en.json
index a203ae6440..f9fc5c6012 100644
--- a/app/appearance/langs/en.json
+++ b/app/appearance/langs/en.json
@@ -1,4 +1,5 @@
{
+ "s3EndpointBucketWarning": "Endpoint may already contain the bucket name, which can disrupt cloud snapshot listing and cleanup. Check the configuration; if synced data already exists, back it up and verify its storage path before changing the configuration",
"embedHTMLFileBelow": "Embed HTML file below",
"horizontalSuperBlock": "Horizontal super block",
"verticalSuperBlock": "Vertical super block",
diff --git a/app/appearance/langs/es.json b/app/appearance/langs/es.json
index 5a4ff29294..5075c52f3a 100644
--- a/app/appearance/langs/es.json
+++ b/app/appearance/langs/es.json
@@ -1,4 +1,5 @@
{
+ "s3EndpointBucketWarning": "Endpoint puede contener ya el nombre del bucket, lo que puede afectar al listado y la limpieza de instantáneas en la nube. Revise la configuración; si ya hay datos sincronizados, haga una copia de seguridad y compruebe su ruta de almacenamiento antes de cambiarla",
"embedHTMLFileBelow": "Incrustar archivo HTML debajo",
"horizontalSuperBlock": "Superbloque horizontal",
"verticalSuperBlock": "Superbloque vertical",
diff --git a/app/appearance/langs/fr.json b/app/appearance/langs/fr.json
index ea7dc99cff..f1484fb350 100644
--- a/app/appearance/langs/fr.json
+++ b/app/appearance/langs/fr.json
@@ -1,4 +1,5 @@
{
+ "s3EndpointBucketWarning": "Endpoint contient peut-être déjà le nom du bucket, ce qui peut perturber la liste et le nettoyage des instantanés cloud. Vérifiez la configuration ; si des données sont déjà synchronisées, sauvegardez-les et vérifiez leur chemin de stockage avant de modifier la configuration",
"embedHTMLFileBelow": "Intégrer le fichier HTML en dessous",
"horizontalSuperBlock": "Superblock horizontal",
"verticalSuperBlock": "Superblock vertical",
diff --git a/app/appearance/langs/he.json b/app/appearance/langs/he.json
index 5e81f2a309..a89c5df67e 100644
--- a/app/appearance/langs/he.json
+++ b/app/appearance/langs/he.json
@@ -1,4 +1,5 @@
{
+ "s3EndpointBucketWarning": "ייתכן ש-Endpoint כבר מכיל את שם דלי האחסון, דבר שעלול לשבש הצגה וניקוי של תמונות מצב בענן. יש לבדוק את ההגדרות; אם קיימים נתונים מסונכרנים, יש לגבות אותם ולוודא את נתיב האחסון לפני שינוי ההגדרות",
"embedHTMLFileBelow": "הטמעת קובץ HTML מתחת",
"horizontalSuperBlock": "בלוק עליון אופקי",
"verticalSuperBlock": "בלוק עליון אנכי",
diff --git a/app/appearance/langs/hi.json b/app/appearance/langs/hi.json
index 6d2d7bfd2e..4d193b5b38 100644
--- a/app/appearance/langs/hi.json
+++ b/app/appearance/langs/hi.json
@@ -1,4 +1,5 @@
{
+ "s3EndpointBucketWarning": "Endpoint में बकेट का नाम पहले से शामिल हो सकता है, जिससे क्लाउड स्नैपशॉट की सूची और सफ़ाई में समस्या आ सकती है। कॉन्फ़िगरेशन जाँचें; यदि सिंक किया गया डेटा मौजूद है, तो कॉन्फ़िगरेशन बदलने से पहले उसका बैकअप लें और संग्रहण पथ की पुष्टि करें",
"embedHTMLFileBelow": "नीचे HTML फ़ाइल एम्बेड करें",
"horizontalSuperBlock": "क्षैतिज सुपर ब्लॉक",
"verticalSuperBlock": "लंबवत सुपर ब्लॉक",
diff --git a/app/appearance/langs/id.json b/app/appearance/langs/id.json
index 1ffecadb6c..26c27e32bf 100644
--- a/app/appearance/langs/id.json
+++ b/app/appearance/langs/id.json
@@ -1,4 +1,5 @@
{
+ "s3EndpointBucketWarning": "Endpoint mungkin sudah memuat nama bucket, sehingga daftar dan pembersihan snapshot cloud dapat terganggu. Periksa konfigurasi; jika sudah ada data tersinkron, cadangkan dan pastikan jalur penyimpanannya sebelum mengubah konfigurasi",
"embedHTMLFileBelow": "Sematkan berkas HTML di bawah",
"horizontalSuperBlock": "Super blok horizontal",
"verticalSuperBlock": "Super blok vertikal",
diff --git a/app/appearance/langs/it.json b/app/appearance/langs/it.json
index b93bdb75b7..2b866c38bf 100644
--- a/app/appearance/langs/it.json
+++ b/app/appearance/langs/it.json
@@ -1,4 +1,5 @@
{
+ "s3EndpointBucketWarning": "Endpoint potrebbe già contenere il nome del bucket, causando problemi nell'elenco e nella pulizia delle istantanee nel cloud. Controlla la configurazione; se esistono già dati sincronizzati, esegui un backup e verifica il percorso di archiviazione prima di modificarla",
"embedHTMLFileBelow": "Incorpora file HTML sotto",
"horizontalSuperBlock": "Super blocco orizzontale",
"verticalSuperBlock": "Super blocco verticale",
diff --git a/app/appearance/langs/ja.json b/app/appearance/langs/ja.json
index 4cabf5a4d8..6205363b73 100644
--- a/app/appearance/langs/ja.json
+++ b/app/appearance/langs/ja.json
@@ -1,4 +1,5 @@
{
+ "s3EndpointBucketWarning": "Endpoint にバケット名が既に含まれている可能性があり、クラウドスナップショットの一覧取得やクリーンアップに支障が出る場合があります。設定を確認し、同期済みデータがある場合は、変更前にバックアップして保存先のパスを確認してください",
"embedHTMLFileBelow": "下に HTML ファイルを埋め込む",
"horizontalSuperBlock": "横向きスーパーブロック",
"verticalSuperBlock": "縦向きスーパーブロック",
diff --git a/app/appearance/langs/ko.json b/app/appearance/langs/ko.json
index 1d4cf73623..4787b2c154 100644
--- a/app/appearance/langs/ko.json
+++ b/app/appearance/langs/ko.json
@@ -1,4 +1,5 @@
{
+ "s3EndpointBucketWarning": "Endpoint에 버킷 이름이 이미 포함되어 있으면 클라우드 스냅샷 목록 조회와 정리에 문제가 생길 수 있습니다. 설정을 확인하고, 동기화된 데이터가 있다면 설정을 변경하기 전에 백업하고 저장 경로를 확인하세요",
"embedHTMLFileBelow": "아래에 HTML 파일 삽입",
"horizontalSuperBlock": "가로 슈퍼 블록",
"verticalSuperBlock": "세로 슈퍼 블록",
diff --git a/app/appearance/langs/nl.json b/app/appearance/langs/nl.json
index 43632dd709..85c2c6f95a 100644
--- a/app/appearance/langs/nl.json
+++ b/app/appearance/langs/nl.json
@@ -1,4 +1,5 @@
{
+ "s3EndpointBucketWarning": "Endpoint bevat mogelijk al de bucketnaam, wat het weergeven en opruimen van cloudsnapshots kan verstoren. Controleer de configuratie; maak een back-up van bestaande gesynchroniseerde gegevens en controleer hun opslagpad voordat u de configuratie wijzigt",
"embedHTMLFileBelow": "HTML-bestand hieronder insluiten",
"horizontalSuperBlock": "Horizontaal superblok",
"verticalSuperBlock": "Verticaal superblok",
diff --git a/app/appearance/langs/pl.json b/app/appearance/langs/pl.json
index b60751b012..45597116c1 100644
--- a/app/appearance/langs/pl.json
+++ b/app/appearance/langs/pl.json
@@ -1,4 +1,5 @@
{
+ "s3EndpointBucketWarning": "Endpoint może już zawierać nazwę zasobnika, co może zakłócać wyświetlanie i czyszczenie migawek w chmurze. Sprawdź konfigurację; jeśli istnieją już zsynchronizowane dane, wykonaj ich kopię zapasową i sprawdź ścieżkę przechowywania przed zmianą konfiguracji",
"embedHTMLFileBelow": "Osadź plik HTML poniżej",
"horizontalSuperBlock": "Poziomy super blok",
"verticalSuperBlock": "Pionowy super blok",
diff --git a/app/appearance/langs/pt-BR.json b/app/appearance/langs/pt-BR.json
index b892c39678..b4c26643c6 100644
--- a/app/appearance/langs/pt-BR.json
+++ b/app/appearance/langs/pt-BR.json
@@ -1,4 +1,5 @@
{
+ "s3EndpointBucketWarning": "Endpoint pode já conter o nome do bucket, o que pode prejudicar a listagem e a limpeza de snapshots na nuvem. Verifique a configuração; se já houver dados sincronizados, faça um backup e confirme o caminho de armazenamento antes de alterá-la",
"embedHTMLFileBelow": "Incorporar arquivo HTML abaixo",
"horizontalSuperBlock": "Super bloco horizontal",
"verticalSuperBlock": "Super bloco vertical",
diff --git a/app/appearance/langs/ru.json b/app/appearance/langs/ru.json
index 161e17b63c..e6eddb3d98 100644
--- a/app/appearance/langs/ru.json
+++ b/app/appearance/langs/ru.json
@@ -1,4 +1,5 @@
{
+ "s3EndpointBucketWarning": "Endpoint может уже содержать имя бакета, что может нарушить получение списка и очистку облачных снимков. Проверьте настройки; если данные уже синхронизированы, создайте резервную копию и проверьте путь хранения перед изменением настроек",
"embedHTMLFileBelow": "Встроить HTML-файл ниже",
"horizontalSuperBlock": "Горизонтальный супер блок",
"verticalSuperBlock": "Вертикальный супер блок",
diff --git a/app/appearance/langs/sk.json b/app/appearance/langs/sk.json
index a47cce902a..d5c0f88aa2 100644
--- a/app/appearance/langs/sk.json
+++ b/app/appearance/langs/sk.json
@@ -1,4 +1,5 @@
{
+ "s3EndpointBucketWarning": "Endpoint už môže obsahovať názov bucketu, čo môže narušiť zobrazovanie a čistenie cloudových snímok. Skontrolujte nastavenia; ak už existujú synchronizované údaje, pred zmenou nastavení ich zálohujte a overte cestu uloženia",
"embedHTMLFileBelow": "Vložiť súbor HTML nižšie",
"horizontalSuperBlock": "Horizontálny super blok",
"verticalSuperBlock": "Vertikálny super blok",
diff --git a/app/appearance/langs/sr.json b/app/appearance/langs/sr.json
index 35c40ef338..9c6911d020 100644
--- a/app/appearance/langs/sr.json
+++ b/app/appearance/langs/sr.json
@@ -1,4 +1,5 @@
{
+ "s3EndpointBucketWarning": "Endpoint можда већ садржи назив складишног контејнера, што може ометати приказ и чишћење снимака у облаку. Проверите подешавања; ако већ постоје синхронизовани подаци, направите резервну копију и проверите путању складиштења пре промене подешавања",
"embedHTMLFileBelow": "Угради HTML датотеку испод",
"horizontalSuperBlock": "Horizontalni superblok",
"verticalSuperBlock": "Vertikalni superblok",
diff --git a/app/appearance/langs/th.json b/app/appearance/langs/th.json
index ac4053b92b..3fecdfe922 100644
--- a/app/appearance/langs/th.json
+++ b/app/appearance/langs/th.json
@@ -1,4 +1,5 @@
{
+ "s3EndpointBucketWarning": "Endpoint อาจมีชื่อบักเก็ตอยู่แล้ว ซึ่งอาจทำให้การแสดงรายการและล้างสแนปช็อตบนคลาวด์ผิดปกติ โปรดตรวจสอบการตั้งค่า หากมีข้อมูลที่ซิงค์แล้ว ให้สำรองข้อมูลและตรวจสอบเส้นทางจัดเก็บก่อนเปลี่ยนการตั้งค่า",
"embedHTMLFileBelow": "ฝังไฟล์ HTML ด้านล่าง",
"horizontalSuperBlock": "ซูเปอร์บล็อกแนวนอน",
"verticalSuperBlock": "ซูเปอร์บล็อกแนวตั้ง",
diff --git a/app/appearance/langs/tr.json b/app/appearance/langs/tr.json
index 66c067c2af..a914494a9b 100644
--- a/app/appearance/langs/tr.json
+++ b/app/appearance/langs/tr.json
@@ -1,4 +1,5 @@
{
+ "s3EndpointBucketWarning": "Endpoint zaten kova adını içeriyor olabilir; bu durum bulut anlık görüntülerinin listelenmesini ve temizlenmesini aksatabilir. Yapılandırmayı kontrol edin; eşitlenmiş veriler varsa yapılandırmayı değiştirmeden önce yedekleyin ve depolama yolunu doğrulayın",
"embedHTMLFileBelow": "HTML dosyasını aşağıya göm",
"horizontalSuperBlock": "Yatay süper blok",
"verticalSuperBlock": "Dikey süper blok",
diff --git a/app/appearance/langs/uk.json b/app/appearance/langs/uk.json
index 169f5b18c1..5eb56e0f59 100644
--- a/app/appearance/langs/uk.json
+++ b/app/appearance/langs/uk.json
@@ -1,4 +1,5 @@
{
+ "s3EndpointBucketWarning": "Endpoint може вже містити назву бакета, що може порушити отримання списку та очищення хмарних знімків. Перевірте налаштування; якщо дані вже синхронізовано, створіть резервну копію та перевірте шлях зберігання перед зміною налаштувань",
"embedHTMLFileBelow": "Вбудувати HTML-файл нижче",
"horizontalSuperBlock": "Горизонтальний суперблок",
"verticalSuperBlock": "Вертикальний суперблок",
diff --git a/app/appearance/langs/zh-CN.json b/app/appearance/langs/zh-CN.json
index b0750c86f1..65c41cf3aa 100644
--- a/app/appearance/langs/zh-CN.json
+++ b/app/appearance/langs/zh-CN.json
@@ -1,4 +1,5 @@
{
+ "s3EndpointBucketWarning": "Endpoint 可能重复包含桶名,导致云端快照列举和清理异常。请核对配置;已有同步数据时,请先备份并确认存储路径,再修改配置",
"embedHTMLFileBelow": "在下方嵌入 HTML 文件",
"horizontalSuperBlock": "横向超级块",
"verticalSuperBlock": "纵向超级块",
diff --git a/app/appearance/langs/zh-TW.json b/app/appearance/langs/zh-TW.json
index 134dd2669c..af3b3e4e9f 100644
--- a/app/appearance/langs/zh-TW.json
+++ b/app/appearance/langs/zh-TW.json
@@ -1,4 +1,5 @@
{
+ "s3EndpointBucketWarning": "Endpoint 可能重複包含儲存桶名稱,導致雲端快照列舉與清理異常。請核對設定;若已有同步資料,請先備份並確認儲存路徑,再修改設定",
"embedHTMLFileBelow": "在下方嵌入 HTML 檔案",
"horizontalSuperBlock": "橫向超級區塊",
"verticalSuperBlock": "縱向超級區塊",
diff --git a/app/src/config/tabs/syncUi.test.ts b/app/src/config/tabs/syncUi.test.ts
index 90624b522a..7489dd8ee7 100644
--- a/app/src/config/tabs/syncUi.test.ts
+++ b/app/src/config/tabs/syncUi.test.ts
@@ -5,7 +5,7 @@ import {test} from "node:test";
import {runInNewContext} from "node:vm";
import {ModuleKind, transpileModule} from "typescript";
-const setup = () => {
+const setup = (initial: {endpoint?: string, bucket?: string} = {}) => {
const source = readFileSync(resolve(process.cwd(), "src/config/tabs/syncUi.ts"), "utf8");
const code = transpileModule(source + "\nexports.bind = bindProviderConfigEvent;", {
compilerOptions: {module: ModuleKind.CommonJS},
@@ -13,18 +13,22 @@ const setup = () => {
const s3 = {endpoint: "", accessKey: "", secretKey: "", bucket: "", region: "", timeout: 30,
pathStyle: true, skipTlsVerify: false, concurrentReqs: 4};
const sync = {provider: 2, s3};
+ Object.assign(s3, initial);
const inputs = Object.fromEntries(Object.keys(s3).map((key) => [key, {
value: "",
}]));
const messages: string[] = [];
const events: Record<string, (event: unknown) => void> = {};
+ let warningHidden = true;
+ const warning = {classList: {toggle: (_name: string, hidden: boolean) => { warningHidden = hidden; }}};
const element = {
- querySelector: (selector: string) => inputs[selector.slice(1)] || null,
+ querySelector: (selector: string) => selector === '[data-type="s3-endpoint-warning"]' ? warning : inputs[selector.slice(1)] || null,
addEventListener: (name: string, callback: (event: unknown) => void) => { events[name] = callback; },
};
const requests: {data: {s3: typeof s3}, resolve: (response: unknown) => void, reject: (error: Error) => void}[] = [];
const moduleExports = {} as {bind: (config: unknown, root: unknown) => void};
runInNewContext(code, {
+ URL,
exports: moduleExports,
window: {siyuan: {config: {sync}, languages: {_kernel: {142: "Input can not be empty"}}}},
require: (name: string) => {
@@ -49,11 +53,37 @@ const setup = () => {
events.change({target: {matches: () => true}});
}
};
- return {sync, inputs, requests, messages, fill, change: () => events.change({target: {matches: () => true}})};
+ return {sync, inputs, requests, messages, fill, warningHidden: () => warningHidden,
+ input: () => events.input({}), change: () => events.change({target: {matches: () => true}})};
};
const settle = () => new Promise<void>((resolve) => setImmediate(resolve));
+test("S3 bucket endpoint warning appears for saved configurations and follows edits without blocking saves", async () => {
+ const ui = setup({endpoint: "https://my.bucket.s3.example.com", bucket: "my.bucket"});
+ assert.equal(ui.warningHidden(), false);
+ for (const endpoint of ["s3.example.com", "https://othermy.bucket.s3.example.com", "https://s3.example.com/my.bucket", "https://"]) {
+ ui.inputs.endpoint.value = endpoint;
+ ui.input();
+ assert.equal(ui.warningHidden(), true, endpoint);
+ }
+ ui.fill();
+ await settle();
+ ui.requests[0].resolve({code: 0, data: {s3: ui.requests[0].data.s3}});
+ await settle();
+ ui.inputs.endpoint.value = " BUCKET.s3.example.com ";
+ ui.inputs.pathStyle.value = "false";
+ ui.input();
+ assert.equal(ui.warningHidden(), false);
+ ui.change();
+ await settle();
+ assert.equal(ui.requests.length, 2);
+ assert.equal(ui.requests[1].data.s3.endpoint, " BUCKET.s3.example.com ");
+ ui.inputs.bucket.value = "different";
+ ui.input();
+ assert.equal(ui.warningHidden(), true);
+});
+
test("S3 configuration saves automatically once required fields are complete", async () => {
const ui = setup();
ui.change();
diff --git a/app/src/config/tabs/syncUi.ts b/app/src/config/tabs/syncUi.ts
index b9efbcdd6c..a4f3b6dd91 100644
--- a/app/src/config/tabs/syncUi.ts
+++ b/app/src/config/tabs/syncUi.ts
@@ -285,7 +285,8 @@ const renderProviderConfig = (root: Element) => {
if (!def.isProviderConfigAllowed()) {
html = def.genUnpaidIntro();
} else if (isThirdPartySyncProviderDef(def)) {
- html = `${def.genIntro()}${def.fields.map(genProviderField).join("")}${genProviderActionButtons(def.configKey)}`;
+ const warning = def.configKey === "s3" ? `<div data-type="s3-endpoint-warning" class="b3-label b3-label--inner ft__error fn__none" role="status">${window.siyuan.languages.s3EndpointBucketWarning}</div>` : "";
+ html = `${def.genIntro()}${def.fields.map(genProviderField).join("")}${warning}${genProviderActionButtons(def.configKey)}`;
} else {
html = def.genIntro();
}
@@ -402,11 +403,13 @@ const bindProviderConfigEvent = (configElement: Element, root: Element) => {
return;
}
syncProviderConfigBoundElements.add(configElement);
+ configElement.addEventListener("input", () => updateS3EndpointWarning(configElement));
configElement.addEventListener("change", (event: Event) => {
const target = event.target as HTMLElement;
if (!target.matches(".b3-text-field, .b3-select")) {
return;
}
+ updateS3EndpointWarning(configElement);
saveSyncProviderConfigValues(configElement);
});
};
@@ -443,6 +446,7 @@ const saveSyncProviderConfigValues = (configElement: Element) => {
element.value = String(response.data[configKey][key]);
}
});
+ updateS3EndpointWarning(configElement);
}
})
.catch(() => {});
@@ -462,6 +466,25 @@ const fillSyncProviderConfigValues = (configElement: Element) => {
el.value = String(data[key]);
}
});
+ updateS3EndpointWarning(configElement);
+};
+
+const updateS3EndpointWarning = (configElement: Element) => {
+ const warning = configElement.querySelector('[data-type="s3-endpoint-warning"]');
+ if (!warning) {
+ return;
+ }
+ const endpoint = configElement.querySelector<HTMLInputElement>("#endpoint").value.trim();
+ const bucket = configElement.querySelector<HTMLInputElement>("#bucket").value.trim().toLowerCase();
+ let suspicious = false;
+ try {
+ const url = new URL(endpoint.includes("://") ? endpoint : `https://${endpoint}`);
+ suspicious = !!bucket && ["http:", "https:"].includes(url.protocol) &&
+ url.hostname.toLowerCase().startsWith(`${bucket}.`);
+ } catch {
+ // 不完整的地址由配置校验处理,这里只提示重复桶名。
+ }
+ warning.classList.toggle("fn__none", !suspicious);
};
const readProviderConfigFields = <T extends object>(configElement: Element, template: T): T => {