搜尋

首頁 >後端開發 >Python教學 >Python的Flask框架中整合CKeditor富文本編輯器

Python的Flask框架中整合CKeditor富文本編輯器

高洛峰
高洛峰原創
2017-03-03 13:39:151951瀏覽

CKeditor是目前最優秀的可見即可得到網頁編輯器之一，它是用JavaScript編寫。具備功能強大、配置容易、跨瀏覽器、支援多種程式語言、開源等功能。它非常流行，互聯網上很容易找到相關技術文檔，國內許多WEB項目和大型網站均採用了CKeditor。

下載CKeditor
訪問CKeditor官方網站，進入下載頁面，選擇Standard Package（一般情況下功能足夠用了），然後點擊Download CKEditor按鈕下載ZIP格式的安裝檔。如果你想嘗試更多的功能，可以選擇下載Full Package。

下載好CKeditor之後，解壓縮到Flask專案static/ckeditor目錄即可。

在Flask專案中使用CKeditor
在Flask專案中使用CKeditor只需要執行兩步驟就可以了：

在3f1c4e4b6b16bbbd69b2ee476dc4f83a標籤引入CKeditor主腳本檔。可以引入本地的文件，也可以引用CDN上的文件。
使用CKEDITOR.replace()把現存的4750256ae76b6b9d804861d8f69e79d3標籤替換成CKEditor。
範例程式碼：

<!DOCTYPE html>
<html>
  <head>
    <title>A Simple Page with CKEditor</title>
    <!-- 请确保CKEditor文件路径正确 -->
    <script src="{{ url_for(&#39;static&#39;, filename=&#39;ckeditor/ckeditor.js&#39;) }}"></script>
  </head>
  <body>
    <form>
      <textarea name="editor1" id="editor1" rows="10" cols="80">
        This is my textarea to be replaced with CKEditor.
      </textarea>
      <script>
        // 用CKEditor替换<textarea id="editor1">
        // 使用默认配置
        CKEDITOR.replace(&#39;editor1&#39;);
      </script>
    </form>
  </body>
</html>

因為CKeditor夠優秀，所以第二步驟也可只為4750256ae76b6b9d804861d8f69e79d3追加名為ckeditor的class屬性值，CKeditor就會自動將其替換。例如：

<!DOCTYPE html>
<html>
  <head>
    <title>A Simple Page with CKEditor</title>
    <!-- 请确保CKEditor文件路径正确 -->
    <script src="{{ url_for(&#39;static&#39;, filename=&#39;ckeditor/ckeditor.js&#39;) }}"></script>
  </head>
  <body>
    <form>
      <textarea name="editor1" id="editor1" class="ckeditor" rows="10" cols="80">
        This is my textarea to be replaced with CKEditor.
      </textarea>
    </form>
  </body>
</html>

CKEditor腳本檔案也可以引用CDN上的文件，下面給出幾個參考連結：

<script src="//cdn.ckeditor.com/4.4.6/basic/ckeditor.js"></script>

 基礎版（迷你版）

<script src="//cdn.ckeditor.com/4.4.6/standard/ckeditor.js"></script>

 標準版

<script src="//cdn.ckeditor.com/4.4.6/full/ckeditor.js"></script>

完整版
開啟上傳功能
預設設定下，CKEditor是沒有開啟上傳功能的，要開啟上傳功能，也相當的簡單，只需要簡單修改配置即可。下面來看看幾個相關的設定值：

  • filebrowserUploadUrl ：檔案上傳路徑。若設定了，則上傳按鈕會出現在連結、圖片、Flash對話方塊。

  • filebrowserImageUploadUrl ： 圖片上傳路徑。若不設定，則使用filebrowserUploadUrl值。

  • filebrowserFlashUploadUrl ： Flash上​​傳路徑。若不設定，則使用filebrowserUploadUrl值。

為了方便，這裡我們只會設定filebrowserUploadUrl值，其值設為/ckupload/（後面會在Flask中定義這個URL）。

設定設定值主要使用2種方法：

方法1：透過CKEditor根目錄的設定檔config.js來設定:

#
CKEDITOR.editorConfig = function( config ) {
  // ...
  // file upload url
  config.filebrowserUploadUrl = &#39;/ckupload/&#39;;
  // ...
};

方法2：將設定值放入當參數放入CKEDITOR.replace():

<script>
CKEDITOR.replace(&#39;editor1&#39;, {
  filebrowserUploadUrl: &#39;/ckupload/&#39;,
});
</script>

