├── gradle.properties
├── ui
    ├── env.d.ts
    ├── tsconfig.json
    ├── tsconfig.vitest.json
    ├── tsconfig.app.json
    ├── tsconfig.node.json
    ├── vite.config.ts
    ├── src
    │   ├── domain
    │   │   └── index.d.ts
    │   ├── views
    │   │   ├── ImportArtical.vue
    │   │   ├── HomeView.vue
    │   │   ├── ExportArtical.vue
    │   │   └── ExportListItem.vue
    │   ├── index.ts
    │   ├── components
    │   │   └── entity
    │   │   │   └── EntityDropdownItems.vue
    │   └── assets
    │   │   └── logo.svg
    ├── build.gradle
    ├── eslint.config.ts
    └── package.json
├── src
    ├── main
    │   ├── resources
    │   │   ├── logo.png
    │   │   ├── plugin.yaml
    │   │   └── extensions
    │   │   │   └── roleTemplate.yaml
    │   └── java
    │   │   └── cn
    │   │       └── lyn4ever
    │   │           └── export2md
    │   │               ├── service
    │   │                   ├── ExportService.java
    │   │                   ├── ImportService.java
    │   │                   ├── PostService.java
    │   │                   └── impl
    │   │                   │   ├── ImportServiceV2.java
    │   │                   │   ├── PostServiceImpl.java
    │   │                   │   └── ExportServiceImpl.java
    │   │               ├── halo
    │   │                   ├── Content.java
    │   │                   ├── PostRequest.java
    │   │                   ├── ContentWrapper.java
    │   │                   ├── ContentRequest.java
    │   │                   └── service
    │   │                   │   └── AbstractContentService.java
    │   │               ├── schema
    │   │                   ├── ImportLogSchema.java
    │   │                   └── ExportLogSchema.java
    │   │               ├── util
    │   │                   ├── FileUtil.java
    │   │                   └── PatchUtils.java
    │   │               ├── HaloPluginExport2docPlugin.java
    │   │               └── rest
    │   │                   ├── ImportController.java
    │   │                   └── ExportController.java
    └── test
    │   └── java
    │       └── cn
    │           └── lyn4ever
    │               └── export2md
    │                   └── HaloPluginExport2docPluginTest.java
├── gradle
    └── wrapper
    │   ├── gradle-wrapper.jar
    │   └── gradle-wrapper.properties
├── settings.gradle
├── .github
    └── workflows
    │   ├── ci.yaml
    │   └── cd.yaml
├── .gitignore
├── README.md
├── gradlew.bat
├── gradlew
├── .editorconfig
└── LICENSE


/gradle.properties:
--------------------------------------------------------------------------------
1 | version=1.2.5
2 | 


--------------------------------------------------------------------------------
/ui/env.d.ts:
--------------------------------------------------------------------------------
1 | /// <reference types="vite/client" />
2 | /// <reference types="unplugin-icons/types/vue" />
3 | 


--------------------------------------------------------------------------------
/src/main/resources/logo.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Lyn4ever29/halo-plugin-export-md/HEAD/src/main/resources/logo.png


--------------------------------------------------------------------------------
/gradle/wrapper/gradle-wrapper.jar:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/Lyn4ever29/halo-plugin-export-md/HEAD/gradle/wrapper/gradle-wrapper.jar


--------------------------------------------------------------------------------
/settings.gradle:
--------------------------------------------------------------------------------
1 | pluginManagement {
2 |     repositories {
3 |         gradlePluginPortal()
4 |     }
5 | }
6 | rootProject.name = 'halo-plugin-export2doc'
7 | include 'ui'
8 | 


--------------------------------------------------------------------------------
/ui/tsconfig.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "files": [],
 3 |   "references": [
 4 |     {
 5 |       "path": "./tsconfig.node.json"
 6 |     },
 7 |     {
 8 |       "path": "./tsconfig.app.json"
 9 |     },
10 |     {
11 |       "path": "./tsconfig.vitest.json"
12 |     }
13 |   ]
14 | }
15 | 


--------------------------------------------------------------------------------
/ui/tsconfig.vitest.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "extends": "./tsconfig.app.json",
 3 |   "include": ["src/**/__tests__/*", "env.d.ts"],
 4 |   "exclude": [],
 5 |   "compilerOptions": {
 6 |     "tsBuildInfoFile": "./node_modules/.tmp/tsconfig.vitest.tsbuildinfo",
 7 | 
 8 |     "lib": [],
 9 |     "types": ["node", "jsdom"]
10 |   }
11 | }
12 | 


--------------------------------------------------------------------------------
/ui/tsconfig.app.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "extends": "@vue/tsconfig/tsconfig.dom.json",
 3 |   "include": ["env.d.ts", "src/**/*", "src/**/*.vue"],
 4 |   "exclude": ["src/**/__tests__/*"],
 5 |   "compilerOptions": {
 6 |     "tsBuildInfoFile": "./node_modules/.tmp/tsconfig.app.tsbuildinfo",
 7 | 
 8 |     "paths": {
 9 |       "@/*": ["./src/*"]
10 |     }
11 |   }
12 | }
13 | 


--------------------------------------------------------------------------------
/src/main/java/cn/lyn4ever/export2md/service/ExportService.java:
--------------------------------------------------------------------------------
 1 | package cn.lyn4ever.export2md.service;
 2 | 
 3 | import cn.lyn4ever.export2md.schema.ExportLogSchema;
 4 | 
 5 | /**
 6 |  * @author Lyn4ever29
 7 |  * @url https://jhacker.cn
 8 |  * @date 2023/12/5
 9 |  */
10 | public interface ExportService {
11 |     public void runTask(ExportLogSchema exportLogSchema);
12 | 
13 | }
14 | 


--------------------------------------------------------------------------------
/.github/workflows/ci.yaml:
--------------------------------------------------------------------------------
 1 | name: CI
 2 | 
 3 | on:
 4 |   push:
 5 |     branches:
 6 |       - main
 7 |   pull_request:
 8 |     branches:
 9 |       - main
10 | 
11 | jobs:
12 |   ci:
13 |     uses: halo-sigs/reusable-workflows/.github/workflows/plugin-ci.yaml@v3
14 |     with:
15 |       ui-path: "ui"
16 |       pnpm-version: 9
17 |       node-version: 22
18 |       java-version: 21
19 | 


--------------------------------------------------------------------------------
/src/main/java/cn/lyn4ever/export2md/halo/Content.java:
--------------------------------------------------------------------------------
 1 | package cn.lyn4ever.export2md.halo;
 2 | 
 3 | import lombok.AllArgsConstructor;
 4 | import lombok.Data;
 5 | import lombok.NoArgsConstructor;
 6 | 
 7 | @Data
 8 | @NoArgsConstructor
 9 | @AllArgsConstructor
10 | public class Content  {
11 |     private String raw;
12 |     private String content;
13 |     private String rawType;
14 | 
15 | }
16 | 


--------------------------------------------------------------------------------
/gradle/wrapper/gradle-wrapper.properties:
--------------------------------------------------------------------------------
1 | distributionBase=GRADLE_USER_HOME
2 | distributionPath=wrapper/dists
3 | #distributionUrl=https\://services.gradle.org/distributions/gradle-8.14-bin.zip
4 | distributionUrl=https\://mirrors.aliyun.com/gradle/distributions/v9.0.0/gradle-9.0.0-all.zip
5 | networkTimeout=10000
6 | validateDistributionUrl=true
7 | zipStoreBase=GRADLE_USER_HOME
8 | zipStorePath=wrapper/dists
9 | 


--------------------------------------------------------------------------------
/ui/tsconfig.node.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "extends": "@tsconfig/node20/tsconfig.json",
 3 |   "include": [
 4 |     "vite.config.*",
 5 |     "vitest.config.*"
 6 |   ],
 7 |   "compilerOptions": {
 8 |     "composite": true,
 9 |     "noEmit": true,
10 |     "tsBuildInfoFile": "./node_modules/.tmp/tsconfig.node.tsbuildinfo",
11 |     "module": "ESNext",
12 |     "moduleResolution": "Bundler",
13 |     "types": ["node"]
14 |   }
15 | }
16 | 


--------------------------------------------------------------------------------
/src/main/java/cn/lyn4ever/export2md/service/ImportService.java:
--------------------------------------------------------------------------------
 1 | package cn.lyn4ever.export2md.service;
 2 | 
 3 | import reactor.core.publisher.Mono;
 4 | import run.halo.app.core.extension.content.Post;
 5 | import java.io.File;
 6 | 
 7 | /**
 8 |  * @author Lyn4ever29
 9 |  * @url https://jhacker.cn
10 |  * @date 2023/11/12
11 |  */
12 | public interface ImportService {
13 | 
14 | 
15 |     /**
16 |      * 运行导出任务
17 |      *
18 |      * @param filePart
19 |      */
20 |     Mono<Post> runTask(File file);
21 | 
22 | }
23 | 
24 | 
25 | 
26 | 


--------------------------------------------------------------------------------
/.github/workflows/cd.yaml:
--------------------------------------------------------------------------------
 1 | name: CD
 2 | 
 3 | on:
 4 |   release:
 5 |     types:
 6 |       - published
 7 | 
 8 | jobs:
 9 |   cd:
10 |     uses: halo-sigs/reusable-workflows/.github/workflows/plugin-cd.yaml@v3
11 |     permissions:
12 |       contents: write
13 |     with:
14 |       ui-path: "ui"
15 |       pnpm-version: 9
16 |       node-version: 22
17 |       java-version: 21
18 |       # Remove skip-appstore-release and set app-id if you want to release to the App Store
19 |       skip-appstore-release: true
20 |       # app-id: app-xyz
21 | 


--------------------------------------------------------------------------------
/src/test/java/cn/lyn4ever/export2md/HaloPluginExport2docPluginTest.java:
--------------------------------------------------------------------------------
 1 | package cn.lyn4ever.export2md;
 2 | 
 3 | import org.junit.jupiter.api.Test;
 4 | import org.junit.jupiter.api.extension.ExtendWith;
 5 | import org.mockito.InjectMocks;
 6 | import org.mockito.Mock;
 7 | import org.mockito.junit.jupiter.MockitoExtension;
 8 | 
 9 | import run.halo.app.plugin.PluginContext;
10 | 
11 | @ExtendWith(MockitoExtension.class)
12 | class HaloPluginExport2docPluginTest {
13 | 
14 |     @Mock
15 |     PluginContext context;
16 | 
17 |     @InjectMocks
18 |     HaloPluginExport2docPlugin plugin;
19 |     
20 |     @Test
21 |     void contextLoads() {
22 |         // plugin.start();
23 |         // plugin.stop();
24 |     }
25 | }
26 | 


--------------------------------------------------------------------------------
/ui/vite.config.ts:
--------------------------------------------------------------------------------
 1 | import { fileURLToPath, URL } from 'url'
 2 | 
 3 | import { viteConfig } from '@halo-dev/ui-plugin-bundler-kit'
 4 | import Icons from 'unplugin-icons/vite'
 5 | import { configDefaults } from 'vitest/config'
 6 | 
 7 | // For more info,
 8 | // please see https://github.com/halo-dev/halo/tree/main/ui/packages/ui-plugin-bundler-kit
 9 | export default viteConfig({
10 |   vite: {
11 |     plugins: [Icons({ compiler: 'vue3' })],
12 |     resolve: {
13 |       alias: {
14 |         '@': fileURLToPath(new URL('./src', import.meta.url)),
15 |       },
16 |     },
17 | 
18 |     // If you don't use Vitest, you can remove the following configuration
19 |     test: {
20 |       environment: 'jsdom',
21 |       exclude: [...configDefaults.exclude, 'e2e/**'],
22 |       root: fileURLToPath(new URL('./', import.meta.url)),
23 |     },
24 |   },
25 | })
26 | 


--------------------------------------------------------------------------------
/src/main/java/cn/lyn4ever/export2md/halo/PostRequest.java:
--------------------------------------------------------------------------------
 1 | package cn.lyn4ever.export2md.halo;
 2 | 
 3 | import lombok.Data;
 4 | import run.halo.app.core.extension.content.Post;
 5 | import run.halo.app.extension.Ref;
 6 | 
 7 | /**
 8 |  * Post and content data for creating and updating post.
 9 |  *
10 |  * @author guqing
11 |  * @since 2.0.0
12 |  */
13 | @Data
14 | public class PostRequest {
15 | 
16 | 
17 |     private Post post;
18 |     private Content content;
19 | 
20 |     public PostRequest(Post post, Content content) {
21 |         this.post = post;
22 |         this.content = content;
23 |     }
24 | 
25 |     public ContentRequest contentRequest() {
26 |         Ref subjectRef = Ref.of(post);
27 |         return new ContentRequest(subjectRef, post.getSpec().getHeadSnapshot(), content.getRaw(),
28 |             content.getContent(), content.getRawType());
29 |     }
30 | }
31 | 


--------------------------------------------------------------------------------
/src/main/resources/plugin.yaml:
--------------------------------------------------------------------------------
 1 | apiVersion: plugin.halo.run/v1alpha1
 2 | kind: Plugin
 3 | metadata:
 4 |   # The name defines how the plugin is invoked,A unique name
 5 |   name: export2doc
 6 | spec:
 7 |   enabled: true
 8 |   requires: ">=2.12.0"
 9 |   author:
10 |     name: Lyn4ever29
11 |     website: https://jhacker.cn
12 |   logo: logo.png
13 |   # 'homepage' usually links to the GitHub repository of the plugin
14 |   homepage: https://jhacker.cn/2023/halo-plugin-export2doc
15 |   repo: https://github.com/halo-dev/plugin-starter
16 |   issues: https://github.com/halo-dev/plugin-starter/issues
17 |   # 'displayName' explains what the plugin does in only a few words
18 |   displayName: "文章导入导出"
19 |   description: "导出文章为markdown、HTML文件，同时支持导入markdown文件"
20 |   license:
21 |     - name: "GPL-3.0"
22 |       url: "https://github.com/halo-dev/plugin-starter/blob/main/LICENSE"
23 | 
24 | 


--------------------------------------------------------------------------------
/ui/src/domain/index.d.ts:
--------------------------------------------------------------------------------
 1 | import type { Metadata } from "@halo-dev/api-client";
 2 | /**
 3 |  *
 4 |  * @export
 5 |  * @interface ExportLog
 6 |  */
 7 | export interface ExportLog {
 8 |   name: string;
 9 |   costSeconds: number;
10 |   createTime: Date;
11 |   status: "a" | "b" | "c";
12 |   tag: string;
13 |   category: string;
14 |   beginTime: string;
15 |   endTime: string;
16 |   remainMetaData: boolean;
17 |   remainCategory: boolean;
18 |   kind: "ExportLog";
19 |   apiVersion: "cn.lyn4ever.export2doc/v1alpha1";
20 |   metadata: Metadata;
21 | }
22 | 
23 | export interface ProblemDetail {
24 |   detail: string;
25 |   instance: string;
26 |   status: number;
27 |   title: string;
28 |   type?: string;
29 | }
30 | 
31 | export interface ListedExportLogList {
32 |   first: boolean;
33 |   hasNext: boolean;
34 |   hasPrevious: boolean;
35 |   items: Array<ExportLog>;
36 |   last: boolean;
37 |   page: number;
38 |   size: number;
39 |   total: number;
40 |   totalPages: number;
41 | }
42 | 


--------------------------------------------------------------------------------
/ui/build.gradle:
--------------------------------------------------------------------------------
 1 | plugins {
 2 |     id 'base'
 3 |     id "com.github.node-gradle.node" version "7.1.0"
 4 | }
 5 | 
 6 | group 'cn.lyn4ever.export2doc.ui'
 7 | 
 8 | tasks.register('pnpmBuild', PnpmTask) {
 9 |     group = 'build'
10 |     description = 'Build the UI project using pnpm'
11 |     args = ['build']
12 |     dependsOn tasks.named('pnpmInstall')
13 |     inputs.dir(layout.projectDirectory.dir('src'))
14 |     inputs.files(fileTree(
15 |         dir: layout.projectDirectory,
16 |         includes: ['*.cjs', '*.ts', '*.js', '*.json', '*.yaml']))
17 |     outputs.dir(layout.buildDirectory.dir('dist'))
18 | }
19 | 
20 | tasks.register('pnpmCheck', PnpmTask) {
21 |     group = 'verification'
22 |     description = 'Run unit tests for the UI project using pnpm'
23 |     args = ['test:unit']
24 |     dependsOn tasks.named('pnpmInstall')
25 | }
26 | 
27 | tasks.named('check') {
28 |     dependsOn tasks.named('pnpmCheck')
29 | }
30 | 
31 | tasks.named('assemble') {
32 |     dependsOn tasks.named('pnpmBuild')
33 | }
34 | 


--------------------------------------------------------------------------------
/src/main/java/cn/lyn4ever/export2md/service/PostService.java:
--------------------------------------------------------------------------------
 1 | package cn.lyn4ever.export2md.service;
 2 | 
 3 | import cn.lyn4ever.export2md.halo.ContentWrapper;
 4 | import cn.lyn4ever.export2md.halo.PostRequest;
 5 | import org.springframework.lang.NonNull;
 6 | import reactor.core.publisher.Mono;
 7 | import run.halo.app.core.extension.content.Post;
 8 | import java.io.File;
 9 | 
10 | public interface PostService  {
11 |     Mono<Post> draftPost(PostRequest postRequest);
12 | 
13 |     Mono<Post> updatePost(PostRequest postRequest);
14 | 
15 |     Mono<Post> updateBy(@NonNull Post post);
16 | 
17 |     Mono<ContentWrapper> getHeadContent(String postName);
18 | 
19 |     Mono<ContentWrapper> getHeadContent(Post post);
20 | 
21 |     Mono<ContentWrapper> getReleaseContent(String postName);
22 | 
23 |     Mono<ContentWrapper> getReleaseContent(Post post);
24 | 
25 |     Mono<Post> publish(Post post);
26 | 
27 |     Mono<Post> unpublish(Post post);
28 | 
29 |     Mono<Post> getByUsername(String postName, String username);
30 | 
31 |     PostRequest formatPost(File file);
32 | }
33 | 


--------------------------------------------------------------------------------
/ui/eslint.config.ts:
--------------------------------------------------------------------------------
 1 | import { globalIgnores } from 'eslint/config'
 2 | import { defineConfigWithVueTs, vueTsConfigs } from '@vue/eslint-config-typescript'
 3 | import pluginVue from 'eslint-plugin-vue'
 4 | import pluginVitest from '@vitest/eslint-plugin'
 5 | import pluginOxlint from 'eslint-plugin-oxlint'
 6 | import skipFormatting from '@vue/eslint-config-prettier/skip-formatting'
 7 | 
 8 | // To allow more languages other than `ts` in `.vue` files, uncomment the following lines:
 9 | // import { configureVueProject } from '@vue/eslint-config-typescript'
10 | // configureVueProject({ scriptLangs: ['ts', 'tsx'] })
11 | // More info at https://github.com/vuejs/eslint-config-typescript/#advanced-setup
12 | 
13 | export default defineConfigWithVueTs(
14 |   {
15 |     name: 'app/files-to-lint',
16 |     files: ['**/*.{ts,mts,tsx,vue}'],
17 |   },
18 | 
19 |   globalIgnores(['**/dist/**', '**/dist-ssr/**', '**/coverage/**']),
20 | 
21 |   pluginVue.configs['flat/essential'],
22 |   vueTsConfigs.recommended,
23 |   
24 |   {
25 |     ...pluginVitest.configs.recommended,
26 |     files: ['src/**/__tests__/*'],
27 |   },
28 |   ...pluginOxlint.configs['flat/recommended'],
29 |   skipFormatting,
30 | )
31 | 


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
 1 | ### Maven
 2 | target/
 3 | logs/
 4 | !.mvn/wrapper/maven-wrapper.jar
 5 | 
 6 | ### Gradle
 7 | .gradle
 8 | /build/
 9 | /out/
10 | !gradle/wrapper/gradle-wrapper.jar
11 | bin/
12 | 
13 | ### Node
14 | node_modules/
15 | 
16 | ### STS
17 | .apt_generated
18 | .classpath
19 | .factorypath
20 | .project
21 | .settings
22 | .springBeans
23 | .sts4-cache
24 | 
25 | ### IntelliJ IDEA
26 | .idea
27 | *.iws
28 | *.iml
29 | *.ipr
30 | log/
31 | 
32 | ### NetBeans
33 | nbproject/private/
34 | build/
35 | nbbuild/
36 | dist/
37 | nbdist/
38 | .nb-gradle/
39 | 
40 | ### Mac
41 | .DS_Store
42 | */.DS_Store
43 | 
44 | ### VSCode
45 | *.project
46 | *.factorypath
47 | .vscode
48 | !.vscode/extensions.json
49 | 
50 | ### Compiled class file
51 | *.class
52 | 
53 | ### Log file
54 | logs
55 | *.log
56 | npm-debug.log*
57 | yarn-debug.log*
58 | yarn-error.log*
59 | pnpm-debug.log*
60 | lerna-debug.log*
61 | 
62 | ### BlueJ files
63 | *.ctxt
64 | 
65 | ### Package Files
66 | *.war
67 | *.nar
68 | *.ear
69 | *.zip
70 | *.tar.gz
71 | *.rar
72 | 
73 | ### Local file
74 | application-local.yml
75 | application-local.yaml
76 | application-local.properties
77 | 
78 | /ui/build/
79 | /workplace/
80 | /src/main/resources/console/
81 | 


--------------------------------------------------------------------------------
/src/main/resources/extensions/roleTemplate.yaml:
--------------------------------------------------------------------------------
 1 | apiVersion: v1alpha1
 2 | kind: Role
 3 | metadata:
 4 |   name: role-template-export2doc-view
 5 |   labels:
 6 |     halo.run/role-template: "true"
 7 |   annotations:
 8 |     rbac.authorization.halo.run/module: "文章导入导出"
 9 |     rbac.authorization.halo.run/display-name: "文章导入导出查看"
