Merge pull request #4 from LeetCode-OpenSource/upgrade_django_ckeditor

Upgrade django ckeditor

Author: daierji

CHANGELOG.rst

@@ -1,6 +1,24 @@
 Changelog
 =========
 
+5.6.1
+-----
+#. Fix bad pypi package
+
+
+5.6.0
+-----
+#. Django 2.1 compatibility, minimal supported Django version is 1.11 LTS
+#. Option to set custom django file backend for CKEditor uploader app.
+
+
+5.5.0
+-----
+#. CKEditor 4.9.2
+#. Documentation improvements
+#. Allow non-string properties of user for CKEDITOR_RESTRICT_BY_USER
+
+
 5.4.0
 -----
 #. Django 2.0 compatibility

README.rst

@@ -13,7 +13,7 @@ Provides a ``RichTextField``, ``RichTextUploadingField``, ``CKEditorWidget`` and
 This version also includes:
 
 #. support to django-storages (works with S3)
-#. updated ckeditor to version 4.7
+#. updated ckeditor to version 4.9
 #. included all ckeditor language and plugin files to made everyone happy! ( `only the plugins maintained by the ckeditor develops team <https://github.com/ckeditor/ckeditor-dev/tree/4.6.2/plugins>`__ )
 
 .. contents:: Contents
@@ -34,19 +34,23 @@ Required
 #. Run the ``collectstatic`` management command: ``$ ./manage.py collectstatic``. This will copy static CKEditor required media resources into the directory given by the ``STATIC_ROOT`` setting. See `Django's documentation on managing static files <https://docs.djangoproject.com/en/dev/howto/static-files>`__ for more info.
 
 #. CKEditor needs to know where its assets are located because it loads them
-   lazily only when needed. The location is determined by looking at a script
-   tag which includes a URL ending in ``ckeditor.js``. This does not work all
+   lazily only when needed. The location is determined in the ``ckeditor-init.js``
+   script. and defaults to ``static/ckeditor/ckeditor/``. This does not work all
    the time, for example when using ``ManifestStaticFilesStorage``, any asset
-   packaging pipeline or whatnot. django-ckeditor is quite good at
-   automatically detecting the correct place even then, but sometimes you have
-   to hardcode ``CKEDITOR_BASEPATH`` somewhere. It is recommended to override
-   the ``admin/base_site.html`` template with your own if you really need to do
+   packaging pipeline or whatnot. django-ckeditor is quite good at automatically
+   detecting the correct place even then, but sometimes you have to hardcode
+   ``CKEDITOR_BASEPATH`` somewhere. This can be hardcoded in settings, i.e.::
+
+        CKEDITOR_BASEPATH = "/my_static/ckeditor/ckeditor"
+
+   It is possible to override
+   the ``admin/change_form.html`` template with your own if you really need to do
    this, i.e.::
 
-        {% extends "admin/base_site.html" %}
+        {% extends "admin/change_form.html" %}
 
         {% block extrahead %}
-        <script>window.CKEDITOR_BASEPATH = '/static/ckeditor/ckeditor/';</script>
+        <script>window.CKEDITOR_BASEPATH = '/my_static/ckeditor/ckeditor/';</script>
         {{ block.super }}
         {% endblock %}
 
@@ -94,6 +98,7 @@ Required for using widget with file upload
    - ``pillow``: Uses Pillow
 
 
+
 Optional - customizing CKEditor editor
 --------------------------------------
 
@@ -165,6 +170,8 @@ Optional for file upload
 
 #. Set the ``CKEDITOR_RESTRICT_BY_DATE`` setting to ``True`` to bucked uploaded files by year/month/day.
 
+#. You can set a custom file storage for CKEditor uploader by defining it under ``CKEDITOR_STORAGE_BACKEND`` variable in settings.
+
 
 Usage
 -----
@@ -222,6 +229,7 @@ or you can load the media manually as it is done in the demo app::
     <script type="text/javascript" src="{% static "ckeditor/ckeditor-init.js" %}"></script>
     <script type="text/javascript" src="{% static "ckeditor/ckeditor/ckeditor.js" %}"></script>
 
+When you need to render ``RichTextField``'s HTML output in your templates safely, just use ``{{ content|safe }}``,  `Django's safe filter <https://docs.djangoproject.com/en/2.0/ref/templates/builtins/#std:templatefilter-safe>`_
 
 
 Management Commands