Flask處理上傳請求
CKEditor上傳功能是統一的接口，即一個接口可以處理圖片上傳、文件上傳、Flash上​​傳。先來看看程式碼：

def gen_rnd_filename():
  filename_prefix = datetime.datetime.now().strftime(&#39;%Y%m%d%H%M%S&#39;)
  return &#39;%s%s&#39; % (filename_prefix, str(random.randrange(1000, 10000)))

@app.route(&#39;/ckupload/&#39;, methods=[&#39;POST&#39;])
def ckupload():
  """CKEditor file upload"""
  error = &#39;&#39;
  url = &#39;&#39;
  callback = request.args.get("CKEditorFuncNum")
  if request.method == &#39;POST&#39; and &#39;upload&#39; in request.files:
    fileobj = request.files[&#39;upload&#39;]
    fname, fext = os.path.splitext(fileobj.filename)
    rnd_name = &#39;%s%s&#39; % (gen_rnd_filename(), fext)
    filepath = os.path.join(app.static_folder, &#39;upload&#39;, rnd_name)
    # 检查路径是否存在，不存在则创建
    dirname = os.path.dirname(filepath)
    if not os.path.exists(dirname):
      try:
        os.makedirs(dirname)
      except:
        error = &#39;ERROR_CREATE_DIR&#39;
    elif not os.access(dirname, os.W_OK):
      error = &#39;ERROR_DIR_NOT_WRITEABLE&#39;
    if not error:
      fileobj.save(filepath)
      url = url_for(&#39;static&#39;, filename=&#39;%s/%s&#39; % (&#39;upload&#39;, rnd_name))
  else:
    error = &#39;post error&#39;
  res = """

<script type="text/javascript">
 window.parent.CKEDITOR.tools.callFunction(%s, &#39;%s&#39;, &#39;%s&#39;);
</script>

""" % (callback, url, error)
  response = make_response(res)
  response.headers["Content-Type"] = "text/html"
  return response

上傳檔案的取得及儲存部分比較簡單，是標準的檔案上傳。這裡主要講講上傳成功後如何回呼的問題。

CKEditor檔案上傳之後，服務端傳回HTML文件，HTML檔案包含JAVASCRIPT腳本，JS腳本會呼叫一個回呼函數，若無錯誤，回呼函數將傳回的URL轉交給CKEditor處理。

這3個參數依序是：

  • CKEditorFuncNum : 回呼函數序號。 CKEditor透過URL參數提交給服務端

  • URL : 上傳後檔案的URL

  • Error : 錯誤訊息。若沒有錯誤，傳回空字串

使用藍本
在大型應用程式中經常會使用藍本，在藍本檢視中整合CKEditor的步驟和app視圖基本上相同。

1. 建立藍本時需指明藍本static目錄的絕對路徑

#
demo = Blueprint(&#39;demo&#39;, static_folder="/path/to/static")

2. 對應url需加上藍本端點

<script src="{{url_for(&#39;.static&#39;, filename=&#39;ckeditor/ckeditor.js&#39;)}}"></script>

<script type="text/javascript">
  CKEDITOR.replace(
    "ckeditor_demo", {
      filebrowserUploadUrl: &#39;./ckupload/&#39;
    }
  );
</script>

3. 設定endpoint端點值

response = form.upload(endpoint=demo)

更多Python的Flask框架中整合CKeditor富文本編輯器相關文章請關注PHP中文網！

#
陳述：
本文內容由網友自願投稿，版權歸原作者所有。本站不承擔相應的法律責任。如發現涉嫌抄襲或侵權的內容，請聯絡admin@php.cn
上一篇：Python的Flask站點中整合xhEditor文字編輯器下一篇：Python的Flask站點中整合xhEditor文字編輯器

相關文章

看更多