10 |     rbac.authorization.halo.run/ui-permissions: |
11 |       ["plugin:export2doc:view"]
12 | rules:
13 |   - apiGroups: [ "cn.lyn4ever.export2doc" ]
14 |     resources: [ "exportLogs"]
15 |     verbs: [ "list" ]
16 | ---
17 | apiVersion: v1alpha1
18 | kind: Role
19 | metadata:
20 |   name: role-template-export2doc-manage
21 |   labels:
22 |     halo.run/role-template: "true"
23 |   annotations:
24 |     rbac.authorization.halo.run/module: "文章导入导出"
25 |     rbac.authorization.halo.run/display-name: "文章导入导出管理"
26 |     rbac.authorization.halo.run/ui-permissions: |
27 |       ["plugin:export2doc:manage"]
28 |     rbac.authorization.halo.run/dependencies: |
29 |       ["role-template-export2doc-view"]
30 | rules:
31 |   - apiGroups: [ "api.plugin.halo.run" ]
32 |     resources: [ "plugins/doImport/**","plugins/doExport/**"]
33 |     resourceNames: [ "export2doc" ]
34 |     verbs: [ "create", "get"]


--------------------------------------------------------------------------------
/src/main/java/cn/lyn4ever/export2md/schema/ImportLogSchema.java:
--------------------------------------------------------------------------------
 1 | package cn.lyn4ever.export2md.schema;
 2 | 
 3 | import io.swagger.v3.oas.annotations.media.Schema;
 4 | import lombok.Data;
 5 | import lombok.EqualsAndHashCode;
 6 | import lombok.ToString;
 7 | import run.halo.app.extension.AbstractExtension;
 8 | import run.halo.app.extension.GVK;
 9 | 
10 | import java.time.LocalDateTime;
11 | import java.util.Date;
12 | 
13 | /**
14 |  * @author Lyn4ever29
15 |  * @url <a href="https://jhacker.cn">...</a>
16 |  * @date 2023/11/1
17 |  */
18 | @Data
19 | @ToString
20 | @EqualsAndHashCode(callSuper = true)
21 | @GVK(kind = "ImportLog", group = "cn.lyn4ever.export2doc",
22 |     version = "v1alpha1", singular = "importLog", plural = "importLogs")
23 | public class ImportLogSchema extends AbstractExtension {
24 |     @Schema
25 |     private String name = LocalDateTime.now().toString();
26 |     @Schema
27 |     private Date createTime = new Date();
28 |     @Schema
29 |     private Long costSeconds;
30 |     @Schema
31 |     private String title;
32 |     /**
33 |      * 文章name
34 |      */
35 |     @Schema
36 |     private String postName;
37 | 
38 |     /**
39 |      * 状态
40 |      * a-失败
41 |      * b-导出中
42 |      * c-成功
43 |      */
44 |     @Schema
45 |     private String status;
46 | }
47 | 


--------------------------------------------------------------------------------
/src/main/java/cn/lyn4ever/export2md/util/FileUtil.java:
--------------------------------------------------------------------------------
 1 | package cn.lyn4ever.export2md.util;
 2 | 
 3 | import cn.hutool.core.io.file.FileNameUtil;
 4 | 
 5 | import java.nio.file.Path;
 6 | import java.nio.file.Paths;
 7 | 
 8 | /**
 9 |  * @author Lyn4ever29
10 |  * @url https://jhacker.cn
11 |  * @date 2023/11/11
12 |  */
13 | public class FileUtil {
14 |     private static final String  ROOT_PATH="/.halo2/plugins/export2doc_files";
15 |     public enum DirPath{
16 |         EXPORT,
17 |         IMPORT;
18 |     }
19 | 
20 | 
21 |     /**
22 |      * 判断文件名是否合法
23 |      *
24 |      * @param name
25 |      * @return
26 |      */
27 |     public static boolean isCorrectName(String name) {
28 |         if (name == null || name.length() > 255) {
29 |             return false;
30 |         }
31 |         //不能包含 /\:*?"<>|
32 |         return !FileNameUtil.containsInvalid(name);
33 |     }
34 | 
35 | 
36 |     /**
37 |      * 获取导出文件的路径
38 |      *
39 |      * @return
40 |      */
41 |     public static Path getDocFile(DirPath dirPath) {
42 |         String userHome = System.getProperty("user.home");
43 |         Path path = Paths.get(userHome, ROOT_PATH).resolve(dirPath.name().toLowerCase());
44 |         if (!path.toFile().exists()) {
45 |             path.toFile().mkdirs();
46 |         }
47 |         return path;
48 |     }
49 | }
50 | 


--------------------------------------------------------------------------------
/ui/src/views/ImportArtical.vue:
--------------------------------------------------------------------------------
 1 | <script setup lang="ts">
 2 | import { Toast, VAlert, VButton } from "@halo-dev/components";
 3 | import { ref } from "vue";
 4 | 
 5 | const onProcessCompleted = () => {
 6 |   Toast.success("成功导入待发布文章列表，请自行发布");
 7 | };
 8 | const showUploader = ref(false);
 9 | </script>
10 | 
11 | <template>
12 |   <div class="px-4 py-3">
13 |     <VAlert title="导入提示" :closable="false">
14 |       <template #description>
15 |         <ul>
16 |           <li>1.仅支持导入.md文件</li>
17 |           <li>
18 |             2.导入后的文章将处于
19 |             <span style="color: red">待发布状态</span>，请核对后自行发布
20 |           </li>
21 |           <li>3.默认的Markdown解析器是flexmark-java，参考资料如下：</li>
22 |           <li>
23 |             <a href="https://github.com/vsch/flexmark-java"
24 |               >https://github.com/vsch/flexmark-java</a
25 |             >
26 |           </li>
27 |         </ul>
28 |       </template>
29 |       <template v-if="!showUploader" #actions>
30 |         <VButton
31 |           v-permission="['plugin:export2doc:manage']"
32 |           @click="showUploader = true"
33 |         >
34 |           开始导入
35 |         </VButton>
36 |       </template>
37 |     </VAlert>
38 |   </div>
39 |   <div v-if="showUploader" class="px-4 pb-3">
40 |     <UppyUpload
41 |       :restrictions="{
42 |         allowedFileTypes: ['.md'],
43 |       }"
44 |       note="仅支持.md文件，可批量上传"
45 |       endpoint="/apis/api.plugin.halo.run/v1alpha1/plugins/export2doc/doImport/import"
46 |       width="100%"
47 |       @uploaded="onProcessCompleted"
48 |     />
49 |   </div>
50 | </template>
51 | 


--------------------------------------------------------------------------------
/src/main/java/cn/lyn4ever/export2md/HaloPluginExport2docPlugin.java:
--------------------------------------------------------------------------------
 1 | package cn.lyn4ever.export2md;
 2 | 
 3 | import cn.lyn4ever.export2md.schema.ExportLogSchema;
 4 | import cn.lyn4ever.export2md.schema.ImportLogSchema;
 5 | import org.pf4j.PluginManager;
 6 | import run.halo.app.plugin.PluginContext;
 7 | import org.springframework.stereotype.Component;
 8 | import run.halo.app.extension.SchemeManager;
 9 | import run.halo.app.plugin.BasePlugin;
10 | 
11 | /**
12 |  * @author Lyn4ever29
13 |  * @url https://jhacker.cn
14 |  * @date 2023/11/1
15 |  */
16 | @Component
17 | public class HaloPluginExport2docPlugin extends BasePlugin {
18 |     private final SchemeManager schemeManager;
19 |     
20 |     public HaloPluginExport2docPlugin(PluginContext context, SchemeManager schemeManager) {
21 |         super(context);
22 |         this.schemeManager = schemeManager;
23 |     }
24 | 
25 |     /**
26 |      * This method is called by the application when the plugin is started.
27 |      * See {@link PluginManager#startPlugin(String)}.
28 |      */
29 |     @Override
30 |     public void start() {
31 |         // 插件启动时注册自定义模型
32 |         schemeManager.register(ExportLogSchema.class);
33 |         schemeManager.register(ImportLogSchema.class);
34 |     }
35 | 
36 |     @Override
37 |     public void stop() {
38 |         // 插件停用时取消注册自定义模型
39 |         schemeManager.unregister(schemeManager.get(ExportLogSchema.class));
40 |         schemeManager.unregister(schemeManager.get(ImportLogSchema.class));
41 | 
42 |     }
43 | 
44 |     /**
45 |      * This method is called by the application when the plugin is deleted.
46 |      * See {@link PluginManager#deletePlugin(String)}.
47 |      */
48 |     @Override
49 |     public void delete() {
50 |         super.delete();
51 |     }
52 | }


--------------------------------------------------------------------------------
/src/main/java/cn/lyn4ever/export2md/schema/ExportLogSchema.java:
--------------------------------------------------------------------------------
 1 | package cn.lyn4ever.export2md.schema;
 2 | 
 3 | import io.swagger.v3.oas.annotations.media.Schema;
 4 | import java.time.LocalDateTime;
 5 | import java.util.Date;
 6 | import lombok.Data;
 7 | import lombok.EqualsAndHashCode;
 8 | import lombok.ToString;
 9 | import run.halo.app.extension.AbstractExtension;
10 | import run.halo.app.extension.GVK;
11 | 
12 | /**
13 |  * @author Lyn4ever29
14 |  * @url <a href="https://jhacker.cn">...</a>
15 |  * @date 2023/11/1
16 |  */
17 | @Data
18 | @ToString
19 | @EqualsAndHashCode(callSuper = true)
20 | @GVK(kind = "ExportLog", group = "cn.lyn4ever.export2doc",
21 |     version = "v1alpha1", singular = "exportLog", plural = "exportLogs")
22 | public class ExportLogSchema extends AbstractExtension {
23 |     @Schema
24 |     private String name = LocalDateTime.now().toString();
25 |     @Schema
26 |     private Date createTime = new Date();
27 |     @Schema
28 |     private Long costSeconds;
29 |     @Schema
30 |     private String tag;
31 |     @Schema
32 |     private String category;
33 | 
34 |     @Schema
35 |     private String beginTime;
36 | 
37 |     @Schema
38 |     private String endTime;
39 | 
40 |     @Schema(defaultValue = "true")
41 |     private Boolean remainMetaData;
42 | 
43 |     @Schema(defaultValue = "true")
44 |     private Boolean remainCategory;
45 | 
46 |     /**
47 |      * 状态
48 |      * a-失败
49 |      * b-导出中
50 |      * c-成功
51 |      */
52 |     @Schema
53 |     private String status;
54 | 
55 |     // @Schema(requiredMode = REQUIRED)
56 |     // private ExportConfigSchema.TodoSpec spec;
57 |     //
58 |     // @Data
59 |     // public static class TodoSpec {
60 |     //
61 |     //     @Schema(requiredMode = REQUIRED, minLength = 1)
62 |     //     private String title;
63 |     //
64 |     //     @Schema(defaultValue = "false")
65 |     //     private Boolean done;
66 |     // }
67 | }
68 | 


--------------------------------------------------------------------------------
/src/main/java/cn/lyn4ever/export2md/halo/ContentWrapper.java:
--------------------------------------------------------------------------------
 1 | package cn.lyn4ever.export2md.halo;
 2 | 
 3 | import cn.lyn4ever.export2md.util.PatchUtils;
 4 | import lombok.Builder;
 5 | import lombok.Data;
 6 | import org.apache.commons.lang3.StringUtils;
 7 | import org.springframework.util.Assert;
 8 | import run.halo.app.core.extension.content.Snapshot;
 9 | 
10 | /**
11 |  * @author guqing
12 |  * @since 2.0.0
13 |  */
14 | @Data
15 | @Builder
16 | public class ContentWrapper {
17 |     private String snapshotName;
18 |     private String raw;
19 |     private String content;
20 |     private String rawType;
21 | 
22 |     public static ContentWrapper patchSnapshot(Snapshot patchSnapshot, Snapshot baseSnapshot) {
23 |         Assert.notNull(baseSnapshot, "The baseSnapshot must not be null.");
24 |         String baseSnapshotName = baseSnapshot.getMetadata().getName();
25 |         if (StringUtils.equals(patchSnapshot.getMetadata().getName(), baseSnapshotName)) {
26 |             return ContentWrapper.builder()
27 |                 .snapshotName(patchSnapshot.getMetadata().getName())
28 |                 .raw(patchSnapshot.getSpec().getRawPatch())
29 |                 .content(patchSnapshot.getSpec().getContentPatch())
30 |                 .rawType(patchSnapshot.getSpec().getRawType())
31 |                 .build();
32 |         }
33 |         String patchedContent = PatchUtils.applyPatch(baseSnapshot.getSpec().getContentPatch(),
34 |             patchSnapshot.getSpec().getContentPatch());
35 |         String patchedRaw = PatchUtils.applyPatch(baseSnapshot.getSpec().getRawPatch(),
36 |             patchSnapshot.getSpec().getRawPatch());
37 |         return ContentWrapper.builder()
38 |             .snapshotName(patchSnapshot.getMetadata().getName())
39 |             .raw(patchedRaw)
40 |             .content(patchedContent)
41 |             .rawType(patchSnapshot.getSpec().getRawType())
42 |             .build();
43 |     }
44 | }
45 | 


--------------------------------------------------------------------------------
/ui/package.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "type": "module",
 3 |   "scripts": {
 4 |     "build": "run-p type-check \"build-only {@}\" --",
 5 |     "build-only": "vite build",
 6 |     "dev": "vite build --watch --mode=development",
 7 |     "lint:oxlint": "oxlint . --fix -D correctness --ignore-path .gitignore",
 8 |     "lint:eslint": "eslint . --fix",
 9 |     "lint": "run-s lint:*",
10 |     "prettier": "prettier --write src/",
11 |     "test:unit": "vitest --passWithNoTests",
12 |     "type-check": "vue-tsc --build"
13 |   },
14 |   "prettier": {
15 |     "printWidth": 100,
16 |     "semi": false,
17 |     "singleQuote": true,
18 |     "tabWidth": 2
19 |   },
20 |   "dependencies": {
21 |     "@halo-dev/api-client": "^2.21.1",
22 |     "@halo-dev/components": "^2.21.0",
23 |     "@halo-dev/console-shared": "^2.21.0",
24 |     "@tanstack/vue-query": "^4.29.1",
25 |     "@vueuse/router": "^10.7.1",
26 |     "axios": "^1.7.2",
27 |     "canvas-confetti": "^1.9.3",
28 |     "turndown": "^7.2.1",
29 |     "vue": "^3.5.17"
30 |   },
31 |   "devDependencies": {
32 |     "@halo-dev/ui-plugin-bundler-kit": "^2.21.2",
33 |     "@iconify/json": "^2.2.350",
34 |     "@tsconfig/node20": "^20.1.6",
35 |     "@types/canvas-confetti": "^1.9.0",
36 |     "@types/jsdom": "^21.1.7",
37 |     "@types/node": "^20.19.1",
38 |     "@vitest/eslint-plugin": "^1.2.7",
39 |     "@vue/eslint-config-prettier": "^10.2.0",
40 |     "@vue/eslint-config-typescript": "^14.5.1",
41 |     "@vue/test-utils": "^2.4.6",
42 |     "@vue/tsconfig": "^0.7.0",
43 |     "eslint": "^9.29.0",
44 |     "eslint-plugin-oxlint": "^0.16.12",
45 |     "eslint-plugin-vue": "~10.0.1",
46 |     "jsdom": "^26.1.0",
47 |     "npm-run-all2": "^7.0.2",
48 |     "oxlint": "^0.16.12",
49 |     "prettier": "^3.6.0",
50 |     "sass": "^1.89.2",
51 |     "typescript": "~5.8.3",
52 |     "unplugin-icons": "^22.1.0",
53 |     "vite": "^5.3.2",
54 |     "vitest": "^3.2.4",
55 |     "vue-tsc": "^2.2.10"
56 |   },
57 |   "packageManager": "pnpm@9.15.9"
58 | }


--------------------------------------------------------------------------------
/ui/src/index.ts:
--------------------------------------------------------------------------------
 1 | import {definePlugin, type OperationItem} from "@halo-dev/console-shared";
 2 | import HomeView from "./views/HomeView.vue";
 3 | import {IconArrowUpDownLine, VDropdownItem} from "@halo-dev/components";
 4 | import {markRaw, type Ref} from "vue";
 5 | import type {ListedPost} from "@halo-dev/api-client";
 6 | 
 7 | // @ts-ignore
 8 | export default definePlugin({
 9 |     components: {},
10 |     routes: [
11 |         {
12 |             parentName: "ToolsRoot",
13 |             route: {
14 |                 path: "export2doc",
15 |                 name: "export2doc",
16 |                 component: HomeView,
17 |                 meta: {
18 |                     title: "文章导入导出",
19 |                     searchable: true,
20 |                     description: "导出文章为 Markdown、HTML 文件，同时支持导入 Markdown 文件",
21 |                     permissions: ["plugin:export2doc:view"],
22 |                     menu: {
23 |                         name: "文章导入导出",
24 |                         group: "tool",
25 |                         icon: markRaw(IconArrowUpDownLine),
26 |                         priority: 0,
27 |                     },
28 |                 },
29 |             },
30 |         },
31 |     ],
32 |     extensionPoints: {
33 |         "post:list-item:operation:create": ():OperationItem<ListedPost>[] => {
34 |             return [
35 |                 {
36 |                     priority: 21,
37 |                     component: markRaw(VDropdownItem),
38 |                     label: "导出",
39 |                     permissions: [],
40 |                     action: (item: ListedPost | undefined):void => {
41 |                       if (item != undefined) {
42 |                         window.location.href = '/apis/api.plugin.halo.run/v1alpha1/plugins/export2doc/doExport/export_one/' + item.post.metadata.name;
43 |                       }
44 |                     },
45 |                     hidden: false,
46 |                     children: [],
47 |                 },
48 |             ];
49 |         }
50 |     }
51 | });
52 | 


--------------------------------------------------------------------------------
/ui/src/components/entity/EntityDropdownItems.vue:
--------------------------------------------------------------------------------
 1 | <script setup lang="ts" generic="T">
 2 | import type { OperationItem } from "@halo-dev/console-shared";
 3 | import { VDropdown } from "@halo-dev/components";
 4 | 
 5 | const props = withDefaults(
 6 |   defineProps<{
 7 |     dropdownItems: OperationItem<T>[];
 8 |     item?: T;
 9 |   }>(),
10 |   {
11 |     item: undefined,
12 |   }
13 | );
14 | 
15 | function action(dropdownItem: OperationItem<T>) {
16 |   if (!dropdownItem.action) {
17 |     return;
18 |   }
19 |   dropdownItem.action(props.item);
20 | }
21 | </script>
22 | 
23 | <template>
24 |   <template v-for="(dropdownItem, index) in dropdownItems">
25 |     <template v-if="!dropdownItem.hidden">
26 |       <VDropdown
27 |         v-if="dropdownItem.children?.length"
28 |         :key="`dropdown-children-items-${index}`"
29 |         :triggers="['click']"
30 |       >
31 |         <component
32 |           :is="dropdownItem.component"
33 |           v-bind="dropdownItem.props"
34 |           @click="action(dropdownItem)"
35 |         >
36 |           {{ dropdownItem.label }}
37 |         </component>
38 |         <template #popper>
39 |           <template v-for="(childItem, childIndex) in dropdownItem.children">
40 |             <component
41 |               :is="childItem.component"
42 |               v-if="!childItem.hidden"
43 |               v-bind="childItem.props"
44 |               :key="`dropdown-child-item-${childIndex}`"
45 |               @click="action(childItem)"
46 |             >
47 |               {{ childItem.label }}
48 |             </component>
49 |           </template>
50 |         </template>
51 |       </VDropdown>
52 |       <component
53 |         :is="dropdownItem.component"
54 |         v-else
55 |         v-bind="dropdownItem.props"
56 |         :key="`dropdown-item-${index}`"
57 |         v-permission="['plugin:export2doc:manage']"
58 |         @click="action(dropdownItem)"
59 |       >
60 |         {{ dropdownItem.label }}
61 |       </component>
62 |     </template>
63 |   </template>
64 | </template>
65 | 


--------------------------------------------------------------------------------
/src/main/java/cn/lyn4ever/export2md/halo/ContentRequest.java:
--------------------------------------------------------------------------------
 1 | package cn.lyn4ever.export2md.halo;
 2 | 
 3 | import static io.swagger.v3.oas.annotations.media.Schema.RequiredMode.REQUIRED;
 4 | 
 5 | import cn.lyn4ever.export2md.util.PatchUtils;
 6 | import io.swagger.v3.oas.annotations.media.Schema;
 7 | import java.util.HashMap;
 8 | import org.apache.commons.lang3.StringUtils;
 9 | import run.halo.app.core.extension.content.Snapshot;
10 | import run.halo.app.extension.Metadata;
11 | import run.halo.app.extension.Ref;
12 | 
13 | /**
14 |  * @copy
15 |  * @author guqing
16 |  * @since 2.0.0
17 |  */
18 | public record ContentRequest(@Schema(requiredMode = REQUIRED) Ref subjectRef,
19 |                              String headSnapshotName,
20 |                              @Schema(requiredMode = REQUIRED) String raw,
21 |                              @Schema(requiredMode = REQUIRED) String content,
22 |                              @Schema(requiredMode = REQUIRED) String rawType) {
23 | 
24 |     public Snapshot toSnapshot() {
25 |         final Snapshot snapshot = new Snapshot();
26 | 
27 |         Metadata metadata = new Metadata();
28 |         metadata.setAnnotations(new HashMap<>());
29 |         snapshot.setMetadata(metadata);
30 | 
31 |         Snapshot.SnapShotSpec snapShotSpec = new Snapshot.SnapShotSpec();
32 |         snapShotSpec.setSubjectRef(subjectRef);
33 | 
34 |         snapShotSpec.setRawType(rawType);
35 |         snapShotSpec.setRawPatch(StringUtils.defaultString(raw()));
36 |         snapShotSpec.setContentPatch(StringUtils.defaultString(content()));
37 | 
38 |         snapshot.setSpec(snapShotSpec);
39 |         return snapshot;
40 |     }
41 | 
42 |     public String rawPatchFrom(String originalRaw) {
43 |         // originalRaw content from v1
44 |         return PatchUtils.diffToJsonPatch(originalRaw, this.raw);
45 |     }
46 | 
47 |     public String contentPatchFrom(String originalContent) {
48 |         // originalContent from v1
49 |         return PatchUtils.diffToJsonPatch(originalContent, this.content);
50 |     }
51 | }
52 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | Halo 2.0 插件——文章导入导出插件
 2 | 
 3 | ## 功能说明
 4 | - 快速导出文章为markdown或者html文件
 5 | - 导出后打包下载
 6 | - 提供文章导入功能，支持导入markdown文件
 7 | 
 8 | ## 预览
 9 | - 文章列表导出功能
