├── .gitattributes
├── .gitignore
├── LICENSE
├── README.md
├── easy_comment
├── __init__.py
├── admin.py
├── apps.py
├── forms.py
├── handlers.py
├── migrations
│ └── __init__.py
├── models.py
├── static
│ ├── ckeditor
│ │ └── ckeditor
│ │ │ └── plugins
│ │ │ └── prism
│ │ │ ├── Creating and Editing Code Snippets.txt
│ │ │ ├── Installation Guide.txt
│ │ │ ├── LICENSE.txt
│ │ │ ├── README.md
│ │ │ ├── lib
│ │ │ └── prism
│ │ │ │ ├── prism_patched.min.css
│ │ │ │ └── prism_patched.min.js
│ │ │ └── plugin.js
│ ├── easy_comment
│ │ ├── css
│ │ │ ├── bootstrap.css
│ │ │ ├── comment.css
│ │ │ └── prism.css
│ │ ├── image
│ │ │ └── default.png
│ │ └── js
│ │ │ └── comment.js
│ └── notifications
│ │ └── notice.js
├── templates
│ ├── easy_comment
│ │ ├── comment.html
│ │ └── comment_entry.html
│ └── notifications
│ │ ├── email
│ │ ├── email.html
│ │ └── email.txt
│ │ ├── list.html
│ │ ├── notice.html
│ │ └── test_tags.html
├── templatetags
│ ├── __init__.py
│ └── comment_tags.py
├── tests.py
├── urls.py
└── views.py
├── online_status
├── __init__.py
├── admin.py
├── apps.py
├── middleware.py
├── migrations
│ └── __init__.py
├── models.py
├── settings.py
├── tests.py
└── views.py
└── requirements
└── requirements.txt
/.gitattributes:
--------------------------------------------------------------------------------
1 | *.css linguist-language=Python
2 | *.html linguist-language=Python
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | # Byte-compiled / optimized / DLL files
2 | __pycache__/
3 | *.py[cod]
4 | *$py.class
5 |
6 | # C extensions
7 | *.so
8 |
9 | # Distribution / packaging
10 | .Python
11 | env/
12 | build/
13 | develop-eggs/
14 | dist/
15 | downloads/
16 | eggs/
17 | .eggs/
18 | lib/
19 | lib64/
20 | parts/
21 | sdist/
22 | var/
23 | wheels/
24 | *.egg-info/
25 | .installed.cfg
26 | *.egg
27 |
28 | # PyInstaller
29 | # Usually these files are written by a python script from a template
30 | # before PyInstaller builds the exe, so as to inject date/other infos into it.
31 | *.manifest
32 | *.spec
33 |
34 | # Installer logs
35 | pip-log.txt
36 | pip-delete-this-directory.txt
37 |
38 | # Unit test / coverage reports
39 | htmlcov/
40 | .tox/
41 | .coverage
42 | .coverage.*
43 | .cache
44 | nosetests.xml
45 | coverage.xml
46 | *.cover
47 | .hypothesis/
48 |
49 | # Translations
50 | *.mo
51 | *.pot
52 |
53 | # Django stuff:
54 | *.log
55 | local_settings.py
56 | media/
57 | easy_comment/migrations
58 | online_status/migrations
59 | .idea/
60 |
61 | # Flask stuff:
62 | instance/
63 | .webassets-cache
64 |
65 | # Scrapy stuff:
66 | .scrapy
67 |
68 | # Sphinx documentation
69 | docs/_build/
70 |
71 | # PyBuilder
72 | target/
73 |
74 | # Jupyter Notebook
75 | .ipynb_checkpoints
76 |
77 | # pyenv
78 | .python-version
79 |
80 | # celery beat schedule file
81 | celerybeat-schedule
82 |
83 | # SageMath parsed files
84 | *.sage.py
85 |
86 | # dotenv
87 | .env
88 |
89 | # virtualenv
90 | .venv
91 | venv/
92 | ENV/
93 |
94 | # Spyder project settings
95 | .spyderproject
96 | .spyproject
97 |
98 | # Rope project settings
99 | .ropeproject
100 |
101 | # mkdocs documentation
102 | /site
103 |
104 | # mypy
105 | .mypy_cache/
106 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | MIT License
2 |
3 | Copyright (c) 2017 Aaron Zhao
4 |
5 | Permission is hereby granted, free of charge, to any person obtaining a copy
6 | of this software and associated documentation files (the "Software"), to deal
7 | in the Software without restriction, including without limitation the rights
8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 |
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 |
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | 与之前的版本相比主要的差别是现在评论使用ajax异步加载、支持评论分页(下拉无限加载),无须再绑定模型,可以评论任何对象(也可以是空的),目前采用的一级评论,按时间倒序,但是评论模型依旧继承了MPTTModel来记录层级顺序,未来会加入二级评论和多层级评论的模板供大家选择。
2 |
3 | ## 项目地址
4 |
5 | [https://github.com/r26zhao/django-easy-comment](https://github.com/r26zhao/django-easy-comment) 如果觉得对你有所帮助的话,请给个star (◕ᴗ◕✿)
6 | 开发环境:py3.6、Django1.11
7 |
8 | 目前没有在py2.7测试过,但根据使用py2.7的小伙伴反应,会报出编码错误,由easy_comment/handlers.py 文件里的中文引起的,把里面的中文处理一下即可解决。
9 | ## 安装
10 |
11 | 1.从github把`easy_comment`、`online_status`和`requirements`拉取到本地项目
12 |
13 | 2.安装依赖包
14 |
15 | `pip install -r requirements/requirements.txt`
16 |
17 | 3.在settings.py里把上面安装的app加入到`INSTALLED_APPS`中
18 | ```
19 | INSTALLED_APPS = [
20 | 'ckeditor',
21 | 'ckeditor_uploader',
22 | 'mptt',
23 | 'easy_comment',
24 | 'notifications',
25 | 'online_status',
26 | ]
27 | ```
28 | 添加ckeditor相关设置,使编辑器可以添加代码块,上传图片
29 | ```
30 | #ckeditor setup
31 | MEDIA_ROOT = os.path.join(BASE_DIR, 'media')
32 | MEDIA_URL = '/media/'
33 | CKEDITOR_UPLOAD_PATH = 'upload/'
34 | CKEDITOR_IMAGE_BACKEND = 'pillow'
35 | CKEDITOR_CONFIGS = {
36 | 'default': {
37 | 'width':'auto',
38 | 'height':'150px',
39 | 'image_previewText':' ',
40 | 'tabSpaces': 4,
41 | 'toolbar': 'Custom',
42 | 'toolbar_Custom': [
43 | ['Bold', 'Italic', 'Underline', 'Format', 'RemoveFormat'],
44 | ['NumberedList', 'BulletedList'],
45 | ['Blockquote', 'CodeSnippet'],
46 | ['Image', 'Link', 'Unlink']
47 | ],
48 | 'extraPlugins': ','.join(['codesnippet','uploadimage','prism','widget','lineutils',]),
49 | }
50 | }
51 | CKEDITOR_ALLOW_NONIMAGE_FILES = False
52 | # 限制用户查看上传图片的权限, 只能看自己传的图片
53 | CKEDITOR_RESTRICT_BY_USER = True
54 | CKEDITOR_RESTRICT_BY_DATE = True
55 | CKEDITOR_BROWSE_SHOW_DIRS = True
56 | ```
57 | 更多ckeditor的设置,可以参考下这里:[django博客开发:添加富文本编辑器ckeditor](http://www.aaron-zhao.com/post/1/)
58 |
59 | 4.`settings.py`里的其他设置
60 | ```
61 | AUTH_USER_MODEL = 'xxx' # 格式是 app_name+model_name
62 | SEND_NOTIFICATION_EMAIL = False
63 | COMMENT_PAGINATE_BY = 10
64 | ```
65 | **AUTH_USER_MODEL** 规定了使用User的model,默认是auth.User, django自带的用户模型
66 |
67 | **SEND_NOTIFICATION_EMAIL** 设置是否接收评论通知邮件,默认False 不接收
68 |
69 | **COMMENT_PAGINATE_BY** 设置评论分页,比如10,就是每10条评论一页,如果设置为None,则不分页,默认10
70 |
71 | 5.在项目的urls.py里加入`easy_comment`, `ckeditor_upload` 和 `notification`的url
72 | ```
73 | from django.conf.urls import url,include
74 | from django.conf.urls.static import static
75 | from django.conf import settings
76 | from django.contrib import admin
77 | import notifications.urls
78 |
79 | urlpatterns = [
80 | url(r'', include('ckeditor_uploader.urls')),
81 | url(r'', include('easy_comment.urls')),
82 | url(r'^notifications/', include(notifications.urls, namespace='notifications')),
83 | ] + static(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT)
84 | ```
85 |
86 | 6.迁移数据库
87 | ```
88 | python manage.py makemigrations
89 | python manage.py migrate
90 | ```
91 | ## 使用模板
92 |
93 | 在detail.html(显示文章)模板里,显示评论的地方引入评论模板
94 | ```
95 | {% include 'easy_comment/comment.html' with entry=传递给模板的变量名 %}
96 | ```
97 | 这里的entry是detai视图函数通过context字典传递给模板的变量,如果你使用了不一样的变量名,比如`context = {"article" : article}`, 则写`entry=article`
98 | ### 评论对象为空
99 |
100 | 如果你评论的对象是空的,需要在comment.html的第129、147行把 `{% url 'easy_comment:comment_list' entry.id %}` 改为 `{% url 'easy_comment:comment_list_no_object' %}`
101 | ## 引入静态文件
102 | ```
103 |
104 |
105 |
106 |
107 |
108 |
109 |
110 |
111 |
112 |
113 | ```
114 | ## 通知功能
115 |
116 | 每当用户发表一条评论、回复,都会生成一个notification实例,管理员(admin)可以收到所有通知,普通用户仅可以收到与自己相关的回复通知,自己对自己的回复是不会产生通知的。
117 | ## 添加管理员
118 |
119 | 在`settings.py`里添加ADMINS,需要提供管理员的用户名和邮箱。
120 | ```
121 | ADMINS = (('Aaron', 'rudy710@qq.com'),) # 网站管理员
122 | ```
123 | ## 开启站内通知
124 |
125 | 在base.html模板里引入`notifications/notice.js`
126 | ```
127 |
128 | ```
129 | 如果想要显示未读通知的数量,写一个``,notice.js脚本会自动更新并向这个span里添加数据,每30秒一次。
130 |
131 |
132 |
133 | `/notifications/ `当前登录用户的所有通知
134 |
135 | `/notifications/unread` 当前用户的未读通知
136 | ## 开启邮件通知
137 |
138 | 默认情况下是不发邮件通知的。开启邮件通知功能后,只有当用户不在线的情况下,才会发邮件。
139 | ```
140 | SEND_NOTIFICATION_EMAIL = True # 开启邮件通知
141 |
142 | # SMTP设置
143 | EMAIL_HOST = ''
144 | EMAIL_HOST_USER = ''
145 | EMAIL_HOST_PASSWORD = ''
146 | EMAIL_PORT =
147 | EMAIL_USE_SSL =
148 |
149 | 添加'online_status.middleware.OnlineStatusMiddleware' 到 MIDDLEWARE
150 |
151 | MIDDLEWARE = [
152 | ···
153 | ···
154 | ···
155 | 'online_status.middleware.OnlineStatusMiddleware',
156 | ]
157 |
158 | USER_ONLINE_TIMEOUT = 600
159 | ```
160 |
161 | 判断用户是否在线,是通过判断用户在一定时间范围内是否有发送新的request,如果超出时间范围,视为不在线。这是时间是通过 `USER_ONLINE_TIMEOUT` 来设置,默认是600秒,也就是10分钟。
162 | ## 关于django-ckeditor
163 |
164 | 默认情况下`django-ckeditor`设置的只允许管理员发送图片,要让普通用户也可以发图片的话,需要`ckeditor_uploader/urls.py`里进行修改,它的`upload` 和 `browse`方法用了`staff_member_required`装饰器,把它换成`login_required`装饰器即可。
165 | ```
166 | if django.VERSION >= (1, 8):
167 | urlpatterns = [
168 | url(r'^upload/', login_required(views.upload), name='ckeditor_upload'),
169 | url(r'^browse/', never_cache(login_required(views.browse)), name='ckeditor_browse'),
170 | ]
171 | ```
172 | ## 总结
173 |
174 | 其实实现一个评论功能并不难,更多的时间是花在如何在前端显示加载评论。本文采用的是后端view返回json,然后前端调用api,ajax异步加载,某种程度上也算是前后分离了。说到前后分离,就要扯到restful api了,后面会介绍下[django-rest-framework](https://github.com/encode/django-rest-framework/tree/master) 的使用(给自己挖个坑)。
175 |
176 |
177 |
178 | ok,扯到这里吧,大家有任何问题,随时交流,评论区留言或者qq(370297300)联系。
179 |
--------------------------------------------------------------------------------
/easy_comment/__init__.py:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/r26zhao/django-easy-comment/f9ef4a2a8a567c7f08d0059c4b5550fa735de34d/easy_comment/__init__.py
--------------------------------------------------------------------------------
/easy_comment/admin.py:
--------------------------------------------------------------------------------
1 | from django.contrib import admin
2 | from mptt.admin import MPTTModelAdmin
3 |
4 | from .models import Comment
5 | # Register your models here.
6 |
7 | admin.site.register(Comment, MPTTModelAdmin)
8 |
--------------------------------------------------------------------------------
/easy_comment/apps.py:
--------------------------------------------------------------------------------
1 | from django.apps import AppConfig
2 |
3 |
4 | class EasyCommentConfig(AppConfig):
5 | name = 'easy_comment'
6 |
--------------------------------------------------------------------------------
/easy_comment/forms.py:
--------------------------------------------------------------------------------
1 | from django import forms
2 | from django.template.defaultfilters import striptags
3 |
4 | from .models import Comment
5 |
6 |
7 | class CommentForm(forms.ModelForm):
8 | honeypot = forms.CharField(required=False,
9 | label='If you enter anything in this field, you comment will be treated as spam!')
10 |
11 | class Meta:
12 | model = Comment
13 | fields = ('content', 'parent', 'content_type', 'object_id')
14 |
15 | def clean_content(self):
16 | """
17 | 检查content字段是否为空
18 | """
19 | value = self.cleaned_data['content']
20 | if striptags(value).replace(' ', '').replace(' ', '') == '' and ' 0:
47 | notify.send(instance.user, recipient=recipient,
48 | verb='回复了 %s' % instance.parent.user.username,
49 | action_object=instance,
50 | target=instance.content_object,
51 | description=instance.content)
52 | if SEND_NOTIFICATION_EMAIL:
53 | email_handler(*recipient)
54 | if not instance.user.username == instance.parent.user.username:
55 | notify.send(instance.user, recipient=instance.parent.user, verb='@了你',
56 | action_object=instance,
57 | target=instance.content_object,
58 | description=instance.content)
59 | if SEND_NOTIFICATION_EMAIL:
60 | email_handler(instance.parent.user)
61 | else:
62 | if recipient.count() > 0:
63 | notify.send(instance.user, recipient=recipient, verb='发表了评论',
64 | action_object=instance,
65 | target=instance.content_object,
66 | description=instance.content)
67 | if SEND_NOTIFICATION_EMAIL:
68 | email_handler(*recipient)
69 |
70 |
71 | post_save.connect(comment_handler, sender=Comment)
72 |
--------------------------------------------------------------------------------
/easy_comment/migrations/__init__.py:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/r26zhao/django-easy-comment/f9ef4a2a8a567c7f08d0059c4b5550fa735de34d/easy_comment/migrations/__init__.py
--------------------------------------------------------------------------------
/easy_comment/models.py:
--------------------------------------------------------------------------------
1 | from mptt.models import TreeForeignKey, MPTTModel
2 | from ckeditor_uploader.fields import RichTextUploadingField
3 | from django.db import models
4 | from django.conf import settings
5 | from django.core.cache import cache
6 | from django.template.loader import render_to_string
7 | from django.contrib.contenttypes.models import ContentType
8 | from django.contrib.contenttypes.fields import GenericForeignKey
9 |
10 | # Create your models here.
11 |
12 |
13 | class Comment(MPTTModel):
14 | user = models.ForeignKey(settings.AUTH_USER_MODEL, blank=True, null=True,)
15 | content_type = models.ForeignKey(ContentType, blank=True, null=True)
16 | object_id = models.PositiveIntegerField(blank=True, null=True, db_index=True)
17 | content_object = GenericForeignKey('content_type', 'object_id')
18 | parent = TreeForeignKey('self', blank=True, null=True, verbose_name='父级评论')
19 | content = RichTextUploadingField(verbose_name='评论', config_name='default')
20 | created = models.DateTimeField(auto_now_add=True, verbose_name='提交时间')
21 |
22 | class MPTTMeta:
23 | order_insertion_by = ['created']
24 |
25 | def __str__(self):
26 | if self.parent is not None:
27 | return '{} 回复 {}'.format(self.user.username, self.parent.user.username)
28 | if self.content_object:
29 | return '{} 评论 {}_{}'.format(self.user.username, self.content_type.model, self.object_id)
30 | else:
31 | return '{} 发表了评论'.format(self.user.username)
32 |
33 | def to_html(self):
34 | """
35 | 把每一条comment的内容渲染成html,并保存在缓存里,不需要每次都渲染了
36 | :return html
37 | """
38 | key = "comment_{}_html".format(self.id)
39 | html = cache.get(key)
40 | if not html:
41 | html = render_to_string('easy_comment/comment_entry.html', context={'comment': self})
42 | cache.set(key, html, timeout=600)
43 | return html
44 |
--------------------------------------------------------------------------------
/easy_comment/static/ckeditor/ckeditor/plugins/prism/Creating and Editing Code Snippets.txt:
--------------------------------------------------------------------------------
1 | CKEditor Prism Highlighter Plugin
2 |
3 |
4 | I. CREATING NEW PRISM CODE SNIPPET
5 |
6 | 1.) Click the Code Snippet icon in the CKEditor Toolbar. The Dialog window will now pop-up.
7 | 2.) Select the language that will be the basis for the syntax highlighting.
8 | 3.) Input the code snippets to be highlighted.
9 | 4.) Click the OK button.
10 |
11 |
12 | II. EDITING EXISTING PRISM CODE SNIPPET
13 |
14 | Just double-click the target code snippet block and its dialog window will pop-up.
15 | This happens since a code snippet is implemented as a widget in which by default
16 | has a mask/wrapper covering the entire widget block so that you could click in
17 | any part of it.
18 |
19 |
20 | Note that you could also copy and paste the existing code snippets for faster workflow
21 | since it will be already set in your desired programming language and you will just
22 | need to edit/set the contents.
23 |
--------------------------------------------------------------------------------
/easy_comment/static/ckeditor/ckeditor/plugins/prism/Installation Guide.txt:
--------------------------------------------------------------------------------
1 | I. OVERVIEW
2 |
3 | This Prism Highlighter plugin requires CKEditor 4.4 or later versions, and it extends
4 | the Code Snippet widget/plugin. It requires CKEditor 4.4 since the Code Snippet's mechanism
5 | for extending/overriding the highlighting engine is only available starting from that version.
6 | Hence, the Code Snippet plugin is also a hard dependency
7 | (which also depends on Widget and Line Utilities).
8 |
9 | In essence, we need to download these plugins:
10 | a. Widget (http://ckeditor.com/addon/widget)
11 | b. Line Utilities (http://ckeditor.com/addon/lineutils)
12 | c. Code Snippet (http://ckeditor.com/addon/codesnippet),
13 | d. Prism Highlighter plugin (http://ckeditor.com/addon/prism).
14 |
15 | For Linux users, after downloading, make sure that the zipped folders or the target CKEditor folders
16 | have right read/write/execute permissions, otherwise you might encounter loading issues
17 | like the "File x could not be found" notice. You might need to run "sudo chmod 777 -R lineutils",
18 | "sudo chmod 777 -R widget", "sudo chmod 777 -R codesnippet", and "sudo chmod 777 -R prism",
19 | before or after copying them in the appropriate CKEditor folders.
20 |
21 | After the installation (Part 2 for Non-Drupal, Part 3 for Drupal), read the important notes in part 4 also to avoid surprises.
22 |
23 |
24 | II. STANDARD INSTALLATION (Usual Setup)
25 |
26 | 1) After unzipping the folder, paste the 4 folders
27 | ("lineutils", "widget", "codesnippet", and "prism")
28 | to "ckeditor/plugins" folder. After that, you should have the following folder structures:
29 | "ckeditor/plugins/lineutils"
30 | "ckeditor/plugins/widget"
31 | "ckeditor/plugins/codesnippet"
32 | "ckeditor/plugins/prism"
33 |
34 | 2) Edit the "ckeditor/config.js" file, and add the following:
35 | if there's no existing line yet:
36 | config.extraPlugins = "lineutils,widget,codesnippet,prism";
37 |
38 | otherwise, append it to the existing list, no extra spaces are allowed:
39 | config.extraPlugins =
40 | "existing_plugin,another_existing_plugin,lineutils,widget,codesnippet,prism";
41 |
42 | 3.) Just to make sure, clear the web browser's cache after modifying your configuration.
43 | Clearing the browser's cache is also very important
44 | since the CKEditor's JS and CSS assets/components are cached also in the browser.
45 |
46 |
47 | III. DRUPAL INSTALLATION
48 |
49 | In Drupal, the typical/recommended way to embed the CKEditor WSYIWYG is
50 | through the CKEditor module (https://drupal.org/project/ckeditor),
51 | and then building/loading the corresponding CKEditor JS library (http://ckeditor.com/).
52 |
53 | Drupal's CKEditor module is typically installed to have this internal path:
54 | sites/all/modules/ckeditor or sites/all/modules/contrib/ckeditor.
55 |
56 | Moreover, the CKEditor JS Library is typically installed to have this internal path:
57 | "sites/all/modules/ckeditor/ckeditor/ckeditor.js" or
58 | "sites/all/modules/contrib/ckeditor/ckeditor/ckeditor.js" or
59 | "sites/all/libraries/ckeditor/ckeditor.js."
60 |
61 | With Drupal's latest CKEditor (https://www.drupal.org/project/ckeditor, 7.x-1.16),
62 | the Widget and Lineutils plugins are already bundled and enabled by default which is indicated
63 | as the "Full" CKEditor.js build if you check in the the CKEditor Global Profile admin page
64 | "admin/config/content/ckeditor/editg"
65 | Path to CKEditor: //cdn.ckeditor.com/4.4.3/full-all
66 |
67 | the path is pointing to the CDN copy/build of CKEditor 4.4.3 with Full Plugins,
68 | so the Widget and Lineutils plugins should not be downloaded anymore,
69 | including the Code Snippet (but Code Snippet must still be activated in
70 | the Drupal's CKEditor Configuration page since it's not activated by default);
71 | actually, conflicts and console error like this will show if you try to still download
72 | and integrate them into the setup:
73 | Uncaught TypeError: CKEDITOR.tools.getIndex is not a function
74 |
75 | Hence, it is highly recommended that you use the latest Drupal CKEditor module
76 | since it would be the easiest to setup, especially in the context of Prism Highlighter plugin.
77 |
78 | Summary of Drupal's CKEditor 7.x-1.16 version:
79 | a. Widget and Line Utilities are already bundled and activated by default.
80 | b. Code Snippet is bundled but not activated
81 | c. Prism Highlighter must be downloaded and activated.
82 |
83 | The instructions below are guides on how to do (b) and (c) above.
84 |
85 | These are the possible plugin setups, the idea is to copy the plugin folder, enable it,
86 | and make it visible in the toolbar:
87 |
88 | A. DRUPAL INSTALLATION OPTION 1 (Easier Setup Than Option 2)
89 |
90 | 1.) Download and unzip the plugin here (depending on your setup):
91 | "sites/all/modules/ckeditor/plugins" or
92 | "sites/all/modules/contrib/ckeditor/plugins".
93 |
94 | After that, you should have this folder structure:
95 | "ckeditor/plugins/prism"
96 |
97 | 2.) We should now activate the new plugin and add them to the toolbar.
98 | This is done by configuring the CKEditor Profile Settings,
99 | in which by default is located in:
100 | "admin/config/content/ckeditor/edit/Advanced"
101 |
102 | A. Activate the Code Snippet and Prism Highlighter Plugins
103 | In EDITOR APPEARANCE >>> Plugins section:
104 | Enable the corresponding checkboxes for the Code Snippet and Prism Highlighter.
105 | This is the text displayed adjacent to their checkboxes:
106 | "Plugin for inserting Code Snippets ..."
107 | "Plugin file: prism"
108 |
109 | B. Add the Code Snippet plugin to the Toolbar
110 | Prism Highlighter just overrides the highlighting engine (back-end)
111 | of Code Snippet so it doesn't need another toolbar button/icon and
112 | it could just utilize the existing one used by Code Snippet. In other words,
113 | Prism Highlighter is just the Code Snippet plugin but with some overrides
114 | under the hood.
115 |
116 | Ultimately, we should then make the activated Code Snippet plugin visible in the toolbar,
117 | skipping this step will make the Code Snippet plugin (and consequently Prism Highligher)
118 | inaccessible in the toolbar.
119 |
120 | In EDITOR APPEARANCE >>> Toolbar section:
121 | Drag the Code Snippet icon (black-colored) from the 'All Buttons' section
122 | to the 'Used Buttons' section.
123 |
124 | 3.) Then, click the Save button. Clear the Drupal's overall cache AND
125 | clear the browser's cache. Clearing the browser's cache is also
126 | very important since the CKEditor's JS and CSS assets/components
127 | are cached also in the browser.
128 |
129 | As indicated above, using the "sites/all/modules/ckeditor/plugins" or
130 | "sites/all/modules/contrib/ckeditor/plugins"
131 | will work with no additional custom hooks programming since by default
132 | CKEditor utilize that folder in the CKEditor Global Profile Settings:
133 | "admin/config/content/ckeditor/editg".
134 |
135 | If you go that Global Profile Settings page, this will be indicated
136 | (unless you override the default configuration):
137 | Path to the CKEditor plugins directory: "%m/plugins"
138 |
139 | In which "%m" refers to the base URL path where the CKEditor module is stored,
140 | and defaults to "sites/all/modules/ckeditor" or "sites/all/modules/contrib/ckeditor".
141 |
142 |
143 | B. DRUPAL INSTALLATION OPTION 2
144 |
145 | With the advent of Libraries API (https://drupal.org/project/libraries),
146 | Drupal offers more flexibility in the handling of external/third-party libraries,
147 | which means a clean mechanism that provides a separation of control between
148 | the CKEditor module and CKEditor library, and implies that we could
149 | safely upgrade the library and module independent to each other.
150 | Having a Libraries folder (sites/all/libraries) is also a very common setup in Drupal.
151 |
152 | This setup assumes that you've already installed and enabled the Libraries API module
153 | and configured the CKEditor library (sites/all/libraries/ckeditor).
154 | Make sure also that the "Path to CKEditor" settings indicated in
155 | the CKEditor's Global Profile (admin/config/content/ckeditor/editg) is
156 | indicated as "%l/ckeditor", in which "%l" refers to the "sites/all/libraries".
157 |
158 | 1.) Download and unzip the plugin here:
159 | "sites/all/libraries/ckeditor/plugins"
160 |
161 | After that, you should have this folder structure:
162 | "ckeditor/plugins/prism"
163 |
164 | 2.) We should now activate the new plugin.
165 | This is done by implementing first the hook_ckeditor_plugin() in a custom module:
166 |
167 | function MYMODULE_ckeditor_plugin() {
168 | return array(
169 | 'prism' => array(
170 | 'name' => 'prism',
171 | 'desc' => t('Prism Highlighter Plugin'),
172 | 'path' => libraries_get_path('ckeditor') . '/plugins/prism/',
173 | ),
174 | );
175 | }
176 |
177 | That hook will make it possible for the Prism Highlighter to show in
178 | the Drupal's CKEditor Configuration page.
179 |
180 | 3. We should now activate the new plugin and add them to the toolbar.
181 | This is done by configuring the CKEditor Profile Settings,
182 | in which by default is located in:
183 | "admin/config/content/ckeditor/edit/Advanced"
184 |
185 | A. Activate the Code Snippet and Prism Highlighter Plugins
186 | In EDITOR APPEARANCE >>> Plugins section:
187 | Enable the corresponding checkboxes for the Code Snippet and Prism Highlighter.
188 | This is the text displayed adjacent to their checkboxes:
189 | "Plugin for inserting Code Snippets ..."
190 | "Prism Highlighter Plugin"
191 |
192 | B. Add the Code Snippet plugin to the Toolbar
193 | Prism Highlighter just overrides the highlighting engine (back-end)
194 | of Code Snippet so it doesn't need another toolbar button/icon and
195 | it could just utilize the existing one used by Code Snippet. In other words,
196 | Prism Highlighter is just the Code Snippet plugin but with some overrides
197 | under the hood.
198 |
199 | Ultimately, we should then make the activated Code Snippet plugin visible in the toolbar,
200 | skipping this step will make the Code Snippet plugin (and consequently Prism Highligher)
201 | inaccessible in the toolbar.
202 |
203 | In EDITOR APPEARANCE >>> Toolbar section:
204 | Drag the Code Snippet icon (black-colored) from the 'All Buttons' section
205 | to the 'Used Buttons' section.
206 |
207 | 4.) Then, click the Save button. Clear the Drupal's overall cache AND
208 | clear the browser's cache. Clearing the browser's cache is also
209 | very important since the CKEditor's JS and CSS assets/components
210 | are cached also in the browser.
211 |
212 |
213 | IV. IMPORTANT NOTES
214 |
215 | A. HTML (SECURITY) FILTERING ISSUES
216 |
217 | Code Snippet/Prism Syntax Highlighter inserts
...
tags/blocks
218 | in your webpages. The is one of the main basis for the styling/syntax highlighting.
219 | Yet, for some systems like Drupal, tag is blacklisted by default
220 | when filtering/rendering page contents (actually will become when rendered).
221 | In Drupal, is allowed by default. Hence, you must allow/whitelist tag in order for the syntax highlighter to work as intended. In Drupal, you should add the """ tag
222 | as one of the whitelisted tags in the
223 | 'Allowed HTML tags' section in 'Limit allowed HTML tags' filter/tab in
224 | "admin/config/content/formats/filtered_html" page.
225 |
226 | B. VIEWING THE PAGE
227 |
228 | This syntax highlighter utilizes the Prism JS/CSS files in order to work as intended.
229 |
230 | Typically, there are 2 view modes for every page in CMS: CKEditor Mode and Page Mode.
231 | In CKEditor Mode (when editing the page), the Prism Highlighter handles the auto-loading
232 | of Prism JS and CSS files. In Page Mode (when rendering/viewing the actual page),
233 | Prism Highlighiter is not loaded anymore (since it depends on CKEditor.)
234 |
235 | In effect, you have to load the Prism JS and CSS files when displaying the page.
236 | You should add these link and script tags in your HTML :
237 |
238 | ...
239 |
240 |
241 |
242 |
243 |
244 | For example, in my personal site I have these values:
245 |
246 | ...
247 |
248 |
249 |
250 |
251 |
252 | Note that even if you're not using Prism Syntax Highlighter, and just using
253 | the Code Snippet plugin, you'll have to do the same steps:
254 | http://docs.ckeditor.com/#!/guide/dev_codesnippet.
255 |
256 | In Drupal, you could easily add the script using JS Injector module
257 | https://www.drupal.org/project/js_injector
258 |
259 | and for adding the stylesheet, you could use the CSS Injector module
260 | https://www.drupal.org/project/css_injector
261 |
262 | If you're a Drupal developer, you could do the JS/CSS insertions using the
263 | drupal_add_js() and drupal_add_css() functions in a custom module.
264 |
--------------------------------------------------------------------------------
/easy_comment/static/ckeditor/ckeditor/plugins/prism/LICENSE.txt:
--------------------------------------------------------------------------------
1 | GNU LESSER GENERAL PUBLIC LICENSE
2 | Version 2.1, February 1999
3 |
4 | Copyright (C) 1991, 1999 Free Software Foundation, Inc.
5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
6 | Everyone is permitted to copy and distribute verbatim copies
7 | of this license document, but changing it is not allowed.
8 |
9 | [This is the first released version of the Lesser GPL. It also counts
10 | as the successor of the GNU Library Public License, version 2, hence
11 | the version number 2.1.]
12 |
13 | Preamble
14 |
15 | The licenses for most software are designed to take away your
16 | freedom to share and change it. By contrast, the GNU General Public
17 | Licenses are intended to guarantee your freedom to share and change
18 | free software--to make sure the software is free for all its users.
19 |
20 | This license, the Lesser General Public License, applies to some
21 | specially designated software packages--typically libraries--of the
22 | Free Software Foundation and other authors who decide to use it. You
23 | can use it too, but we suggest you first think carefully about whether
24 | this license or the ordinary General Public License is the better
25 | strategy to use in any particular case, based on the explanations below.
26 |
27 | When we speak of free software, we are referring to freedom of use,
28 | not price. Our General Public Licenses are designed to make sure that
29 | you have the freedom to distribute copies of free software (and charge
30 | for this service if you wish); that you receive source code or can get
31 | it if you want it; that you can change the software and use pieces of
32 | it in new free programs; and that you are informed that you can do
33 | these things.
34 |
35 | To protect your rights, we need to make restrictions that forbid
36 | distributors to deny you these rights or to ask you to surrender these
37 | rights. These restrictions translate to certain responsibilities for
38 | you if you distribute copies of the library or if you modify it.
39 |
40 | For example, if you distribute copies of the library, whether gratis
41 | or for a fee, you must give the recipients all the rights that we gave
42 | you. You must make sure that they, too, receive or can get the source
43 | code. If you link other code with the library, you must provide
44 | complete object files to the recipients, so that they can relink them
45 | with the library after making changes to the library and recompiling
46 | it. And you must show them these terms so they know their rights.
47 |
48 | We protect your rights with a two-step method: (1) we copyright the
49 | library, and (2) we offer you this license, which gives you legal
50 | permission to copy, distribute and/or modify the library.
51 |
52 | To protect each distributor, we want to make it very clear that
53 | there is no warranty for the free library. Also, if the library is
54 | modified by someone else and passed on, the recipients should know
55 | that what they have is not the original version, so that the original
56 | author's reputation will not be affected by problems that might be
57 | introduced by others.
58 |
59 | Finally, software patents pose a constant threat to the existence of
60 | any free program. We wish to make sure that a company cannot
61 | effectively restrict the users of a free program by obtaining a
62 | restrictive license from a patent holder. Therefore, we insist that
63 | any patent license obtained for a version of the library must be
64 | consistent with the full freedom of use specified in this license.
65 |
66 | Most GNU software, including some libraries, is covered by the
67 | ordinary GNU General Public License. This license, the GNU Lesser
68 | General Public License, applies to certain designated libraries, and
69 | is quite different from the ordinary General Public License. We use
70 | this license for certain libraries in order to permit linking those
71 | libraries into non-free programs.
72 |
73 | When a program is linked with a library, whether statically or using
74 | a shared library, the combination of the two is legally speaking a
75 | combined work, a derivative of the original library. The ordinary
76 | General Public License therefore permits such linking only if the
77 | entire combination fits its criteria of freedom. The Lesser General
78 | Public License permits more lax criteria for linking other code with
79 | the library.
80 |
81 | We call this license the "Lesser" General Public License because it
82 | does Less to protect the user's freedom than the ordinary General
83 | Public License. It also provides other free software developers Less
84 | of an advantage over competing non-free programs. These disadvantages
85 | are the reason we use the ordinary General Public License for many
86 | libraries. However, the Lesser license provides advantages in certain
87 | special circumstances.
88 |
89 | For example, on rare occasions, there may be a special need to
90 | encourage the widest possible use of a certain library, so that it becomes
91 | a de-facto standard. To achieve this, non-free programs must be
92 | allowed to use the library. A more frequent case is that a free
93 | library does the same job as widely used non-free libraries. In this
94 | case, there is little to gain by limiting the free library to free
95 | software only, so we use the Lesser General Public License.
96 |
97 | In other cases, permission to use a particular library in non-free
98 | programs enables a greater number of people to use a large body of
99 | free software. For example, permission to use the GNU C Library in
100 | non-free programs enables many more people to use the whole GNU
101 | operating system, as well as its variant, the GNU/Linux operating
102 | system.
103 |
104 | Although the Lesser General Public License is Less protective of the
105 | users' freedom, it does ensure that the user of a program that is
106 | linked with the Library has the freedom and the wherewithal to run
107 | that program using a modified version of the Library.
108 |
109 | The precise terms and conditions for copying, distribution and
110 | modification follow. Pay close attention to the difference between a
111 | "work based on the library" and a "work that uses the library". The
112 | former contains code derived from the library, whereas the latter must
113 | be combined with the library in order to run.
114 |
115 | GNU LESSER GENERAL PUBLIC LICENSE
116 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
117 |
118 | 0. This License Agreement applies to any software library or other
119 | program which contains a notice placed by the copyright holder or
120 | other authorized party saying it may be distributed under the terms of
121 | this Lesser General Public License (also called "this License").
122 | Each licensee is addressed as "you".
123 |
124 | A "library" means a collection of software functions and/or data
125 | prepared so as to be conveniently linked with application programs
126 | (which use some of those functions and data) to form executables.
127 |
128 | The "Library", below, refers to any such software library or work
129 | which has been distributed under these terms. A "work based on the
130 | Library" means either the Library or any derivative work under
131 | copyright law: that is to say, a work containing the Library or a
132 | portion of it, either verbatim or with modifications and/or translated
133 | straightforwardly into another language. (Hereinafter, translation is
134 | included without limitation in the term "modification".)
135 |
136 | "Source code" for a work means the preferred form of the work for
137 | making modifications to it. For a library, complete source code means
138 | all the source code for all modules it contains, plus any associated
139 | interface definition files, plus the scripts used to control compilation
140 | and installation of the library.
141 |
142 | Activities other than copying, distribution and modification are not
143 | covered by this License; they are outside its scope. The act of
144 | running a program using the Library is not restricted, and output from
145 | such a program is covered only if its contents constitute a work based
146 | on the Library (independent of the use of the Library in a tool for
147 | writing it). Whether that is true depends on what the Library does
148 | and what the program that uses the Library does.
149 |
150 | 1. You may copy and distribute verbatim copies of the Library's
151 | complete source code as you receive it, in any medium, provided that
152 | you conspicuously and appropriately publish on each copy an
153 | appropriate copyright notice and disclaimer of warranty; keep intact
154 | all the notices that refer to this License and to the absence of any
155 | warranty; and distribute a copy of this License along with the
156 | Library.
157 |
158 | You may charge a fee for the physical act of transferring a copy,
159 | and you may at your option offer warranty protection in exchange for a
160 | fee.
161 |
162 | 2. You may modify your copy or copies of the Library or any portion
163 | of it, thus forming a work based on the Library, and copy and
164 | distribute such modifications or work under the terms of Section 1
165 | above, provided that you also meet all of these conditions:
166 |
167 | a) The modified work must itself be a software library.
168 |
169 | b) You must cause the files modified to carry prominent notices
170 | stating that you changed the files and the date of any change.
171 |
172 | c) You must cause the whole of the work to be licensed at no
173 | charge to all third parties under the terms of this License.
174 |
175 | d) If a facility in the modified Library refers to a function or a
176 | table of data to be supplied by an application program that uses
177 | the facility, other than as an argument passed when the facility
178 | is invoked, then you must make a good faith effort to ensure that,
179 | in the event an application does not supply such function or
180 | table, the facility still operates, and performs whatever part of
181 | its purpose remains meaningful.
182 |
183 | (For example, a function in a library to compute square roots has
184 | a purpose that is entirely well-defined independent of the
185 | application. Therefore, Subsection 2d requires that any
186 | application-supplied function or table used by this function must
187 | be optional: if the application does not supply it, the square
188 | root function must still compute square roots.)
189 |
190 | These requirements apply to the modified work as a whole. If
191 | identifiable sections of that work are not derived from the Library,
192 | and can be reasonably considered independent and separate works in
193 | themselves, then this License, and its terms, do not apply to those
194 | sections when you distribute them as separate works. But when you
195 | distribute the same sections as part of a whole which is a work based
196 | on the Library, the distribution of the whole must be on the terms of
197 | this License, whose permissions for other licensees extend to the
198 | entire whole, and thus to each and every part regardless of who wrote
199 | it.
200 |
201 | Thus, it is not the intent of this section to claim rights or contest
202 | your rights to work written entirely by you; rather, the intent is to
203 | exercise the right to control the distribution of derivative or
204 | collective works based on the Library.
205 |
206 | In addition, mere aggregation of another work not based on the Library
207 | with the Library (or with a work based on the Library) on a volume of
208 | a storage or distribution medium does not bring the other work under
209 | the scope of this License.
210 |
211 | 3. You may opt to apply the terms of the ordinary GNU General Public
212 | License instead of this License to a given copy of the Library. To do
213 | this, you must alter all the notices that refer to this License, so
214 | that they refer to the ordinary GNU General Public License, version 2,
215 | instead of to this License. (If a newer version than version 2 of the
216 | ordinary GNU General Public License has appeared, then you can specify
217 | that version instead if you wish.) Do not make any other change in
218 | these notices.
219 |
220 | Once this change is made in a given copy, it is irreversible for
221 | that copy, so the ordinary GNU General Public License applies to all
222 | subsequent copies and derivative works made from that copy.
223 |
224 | This option is useful when you wish to copy part of the code of
225 | the Library into a program that is not a library.
226 |
227 | 4. You may copy and distribute the Library (or a portion or
228 | derivative of it, under Section 2) in object code or executable form
229 | under the terms of Sections 1 and 2 above provided that you accompany
230 | it with the complete corresponding machine-readable source code, which
231 | must be distributed under the terms of Sections 1 and 2 above on a
232 | medium customarily used for software interchange.
233 |
234 | If distribution of object code is made by offering access to copy
235 | from a designated place, then offering equivalent access to copy the
236 | source code from the same place satisfies the requirement to
237 | distribute the source code, even though third parties are not
238 | compelled to copy the source along with the object code.
239 |
240 | 5. A program that contains no derivative of any portion of the
241 | Library, but is designed to work with the Library by being compiled or
242 | linked with it, is called a "work that uses the Library". Such a
243 | work, in isolation, is not a derivative work of the Library, and
244 | therefore falls outside the scope of this License.
245 |
246 | However, linking a "work that uses the Library" with the Library
247 | creates an executable that is a derivative of the Library (because it
248 | contains portions of the Library), rather than a "work that uses the
249 | library". The executable is therefore covered by this License.
250 | Section 6 states terms for distribution of such executables.
251 |
252 | When a "work that uses the Library" uses material from a header file
253 | that is part of the Library, the object code for the work may be a
254 | derivative work of the Library even though the source code is not.
255 | Whether this is true is especially significant if the work can be
256 | linked without the Library, or if the work is itself a library. The
257 | threshold for this to be true is not precisely defined by law.
258 |
259 | If such an object file uses only numerical parameters, data
260 | structure layouts and accessors, and small macros and small inline
261 | functions (ten lines or less in length), then the use of the object
262 | file is unrestricted, regardless of whether it is legally a derivative
263 | work. (Executables containing this object code plus portions of the
264 | Library will still fall under Section 6.)
265 |
266 | Otherwise, if the work is a derivative of the Library, you may
267 | distribute the object code for the work under the terms of Section 6.
268 | Any executables containing that work also fall under Section 6,
269 | whether or not they are linked directly with the Library itself.
270 |
271 | 6. As an exception to the Sections above, you may also combine or
272 | link a "work that uses the Library" with the Library to produce a
273 | work containing portions of the Library, and distribute that work
274 | under terms of your choice, provided that the terms permit
275 | modification of the work for the customer's own use and reverse
276 | engineering for debugging such modifications.
277 |
278 | You must give prominent notice with each copy of the work that the
279 | Library is used in it and that the Library and its use are covered by
280 | this License. You must supply a copy of this License. If the work
281 | during execution displays copyright notices, you must include the
282 | copyright notice for the Library among them, as well as a reference
283 | directing the user to the copy of this License. Also, you must do one
284 | of these things:
285 |
286 | a) Accompany the work with the complete corresponding
287 | machine-readable source code for the Library including whatever
288 | changes were used in the work (which must be distributed under
289 | Sections 1 and 2 above); and, if the work is an executable linked
290 | with the Library, with the complete machine-readable "work that
291 | uses the Library", as object code and/or source code, so that the
292 | user can modify the Library and then relink to produce a modified
293 | executable containing the modified Library. (It is understood
294 | that the user who changes the contents of definitions files in the
295 | Library will not necessarily be able to recompile the application
296 | to use the modified definitions.)
297 |
298 | b) Use a suitable shared library mechanism for linking with the
299 | Library. A suitable mechanism is one that (1) uses at run time a
300 | copy of the library already present on the user's computer system,
301 | rather than copying library functions into the executable, and (2)
302 | will operate properly with a modified version of the library, if
303 | the user installs one, as long as the modified version is
304 | interface-compatible with the version that the work was made with.
305 |
306 | c) Accompany the work with a written offer, valid for at
307 | least three years, to give the same user the materials
308 | specified in Subsection 6a, above, for a charge no more
309 | than the cost of performing this distribution.
310 |
311 | d) If distribution of the work is made by offering access to copy
312 | from a designated place, offer equivalent access to copy the above
313 | specified materials from the same place.
314 |
315 | e) Verify that the user has already received a copy of these
316 | materials or that you have already sent this user a copy.
317 |
318 | For an executable, the required form of the "work that uses the
319 | Library" must include any data and utility programs needed for
320 | reproducing the executable from it. However, as a special exception,
321 | the materials to be distributed need not include anything that is
322 | normally distributed (in either source or binary form) with the major
323 | components (compiler, kernel, and so on) of the operating system on
324 | which the executable runs, unless that component itself accompanies
325 | the executable.
326 |
327 | It may happen that this requirement contradicts the license
328 | restrictions of other proprietary libraries that do not normally
329 | accompany the operating system. Such a contradiction means you cannot
330 | use both them and the Library together in an executable that you
331 | distribute.
332 |
333 | 7. You may place library facilities that are a work based on the
334 | Library side-by-side in a single library together with other library
335 | facilities not covered by this License, and distribute such a combined
336 | library, provided that the separate distribution of the work based on
337 | the Library and of the other library facilities is otherwise
338 | permitted, and provided that you do these two things:
339 |
340 | a) Accompany the combined library with a copy of the same work
341 | based on the Library, uncombined with any other library
342 | facilities. This must be distributed under the terms of the
343 | Sections above.
344 |
345 | b) Give prominent notice with the combined library of the fact
346 | that part of it is a work based on the Library, and explaining
347 | where to find the accompanying uncombined form of the same work.
348 |
349 | 8. You may not copy, modify, sublicense, link with, or distribute
350 | the Library except as expressly provided under this License. Any
351 | attempt otherwise to copy, modify, sublicense, link with, or
352 | distribute the Library is void, and will automatically terminate your
353 | rights under this License. However, parties who have received copies,
354 | or rights, from you under this License will not have their licenses
355 | terminated so long as such parties remain in full compliance.
356 |
357 | 9. You are not required to accept this License, since you have not
358 | signed it. However, nothing else grants you permission to modify or
359 | distribute the Library or its derivative works. These actions are
360 | prohibited by law if you do not accept this License. Therefore, by
361 | modifying or distributing the Library (or any work based on the
362 | Library), you indicate your acceptance of this License to do so, and
363 | all its terms and conditions for copying, distributing or modifying
364 | the Library or works based on it.
365 |
366 | 10. Each time you redistribute the Library (or any work based on the
367 | Library), the recipient automatically receives a license from the
368 | original licensor to copy, distribute, link with or modify the Library
369 | subject to these terms and conditions. You may not impose any further
370 | restrictions on the recipients' exercise of the rights granted herein.
371 | You are not responsible for enforcing compliance by third parties with
372 | this License.
373 |
374 | 11. If, as a consequence of a court judgment or allegation of patent
375 | infringement or for any other reason (not limited to patent issues),
376 | conditions are imposed on you (whether by court order, agreement or
377 | otherwise) that contradict the conditions of this License, they do not
378 | excuse you from the conditions of this License. If you cannot
379 | distribute so as to satisfy simultaneously your obligations under this
380 | License and any other pertinent obligations, then as a consequence you
381 | may not distribute the Library at all. For example, if a patent
382 | license would not permit royalty-free redistribution of the Library by
383 | all those who receive copies directly or indirectly through you, then
384 | the only way you could satisfy both it and this License would be to
385 | refrain entirely from distribution of the Library.
386 |
387 | If any portion of this section is held invalid or unenforceable under any
388 | particular circumstance, the balance of the section is intended to apply,
389 | and the section as a whole is intended to apply in other circumstances.
390 |
391 | It is not the purpose of this section to induce you to infringe any
392 | patents or other property right claims or to contest validity of any
393 | such claims; this section has the sole purpose of protecting the
394 | integrity of the free software distribution system which is
395 | implemented by public license practices. Many people have made
396 | generous contributions to the wide range of software distributed
397 | through that system in reliance on consistent application of that
398 | system; it is up to the author/donor to decide if he or she is willing
399 | to distribute software through any other system and a licensee cannot
400 | impose that choice.
401 |
402 | This section is intended to make thoroughly clear what is believed to
403 | be a consequence of the rest of this License.
404 |
405 | 12. If the distribution and/or use of the Library is restricted in
406 | certain countries either by patents or by copyrighted interfaces, the
407 | original copyright holder who places the Library under this License may add
408 | an explicit geographical distribution limitation excluding those countries,
409 | so that distribution is permitted only in or among countries not thus
410 | excluded. In such case, this License incorporates the limitation as if
411 | written in the body of this License.
412 |
413 | 13. The Free Software Foundation may publish revised and/or new
414 | versions of the Lesser General Public License from time to time.
415 | Such new versions will be similar in spirit to the present version,
416 | but may differ in detail to address new problems or concerns.
417 |
418 | Each version is given a distinguishing version number. If the Library
419 | specifies a version number of this License which applies to it and
420 | "any later version", you have the option of following the terms and
421 | conditions either of that version or of any later version published by
422 | the Free Software Foundation. If the Library does not specify a
423 | license version number, you may choose any version ever published by
424 | the Free Software Foundation.
425 |
426 | 14. If you wish to incorporate parts of the Library into other free
427 | programs whose distribution conditions are incompatible with these,
428 | write to the author to ask for permission. For software which is
429 | copyrighted by the Free Software Foundation, write to the Free
430 | Software Foundation; we sometimes make exceptions for this. Our
431 | decision will be guided by the two goals of preserving the free status
432 | of all derivatives of our free software and of promoting the sharing
433 | and reuse of software generally.
434 |
435 | NO WARRANTY
436 |
437 | 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
438 | WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
439 | EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
440 | OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY
441 | KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
442 | IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
443 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
444 | LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME
445 | THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
446 |
447 | 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
448 | WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
449 | AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU
450 | FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
451 | CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
452 | LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
453 | RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
454 | FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
455 | SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
456 | DAMAGES.
457 |
458 | END OF TERMS AND CONDITIONS
459 |
460 | How to Apply These Terms to Your New Libraries
461 |
462 | If you develop a new library, and you want it to be of the greatest
463 | possible use to the public, we recommend making it free software that
464 | everyone can redistribute and change. You can do so by permitting
465 | redistribution under these terms (or, alternatively, under the terms of the
466 | ordinary General Public License).
467 |
468 | To apply these terms, attach the following notices to the library. It is
469 | safest to attach them to the start of each source file to most effectively
470 | convey the exclusion of warranty; and each file should have at least the
471 | "copyright" line and a pointer to where the full notice is found.
472 |
473 |
474 | Copyright (C)
475 |
476 | This library is free software; you can redistribute it and/or
477 | modify it under the terms of the GNU Lesser General Public
478 | License as published by the Free Software Foundation; either
479 | version 2.1 of the License, or (at your option) any later version.
480 |
481 | This library is distributed in the hope that it will be useful,
482 | but WITHOUT ANY WARRANTY; without even the implied warranty of
483 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
484 | Lesser General Public License for more details.
485 |
486 | You should have received a copy of the GNU Lesser General Public
487 | License along with this library; if not, write to the Free Software
488 | Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
489 |
490 | Also add information on how to contact you by electronic and paper mail.
491 |
492 | You should also get your employer (if you work as a programmer) or your
493 | school, if any, to sign a "copyright disclaimer" for the library, if
494 | necessary. Here is a sample; alter the names:
495 |
496 | Yoyodyne, Inc., hereby disclaims all copyright interest in the
497 | library `Frob' (a library for tweaking knobs) written by James Random Hacker.
498 |
499 | , 1 April 1990
500 | Ty Coon, President of Vice
501 |
502 | That's all there is to it!
503 |
--------------------------------------------------------------------------------
/easy_comment/static/ckeditor/ckeditor/plugins/prism/README.md:
--------------------------------------------------------------------------------
1 | ckeditor-prism
2 | ================
3 | OVERVIEW:
4 | Prism Highlighter is a plugin for CKEditor for inserting beautiful formatted text, markdown, or code snippets in your blog or website. Prism is the chosen renderer/highlighter/colorizer since it's pretty, lightweight, and extendable. I also use this plugin in my [personal website](http://www.ranelpadon.com/content/practical-regex-part-12-common-operators).
5 |
6 | This plugin utilizes the following libraries:
7 |
8 | - CKEditor Code Snippet Plugin
9 | - CKEditor Code Snippet API
10 | - Prism Syntax Highlighter with Dark Theme
11 | - Prism Line Numbers Add-on
12 |
13 |
14 | By default, Prism has no line numbering mechanism, so the **Line Number** add-on has been added. Also, in order for the line numbers to work smoothly in CKEditor and when rendering the actual page, I did some minor patching in **prism.js** and **prism.css**.
15 |
16 | LIVE DEMO PAGE:
17 | Demo page could be found here.
18 |
19 | INSTALLATION:
20 | Kindly refer to Installation Guide.
21 |
22 | HOW TO USE:
23 | Kindly refer to How to Create and Edit Prism Snippets.
24 |
25 | LICENSE and CREDITS:
26 | License: LGPLv2.1 or later should apply. Note that LGPLv2.1+ is also compatible with GPLv2.
27 | Copyright 2015 by [Engr. Ranel O. Padon](http://www.ranelpadon.com)
28 |
29 | Thanks to CKEditor, Prism, and other great open-source softwares and their unsung developers.
30 |
31 | =======================================================
32 |
33 |
34 |
35 |
36 |
37 |
38 |
39 |
--------------------------------------------------------------------------------
/easy_comment/static/ckeditor/ckeditor/plugins/prism/lib/prism/prism_patched.min.css:
--------------------------------------------------------------------------------
1 | code[class*="language-"],pre{color:white;text-shadow:0 -.1em .2em black;font-family:Monaco,Consolas,'Andale Mono','Ubuntu Mono',monospace;direction:ltr;text-align:left;white-space:pre;word-spacing:normal;word-break:normal;word-wrap:normal;line-height:1.5;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-hyphens:none;-moz-hyphens:none;-ms-hyphens:none;hyphens:none}@media print{code[class*="language-"],pre{text-shadow:none}}pre,:not(pre)>code[class*="language-"]{background:hsl(30,20%,25%)}pre{padding:1em;margin:.5em 0;overflow:auto;border:.3em solid hsl(30,20%,40%);border-radius:.5em;box-shadow:1px 1px .5em black inset}:not(pre)>code[class*="language-"]{padding:.15em .2em .05em;border-radius:.3em;border:.13em solid hsl(30,20%,40%);box-shadow:1px 1px .3em -.1em black inset;white-space:normal}.token.comment,.token.prolog,.token.doctype,.token.cdata{color:hsl(30,20%,50%)}.token.punctuation{opacity:.7}.namespace{opacity:.7}.token.property,.token.tag,.token.boolean,.token.number,.token.constant,.token.symbol{color:hsl(350,40%,70%)}.token.selector,.token.attr-name,.token.string,.token.char,.token.builtin,.token.inserted{color:hsl(75,70%,60%)}.token.operator,.token.entity,.token.url,.language-css .token.string,.style .token.string,.token.variable{color:hsl(40,90%,60%)}.token.atrule,.token.attr-value,.token.keyword{color:hsl(350,40%,70%)}.token.regex,.token.important{color:#e90}.token.important,.token.bold{font-weight:bold}.token.italic{font-style:italic}.token.entity{cursor:help}.token.deleted{color:red}pre{position:relative;padding-left:3.8em;counter-reset:linenumber}pre>code{position:relative}pre>code .line-numbers-rows{position:absolute;pointer-events:none;top:0;font-size:100%;left:-3.8em;width:3em;letter-spacing:-1px;border-right:1px solid #999;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none}.line-numbers-rows>span{pointer-events:none;display:block;counter-increment:linenumber}.line-numbers-rows>span:before{content:counter(linenumber);color:#999;display:block;padding-right:.8em;text-align:right}
2 |
--------------------------------------------------------------------------------
/easy_comment/static/ckeditor/ckeditor/plugins/prism/lib/prism/prism_patched.min.js:
--------------------------------------------------------------------------------
1 | var _self="undefined"!=typeof window?window:"undefined"!=typeof WorkerGlobalScope&&self instanceof WorkerGlobalScope?self:{},Prism=function(){var e=/\blang(?:uage)?-(?!\*)(\w+)\b/i,t=_self.Prism={util:{encode:function(e){return e instanceof i?new i(e.type,t.util.encode(e.content),e.alias):"Array"===t.util.type(e)?e.map(t.util.encode):e.replace(/&/g,"&").replace(/e.length)break e;if(!(f instanceof a)){d.lastIndex=0;var b=d.exec(f);if(b){u&&(m=b[1].length);var h=b.index-1+m,b=b[0].slice(m),S=b.length,T=h+S,A=f.slice(0,h+1),N=f.slice(T+1),I=[g,1];A&&I.push(A);var L=new a(o,p?t.tokenize(b,p):b,E);I.push(L),N&&I.push(N),Array.prototype.splice.apply(r,I)}}}}}return r},hooks:{all:{},add:function(e,i){var n=t.hooks.all;n[e]=n[e]||[],n[e].push(i)},run:function(e,i){var n=t.hooks.all[e];if(n&&n.length)for(var a,r=0;a=n[r++];)a(i)}}},i=t.Token=function(e,t,i){this.type=e,this.content=t,this.alias=i};if(i.stringify=function(e,n,a){if("string"==typeof e)return e;if("Array"===t.util.type(e))return e.map(function(t){return i.stringify(t,n,e)}).join("");var r={type:e.type,content:i.stringify(e.content,n,a),tag:"span",classes:["token",e.type],attributes:{},language:n,parent:a};if("comment"==r.type&&(r.attributes.spellcheck="true"),e.alias){var s="Array"===t.util.type(e.alias)?e.alias:[e.alias];Array.prototype.push.apply(r.classes,s)}t.hooks.run("wrap",r);var o="";for(var l in r.attributes)o+=(o?" ":"")+l+'="'+(r.attributes[l]||"")+'"';return"<"+r.tag+' class="'+r.classes.join(" ")+'" '+o+">"+r.content+""+r.tag+">"},!_self.document)return _self.addEventListener?(_self.addEventListener("message",function(e){var i=JSON.parse(e.data),n=i.language,a=i.code,r=i.immediateClose;_self.postMessage(t.highlight(a,t.languages[n],n)),r&&_self.close()},!1),_self.Prism):_self.Prism;var n=document.getElementsByTagName("script");return n=n[n.length-1],n&&(t.filename=n.src,document.addEventListener&&!n.hasAttribute("data-manual")&&document.addEventListener("DOMContentLoaded",t.highlightAll)),_self.Prism}();"undefined"!=typeof module&&module.exports&&(module.exports=Prism),"undefined"!=typeof global&&(global.Prism=Prism),Prism.languages.markup={comment://,prolog:/<\?[\w\W]+?\?>/,doctype://,cdata://i,tag:{pattern:/<\/?(?!\d)[^\s>\/=.$<]+(?:\s+[^\s>\/=]+(?:=(?:("|')(?:\\\1|\\?(?!\1)[\w\W])*\1|[^\s'">=]+))?)*\s*\/?>/i,inside:{tag:{pattern:/^<\/?[^\s>\/]+/i,inside:{punctuation:/^<\/?/,namespace:/^[^\s>\/:]+:/}},"attr-value":{pattern:/=(?:('|")[\w\W]*?(\1)|[^\s>]+)/i,inside:{punctuation:/[=>"']/}},punctuation:/\/?>/,"attr-name":{pattern:/[^\s>\/]+/,inside:{namespace:/^[^\s>\/:]+:/}}}},entity:/?[\da-z]{1,8};/i},Prism.hooks.add("wrap",function(e){"entity"===e.type&&(e.attributes.title=e.content.replace(/&/,"&"))}),Prism.languages.xml=Prism.languages.markup,Prism.languages.html=Prism.languages.markup,Prism.languages.mathml=Prism.languages.markup,Prism.languages.svg=Prism.languages.markup,Prism.languages.css={comment:/\/\*[\w\W]*?\*\//,atrule:{pattern:/@[\w-]+?.*?(;|(?=\s*\{))/i,inside:{rule:/@[\w-]+/}},url:/url\((?:(["'])(\\(?:\r\n|[\w\W])|(?!\1)[^\\\r\n])*\1|.*?)\)/i,selector:/[^\{\}\s][^\{\};]*?(?=\s*\{)/,string:/("|')(\\(?:\r\n|[\w\W])|(?!\1)[^\\\r\n])*\1/,property:/(\b|\B)[\w-]+(?=\s*:)/i,important:/\B!important\b/i,"function":/[-a-z0-9]+(?=\()/i,punctuation:/[(){};:]/},Prism.languages.css.atrule.inside.rest=Prism.util.clone(Prism.languages.css),Prism.languages.markup&&(Prism.languages.insertBefore("markup","tag",{style:{pattern:/(