利用 ONLYOFFICE 将在线文档编辑器集成到 Python Web 应用程序中

ONLYOFFICE是根据 GNU AGPL v.3 许可证条款分发的开源协作办公套件。它包含三个用于文本文档、电子表格和演示文稿的编辑器，并具有以下功能:

通过 API，开发人员可以将 ONLYOFFICE 编辑器集成到网站和利用程序设计语言编写的应用程序中，并能配置和管理编辑器。

要集成 ONLYOFFICE 编辑器，我们需要一个集成应用程序来连接编辑器（ONLYOFFICE 文档服务器）和服务。 要在你的界面中使用编辑器，因该授予 ONLYOFFICE 以下权限：

流行的协作解决方案的成功集成案例有很多，如 Nextcloud、ownCloud、Alfresco、Confluence 和 SharePoint，都是通过 ONLYOFFICE 提供的官方即用型连接器实现的。

实际的集成案例之一是 ONLYOFFICE 编辑器与以 C＃ 编写的开源协作平台的集成。该平台具有文档和项目管理、CRM、电子邮件聚合器、日历、用户数据库、博客、论坛、调查、Wiki 和即时通讯程序的功能。

将在线编辑器与 CRM 和项目模块集成，你可以：

在“邮件”模块中，你可以关联存储在“文档模块”中的文件，或者将指向所需文档的链接插入到邮件正文中。 当 ONLYOFFICE 用户收到带有附件的文档的消息时，他们可以：下载附件、在浏览器中查看文件、打开文件进行编辑或将其保存到“文档模块”。 如上所述，如果格式不同于 OOXML ，则文件将自动转换为 、、，并且其副本也将以原始格式保存。

在本文中，你将看到 ONLYOFFICE 与最流行的编程语言之一的 Python 编写的文档管理系统的集成过程。 以下步骤将向你展示如何创建所有必要的部分，以使在 DMS（文档管理系统Document Management System）界面内的文档中可以进行协同工作成为可能：查看、编辑、协同编辑、保存文件和用户访问管理，并可以作为服务的示例集成到 Python 应用程序中。

1、前置需求

首先，创建集成过程的关键组件：ONLYOFFICE 文档服务器和用 Python 编写的文件管理系统。

1.1、ONLYOFFICE 文档服务器

要安装 ONLYOFFICE 文档服务器，你可以从多个安装选项中进行选择：编译 GitHub 上可用的源代码，使用 或软件包亦或 Docker 镜像。

我们推荐使用下面这条命令利用 Docker 映像安装文档服务器和所有必需的依赖。请注意，选择此方法，你需要安装最新的 Docker 版本。

1.2、利用 Python 开发 DMS

如果已经拥有一个，请检查它是否满足以下条件：

对于该应用程序，我们将使用 Bottle 框架。我们将使用以下命令将其安装在工作目录中：

然后我们创建应用程序代码 和模板。

我们将以下代码添加到 文件中：

一旦我们运行该应用程序，点击 http://localhost:8080就会在浏览器上呈现一个空白页面 。 为了使文档服务器能够创建新文档，添加默认文件并在模板中生成其名称列表，我们应该创建一个文件夹并将3种类型文件（、和）放入其中。

要读取这些文件的名称，我们使用 组件（模块）：

现在让我们为文件夹中的所有文件名创建一个变量：

要在模板中使用此变量，我们需要通过 方法传递它：

这是模板中的这个变量：

我们重新启动应用程序以查看页面上的文件名列表。

使这些文件可用于所有应用程序用户的方法如下：

2、查看文档

所有组件准备就绪后，让我们添加函数以使编辑者可以利用应用接口操作。

第一个选项使用户可以打开和查看文档。连接模板中的文档编辑器 API ：

是文档编辑器的链接接口。

打开每个文件以供查看的按钮：

现在我们需要添加带有 的标签，打开文档编辑器：

要打开编辑器，必须调用调用一个函数：

DocEditor 函数有两个参数：将在其中打开编辑器的元素 和带有编辑器设置的。 在此示例中，使用了以下必需参数：

我们还可以添加将在编辑器中显示的 。

接下来，我们可以在 Python 应用程序中查看文档。

3、编辑文档

首先，添加 “Edit”（编辑）按钮：

然后创建一个新功能，打开文件进行编辑。类似于查看功能。

现在创建 3 个函数：

被调用以关闭一个打开的编辑器。

你可能会注意到，函数中缺少参数，因为默认情况下它的值是：。

现在，我们拥有了打开文档以在 Python 应用程序中进行协同编辑的所有功能。

4、如何在 Python 应用中利用 ONLYOFFICE 协同编辑文档

通过在编辑器中设置对同一文档使用相同的 来实现协同编辑。 如果没有此键值，则每次打开文件时，编辑器都会创建编辑会话。

为每个文档设置唯一键，以使用户连接到同一编辑会话时进行协同编辑。 密钥格式应为以下格式：。下一步是将其添加到当前文档的所有配置中。

5、如何在 Python 应用中利用 ONLYOFFICE 保存文档

每次我们更改并保存文件时，ONLYOFFICE 都会存储其所有版本。 让我们仔细看看它是如何工作的。 关闭编辑器后，文档服务器将构建要保存的文件版本并将请求发送到 地址。 该请求包含和指向刚刚构建的文件的链接。

用于查找文件的旧版本并将其替换为新版本。 由于这里没有任何数据库，因此仅使用发送文件名。

在 的设置中指定参数并将其添加到方法中：

编写一种方法，在获取到 POST 请求发送到 地址后将保存文件：

是已生成的文件，当我们关闭编辑器时，新版本的文件将保存到存储器中。

6、管理用户

如果应用中有用户，并且你需要查看谁在编辑文档，请在编辑器的配置中输入其标识符（和）。

在界面中添加选择用户的功能：

如果在标记 的开头添加对函数 的调用，负责初始化函数自身和变量。

使用 和来配置用户设置。将这些参数添加到文件编辑函数中的编辑器配置中。

使用这种方法，你可以将 ONLYOFFICE 编辑器集成到用 Python 编写的应用程序中，并获得用于在文档上进行协同工作的所有必要工具。有关更多集成示例（Java、Node.js、PHP、Ruby），请参考官方的 API 文档。

via: https://opensourceforu.com/2019/09/integrate-online-documents-editors-into-a-python-web-app-using-onlyoffice/

作者：Aashima Sharma选题：lujun9972译者：stevenzdg988校对：wxy

本文由 LCTT原创编译，Linux中国荣誉推出

来源：硬核老王