10 | 
11 | ![https://github.com/Lyn4ever29/halo-plugin-export-md/assets/25952589/dd247afe-76f0-402f-9f3c-68b265d7b8ab](https://github.com/Lyn4ever29/halo-plugin-export-md/assets/25952589/dd247afe-76f0-402f-9f3c-68b265d7b8ab)
12 | 
13 | - 导出列表
14 | 
15 | ![导出列表](https://github.com/Lyn4ever29/halo-plugin-export-md/assets/25952589/2404ae3c-582b-4f5e-b9b6-96f7b029af69)
16 | 
17 | 
18 | ## 安装
19 | - 下载[Release](https://github.com/Lyn4ever29/halo-plugin-export-md/releases)版本，直接安装即可
20 | - 在Halo应用市场，支持一键安装[文章导入导出](https://www.halo.run/store/apps/app-vWbpZ)
21 | 
22 | 
23 | ## 更新日志
24 | - v1.2.5
25 |   - 适配Halo2.21版本，感谢[Zhangfen21082](https://github.com/Zhangfen21082)网友的修复
26 |   - 修改markdown4j库为[flexmark-java](https://github.com/vsch/flexmark-java)
27 |   - 修改插件编写方式为最新版本，将console目录同步修改为ui目录
28 | - v1.2.4 
29 |   - 将导入导出页面的入口放置在工具菜单项下作为子菜单项（2.12版本的特性）。
30 |   - 需要注意，此改动需要 2.12 的支持
31 | - v1.2.3 优化导入导出的 UI。（来自[ruibaby](https://github.com/ruibaby)的PR）
32 |   - 支持显示空状态，引导用户导出文章。
33 |   - 支持导出/删除记录之后自动更新列表数据，不再需要手动刷新页面。
34 |   - 使用 Halo 在全局注册的 Uppy 组件，减少构建产物体积。（已同步修改 plugin.yaml 的 requires 为 2.11）
35 |   - 使用 Halo 官方新提供的 @halo-dev/ui-plugin-bundler-kit 用于构建插件。
36 |   - 移除部分无用样式和注释。
37 | - v1.2.2
38 |   - 导出文章时，添加封面图字段
39 |   - 添加权限控制，感谢[chengzhongxue](https://github.com/chengzhongxue)的PR
40 | - v1.2.1
41 |   - 修复halo2.11版本升级后，导入功能失效的问题（由于Halo修改了文章发布机制，导致导入失效，已更新至最新代码）。
42 |   - 如果是halo2.10版本，请使用**v1.1.4**
43 | - v1.2.0
44 |   - 更改导出文章压缩包目录为halo2工作目录
45 |   - 修改有关草稿箱的说明，导入后的文章处于待发布状态，需要用户自行发布
46 | - v1.1.4 在文章列表添加导出快捷方式，可以导出单文件。
47 | - v1.1.0 
48 |   - 支持导入Markdown文件
49 |   - 导出的Mardkdown文件支持属性，属性示例如下：
50 |   
51 |   ```yaml
52 |   ---
53 |   title: 试试Nacos作注册中心和配置中心，爱不释手的感觉
54 |   date: 2023-04-22 20:28:05
55 |   auther: lyn4ever
56 |   excerpt: 在使用SpringCloud做分布式微服务架构时，注册中心是必不可少的一个组件。
57 |   permalink: /2022/166359134426
58 |   categories:
59 |     - java
60 |     - springcloud
61 |   tags:
62 |     - springcloud
63 |     - nacos
64 |     - 注册中心
65 |   ---
66 |   ```
67 | - v1.0.0
68 |   - 简单导出功能
69 | 
70 | 


--------------------------------------------------------------------------------
/ui/src/views/HomeView.vue:
--------------------------------------------------------------------------------
 1 | <script setup lang="ts">
 2 | import { nextTick, ref, shallowRef } from "vue";
 3 | import ImportArtical from "@/views/ImportArtical.vue";
 4 | import ExportArtical from "@/views/ExportArtical.vue";
 5 | import { useRouteQuery } from "@vueuse/router";
 6 | 
 7 | import {
 8 |   IconArrowDownCircleLine,
 9 |   IconArrowUpCircleLine,
10 |   IconArrowUpDownLine,
11 |   VButton,
12 |   VCard,
13 |   VPageHeader,
14 |   VSpace,
15 |   VTabbar,
16 | } from "@halo-dev/components";
17 | 
18 | const tabs = shallowRef([
19 |   {
20 |     id: "export2doc",
21 |     label: "导出文章",
22 |   },
23 |   {
24 |     id: "import4doc",
25 |     label: "导入文章",
26 |   },
27 | ]);
28 | 
29 | const activeIndex = useRouteQuery<string>("tab", tabs.value[0].id);
30 | 
31 | const export2doc = ref();
32 | const import4doc = ref();
33 | 
34 | //新增导出
35 | const handleCreate = () => {
36 |   activeIndex.value = "export2doc";
37 |   nextTick(() => {
38 |     export2doc.value.confirmExport();
39 |   });
40 | };
41 | </script>
42 | 
43 | <template>
44 |   <VPageHeader title="文章导入导出">
45 |     <template #icon>
46 |       <IconArrowUpDownLine class="mr-2 self-center" />
47 |     </template>
48 |     <template #actions>
49 |       <VSpace v-permission="['plugin:export2doc:manage']">
50 |         <VButton
51 |           type="default"
52 |           size="sm"
53 |           :route="{ name: 'export2doc', query: { tab: 'import4doc' } }"
54 |         >
55 |           <template #icon>
56 |             <IconArrowUpCircleLine class="h-full w-full" />
57 |           </template>
58 |           导入文章
59 |         </VButton>
60 |         <VButton type="secondary" @click="handleCreate">
61 |           <template #icon>
62 |             <IconArrowDownCircleLine class="h-full w-full" />
63 |           </template>
64 |           导出文章
65 |         </VButton>
66 |       </VSpace>
67 |     </template>
68 |   </VPageHeader>
69 | 
70 |   <div class="m-0 md:m-4">
71 |     <VCard :body-class="['!p-0']">
72 |       <template #header>
73 |         <VTabbar
74 |           v-model:active-id="activeIndex"
75 |           :items="tabs.map((item) => ({ id: item.id, label: item.label }))"
76 |           class="w-full !rounded-none"
77 |           type="outline"
78 |         ></VTabbar>
79 |       </template>
80 |       <div class="bg-white">
81 |         <ImportArtical v-if="activeIndex == 'import4doc'" ref="import4doc" />
82 |         <ExportArtical v-if="activeIndex == 'export2doc'" ref="export2doc" />
83 |       </div>
84 |     </VCard>
85 |   </div>
86 | </template>
87 | 


--------------------------------------------------------------------------------
/gradlew.bat:
--------------------------------------------------------------------------------
 1 | @rem
 2 | @rem Copyright 2015 the original author or authors.
 3 | @rem
 4 | @rem Licensed under the Apache License, Version 2.0 (the "License");
 5 | @rem you may not use this file except in compliance with the License.
 6 | @rem You may obtain a copy of the License at
 7 | @rem
 8 | @rem      https://www.apache.org/licenses/LICENSE-2.0
 9 | @rem
10 | @rem Unless required by applicable law or agreed to in writing, software
11 | @rem distributed under the License is distributed on an "AS IS" BASIS,
12 | @rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | @rem See the License for the specific language governing permissions and
14 | @rem limitations under the License.
15 | @rem
16 | 
17 | @if "%DEBUG%"=="" @echo off
18 | @rem ##########################################################################
19 | @rem
20 | @rem  Gradle startup script for Windows
21 | @rem
22 | @rem ##########################################################################
23 | 
24 | @rem Set local scope for the variables with windows NT shell
25 | if "%OS%"=="Windows_NT" setlocal
26 | 
27 | set DIRNAME=%~dp0
28 | if "%DIRNAME%"=="" set DIRNAME=.
29 | @rem This is normally unused
30 | set APP_BASE_NAME=%~n0
31 | set APP_HOME=%DIRNAME%
32 | 
33 | @rem Resolve any "." and ".." in APP_HOME to make it shorter.
34 | for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi
35 | 
36 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
37 | set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m"
38 | 
39 | @rem Find java.exe
40 | if defined JAVA_HOME goto findJavaFromJavaHome
41 | 
42 | set JAVA_EXE=java.exe
43 | %JAVA_EXE% -version >NUL 2>&1
44 | if %ERRORLEVEL% equ 0 goto execute
45 | 
46 | echo.
47 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
48 | echo.
49 | echo Please set the JAVA_HOME variable in your environment to match the
50 | echo location of your Java installation.
51 | 
52 | goto fail
53 | 
54 | :findJavaFromJavaHome
55 | set JAVA_HOME=%JAVA_HOME:"=%
56 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe
57 | 
58 | if exist "%JAVA_EXE%" goto execute
59 | 
60 | echo.
61 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
62 | echo.
63 | echo Please set the JAVA_HOME variable in your environment to match the
64 | echo location of your Java installation.
65 | 
66 | goto fail
67 | 
68 | :execute
69 | @rem Setup the command line
70 | 
71 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
72 | 
73 | 
74 | @rem Execute Gradle
75 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %*
76 | 
77 | :end
78 | @rem End local scope for the variables with windows NT shell
79 | if %ERRORLEVEL% equ 0 goto mainEnd
80 | 
81 | :fail
82 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
83 | rem the _cmd.exe /c_ return code!
84 | set EXIT_CODE=%ERRORLEVEL%
85 | if %EXIT_CODE% equ 0 set EXIT_CODE=1
86 | if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE%
87 | exit /b %EXIT_CODE%
88 | 
89 | :mainEnd
90 | if "%OS%"=="Windows_NT" endlocal
91 | 
92 | :omega
93 | 


--------------------------------------------------------------------------------
/src/main/java/cn/lyn4ever/export2md/util/PatchUtils.java:
--------------------------------------------------------------------------------
 1 | package cn.lyn4ever.export2md.util;
 2 | 
 3 | import com.fasterxml.jackson.core.type.TypeReference;
 4 | import com.github.difflib.DiffUtils;
 5 | import com.github.difflib.patch.*;
 6 | import com.google.common.base.Splitter;
 7 | import lombok.Data;
 8 | import org.apache.commons.lang3.StringUtils;
 9 | import run.halo.app.infra.utils.JsonUtils;
10 | 
11 | import java.util.Collections;
12 | import java.util.List;
13 | 
14 | /**
15 |  * @author guqing
16 |  * @since 2.0.0
17 |  */
18 | public class PatchUtils {
19 |     private static final String DELIMITER = "\n";
20 |     private static final Splitter lineSplitter = Splitter.on(DELIMITER);
21 | 
22 |     public static Patch<String> create(String deltasJson) {
23 |         List<Delta> deltas = JsonUtils.jsonToObject(deltasJson, new TypeReference<>() {
24 |         });
25 |         Patch<String> patch = new Patch<>();
26 |         for (Delta delta : deltas) {
27 |             StringChunk sourceChunk = delta.getSource();
28 |             StringChunk targetChunk = delta.getTarget();
29 |             Chunk<String> orgChunk = new Chunk<>(sourceChunk.getPosition(), sourceChunk.getLines(),
30 |                 sourceChunk.getChangePosition());
31 |             Chunk<String> revChunk = new Chunk<>(targetChunk.getPosition(), targetChunk.getLines(),
32 |                 targetChunk.getChangePosition());
33 |             switch (delta.getType()) {
34 |                 case DELETE -> patch.addDelta(new DeleteDelta<>(orgChunk, revChunk));
35 |                 case INSERT -> patch.addDelta(new InsertDelta<>(orgChunk, revChunk));
36 |                 case CHANGE -> patch.addDelta(new ChangeDelta<>(orgChunk, revChunk));
37 |                 default -> throw new IllegalArgumentException("Unsupported delta type.");
38 |             }
39 |         }
40 |         return patch;
41 |     }
42 | 
43 |     public static String patchToJson(Patch<String> patch) {
44 |         List<AbstractDelta<String>> deltas = patch.getDeltas();
45 |         return JsonUtils.objectToJson(deltas);
46 |     }
47 | 
48 |     public static String applyPatch(String original, String patchJson) {
49 |         Patch<String> patch = PatchUtils.create(patchJson);
50 |         try {
51 |             return String.join(DELIMITER, patch.applyTo(breakLine(original)));
52 |         } catch (PatchFailedException e) {
53 |             throw new RuntimeException(e);
54 |         }
55 |     }
56 | 
57 |     public static String diffToJsonPatch(String original, String revised) {
58 |         Patch<String> patch = DiffUtils.diff(breakLine(original), breakLine(revised));
59 |         return PatchUtils.patchToJson(patch);
60 |     }
61 | 
62 |     public static List<String> breakLine(String content) {
63 |         if (StringUtils.isBlank(content)) {
64 |             return Collections.emptyList();
65 |         }
66 |         return lineSplitter.splitToList(content);
67 |     }
68 | 
69 |     @Data
70 |     public static class Delta {
71 |         private StringChunk source;
72 |         private StringChunk target;
73 |         private DeltaType type;
74 |     }
75 | 
76 |     @Data
77 |     public static class StringChunk {
78 |         private int position;
79 |         private List<String> lines;
80 |         private List<Integer> changePosition;
81 |     }
82 | }
83 | 


--------------------------------------------------------------------------------
/ui/src/views/ExportArtical.vue:
--------------------------------------------------------------------------------
  1 | <script lang="ts" setup>
  2 | import axios from "axios";
  3 | import {
  4 |   Dialog,
  5 |   Toast,
  6 |   VButton,
  7 |   VEmpty,
  8 |   VLoading,
  9 |   VSpace,
 10 | } from "@halo-dev/components";
 11 | import ExportItem from "@/views/ExportListItem.vue";
 12 | import { useQuery } from "@tanstack/vue-query";
 13 | import type { ListedExportLogList } from "../domain";
 14 | 
 15 | const http = axios.create({
 16 |   baseURL: "/",
 17 |   timeout: 1000,
 18 | });
 19 | 
 20 | const nowTime = () => {
 21 |   const now = new Date();
 22 |   const year = now.getFullYear();
 23 |   const month = String(now.getMonth() + 1).padStart(2, "0");
 24 |   const day = String(now.getDate()).padStart(2, "0");
 25 |   const hours = String(now.getHours()).padStart(2, "0");
 26 |   const minutes = String(now.getMinutes()).padStart(2, "0");
 27 |   const seconds = String(now.getSeconds()).padStart(2, "0");
 28 | 
 29 |   return year + month + day + hours + minutes + seconds;
 30 | };
 31 | 
 32 | const { data, isLoading, isFetching, refetch } = useQuery({
 33 |   queryKey: ["plugin:export2doc:exportLogs"],
 34 |   queryFn: async () => {
 35 |     const { data } = await http.get<ListedExportLogList>(
 36 |       "/apis/cn.lyn4ever.export2doc/v1alpha1/exportLogs"
 37 |     );
 38 |     return data;
 39 |   },
 40 |   refetchInterval(data) {
 41 |     const pendingData = data?.items.some(
 42 |       (item) => !!item.metadata.deletionTimestamp || item.status === "b"
 43 |     );
 44 | 
 45 |     return pendingData ? 1000 : false;
 46 |   },
 47 | });
 48 | 
 49 | const confirmExport = () => {
 50 |   Dialog.warning({
 51 |     title: "新增导出",
 52 |     description:
 53 |       "点击按钮后，后台将进行导出，请耐心等待完成，导出完成后，点击名称即可下载。",
 54 |     confirmType: "primary",
 55 |     confirmText: "确定",
 56 |     cancelText: "取消",
 57 |     onConfirm: async () => {
 58 |       try {
 59 |         await http
 60 |           .post(
 61 |             "/apis/api.plugin.halo.run/v1alpha1/plugins/export2doc/doExport/export",
 62 |             {
 63 |               name: "export2doc_" + nowTime(),
 64 |               createTime: "",
 65 |               costSeconds: "",
 66 |               tag: "",
 67 |               category: "",
 68 |               beginTime: "",
 69 |               endTime: "",
 70 |               remainMetaData: true,
 71 |               remainCategory: true,
 72 |             }
 73 |           )
 74 |           .then(() => {
 75 |             Toast.success("新增导出成功");
 76 |             refetch();
 77 |           });
 78 |       } catch (e) {
 79 |         console.error("Failed to submit exportLog", e);
 80 |       }
 81 |     },
 82 |   });
 83 | };
 84 | 
 85 | // 输出组件的方法，让外部组件可以调用
 86 | defineExpose({
 87 |   confirmExport,
 88 | });
 89 | </script>
 90 | 
 91 | <template>
 92 |   <VLoading v-if="isLoading" />
 93 | 
 94 |   <Transition v-else-if="!data?.items.length" appear name="fade">
 95 |     <VEmpty
 96 |       message="当前还没有导出记录，你可以尝试导出数据或者刷新。"
 97 |       title="暂无导出记录"
 98 |     >
 99 |       <template #actions>
100 |         <VSpace>
101 |           <VButton :loading="isFetching" @click="refetch()"> 刷新 </VButton>
102 |           <VButton type="secondary" @click="confirmExport"> 导出 </VButton>
103 |         </VSpace>
104 |       </template>
105 |     </VEmpty>
106 |   </Transition>
107 | 
108 |   <Transition v-else appear name="fade">
109 |     <ul class="box-border h-full w-full divide-y divide-gray-100" role="list">
110 |       <li v-for="item in data.items" :key="item.metadata.name">
111 |         <ExportItem :export-log="item" :show-operations="true" />
112 |       </li>
113 |     </ul>
114 |   </Transition>
115 | </template>
116 | 


--------------------------------------------------------------------------------
/src/main/java/cn/lyn4ever/export2md/rest/ImportController.java:
--------------------------------------------------------------------------------
  1 | package cn.lyn4ever.export2md.rest;
  2 | 
  3 | import cn.lyn4ever.export2md.service.ImportService;
  4 | import cn.lyn4ever.export2md.util.FileUtil;
  5 | import java.io.File;
  6 | import lombok.extern.slf4j.Slf4j;
  7 | import org.springframework.beans.factory.annotation.Autowired;
  8 | import org.springframework.http.MediaType;
  9 | import org.springframework.http.codec.multipart.FilePart;
 10 | import org.springframework.web.bind.annotation.CookieValue;
 11 | import org.springframework.web.bind.annotation.PostMapping;
 12 | import org.springframework.web.bind.annotation.RequestMapping;
 13 | import org.springframework.web.bind.annotation.RequestPart;
 14 | import org.springframework.web.bind.annotation.RestController;
 15 | import reactor.core.publisher.Flux;
 16 | import reactor.core.publisher.Mono;
 17 | import reactor.core.scheduler.Schedulers;
 18 | import run.halo.app.core.extension.content.Post;
 19 | import run.halo.app.extension.ReactiveExtensionClient;
 20 | import run.halo.app.plugin.ApiVersion;
 21 | 
 22 | /**
 23 |  * 自定义导入接口
 24 |  *
 25 |  * @author Lyn4ever29
 26 |  * @url https://jhacker.cn
 27 |  * @date 2023/11/1
 28 |  */
 29 | @ApiVersion("v1alpha1")
 30 | @RequestMapping("/doImport")
 31 | @RestController
 32 | @Slf4j
 33 | public class ImportController {
 34 | // /apis/api.plugin.halo.run/v1alpha1/plugins/export2doc/doImport/**
 35 | 
 36 | 
 37 |     @Autowired
 38 |     private ImportService importService;
 39 | 
 40 |     @Autowired
 41 |     private ReactiveExtensionClient reactiveClient;
 42 | 
 43 | 
 44 |     @PostMapping(value = "/import1", consumes = {
 45 |         MediaType.TEXT_MARKDOWN_VALUE,
 46 |         MediaType.TEXT_EVENT_STREAM_VALUE,
 47 |         "text/*",
 48 |         MediaType.APPLICATION_PROBLEM_JSON_VALUE,
 49 |         MediaType.MULTIPART_FORM_DATA_VALUE})
 50 |     @Deprecated
 51 |     public Flux<Post> importPost1(@CookieValue("XSRF-TOKEN") String token,
 52 |         @CookieValue("SESSION") String session,
 53 |         @RequestPart("file") final Flux<FilePart> filePartFlux) {
 54 | 
 55 |         //保存文件
 56 |         //保存文件
 57 | 
 58 | 
 59 |         return filePartFlux.flatMap(filePart -> {
 60 |             File file =
 61 |                 new File(FileUtil.getDocFile(FileUtil.DirPath.IMPORT).toFile().getAbsolutePath()
 62 |                     + "/" + filePart.filename());
 63 |             return filePart.transferTo(file)
 64 |                 .flatMap(f -> importService.runTask(file));
 65 |         });
 66 | 
 67 |     }
 68 | 
 69 |     @PostMapping(value = "/import", consumes = {
 70 |         MediaType.TEXT_MARKDOWN_VALUE,
 71 |         MediaType.TEXT_EVENT_STREAM_VALUE,
 72 |         "text/*",
 73 |         MediaType.APPLICATION_PROBLEM_JSON_VALUE,
 74 |         MediaType.MULTIPART_FORM_DATA_VALUE})
 75 |     public Flux<Post> importPost(@RequestPart("file") final Flux<FilePart> filePartFlux) {
 76 | 
 77 |         //保存文件
 78 |         //保存文件
 79 | 
 80 |         return filePartFlux.publishOn(Schedulers.boundedElastic()).flatMap(filePart -> {
 81 |             File file =
 82 |                 new File(FileUtil.getDocFile(FileUtil.DirPath.IMPORT).toFile().getAbsolutePath()
 83 |                     + "/" + filePart.filename());
 84 |             // importService.importPost(file,token, session);
 85 | 
 86 |             filePart.transferTo(file).block();
 87 |             return importService.runTask(file);
 88 |         });
 89 | 
 90 |     }
 91 | 
 92 | 
 93 | //        return flux.flatMap(map->{
 94 | //            List<FilePart> fileParts = map.get("file");
 95 | //            fileParts.forEach(it->{
 96 | //                new Thread(() -> {
 97 | //                    importService.runTask(it);
 98 | //                }).start();
 99 | //            });
100 | //            return null;
101 | //        }).then(Mono.just("OK"));
102 | 
103 | 
104 | }
105 | 


--------------------------------------------------------------------------------
/src/main/java/cn/lyn4ever/export2md/service/impl/ImportServiceV2.java:
--------------------------------------------------------------------------------
  1 | package cn.lyn4ever.export2md.service.impl;
  2 | 
  3 | import cn.hutool.core.lang.UUID;
  4 | import cn.lyn4ever.export2md.halo.PostRequest;
  5 | import cn.lyn4ever.export2md.schema.ImportLogSchema;
  6 | import cn.lyn4ever.export2md.service.ImportService;
  7 | import cn.lyn4ever.export2md.service.PostService;
  8 | import java.io.File;
  9 | import java.security.Principal;
 10 | import java.util.Date;
 11 | import lombok.RequiredArgsConstructor;
 12 | import org.springframework.security.core.context.ReactiveSecurityContextHolder;
 13 | import org.springframework.security.core.context.SecurityContext;
 14 | import org.springframework.stereotype.Service;
 15 | import reactor.core.publisher.Mono;
 16 | import run.halo.app.core.extension.content.Post;
 17 | import run.halo.app.extension.Metadata;
 18 | import run.halo.app.extension.ReactiveExtensionClient;
 19 | 
 20 | /**
 21 |  * @author Lyn4ever29
 22 |  * @url https://jhacker.cn
 23 |  * @date 2023/12/5
 24 |  */
 25 | @Service
 26 | @RequiredArgsConstructor
 27 | public class ImportServiceV2 implements ImportService {
 28 |     private final PostService postService;
 29 |     private final ReactiveExtensionClient client;
 30 | 
 31 |     /**
 32 |      * 运行导出任务
 33 |      *
 34 |      * @param file
 35 |      * @return
 36 |      */
 37 |     @Override
 38 |     public Mono<Post> runTask(File file) {
 39 |         long old = System.currentTimeMillis();
 40 |         return ReactiveSecurityContextHolder.getContext()
 41 |             .map(SecurityContext::getAuthentication)
 42 |             .map(Principal::getName)
 43 |             .flatMap(owner -> {
 44 |                 PostRequest postRequest = postService.formatPost(file);
 45 |                 Post post = postRequest.getPost();
 46 |                 // post.getStatus().setContributors(List.of(owner));
 47 | 
 48 |                 // https://jhacker.cn/apis/api.console.halo.run/v1alpha1/posts
 49 |                 return postService.draftPost(postRequest).doOnSuccess(re->{
 50 | 
 51 |                     ImportLogSchema schema = new ImportLogSchema();
 52 |                     schema.setCreateTime(new Date());
 53 |                     schema.setPostName(post.getMetadata().getName());
 54 |                     schema.setTitle(post.getSpec().getTitle());
 55 |                     schema.setCostSeconds(System.currentTimeMillis() - old);
 56 |                     schema.setMetadata(new Metadata());
 57 |                     schema.getMetadata().setName(UUID.fastUUID().toString(false));
 58 | 
 59 |                     client.create(schema);
 60 |                 });
 61 | 
 62 |             });
 63 | 
 64 | 
 65 | 
 66 |         /*
 67 |         {
 68 |           "post":{
 69 |             "spec":{
 70 |               "title":"111",
 71 |               "slug":"111",
 72 |               "template":"",
 73 |               "cover":"",
 74 |               "deleted":false,
 75 |               "publish":false,
 76 |               "pinned":false,
 77 |               "allowComment":true,
 78 |               "visible":"PUBLIC",
 79 |               "priority":0,
 80 |               "excerpt":{
 81 |                 "autoGenerate":true,
 82 |                 "raw":""
 83 |               },
 84 |               "categories":[
 85 |               ],
 86 |               "tags":[
 87 |               ],
 88 |               "htmlMetas":[
 89 |               ]
 90 |             },
 91 |             "apiVersion":"content.halo.run/v1alpha1",
 92 |             "kind":"Post",
 93 |             "metadata":{
 94 |               "name":"3ad608e7-a0cb-482b-9eff-fc5883a3575b",
 95 |               "annotations":{
 96 |                 "content.halo.run/preferred-editor":"bytemd"
 97 |               }
 98 |             }
 99 |           },
100 |           "content":{
101 |             "raw":" ## title\n name\n - 都\n - [x] 哈哈\n - [ ] haode ",
102 |             "content":"<h2 id=\"title\">title</h2>\n<p>name</p>\n<ul
103 |             class=\"contains-task-list\">\n<li>都</li>\n<li class=\"task-list-item\"><input
104 |             type=\"checkbox\" checked disabled> 哈哈</li>\n<li class=\"task-list-item\"><input
105 |             type=\"checkbox\" disabled> haode</li>\n</ul>",
106 |             "rawType":"markdown"
107 |           }
108 |         }
109 |          */
110 | 
111 |     }
112 | }
113 | 


--------------------------------------------------------------------------------
/ui/src/views/ExportListItem.vue:
--------------------------------------------------------------------------------
  1 | <script lang="ts" setup>
  2 | import { computed, markRaw, ref, toRefs } from "vue";
  3 | import axios from "axios";
  4 | import {
  5 |   Dialog,
  6 |   Toast,
  7 |   VDropdownItem,
  8 |   VEntity,
  9 |   VEntityField,
 10 |   VSpace,
 11 |   VStatusDot,
 12 | } from "@halo-dev/components";
 13 | import type { ExportLog } from "@/domain";
 14 | // Update the import path to the correct location of EntityDropdownItems.vue
 15 | import EntityDropdownItems from "../components/entity/EntityDropdownItems.vue";
 16 | import { useQueryClient } from "@tanstack/vue-query";
 17 | 
 18 | const queryClient = useQueryClient();
 19 | 
 20 | const props = withDefaults(
 21 |   defineProps<{
 22 |     exportLog: ExportLog;
 23 |     showOperations: boolean;
 24 |   }>(),
 25 |   {
 26 |     showOperations: true,
 27 |   }
 28 | );
 29 | 
 30 | const { exportLog } = toRefs(props);
 31 | 
 32 | const operationItems = computed(() => {
 33 |   return [
 34 |     {
 35 |       priority: 10,
 36 |       component: markRaw(VDropdownItem),
 37 |       label: "下载",
 38 |       hidden: props.exportLog.status !== "c",
 39 |       permissions: [],
 40 |       action: () => {
 41 |         window.location.href =
 42 |           "/apis/api.plugin.halo.run/v1alpha1/plugins/export2doc/doExport/down/" +
 43 |           props.exportLog.name;
 44 |       },
 45 |     },
 46 |     {
 47 |       priority: 20,
 48 |       component: markRaw(VDropdownItem),
 49 |       props: {
 50 |         type: "danger",
 51 |       },
 52 |       label: "删除",
 53 |       action: () => {
 54 |         clickDel();
 55 |       },
 56 |     },
 57 |   ];
 58 | });
 59 | 
 60 | const http = axios.create({
 61 |   baseURL: "/",
 62 |   timeout: 1000,
 63 | });
 64 | 
 65 | const statusList = ref({
 66 |   a: "失败",
 67 |   b: "导出中",
 68 |   c: "成功",
 69 | });
 70 | const statusTag = ref({
 71 |   a: "error" as const,
 72 |   b: "warning" as const,
 73 |   c: "success" as const,
 74 | });
 75 | 
 76 | const clickDel = () => {
 77 |   Dialog.warning({
 78 |     title: "确定删除吗？",
 79 |     description:
 80 |       "删除导出记录后，已经导出的文件也会被删除，此操作不可逆，确定吗？",
 81 |     confirmType: "danger",
 82 |     confirmText: "确定",
 83 |     cancelText: "取消",
 84 |     onConfirm() {
 85 |       http
 86 |         .post(
 87 |           "/apis/api.plugin.halo.run/v1alpha1/plugins/export2doc/doExport/del",
 88 |           [props.exportLog.name]
 89 |         )
 90 |         .then(() => {
 91 |           Toast.success("删除成功");
 92 |           queryClient.invalidateQueries({
 93 |             queryKey: ["plugin:export2doc:exportLogs"],
 94 |           });
 95 |         })
 96 |         .catch(() => {
 97 |           Toast.error("删除失败，请稍后再试");
 98 |         });
 99 |     },
100 |   });
101 | };
102 | 
103 | const formatDate = (s: string | number | Date) => {
104 |   return new Date(s).toLocaleString();
105 | };
106 | </script>
107 | 
108 | <template>
109 |   <VEntity>
110 |     <template #start>
111 |       <VEntityField :description="exportLog.name">
112 |         <template #description>
113 |           <VSpace class="flex-wrap">
114 |             <span class="text-xs text-gray-500">
115 |               {{ exportLog.name }}
116 |             </span>
117 |           </VSpace>
118 |         </template>
119 |       </VEntityField>
120 |     </template>
121 |     <template #end>
122 |       <VEntityField>
123 |         <template #description>
124 |           <VStatusDot
125 |             :state="statusTag[exportLog.status]"
126 |             :text="statusList[exportLog.status]"
127 |           />
128 |         </template>
129 |       </VEntityField>
130 |       <VEntityField v-if="exportLog.status === 'c'">
131 |         <template #description>
132 |           <span class="truncate text-xs tabular-nums text-gray-500">
133 |             {{ exportLog.costSeconds }}ms
134 |           </span>
135 |         </template>
136 |       </VEntityField>
137 |       <VEntityField v-if="exportLog.metadata.deletionTimestamp">
138 |         <template #description>
139 |           <VStatusDot v-tooltip="'删除中'" state="warning" animate />
140 |         </template>
141 |       </VEntityField>
142 |       <VEntityField>
143 |         <template #description>
144 |           <span class="truncate text-xs tabular-nums text-gray-500">
145 |             {{ formatDate(exportLog.createTime) }}
146 |           </span>
147 |         </template>
148 |       </VEntityField>
149 |       <slot name="end"></slot>
150 |     </template>
151 |     <template v-if="showOperations" #dropdownItems>
152 |       <EntityDropdownItems :dropdown-items="operationItems" :item="exportLog" />
153 |     </template>
154 |   </VEntity>
155 | </template>
156 | 
157 | <style scoped lang="scss"></style>
158 | 


--------------------------------------------------------------------------------
/ui/src/assets/logo.svg:
--------------------------------------------------------------------------------
1 | <?xml version="1.0" encoding="UTF-8" standalone="no"?><!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd"><svg width="100%" height="100%" viewBox="0 0 2144 877" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xml:space="preserve" xmlns:serif="http://www.serif.com/" style="fill-rule:evenodd;clip-rule:evenodd;stroke-linejoin:round;stroke-miterlimit:2;"><path d="M1028.16,339.331c148.249,0 268.609,120.36 268.609,268.609c-0,148.249 -120.36,268.608 -268.609,268.608c-148.249,0 -268.608,-120.359 -268.608,-268.608c-0,-148.249 120.359,-268.609 268.608,-268.609Zm0,119.152c82.488,0 149.457,66.969 149.457,149.457c-0,82.487 -66.969,149.456 -149.457,149.456c-82.487,0 -149.456,-66.969 -149.456,-149.456c-0,-82.488 66.969,-149.457 149.456,-149.457Z" style="fill:url(#_Linear1);"/><path d="M1874.58,339.331c148.249,0 268.608,120.36 268.608,268.609c0,148.249 -120.359,268.608 -268.608,268.608c-148.249,0 -268.609,-120.359 -268.609,-268.608c0,-148.249 120.36,-268.609 268.609,-268.609Zm-0,119.152c82.487,0 149.456,66.969 149.456,149.457c0,82.487 -66.969,149.456 -149.456,149.456c-82.488,0 -149.457,-66.969 -149.457,-149.456c0,-82.488 66.969,-149.457 149.457,-149.457Z" style="fill:url(#_Linear2);"/><path d="M1309.27,377.585c-0,-10.083 -7.222,-18.719 -17.146,-20.504c-19.618,-3.528 -51.9,-9.334 -74.172,-13.34c-6.073,-1.092 -12.318,0.564 -17.052,4.522c-4.734,3.959 -7.469,9.812 -7.469,15.983c-0,91.374 -0,407.153 -0,491.469c-0,5.525 2.195,10.824 6.102,14.731c3.907,3.907 9.206,6.102 14.731,6.102c20.987,0 53.186,0 74.173,0c5.525,0 10.824,-2.195 14.731,-6.102c3.907,-3.907 6.102,-9.206 6.102,-14.731c-0,-84.425 -0,-400.286 -0,-478.13Z" style="fill:url(#_Linear3);"/><path d="M1542.59,72.033c0,-8.288 -3.292,-16.237 -9.153,-22.097c-5.86,-5.861 -13.809,-9.153 -22.097,-9.153c-23.867,-0 -56.609,-0 -80.477,-0c-8.288,-0 -16.236,3.292 -22.097,9.153c-5.86,5.86 -9.153,13.809 -9.153,22.097c0,131.79 0,641.475 0,773.265c0,8.288 3.293,16.237 9.153,22.097c5.861,5.861 13.809,9.153 22.097,9.153c23.868,0 56.61,0 80.477,0c8.288,0 16.237,-3.292 22.097,-9.153c5.861,-5.86 9.153,-13.809 9.153,-22.097c0,-131.79 0,-641.475 0,-773.265Z" style="fill:url(#_Linear4);fill-rule:nonzero;"/><g><path d="M506.409,822.063c-0,13.815 5.494,27.062 15.271,36.821c9.777,9.76 23.034,15.23 36.848,15.206c18.674,-0.034 39.711,-0.072 58.369,-0.105c28.696,-0.052 51.932,-23.329 51.932,-52.026l0,-769.586c0,-13.798 -5.481,-27.031 -15.238,-36.788c-9.756,-9.757 -22.99,-15.238 -36.788,-15.238l-58.368,-0c-13.798,-0 -27.031,5.481 -36.788,15.238c-9.757,9.757 -15.238,22.99 -15.238,36.788c-0,155.286 -0,614.283 -0,769.69Z" style="fill:url(#_Linear5);fill-rule:nonzero;"/><path d="M616.746,322.662c13.813,0 27.061,5.487 36.829,15.255c9.767,9.768 15.254,23.015 15.254,36.829c0,105.185 0,341.877 0,447.062c0,13.814 -5.487,27.061 -15.254,36.829c-9.768,9.767 -23.016,15.255 -36.829,15.255c-18.632,-0 -39.622,-0 -58.254,-0c-13.813,-0 -27.061,-5.488 -36.828,-15.255c-9.768,-9.768 -15.255,-23.015 -15.255,-36.829c-0,-68.223 -0,-187.159 -0,-255.383c-0,-13.813 -5.487,-27.061 -15.255,-36.828c-9.767,-9.768 -23.015,-15.255 -36.828,-15.255c-129.249,-0 -454.326,-0 -454.326,-0l0,-191.68l616.746,0Z" style="fill:#0051b0;fill-rule:nonzero;"/><path d="M-0,822.101c0,13.817 5.497,27.067 15.277,36.827c9.781,9.76 23.043,15.229 36.86,15.199c18.675,-0.04 39.713,-0.085 58.368,-0.124c28.69,-0.062 51.916,-23.337 51.916,-52.027c-0,-155.205 -0,-614.509 -0,-769.714c-0,-28.69 -23.226,-51.965 -51.916,-52.026c-18.655,-0.04 -39.693,-0.085 -58.368,-0.125c-13.817,-0.029 -27.079,5.439 -36.86,15.199c-9.78,9.76 -15.277,23.01 -15.277,36.827l-0,769.964Z" style="fill:url(#_Linear6);fill-rule:nonzero;"/></g><defs><linearGradient id="_Linear1" x1="0" y1="0" x2="1" y2="0" gradientUnits="userSpaceOnUse" gradientTransform="matrix(5.19814e-14,-848.921,848.921,5.19814e-14,1308.8,875.397)"><stop offset="0" style="stop-color:#0050b5;stop-opacity:1"/><stop offset="1" style="stop-color:#0b87fd;stop-opacity:1"/></linearGradient><linearGradient id="_Linear2" x1="0" y1="0" x2="1" y2="0" gradientUnits="userSpaceOnUse" gradientTransform="matrix(5.19814e-14,-848.921,848.921,5.19814e-14,1308.8,875.397)"><stop offset="0" style="stop-color:#0050b5;stop-opacity:1"/><stop offset="1" style="stop-color:#0b87fd;stop-opacity:1"/></linearGradient><linearGradient id="_Linear3" x1="0" y1="0" x2="1" y2="0" gradientUnits="userSpaceOnUse" gradientTransform="matrix(5.19814e-14,-848.921,848.921,5.19814e-14,1308.8,875.397)"><stop offset="0" style="stop-color:#0050b5;stop-opacity:1"/><stop offset="1" style="stop-color:#0b87fd;stop-opacity:1"/></linearGradient><linearGradient id="_Linear4" x1="0" y1="0" x2="1" y2="0" gradientUnits="userSpaceOnUse" gradientTransform="matrix(5.19814e-14,-848.921,848.921,5.19814e-14,1308.8,875.397)"><stop offset="0" style="stop-color:#0050b5;stop-opacity:1"/><stop offset="1" style="stop-color:#0b87fd;stop-opacity:1"/></linearGradient><linearGradient id="_Linear5" x1="0" y1="0" x2="1" y2="0" gradientUnits="userSpaceOnUse" gradientTransform="matrix(-3.91885e-13,472.459,-473.895,-3.90698e-13,587.619,-0.861651)"><stop offset="0" style="stop-color:#0048af;stop-opacity:1"/><stop offset="1" style="stop-color:#003580;stop-opacity:1"/></linearGradient><linearGradient id="_Linear6" x1="0" y1="0" x2="1" y2="0" gradientUnits="userSpaceOnUse" gradientTransform="matrix(5.51848e-14,898.506,-901.236,5.50176e-14,162.421,-12.1337)"><stop offset="0" style="stop-color:#0b89ff;stop-opacity:1"/><stop offset="1" style="stop-color:#004eb2;stop-opacity:1"/></linearGradient></defs></svg>


--------------------------------------------------------------------------------
/src/main/java/cn/lyn4ever/export2md/rest/ExportController.java:
--------------------------------------------------------------------------------
  1 | package cn.lyn4ever.export2md.rest;
  2 | 
  3 | import cn.lyn4ever.export2md.schema.ExportLogSchema;
  4 | import cn.lyn4ever.export2md.service.impl.ExportServiceImpl;
  5 | import cn.lyn4ever.export2md.util.FileUtil;
  6 | import lombok.extern.slf4j.Slf4j;
  7 | import org.apache.commons.lang3.StringUtils;
  8 | import org.springframework.beans.factory.annotation.Autowired;
  9 | import org.springframework.http.HttpHeaders;
 10 | import org.springframework.http.MediaType;
 11 | import org.springframework.http.ZeroCopyHttpOutputMessage;
 12 | import org.springframework.http.server.reactive.ServerHttpResponse;
 13 | import org.springframework.web.bind.annotation.*;
 14 | import reactor.core.publisher.Mono;
 15 | import reactor.core.scheduler.Schedulers;
 16 | import run.halo.app.extension.ExtensionClient;
 17 | import run.halo.app.extension.Metadata;
 18 | import run.halo.app.extension.ReactiveExtensionClient;
 19 | import run.halo.app.plugin.ApiVersion;
 20 | 
 21 | import java.io.File;
 22 | import java.io.UnsupportedEncodingException;
 23 | import java.net.URLEncoder;
 24 | import java.nio.charset.StandardCharsets;
 25 | import java.nio.file.Path;
 26 | import java.util.Arrays;
 27 | import java.util.Date;
 28 | 
 29 | /**
 30 |  * 自定义导出接口
 31 |  *
 32 |  * @author Lyn4ever29
 33 |  * @url https://jhacker.cn
 34 |  * @date 2023/11/1
 35 |  */
 36 | @ApiVersion("v1alpha1")
 37 | @RequestMapping("/doExport")
 38 | @RestController
 39 | @Slf4j
 40 | public class ExportController {
 41 | // /apis/plugin.api.halo.run/v1alpha1/plugins/export-anything/doExport/**
 42 | 
 43 |     private final String EXPORT_ONE_DIR = "markdown_post";
 44 | 
 45 |     @Autowired
 46 |     private ExportServiceImpl exportService;
 47 | 
 48 |     @Autowired
 49 |     private ReactiveExtensionClient reactiveClient;
 50 |     @Autowired
 51 |     private ExtensionClient commonClient;
 52 | 
 53 | 
 54 |     @PostMapping("/export")
 55 |     public Mono<ExportLogSchema> export(@RequestBody final ExportLogSchema exportLogSchema) {
 56 |         exportLogSchema.setCreateTime(new Date());
 57 |         exportLogSchema.setStatus("b");
 58 |         //设置元数据才能保存
 59 |         exportLogSchema.setMetadata(new Metadata());
 60 |         exportLogSchema.getMetadata().setName(exportLogSchema.getName());
 61 | 
 62 |         return reactiveClient.create(exportLogSchema).doOnSuccess(
 63 |                 exportLogSchema1 -> {
 64 |                     Thread t = new Thread(() -> {
 65 |                         exportService.runTask(exportLogSchema);
 66 |                     });
 67 |                     t.start();
 68 |                 }
 69 |         );
 70 |     }
 71 | 
 72 |     /**
 73 |      * 导出单篇文章
 74 |      *
 75 |      * @param name
 76 |      * @return
 77 |      */
 78 |     @GetMapping("/export_one/{name}")
 79 |     public Mono<Void> fetchHeadContent(@PathVariable("name") String name, ServerHttpResponse response) throws UnsupportedEncodingException {
 80 | 
 81 |         return Mono.fromCallable(() -> {
 82 |                     //写文件
 83 |                     String fileName = exportService.writePost(name, EXPORT_ONE_DIR);
 84 |                     File file = new File(fileName);
 85 | 
 86 |                     ZeroCopyHttpOutputMessage zeroCopyResponse = (ZeroCopyHttpOutputMessage) response;
 87 |                     HttpHeaders headers = zeroCopyResponse.getHeaders();
 88 |                     headers.set("Content-Disposition", "attachment; filename=" + URLEncoder.encode(file.getName(), StandardCharsets.UTF_8));
 89 |                     headers.set("file-name", URLEncoder.encode(file.getName(), StandardCharsets.UTF_8));
 90 |                     headers.set("Access-Control-Allow-Origin", "*");
 91 |                     MediaType application = new MediaType("application", "octet-stream", StandardCharsets.UTF_8);
 92 |                     headers.setContentType(application);
 93 |                     zeroCopyResponse.writeWith(file, 0, file.length()).subscribe();
 94 |                     return "";
 95 |                 })
 96 |                 .publishOn(Schedulers.boundedElastic()).then();
 97 | 
 98 | 
 99 |     }
100 | 
101 |     @PostMapping("/del")
102 |     public Mono<Void> delete(@RequestBody String[] names) {
103 | 
104 |         Arrays.stream(names).parallel().forEach(name ->
105 |                 reactiveClient.fetch(ExportLogSchema.class, name)
106 |                         .publishOn(Schedulers.boundedElastic())
107 |                         .doOnSuccess(exportLogSchema -> {
108 |                             reactiveClient.delete(exportLogSchema).doOnSuccess(exportLogSchema1 -> {
109 |                                 //删除文件
110 |                                 exportService.delete(name);
111 |                             }).subscribe();
112 |                         }).subscribe());
113 |         return Mono.empty();
114 |     }
115 | 
116 |     @GetMapping("/down/{path}")
117 |     public Mono<Void> down(@PathVariable("path") String path, ServerHttpResponse response) {
118 |         if (StringUtils.isBlank(path)) {
119 |             return Mono.empty();
120 |         }
121 |         if (path.split("\\.").length > 2) {
122 |             //包含太多.的路径，不可下载
123 |             return Mono.empty();
124 |         }
125 | 
126 |         Path docFile = FileUtil.getDocFile(FileUtil.DirPath.EXPORT);
127 |         File file = new File(docFile.toFile().getAbsolutePath() + "/" + path + ".zip");
128 |         if (!file.exists()) {
129 |             //todo 适配旧版本,未来会删除
130 |             file = new File(docFile.toFile().getAbsolutePath() + "/../" + path + ".zip");
131 |             if (!file.exists()) {
132 |                 //todo 适配旧版本,未来会删除
133 |                 file = new File(System.getProperty("user.home")+"/.halo/plugins/export2doc_files/" + path + ".zip");
134 |             }
135 |             if (!file.exists()) {
136 |                 throw new RuntimeException("文件不存在");
137 |             }
138 |         }
139 | 
140 |         ZeroCopyHttpOutputMessage zeroCopyResponse = (ZeroCopyHttpOutputMessage) response;
141 |         HttpHeaders headers = zeroCopyResponse.getHeaders();
142 |         headers.set("Content-Disposition", "attachment; filename=" + URLEncoder.encode(file.getName(), StandardCharsets.UTF_8));
143 |         headers.set("file-name", URLEncoder.encode(path, StandardCharsets.UTF_8));
144 |         headers.set("Access-Control-Allow-Origin", "*");
145 |         MediaType application = new MediaType("application", "octet-stream", StandardCharsets.UTF_8);
146 |         headers.setContentType(application);
147 |         zeroCopyResponse.writeWith(file, 0, file.length()).subscribe();
148 | 
149 |         return Mono.empty();
150 |     }
151 | 
152 | 
153 | }
154 | 


--------------------------------------------------------------------------------
/src/main/java/cn/lyn4ever/export2md/halo/service/AbstractContentService.java:
--------------------------------------------------------------------------------
  1 | package cn.lyn4ever.export2md.halo.service;
  2 | 
  3 | import cn.lyn4ever.export2md.halo.ContentRequest;
  4 | import cn.lyn4ever.export2md.halo.ContentWrapper;
  5 | import lombok.AllArgsConstructor;
  6 | import lombok.extern.slf4j.Slf4j;
  7 | import org.apache.commons.lang3.StringUtils;
  8 | import org.springframework.lang.NonNull;
  9 | import org.springframework.lang.Nullable;
 10 | import org.springframework.security.core.context.ReactiveSecurityContextHolder;
 11 | import org.springframework.security.core.context.SecurityContext;
 12 | import org.springframework.util.Assert;
 13 | import reactor.core.publisher.Mono;
 14 | import run.halo.app.core.extension.content.Snapshot;
 15 | import run.halo.app.extension.MetadataUtil;
 16 | import run.halo.app.extension.ReactiveExtensionClient;
 17 | import java.security.Principal;
 18 | import java.time.Instant;
 19 | import java.util.UUID;
 20 | 
 21 | /**
 22 |  * Abstract Service for {@link Snapshot}.
 23 |  *
 24 |  * @author guqing
 25 |  * @since 2.0.0
 26 |  */
 27 | @Slf4j
 28 | @AllArgsConstructor
 29 | public abstract class AbstractContentService {
 30 | 
 31 |     private final ReactiveExtensionClient client;
 32 | 
 33 |     public Mono<ContentWrapper> getContent(String snapshotName, String baseSnapshotName) {
 34 |         if (StringUtils.isBlank(snapshotName) || StringUtils.isBlank(baseSnapshotName)) {
 35 |             return Mono.empty();
 36 |         }
 37 |         // TODO: refactor this method to use client.get instead of fetch but please be careful
 38 |         return client.fetch(Snapshot.class, baseSnapshotName)
 39 |             .doOnNext(this::checkBaseSnapshot)
 40 |             .flatMap(baseSnapshot -> {
 41 |                 if (StringUtils.equals(snapshotName, baseSnapshotName)) {
 42 |                     var contentWrapper = ContentWrapper.patchSnapshot(baseSnapshot, baseSnapshot);
 43 |                     return Mono.just(contentWrapper);
 44 |                 }
 45 |                 return client.fetch(Snapshot.class, snapshotName)
 46 |                     .map(snapshot -> ContentWrapper.patchSnapshot(snapshot, baseSnapshot));
 47 |             })
 48 |             .switchIfEmpty(Mono.defer(() -> {
 49 |                 log.error("The content snapshot [{}] or base snapshot [{}] not found.",
 50 |                     snapshotName, baseSnapshotName);
 51 |                 return Mono.empty();
 52 |             }));
 53 |     }
 54 | 
 55 |     protected void checkBaseSnapshot(Snapshot snapshot) {
 56 |         Assert.notNull(snapshot, "The snapshot must not be null.");
 57 |         if (!isBaseSnapshot(snapshot)) {
 58 |             throw new IllegalArgumentException(
 59 |                 String.format("The snapshot [%s] is not a base snapshot.",
 60 |                     snapshot.getMetadata().getName()));
 61 |         }
 62 |     }
 63 | 
 64 |     protected Mono<ContentWrapper> draftContent(@Nullable String baseSnapshotName,
 65 |         ContentRequest contentRequest,
 66 |         @Nullable String parentSnapshotName) {
 67 |         Snapshot snapshot = contentRequest.toSnapshot();
 68 |         snapshot.getMetadata().setName(UUID.randomUUID().toString());
 69 |         snapshot.getSpec().setParentSnapshotName(parentSnapshotName);
 70 | 
 71 |         final String baseSnapshotNameToUse =
 72 |             StringUtils.defaultIfBlank(baseSnapshotName, snapshot.getMetadata().getName());
 73 |         return client.fetch(Snapshot.class, baseSnapshotName)
 74 |             .doOnNext(this::checkBaseSnapshot)
 75 |             .defaultIfEmpty(snapshot)
 76 |             .map(baseSnapshot -> determineRawAndContentPatch(snapshot, baseSnapshot,
 77 |                 contentRequest)
 78 |             )
 79 |             .flatMap(source -> getContextUsername()
 80 |                 .map(username -> {
 81 |                     Snapshot.addContributor(source, username);
 82 |                     source.getSpec().setOwner(username);
 83 |                     return source;
 84 |                 })
 85 |                 .defaultIfEmpty(source)
 86 |             )
 87 |             .flatMap(snapshotToCreate -> client.create(snapshotToCreate)
 88 |                 .flatMap(head -> restoredContent(baseSnapshotNameToUse, head)));
 89 |     }
 90 | 
 91 |     protected Mono<ContentWrapper> draftContent(String baseSnapshotName, ContentRequest content) {
 92 |         return this.draftContent(baseSnapshotName, content, content.headSnapshotName());
 93 |     }
 94 | 
 95 |     protected Mono<ContentWrapper> updateContent(String baseSnapshotName,
 96 |         ContentRequest contentRequest) {
 97 |         Assert.notNull(contentRequest, "The contentRequest must not be null");
 98 |         Assert.notNull(baseSnapshotName, "The baseSnapshotName must not be null");
 99 |         Assert.notNull(contentRequest.headSnapshotName(), "The headSnapshotName must not be null");
100 |         return client.fetch(Snapshot.class, contentRequest.headSnapshotName())
101 |             .flatMap(headSnapshot -> client.fetch(Snapshot.class, baseSnapshotName)
102 |                 .map(baseSnapshot -> determineRawAndContentPatch(headSnapshot, baseSnapshot,
103 |                     contentRequest)
104 |                 )
105 |             )
106 |             .flatMap(headSnapshot -> getContextUsername()
107 |                 .map(username -> {
108 |                     Snapshot.addContributor(headSnapshot, username);
109 |                     return headSnapshot;
110 |                 })
111 |                 .defaultIfEmpty(headSnapshot)
112 |             )
113 |             .flatMap(client::update)
114 |             .flatMap(head -> restoredContent(baseSnapshotName, head));
115 |     }
116 | 
117 |     protected Mono<ContentWrapper> restoredContent(String baseSnapshotName, Snapshot headSnapshot) {
118 |         return client.fetch(Snapshot.class, baseSnapshotName)
119 |             .doOnNext(this::checkBaseSnapshot)
120 |             .map(baseSnapshot -> ContentWrapper.patchSnapshot(headSnapshot, baseSnapshot));
121 |     }
122 | 
123 |     protected Snapshot determineRawAndContentPatch(Snapshot snapshotToUse,
124 |         Snapshot baseSnapshot,
125 |         ContentRequest contentRequest) {
126 |         Assert.notNull(baseSnapshot, "The baseSnapshot must not be null.");
127 |         Assert.notNull(contentRequest, "The contentRequest must not be null.");
128 |         Assert.notNull(snapshotToUse, "The snapshotToUse not be null.");
129 |         String originalRaw = baseSnapshot.getSpec().getRawPatch();
130 |         String originalContent = baseSnapshot.getSpec().getContentPatch();
131 |         String baseSnapshotName = baseSnapshot.getMetadata().getName();
132 | 
133 |         snapshotToUse.getSpec().setLastModifyTime(Instant.now());
134 |         // it is the v1 snapshot, set the content directly
135 |         if (StringUtils.equals(baseSnapshotName,
136 |             snapshotToUse.getMetadata().getName())) {
137 |             snapshotToUse.getSpec().setRawPatch(contentRequest.raw());
138 |             snapshotToUse.getSpec().setContentPatch(contentRequest.content());
139 |             MetadataUtil.nullSafeAnnotations(snapshotToUse)
140 |                 .put(Snapshot.KEEP_RAW_ANNO, Boolean.TRUE.toString());
141 |         } else {
142 |             // otherwise diff a patch based on the v1 snapshot
143 |             String revisedRaw = contentRequest.rawPatchFrom(originalRaw);
144 |             String revisedContent = contentRequest.contentPatchFrom(originalContent);
145 |             snapshotToUse.getSpec().setRawPatch(revisedRaw);
146 |             snapshotToUse.getSpec().setContentPatch(revisedContent);
147 |         }
148 |         return snapshotToUse;
149 |     }
150 | 
151 |     protected Mono<String> getContextUsername() {
152 |         return ReactiveSecurityContextHolder.getContext()
153 |             .map(SecurityContext::getAuthentication)
154 |             .map(Principal::getName);
155 |     }
156 | 
157 | 
158 |     /**
159 |      * 更新自halo
160 |      * @param snapshot
161 |      * @return
162 |      */
163 |     private static boolean isBaseSnapshot(@NonNull Snapshot snapshot) {
164 |         var annotations = snapshot.getMetadata().getAnnotations();
165 |         if (annotations == null) {
166 |             return false;
167 |         }
168 |         return Boolean.parseBoolean(annotations.get(Snapshot.KEEP_RAW_ANNO));
169 |     }
170 | }
171 | 


--------------------------------------------------------------------------------
/gradlew:
--------------------------------------------------------------------------------
  1 | #!/bin/sh
  2 | 
  3 | #
  4 | # Copyright © 2015-2021 the original authors.
  5 | #
  6 | # Licensed under the Apache License, Version 2.0 (the "License");
  7 | # you may not use this file except in compliance with the License.
  8 | # You may obtain a copy of the License at
  9 | #
 10 | #      https://www.apache.org/licenses/LICENSE-2.0
 11 | #
 12 | # Unless required by applicable law or agreed to in writing, software
 13 | # distributed under the License is distributed on an "AS IS" BASIS,
 14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 15 | # See the License for the specific language governing permissions and
 16 | # limitations under the License.
 17 | #
 18 | 
 19 | ##############################################################################
 20 | #
 21 | #   Gradle start up script for POSIX generated by Gradle.
 22 | #
 23 | #   Important for running:
 24 | #
 25 | #   (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is
 26 | #       noncompliant, but you have some other compliant shell such as ksh or
 27 | #       bash, then to run this script, type that shell name before the whole
 28 | #       command line, like:
 29 | #
 30 | #           ksh Gradle
 31 | #
 32 | #       Busybox and similar reduced shells will NOT work, because this script
 33 | #       requires all of these POSIX shell features:
 34 | #         * functions;
 35 | #         * expansions «$var», «${var}», «${var:-default}», «${var+SET}»,
 36 | #           «${var#prefix}», «${var%suffix}», and «$( cmd )»;
 37 | #         * compound commands having a testable exit status, especially «case»;
 38 | #         * various built-in commands including «command», «set», and «ulimit».
 39 | #
 40 | #   Important for patching:
 41 | #
 42 | #   (2) This script targets any POSIX shell, so it avoids extensions provided
 43 | #       by Bash, Ksh, etc; in particular arrays are avoided.
 44 | #
 45 | #       The "traditional" practice of packing multiple parameters into a
 46 | #       space-separated string is a well documented source of bugs and security
 47 | #       problems, so this is (mostly) avoided, by progressively accumulating
 48 | #       options in "$@", and eventually passing that to Java.
 49 | #
 50 | #       Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS,
 51 | #       and GRADLE_OPTS) rely on word-splitting, this is performed explicitly;
 52 | #       see the in-line comments for details.
 53 | #
 54 | #       There are tweaks for specific operating systems such as AIX, CygWin,
 55 | #       Darwin, MinGW, and NonStop.
 56 | #
 57 | #   (3) This script is generated from the Groovy template
 58 | #       https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
 59 | #       within the Gradle project.
 60 | #
 61 | #       You can find Gradle at https://github.com/gradle/gradle/.
 62 | #
 63 | ##############################################################################
 64 | 
 65 | # Attempt to set APP_HOME
 66 | 
 67 | # Resolve links: $0 may be a link
 68 | app_path=$0
 69 | 
 70 | # Need this for daisy-chained symlinks.
 71 | while
 72 |     APP_HOME=${app_path%"${app_path##*/}"}  # leaves a trailing /; empty if no leading path
 73 |     [ -h "$app_path" ]
 74 | do
 75 |     ls=$( ls -ld "$app_path" )
 76 |     link=${ls#*' -> '}
 77 |     case $link in             #(
 78 |       /*)   app_path=$link ;; #(
 79 |       *)    app_path=$APP_HOME$link ;;
 80 |     esac
 81 | done
 82 | 
 83 | # This is normally unused
 84 | # shellcheck disable=SC2034
 85 | APP_BASE_NAME=${0##*/}
 86 | APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
 87 | 
 88 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
 89 | DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
 90 | 
 91 | # Use the maximum available, or set MAX_FD != -1 to use that value.
 92 | MAX_FD=maximum
 93 | 
 94 | warn () {
 95 |     echo "$*"
 96 | } >&2
 97 | 
 98 | die () {
 99 |     echo
100 |     echo "$*"
101 |     echo
102 |     exit 1
103 | } >&2
104 | 
105 | # OS specific support (must be 'true' or 'false').
106 | cygwin=false
107 | msys=false
108 | darwin=false
109 | nonstop=false
110 | case "$( uname )" in                #(
111 |   CYGWIN* )         cygwin=true  ;; #(
112 |   Darwin* )         darwin=true  ;; #(
113 |   MSYS* | MINGW* )  msys=true    ;; #(
114 |   NONSTOP* )        nonstop=true ;;
115 | esac
116 | 
117 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
118 | 
119 | 
120 | # Determine the Java command to use to start the JVM.
121 | if [ -n "$JAVA_HOME" ] ; then
122 |     if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
123 |         # IBM's JDK on AIX uses strange locations for the executables
124 |         JAVACMD=$JAVA_HOME/jre/sh/java
125 |     else
126 |         JAVACMD=$JAVA_HOME/bin/java
127 |     fi
128 |     if [ ! -x "$JAVACMD" ] ; then
129 |         die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
130 | 
131 | Please set the JAVA_HOME variable in your environment to match the
132 | location of your Java installation."
133 |     fi
134 | else
135 |     JAVACMD=java
136 |     which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
137 | 
138 | Please  set the JAVA_HOME variable in your environment to match the
139 | location of your Java installation."
140 | fi
141 | 
142 | # Increase the maximum file descriptors if we can.
143 | if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
144 |     case $MAX_FD in #(
145 |       max*)
146 |         # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked.
147 |         # shellcheck disable=SC3045
148 |         MAX_FD=$( ulimit -H -n ) ||
149 |             warn "Could not query maximum file descriptor limit"
150 |     esac
151 |     case $MAX_FD in  #(
152 |       '' | soft) :;; #(
153 |       *)
154 |         # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked.
155 |         # shellcheck disable=SC3045
156 |         ulimit -n "$MAX_FD" ||
157 |             warn "Could not set maximum file descriptor limit to $MAX_FD"
158 |     esac
159 | fi
160 | 
161 | # Collect all arguments for the java command, stacking in reverse order:
162 | #   * args from the command line
163 | #   * the main class name
164 | #   * -classpath
165 | #   * -D...appname settings
166 | #   * --module-path (only if needed)
167 | #   * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables.
168 | 
169 | # For Cygwin or MSYS, switch paths to Windows format before running java
170 | if "$cygwin" || "$msys" ; then
171 |     APP_HOME=$( cygpath --path --mixed "$APP_HOME" )
172 |     CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" )
173 | 
174 |     JAVACMD=$( cygpath --unix "$JAVACMD" )
175 | 
176 |     # Now convert the arguments - kludge to limit ourselves to /bin/sh
177 |     for arg do
178 |         if
179 |             case $arg in                                #(
180 |               -*)   false ;;                            # don't mess with options #(
181 |               /?*)  t=${arg#/} t=/${t%%/*}              # looks like a POSIX filepath
182 |                     [ -e "$t" ] ;;                      #(
183 |               *)    false ;;
184 |             esac
185 |         then
186 |             arg=$( cygpath --path --ignore --mixed "$arg" )
187 |         fi
188 |         # Roll the args list around exactly as many times as the number of
189 |         # args, so each arg winds up back in the position where it started, but
190 |         # possibly modified.
191 |         #
192 |         # NB: a `for` loop captures its iteration list before it begins, so
193 |         # changing the positional parameters here affects neither the number of
194 |         # iterations, nor the values presented in `arg`.
195 |         shift                   # remove old arg
196 |         set -- "$@" "$arg"      # push replacement arg
197 |     done
198 | fi
199 | 
200 | # Collect all arguments for the java command;
201 | #   * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of
202 | #     shell script including quotes and variable substitutions, so put them in
203 | #     double quotes to make sure that they get re-expanded; and
204 | #   * put everything else in single quotes, so that it's not re-expanded.
205 | 
206 | set -- \
207 |         "-Dorg.gradle.appname=$APP_BASE_NAME" \
208 |         -classpath "$CLASSPATH" \
209 |         org.gradle.wrapper.GradleWrapperMain \
210 |         "$@"
211 | 
212 | # Stop when "xargs" is not available.
213 | if ! command -v xargs >/dev/null 2>&1
214 | then
215 |     die "xargs is not available"
216 | fi
217 | 
218 | # Use "xargs" to parse quoted args.
219 | #
220 | # With -n1 it outputs one arg per line, with the quotes and backslashes removed.
221 | #
222 | # In Bash we could simply go:
223 | #
224 | #   readarray ARGS < <( xargs -n1 <<<"$var" ) &&
225 | #   set -- "${ARGS[@]}" "$@"
226 | #
227 | # but POSIX shell has neither arrays nor command substitution, so instead we
228 | # post-process each arg (as a line of input to sed) to backslash-escape any
229 | # character that might be a shell metacharacter, then use eval to reverse
230 | # that process (while maintaining the separation between arguments), and wrap
231 | # the whole thing up as a single "set" statement.
232 | #
233 | # This will of course break if any of these variables contains a newline or
234 | # an unmatched quote.
235 | #
236 | 
237 | eval "set -- $(
238 |         printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" |
239 |         xargs -n1 |
240 |         sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' |
241 |         tr '\n' ' '
242 |     )" '"$@"'
243 | 
244 | exec "$JAVACMD" "$@"
245 | 


