Linux中國

利用 ONLYOFFICE 將在線文檔編輯器集成到 Python Web 應用程序中

292 views0
By
Share

ONLYOFFICE 是根據 GNU AGPL v.3 許可證條款分發的開源協作辦公套件。它包含三個用於文本文檔、電子表格和演示文稿的編輯器，並具有以下功能:

  • 查看，編輯和協同編輯 .docx、.xlsx、.pptx 文件。OOXML 作為一種核心格式，可確保與 Microsoft Word、Excel 和 PowerPoint 文件的高度兼容性。
  • 通過內部轉換為 OOXML，編輯其他流行格式（.odt、.rtf、.txt、.html、.ods、.csv、.odp）。
  • 熟悉的選項卡式界面。
  • 協作工具：兩種協同編輯模式（快速和嚴謹），跟蹤更改，評論和集成聊天。
  • 靈活的訪問許可權管理：完全訪問許可權、只讀、審閱、表單填寫和評論。
  • 使用 API 構建附加組件。
  • 250 種可用語言和象形字母表。

通過 API，開發人員可以將 ONLYOFFICE 編輯器集成到網站和利用程序設計語言編寫的應用程序中，並能配置和管理編輯器。

要集成 ONLYOFFICE 編輯器，我們需要一個集成應用程序來連接編輯器（ONLYOFFICE 文檔伺服器）和服務。 要在你的界面中使用編輯器，因該授予 ONLYOFFICE 以下許可權：

  • 添加並執行自定義代碼。
  • 用於下載和保存文件的匿名訪問許可權。這意味著編輯器僅與伺服器端的服務通信，而不包括客戶端的任何用戶授權數據（瀏覽器 cookies）。
  • 在用戶界面添加新按鈕（例如，「在 ONLYOFFICE 中打開」、「在 ONLYOFFICE 中編輯」）。
  • 開啟一個新頁面，ONLYOFFICE 可以在其中執行腳本以添加編輯器。
  • 能夠指定文檔伺服器連接設置。

流行的協作解決方案的成功集成案例有很多，如 Nextcloud、ownCloud、Alfresco、Confluence 和 SharePoint，都是通過 ONLYOFFICE 提供的官方即用型連接器實現的。

實際的集成案例之一是 ONLYOFFICE 編輯器與以 C＃ 編寫的開源協作平台的集成。該平台具有文檔和項目管理、CRM、電子郵件聚合器、日曆、用戶資料庫、博客、論壇、調查、Wiki 和即時通訊程序的功能。

將在線編輯器與 CRM 和項目模塊集成，你可以：

  • 文檔關聯到 CRM 時機和容器、項目任務和討論，甚至創建一個單獨的文件夾，其中包含與項目相關的文檔、電子表格和演示文稿。
  • 直接在 CRM 或項目模塊中創建新的文檔、工作表和演示文稿。
  • 打開和編輯關聯的文檔，或者下載和刪除。
  • 將聯繫人從 CSV 文件批量導入到 CRM 中，並將客戶資料庫導出為 CSV 文件。

在「郵件」模塊中，你可以關聯存儲在「文檔模塊」中的文件，或者將指向所需文檔的鏈接插入到郵件正文中。 當 ONLYOFFICE 用戶收到帶有附件的文檔的消息時，他們可以：下載附件、在瀏覽器中查看文件、打開文件進行編輯或將其保存到「文檔模塊」。 如上所述，如果格式不同於 OOXML ，則文件將自動轉換為 .docx、.xlsx、.pptx，並且其副本也將以原始格式保存。

在本文中，你將看到 ONLYOFFICE 與最流行的編程語言之一的 Python 編寫的文檔管理系統的集成過程。 以下步驟將向你展示如何創建所有必要的部分，以使在 DMS（ 文檔管理系統 Document Management System ）界面內的文檔中可以進行協同工作成為可能：查看、編輯、協同編輯、保存文件和用戶訪問管理，並可以作為服務的示例集成到 Python 應用程序中。

1、前置需求

首先，創建集成過程的關鍵組件：ONLYOFFICE 文檔伺服器 和用 Python 編寫的文件管理系統。

1.1、ONLYOFFICE 文檔伺服器

要安裝 ONLYOFFICE 文檔伺服器，你可以從多個安裝選項中進行選擇：編譯 GitHub 上可用的源代碼，使用 .deb 或 .rpm 軟體包亦或 Docker 鏡像。

我們推薦使用下面這條命令利用 Docker 映像安裝文檔伺服器和所有必需的依賴。請注意，選擇此方法，你需要安裝最新的 Docker 版本。

docker run -itd -p 80:80 onlyoffice/documentserver-de

1.2、利用 Python 開發 DMS

