糊涂涂

菜单

Administrator
发布于 2024-01-08 / 180 阅读
0

轻传与Obsidian联动-实现本地编辑自动上传Typecho或者Wordpress

日期: 2023年 08 日 02 日
时间: 15 点 36 分
Tags:

  • 折腾
    categories:
  • 折腾

.. toc::

轻传

开源地址
GitHub - Xingsandesu/QingQ-XMLRPC-Client: 一个基于Python的XMLPRC客户端，适配Typecho

简介

本项目使用 Typecho 的 XML-RPC 接口，实现本地 Markdown 文件解析，并且自动上传 Typecho 服务器，实现博客写作本地化与自动化

功能列表

| 功能 | 描述 |
| ———————————— | ———————————————————————————– |
| XML-RPC 发布 | 基于 metaWeblog API 实现的发布操作 |
| Markdown 渲染 | 基于 mistune 实现 Markdown 文件的本地 HTML 渲染 |
| 自适应配置检查 | 自写自纠错自生成逻辑实现 Config 的规范化调用 |
| 拖动上传 | 使用时自动获取 Markdown 文件的路径与文件名拖动即发布，注意，该功能只支持到 1.0 |
| TOC 生成支持 | 基于 mistune 实现支持文档自动生成 TOC |
| YAML 头信息读取 | 自动读取 Markdown YAML 头信息，实现发布时自动归类，Typecho 打标签与 OBsidian 打标签 |
| 报错抓取 | 自动抓取 Traceback，并保存到 error. Txt |
| WebDav 服务端 | 集成了一个 WebDav 服务端，现在可以直接和 Obsidian 中 WebDav 插件联动了 |
| 企业微信推送支持 | 服务端部署可以直接推送消息到企业微信 |
| 基于本地 YAML 的自动识别上传或修改文章 | 通过本地 YAML 文件来实现该功能，注意，此文件是隐藏的 |

重要更新提示: 1.3 拆分了 Hook Server 与 WebDav Server，现在程序是两部分，首先运行 Hook Server 然后运行 WebDav Server 分别填写需要的配置
最好自行安装 python 然后通过 requirements. Txt 安装依赖，手动使用 python Server. Py 和 python webdav. Py 来运行两个程序

快速开始

注意，此处可以运用到 1.0 之后的版本

1. 下载程序

Releases · Xingsandesu/QingQ-XMLRPC-Client

安装 python pip 安装相应依赖

2. 准备您的 Markdown 文档

3. 企业微信注册

1. 到企业微信官网，注册一个企业

  1. 登录企业微信后台，创建一个“自建”应用，获取企业 ID、agentid、secret 这 3 个必要的参数
    3. 在企业微信的通讯录中，创建多个测试账号
  2. 在手机端安装“企业微信”APP，使用测试账号登录到企业微信，准备接收消息。

4. 准备一个服务器或者主机

  • 如果你拥有一个 Linux 服务器，我推荐使用 screen 来运行脚本

5. 第一次运行程序

python Server.py
python webdav.py
  • 第一次运行程序会自动生成 config. Yml 配置文件，并且报错，请不用担心，按照配置文件提示去填写他
  • 如果你失误填写了错误的配置文件或者格式，重新运行程序或者删除 config. Yml ，程序会自动更正配置

6. 第二次运行程序

  • 如果你的配置没有问题，我想现在程序已经开始正常的运行了
  • 如果你想在命令行持久运行在 Linux 上可以创建一个 screen 来运行他
    screen -S webdav
cd <你的程序运行目录>
python webdav.py
按:Ctrl+a, 再按:d, 即可退出这个screen

screen -S hook
cd <你的程序运行目录>
python Server.py
按:Ctrl+a, 再按:d, 即可退出这个screen

后续管理窗口
screen -r webdav
screen -r hook

- 如果出现了提示报错，请按照提示检查并修改配置文件
- 如果出现了未知错误，请提交 error. Txt 到本项目的 issue，并写明复现方法，如果不可复现请直接提交 txt 内容

### 7. 进阶配置 （可选）

#### 反向代理 