ckeditor/__init__.py

@@ -1,2 +1,2 @@
-VERSION = (5, 4, 3)
+VERSION = (5, 6, 2)
 __version__ = '.'.join(map(str, VERSION))

ckeditor/static/ckeditor/ckeditor/CHANGES.md

@@ -1,8 +1,8 @@
 Software License Agreement
 ==========================
 
-CKEditor - The text editor for Internet - http://ckeditor.com
-Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved.
+CKEditor - The text editor for Internet - https://ckeditor.com/
+Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved.
 
 Licensed under the terms of any of the following licenses at your
 choice:
@@ -37,7 +37,7 @@ done by developers outside of CKSource with their express permission.
 
 The following libraries are included in CKEditor under the MIT license (see Appendix D):
 
-* CKSource Samples Framework (included in the samples) - Copyright (c) 2014-2017, CKSource - Frederico Knabben.
+* CKSource Samples Framework (included in the samples) - Copyright (c) 2014-2018, CKSource - Frederico Knabben.
 * PicoModal (included in `samples/js/sf.js`) - Copyright (c) 2012 James Frasca.
 * CodeMirror (included in the samples) - Copyright (C) 2014 by Marijn Haverbeke <marijnh@gmail.com> and others.
 

ckeditor/static/ckeditor/ckeditor/LICENSE.md

@@ -1,7 +1,7 @@
 CKEditor 4
 ==========
 
-Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved.
+Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved.
 http://ckeditor.com - See LICENSE.md for license information.
 
 CKEditor is a text editor to be used inside web pages. It's not a replacement

ckeditor/static/ckeditor/ckeditor/README.md

@@ -1,32 +1,32 @@
-/**
- * @license Copyright (c) 2003-2017, CKSource - Frederico Knabben. All rights reserved.
- * For licensing, see LICENSE.md or http://ckeditor.com/license
- */
-
-/**
- * This file was added automatically by CKEditor builder.
- * You may re-use it at any time to build CKEditor again.
- *
- * If you would like to build CKEditor online again
- * (for example to upgrade), visit one the following links:
- *
- * (1) http://ckeditor.com/builder
- *     Visit online builder to build CKEditor from scratch.
- *
- * (2) http://ckeditor.com/builder/e36bab0e1b0cd2508382db742151f0ca
- *     Visit online builder to build CKEditor, starting with the same setup as before.
- *
- * (3) http://ckeditor.com/builder/download/e36bab0e1b0cd2508382db742151f0ca
- *     Straight download link to the latest version of CKEditor (Optimized) with the same setup as before.
- *
- * NOTE:
- *    This file is not used by CKEditor, you may remove it.
- *    Changing this file will not change your CKEditor configuration.
- */
-
-var CKBUILDER_CONFIG = {
-	skin: 'moono-lisa',
-	preset: 'full',
+/**
+ * @license Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved.
+ * For licensing, see LICENSE.md or http://ckeditor.com/license
+ */
+
+/**
+ * This file was added automatically by CKEditor builder.
+ * You may re-use it at any time to build CKEditor again.
+ *
+ * If you would like to build CKEditor online again
+ * (for example to upgrade), visit one the following links:
+ *
+ * (1) http://ckeditor.com/builder
+ *     Visit online builder to build CKEditor from scratch.
+ *
+ * (2) http://ckeditor.com/builder/d92ab52ffca329d7b5e1b78ef77a81f9
+ *     Visit online builder to build CKEditor, starting with the same setup as before.
+ *
+ * (3) http://ckeditor.com/builder/download/d92ab52ffca329d7b5e1b78ef77a81f9
+ *     Straight download link to the latest version of CKEditor (Optimized) with the same setup as before.
+ *
+ * NOTE:
+ *    This file is not used by CKEditor, you may remove it.
+ *    Changing this file will not change your CKEditor configuration.
+ */
+
+var CKBUILDER_CONFIG = {
+	skin: 'moono-lisa',
+	preset: 'full',
 	ignore: [
 		'.DS_Store',
 		'.bender',
@@ -110,6 +110,7 @@ var CKBUILDER_CONFIG = {
 		'templates' : 1,
 		'toolbar' : 1,
 		'undo' : 1,
+		'uploadimage' : 1,
 		'wsc' : 1,
 		'wysiwygarea' : 1
 	},