feat: support pull remote post updates to local mapped file

laggage · laggage · commit dfc9b4a44512 · 2022-04-01T18:49:20.000+08:00
diff --git a/package.json b/package.json
@@ -154,6 +154,13 @@
                 "enablement": "vscode-cnb.isAuthorized",
                 "category": "Cnblogs"
             },
+            {
+                "command": "vscode-cnb.pull-post-remote-updates",
+                "title": "拉取远程更新",
+                "category": "Cnblogs",
+                "enablement": "vscode-cnb.isAuthorized",
+                "icon": "$(cloud-download)"
+            },
             {
                 "command": "vscode-cnb.show-post-to-local-file-info",
                 "title": "博客园关联博文",
@@ -424,17 +431,22 @@
             "view/item/context": [
                 {
                     "command": "vscode-cnb.save-post",
-                    "group": "inline",
+                    "group": "inline@1",
                     "when": "viewItem == cnb-post-cached"
                 },
                 {
-                    "command": "vscode-cnb.delete-post",
-                    "group": "inline",
-                    "when": "viewItem =~ /^cnb-post/ && viewItem != cnb-post-category"
+                    "command": "vscode-cnb.pull-post-remote-updates",
+                    "group": "inline@2",
+                    "when": "viewItem == cnb-post-cached"
                 },
                 {
                     "command": "vscode-cnb.modify-post-settings",
-                    "group": "inline",
+                    "group": "inline@3",
+                    "when": "viewItem =~ /^cnb-post/ && viewItem != cnb-post-category"
+                },
+                {
+                    "command": "vscode-cnb.delete-post",
+                    "group": "inline@4",
                     "when": "viewItem =~ /^cnb-post/ && viewItem != cnb-post-category"
                 },
                 {
@@ -475,20 +487,30 @@
                     "when": "viewItem =~ /^cnb-post-cached/",
                     "group": "delete@2"
                 },
+                {
+                    "command": "vscode-cnb.save-post",
+                    "group": "0@1",
+                    "when": "viewItem == cnb-post-cached"
+                },
+                {
+                    "command": "vscode-cnb.pull-post-remote-updates",
+                    "group": "0@2",
+                    "when": "viewItem == cnb-post-cached"
+                },
                 {
                     "command": "vscode-cnb.reveal-local-post-file-in-os",
                     "when": "viewItem =~ /^cnb-post-cached/",
-                    "group": "0@1"
+                    "group": "0@3"
                 },
                 {
                     "command": "vscode-cnb.view-post-online",
                     "when": "viewItem =~ /^cnb-post/ && viewItem != cnb-post-category",
-                    "group": "0@2"
+                    "group": "0@4"
                 },
                 {
                     "command": "vscode-cnb.export-post-to-pdf",
-                    "when": "viewItem =~ /^cnb-post/",
-                    "group": "0@3"
+                    "when": "viewItem =~ /^cnb-post/ && viewItem != cnb-post-category",
+                    "group": "0@5"
                 },
                 {
                     "command": "vscode-cnb.delete-selected-post-categories",
@@ -526,29 +548,34 @@
                     "group": "cnblogs@2"
                 },
                 {
-                    "command": "vscode-cnb.modify-post-settings",
+                    "command": "vscode-cnb.pull-post-remote-updates",
                     "when": "resourceLangId == markdown",
                     "group": "cnblogs@3"
                 },
                 {
-                    "command": "vscode-cnb.open-post-in-blog-admin",
+                    "command": "vscode-cnb.modify-post-settings",
                     "when": "resourceLangId == markdown",
                     "group": "cnblogs@4"
                 },
                 {
-                    "command": "vscode-cnb.upload-clipboard-image",
+                    "command": "vscode-cnb.open-post-in-blog-admin",
                     "when": "resourceLangId == markdown",
                     "group": "cnblogs@5"
                 },
                 {
-                    "command": "vscode-cnb.upload-local-disk-image",
+                    "command": "vscode-cnb.upload-clipboard-image",
                     "when": "resourceLangId == markdown",
                     "group": "cnblogs@6"
                 },
                 {
-                    "command": "vscode-cnb.export-post-to-pdf",
+                    "command": "vscode-cnb.upload-local-disk-image",
                     "when": "resourceLangId == markdown",
                     "group": "cnblogs@7"
+                },
+                {
+                    "command": "vscode-cnb.export-post-to-pdf",
+                    "when": "resourceLangId == markdown",
+                    "group": "cnblogs@8"
                 }
             ],
             "editor/title": [
@@ -575,24 +602,29 @@
                     "group": "cnblogs@2"
                 },
                 {
-                    "command": "vscode-cnb.modify-post-settings",
+                    "command": "vscode-cnb.pull-post-remote-updates",
                     "when": "resourceLangId == markdown",
                     "group": "cnblogs@3"
                 },
                 {
-                    "command": "vscode-cnb.show-post-to-local-file-info",
+                    "command": "vscode-cnb.modify-post-settings",
                     "when": "resourceLangId == markdown",
                     "group": "cnblogs@4"
                 },
                 {
-                    "command": "vscode-cnb.open-post-in-blog-admin",
+                    "command": "vscode-cnb.show-post-to-local-file-info",
                     "when": "resourceLangId == markdown",
                     "group": "cnblogs@5"
                 },
                 {
-                    "command": "vscode-cnb.export-post-to-pdf",
+                    "command": "vscode-cnb.open-post-in-blog-admin",
                     "when": "resourceLangId == markdown",
                     "group": "cnblogs@6"
+                },
+                {
+                    "command": "vscode-cnb.export-post-to-pdf",
+                    "when": "resourceLangId == markdown",
+                    "group": "cnblogs@7"
                 }
             ]
         },