如果已經擁有一個，請檢查它是否滿足以下條件：

  • 包含需要打開以查看/編輯的保留文件
  • 允許下載文件

對於該應用程序，我們將使用 Bottle 框架。我們將使用以下命令將其安裝在工作目錄中：

pip install bottle

然後我們創建應用程序代碼 main.py 和模板 index.tpl。

我們將以下代碼添加到 main.py 文件中：

from bottle import route, run, template, get, static_file # connecting the framework and the necessary components
@route('/') # setting up routing for requests for /
def index():
    return template('index.tpl') # showing template in response to request

run(host="localhost", port=8080) # running the application on port 8080

一旦我們運行該應用程序，點擊 http://localhost:8080 就會在瀏覽器上呈現一個空白頁面 。 為了使文檔伺服器能夠創建新文檔，添加默認文件並在模板中生成其名稱列表，我們應該創建一個文件夾 files 並將3種類型文件（.docx、.xlsx 和 .pptx）放入其中。

要讀取這些文件的名稱，我們使用 listdir 組件（模塊）：

from os import listdir

現在讓我們為文件夾中的所有文件名創建一個變數：

sample_files = [f for f in listdir('files')]

要在模板中使用此變數，我們需要通過 template 方法傳遞它：

def index():
    return template('index.tpl', sample_files=sample_files)

這是模板中的這個變數：

% for file in sample_files:
  <div>
    <span>{{file}}</span>
  </div>
% end

我們重新啟動應用程序以查看頁面上的文件名列表。

使這些文件可用於所有應用程序用戶的方法如下：

@get("/files/<filepath:re:.*.*>")
def show_sample_files(filepath):
    return static_file(filepath, root="files")

2、查看文檔

所有組件準備就緒後，讓我們添加函數以使編輯者可以利用應用介面操作。

第一個選項使用戶可以打開和查看文檔。連接模板中的文檔編輯器 API ：

<script type="text/javascript" src="editor_url/web-apps/apps/api/documents/api.js"></script>

editor_url 是文檔編輯器的鏈接介面。

打開每個文件以供查看的按鈕：

<button onclick="view(&apos;files/{{file}}&apos;)">view</button>

現在我們需要添加帶有 id 的 div 標籤，打開文檔編輯器：

<div id="editor"></div>

要打開編輯器，必須調用調用一個函數：

<script>
function view(filename) {
    if (/docx$/.exec(filename)) {
        filetype = "text"
    }
    if (/xlsx$/.exec(filename)) {
        filetype = "spreadsheet"
    }
    if (/pptx$/.exec(filename)) {
        filetype = "presentation",
        title: filename
    }
​
    new DocsAPI.DocEditor("editor",
        {
            documentType: filetype,
            document: {
                url: "host_url" + &apos;/&apos; + filename,
                title: filename
            },
            editorConfig: {mode: &apos;view&apos;}
        });
  }
</script>

DocEditor 函數有兩個參數：將在其中打開編輯器的元素 id 和帶有編輯器設置的 JSON。 在此示例中，使用了以下必需參數：

  • documentType 由其格式標識（.docx、.xlsx、.pptx 用於相應的文本、電子表格和演示文稿）
  • document.url 是你要打開的文件鏈接。
  • editorConfig.mode。

我們還可以添加將在編輯器中顯示的 title。

接下來，我們可以在 Python 應用程序中查看文檔。

3、編輯文檔

首先，添加 「Edit」（編輯）按鈕：

<button onclick="edit(&apos;files/{{file}}&apos;)">edit</button>

然後創建一個新功能，打開文件進行編輯。類似於查看功能。

現在創建 3 個函數：

<script>
    var editor;
    function view(filename) {
        if (editor) {
            editor.destroyEditor()
        }
        editor = new DocsAPI.DocEditor("editor",
            {
                documentType: get_file_type(filename),
                document: {
                    url: "host_url" + &apos;/&apos; + filename,
                    title: filename
                },
                editorConfig: {mode: &apos;view&apos;}
            });
    }

    function edit(filename) {
        if (editor) {
            editor.destroyEditor()
        }
        editor = new DocsAPI.DocEditor("editor",
            {
                documentType: get_file_type(filename),
                document: {
                    url: "host_url" + &apos;/&apos; + filename,
                    title: filename
                }
            });
    }

    function get_file_type(filename) {
        if (/docx$/.exec(filename)) {
            return "text"
        }
        if (/xlsx$/.exec(filename)) {
            return "spreadsheet"
        }
        if (/pptx$/.exec(filename)) {
            return "presentation"
        }
    }
</script>

destroyEditor 被調用以關閉一個打開的編輯器。

