├── .bowerrc ├── bower.json ├── .gitignore ├── package.json ├── css └── styles.css ├── gulpfile.js ├── README.md ├── js └── plugin.js ├── Plugin.php └── LICENSE /.bowerrc: -------------------------------------------------------------------------------- 1 | { 2 | "analytics": false, 3 | "directory": "vendor" 4 | } -------------------------------------------------------------------------------- /bower.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "emoji-plugin", 3 | "private": true, 4 | "dependencies": { 5 | "emojify.js": "~0.9.5", 6 | "es5-shim": "~4.0.5" 7 | } 8 | } 9 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Do not index node.js modules that are used for building 2 | node_modules 3 | package-lock.json 4 | 5 | # Do not index bower components 6 | vendor 7 | 8 | # Do not index releases 9 | release 10 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "version": "1.0.1", 3 | "devDependencies": { 4 | "bower": "~1.8.8", 5 | "gulp": "~4.0.0", 6 | "event-stream": "~3.1.7", 7 | "gulp-zip": "~2.0.2", 8 | "gulp-tar": "~3.1.0", 9 | "gulp-gzip": "~0.0.8", 10 | "gulp-chmod": "~3.0.0", 11 | "gulp-rename": "~1.2.0" 12 | } 13 | } 14 | -------------------------------------------------------------------------------- /css/styles.css: -------------------------------------------------------------------------------- 1 | /* 2 | * This file is a part of Mibew Emoji Plugin. 3 | * 4 | * Copyright 2014 Dmitriy Simushev . 5 | * 6 | * Licensed under the Apache License, Version 2.0 (the "License"); 7 | * you may not use this file except in compliance with the License. 8 | * You may obtain a copy of the License at 9 | * 10 | * http://www.apache.org/licenses/LICENSE-2.0 11 | * 12 | * Unless required by applicable law or agreed to in writing, software 13 | * distributed under the License is distributed on an "AS IS" BASIS, 14 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | * See the License for the specific language governing permissions and 16 | * limitations under the License. 17 | */ 18 | 19 | .emoji { 20 | width: 1.8em; 21 | height: 1.8em; 22 | display: inline-block; 23 | vertical-align: text-bottom; 24 | } 25 | -------------------------------------------------------------------------------- /gulpfile.js: -------------------------------------------------------------------------------- 1 | var bower = require('bower'), 2 | eventStream = require('event-stream'), 3 | gulp = require('gulp'), 4 | chmod = require('gulp-chmod'), 5 | zip = require('gulp-zip'), 6 | tar = require('gulp-tar'), 7 | gzip = require('gulp-gzip'), 8 | rename = require('gulp-rename'); 9 | 10 | // Installs bower dependencies 11 | gulp.task('bower', function(callback) { 12 | bower.commands.install([], {}, {}) 13 | .on('error', function(error) { 14 | callback(error); 15 | }) 16 | .on('end', function() { 17 | callback(); 18 | }); 19 | }); 20 | 21 | gulp.task('prepare-release', gulp.series('bower', function() { 22 | var version = require('./package.json').version; 23 | 24 | return eventStream.merge( 25 | getSources() 26 | .pipe(zip('emoji-plugin-' + version + '.zip')), 27 | getSources() 28 | .pipe(tar('emoji-plugin-' + version + '.tar')) 29 | .pipe(gzip()) 30 | ) 31 | .pipe(chmod(0644)) 32 | .pipe(gulp.dest('release')); 33 | })); 34 | 35 | // Builds and packs plugins sources 36 | gulp.task('default', gulp.series('prepare-release')); 37 | 38 | /** 39 | * Returns files stream with the plugin sources. 40 | * 41 | * @returns {Object} Stream with VinylFS files. 42 | */ 43 | var getSources = function() { 44 | return gulp.src([ 45 | 'Plugin.php', 46 | 'README.md', 47 | 'LICENSE', 48 | 'js/*', 49 | 'css/*', 50 | 'vendor/es5-shim/es5-shim.js', 51 | 'vendor/es5-shim/LICENSE', 52 | 'vendor/es5-shim/README.md', 53 | 'vendor/emojify.js/emojify.js', 54 | 'vendor/emojify.js/README.md', 55 | 'vendor/emojify.js/images/emoji/*' 56 | ], 57 | {base: './'} 58 | ) 59 | .pipe(rename(function(path) { 60 | path.dirname = 'Mibew/Mibew/Plugin/Emoji/' + path.dirname; 61 | })); 62 | } 63 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Mibew Emoji plugin 2 | 3 | It replaces emojis codes with images in chat messages. The full list of supported emojis can be found at http://www.emoji-cheat-sheet.com/ 4 | 5 | Emoticons like :-) and ;D are also supported. 6 | 7 | 8 | ## Installation 9 | 10 | 1. Get the archive with the plugin sources. You can download it from the [official site](https://mibew.org/plugins#mibew-emoji) or build the plugin from sources. 11 | 12 | 2. Untar/unzip the plugin's archive. 13 | 14 | 3. Put files of the plugins to the `/plugins` folder. 15 | 16 | 4. (optional) Add plugins configs to "plugins" structure in "``/configs/config.yml". If the "plugins" stucture looks like `plugins: []` it will become: 17 | ```yaml 18 | plugins: 19 | "Mibew:Emoji": # Plugin's configurations are described below 20 | ignore_emoticons: false 21 | ``` 22 | 23 | 5. Navigate to "``/operator/plugin" page and enable the plugin. 24 | 25 | 26 | ## Plugin's configurations 27 | 28 | The plugin can be configured with values in "``/configs/config.yml" file. 29 | 30 | ### config.ignore_emoticons 31 | 32 | Type: `Boolean` 33 | 34 | Default: `false` 35 | 36 | If set to true, the plugin only converts :emoji: and ignore emoticons like :-) and ;D. This value is optional and can be skipped. 37 | 38 | 39 | ## Build from sources 40 | 41 | There are several actions one should do before use the latest version of the plugin from the repository: 42 | 43 | 1. Obtain a copy of the repository using `git clone`, download button, or another way. 44 | 2. Install [node.js](http://nodejs.org/) and [npm](https://www.npmjs.org/). 45 | 3. Install [Gulp](http://gulpjs.com/). 46 | 4. Install npm dependencies using `npm install`. 47 | 5. Run Gulp to build the sources using `gulp default`. 48 | 49 | Finally `.tar.gz` and `.zip` archives of the ready-to-use Plugin will be available in `release` directory. 50 | 51 | 52 | ## License 53 | 54 | [Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0.html) 55 | -------------------------------------------------------------------------------- /js/plugin.js: -------------------------------------------------------------------------------- 1 | /*! 2 | * This file is a part of Mibew Emoji Plugin. 3 | * 4 | * Copyright 2014 Dmitriy Simushev . 5 | * 6 | * Licensed under the Apache License, Version 2.0 (the "License"); 7 | * you may not use this file except in compliance with the License. 8 | * You may obtain a copy of the License at 9 | * 10 | * http://www.apache.org/licenses/LICENSE-2.0 11 | * 12 | * Unless required by applicable law or agreed to in writing, software 13 | * distributed under the License is distributed on an "AS IS" BASIS, 14 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | * See the License for the specific language governing permissions and 16 | * limitations under the License. 17 | */ 18 | 19 | (function (Mibew, emojify) { 20 | // Initialize separated Marionette.js module for the plugin. 21 | var module = Mibew.Application.module( 22 | 'MibewEmojiPlugin', 23 | {startWithParent: false} 24 | ); 25 | 26 | // Make the plugin works together with "Chat" and "Invitation" modules. 27 | var eventsMap = { 28 | 'start': function() { 29 | module.start(); 30 | }, 31 | 'stop': function() { 32 | module.stop(); 33 | } 34 | } 35 | 36 | Mibew.Application.Chat.on(eventsMap); 37 | Mibew.Application.Invitation.on(eventsMap); 38 | 39 | module.addInitializer(function() { 40 | emojify.setConfig({ 41 | img_dir: Mibew.PluginOptions.MibewEmoji.imagesDir, 42 | ignore_emoticons: Mibew.PluginOptions.MibewEmoji.ignoreEmoticons 43 | }); 44 | 45 | // Update message body right after it is added to the messages 46 | // collection. 47 | Mibew.Objects.Collections.messages.on('add', function(model) { 48 | var kind = model.get('kind'); 49 | 50 | if (kind == model.KIND_USER || kind == model.KIND_AGENT) { 51 | model.set( 52 | 'message', 53 | emojify.replace(model.get('message')) 54 | ); 55 | } 56 | }); 57 | }); 58 | })(Mibew, emojify); 59 | -------------------------------------------------------------------------------- /Plugin.php: -------------------------------------------------------------------------------- 1 | . 6 | * 7 | * Licensed under the Apache License, Version 2.0 (the "License"); 8 | * you may not use this file except in compliance with the License. 9 | * You may obtain a copy of the License at 10 | * 11 | * http://www.apache.org/licenses/LICENSE-2.0 12 | * 13 | * Unless required by applicable law or agreed to in writing, software 14 | * distributed under the License is distributed on an "AS IS" BASIS, 15 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 16 | * See the License for the specific language governing permissions and 17 | * limitations under the License. 18 | */ 19 | 20 | /** 21 | * @file The main file of Mibew:Emoji plugin. 22 | */ 23 | 24 | namespace Mibew\Mibew\Plugin\Emoji; 25 | 26 | use Mibew\EventDispatcher\EventDispatcher; 27 | use Mibew\EventDispatcher\Events; 28 | use Symfony\Component\HttpFoundation\Request; 29 | 30 | /** 31 | * The main plugin's file definition. 32 | * 33 | * It only attaches needed CSS and JS files to chat windows. 34 | */ 35 | class Plugin extends \Mibew\Plugin\AbstractPlugin implements \Mibew\Plugin\PluginInterface 36 | { 37 | /** 38 | * List of the plugin configs. 39 | * 40 | * @var array 41 | */ 42 | protected $config; 43 | 44 | /** 45 | * Class constructor. 46 | * 47 | * @param array $config List of the plugin config. The following options are 48 | * supported: 49 | * - 'ignore_emoticons': boolean, if set to true, the plugin only converts 50 | * :emoji: and ignore emoticons like :-) and ;D. The default value is 51 | * false. 52 | */ 53 | public function __construct($config) 54 | { 55 | $this->config = $config + array('ignore_emoticons' => false); 56 | } 57 | 58 | /** 59 | * The plugin does not need extra initialization thus it is always ready to 60 | * work. 61 | * 62 | * @return boolean 63 | */ 64 | public function initialized() 65 | { 66 | return true; 67 | } 68 | 69 | /** 70 | * The main entry point of a plugin. 71 | */ 72 | public function run() 73 | { 74 | // Attach CSS and JS files of the plugin to chat window. 75 | $dispatcher = EventDispatcher::getInstance(); 76 | $dispatcher->attachListener(Events::PAGE_ADD_CSS, $this, 'attachCssFiles'); 77 | $dispatcher->attachListener(Events::PAGE_ADD_JS, $this, 'attachJsFiles'); 78 | $dispatcher->attachListener(Events::PAGE_ADD_JS_PLUGIN_OPTIONS, $this, 'attachPluginOptions'); 79 | } 80 | 81 | /** 82 | * Event handler for "pageAddJS" event. 83 | * 84 | * @param array $args 85 | */ 86 | public function attachJSFiles(&$args) 87 | { 88 | if ($this->isAppropriatePage($args['request'])) { 89 | $base_path = str_replace(DIRECTORY_SEPARATOR, '/', $this->getFilesPath()); 90 | $args['js'][] = $base_path . '/vendor/es5-shim/es5-shim.js'; 91 | $args['js'][] = $base_path . '/vendor/emojify.js/emojify.js'; 92 | $args['js'][] = $base_path . '/js/plugin.js'; 93 | } 94 | } 95 | 96 | /** 97 | * Event handler for "pageAddCSS" event. 98 | * 99 | * @param array $args 100 | */ 101 | public function attachCssFiles(&$args) 102 | { 103 | if ($this->isAppropriatePage($args['request'])) { 104 | $args['css'][] = str_replace(DIRECTORY_SEPARATOR, '/', $this->getFilesPath()) . '/css/styles.css'; 105 | } 106 | } 107 | 108 | /** 109 | * Event handler for "pageAddJSPluginOptions" event. 110 | * 111 | * @param array $args 112 | */ 113 | public function attachPluginOptions(&$args) 114 | { 115 | $request = $args['request']; 116 | 117 | if ($this->isAppropriatePage($request)) { 118 | $args['plugins']['MibewEmoji'] = array( 119 | 'imagesDir' => ($request->getBasePath() . '/' 120 | . str_replace(DIRECTORY_SEPARATOR, '/', $this->getFilesPath()) 121 | . '/vendor/emojify.js/images/emoji'), 122 | 'ignoreEmoticons' => $this->config['ignore_emoticons'], 123 | ); 124 | } 125 | } 126 | 127 | /** 128 | * Specify version of the plugin. 129 | * 130 | * @return string Plugin's version. 131 | */ 132 | public static function getVersion() 133 | { 134 | return '1.0.1'; 135 | } 136 | 137 | /** 138 | * Specify dependencies of the plugin. 139 | * 140 | * @return array List of dependencies 141 | */ 142 | public static function getDependencies() 143 | { 144 | // This plugin does not depend on others so return an empty array. 145 | return array(); 146 | } 147 | 148 | /** 149 | * Checks if plugins data should be attached to the page. 150 | * 151 | * @param Request $request Incoming request 152 | * @return boolean 153 | */ 154 | protected function isAppropriatePage(Request $request) 155 | { 156 | $route = $request->attributes->get('_route'); 157 | 158 | return in_array( 159 | $route, 160 | array( 161 | 'chat_operator', 162 | 'chat_user_start', 163 | 'chat_user', 164 | 'chat_user_invitation', 165 | ) 166 | ); 167 | } 168 | } 169 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright [yyyy] [name of copyright owner] 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | --------------------------------------------------------------------------------