├── .gitignore ├── package.json ├── gulpfile.js ├── README.md ├── Plugin.php └── LICENSE /.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('auto-invite-plugin-' + version + '.zip')), 15 | getSources() 16 | .pipe(tar('auto-invite-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 | ], 37 | {base: './'} 38 | ) 39 | .pipe(rename(function(path) { 40 | path.dirname = 'Mibew/Mibew/Plugin/AutoInvite/' + path.dirname; 41 | })); 42 | } 43 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Auto Invite plugin 2 | 3 | A plugin to automatically invite a visitor into chat. 4 | 5 | Based on idea of [this code](https://github.com/JustBlackBird/aggressive-messaging). 6 | 7 | ## Installation 8 | 9 | 1. Get the archive with the plugin sources. You can download it from the 10 | [official site](https://mibew.org/plugins#mibew-autoinvite) or build the 11 | plugin from sources. 12 | 13 | 2. Untar/unzip the plugin's archive. 14 | 15 | 3. Put files of the plugins to the `/plugins` folder. 16 | 17 | 4. (optional) Add plugins configs to "plugins" structure in 18 | "``/configs/config.yml". If the "plugins" stucture looks like 19 | `plugins: []` it will become: 20 | ```yaml 21 | plugins: 22 | "Mibew:AutoInvite": # Plugin's configurations are described below 23 | wait_time: 30 24 | strategy: random 25 | group: 0 26 | ``` 27 | 28 | 5. Navigate to "``/operator/plugin" page and enable the plugin. 29 | 30 | ## Plugin's configurations 31 | 32 | The plugin can be configured with values in "``/configs/config.yml" file. 33 | 34 | ### config.wait_time 35 | 36 | Type: `Integer` 37 | 38 | Default: `60` 39 | 40 | Specify time in seconds to wait before sending an invitation. 41 | 42 | ### config.strategy 43 | 44 | Type: `String` 45 | 46 | Default: `first` 47 | 48 | Invitation strategy (i.e. how to choose an operator on behalf of whom 49 | the invitation will be sent). At the moment there are two options 50 | available: `first` (first available operator will be used) and `random` 51 | (speaks for itself). 52 | 53 | ### config.group 54 | 55 | Type: `Integer` 56 | 57 | Default: 0 58 | 59 | What group to choose operator from. Note that if there will be no 60 | available operators from that group the invitation will not be sent. 61 | 62 | 63 | ## Build from sources 64 | 65 | There are several actions one should do before use the latest version of the plugin from the repository: 66 | 67 | 1. Obtain a copy of the repository using `git clone`, download button, or another way. 68 | 2. Install [node.js](http://nodejs.org/) and [npm](https://www.npmjs.org/). 69 | 3. Install [Gulp](http://gulpjs.com/). 70 | 4. Install npm dependencies using `npm install`. 71 | 5. Run Gulp to build the sources using `gulp default`. 72 | 73 | Finally `.tar.gz` and `.zip` archives of the ready-to-use Plugin will be available in `release` directory. 74 | 75 | ## License 76 | 77 | [Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0.html) 78 | -------------------------------------------------------------------------------- /Plugin.php: -------------------------------------------------------------------------------- 1 | 0)) { 48 | $this->wait_time = (int)$config['wait_time']; 49 | } 50 | if (isset($config['strategy']) && ($config['strategy'] == 'random')) { 51 | $this->strategy = $config['strategy']; 52 | } 53 | if (isset($config['group']) && ((int)$config['group'] > 0)) { 54 | $this->group = (int)$config['group']; 55 | } 56 | } 57 | 58 | /** 59 | * Defines necessary event listeners. 60 | */ 61 | public function run() 62 | { 63 | $dispatcher = EventDispatcher::getInstance(); 64 | $dispatcher->attachListener('visitorTrack', $this, 'inviteVisitor'); 65 | $dispatcher->attachListener('invitationAccept', $this, 'markThreadAsOrphaned'); 66 | $dispatcher->attachListener('invitationReject', $this, 'forgetThread'); 67 | $dispatcher->attachListener('invitationIgnore', $this, 'forgetThread'); 68 | } 69 | 70 | /** 71 | * Returns verision of the plugin. 72 | * 73 | * @return string Plugin's version. 74 | */ 75 | public static function getVersion() 76 | { 77 | return '0.1.1'; 78 | } 79 | 80 | /** 81 | * Automatically invite a visitor into chat. 82 | * 83 | * @param array $args Event data 84 | */ 85 | public function inviteVisitor($args) 86 | { 87 | // Get a visitor 88 | $visitor = $args['visitor']; 89 | $visitor_id = $visitor['visitorid']; 90 | 91 | // Is a visitor invited at the moment? 92 | $invitation_state = invitation_state($visitor_id); 93 | // Was a visitor invited before? 94 | $was_invited = $visitor['invitations'] > 0; 95 | // How long a visitor is on the site? 96 | $spent_on_site = (time() - $visitor['firsttime']); 97 | // Are there any operators available? 98 | $anybody_online = has_online_operators($this->group); 99 | 100 | // Check whether the visitor should be invited into chat 101 | $send_invitation = !$invitation_state['invited'] 102 | && !$was_invited 103 | && ($spent_on_site > $this->wait_time) 104 | && $anybody_online; 105 | 106 | if ($send_invitation) { 107 | // Determine operator to send the invitation 108 | $operators = get_online_operators($this->group); 109 | if ($this->strategy == 'first') { 110 | // Invite on behalf of the first available operator 111 | $operator = $operators[0]; 112 | } 113 | else { 114 | // Invite on behalf of a random available operator 115 | $operator = $operators[array_rand($operators)]; 116 | } 117 | // Invite into chat 118 | $thread = invitation_invite($visitor_id, $operator); 119 | 120 | // Store ID of the thread in the database for future use 121 | Database::getInstance()->query( 122 | 'INSERT INTO {mibew_autoinvite} (threadid) VALUES (:threadid)', 123 | array(':threadid' => $thread->id) 124 | ); 125 | } 126 | } 127 | 128 | /** 129 | * Mark the thread tied to invitation as orphaned (i.e. 'waiting for operator'). 130 | * 131 | * @param array $args Event data 132 | */ 133 | public function markThreadAsOrphaned($args) 134 | { 135 | // Get the thread related to invitation 136 | $thread = $args['invitation']; 137 | 138 | // Check whether the thread is related to automatically sent invitation 139 | $result = Database::getInstance()->query( 140 | "SELECT COUNT(*) AS autoinvited FROM {mibew_autoinvite} WHERE threadid = :threadid", 141 | array(':threadid' => $thread->id), 142 | array('return_rows' => Database::RETURN_ONE_ROW) 143 | ); 144 | 145 | if ($result && isset($result['autoinvited']) && ($result['autoinvited'] > 0)) { 146 | // A visitor was invited automatically, change thread state 147 | $thread->state = Thread::STATE_WAITING; 148 | $thread->nextAgent = 0; 149 | $thread->save(true); 150 | // Forget about the thread 151 | $this->forgetThread($args); 152 | } 153 | } 154 | 155 | /** 156 | * Remove ID of the thread tied to invitation from the database. 157 | * 158 | * @param array $args Event data 159 | */ 160 | public function forgetThread($args) 161 | { 162 | $thread = $args['invitation']; 163 | Database::getInstance()->query( 164 | 'DELETE FROM {mibew_autoinvite} WHERE threadid = :threadid', 165 | array(':threadid' => $thread->id) 166 | ); 167 | } 168 | 169 | /** 170 | * {@inheritdoc} 171 | */ 172 | public static function install() 173 | { 174 | return Database::getInstance()->query( 175 | 'CREATE TABLE {mibew_autoinvite} ( ' 176 | . 'threadid INT NOT NULL PRIMARY KEY' 177 | . ') charset utf8 ENGINE=InnoDb' 178 | ); 179 | } 180 | 181 | /** 182 | * {@inheritdoc} 183 | */ 184 | public static function uninstall() 185 | { 186 | return Database::getInstance()->query('DROP TABLE {mibew_autoinvite}'); 187 | } 188 | } 189 | -------------------------------------------------------------------------------- /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 | --------------------------------------------------------------------------------