feat: support publish ing (#89)

laggage · web-flow · commit fe843cda2935 · 2022-11-15T18:49:28.000+08:00
diff --git a/README.md b/README.md
@@ -19,6 +19,7 @@
 	- [导出 pdf](#导出-pdf)
 	- [提取图片](#提取图片)
 	- [博文设置面板](#博文设置面板)
+	- [闪存](#闪存)
 - [vscode 版本要求](#vscode-版本要求)
 - [插件设置](#插件设置)
 
@@ -144,6 +145,28 @@
 
 <kbd><img src="https://img2022.cnblogs.com/blog/1596066/202203/1596066-20220331113211016-1457564407.png?v=202204242" height="550"></kbd>
 
+### 闪存
+
+支持通过快捷键 `ctrl+s ctrl+c`(windows) `cmd + s cmd+c`(mac) 调用发闪存命令, 发闪存前需要先编辑, 编辑完成后可以发布; 也可以在编辑器中选中一段文本或代码, 然后鼠标右键唤起上下文菜单, 可以将选中的内容发到闪存
+
+<kbd><img src="https://img2022.cnblogs.com/blog/35695/202211/35695-20221115143017664-1504226894.png" alt="" height="550"></kbd>
+
+可以通过博客园导航视图中有 `发闪存` 按钮调用发闪存命令, 点击后会先要求编辑闪存, 编辑后可以发布
+
+<kbd><img src="https://img2022.cnblogs.com/blog/35695/202211/35695-20221115143240134-832955354.png" alt="" height="550"></kbd>
+
+<kbd><img src="https://img2022.cnblogs.com/blog/35695/202211/35695-20221115144008924-1453379990.png" alt=""></kbd>
+
+编辑完成后回车会弹出确认框, 此时可以通过 `编辑内容` `编辑访问权限` `编辑标签` 按钮二次编辑
+
+<kbd><img src="https://img2022.cnblogs.com/blog/35695/202211/35695-20221115143733447-1514251853.png" height="550"></kbd>
+
+也可以通过VSCode命令面板(`ctrl/cmd + p`唤起命令面板)调用发闪存命令
+
+<kbd><img src="https://img2022.cnblogs.com/blog/35695/202211/35695-20221115144307251-1543702626.png" height="550"></kbd>
+
+通过本插件发布的闪存, 在尾部会显示一个vscode图标
+
 ## vscode 版本要求
 
 \>=1.62.0
diff --git a/package.json b/package.json
@@ -29,7 +29,8 @@
         "onView:vscode-cnb-workspace",
         "onCommand:vscode-cnb.open-workspace",
         "onCommand:vscode-cnb.login",
-        "onCommand:vscode-cnb.logout"
+        "onCommand:vscode-cnb.logout",
+        "onCommand:vscode-cnb.ing-publish-selection"
     ],
     "main": "./dist/extension.js",
     "contributes": {
@@ -289,6 +290,18 @@
                 "category": "Cnblogs",
                 "icon": "$(refresh)",
                 "enablement": "vscode-cnb.isAuthorized && !vscode-cnb.posts-list-refreshing"
+            },
+            {
+                "command": "vscode-cnb.ing.publish",
+                "title": "发闪存",
+                "category": "Cnblogs",
+                "enablement": "vscode-cnb.isAuthorized"
+            },
+            {
+                "command": "vscode-cnb.ing.publish-selection",
+                "title": "将选中内容发到闪存",
+                "category": "Cnblogs",
+                "enablement": "vscode-cnb.isAuthorized && editorHasSelection == true && isInDiffEditor == false && isInEmbeddedEditor == false"
             }
         ],
         "configuration": [
@@ -532,6 +545,10 @@
                 {
                     "command": "vscode-cnb.export-post-to-pdf",
                     "when": "false"
+                },
+                {
+                    "command": "vscode-cnb.ing.publish-selection",
+                    "when": "false"
                 }
             ],
             "view/item/context": [
@@ -693,6 +710,10 @@
                     "command": "vscode-cnb.extract-images",
                     "when": "resourceLangId == markdown",
                     "group": "cnblogs@9"
+                },
+                {
+                    "command": "vscode-cnb.ing.publish-selection",
+                    "group": "cnblogs@10"
                 }
             ],
             "editor/title": [
@@ -757,6 +778,11 @@
                 "key": "ctrl+alt+f",
                 "mac": "cmd+alt+f",
                 "when": "editorTextFocus && resourceLangId == markdown"
+            },
+            {
+                "command": "vscode-cnb.ing.publish",
+                "key": "ctrl+s ctrl+c",
+                "mac": "cmd+s cmd+c"
             }
         ],
         "viewsContainers": {
@@ -781,6 +807,11 @@
                 "view": "cnblogs-navigation",
                 "contents": "[首页](https://www.cnblogs.com)\n[新闻](https://news.cnblogs.com/)\n[博问](https://q.cnblogs.com/)\n[闪存](https://ing.cnblogs.com/)"
             },
+            {
+                "view": "cnblogs-navigation",
+                "contents": "[发闪存](command:vscode-cnb.ing.publish)",
+                "when": "vscode-cnb.isAuthorized"
+            },
             {
                 "view": "vscode-cnb-workspace",
                 "contents": "[在vscode中打开工作空间](command:vscode-cnb.open-workspace)",
diff --git a/src/commands/command-handler.ts b/src/commands/command-handler.ts
@@ -1,7 +1,9 @@
-export abstract class TreeViewCommandHandler<TData> {
-    readonly input: unknown;
-
+export abstract class CommandHandler {
     abstract handle(): Promise<void> | void;
+}
+
+export abstract class TreeViewCommandHandler<TData> extends CommandHandler {
+    readonly input: unknown;
 
     abstract parseInput(): TData | null;
 }
diff --git a/src/commands/commands-registration.ts b/src/commands/commands-registration.ts
@@ -34,6 +34,7 @@ import { pullPostRemoteUpdates } from './pull-post-remote-updates';
 import { extractImages } from './extract-images';
 import { clearPostsSearchResults, refreshPostsSearchResults, searchPosts } from './posts-list/search';
 import { handleDeletePostCategories } from './post-category/delete-selected-categories';
+import { PublishIngCommandHandler } from '@/commands/ing/publish-ing';
 
 export const registerCommands = () => {
     const context = globalState.extensionContext;
@@ -77,6 +78,10 @@ export const registerCommands = () => {
         commands.registerCommand(`${appName}.search-posts`, searchPosts),
         commands.registerCommand(`${appName}.clear-posts-search-results`, clearPostsSearchResults),
         commands.registerCommand(`${appName}.refresh-posts-search-results`, refreshPostsSearchResults),
+        commands.registerCommand(`${appName}.ing.publish`, () => new PublishIngCommandHandler('input').handle()),
+        commands.registerCommand(`${appName}.ing.publish-selection`, () =>
+            new PublishIngCommandHandler('selection').handle()
+        ),
     ];
     context?.subscriptions.push(...disposables);
 };
diff --git a/src/commands/ing/publish-ing.ts b/src/commands/ing/publish-ing.ts
@@ -0,0 +1,185 @@
+import { CommandHandler } from '@/commands/command-handler';
+import { IngPublishModel } from '@/models/ing';
+import { AlertService } from '@/services/alert.service';
+import { globalState } from '@/services/global-state';
+import { IngApi } from '@/services/ing.api';
+import { InputStep, MultiStepInput, QuickPickParameters } from '@/services/multi-step-input';
+import { commands, MessageOptions, ProgressLocation, QuickPickItem, Uri, window } from 'vscode';
+
+export class PublishIngCommandHandler extends CommandHandler {
+    readonly maxLength = 0;
+    readonly operation = '发布闪存';
+    readonly editingText = '编辑闪存';
+    readonly inputStep: Record<'content' | 'access' | 'tags', InputStep> = {
+        content: async input => {
+            this.currentStep = 1;
+            this.inputContent = await input.showInputBox({
+                title: this.editingText + ' - 内容',
+                value: this.inputContent,
+                prompt: '你在做什么? 你在想什么?',
+                totalSteps: Object.keys(this.inputStep).length,
+                step: this.currentStep,
+                validateInput: v => Promise.resolve(v.length > 2000 ? '最多输入2000个字符' : undefined),
+                shouldResume: () => Promise.resolve(false),
+            });
+            return this.inputContent ? this.inputStep.access : undefined;
+        },
+        access: async input => {
+            this.currentStep = 2;
+            const items = [
+                { label: '公开', value: false },
+                { label: '仅自己', value: true },
+            ];
+            const activeItem = items.filter(x => x.value === this.inputIsPrivate);
+            const result = <QuickPickItem & { value: boolean }>await input.showQuickPick<
+                QuickPickItem & { value: boolean },
+                QuickPickParameters<QuickPickItem & { value: boolean }>
+            >({
+                title: this.editingText + ' - 访问权限',
+                placeholder: '',
+                step: this.currentStep,
+                totalSteps: Object.keys(this.inputStep).length,
+                items: items,
+                activeItems: activeItem,
+                canSelectMany: false,
+                shouldResume: () => Promise.resolve(false),
+            });
+            if (result && result.value != null) {
+                this.inputIsPrivate = result.value;
+                return this.inputStep.tags;
+            }
+        },
+        tags: async input => {
+            this.currentStep = 3;
+            const value = await input.showInputBox({
+                title: this.editingText + '标签(非必填)',
+                step: this.currentStep,
+                totalSteps: Object.keys(this.inputStep).length,
+                placeHolder: '在此输入标签',
+                shouldResume: () => Promise.resolve(false),
+                prompt: '输入标签, 以 "," 分隔',
+                validateInput: () => Promise.resolve(undefined),
+                value: this.inputTags.join(', '),
+            });
+            this.inputTags = value
+                .split(/, ?/)
+                .map(x => x.trim())
+                .filter(x => !!x);
+        },
+    };
+    inputTags: string[] = [];
+    inputContent = '';
+    inputIsPrivate = false;
+    currentStep = 0;
+
+    constructor(public readonly contentSource: 'selection' | 'input' = 'selection') {
+        super();
+    }
+
+    private get formattedIngContent() {
+        return `${this.inputTags.map(x => `[${x}]`).join('')}${this.inputContent}`;
+    }
+
+    async handle() {
+        const content = await this.getContent();
+        if (!content) return;
+        const api = new IngApi();
+        await this.onPublished(
+            await window.withProgress({ location: ProgressLocation.Notification, title: '正在发闪, 请稍候...' }, p => {
+                p.report({ increment: 30 });
+                return api.publishIng(content).then(isPublished => {
+                    p.report({ increment: 70 });
+                    return isPublished;
+                });
+            })
+        );
+    }
+
+    private getContent(): Promise<IngPublishModel | false> {
+        switch (this.contentSource) {
+            case 'selection':
+                return this.getContentFromSelection();
+            case 'input':
+                return this.acquireInputContent();
+        }
+    }
+
+    private getContentFromSelection(): Promise<IngPublishModel | false> {
+        const text = window.activeTextEditor?.document.getText(window.activeTextEditor?.selection);
+        if (!text) {
+            this.warnNoSelection();
+            return Promise.resolve(false);
+        }
+        this.inputContent = text;
+        return this.acquireInputContent();
+    }
+
+    private async acquireInputContent(step = this.inputStep.content): Promise<IngPublishModel | false> {
+        await MultiStepInput.run(step);
+        return this.inputContent &&
+            this.currentStep === Object.keys(this.inputStep).length &&
+            (await this.confirmPublish())
+            ? {
+                  content: this.formattedIngContent,
+                  isPrivate: this.inputIsPrivate,
+              }
+            : false;
+    }
+
+    private async confirmPublish(): Promise<boolean> {
+        const items = [
+            ['确定', () => Promise.resolve(true)],
+            ['编辑内容', async () => (await this.acquireInputContent(this.inputStep.content)) !== false],
+            ['编辑访问权限', async () => (await this.acquireInputContent(this.inputStep.access)) !== false],
+            ['编辑标签', async () => (await this.acquireInputContent(this.inputStep.tags)) !== false],
+        ] as const;
+        const selected = await window.showInformationMessage(
+            '确定要发布闪存吗?',
+            {
+                modal: true,
+                detail: '📝' + this.formattedIngContent + (this.inputIsPrivate ? '\n\n🔒仅自己可见' : ''),
+            } as MessageOptions,
+            ...items.map(([title]) => title)
+        );
+        return (await items.find(x => x[0] === selected)?.[1].call(null)) ?? false;
+    }
+
+    private warnNoSelection() {
+        AlertService.warning(`无法${this.operation}, 当前没有选中的内容`);
+    }
+
+    private async onPublished(isPublished: boolean): Promise<void> {
+        if (isPublished) {
+            const options = [
+                [
+                    '打开闪存',
+                    (): Thenable<void> => commands.executeCommand('vscode.open', Uri.parse(globalState.config.ingSite)),
+                ],
+                [
+                    '我的闪存',
+                    (): Thenable<void> =>
+                        commands.executeCommand('vscode.open', Uri.parse(globalState.config.ingSite + '/#my')),
+                ],
+                [
+                    '新回应',
+                    (): Thenable<void> =>
+                        commands.executeCommand(
+                            'vscode.open',
+                            Uri.parse(globalState.config.ingSite + '/#recentcomment')
+                        ),
+                ],
+                [
+                    '提到我',
+                    (): Thenable<void> =>
+                        commands.executeCommand('vscode.open', Uri.parse(globalState.config.ingSite + '/#mention')),
+                ],
+            ] as const;
+            const option = await window.showInformationMessage(
+                '闪存已发布, 快去看看吧',
+                { modal: false },
+                ...options.map(v => ({ title: v[0], id: v[0] }))
+            );
+            if (option) return options.find(x => x[0] === option.id)?.[1].call(null);
+        }
+    }
+}
diff --git a/src/models/config.ts b/src/models/config.ts
@@ -13,6 +13,8 @@ export interface IConfig {
         revocationEndpoint: string;
     };
     apiBaseUrl: string;
+    ingSite: string;
+    cnblogsOpenApiUrl: string;
 }
 
 export const isDev = () => process.env.NODE_ENV === 'Development';
@@ -30,6 +32,8 @@ export const defaultConfig: IConfig = {
         revocationEndpoint: '/connection/revocation',
     },
     apiBaseUrl: 'https://i.cnblogs.com',
+    ingSite: 'https://ing.cnblogs.com',
+    cnblogsOpenApiUrl: 'https://api.cnblogs.com',
 };
 
 export const devConfig = Object.assign({}, defaultConfig, {
@@ -39,4 +43,6 @@ export const devConfig = Object.assign({}, defaultConfig, {
         clientSecret: env.ClientSecret ? env.ClientSecret : '',
     }),
     apiBaseUrl: 'https://admin.cnblogs.com',
+    ingSite: 'https://my-ing.cnblogs.com',
+    cnblogsOpenApiUrl: 'https://my-api.cnblogs.com',
 });
diff --git a/src/models/ing.ts b/src/models/ing.ts
@@ -0,0 +1,11 @@
+export class Ing {
+    id = -1;
+    content = '';
+    isPrivate = false;
+
+    static parse(this: void, value: unknown): Ing {
+        return Object.assign(new Ing(), typeof value === 'object' ? value : {});
+    }
+}
+
+export type IngPublishModel = Pick<Ing, 'content' | 'isPrivate'>;
diff --git a/src/services/ing.api.ts b/src/services/ing.api.ts
@@ -0,0 +1,19 @@
+import { IngPublishModel } from '@/models/ing';
+import { accountService } from '@/services/account.service';
+import { AlertService } from '@/services/alert.service';
+import { globalState } from '@/services/global-state';
+import fetch from 'node-fetch';
+
+export class IngApi {
+    async publishIng(ing: IngPublishModel): Promise<boolean> {
+        const resp = await fetch(`${globalState.config.cnblogsOpenApiUrl}/api/statuses`, {
+            method: 'POST',
+            body: JSON.stringify(ing),
+            headers: [accountService.buildBearerAuthorizationHeader(), ['Content-Type', 'application/json']],
+        }).catch(reason => void AlertService.warning(JSON.stringify(reason)));
+        if (!resp || !resp.ok)
+            AlertService.error(`闪存发布失败, ${resp?.statusText ?? ''} ${JSON.stringify((await resp?.text()) ?? '')}`);
+
+        return resp != null && resp.ok;
+    }
+}