--------------------------------------------------------------------------------
/src/main/java/cn/lyn4ever/export2md/service/impl/PostServiceImpl.java:
--------------------------------------------------------------------------------
  1 | package cn.lyn4ever.export2md.service.impl;
  2 | 
  3 | import cn.hutool.core.lang.UUID;
  4 | import cn.hutool.json.JSONUtil;
  5 | import cn.lyn4ever.export2md.halo.Content;
  6 | import cn.lyn4ever.export2md.halo.ContentRequest;
  7 | import cn.lyn4ever.export2md.halo.ContentWrapper;
  8 | import cn.lyn4ever.export2md.halo.PostRequest;
  9 | import cn.lyn4ever.export2md.halo.service.AbstractContentService;
 10 | import cn.lyn4ever.export2md.service.PostService;
 11 | import java.io.BufferedReader;
 12 | import java.io.File;
 13 | import java.io.FileNotFoundException;
 14 | import java.io.FileReader;
 15 | import java.io.IOException;
 16 | import java.time.Duration;
 17 | import java.time.Instant;
 18 | import java.util.Objects;
 19 | import java.util.StringJoiner;
 20 | import com.vladsch.flexmark.html2md.converter.FlexmarkHtmlConverter;
 21 | import lombok.extern.slf4j.Slf4j;
 22 | import org.apache.commons.lang3.StringUtils;
 23 | import org.springframework.dao.OptimisticLockingFailureException;
 24 | import org.springframework.lang.NonNull;
 25 | import org.springframework.stereotype.Component;
 26 | import reactor.core.publisher.Mono;
 27 | import reactor.util.retry.Retry;
 28 | import run.halo.app.core.extension.content.Post;
 29 | import run.halo.app.extension.Metadata;
 30 | import run.halo.app.extension.ReactiveExtensionClient;
 31 | import run.halo.app.extension.Ref;
 32 | import run.halo.app.infra.Condition;
 33 | import run.halo.app.infra.ConditionStatus;
 34 | 
 35 | /**
 36 |  * A default implementation of {@link PostService}.
 37 |  *
 38 |  * @author guqing
 39 |  * @since 2.0.0
 40 |  */
 41 | @Slf4j
 42 | @Component
 43 | public class PostServiceImpl extends AbstractContentService implements PostService {
 44 |     private final ReactiveExtensionClient client;
 45 | 
 46 |     public PostServiceImpl(ReactiveExtensionClient client) {
 47 |         super(client);
 48 |         this.client = client;
 49 |     }
 50 | 
 51 | 
 52 |     /**
 53 |      * 保存文章
 54 |      *
 55 |      * @param postRequest
 56 |      * @return
 57 |      */
 58 |     @Override
 59 |     public Mono<Post> draftPost(PostRequest postRequest) {
 60 |         System.out.println(JSONUtil.toJsonStr(postRequest));
 61 |         return Mono.defer(
 62 |                 () -> {
 63 |                     Post post = postRequest.getPost();
 64 |                     return getContextUsername()
 65 |                         .map(username -> {
 66 |                             post.getSpec().setOwner(username);
 67 |                             return post;
 68 |                         })
 69 |                         .defaultIfEmpty(post);
 70 |                 }
 71 |             )
 72 |             //保存文章
 73 |             .flatMap(client::create)
 74 |             .flatMap(post -> {
 75 |                 System.out.println("保存文章" + post.toString());
 76 |                 if (postRequest.getContent() == null) {
 77 |                     return Mono.just(post);
 78 |                 }
 79 |                 var contentRequest =
 80 |                     new ContentRequest(Ref.of(post), post.getSpec().getHeadSnapshot(),
 81 |                         postRequest.getContent().getRaw(), postRequest.getContent().getContent(),
 82 |                         postRequest.getContent().getRawType());
 83 |                 //保存文章内容
 84 |                 return draftContent(post.getSpec().getBaseSnapshot(), contentRequest)
 85 |                     .flatMap(contentWrapper -> waitForPostToDraftConcludingWork(
 86 |                         post.getMetadata().getName(),
 87 |                         contentWrapper)
 88 |                     );
 89 |             })
 90 |             .retryWhen(Retry.backoff(5, Duration.ofMillis(100))
 91 |                 .filter(OptimisticLockingFailureException.class::isInstance));
 92 |     }
 93 | 
 94 |     private Mono<Post> waitForPostToDraftConcludingWork(String postName,
 95 |         ContentWrapper contentWrapper) {
 96 |         return Mono.defer(() -> client.fetch(Post.class, postName)
 97 |                 .flatMap(post -> {
 98 |                     post.getSpec().setBaseSnapshot(contentWrapper.getSnapshotName());
 99 |                     post.getSpec().setHeadSnapshot(contentWrapper.getSnapshotName());
100 |                     if (Objects.equals(true, post.getSpec().getPublish())) {
101 |                         post.getSpec().setReleaseSnapshot(post.getSpec().getHeadSnapshot());
102 |                     }
103 |                     Condition condition = Condition.builder()
104 |                         .type(Post.PostPhase.DRAFT.name())
105 |                         .reason("DraftedSuccessfully")
106 |                         .message("Drafted post successfully.")
107 |                         .status(ConditionStatus.TRUE)
108 |                         .lastTransitionTime(Instant.now())
109 |                         .build();
110 |                     Post.PostStatus status = post.getStatusOrDefault();
111 |                     status.setPhase(Post.PostPhase.DRAFT.name());
112 |                     status.getConditionsOrDefault().addAndEvictFIFO(condition);
113 |                     return client.update(post);
114 |                 }))
115 |             .retryWhen(Retry.backoff(5, Duration.ofMillis(100))
116 |                 .filter(OptimisticLockingFailureException.class::isInstance));
117 |     }
118 | 
119 |     @Override
120 |     public Mono<Post> updatePost(PostRequest postRequest) {
121 |         Post post = postRequest.getPost();
122 |         String headSnapshot = post.getSpec().getHeadSnapshot();
123 |         String releaseSnapshot = post.getSpec().getReleaseSnapshot();
124 |         String baseSnapshot = post.getSpec().getBaseSnapshot();
125 | 
126 |         if (StringUtils.equals(releaseSnapshot, headSnapshot)) {
127 |             // create new snapshot to update first
128 |             return draftContent(baseSnapshot, postRequest.contentRequest(), headSnapshot)
129 |                 .flatMap(contentWrapper -> {
130 |                     post.getSpec().setHeadSnapshot(contentWrapper.getSnapshotName());
131 |                     return client.update(post);
132 |                 });
133 |         }
134 |         return Mono.defer(() -> updateContent(baseSnapshot, postRequest.contentRequest())
135 |                 .flatMap(contentWrapper -> {
136 |                     post.getSpec().setHeadSnapshot(contentWrapper.getSnapshotName());
137 |                     return client.update(post);
138 |                 }))
139 |             .retryWhen(Retry.backoff(5, Duration.ofMillis(100))
140 |                 .filter(throwable -> throwable instanceof OptimisticLockingFailureException));
141 |     }
142 | 
143 |     @Override
144 |     public Mono<Post> updateBy(@NonNull Post post) {
145 |         return client.update(post);
146 |     }
147 | 
148 |     @Override
149 |     public Mono<ContentWrapper> getHeadContent(String postName) {
150 |         return client.get(Post.class, postName)
151 |             .flatMap(this::getHeadContent);
152 |     }
153 | 
154 |     @Override
155 |     public Mono<ContentWrapper> getHeadContent(Post post) {
156 |         var headSnapshot = post.getSpec().getHeadSnapshot();
157 |         return getContent(headSnapshot, post.getSpec().getBaseSnapshot());
158 |     }
159 | 
160 |     @Override
161 |     public Mono<ContentWrapper> getReleaseContent(String postName) {
162 |         return client.get(Post.class, postName)
163 |             .flatMap(this::getReleaseContent);
164 |     }
165 | 
166 |     @Override
167 |     public Mono<ContentWrapper> getReleaseContent(Post post) {
168 |         var releaseSnapshot = post.getSpec().getReleaseSnapshot();
169 |         return getContent(releaseSnapshot, post.getSpec().getBaseSnapshot());
170 |     }
171 | 
172 |     @Override
173 |     public Mono<Post> publish(Post post) {
174 |         return Mono.just(post)
175 |             .doOnNext(p -> {
176 |                 var spec = post.getSpec();
177 |                 spec.setPublish(true);
178 |                 if (spec.getHeadSnapshot() == null) {
179 |                     spec.setHeadSnapshot(spec.getBaseSnapshot());
180 |                 }
181 |                 spec.setReleaseSnapshot(spec.getHeadSnapshot());
182 |             }).flatMap(client::update);
183 |     }
184 | 
185 |     @Override
186 |     public Mono<Post> unpublish(Post post) {
187 |         return Mono.just(post)
188 |             .doOnNext(p -> p.getSpec().setPublish(false))
189 |             .flatMap(client::update);
190 |     }
191 | 
192 |     @Override
193 |     public Mono<Post> getByUsername(String postName, String username) {
194 |         return client.get(Post.class, postName)
195 |             .filter(post -> post.getSpec() != null)
196 |             .filter(post -> Objects.equals(username, post.getSpec().getOwner()));
197 |     }
198 | 
199 |     @Override
200 |     public PostRequest formatPost(File file) {
201 |         BufferedReader reader = null;
202 |         try {
203 |             reader = new BufferedReader(new FileReader(file));
204 |         } catch (FileNotFoundException e) {
205 |             throw new RuntimeException(e);
206 |         }
207 | 
208 |         StringJoiner sj = new StringJoiner("\n");
209 |         reader.lines().forEach(sj::add);
210 | 
211 |         String title = file.getName().split(".md")[0];
212 | 
213 |         Post post = new Post();
214 | 
215 |         Post.PostSpec postSpec = new Post.PostSpec();
216 |         postSpec.setTitle(title);
217 |         postSpec.setSlug(UUID.fastUUID().toString(false));
218 |         postSpec.setAllowComment(true);
219 |         postSpec.setDeleted(false);
220 |         Post.Excerpt excerpt = new Post.Excerpt();
221 |         excerpt.setAutoGenerate(true);
222 |         excerpt.setRaw("");
223 |         postSpec.setExcerpt(excerpt);
224 |         postSpec.setPriority(0);
225 |         postSpec.setVisible(Post.VisibleEnum.PUBLIC);
226 |         postSpec.setPublish(false);
227 |         postSpec.setPinned(false);
228 | 
229 | 
230 |         Post.PostStatus postStatus = new Post.PostStatus();
231 |         //草稿箱，待发布状态
232 |         postStatus.setPhase(Post.PostPhase.DRAFT.name());
233 |         // postStatus.setContributors(List.of(owner));
234 | 
235 |         post.setSpec(postSpec);
236 |         // post.setStatus(postStatus);
237 |         //设置元数据才能保存
238 |         Metadata postMeta = new Metadata();
239 |         postMeta.setName(UUID.fastUUID().toString(false));
240 |         // postMeta.setAnnotations(Map.of("content.halo.run/preferred-editor","bytemd"));
241 |         post.setMetadata(postMeta);
242 | 
243 | 
244 |         try {
245 |             return new PostRequest(post, new Content(sj.toString(),
246 |             FlexmarkHtmlConverter.builder()
247 |                 .build()
248 |                 .convert(sj.toString()),
249 |                 "markdown")
250 |             );
251 |         } catch (Exception e) {
252 |             throw new RuntimeException(e);
253 |         }
254 | 
255 |     }
256 | }
257 | 


