0ct0pu5/siyuan
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

🧑‍💻 Improve kernel API /api/convert/pandoc Fix https://github.com/siyuan-note/siyuan/issues/8619

Browse source
This commit is contained in:
Daniel 2023-06-26 18:31:30 +08:00
parent b3d3048924
commit fc818c6511
No known key found for this signature in database
GPG key ID: 86211BA83DF03017
4 changed files with 46 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
API.md
View file

@ -470,7 +470,8 @@ View API token in <kbd>Settings - About</kbd>, request header: `Authorization: T
* `"/assets/sub/"`: workspace/data/assets/sub/ folder
Under normal circumstances, it is recommended to use the first method, which is stored in the assets folder
of the workspace, putting in a subdirectory has some side effects, please refer to the assets chapter of the user guide.
of the workspace, putting in a subdirectory has some side effects, please refer to the assets chapter of the user
guide.
* `file[]`: Uploaded file list
* Return value
@ -829,9 +830,9 @@ View API token in <kbd>Settings - About</kbd>, request header: `Authorization: T
}
```
* `fromID`: Def block ID
* `toID`: Target block ID
* `refIDs`: Ref block IDs point to def block ID, optional, if not specified, all ref block IDs will be transferred
* `fromID`: Def block ID
* `toID`: Target block ID
* `refIDs`: Ref block IDs point to def block ID, optional, if not specified, all ref block IDs will be transferred
* Return value
```json
@ -1041,8 +1042,8 @@ View API token in <kbd>Settings - About</kbd>, request header: `Authorization: T
"newPath": "/data/assets/test-20230523085812-k3o9t32.png"
}
```
* `path`: the file path under the workspace path
* `newPath`: the new file path under the workspace path
* `path`: the file path under the workspace path
* `newPath`: the new file path under the workspace path
* Return value
```json
@ -1119,7 +1120,7 @@ View API token in <kbd>Settings - About</kbd>, request header: `Authorization: T
* `/api/convert/pandoc`
* Working directory
* Executing the pandoc command will set the working directory to `workspace/temp/convert/pandoc/`
* Executing the pandoc command will set the working directory to `workspace/temp/convert/pandoc/${dir}`
* API [`Put file`](#put-file) can be used to write the file to be converted to this directory first
* Then call the API for conversion, and the converted file will also be written to this directory
* Finally, call the API [`Get file`](#get-file) to get the converted file
@ -1129,6 +1130,7 @@ View API token in <kbd>Settings - About</kbd>, request header: `Authorization: T
```json
{
"dir": "test",
"args": [
"--to", "markdown_strict-raw_html",
"foo.epub",
@ -1144,9 +1146,12 @@ View API token in <kbd>Settings - About</kbd>, request header: `Authorization: T
{
"code": 0,
"msg": "",
"data": null
"data": {
"path": "/temp/convert/pandoc/test"
}
}
```
* `path`: the path under the workspace
## Notification

19
API_zh_CN.md
View file

@ -822,9 +822,9 @@
}
```
* `fromID`：定义块 ID
* `toID`：目标块 ID
* `refIDs`：指向定义块 ID 的引用所在块 ID，可选，如果不指定，所有指向定义块 ID 的引用块 ID 都会被转移
* `fromID`：定义块 ID
* `toID`：目标块 ID
* `refIDs`：指向定义块 ID 的引用所在块 ID，可选，如果不指定，所有指向定义块 ID 的引用块 ID 都会被转移
* 返回值
```json
@ -835,7 +835,6 @@
}
```
## 属性
### 设置块属性
@ -1035,8 +1034,8 @@
"newPath": "/data/assets/test-20230523085812-k3o9t32.png"
}
```
* `path`：工作空间路径下的文件路径
* `newPath`：新的文件路径
* `path`：工作空间路径下的文件路径
* `newPath`：新的文件路径
* 返回值
```json
@ -1113,7 +1112,7 @@
* `/api/convert/pandoc`
* 工作目录
* 执行调用 pandoc 命令时工作目录会被设置在 `工作空间/temp/convert/pandoc/` 下
* 执行调用 pandoc 命令时工作目录会被设置在 `工作空间/temp/convert/pandoc/${test}` 下
* 可先通过 API [`写入文件`](#写入文件) 将待转换文件写入该目录
* 然后再调用该 API 进行转换，转换后的文件也会被写入该目录
* 最后调用 API [`获取文件`](#获取文件) 获取转换后的文件内容
@ -1123,6 +1122,7 @@
```json
{
"dir": "test",
"args": [
"--to", "markdown_strict-raw_html",
"foo.epub",
@ -1138,9 +1138,12 @@
{
"code": 0,
"msg": "",
"data": null
"data": {
"path": "/temp/convert/pandoc/test"
}
}
```
* `path`：工作空间下的路径
## 通知

12
kernel/api/pandoc.go
View file

@ -33,17 +33,27 @@ func pandoc(c *gin.Context) {
return
}
dir := gulu.Rand.String(7)
dirArg := arg["dir"]
if nil != dirArg {
dir = dirArg.(string)
}
pandocArgs := arg["args"].([]interface{})
var args []string
for _, v := range pandocArgs {
args = append(args, v.(string))
}
err := util.ConvertPandoc(args...)
path, err := util.ConvertPandoc(dir, args...)
if nil != err {
ret.Code = -1
ret.Msg = err.Error()
return
}
ret.Data = map[string]interface{}{
"path": path,
}
return
}

18
kernel/util/pandoc.go
View file

@ -29,24 +29,28 @@ import (
"github.com/siyuan-note/logging"
)
func ConvertPandoc(args ...string) (err error) {
func ConvertPandoc(dir string, args ...string) (path string, err error) {
if "" == PandocBinPath || ContainerStd != Container {
return errors.New("not found executable pandoc")
err = errors.New("not found executable pandoc")
return
}
pandoc := exec.Command(PandocBinPath, args...)
gulu.CmdAttr(pandoc)
dir := filepath.Join(WorkspaceDir, "temp", "convert", "pandoc", gulu.Rand.String(7))
if err = os.MkdirAll(dir, 0755); nil != err {
logging.LogErrorf("mkdir [%s] failed: [%s]", dir, err)
path = filepath.Join("temp", "convert", "pandoc", dir)
absPath := filepath.Join(WorkspaceDir, path)
if err = os.MkdirAll(absPath, 0755); nil != err {
logging.LogErrorf("mkdir [%s] failed: [%s]", absPath, err)
return
}
pandoc.Dir = dir
pandoc.Dir = absPath
output, err := pandoc.CombinedOutput()
if nil != err {
logging.LogErrorf("pandoc convert output [%s]", string(output))
err = errors.Join(err, errors.New(string(output)))
logging.LogErrorf("pandoc convert output failed: %s", err)
return
}
path = "/" + filepath.ToSlash(path)
return
}