feat(sitemap): Auto generate sitemap if remote domain config exist.

Author: walkthunder

src/baseTypes.ts

@@ -72,6 +72,7 @@ export interface OnedriveConfig {
 export interface InvioPluginSettings {
   s3: S3Config;
   password: string;
+  remoteDomain: string;
   serviceType: SUPPORTED_SERVICES_TYPE;
   currLogLevel?: string;
   autoRunEveryMilliseconds?: number;

src/exporter.ts

@@ -116,7 +116,16 @@ export const publishFiles = async (
             log.info('download list: ', externalFiles);
         }
     }
-
+    if (settings.remoteDomain) {
+        const sitemapDomStr = HTMLGenerator.generateSitemap(allFiles, settings.remoteDomain);
+        const sitemapDownload = new Downloadable('sitemap.xml', sitemapDomStr, htmlPath.joinString(settings.localWatchDir));
+        Object.assign(sitemapDownload, {
+            path: `${sitemapDownload.relativeDownloadPath.asString}/${sitemapDownload.filename}`,
+            key: settings.localWatchDir + '/' + sitemapDownload.filename,
+        }) 
+        log.info('sitemap - ', sitemapDomStr, htmlPath);
+        externalFiles.push(sitemapDownload);
+    }
     externalFiles = externalFiles.filter((file, index) => externalFiles.findIndex((f) => f.relativeDownloadPath == file.relativeDownloadPath && f.filename === file.filename) == index);
     await Utils.downloadFiles(externalFiles, htmlPath, view);
     log.info('download files to: ', htmlPath, externalFiles);

src/html-generation/html-generator.ts

@@ -96,9 +96,8 @@ export class HTMLGenerator {
 			// leftSidebar.appendChild(fileTree);
 			const dataNode = this.generateRootDirNode(file, usingDocument);
 			leftSidebar.appendChild(dataNode);
-			const rootDir = file.exportPath.directory.asString?.split('/')[0];
-
-			file.downloads.push(new Downloadable('_common-left-tree.html', fileTree.outerHTML, new Path(file.exportPath.asString.split('/')[0])));
+			const rootDir = new Path(file.exportPath.asString.split('/')[0])
+			file.downloads.push(new Downloadable('_common-left-tree.html', fileTree.outerHTML, rootDir));
 		}
 
 		await this.appendFooter(file);
@@ -657,6 +656,41 @@ export class HTMLGenerator {
 		return treeItems;
 	}
 
+	private static createXMLNode(file: TFile, usingDocument: Document, domain: string) {
+		const url = usingDocument.createElement("url");
+
+		const loc = usingDocument.createElement('loc');
+		loc.innerHTML = Utils.getRemoteUrl(file, domain);
+
+		const lastmod = usingDocument.createElement("lastmod");
+		lastmod.innerHTML = new Date(file.stat.mtime).toISOString().slice(0, 10);
+
+		url.appendChild(loc);
+		url.appendChild(lastmod);
+		return url;
+	}
+
+	static generateSitemap(fileList: TFile[], domain: string): string {
+			var doc = document.implementation.createDocument('', '', null);
+
+			//create the outer tag
+			var urlset = doc.createElement("urlset");
+			urlset.setAttribute("xmlns","http://www.sitemaps.org/schemas/sitemap/0.9");
+		 
+		   //first create static sites (note, that this is a selection)
+		   for (var i=0; i < fileList.length; i++) {
+				const target = fileList[i];
+				if (target instanceof TFile) {
+					const urlItemNode = this.createXMLNode(target, doc, domain);
+					urlset.appendChild(urlItemNode);
+				}
+		   }            					
+		   doc.appendChild(urlset);
+		   var oSerializer = new XMLSerializer();
+		   var xmltext = oSerializer.serializeToString(doc);
+		   return `<?xml version="1.0" encoding="UTF-8"?>${xmltext}`;
+	}
+
 	private static generateBrandHeader(usingDocument: Document, brand: string, icon: string, slogan: string, homeLink: string) {
 		// site-body-left-column-site-name
 		/**

src/langs/en.json

@@ -94,6 +94,9 @@
   "modal_sizesconflict_copynotice": "All the sizes conflicts info have been copied to the clipboard!",
 
   "settings_basic": "Basic Settings",
+  "settings_domain": "Domain",
+  "settings_domain_desc": "The option to point a domain to your S3 (or other COS) is optional, but recommended for previewing and generating a website that is SEO-friendly. \n Like https://search.google.com",
+  "settings_domain_saved": "Domain saved",
   "settings_password": "Encryption Password",
   "settings_password_desc": "Password for E2E encryption. Empty for no password. You need to click \"Confirm\". Attention: the password and other info are saved locally.",
   "settings_autorun": "Schedule For Auto Run",

src/langs/zh_cn.json

@@ -94,6 +94,9 @@
   "modal_sizesconflict_copynotice": "所有的文件大小冲突信息，已被复制到剪贴板！",
 
   "settings_basic": "基本设置",
+  "settings_domain": "域名",
+  "settings_domain_desc": "（可选）绑定的指向S3（或其他COS）的域名，主要用于预览和部署网页时SEO相关配置的自动注入。\n例如：https://search.google.com",
+  "settings_domain_saved": "域名保存成功",
   "settings_password": "密码",
   "settings_password_desc": "端到端加密的密码。不填写则代表没密码。您需要点击“确认”来修改。注意：密码和其它信息都会在本地保存。",
   "settings_autorun": "自动运行",

src/langs/zh_tw.json

@@ -94,6 +94,9 @@
   "modal_sizesconflict_copynotice": "所有的檔案大小衝突資訊，已被複制到剪貼簿！",
 
   "settings_basic": "基本設定",
+  "settings_domain": "域名",
+  "settings_domain_desc": "（可选）绑定的指向S3（或其他COS）的域名，主要用于预览和部署网页时SEO相关配置的自动注入。\n例如：https://search.google.com",
+  "settings_domain_saved": "域名保存成功",
   "settings_password": "密碼",
   "settings_password_desc": "端到端加密的密碼。不填寫則代表沒密碼。您需要點選“確認”來修改。注意：密碼和其它資訊都會在本地儲存。",
   "settings_autorun": "自動執行",

src/main.ts

@@ -62,12 +62,14 @@ import { Path } from './utils/path';
 import { HTMLGenerator } from './html-generation/html-generator';
 import icon, { UsingIconNames, getIconSvg, addIconForconflictFile } from './utils/icon';
 import { StatsView, VIEW_TYPE_STATS, LogType } from "./statsView";
+import { DomaindModal } from './remoteDomainModal';
 
 const { iconNameSyncWait, iconNameSyncPending, iconNameSyncRunning, iconNameLogs, iconNameSyncLogo } = UsingIconNames;
 
 const DEFAULT_SETTINGS: InvioPluginSettings = {
   s3: DEFAULT_S3_CONFIG,
   password: "",
+  remoteDomain: '',
   serviceType: "s3",
   currLogLevel: "info",
   // vaultRandomID: "", // deprecated
@@ -114,6 +116,21 @@ export default class InvioPlugin extends Plugin {
     return false;
   }
 
+  async checkDomain() {
+    // Domain check
+    return new Promise((resolve) => {
+      if (this.settings?.remoteDomain) {
+        resolve(this.settings.remoteDomain);
+      }
+      if (!this.settings?.remoteDomain) {
+        // Show modal to get
+        new DomaindModal(this.app, this, this.settings?.remoteDomain, (newDomain) => {
+          resolve(newDomain);
+        }).open()
+      }
+    })
+  }
+
   async syncRun(triggerSource: SyncTriggerSourceType = "manual", fileList?: string[]) {
     const t = (x: TransItemType, vars?: any) => {
       return this.i18n.t(x, vars);
@@ -309,8 +326,10 @@ export default class InvioPlugin extends Plugin {
       log.info('plan.mixedStates: ', plan.mixedStates, touchedFileMap); // for debugging
 
       try {
-        loadingModal.close();
-        loadingModal = null;
+        if (loadingModal) {
+          loadingModal.close();
+          loadingModal = null;
+        }
 
         if (triggerSource !== 'force') {
           await new Promise((resolve, reject) => {
@@ -556,7 +575,7 @@ export default class InvioPlugin extends Plugin {
         triggerSource: triggerSource,
         syncStatus: this.syncStatus,
       });
-      loadingModal.close();
+      loadingModal?.close();
       log.error(msg);
       log.error(error);
       getNotice(null, msg, 10 * 1000);

src/settings.ts

@@ -520,6 +520,27 @@ export class InvioSettingTab extends PluginSettingTab {
           })
       );
 
+      let remoteDomain = `${this.plugin.settings.remoteDomain}`;
+      new Setting(s3Div)
+        .setName(t("settings_domain"))
+        .setDesc(t("settings_domain_desc"))
+        .addText((text) => {
+          text
+            .setPlaceholder("https://docs.google.com")
+            .setValue(`${this.plugin.settings.remoteDomain || ''}`)
+            .onChange(async (value) => {
+              remoteDomain = value.trim();
+            });
+        })
+        .addButton(async (button) => {
+          button.setButtonText(t("confirm"));
+          button.onClick(async () => {
+            this.plugin.settings.remoteDomain = remoteDomain
+            await this.plugin.saveSettings();
+            log.info('new domain: ', t("settings_domain_saved") + " " + remoteDomain)
+            new Notice(t("settings_domain_saved") + " " + remoteDomain)
+          });
+        });
     // if (VALID_REQURL) {
     //   new Setting(s3Div)
     //     .setName(t("settings_s3_bypasscorslocally"))