--------------------------------------------------------------------------------
/src/main/java/cn/lyn4ever/export2md/service/impl/ExportServiceImpl.java:
--------------------------------------------------------------------------------
  1 | package cn.lyn4ever.export2md.service.impl;
  2 | 
  3 | import cn.hutool.core.util.ZipUtil;
  4 | import cn.lyn4ever.export2md.halo.ContentWrapper;
  5 | import cn.lyn4ever.export2md.schema.ExportLogSchema;
  6 | import cn.lyn4ever.export2md.service.ExportService;
  7 | import cn.lyn4ever.export2md.util.FileUtil;
  8 | import lombok.extern.slf4j.Slf4j;
  9 | import org.apache.commons.lang3.StringUtils;
 10 | import org.springframework.beans.factory.annotation.Autowired;
 11 | import org.springframework.stereotype.Component;
 12 | import org.springframework.util.Assert;
 13 | import run.halo.app.core.extension.content.Category;
 14 | import run.halo.app.core.extension.content.Post;
 15 | import run.halo.app.core.extension.content.Snapshot;
 16 | import run.halo.app.core.extension.content.Tag;
 17 | import run.halo.app.extension.ExtensionClient;
 18 | import run.halo.app.extension.ListResult;
 19 | import run.halo.app.extension.MetadataOperator;
 20 | import run.halo.app.extension.MetadataUtil;
 21 | 
 22 | import java.io.BufferedWriter;
 23 | import java.io.File;
 24 | import java.io.FileWriter;
 25 | import java.io.IOException;
 26 | import java.nio.file.Path;
 27 | import java.time.ZoneId;
 28 | import java.time.format.DateTimeFormatter;
 29 | import java.util.*;
 30 | import java.util.concurrent.atomic.AtomicReference;
 31 | import java.util.function.Predicate;
 32 | 
 33 | /**
 34 |  * @author Lyn4ever29
 35 |  * @url https://jhacker.cn
 36 |  * @date 2023/11/12
 37 |  */
 38 | @Component
 39 | @Slf4j
 40 | public class ExportServiceImpl implements ExportService {
 41 | 
 42 | 
 43 |     public static ThreadLocal<Map<String, String>> TagPool = new ThreadLocal<>();
 44 |     public static ThreadLocal<Map<String, String>> CatePool = new ThreadLocal<>();
 45 | 
 46 | 
 47 |     private final int pageSize = 20;
 48 | 
 49 |     private final Map<String, String> extendNameMap = new HashMap<>() {{
 50 |         put("markdown", ".md");
 51 |         put("html", ".html");
 52 |         put("json", ".josn");
 53 | 
 54 |     }};
 55 |     @Autowired
 56 |     private ExtensionClient client;
 57 | 
 58 |     /**
 59 |      * 运行导出任务
 60 |      *
 61 |      * @param exportLogSchema
 62 |      */
 63 |     @Override
 64 |     public void runTask(ExportLogSchema exportLogSchema) {
 65 |         long old = System.currentTimeMillis();
 66 |         //根据配置获取对应的文章
 67 |         String categories = exportLogSchema.getCategory();
 68 |         String tag = exportLogSchema.getTag();
 69 | 
 70 |         // 构造查询条件
 71 |         Predicate<Post> paramPredicate = post -> true;
 72 | //        if (StringUtils.isNotBlank(categories)) {
 73 | //            paramPredicate.and(post -> contains(Set.copyOf(List.of(categories.split(","))), post.getSpec().getCategories()));
 74 | //        }
 75 | //        if (StringUtils.isNotBlank(tag)) {
 76 | //            paramPredicate.and(post -> contains(Set.copyOf(List.of(tag.split(","))), post.getSpec().getTags()));
 77 | //        }
 78 | 
 79 | 
 80 |         ListResult<Post> listResult = client.list(Post.class, paramPredicate, null, 1, pageSize);
 81 | 
 82 | 
 83 |         //分页导出数据
 84 |         //分页获取文章并处理
 85 |         for (int i = 1; i <= listResult.getTotalPages(); i++) {
 86 |             ListResult<Post> posts = client.list(Post.class, paramPredicate, null, i, pageSize);
 87 |             posts.getItems().forEach(post -> {
 88 |                 writePost(post.getMetadata().getName(), exportLogSchema.getName());
 89 |             });
 90 |         }
 91 |         //打包文件
 92 |         File absoluteFile = FileUtil.getDocFile(FileUtil.DirPath.EXPORT).toFile().getAbsoluteFile();
 93 |         ZipUtil.zip(absoluteFile + "/" + exportLogSchema.getName(), absoluteFile + "/" + exportLogSchema.getName() + ".zip");
 94 | 
 95 |         //修改状态
 96 |         client.fetch(ExportLogSchema.class, exportLogSchema.getMetadata().getName())
 97 |                 .ifPresent(exportLog -> {
 98 |                     long now = System.currentTimeMillis();
 99 |                     exportLog.setCostSeconds(now - old);
100 |                     exportLog.setStatus("c");
101 |                     client.update(exportLog);
102 |                 });
103 |     }
104 | 
105 |     /**
106 |      * 写文件
107 |      *
108 |      * @param items
109 |      * @param dirName 导出计划名称-保存文件夹
110 |      */
111 | //    private void detailPost(List<Post> items, String dirName) {
112 | //        for (Post post : items) {
113 | //            //获取文章详情
114 | //            client.fetch(Post.class, post.getMetadata().getName())
115 | //                    .ifPresent(wholePost -> {
116 | //                        //获取文章内容
117 | //                        String releaseSnapshot = wholePost.getSpec().getReleaseSnapshot();
118 | //                        ContentWrapper content = getContent(releaseSnapshot, wholePost.getSpec().getBaseSnapshot());
119 | //                        if (null != content) {
120 | //                            writeContent(post, content, dirName);
121 | //                        }
122 | //                    });
123 | //        }
124 | //    }
125 | 
126 |     /**
127 |      * 将文章到文件里
128 |      *
129 |      * @param name 文章的name
130 |      * @param path 保存的文件夹(上一级)
131 |      */
132 |     public String writePost(String name, String path) {
133 |         Optional<Post> fetch = client.fetch(Post.class, name);
134 |         if (fetch.isPresent()) {
135 |             Post wholePost = fetch.get();
136 |             //获取文章内容
137 |             String releaseSnapshot = wholePost.getSpec().getReleaseSnapshot();
138 |             ContentWrapper content = getContent(releaseSnapshot, wholePost.getSpec().getBaseSnapshot());
139 |             if (null != content) {
140 |                 return writeContent(wholePost, content, path);
141 |             }
142 |         }
143 |         return "";
144 |     }
145 | 
146 |     /**
147 |      * 写入文件内容
148 |      *
149 |      * @param post
150 |      * @param content
151 |      * @param path
152 |      */
153 |     private String writeContent(Post post, ContentWrapper content, String path) {
154 |         Path docFile = FileUtil.getDocFile(FileUtil.DirPath.EXPORT);
155 |         //文件夹
156 |         File dir = new File(docFile.toFile().getAbsoluteFile() + "/" + path);
157 |         //判读文件夹是否存在
158 |         if (!dir.exists()) {
159 |             dir.mkdirs();
160 |         }
161 | 
162 |         //markdown | html | json | asciidoc | latex
163 |         String extendName = extendNameMap.get(StringUtils.lowerCase(content.getRawType()));
164 | 
165 |         //判断文件名是否合法
166 |         String fileName = post.getSpec().getTitle();
167 |         if (!FileUtil.isCorrectName(fileName)) {
168 |             fileName = post.getSpec().getSlug();
169 |         }
170 |         String finalFileName = dir.getAbsoluteFile() + "/" + fileName + extendName;
171 | 
172 | 
173 |         try {
174 |             File file = new File(finalFileName);
175 |             BufferedWriter writer = new BufferedWriter(new FileWriter(file));
176 |             //markdown文件的属性
177 |             if (StringUtils.equals(extendName, ".md")) {
178 |                 Post.PostStatus postStatus = post.getStatus();
179 |                 Post.PostSpec postSpec = post.getSpec();
180 |                 MetadataOperator postMetadata = post.getMetadata();
181 |                 //  ---
182 |                 //  title: 快速开始
183 |                 //  date: 2023-10-22 16:56:20
184 |                 //  permalink: /pages/quickStart/
185 |                 //  categories:
186 |                 //  - cate1
187 |                 //  tags:
188 |                 //  - tag1
189 |                 //  ---
190 |                 writer.write("---\n");
191 |                 writer.write(String.format("title: %s\n", postSpec.getTitle()));
192 |                 writer.write(String.format("id: %s\n", postMetadata.getName()));
193 | 
194 |                 DateTimeFormatter formatter = DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss");
195 |                 String formatDate = postMetadata.getCreationTimestamp().atZone(ZoneId.systemDefault()).format(formatter);
196 |                 writer.write(String.format("date: %s\n", formatDate));
197 | 
198 |                 writer.write(String.format("auther: %s\n", postSpec.getOwner()));
199 |                 writer.write(String.format("cover: %s\n", postSpec.getCover()));
200 |                 //摘录 不允许存在:和\n
201 |                 writer.write(String.format("excerpt: %s\n", postStatus.getExcerpt().replaceAll("\n", "").replaceAll(":","")));
202 |                 //永久链接
203 |                 writer.write(String.format("permalink: %s\n", postStatus.getPermalink()));
204 |                 //分类
205 |                 //分类-1 获取全部分类
206 |                 if (postSpec.getCategories() != null) {
207 |                     writer.write("categories:\n");
208 |                     for (String category : postSpec.getCategories()) {
209 |                         writer.write(String.format(" - %s\n", getCateTrueName(category)));
210 |                     }
211 |                 }
212 |                 //标签
213 |                 if (postSpec.getTags() != null) {
214 |                     writer.write("tags: \n");
215 |                     for (String tag : postSpec.getTags()) {
216 |                         writer.write(String.format(" - %s\n", getTagTrueName(tag)));
217 |                     }
218 |                 }
219 |                 writer.write("---\n\n");
220 |             }
221 | 
222 |             //内容
223 |             writer.write(content.getRaw());
224 |             writer.flush();
225 |             log.warn("写文件:{}-{}", content.getRawType(), file.getAbsolutePath());
226 |         } catch (IOException e) {
227 |             throw new RuntimeException(e);
228 |         }
229 |         return finalFileName;
230 |     }
231 | 
232 |     /**
233 |      * 根据id来查询真是的分类名称
234 |      *
235 |      * @param name
236 |      * @return
237 |      */
238 |     private String getCateTrueName(String name) {
239 |         Map<String, String> map = CatePool.get();
240 |         if (null == map) {
241 |             map = new HashMap<>();
242 |         }
243 |         String cateName = map.get(name);
244 | 
245 |         if (StringUtils.isNotBlank(cateName)) {
246 |             return cateName;
247 |         } else {
248 |             //查询
249 |             Optional<Category> fetch = client.fetch(Category.class, name);
250 |             if (fetch.isPresent()) {
251 |                 Category category = fetch.get();
252 |                 map.put(name, category.getSpec().getSlug());
253 |                 return category.getSpec().getSlug();
254 |             } else {
255 |                 //没有找到合适的
256 |                 return name;
257 |             }
258 |         }
259 |     }
260 | 
261 |     /**
262 |      * 根据id查找tag
263 |      *
264 |      * @param name
265 |      * @return
266 |      */
267 |     private String getTagTrueName(String name) {
268 |         Map<String, String> map = TagPool.get();
269 |         if (null == map) {
270 |             map = new HashMap<>();
271 |         }
272 |         String tagName = map.get(name);
273 |         if (StringUtils.isNotBlank(tagName)) {
274 |             return tagName;
275 |         } else {
276 |             //查询
277 |             Optional<Tag> fetch = client.fetch(Tag.class, name);
278 |             if (fetch.isPresent()) {
279 |                 Tag tag = fetch.get();
280 |                 map.put(name, tag.getSpec().getSlug());
281 |                 return tag.getSpec().getSlug();
282 |             } else {
283 |                 return name;
284 |             }
285 |         }
286 |     }
287 | 
288 | 
289 | 
290 |     /**
291 |      * 获取文章详情
292 |      *
293 |      * @param snapshotName
294 |      * @param baseSnapshotName
295 |      * @return
296 |      */
297 |     public ContentWrapper getContent(String snapshotName, String baseSnapshotName) {
298 |         if (StringUtils.isBlank(snapshotName) || StringUtils.isBlank(baseSnapshotName)) {
299 |             return null;
300 |         }
301 |         AtomicReference<ContentWrapper> wrapper = new AtomicReference<>(null);
302 |         // TODO: refactor this method to use client.get instead of fetch but please be careful
303 |         client.fetch(Snapshot.class, baseSnapshotName)
304 |                 .ifPresent(baseSnapshot -> {
305 |                     checkBaseSnapshot(baseSnapshot);
306 |                     if (StringUtils.equals(snapshotName, baseSnapshotName)) {
307 |                         wrapper.set(ContentWrapper.patchSnapshot(baseSnapshot, baseSnapshot));
308 |                     }
309 |                     client.fetch(Snapshot.class, snapshotName)
310 |                             .ifPresent(snapshot ->
311 |                                     wrapper.set(ContentWrapper.patchSnapshot(snapshot, baseSnapshot)));
312 |                 });
313 | 
314 |         return wrapper.get();
315 |     }
316 | 
317 |     protected void checkBaseSnapshot(Snapshot snapshot) {
318 |         Assert.notNull(snapshot, "The snapshot must not be null.");
319 |         String keepRawAnno =
320 |                 MetadataUtil.nullSafeAnnotations(snapshot).get(Snapshot.KEEP_RAW_ANNO);
321 |         if (!StringUtils.equals(Boolean.TRUE.toString(), keepRawAnno)) {
322 |             throw new IllegalArgumentException(
323 |                     String.format("The snapshot [%s] is not a base snapshot.",
324 |                             snapshot.getMetadata().getName()));
325 |         }
326 |     }
327 | 
328 |     public void delete(String name) {
329 | 
330 |         String fileName = FileUtil.getDocFile(FileUtil.DirPath.EXPORT).toFile().getAbsolutePath() + "/" + name;
331 | 
332 |         //删除文件夹
333 |         cn.hutool.core.io.FileUtil.del(fileName);
334 |         //删除压缩文件
335 |         cn.hutool.core.io.FileUtil.del(fileName + ".zip");
336 | 
337 | 
338 |     }
339 | }
340 | 
341 | 
342 | 
343 | 