- 在 1.2 版本后，你可以使用 Nginx 等软件，反向代理该服务器
- 这里提供一个简单的配置

location / {

proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;

proxy_set_header Host $http_host;

proxy_redirect off;

proxy_pass http://127.0.0.1:8080;

# 请将下一行注释符删除，并更改大小为理论最大文件尺寸

# client_max_body_size 20000m;

}

## 快速开始-1.0

### 注意，1.0 与此后更新的程序逻辑发生了极大的变更，1.0 版本快速开始并不适用与其他版本

1. 下载程序

[轻传 By KooKoo](https://download.kookoo.top/exe/QingQ.exe)

2. 准备您的 Markdown 文档

3. 拖动文档到轻传，第一次生成配置文件并按照内容修改

4. 再次拖动文档到轻传

5. Done！

## 与 Obsidian 基础联动

首先，您需要了解 Obsidian 的基础概念 - Template 模板与 Markdown YAML 头信息。

### Template 模板

模板插件能让你在当前笔记中快速插入预设的文本段。和其他软件的模板不同，Obsidian 的模板和普通笔记一样，都是 Markdown 文件，模板的作用仅仅是保存预设文本段，方便 Obsidian 识别与插入。

#### 设置模板文件夹

使用模板前，你需要指定模板文件夹，这样 Obsidian 才知道模板存放在什么地方。启用模板插件后，你需要在 `设置` -> `模板` -> `模板文件夹位置` 中指定模板文件夹的路径。

#### 在当前笔记中插入模板

设置好了模板文件夹后，你就可以在当前笔记中插入模板了。插入模板的方法很简单，你可以在左边栏中点击 `插入模板` 按钮，也可以使用相应的快捷键（需要设置），也可以使用命令面板来完成操作。

当你执行这个命令时，模板中的文本段会立刻插入到当前笔记中光标所在的位置。

#### 插入当前笔记标题

如果你想让模板自动生成当前笔记的标题，则可以使用 `{{title}}` 占位符。

#### 插入日期与时间

Obsidian 允许你在模板中使用占位符 `{{date}}` 和 `{{time}}` 来代表日期和时间。当模板插入到笔记中时，Obsidian 会自动地将这些占位符替换成当下的日期值和时间值。

当然，替换的日期值和时间值的格式也是可以自行设定的。你可以在模板插件的设置页进行格式的设定，具体的格式语法请看[这里](https://momentjs.com/docs/#/displaying/format/)。

_一个小技巧：如果你想在模板中使用两个日期占位符，你可以通过相应的格式把时间占位符变成日期占位符。想使用两个日期占位符也是同理。_

#### 另一种指定格式的方法

除了在设置页中指定日期值和时间值的格式外，你还可以使用 `{{date:YYYY-MM-DD}}`、`{{time:HH:mm}}` 这样的占位符来直接指定格式——冒号 `:` 后的部分都会被识别为格式语法。需要注意的是，这种写法会覆盖设置页中对于占位符的格式设置，因此它仅对于当前模板有效，对其他模板是不起作用的（如果你有多个模板的话）。

#### 在其他地方使用格式语法

目前，这种格式语法也可以在[日记](https://publish.obsidian.md/help-zh/%E6%8F%92%E4%BB%B6/%E6%97%A5%E8%AE%B0)和 [ZK 卡片](https://publish.obsidian.md/help-zh/%E6%8F%92%E4%BB%B6/ZK+%E5%8D%A1%E7%89%87)的模板设置里使用。但是，`{{date}}` 和 `{{time}}` 占位符并不能使用。

### Markdown YAML 头信息

在 Obsidian 中写文档，通常需要在头部写一些关于文章的信息，这些都是需要使用 YAML 语言来写的，例如

title:
date:
tags:

  • 1
  • 2
提醒此部分一般叫做 `Front-matter` 。

文章内部的 YAML 配置都是以 `---` 开始和结束的，而且，结束之后通常还要再有一行的空行，用以区分 Markdown 语法。

#### 基本语法

YAML 使用键值对的形式记录信息，标准格式是

key: value
键: 值

#### 基本规则

1. 大小写敏感
2. **使用缩进表示层级关系**
3. 禁止使用 tab 缩进，只能使用空格键
4. 缩进长度没有限制，只要元素对齐就表示这些元素属于一个层级
5. 使用 `#` 表示注释
6. 字符串可以不用引号标注（但是建议你最好还是加上引号）

### 联动使用方法

#### 教程

1. 下载我提供的 [Template.md](https://github.com/Xingsandesu/QingQ-XMLPRC-Client/blob/main/Template.md)
2. 参考 `Template模板` 来使用这个模板
3. 写作
4. 安装第三方插件 Remotely Save 
![image.png](https://cdn.jsdelivr.net/gh/Xingsandesu/kookoo-picbed/img/2023%2F07%2F31%2F20230731224333_22-43-34.png)
5. 配置 webdav 地址与账号密码以及相关设置，账号密码为你的系统账号密码
6. 创建一个保存草稿和发布的文件夹
7. 创建一个文件夹来保存草稿
8. 创建一个文件夹来保存发布
9. 在 config. Yml 填写 File_dir 为发布文件夹路径
10. 在 config. Yml 填写 Webdav_root_path 为你的 Obsidian 库路径，
11. 填写其他配置，详见快速开始
12. 运行程序
13. 安装第三方插件 Shell commands
14. 选择 powershell 运行，复制并修改这段代码上去，可选创建快捷键与别名

Copy-Item -Path “你的草稿文件夹绝对路径{{file_name}}” -Destination “你的Typecho Push API文件夹绝对路径”; Start-Sleep -Seconds 61; Remove-Item -Path “你的Typecho Push API文件夹绝对路径{{file_name}}”

> 使用这个命令自动 copy 并删除，可以保存快捷键，写完文章后，使用快捷键，配合 remotely save 每分钟自动保存，实现自动上传自动清理
16. 写作完成后，只需把运行这个命令，手动运行同步操作或者等待插件完成自动同步，即可完成发布
17. 如果想要修改，修改文件后运行这个命令，手动运行同步操作或者等待插件完成自动同步，即可完成修改

#### 注意事项

- .slug_cid_mapping. Yml 是完成上传后保存的一份特殊的 log 文件，他是隐藏的，以 YAML 格式储存，非必要请不要删除他，他记录了所有你使用程序上传的文章信息，根据这些信息才能判断文章是否已经存在，而完成文章发布或更新操作
- Print. Log 是程序运行的 log 文件，该文件记录了所有控制台信息，遇到问题你可以查看该文件，注意，log 含有重要的身份信息，请不要泄露他
- Config. Yml 是程序的配置文件，程序需要的参数会在里面填写或更新，更新程序不会删除原有的配置，而是增量写入，每次更新时如果有配置更新，请填写相关配置
- Error. Txt 是程序遇到未知错误而产生的文件，如果遇到自己解决不了的问题，请附带此文件到 issue

配置文件填写路径时，如果遇到报错，请使用 \ 代替 \

### 联动使用方法-1.0

#### 教程

1. 下载我提供的 [Template.md](https://github.com/Xingsandesu/QingQ-XMLPRC-Client/blob/main/Template.md)
![image.png](https://cdn.jsdelivr.net/gh/Xingsandesu/kookoo-picbed/img/2023%2F07%2F30%2F20230730151803_15-18-05.png)

2. 参考 `Template模板` 来使用这个模板
3. 写作
4. 拖动文件到程序，完成发布。

#### 模板 YAML 字段内容注释

时间日期，Obsidian 模板可以自动识别，此处无需更改

日期: {{date: YYYY年 MM 日 DD 日}}
时间: {{time: HH 点 mm 分}}
Tags:

  • 折腾 # Obsidian 可以识别的键值对，作为 Obsidian 本地归档分类使用
    categories:

  • 折腾 # 本程序上传Typecho时的分类键值对，作为 Typecho 分类时调用，此处填写后文章自动把上传内容划分到您输入的分类中

    此处是自动生成TOC的Tag，写作时，如果仅作为 Obsidian 本地笔记使用，或者不想生成TOC可以删除

    .. toc::

常见问题及解决方案

1. 如何在 Linux / macOS 中使用它 ?

- 下载源码，自行用 Pyinstaller 来构建 Linux 的可运行程序
- 或者直接下载源码，打开命令行，输入 python main. py <您的Markdown文件路径>

2. 使用上遇到了不能上传的问题 ?

- 提交 Issue
- 发送邮件到 fushinn888@gmail.com

3. 为什么在 Typecho 后台编辑文章是 HTML 格式 ?

这是因为 Typecho 的一个BUG，直接使用 XML-PRC 来发布 Markdown 格式的文档内容时，Typecho无法自动识别 Markdown 格式，因此，本程序通过在本地直接渲染 Markdown 文件，直接向 Typecho 提交 HTML 文本，曲线解决了这一问题，并且通过这一手段，实现了自动生成 TOC 目录的功能，当然，您也可以自己开发相应的渲染器。

4. 在其他的 CMS 上可以使用该程序吗 ?

当然！本程序是基于 metaWeblog API 实现的，您也可以部署到其他平台上，包括但不限于WordPress，CSDN，cnblog等，您也可以使用 metaWeblog API 来为本程序添加其他的功能

效果展示

Markdown 渲染效果展示

test - 糊涂涂博客

二次开发

欢迎各位

异常排错

已知异常

  • 程序过程中会自动提醒

未知异常

TODO LIST

  • [x] Hook 联动
  • [x] Obsidian 联动
  • [x] 集成 WebDav 服务器

如果有更好的想法，欢迎提交 issue

更新日志

1.1-Server-Hook

  • 通过 Hook 实现获取自定义文件夹内如果有新的 markdown 文件被创建，程序会自动上传到 Typecho
  • 提供企业微信消息推送支持，在 config. Yml 中添加自己的企业微信信息，如果 markdown 文件被正确的上传，则会推送消息到您的企业微信程序中。
  • 添加了日志模块，由于是服务端部署模式，将不会使用 input ()来进行 Windows 窗口留存，相关所有的输出都会通过 print. Log 保存，如有报错请看 log
  • 更新了 error. Txt 未知异常报错捕获逻辑
  • 提供 Linux 与 Windows 两种部署方式，获取请 releases 中下载

1.2

BUG FIX

  • 重写了文章上传逻辑，现在是基于本地文件. Slug_cid_mapping. Yml 来实现自动识别更新文章或者上传新文章的逻辑，请不要删除这个文件
  • 重写了读取 YAML 头信息的读取方式，修复了之前有可能读取头文件不完全的 BUG
  • 重写了加载逻辑
  • 优化了 error. Txt 的判断点，现在代码更健壮了
  • 增加了企业微信应用 id 的可配置变量，现在可以在配置文件中修改它
  • 错别字修正

功能更新

  • 集成一个 WebDav 服务端，在服务器中部署它，或者在电脑中运行他，现在可以直接使用 WebDav 来配合 Obsidian 的 webdav 同步插件来实现无缝上传或者更新文章了
  • 支持了 XMLRPC 上传解析 YAML 头信息中标签信息，但是这里有一个已知 BUG 详见 typecho/typecho #1607
  • 增加异步执行的相关代码

1.3

更新日志

  • 人生苦短，远离多线程

BUG FIX

  • 修复了 YAML 头信息的获取逻辑
  • Template. Md 去掉了 Typecho 的标签字段，暂时去掉了对 Typecho 标签的支持，等待 Typecho 官方修复
  • 优化了 error. Txt 抓取逻辑，增加了更多错误检测

功能更新

  • 重写了 Webdav 服务器启动方式，现在以 cherrypy 启动
  • 拆分了 WebDav Server 与 Hook Server，现在他们都是以独立的脚本来运行（Pyinstaller 多线程打包会有问题）
  • 去除了各自相应的逻辑代码

重要公告

  • 如果想直接运行在本地运行. Py 程序，请务必安装 requirements. Txt 中的相关依赖

相关依赖

见 requirements.txt
轻传-基于XML-RPC的Type...
网络基础