├── composer.json ├── .gitignore ├── package.json ├── gulpfile.js ├── README.md ├── Plugin.php └── LICENSE /composer.json: -------------------------------------------------------------------------------- 1 | { 2 | "require": { 3 | "fabiang/xmpp": "0.7.0" 4 | } 5 | } 6 | -------------------------------------------------------------------------------- /.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 | 8 | # Do not include composer products 9 | vendor 10 | 11 | # Do not index composer files 12 | composer.phar 13 | composer.lock 14 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "version": "0.0.1", 3 | "devDependencies": { 4 | "event-stream": "~3.1.7", 5 | "gulp": "^4.0.0", 6 | "gulp-chmod": "~3.0.0", 7 | "gulp-composer": "*", 8 | "gulp-gzip": "~0.0.8", 9 | "gulp-rename": "~1.2.0", 10 | "gulp-tar": "~3.1.0", 11 | "gulp-util": "*", 12 | "gulp-zip": "~2.0.2" 13 | }, 14 | "dependencies": { 15 | "gulp": "^4.0.0", 16 | "graceful-fs": "^4.1.11" 17 | } 18 | } 19 | -------------------------------------------------------------------------------- /gulpfile.js: -------------------------------------------------------------------------------- 1 | var fs = require('fs'), 2 | https = require('https'), 3 | exec = require('child_process').exec, 4 | eventStream = require('event-stream'), 5 | gulp = require('gulp'), 6 | chmod = require('gulp-chmod'), 7 | zip = require('gulp-zip'), 8 | tar = require('gulp-tar'), 9 | gzip = require('gulp-gzip'), 10 | rename = require('gulp-rename'); 11 | 12 | var config = { 13 | getComposerUrl: 'https://getcomposer.org/installer', 14 | phpBin: 'php -d "suhosin.executor.include.whitelist = phar" -d "memory_limit=512M"' 15 | } 16 | 17 | // Get and install PHP Composer 18 | gulp.task('get-composer', function(callback) { 19 | // Check if Composer already in place 20 | if (fs.existsSync('./composer.phar')) { 21 | callback(null); 22 | 23 | return; 24 | } 25 | 26 | // Get installer from the internet 27 | https.get(config.getComposerUrl, function(response) { 28 | // Run PHP to install Composer 29 | var php = exec(config.phpBin, function(error, stdout, stderr) { 30 | callback(error ? stderr : null); 31 | }); 32 | // Pass installer code to PHP via STDIN 33 | response.pipe(php.stdin); 34 | }); 35 | }); 36 | 37 | // Install Composer dependencies 38 | gulp.task('composer-install', gulp.series('get-composer', function(callback) { 39 | exec(config.phpBin + ' composer.phar install --no-dev', function(error, stdout, stderr) { 40 | callback(error ? stderr : null); 41 | }); 42 | })); 43 | 44 | gulp.task('prepare-release', gulp.series('composer-install', function() { 45 | var version = require('./package.json').version; 46 | 47 | return eventStream.merge( 48 | getSources() 49 | .pipe(zip('jabber-plugin-' + version + '.zip')), 50 | getSources() 51 | .pipe(tar('jabber-plugin-' + version + '.tar')) 52 | .pipe(gzip()) 53 | ) 54 | .pipe(chmod(0644)) 55 | .pipe(gulp.dest('release')); 56 | })); 57 | 58 | // Builds and packs plugins sources 59 | gulp.task('default', gulp.series('prepare-release')); 60 | 61 | /** 62 | * Returns files stream with the plugin sources. 63 | * 64 | * @returns {Object} Stream with VinylFS files. 65 | */ 66 | var getSources = function() { 67 | return gulp.src([ 68 | 'Plugin.php', 69 | 'README.md', 70 | 'LICENSE', 71 | 'vendor/**/*.*' 72 | ], 73 | {base: './'} 74 | ) 75 | .pipe(rename(function(path) { 76 | path.dirname = 'Mibew/Mibew/Plugin/Jabber/' + path.dirname; 77 | })); 78 | } 79 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Mibew Jabber plugin 2 | Plugin for Mibew Messenger to send notifications on new chats into Jabber (by XMPP). 3 | 4 | # Install 5 | 6 | 1. Get the archive with the plugin sources. You can download it from the [official site](https://mibew.org/plugins#mibew-jabber) or build the plugin from sources. 7 | 2. Untar/unzip the plugin's archive. 8 | 3. Put files of the plugins to the `/plugins` folder. 9 | 4. Configure the plugin by altering the section ```plugins``` in "``/configs/config.yml" file. 10 | 11 | If the "plugins" structure looks like `plugins: []` it will become: 12 | 13 | ```yaml 14 | plugins: 15 | "Mibew:Jabber": # Plugin's configurations are described below 16 | server: "tcp://example.com:5222" 17 | username: "account@example.com/MibewMessenger" 18 | password: "password" 19 | rcpt: "jid@example.com" 20 | ``` 21 | or (if you want to send notifications to multiple users): 22 | 23 | ```yaml 24 | plugins: 25 | "Mibew:Jabber": # Plugin's configurations are described below 26 | server: "tcp://example.com:5222" 27 | username: "account@example.com/MibewMessenger" 28 | password: "password" 29 | rcpt: ["jid1@example.com", "jid2@example.com"] 30 | ``` 31 | 32 | 5. Navigate to `/operator/plugin` page and enable the plugin. 33 | 34 | ## Plugin's configurations 35 | 36 | The plugin can be configured with values in "``/configs/config.yml" 37 | file. 38 | 39 | ### config.server 40 | 41 | Type: `String` 42 | 43 | Address of your XMPP (Jabber) server. Should be written as `://:`. 44 | 45 | ### config.username 46 | 47 | Type: `String` 48 | 49 | The username (JID) of your notification bot. Could be written as `JID/Resource`. 50 | 51 | ### config.password 52 | 53 | Type: `String` 54 | 55 | The password of bot XMPP account. 56 | 57 | ### config.rcpt 58 | 59 | Type: `String` or `Array` 60 | 61 | JID or JIDs to send notifications to. 62 | 63 | # Build from sources 64 | 65 | 1. Obtain a copy of the repository using `git clone`, download button, or another way. 66 | 2. Install [node.js](http://nodejs.org/) and [npm](https://www.npmjs.org/). 67 | 3. Install [Gulp](http://gulpjs.com/). 68 | 4. Install npm dependencies using `npm install`. 69 | 5. Run Gulp to build the sources using `gulp default`. 70 | 71 | Finally `.tar.gz` and `.zip` archives of the ready-to-use Plugin will be available in release directory. 72 | 73 | # License 74 | 75 | [Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0.html) 76 | -------------------------------------------------------------------------------- /Plugin.php: -------------------------------------------------------------------------------- 1 | rcpts = $config['rcpt']; 52 | } 53 | else { 54 | $this->rcpts[] = $config['rcpt']; 55 | } 56 | 57 | $this->initialized = true; 58 | } 59 | } 60 | 61 | /** 62 | * This creates the listener that listens for new 63 | * threads to send out notifications 64 | */ 65 | public function run() 66 | { 67 | $dispatcher = EventDispatcher::getInstance(); 68 | $dispatcher->attachListener(Events::THREAD_CREATE, $this, 'sendJabberNotification'); 69 | } 70 | 71 | /** 72 | * Sends notification to Jabber 73 | * @return boolean 74 | */ 75 | public function sendJabberNotification(&$args) 76 | { 77 | // Initialize jabber connection 78 | $options = new Options($this->config['server']); 79 | $options->setUsername($this->config['username']) 80 | ->setPassword($this->config['password']); 81 | 82 | $client = new Client($options); 83 | $client->connect(); 84 | 85 | // Prepare the notification 86 | $message = new Message; 87 | $message->setMessage(getlocal('You have a new user waiting for a response. Username: {0}', array($args['thread']->userName))); 88 | 89 | // Send the notification to all recipients 90 | foreach ($this->rcpts as $rcpt) { 91 | $message->setTo($rcpt); 92 | $client->send($message); 93 | } 94 | 95 | return true; 96 | } 97 | 98 | /** 99 | * Returns plugin's version. 100 | * 101 | * @return string 102 | */ 103 | public static function getVersion() 104 | { 105 | return '0.0.1'; 106 | } 107 | 108 | /** 109 | * Returns plugin's dependencies. 110 | * 111 | * @return type 112 | */ 113 | public static function getDependencies() 114 | { 115 | return array(); 116 | } 117 | } 118 | -------------------------------------------------------------------------------- /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 | --------------------------------------------------------------------------------