--------------------------------------------------------------------------------
/.editorconfig:
--------------------------------------------------------------------------------
  1 | [*]
  2 | charset = utf-8
  3 | end_of_line = lf
  4 | indent_size = 4
  5 | indent_style = space
  6 | insert_final_newline = false
  7 | max_line_length = 120
  8 | tab_width = 4
  9 | ij_continuation_indent_size = 8
 10 | ij_formatter_off_tag = @formatter:off
 11 | ij_formatter_on_tag = @formatter:on
 12 | ij_formatter_tags_enabled = false
 13 | ij_smart_tabs = false
 14 | ij_wrap_on_typing = false
 15 | 
 16 | [*.java]
 17 | max_line_length = 100
 18 | ij_continuation_indent_size = 4
 19 | ij_java_align_consecutive_assignments = false
 20 | ij_java_align_consecutive_variable_declarations = false
 21 | ij_java_align_group_field_declarations = false
 22 | ij_java_align_multiline_annotation_parameters = false
 23 | ij_java_align_multiline_array_initializer_expression = false
 24 | ij_java_align_multiline_assignment = false
 25 | ij_java_align_multiline_binary_operation = false
 26 | ij_java_align_multiline_chained_methods = false
 27 | ij_java_align_multiline_extends_list = false
 28 | ij_java_align_multiline_for = true
 29 | ij_java_align_multiline_method_parentheses = false
 30 | ij_java_align_multiline_parameters = false
 31 | ij_java_align_multiline_parameters_in_calls = false
 32 | ij_java_align_multiline_parenthesized_expression = false
 33 | ij_java_align_multiline_records = true
 34 | ij_java_align_multiline_resources = true
 35 | ij_java_align_multiline_ternary_operation = false
 36 | ij_java_align_multiline_text_blocks = false
 37 | ij_java_align_multiline_throws_list = false
 38 | ij_java_align_subsequent_simple_methods = false
 39 | ij_java_align_throws_keyword = false
 40 | ij_java_annotation_parameter_wrap = off
 41 | ij_java_array_initializer_new_line_after_left_brace = false
 42 | ij_java_array_initializer_right_brace_on_new_line = false
 43 | ij_java_array_initializer_wrap = normal
 44 | ij_java_assert_statement_colon_on_next_line = false
 45 | ij_java_assert_statement_wrap = normal
 46 | ij_java_assignment_wrap = normal
 47 | ij_java_binary_operation_sign_on_next_line = true
 48 | ij_java_binary_operation_wrap = normal
 49 | ij_java_blank_lines_after_anonymous_class_header = 0
 50 | ij_java_blank_lines_after_class_header = 0
 51 | ij_java_blank_lines_after_imports = 1
 52 | ij_java_blank_lines_after_package = 1
 53 | ij_java_blank_lines_around_class = 1
 54 | ij_java_blank_lines_around_field = 0
 55 | ij_java_blank_lines_around_field_in_interface = 0
 56 | ij_java_blank_lines_around_initializer = 1
 57 | ij_java_blank_lines_around_method = 1
 58 | ij_java_blank_lines_around_method_in_interface = 1
 59 | ij_java_blank_lines_before_class_end = 0
 60 | ij_java_blank_lines_before_imports = 0
 61 | ij_java_blank_lines_before_method_body = 0
 62 | ij_java_blank_lines_before_package = 1
 63 | ij_java_block_brace_style = end_of_line
 64 | ij_java_block_comment_at_first_column = false
 65 | ij_java_call_parameters_new_line_after_left_paren = false
 66 | ij_java_call_parameters_right_paren_on_new_line = false
 67 | ij_java_call_parameters_wrap = normal
 68 | ij_java_case_statement_on_separate_line = true
 69 | ij_java_catch_on_new_line = false
 70 | ij_java_class_annotation_wrap = split_into_lines
 71 | ij_java_class_brace_style = end_of_line
 72 | ij_java_class_count_to_use_import_on_demand = 999
 73 | ij_java_class_names_in_javadoc = 1
 74 | ij_java_do_not_indent_top_level_class_members = false
 75 | ij_java_do_not_wrap_after_single_annotation = false
 76 | ij_java_do_while_brace_force = always
 77 | ij_java_doc_add_blank_line_after_description = true
 78 | ij_java_doc_add_blank_line_after_param_comments = false
 79 | ij_java_doc_add_blank_line_after_return = false
 80 | ij_java_doc_add_p_tag_on_empty_lines = true
 81 | ij_java_doc_align_exception_comments = true
 82 | ij_java_doc_align_param_comments = false
 83 | ij_java_doc_do_not_wrap_if_one_line = false
 84 | ij_java_doc_enable_formatting = true
 85 | ij_java_doc_enable_leading_asterisks = true
 86 | ij_java_doc_indent_on_continuation = false
 87 | ij_java_doc_keep_empty_lines = true
 88 | ij_java_doc_keep_empty_parameter_tag = true
 89 | ij_java_doc_keep_empty_return_tag = true
 90 | ij_java_doc_keep_empty_throws_tag = true
 91 | ij_java_doc_keep_invalid_tags = true
 92 | ij_java_doc_param_description_on_new_line = false
 93 | ij_java_doc_preserve_line_breaks = false
 94 | ij_java_doc_use_throws_not_exception_tag = true
 95 | ij_java_else_on_new_line = false
 96 | ij_java_enum_constants_wrap = normal
 97 | ij_java_extends_keyword_wrap = normal
 98 | ij_java_extends_list_wrap = normal
 99 | ij_java_field_annotation_wrap = split_into_lines
