├── css └── broadcast.css ├── .gitignore ├── package.json ├── gulpfile.js ├── README.md ├── js └── broadcast.js ├── Plugin.php └── LICENSE /css/broadcast.css: -------------------------------------------------------------------------------- 1 | #broadcast_mode {margin-left: 5px; font-size: 0.9em;} 2 | #broadcast_mode option {display: inline; font-size: 1em;} -------------------------------------------------------------------------------- /.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 releases 6 | release 7 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "version": "0.1.1", 3 | "devDependencies": { 4 | "gulp": "~4.0.0", 5 | "event-stream": "~3.1.7", 6 | "gulp-zip": "~2.0.2", 7 | "gulp-tar": "~3.1.0", 8 | "gulp-gzip": "~0.0.8", 9 | "gulp-chmod": "~3.0.0", 10 | "gulp-rename": "~1.2.0" 11 | } 12 | } 13 | -------------------------------------------------------------------------------- /gulpfile.js: -------------------------------------------------------------------------------- 1 | var eventStream = require('event-stream'), 2 | gulp = require('gulp'), 3 | chmod = require('gulp-chmod'), 4 | zip = require('gulp-zip'), 5 | tar = require('gulp-tar'), 6 | gzip = require('gulp-gzip'), 7 | rename = require('gulp-rename'); 8 | 9 | gulp.task('prepare-release', function() { 10 | var version = require('./package.json').version; 11 | 12 | return eventStream.merge( 13 | getSources() 14 | .pipe(zip('broadcast-plugin-' + version + '.zip')), 15 | getSources() 16 | .pipe(tar('broadcast-plugin-' + version + '.tar')) 17 | .pipe(gzip()) 18 | ) 19 | .pipe(chmod(0644)) 20 | .pipe(gulp.dest('release')); 21 | }); 22 | 23 | // Builds and packs plugins sources 24 | gulp.task('default', gulp.series('prepare-release')); 25 | 26 | /** 27 | * Returns files stream with the plugin sources. 28 | * 29 | * @returns {Object} Stream with VinylFS files. 30 | */ 31 | var getSources = function() { 32 | return gulp.src([ 33 | 'Plugin.php', 34 | 'README.md', 35 | 'LICENSE', 36 | 'js/**/*.*', 37 | 'css/**/*.*' 38 | ], 39 | {base: './'} 40 | ) 41 | .pipe(rename(function(path) { 42 | path.dirname = 'Mibew/Mibew/Plugin/Broadcast/' + path.dirname; 43 | })); 44 | } 45 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Broadcast plugin 2 | 3 | A plugin to broadcast a message. 4 | 5 | At the moment there are four broadcasting modes available: 6 | 7 | * to all active chats (i.e. to chats with an operator connected); 8 | * to all waiting chats (i.e. to chats in a queue and chats where an operator has been disconnected); 9 | * to all chats except for closed ones; 10 | * to all operators involved in chats (i.e. to operators in active chats or in active invitations). 11 | 12 | Messages being sending as system ones. To send a message one should be an administrator. 13 | 14 | Plugin's localization constants could be translated via standard interface. 15 | 16 | ## Installation 17 | 18 | 1. Get the archive with the plugin sources. You can download it from the 19 | [official site](https://mibew.org/plugins#mibew-broadcast) or build the 20 | plugin from sources. 21 | 22 | 2. Untar/unzip the plugin's archive. 23 | 24 | 3. Put files of the plugins to the `/plugins` folder. 25 | 26 | 4. Navigate to "``/operator/plugin" page and enable the plugin. 27 | 28 | ## Build from sources 29 | 30 | There are several actions one should do before use the latest version of the plugin from the repository: 31 | 32 | 1. Obtain a copy of the repository using `git clone`, download button, or another way. 33 | 2. Install [node.js](http://nodejs.org/) and [npm](https://www.npmjs.org/). 34 | 3. Install [Gulp](http://gulpjs.com/). 35 | 4. Install npm dependencies using `npm install`. 36 | 5. Run Gulp to build the sources using `gulp default`. 37 | 38 | Finally `.tar.gz` and `.zip` archives of the ready-to-use Plugin will be available in `release` directory. 39 | 40 | ## License 41 | 42 | [Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0.html) 43 | -------------------------------------------------------------------------------- /js/broadcast.js: -------------------------------------------------------------------------------- 1 | /*! 2 | * This file is a part of Mibew Broadcast Plugin 3 | * 4 | * Copyright 2018 the original author or authors. 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 | $(document).ready(function(){ 20 | $('#sidebar ul li:first-child ul.submenu li:nth-child(2)') 21 | .after('
  • ' 22 | + Mibew.Localization.trans('Broadcast to') 23 | + '
    • '); 32 | $('#broadcast').click(function(e){ 33 | Mibew.Utils.prompt(Mibew.Localization.trans('Enter the message:'), function(value) { 34 | if (value) { 35 | Mibew.Objects.server.callFunctions( 36 | [{ 37 | 'function': 'broadcastMessage', 38 | 'arguments': { 39 | // required arguments 40 | 'agentId': Mibew.Objects.Models.agent.get('id'), 41 | 'return': {}, 42 | 'references': {}, 43 | // arguments needed 44 | 'message': value, 45 | 'mode': $("#broadcast_mode").val() 46 | 47 | } 48 | }], 49 | function(args) {}, 50 | true 51 | ); 52 | } 53 | }); 54 | }); 55 | }); 56 | -------------------------------------------------------------------------------- /Plugin.php: -------------------------------------------------------------------------------- 1 | attachListener(Events::USERS_FUNCTION_CALL, $this, 'usersFunctionCallHandler'); 49 | $dispatcher->attachListener(Events::PAGE_ADD_JS, $this, 'addJs'); 50 | $dispatcher->attachListener(Events::PAGE_ADD_CSS, $this, 'addCss'); 51 | } 52 | 53 | /** 54 | * A handler for {@link \Mibew\EventDispatcher\Events::USERS_FUNCTION_CALL}. 55 | * 56 | * Provides an ability to use "openStreetMapGetInfo" function at the client 57 | * side. 58 | * 59 | * @see \Mibew\EventDispatcher\Events::USERS_FUNCTION_CALL 60 | */ 61 | public function usersFunctionCallHandler(&$function) 62 | { 63 | if ($this->checkAdmin() && ($function['function'] == 'broadcastMessage')) { 64 | 65 | // Get message and its mode 66 | $message = $function['arguments']['message']; 67 | $mode = $function['arguments']['mode']; 68 | 69 | // Set default message type 70 | $message_type = Thread::KIND_INFO; 71 | 72 | // Get threads list depending on message mode 73 | $threads = array(); 74 | if ($mode === 'chats') { 75 | // Message mode: all active chats 76 | $threads = Database::getInstance()->query( 77 | 'SELECT threadid FROM {thread} WHERE istate = :istate', 78 | array(':istate' => Thread::STATE_CHATTING), 79 | array('return_rows' => Database::RETURN_ALL_ROWS) 80 | ); 81 | } 82 | elseif ($mode === 'operators') { 83 | // Message mode: operators only (all active chats and invitations) 84 | $threads = Database::getInstance()->query( 85 | 'SELECT threadid FROM {thread} WHERE istate = :istate1 or istate = :istate2', 86 | array(':istate1' => Thread::STATE_CHATTING, ':istate2' => Thread::STATE_INVITED), 87 | array('return_rows' => Database::RETURN_ALL_ROWS) 88 | ); 89 | 90 | // Hide message from visitors 91 | $message_type = Thread::KIND_FOR_AGENT; 92 | } 93 | elseif ($mode === 'queue') { 94 | // Message mode: all opened chats without operators 95 | $threads = Database::getInstance()->query( 96 | 'SELECT threadid FROM {thread} WHERE istate = :istate1 or istate = :istate2', 97 | array(':istate1' => Thread::STATE_QUEUE, ':istate2' => Thread::STATE_WAITING), 98 | array('return_rows' => Database::RETURN_ALL_ROWS) 99 | ); 100 | } 101 | elseif ($mode === 'all') { 102 | // Message mode: all chats (except for closed ones) 103 | $threads = Database::getInstance()->query( 104 | 'SELECT threadid FROM {thread} WHERE istate <> :istate', 105 | array(':istate' => Thread::STATE_CLOSED), 106 | array('return_rows' => Database::RETURN_ALL_ROWS) 107 | ); 108 | } 109 | 110 | // Acually send messages 111 | foreach ($threads as $thread) { 112 | $thread_object = Thread::load($thread['threadid']); 113 | $thread_object->postMessage($message_type, $message); 114 | } 115 | 116 | $function['results'] = array(); 117 | } 118 | } 119 | 120 | /** 121 | * Adds custom JS file to the page. 122 | * 123 | * @see \Mibew\EventDispatcher\Events::PAGE_ADD_JS 124 | */ 125 | public function addJs(&$args) 126 | { 127 | if ($this->checkAdmin()) { 128 | if (!strcmp('/operator/users', $args['request']->getPathInfo())) { 129 | $args['js'][] = str_replace(DIRECTORY_SEPARATOR, '/', $this->getFilesPath()) . '/js/broadcast.js'; 130 | } 131 | } 132 | } 133 | 134 | /** 135 | * Adds custom CSS file to the page. 136 | * 137 | * @see \Mibew\EventDispatcher\Events::PAGE_ADD_CSS 138 | */ 139 | public function addCss(&$args) 140 | { 141 | if ($this->checkAdmin()) { 142 | if (!strcmp('/operator/users', $args['request']->getPathInfo())) { 143 | $args['css'][] = $this->getFilesPath() . '/css/broadcast.css'; 144 | } 145 | } 146 | } 147 | 148 | /** 149 | * Checks whether an actual operator is an administrator. 150 | */ 151 | protected function checkAdmin() 152 | { 153 | return (array_key_exists(SESSION_PREFIX . 'operator', $_SESSION) 154 | && is_capable(CAN_ADMINISTRATE, operator_by_id($_SESSION[SESSION_PREFIX . 'operator']['operatorid']))); 155 | } 156 | 157 | /** 158 | * Returns verision of the plugin. 159 | * 160 | * @return string Plugin's version. 161 | */ 162 | public static function getVersion() 163 | { 164 | return '0.1.1'; 165 | } 166 | 167 | /** 168 | * {@inheritdoc} 169 | */ 170 | public static function install() 171 | { 172 | // Initialize localization constants 173 | $constants = array( 174 | 'Broadcast to', 175 | 'all', 176 | 'chats', 177 | 'queue', 178 | 'operators', 179 | 'Enter the message:' 180 | ); 181 | 182 | foreach ($constants as $constant) { 183 | getlocal($constant); 184 | } 185 | 186 | return true; 187 | } 188 | } 189 | 190 | -------------------------------------------------------------------------------- /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 | --------------------------------------------------------------------------------