diff --git a/src/commands/commands-registration.ts b/src/commands/commands-registration.ts
@@ -1,4 +1,4 @@
-import vscode from 'vscode';
+import { commands } from 'vscode';
 import { openMyAccountSettings } from './open-my-account-settings';
 import { openMyWebBlogConsole } from './open-my-blog-management-background';
 import { openMyHomePage } from './open-my-home-page';
@@ -32,46 +32,48 @@ import { setWorkspace } from './set-workspace';
 import { revealWorkspaceInOs } from './reveal-workspace-in-os';
 import { viewPostOnline } from './view-post-online';
 import { exportPostToPdf } from './pdf/export-pdf.command';
+import { pullPostRemoteUpdates } from './pull-post-remote-updates';
 
 export const registerCommands = () => {
     const context = globalState.extensionContext;
     const appName = globalState.extensionName;
     const disposables = [
-        vscode.commands.registerCommand(`${appName}.login`, login),
-        vscode.commands.registerCommand(`${appName}.open-my-blog`, openMyBlog),
-        vscode.commands.registerCommand(`${appName}.open-my-home-page`, openMyHomePage),
-        vscode.commands.registerCommand(`${appName}.open-my-blog-management-background`, openMyWebBlogConsole),
-        vscode.commands.registerCommand(`${appName}.open-my-account-settings`, openMyAccountSettings),
-        vscode.commands.registerCommand(`${appName}.logout`, logout),
-        vscode.commands.registerCommand(`${appName}.refresh-posts-list`, refreshPostsList),
-        vscode.commands.registerCommand(`${appName}.previous-posts-list`, gotoPreviousPostsList),
-        vscode.commands.registerCommand(`${appName}.seek-posts-list`, seekPostsList),
-        vscode.commands.registerCommand(`${appName}.next-posts-list`, gotoNextPostsList),
-        vscode.commands.registerCommand(`${appName}.edit-post`, openPostInVscode),
-        vscode.commands.registerCommand(`${appName}.save-post`, savePostToCnblogs),
-        vscode.commands.registerCommand(`${appName}.modify-post-settings`, modifyPostSettings),
-        vscode.commands.registerCommand(`${appName}.delete-post`, deleteSelectedPosts),
-        vscode.commands.registerCommand(`${appName}.create-local-draft`, createLocalDraft),
-        vscode.commands.registerCommand(`${appName}.delete-local-draft`, deleteLocalDraft),
-        vscode.commands.registerCommand(`${appName}.save-local-draft-to-cnblogs`, saveLocalDraftToCnblogs),
-        vscode.commands.registerCommand(`${appName}.save-post-file-to-cnblogs`, savePostFileToCnblogs),
-        vscode.commands.registerCommand(`${appName}.upload-clipboard-image`, () => uploadImage(true, 'clipboard')),
-        vscode.commands.registerCommand(`${appName}.upload-local-disk-image`, () => uploadImage(true, 'local')),
-        vscode.commands.registerCommand(`${appName}.upload-image`, () => uploadImage(true)),
-        vscode.commands.registerCommand(`${appName}.reveal-local-post-file-in-os`, revealLocalPostFileInOs),
-        vscode.commands.registerCommand(`${appName}.show-post-to-local-file-info`, showLocalFileToPostInfo),
-        vscode.commands.registerCommand(`${appName}.new-post-category`, newPostCategory),
-        vscode.commands.registerCommand(`${appName}.delete-selected-post-categories`, deleteSelectedCategories),
-        vscode.commands.registerCommand(`${appName}.refresh-post-categories-list`, refreshPostCategoriesList),
-        vscode.commands.registerCommand(`${appName}.update-post-category`, updatePostCategory),
-        vscode.commands.registerCommand(`${appName}.delete-post-to-local-file-map`, deletePostToLocalFileMap),
-        vscode.commands.registerCommand(`${appName}.rename-post`, renamePost),
-        vscode.commands.registerCommand(`${appName}.open-post-in-blog-admin`, openPostInBlogAdmin),
-        vscode.commands.registerCommand(`${appName}.open-workspace`, openWorkspace),
-        vscode.commands.registerCommand(`${appName}.set-workspace`, setWorkspace),
-        vscode.commands.registerCommand(`${appName}.reveal-workspace-in-os`, revealWorkspaceInOs),
-        vscode.commands.registerCommand(`${appName}.view-post-online`, viewPostOnline),
-        vscode.commands.registerCommand(`${appName}.export-post-to-pdf`, exportPostToPdf),
+        commands.registerCommand(`${appName}.login`, login),
+        commands.registerCommand(`${appName}.open-my-blog`, openMyBlog),
+        commands.registerCommand(`${appName}.open-my-home-page`, openMyHomePage),
+        commands.registerCommand(`${appName}.open-my-blog-management-background`, openMyWebBlogConsole),
+        commands.registerCommand(`${appName}.open-my-account-settings`, openMyAccountSettings),
+        commands.registerCommand(`${appName}.logout`, logout),
+        commands.registerCommand(`${appName}.refresh-posts-list`, refreshPostsList),
+        commands.registerCommand(`${appName}.previous-posts-list`, gotoPreviousPostsList),
+        commands.registerCommand(`${appName}.seek-posts-list`, seekPostsList),
+        commands.registerCommand(`${appName}.next-posts-list`, gotoNextPostsList),
+        commands.registerCommand(`${appName}.edit-post`, openPostInVscode),
+        commands.registerCommand(`${appName}.save-post`, savePostToCnblogs),
+        commands.registerCommand(`${appName}.modify-post-settings`, modifyPostSettings),
+        commands.registerCommand(`${appName}.delete-post`, deleteSelectedPosts),
+        commands.registerCommand(`${appName}.create-local-draft`, createLocalDraft),
+        commands.registerCommand(`${appName}.delete-local-draft`, deleteLocalDraft),
+        commands.registerCommand(`${appName}.save-local-draft-to-cnblogs`, saveLocalDraftToCnblogs),
+        commands.registerCommand(`${appName}.save-post-file-to-cnblogs`, savePostFileToCnblogs),
+        commands.registerCommand(`${appName}.pull-post-remote-updates`, pullPostRemoteUpdates),
+        commands.registerCommand(`${appName}.upload-clipboard-image`, () => uploadImage(true, 'clipboard')),
+        commands.registerCommand(`${appName}.upload-local-disk-image`, () => uploadImage(true, 'local')),
+        commands.registerCommand(`${appName}.upload-image`, () => uploadImage(true)),
+        commands.registerCommand(`${appName}.reveal-local-post-file-in-os`, revealLocalPostFileInOs),
+        commands.registerCommand(`${appName}.show-post-to-local-file-info`, showLocalFileToPostInfo),
+        commands.registerCommand(`${appName}.new-post-category`, newPostCategory),
+        commands.registerCommand(`${appName}.delete-selected-post-categories`, deleteSelectedCategories),
+        commands.registerCommand(`${appName}.refresh-post-categories-list`, refreshPostCategoriesList),
+        commands.registerCommand(`${appName}.update-post-category`, updatePostCategory),
+        commands.registerCommand(`${appName}.delete-post-to-local-file-map`, deletePostToLocalFileMap),
+        commands.registerCommand(`${appName}.rename-post`, renamePost),
+        commands.registerCommand(`${appName}.open-post-in-blog-admin`, openPostInBlogAdmin),
+        commands.registerCommand(`${appName}.open-workspace`, openWorkspace),
+        commands.registerCommand(`${appName}.set-workspace`, setWorkspace),
+        commands.registerCommand(`${appName}.reveal-workspace-in-os`, revealWorkspaceInOs),
+        commands.registerCommand(`${appName}.view-post-online`, viewPostOnline),
+        commands.registerCommand(`${appName}.export-post-to-pdf`, exportPostToPdf),
     ];
     context?.subscriptions.push(...disposables);
 };