100 | ij_java_finally_on_new_line = false
101 | ij_java_for_brace_force = always
102 | ij_java_for_statement_new_line_after_left_paren = false
103 | ij_java_for_statement_right_paren_on_new_line = false
104 | ij_java_for_statement_wrap = normal
105 | ij_java_generate_final_locals = false
106 | ij_java_generate_final_parameters = false
107 | ij_java_if_brace_force = always
108 | ij_java_imports_layout = $*, |, *, |, *
109 | ij_java_indent_case_from_switch = true
110 | ij_java_insert_inner_class_imports = false
111 | ij_java_insert_override_annotation = true
112 | ij_java_keep_blank_lines_before_right_brace = 2
113 | ij_java_keep_blank_lines_between_package_declaration_and_header = 2
114 | ij_java_keep_blank_lines_in_code = 2
115 | ij_java_keep_blank_lines_in_declarations = 2
116 | ij_java_keep_control_statement_in_one_line = true
117 | ij_java_keep_first_column_comment = true
118 | ij_java_keep_indents_on_empty_lines = false
119 | ij_java_keep_line_breaks = true
120 | ij_java_keep_multiple_expressions_in_one_line = false
121 | ij_java_keep_simple_blocks_in_one_line = false
122 | ij_java_keep_simple_classes_in_one_line = false
123 | ij_java_keep_simple_lambdas_in_one_line = false
124 | ij_java_keep_simple_methods_in_one_line = false
125 | ij_java_label_indent_absolute = false
126 | ij_java_label_indent_size = 0
127 | ij_java_lambda_brace_style = end_of_line
128 | ij_java_layout_static_imports_separately = true
129 | ij_java_line_comment_add_space = true
130 | ij_java_line_comment_at_first_column = false
131 | ij_java_method_annotation_wrap = split_into_lines
132 | ij_java_method_brace_style = end_of_line
133 | ij_java_method_call_chain_wrap = normal
134 | ij_java_method_parameters_new_line_after_left_paren = false
135 | ij_java_method_parameters_right_paren_on_new_line = false
136 | ij_java_method_parameters_wrap = normal
137 | ij_java_modifier_list_wrap = false
138 | ij_java_names_count_to_use_import_on_demand = 999
139 | ij_java_new_line_after_lparen_in_record_header = false
140 | ij_java_parameter_annotation_wrap = normal
141 | ij_java_parentheses_expression_new_line_after_left_paren = false
142 | ij_java_parentheses_expression_right_paren_on_new_line = false
143 | ij_java_place_assignment_sign_on_next_line = false
144 | ij_java_prefer_longer_names = true
145 | ij_java_prefer_parameters_wrap = false
146 | ij_java_record_components_wrap = normal
147 | ij_java_repeat_synchronized = true
148 | ij_java_replace_instanceof_and_cast = false
149 | ij_java_replace_null_check = true
150 | ij_java_replace_sum_lambda_with_method_ref = true
151 | ij_java_resource_list_new_line_after_left_paren = false
152 | ij_java_resource_list_right_paren_on_new_line = false
153 | ij_java_resource_list_wrap = normal
154 | ij_java_rparen_on_new_line_in_record_header = false
155 | ij_java_space_after_closing_angle_bracket_in_type_argument = false
156 | ij_java_space_after_colon = true
157 | ij_java_space_after_comma = true
158 | ij_java_space_after_comma_in_type_arguments = true
159 | ij_java_space_after_for_semicolon = true
160 | ij_java_space_after_quest = true
161 | ij_java_space_after_type_cast = true
162 | ij_java_space_before_annotation_array_initializer_left_brace = false
163 | ij_java_space_before_annotation_parameter_list = false
164 | ij_java_space_before_array_initializer_left_brace = true
165 | ij_java_space_before_catch_keyword = true
166 | ij_java_space_before_catch_left_brace = true
167 | ij_java_space_before_catch_parentheses = true
168 | ij_java_space_before_class_left_brace = true
169 | ij_java_space_before_colon = true
170 | ij_java_space_before_colon_in_foreach = true
171 | ij_java_space_before_comma = false
172 | ij_java_space_before_do_left_brace = true
173 | ij_java_space_before_else_keyword = true
174 | ij_java_space_before_else_left_brace = true
175 | ij_java_space_before_finally_keyword = true
176 | ij_java_space_before_finally_left_brace = true
177 | ij_java_space_before_for_left_brace = true
178 | ij_java_space_before_for_parentheses = true
179 | ij_java_space_before_for_semicolon = false
180 | ij_java_space_before_if_left_brace = true
181 | ij_java_space_before_if_parentheses = true
182 | ij_java_space_before_method_call_parentheses = false
183 | ij_java_space_before_method_left_brace = true
184 | ij_java_space_before_method_parentheses = false
185 | ij_java_space_before_opening_angle_bracket_in_type_parameter = false
186 | ij_java_space_before_quest = true
187 | ij_java_space_before_switch_left_brace = true
188 | ij_java_space_before_switch_parentheses = true
189 | ij_java_space_before_synchronized_left_brace = true
190 | ij_java_space_before_synchronized_parentheses = true
191 | ij_java_space_before_try_left_brace = true
192 | ij_java_space_before_try_parentheses = true
193 | ij_java_space_before_type_parameter_list = false
194 | ij_java_space_before_while_keyword = true
195 | ij_java_space_before_while_left_brace = true
196 | ij_java_space_before_while_parentheses = true
197 | ij_java_space_inside_one_line_enum_braces = false
198 | ij_java_space_within_empty_array_initializer_braces = false
199 | ij_java_space_within_empty_method_call_parentheses = false
200 | ij_java_space_within_empty_method_parentheses = false
201 | ij_java_spaces_around_additive_operators = true
202 | ij_java_spaces_around_assignment_operators = true
203 | ij_java_spaces_around_bitwise_operators = true
204 | ij_java_spaces_around_equality_operators = true
205 | ij_java_spaces_around_lambda_arrow = true
206 | ij_java_spaces_around_logical_operators = true
207 | ij_java_spaces_around_method_ref_dbl_colon = false
208 | ij_java_spaces_around_multiplicative_operators = true
209 | ij_java_spaces_around_relational_operators = true
210 | ij_java_spaces_around_shift_operators = true
211 | ij_java_spaces_around_type_bounds_in_type_parameters = true
212 | ij_java_spaces_around_unary_operator = false
213 | ij_java_spaces_within_angle_brackets = false
214 | ij_java_spaces_within_annotation_parentheses = false
215 | ij_java_spaces_within_array_initializer_braces = false
216 | ij_java_spaces_within_braces = false
217 | ij_java_spaces_within_brackets = false
218 | ij_java_spaces_within_cast_parentheses = false
219 | ij_java_spaces_within_catch_parentheses = false
220 | ij_java_spaces_within_for_parentheses = false
221 | ij_java_spaces_within_if_parentheses = false
222 | ij_java_spaces_within_method_call_parentheses = false
223 | ij_java_spaces_within_method_parentheses = false
224 | ij_java_spaces_within_parentheses = false
225 | ij_java_spaces_within_switch_parentheses = false
226 | ij_java_spaces_within_synchronized_parentheses = false
227 | ij_java_spaces_within_try_parentheses = false
228 | ij_java_spaces_within_while_parentheses = false
229 | ij_java_special_else_if_treatment = true
230 | ij_java_subclass_name_suffix = Impl
231 | ij_java_ternary_operation_signs_on_next_line = true
232 | ij_java_ternary_operation_wrap = normal
233 | ij_java_test_name_suffix = Test
234 | ij_java_throws_keyword_wrap = normal
235 | ij_java_throws_list_wrap = normal
236 | ij_java_use_external_annotations = false
237 | ij_java_use_fq_class_names = false
238 | ij_java_use_relative_indents = false
239 | ij_java_use_single_class_imports = true
240 | ij_java_variable_annotation_wrap = normal
241 | ij_java_visibility = public
242 | ij_java_while_brace_force = always
243 | ij_java_while_on_new_line = false
244 | ij_java_wrap_comments = false
245 | ij_java_wrap_first_method_in_call_chain = false
246 | ij_java_wrap_long_lines = true
247 | 
248 | [*.properties]
249 | ij_properties_align_group_field_declarations = false
250 | ij_properties_keep_blank_lines = false
251 | ij_properties_key_value_delimiter = equals
252 | ij_properties_spaces_around_key_value_delimiter = false
253 | 
254 | [.editorconfig]
255 | ij_editorconfig_align_group_field_declarations = false
256 | ij_editorconfig_space_after_colon = false
257 | ij_editorconfig_space_after_comma = true
258 | ij_editorconfig_space_before_colon = false
259 | ij_editorconfig_space_before_comma = false
260 | ij_editorconfig_spaces_around_assignment_operators = true
261 | 
262 | [{*.ant, *.fxml, *.jhm, *.jnlp, *.jrxml, *.jspx, *.pom, *.rng, *.tagx, *.tld, *.wsdl, *.xml, *.xsd, *.xsl, *.xslt, *.xul}]
263 | ij_xml_align_attributes = true
264 | ij_xml_align_text = false
265 | ij_xml_attribute_wrap = normal
266 | ij_xml_block_comment_at_first_column = true
267 | ij_xml_keep_blank_lines = 2
268 | ij_xml_keep_indents_on_empty_lines = false
269 | ij_xml_keep_line_breaks = true
270 | ij_xml_keep_line_breaks_in_text = true
271 | ij_xml_keep_whitespaces = false
272 | ij_xml_keep_whitespaces_around_cdata = preserve
273 | ij_xml_keep_whitespaces_inside_cdata = false
274 | ij_xml_line_comment_at_first_column = true
275 | ij_xml_space_after_tag_name = false
276 | ij_xml_space_around_equals_in_attribute = false
277 | ij_xml_space_inside_empty_tag = false
278 | ij_xml_text_wrap = normal
279 | 
280 | [{*.bash, *.sh, *.zsh}]
281 | indent_size = 2
282 | tab_width = 2
283 | ij_shell_binary_ops_start_line = false
284 | ij_shell_keep_column_alignment_padding = false
285 | ij_shell_minify_program = false
286 | ij_shell_redirect_followed_by_space = false
287 | ij_shell_switch_cases_indented = false
288 | 
289 | [{*.gant, *.gradle, *.groovy, *.gy}]
290 | ij_groovy_align_group_field_declarations = false
291 | ij_groovy_align_multiline_array_initializer_expression = false
292 | ij_groovy_align_multiline_assignment = false
293 | ij_groovy_align_multiline_binary_operation = false
294 | ij_groovy_align_multiline_chained_methods = false
295 | ij_groovy_align_multiline_extends_list = false
296 | ij_groovy_align_multiline_for = true
297 | ij_groovy_align_multiline_list_or_map = true
298 | ij_groovy_align_multiline_method_parentheses = false
299 | ij_groovy_align_multiline_parameters = true
300 | ij_groovy_align_multiline_parameters_in_calls = false
301 | ij_groovy_align_multiline_resources = true
302 | ij_groovy_align_multiline_ternary_operation = false
303 | ij_groovy_align_multiline_throws_list = false
304 | ij_groovy_align_named_args_in_map = true
305 | ij_groovy_align_throws_keyword = false
306 | ij_groovy_array_initializer_new_line_after_left_brace = false
307 | ij_groovy_array_initializer_right_brace_on_new_line = false
308 | ij_groovy_array_initializer_wrap = off
309 | ij_groovy_assert_statement_wrap = off
310 | ij_groovy_assignment_wrap = off
311 | ij_groovy_binary_operation_wrap = off
312 | ij_groovy_blank_lines_after_class_header = 0
313 | ij_groovy_blank_lines_after_imports = 1
314 | ij_groovy_blank_lines_after_package = 1
315 | ij_groovy_blank_lines_around_class = 1
316 | ij_groovy_blank_lines_around_field = 0
317 | ij_groovy_blank_lines_around_field_in_interface = 0
318 | ij_groovy_blank_lines_around_method = 1
319 | ij_groovy_blank_lines_around_method_in_interface = 1
320 | ij_groovy_blank_lines_before_imports = 1
321 | ij_groovy_blank_lines_before_method_body = 0
322 | ij_groovy_blank_lines_before_package = 0
323 | ij_groovy_block_brace_style = end_of_line
324 | ij_groovy_block_comment_at_first_column = true
325 | ij_groovy_call_parameters_new_line_after_left_paren = false
326 | ij_groovy_call_parameters_right_paren_on_new_line = false
327 | ij_groovy_call_parameters_wrap = off
328 | ij_groovy_catch_on_new_line = false
329 | ij_groovy_class_annotation_wrap = split_into_lines
330 | ij_groovy_class_brace_style = end_of_line
331 | ij_groovy_class_count_to_use_import_on_demand = 5
332 | ij_groovy_do_while_brace_force = never
333 | ij_groovy_else_on_new_line = false
334 | ij_groovy_enum_constants_wrap = off
335 | ij_groovy_extends_keyword_wrap = off
336 | ij_groovy_extends_list_wrap = off
337 | ij_groovy_field_annotation_wrap = split_into_lines
338 | ij_groovy_finally_on_new_line = false
339 | ij_groovy_for_brace_force = never
340 | ij_groovy_for_statement_new_line_after_left_paren = false
341 | ij_groovy_for_statement_right_paren_on_new_line = false
342 | ij_groovy_for_statement_wrap = off
343 | ij_groovy_if_brace_force = never
344 | ij_groovy_import_annotation_wrap = 2
345 | ij_groovy_indent_case_from_switch = true
346 | ij_groovy_indent_label_blocks = true
347 | ij_groovy_insert_inner_class_imports = false
348 | ij_groovy_keep_blank_lines_before_right_brace = 2
349 | ij_groovy_keep_blank_lines_in_code = 2
350 | ij_groovy_keep_blank_lines_in_declarations = 2
351 | ij_groovy_keep_control_statement_in_one_line = true
352 | ij_groovy_keep_first_column_comment = true
353 | ij_groovy_keep_indents_on_empty_lines = false
354 | ij_groovy_keep_line_breaks = true
355 | ij_groovy_keep_multiple_expressions_in_one_line = false
356 | ij_groovy_keep_simple_blocks_in_one_line = false
357 | ij_groovy_keep_simple_classes_in_one_line = true
358 | ij_groovy_keep_simple_lambdas_in_one_line = true
359 | ij_groovy_keep_simple_methods_in_one_line = true
360 | ij_groovy_label_indent_absolute = false
361 | ij_groovy_label_indent_size = 0
362 | ij_groovy_lambda_brace_style = end_of_line
363 | ij_groovy_layout_static_imports_separately = true
364 | ij_groovy_line_comment_add_space = false
365 | ij_groovy_line_comment_at_first_column = true
366 | ij_groovy_method_annotation_wrap = split_into_lines
367 | ij_groovy_method_brace_style = end_of_line
368 | ij_groovy_method_call_chain_wrap = off
369 | ij_groovy_method_parameters_new_line_after_left_paren = false
370 | ij_groovy_method_parameters_right_paren_on_new_line = false
371 | ij_groovy_method_parameters_wrap = off
372 | ij_groovy_modifier_list_wrap = false
373 | ij_groovy_names_count_to_use_import_on_demand = 3
374 | ij_groovy_parameter_annotation_wrap = off
375 | ij_groovy_parentheses_expression_new_line_after_left_paren = false
376 | ij_groovy_parentheses_expression_right_paren_on_new_line = false
377 | ij_groovy_prefer_parameters_wrap = false
378 | ij_groovy_resource_list_new_line_after_left_paren = false
379 | ij_groovy_resource_list_right_paren_on_new_line = false
380 | ij_groovy_resource_list_wrap = off
381 | ij_groovy_space_after_assert_separator = true
382 | ij_groovy_space_after_colon = true
383 | ij_groovy_space_after_comma = true
384 | ij_groovy_space_after_comma_in_type_arguments = true
385 | ij_groovy_space_after_for_semicolon = true
386 | ij_groovy_space_after_quest = true
387 | ij_groovy_space_after_type_cast = true
388 | ij_groovy_space_before_annotation_parameter_list = false
389 | ij_groovy_space_before_array_initializer_left_brace = false
390 | ij_groovy_space_before_assert_separator = false
391 | ij_groovy_space_before_catch_keyword = true
392 | ij_groovy_space_before_catch_left_brace = true
393 | ij_groovy_space_before_catch_parentheses = true
394 | ij_groovy_space_before_class_left_brace = true
395 | ij_groovy_space_before_closure_left_brace = true
396 | ij_groovy_space_before_colon = true
397 | ij_groovy_space_before_comma = false
398 | ij_groovy_space_before_do_left_brace = true
399 | ij_groovy_space_before_else_keyword = true
400 | ij_groovy_space_before_else_left_brace = true
401 | ij_groovy_space_before_finally_keyword = true
402 | ij_groovy_space_before_finally_left_brace = true
403 | ij_groovy_space_before_for_left_brace = true
404 | ij_groovy_space_before_for_parentheses = true
405 | ij_groovy_space_before_for_semicolon = false
406 | ij_groovy_space_before_if_left_brace = true
407 | ij_groovy_space_before_if_parentheses = true
408 | ij_groovy_space_before_method_call_parentheses = false
409 | ij_groovy_space_before_method_left_brace = true
410 | ij_groovy_space_before_method_parentheses = false
411 | ij_groovy_space_before_quest = true
412 | ij_groovy_space_before_switch_left_brace = true
413 | ij_groovy_space_before_switch_parentheses = true
414 | ij_groovy_space_before_synchronized_left_brace = true
415 | ij_groovy_space_before_synchronized_parentheses = true
416 | ij_groovy_space_before_try_left_brace = true
417 | ij_groovy_space_before_try_parentheses = true
418 | ij_groovy_space_before_while_keyword = true
419 | ij_groovy_space_before_while_left_brace = true
420 | ij_groovy_space_before_while_parentheses = true
421 | ij_groovy_space_in_named_argument = true
422 | ij_groovy_space_in_named_argument_before_colon = false
423 | ij_groovy_space_within_empty_array_initializer_braces = false
424 | ij_groovy_space_within_empty_method_call_parentheses = false
425 | ij_groovy_spaces_around_additive_operators = true
426 | ij_groovy_spaces_around_assignment_operators = true
427 | ij_groovy_spaces_around_bitwise_operators = true
428 | ij_groovy_spaces_around_equality_operators = true
429 | ij_groovy_spaces_around_lambda_arrow = true
430 | ij_groovy_spaces_around_logical_operators = true
431 | ij_groovy_spaces_around_multiplicative_operators = true
432 | ij_groovy_spaces_around_regex_operators = true
433 | ij_groovy_spaces_around_relational_operators = true
434 | ij_groovy_spaces_around_shift_operators = true
435 | ij_groovy_spaces_within_annotation_parentheses = false
436 | ij_groovy_spaces_within_array_initializer_braces = false
437 | ij_groovy_spaces_within_braces = true
438 | ij_groovy_spaces_within_brackets = false
439 | ij_groovy_spaces_within_cast_parentheses = false
440 | ij_groovy_spaces_within_catch_parentheses = false
441 | ij_groovy_spaces_within_for_parentheses = false
442 | ij_groovy_spaces_within_gstring_injection_braces = false
443 | ij_groovy_spaces_within_if_parentheses = false
444 | ij_groovy_spaces_within_list_or_map = false
445 | ij_groovy_spaces_within_method_call_parentheses = false
446 | ij_groovy_spaces_within_method_parentheses = false
447 | ij_groovy_spaces_within_parentheses = false
448 | ij_groovy_spaces_within_switch_parentheses = false
449 | ij_groovy_spaces_within_synchronized_parentheses = false
450 | ij_groovy_spaces_within_try_parentheses = false
451 | ij_groovy_spaces_within_tuple_expression = false
452 | ij_groovy_spaces_within_while_parentheses = false
453 | ij_groovy_special_else_if_treatment = true
454 | ij_groovy_ternary_operation_wrap = off
455 | ij_groovy_throws_keyword_wrap = off
456 | ij_groovy_throws_list_wrap = off
457 | ij_groovy_use_flying_geese_braces = false
458 | ij_groovy_use_fq_class_names = false
459 | ij_groovy_use_fq_class_names_in_javadoc = true
460 | ij_groovy_use_relative_indents = false
461 | ij_groovy_use_single_class_imports = true
462 | ij_groovy_variable_annotation_wrap = off
463 | ij_groovy_while_brace_force = never
464 | ij_groovy_while_on_new_line = false
465 | ij_groovy_wrap_long_lines = false
466 | 
467 | [{*.har, *.json}]
468 | indent_size = 2
469 | ij_json_keep_blank_lines_in_code = 0
470 | ij_json_keep_indents_on_empty_lines = false
471 | ij_json_keep_line_breaks = true
472 | ij_json_space_after_colon = true
473 | ij_json_space_after_comma = true
474 | ij_json_space_before_colon = true
475 | ij_json_space_before_comma = false
476 | ij_json_spaces_within_braces = false
477 | ij_json_spaces_within_brackets = false
478 | ij_json_wrap_long_lines = false
479 | 
480 | [{*.htm, *.html, *.sht, *.shtm, *.shtml}]
481 | ij_html_add_new_line_before_tags = body, div, p, form, h1, h2, h3
482 | ij_html_align_attributes = true
483 | ij_html_align_text = false
484 | ij_html_attribute_wrap = normal
485 | ij_html_block_comment_at_first_column = true
486 | ij_html_do_not_align_children_of_min_lines = 0
487 | ij_html_do_not_break_if_inline_tags = title, h1, h2, h3, h4, h5, h6, p
488 | ij_html_do_not_indent_children_of_tags = html, body, thead, tbody, tfoot
489 | ij_html_enforce_quotes = false
490 | ij_html_inline_tags = a, abbr, acronym, b, basefont, bdo, big, br, cite, cite, code, dfn, em, font, i, img, input, kbd, label, q, s, samp, select, small, span, strike, strong, sub, sup, textarea, tt, u, var
491 | ij_html_keep_blank_lines = 2
492 | ij_html_keep_indents_on_empty_lines = false
493 | ij_html_keep_line_breaks = true
494 | ij_html_keep_line_breaks_in_text = true
495 | ij_html_keep_whitespaces = false
496 | ij_html_keep_whitespaces_inside = span, pre, textarea
497 | ij_html_line_comment_at_first_column = true
498 | ij_html_new_line_after_last_attribute = never
499 | ij_html_new_line_before_first_attribute = never
500 | ij_html_quote_style = double
501 | ij_html_remove_new_line_before_tags = br
502 | ij_html_space_after_tag_name = false
503 | ij_html_space_around_equality_in_attribute = false
504 | ij_html_space_inside_empty_tag = false
505 | ij_html_text_wrap = normal
506 | 
507 | [{*.yaml, *.yml}]
508 | indent_size = 2
509 | ij_yaml_keep_indents_on_empty_lines = false
510 | ij_yaml_keep_line_breaks = true
511 | 
512 | [*.{js,jsx,mjs,cjs,ts,tsx,mts,cts,vue,css,scss,sass,less,styl}]
513 | charset = utf-8
514 | indent_size = 2
515 | indent_style = space
516 | insert_final_newline = true
517 | trim_trailing_whitespace = true
518 | 
519 | end_of_line = lf
520 | max_line_length = 100
521 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
  1 |                     GNU GENERAL PUBLIC LICENSE
  2 |                        Version 3, 29 June 2007
  3 | 
  4 |  Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
  5 |  Everyone is permitted to copy and distribute verbatim copies
  6 |  of this license document, but changing it is not allowed.
  7 | 
  8 |                             Preamble
  9 | 
 10 |   The GNU General Public License is a free, copyleft license for
 11 | software and other kinds of works.
 12 | 
 13 |   The licenses for most software and other practical works are designed
 14 | to take away your freedom to share and change the works.  By contrast,
 15 | the GNU General Public License is intended to guarantee your freedom to
 16 | share and change all versions of a program--to make sure it remains free
 17 | software for all its users.  We, the Free Software Foundation, use the
 18 | GNU General Public License for most of our software; it applies also to
 19 | any other work released this way by its authors.  You can apply it to
 20 | your programs, too.
 21 | 
 22 |   When we speak of free software, we are referring to freedom, not
 23 | price.  Our General Public Licenses are designed to make sure that you
 24 | have the freedom to distribute copies of free software (and charge for
 25 | them if you wish), that you receive source code or can get it if you
 26 | want it, that you can change the software or use pieces of it in new
 27 | free programs, and that you know you can do these things.
 28 | 
 29 |   To protect your rights, we need to prevent others from denying you
 30 | these rights or asking you to surrender the rights.  Therefore, you have
 31 | certain responsibilities if you distribute copies of the software, or if
 32 | you modify it: responsibilities to respect the freedom of others.
 33 | 
 34 |   For example, if you distribute copies of such a program, whether
 35 | gratis or for a fee, you must pass on to the recipients the same
 36 | freedoms that you received.  You must make sure that they, too, receive
 37 | or can get the source code.  And you must show them these terms so they
 38 | know their rights.
 39 | 
 40 |   Developers that use the GNU GPL protect your rights with two steps:
 41 | (1) assert copyright on the software, and (2) offer you this License
 42 | giving you legal permission to copy, distribute and/or modify it.
 43 | 
 44 |   For the developers' and authors' protection, the GPL clearly explains
 45 | that there is no warranty for this free software.  For both users' and
 46 | authors' sake, the GPL requires that modified versions be marked as
 47 | changed, so that their problems will not be attributed erroneously to
 48 | authors of previous versions.
 49 | 
 50 |   Some devices are designed to deny users access to install or run
 51 | modified versions of the software inside them, although the manufacturer
 52 | can do so.  This is fundamentally incompatible with the aim of
 53 | protecting users' freedom to change the software.  The systematic
 54 | pattern of such abuse occurs in the area of products for individuals to
 55 | use, which is precisely where it is most unacceptable.  Therefore, we
 56 | have designed this version of the GPL to prohibit the practice for those
 57 | products.  If such problems arise substantially in other domains, we
 58 | stand ready to extend this provision to those domains in future versions
 59 | of the GPL, as needed to protect the freedom of users.
 60 | 
 61 |   Finally, every program is threatened constantly by software patents.
 62 | States should not allow patents to restrict development and use of
 63 | software on general-purpose computers, but in those that do, we wish to
 64 | avoid the special danger that patents applied to a free program could
 65 | make it effectively proprietary.  To prevent this, the GPL assures that
 66 | patents cannot be used to render the program non-free.
 67 | 
 68 |   The precise terms and conditions for copying, distribution and
 69 | modification follow.
 70 | 
 71 |                        TERMS AND CONDITIONS
 72 | 
 73 |   0. Definitions.
 74 | 
 75 |   "This License" refers to version 3 of the GNU General Public License.
 76 | 
 77 |   "Copyright" also means copyright-like laws that apply to other kinds of
 78 | works, such as semiconductor masks.
 79 | 
 80 |   "The Program" refers to any copyrightable work licensed under this
 81 | License.  Each licensee is addressed as "you".  "Licensees" and
 82 | "recipients" may be individuals or organizations.
 83 | 
 84 |   To "modify" a work means to copy from or adapt all or part of the work
 85 | in a fashion requiring copyright permission, other than the making of an
 86 | exact copy.  The resulting work is called a "modified version" of the
 87 | earlier work or a work "based on" the earlier work.
 88 | 
 89 |   A "covered work" means either the unmodified Program or a work based
 90 | on the Program.
 91 | 
 92 |   To "propagate" a work means to do anything with it that, without
 93 | permission, would make you directly or secondarily liable for
 94 | infringement under applicable copyright law, except executing it on a
 95 | computer or modifying a private copy.  Propagation includes copying,
 96 | distribution (with or without modification), making available to the
 97 | public, and in some countries other activities as well.
 98 | 
 99 |   To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies.  Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 | 