你可能會注意到，edit() 函數中缺少 editorConfig 參數，因為默認情況下它的值是：{"mode":"edit"}。

現在，我們擁有了打開文檔以在 Python 應用程序中進行協同編輯的所有功能。

4、如何在 Python 應用中利用 ONLYOFFICE 協同編輯文檔

通過在編輯器中設置對同一文檔使用相同的 document.key 來實現協同編輯。 如果沒有此鍵值，則每次打開文件時，編輯器都會創建編輯會話。

為每個文檔設置唯一鍵，以使用戶連接到同一編輯會話時進行協同編輯。 密鑰格式應為以下格式：filename +"_key"。下一步是將其添加到當前文檔的所有配置中。

document: {
    url: "host_url" + &apos;/&apos; + filepath,
    title: filename,
    key: filename + &apos;_key&apos;
},

5、如何在 Python 應用中利用 ONLYOFFICE 保存文檔

每次我們更改並保存文件時，ONLYOFFICE 都會存儲其所有版本。 讓我們仔細看看它是如何工作的。 關閉編輯器後，文檔伺服器將構建要保存的文件版本並將請求發送到 callbackUrl 地址。 該請求包含 document.key和指向剛剛構建的文件的鏈接。

document.key 用於查找文件的舊版本並將其替換為新版本。 由於這裡沒有任何資料庫，因此僅使用 callbackUrl 發送文件名。

在 editorConfig.callbackUrl 的設置中指定 callbackUrl 參數並將其添加到 edit() 方法中：

 function edit(filename) {
        const filepath = &apos;files/&apos; + filename;
        if (editor) {
            editor.destroyEditor()
        }
        editor = new DocsAPI.DocEditor("editor",
            {
                documentType: get_file_type(filepath),
                document: {
                    url: "host_url" + &apos;/&apos; + filepath,
                    title: filename, 
                    key: filename + &apos;_key&apos;
                }
                ,
                editorConfig: {
                    mode: &apos;edit&apos;,
                    callbackUrl: "host_url" + &apos;/callback&apos; + &apos;&filename=&apos; + filename  // add file name as a request parameter
                }
            });
    }

編寫一種方法，在獲取到 POST 請求發送到 /callback 地址後將保存文件：

@post("/callback") # processing post requests for /callback
def callback():
    if request.json[&apos;status&apos;] == 2:
        file = requests.get(request.json[&apos;url&apos;]).content
        with open(&apos;files/&apos; + request.query[&apos;filename&apos;], &apos;wb&apos;) as f:
            f.write(file)
    return "{"error":0}"
​

# status 2 是已生成的文件，當我們關閉編輯器時，新版本的文件將保存到存儲器中。

6、管理用戶

如果應用中有用戶，並且你需要查看誰在編輯文檔，請在編輯器的配置中輸入其標識符（id和name）。

在界面中添加選擇用戶的功能：

<select id="user_selector" onchange="pick_user()">
    <option value="1" selected="selected">JD</option>
    <option value="2">Turk</option>
    <option value="3">Elliot</option>
    <option value="4">Carla</option>
</select>

如果在標記 <script> 的開頭添加對函數 pick_user() 的調用，負責初始化函數自身 id 和 name 變數。

function pick_user() {
    const user_selector = document.getElementById("user_selector");
    this.current_user_name = user_selector.options[user_selector.selectedIndex].text;
    this.current_user_id = user_selector.options[user_selector.selectedIndex].value;
}

使用 editorConfig.user.id 和 editorConfig.user.name 來配置用戶設置。將這些參數添加到文件編輯函數中的編輯器配置中。

function edit(filename) {
    const filepath = &apos;files/&apos; + filename;
    if (editor) {
        editor.destroyEditor()
    }
    editor = new DocsAPI.DocEditor("editor",
        {
            documentType: get_file_type(filepath),
            document: {
                url: "host_url" + &apos;/&apos; + filepath,
                title: filename
            },
            editorConfig: {
                mode: &apos;edit&apos;,
                callbackUrl: "host_url" + &apos;/callback&apos; + &apos;?filename=&apos; + filename,
                user: {
                    id: this.current_user_id,
                    name: this.current_user_name
                }
            }
        });
}

使用這種方法，你可以將 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中國 榮譽推出

本文轉載來自 Linux 中國: https://github.com/Linux-CN/archive

對這篇文章感覺如何？

太棒了
0
不錯
0
愛死了
0
不太好
0
感覺很糟
0
雨落清風。心向陽
    Previous
    Next

    You may also like

    Leave a reply

    您的郵箱地址不會被公開。 必填項已用 * 標註

    此站點使用Akismet來減少垃圾評論。了解我們如何處理您的評論數據。

    More in:Linux中國