diff --git a/src/commands/posts-list/open-post-in-vscode.ts b/src/commands/posts-list/open-post-in-vscode.ts
@@ -1,5 +1,5 @@
 import fs from 'fs';
-import path = require('path');
+import path from 'path';
 import { FileSystemError, MessageOptions, Uri, window, workspace } from 'vscode';
 import { Post } from '../../models/post';
 import { AlertService } from '../../services/alert.service';
@@ -17,12 +17,12 @@ const buildLocalPostFileUri = async (post: Post, includePostId = false): Promise
     return Uri.joinPath(workspaceUri, `${postTitle}${postIdSegment}${ext}`);
 };
 
-export const openPostInVscode = async (postId: number, forceUpdateLocalPostFile = false) => {
+export const openPostInVscode = async (postId: number, forceUpdateLocalPostFile = false): Promise<Uri | false> => {
     let mappedPostFilePath = PostFileMapManager.getFilePath(postId);
     const isFileExist = mappedPostFilePath ? fs.existsSync(mappedPostFilePath) : false;
     if (isFileExist && !forceUpdateLocalPostFile) {
         await openPostFile(mappedPostFilePath!);
-        return;
+        return Uri.file(mappedPostFilePath!);
     }
     // 本地文件已经被删除了, 确保重新生成博文与本地文件的关联
     if (mappedPostFilePath && !isFileExist) {
@@ -32,7 +32,7 @@ export const openPostInVscode = async (postId: number, forceUpdateLocalPostFile
 
     const postEditDto = await postService.fetchPostEditDto(postId);
     if (!postEditDto) {
-        return;
+        return false;
     }
     const post = postEditDto.post;
 
@@ -59,7 +59,7 @@ export const openPostInVscode = async (postId: number, forceUpdateLocalPostFile
                     break;
                 // 取消, 直接返回, 不进行任何操作
                 case undefined:
-                    return;
+                    return false;
             }
         }
     }
@@ -68,6 +68,7 @@ export const openPostInVscode = async (postId: number, forceUpdateLocalPostFile
     await workspace.fs.writeFile(fileUri, new TextEncoder().encode(postEditDto.post.postBody));
     await PostFileMapManager.updateOrCreate(postId, fileUri.fsPath);
     await openPostFile(post);
+    return fileUri;
 };
 
 const createDirectoryIfNotExist = async (uri: Uri) => {
diff --git a/src/commands/pull-post-remote-updates.ts b/src/commands/pull-post-remote-updates.ts
@@ -0,0 +1,102 @@
+import { MessageOptions, Uri, window, workspace } from 'vscode';
+import { Post } from '../models/post';
+import { PostFileMapManager } from '../services/post-file-map';
+import { openPostInVscode } from './posts-list/open-post-in-vscode';
+import fs from 'fs';
+import { postService } from '../services/post.service';
+import { AlertService } from '../services/alert.service';
+import path from 'path';
+import { revealPostsListItem } from '../services/posts-list-view';
+
+const pullPostRemoteUpdates = async (input: Post | Uri | undefined | null): Promise<void> => {
+    let ctxs: CommandContext[] = [];
+    let uri: Uri | undefined;
+    if (parsePostInput(input) && input.id > 0) {
+        await handlePostInput(input, ctxs);
+    } else if ((uri = parseUriInput(input))) {
+        await handleUriInput(uri, ctxs);
+    }
+
+    if (ctxs.length <= 0 || !(await confirmOperation(ctxs))) {
+        return;
+    }
+
+    await update(ctxs);
+
+    AlertService.info(`本地文件${resolveFileNames(ctxs)}已更新`);
+};
+
+export { pullPostRemoteUpdates };
+
+type InputType = Post | Uri | undefined | null;
+type CommandContext = { postId: number; fileUri: Uri };
+
+const parsePostInput = (input: InputType): input is Post => input instanceof Post;
+
+const handlePostInput = async (post: Post, contexts: CommandContext[]) => {
+    const { id: postId } = post;
+    let filePath = PostFileMapManager.getFilePath(postId);
+    if (filePath && !fs.existsSync(filePath)) {
+        // 博文关联了本地不存在文件, 此时需要删除这个关联
+
+        filePath = '';
+        await PostFileMapManager.updateOrCreate(postId, filePath);
+    }
+    if (!filePath) {
+        // 本地没有这篇博文, 直接将博文下载到本地即可
+        return void (await openPostInVscode(postId, false));
+    }
+
+    await revealPostsListItem(post);
+    contexts.push({ postId: postId, fileUri: Uri.file(filePath) });
+};
+
+const parseUriInput = (input: InputType): Uri | undefined => {
+    if (input instanceof Uri) {
+        return input;
+    }
+    const { document } = window.activeTextEditor ?? {};
+    if (document && !document.isUntitled) {
+        return document.uri;
+    }
+};
+
+const handleUriInput = (fileUri: Uri, contexts: CommandContext[]): Promise<void> => {
+    const postId = PostFileMapManager.getPostId(fileUri.fsPath);
+    if (!postId) {
+        AlertService.warning(
+            `本地文件"${path.basename(fileUri.fsPath, path.extname(fileUri.fsPath))}"未关联博客园博文`
+        );
+        return Promise.resolve();
+    }
+    contexts.push({ postId, fileUri });
+    return Promise.resolve();
+};
+
+const confirmOperation = async (ctxs: CommandContext[]): Promise<boolean> => {
+    const options = ['确定'];
+    return (
+        (await window.showWarningMessage(
+            '确定要拉取远程博文内容更新本地文件吗?',
+            {
+                modal: true,
+                detail: `本地文件${resolveFileNames(ctxs)}的内容将被覆盖, 数据无价, 请谨慎操作`,
+            } as MessageOptions,
+            ...options
+        )) === options[0]
+    );
+};
+
+const update = async (contexts: CommandContext[]) => {
+    for (const ctx of contexts) {
+        const { fileUri, postId } = ctx;
+        const { post } = (await postService.fetchPostEditDto(postId)) ?? {};
+        if (post) {
+            const textEditors = window.visibleTextEditors.filter(x => x.document.uri.fsPath === fileUri.fsPath);
+            await Promise.all(textEditors.map(editor => editor.document.save()));
+            await workspace.fs.writeFile(fileUri, new TextEncoder().encode(post.postBody));
+        }
+    }
+};
+
+const resolveFileNames = (ctxs: CommandContext[]) => `"${ctxs.map(x => path.basename(x.fileUri.fsPath)).join('", ')}"`;
diff --git a/src/services/posts-list-view.ts b/src/services/posts-list-view.ts
@@ -9,6 +9,6 @@ export const revealPostsListItem = async (
         return;
     }
 
-    const view = [extensionViews.postsList, extensionViews.anotherPostsList].find(x => x?.visible);
+    const view = extensionViews.visiblePostList();
     await view?.reveal(post, options);
 };

Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,6 @@ export const revealPostsListItem = async (`
`9`	`9`	`return;`
`10`	`10`	`}`
`11`	`11`
`12`		`- const view = [extensionViews.postsList, extensionViews.anotherPostsList].find(x => x?.visible);`
	`12`	`+ const view = extensionViews.visiblePostList();`
`13`	`13`	`await view?.reveal(post, options);`
`14`	`14`	`};`