103 |   An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License.  If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 | 
112 |   1. Source Code.
113 | 
114 |   The "source code" for a work means the preferred form of the work
115 | for making modifications to it.  "Object code" means any non-source
116 | form of a work.
117 | 
118 |   A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 | 
123 |   The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form.  A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 | 
134 |   The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities.  However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work.  For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 | 
147 |   The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 | 
151 |   The Corresponding Source for a work in source code form is that
152 | same work.
153 | 
154 |   2. Basic Permissions.
155 | 
156 |   All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met.  This License explicitly affirms your unlimited
159 | permission to run the unmodified Program.  The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work.  This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 | 
164 |   You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force.  You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright.  Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 | 
175 |   Conveying under any other circumstances is permitted solely under
176 | the conditions stated below.  Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 | 
179 |   3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 | 
181 |   No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 | 
187 |   When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 | 
195 |   4. Conveying Verbatim Copies.
196 | 
197 |   You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 | 
205 |   You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 | 
208 |   5. Conveying Modified Source Versions.
209 | 
210 |   You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 | 
214 |     a) The work must carry prominent notices stating that you modified
215 |     it, and giving a relevant date.
216 | 
217 |     b) The work must carry prominent notices stating that it is
218 |     released under this License and any conditions added under section
219 |     7.  This requirement modifies the requirement in section 4 to
220 |     "keep intact all notices".
221 | 
222 |     c) You must license the entire work, as a whole, under this
223 |     License to anyone who comes into possession of a copy.  This
224 |     License will therefore apply, along with any applicable section 7
225 |     additional terms, to the whole of the work, and all its parts,
226 |     regardless of how they are packaged.  This License gives no
227 |     permission to license the work in any other way, but it does not
228 |     invalidate such permission if you have separately received it.
229 | 
230 |     d) If the work has interactive user interfaces, each must display
231 |     Appropriate Legal Notices; however, if the Program has interactive
232 |     interfaces that do not display Appropriate Legal Notices, your
233 |     work need not make them do so.
234 | 
235 |   A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit.  Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 | 
245 |   6. Conveying Non-Source Forms.
246 | 
247 |   You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 | 
252 |     a) Convey the object code in, or embodied in, a physical product
253 |     (including a physical distribution medium), accompanied by the
254 |     Corresponding Source fixed on a durable physical medium
255 |     customarily used for software interchange.
256 | 
257 |     b) Convey the object code in, or embodied in, a physical product
258 |     (including a physical distribution medium), accompanied by a
259 |     written offer, valid for at least three years and valid for as
260 |     long as you offer spare parts or customer support for that product
261 |     model, to give anyone who possesses the object code either (1) a
262 |     copy of the Corresponding Source for all the software in the
263 |     product that is covered by this License, on a durable physical
264 |     medium customarily used for software interchange, for a price no
265 |     more than your reasonable cost of physically performing this
266 |     conveying of source, or (2) access to copy the
267 |     Corresponding Source from a network server at no charge.
268 | 
269 |     c) Convey individual copies of the object code with a copy of the
270 |     written offer to provide the Corresponding Source.  This
271 |     alternative is allowed only occasionally and noncommercially, and
272 |     only if you received the object code with such an offer, in accord
273 |     with subsection 6b.
274 | 
275 |     d) Convey the object code by offering access from a designated
276 |     place (gratis or for a charge), and offer equivalent access to the
277 |     Corresponding Source in the same way through the same place at no
278 |     further charge.  You need not require recipients to copy the
279 |     Corresponding Source along with the object code.  If the place to
280 |     copy the object code is a network server, the Corresponding Source
281 |     may be on a different server (operated by you or a third party)
282 |     that supports equivalent copying facilities, provided you maintain
283 |     clear directions next to the object code saying where to find the
284 |     Corresponding Source.  Regardless of what server hosts the
285 |     Corresponding Source, you remain obligated to ensure that it is
286 |     available for as long as needed to satisfy these requirements.
287 | 
288 |     e) Convey the object code using peer-to-peer transmission, provided
289 |     you inform other peers where the object code and Corresponding
290 |     Source of the work are being offered to the general public at no
291 |     charge under subsection 6d.
292 | 
293 |   A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 | 
297 |   A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling.  In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage.  For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product.  A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 | 
310 |   "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source.  The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 | 
318 |   If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information.  But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 | 
329 |   The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed.  Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 | 
337 |   Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 | 
343 |   7. Additional Terms.
344 | 
345 |   "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law.  If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 | 
354 |   When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it.  (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.)  You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 | 
361 |   Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 | 
365 |     a) Disclaiming warranty or limiting liability differently from the
366 |     terms of sections 15 and 16 of this License; or
367 | 
368 |     b) Requiring preservation of specified reasonable legal notices or
369 |     author attributions in that material or in the Appropriate Legal
370 |     Notices displayed by works containing it; or
371 | 
372 |     c) Prohibiting misrepresentation of the origin of that material, or
373 |     requiring that modified versions of such material be marked in
374 |     reasonable ways as different from the original version; or
375 | 
376 |     d) Limiting the use for publicity purposes of names of licensors or
377 |     authors of the material; or
378 | 
379 |     e) Declining to grant rights under trademark law for use of some
380 |     trade names, trademarks, or service marks; or
381 | 
382 |     f) Requiring indemnification of licensors and authors of that
383 |     material by anyone who conveys the material (or modified versions of
384 |     it) with contractual assumptions of liability to the recipient, for
385 |     any liability that these contractual assumptions directly impose on
386 |     those licensors and authors.
387 | 
388 |   All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10.  If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term.  If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 | 
398 |   If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 | 
403 |   Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 | 
407 |   8. Termination.
408 | 
409 |   You may not propagate or modify a covered work except as expressly
410 | provided under this License.  Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 | 
415 |   However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 | 
422 |   Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 | 
429 |   Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License.  If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 | 
435 |   9. Acceptance Not Required for Having Copies.
436 | 
437 |   You are not required to accept this License in order to receive or
438 | run a copy of the Program.  Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance.  However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work.  These actions infringe copyright if you do
443 | not accept this License.  Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 | 
446 |   10. Automatic Licensing of Downstream Recipients.
447 | 
448 |   Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License.  You are not responsible
451 | for enforcing compliance by third parties with this License.
452 | 
453 |   An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations.  If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 | 
463 |   You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License.  For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 | 
471 |   11. Patents.
472 | 
473 |   A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based.  The
475 | work thus licensed is called the contributor's "contributor version".
476 | 
477 |   A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version.  For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 | 
487 |   Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 | 
492 |   In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement).  To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 | 
499 |   If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients.  "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 | 
513 |   If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 | 
521 |   A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License.  You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 | 
536 |   Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 | 
540 |   12. No Surrender of Others' Freedom.
541 | 
542 |   If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License.  If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all.  For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 | 
552 |   13. Use with the GNU Affero General Public License.
553 | 
554 |   Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work.  The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 | 
563 |   14. Revised Versions of this License.
564 | 
565 |   The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time.  Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 | 
570 |   Each version is given a distinguishing version number.  If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation.  If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 | 
579 |   If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 | 
584 |   Later license versions may give you additional or different
585 | permissions.  However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 | 
589 |   15. Disclaimer of Warranty.
590 | 
591 |   THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 | 
600 |   16. Limitation of Liability.
601 | 
602 |   IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 | 
612 |   17. Interpretation of Sections 15 and 16.
613 | 
614 |   If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 | 
621 |                      END OF TERMS AND CONDITIONS
622 | 
623 |             How to Apply These Terms to Your New Programs
624 | 
625 |   If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 | 
629 |   To do so, attach the following notices to the program.  It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 | 
634 |     <one line to give the program's name and a brief idea of what it does.>
635 |     Copyright (C) <year>  <name of author>
636 | 
637 |     This program is free software: you can redistribute it and/or modify
638 |     it under the terms of the GNU General Public License as published by
639 |     the Free Software Foundation, either version 3 of the License, or
640 |     (at your option) any later version.
641 | 
642 |     This program is distributed in the hope that it will be useful,
643 |     but WITHOUT ANY WARRANTY; without even the implied warranty of
644 |     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
645 |     GNU General Public License for more details.
646 | 
647 |     You should have received a copy of the GNU General Public License
648 |     along with this program.  If not, see <http://www.gnu.org/licenses/>.
649 | 
650 | Also add information on how to contact you by electronic and paper mail.
651 | 
652 |   If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 | 
655 |     <program>  Copyright (C) <year>  <name of author>
656 |     This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 |     This is free software, and you are welcome to redistribute it
658 |     under certain conditions; type `show c' for details.
659 | 
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License.  Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 | 
664 |   You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | <http://www.gnu.org/licenses/>.
668 | 
669 |   The GNU General Public License does not permit incorporating your program
670 | into proprietary programs.  If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library.  If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License.  But first, please read
674 | <http://www.gnu.org/philosophy/why-not-lgpl.html>.


--------------------------------------------------------------------------------