├── .gitignore
├── package.json
├── routing.yml
├── LICENSE
├── gulpfile.js
├── Plugin.php
├── README.md
└── Controller
    └── OperatorStatusController.php


/.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


--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "version": "0.4.0",
 3 |   "devDependencies": {
 4 |     "event-stream": "3.3.4",
 5 |     "gulp": "^4.0.0",
 6 |     "gulp-chmod": "~3.0.0",
 7 |     "gulp-gzip": "~1.1.0",
 8 |     "gulp-rename": "~1.2.2",
 9 |     "gulp-tar": "~3.1.0",
10 |     "gulp-zip": "~3.0.2"
11 |   }
12 | }
13 | 


--------------------------------------------------------------------------------
/routing.yml:
--------------------------------------------------------------------------------
 1 | mibew_operator_status_has_online_operators:
 2 |   path: /opstatus
 3 |   defaults:
 4 |     _controller: Mibew\Mibew\Plugin\OperatorStatus\Controller\OperatorStatusController::hasOnlineOperatorsAction
 5 | 
 6 | mibew_operator_status_has_online_group_operators:
 7 |   path: /opstatus/group/{group_id}
 8 |   defaults:
 9 |     _controller: Mibew\Mibew\Plugin\OperatorStatus\Controller\OperatorStatusController::isOperatorGroupOnlineAction
10 | 
11 | mibew_operator_status_is_operator_online:
12 |   path: /opstatus/{opcode}
13 |   defaults:
14 |     _controller: Mibew\Mibew\Plugin\OperatorStatus\Controller\OperatorStatusController::isOperatorOnlineAction
15 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | MIT License
 2 | 
 3 | Copyright (c) 2016 罗光盛
 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 | 


--------------------------------------------------------------------------------
/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('operator-status-plugin-' + version + '.zip')),
15 |         getSources()
16 |             .pipe(tar('operator-status-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 |             'Controller/*',
34 |             'LICENSE',
35 |             'Plugin.php',
36 |             'README.md',
37 |             'routing.yml'
38 |         ],
39 |         {base: './'}
40 |     )
41 |     .pipe(rename(function(path) {
42 |         path.dirname = 'Mibew/Mibew/Plugin/OperatorStatus/' + path.dirname;
43 |     }));
44 | }


--------------------------------------------------------------------------------
/Plugin.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /*
 3 |  * MIT License
 4 |  *
 5 |  * Copyright (c) 2016 everyx (lunt.luo@gmail.com)
 6 |  *
 7 |  * Permission is hereby granted, free of charge, to any person obtaining a copy
 8 |  * of this software and associated documentation files (the "Software"), to deal
 9 |  * in the Software without restriction, including without limitation the rights
10 |  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 |  * copies of the Software, and to permit persons to whom the Software is
12 |  * furnished to do so, subject to the following conditions:
13 |  *
14 |  * The above copyright notice and this permission notice shall be included in all
15 |  * copies or substantial portions of the Software.
16 |  *
17 |  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 |  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 |  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 |  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 |  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 |  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 |  * SOFTWARE.
24 |  */
25 | 
26 | namespace Mibew\Mibew\Plugin\OperatorStatus;
27 | 
28 | /**
29 |  * Main plugin class.
30 |  */
31 | class Plugin extends \Mibew\Plugin\AbstractPlugin implements \Mibew\Plugin\PluginInterface
32 | {
33 |     protected $initialized = true;
34 | 
35 |     /**
36 |      * The main entry point of a plugin.
37 |      */
38 |     public function run()
39 |     {
40 |     }
41 | 
42 |     /**
43 |      * Returns verision of the plugin.
44 |      *
45 |      * @return string Plugin's version.
46 |      */
47 |     public static function getVersion()
48 |     {
49 |         return '0.4.0';
50 |     }
51 | }
52 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # Mibew Operator Status plugin
 2 | Plugin for Mibew, get statement based on the availability of operators.
 3 | 
 4 | # Usage
 5 | 
 6 | 1. Get any operators online status:
 7 |  
 8 |     * request URL: `<MIBEW-BASE-URL>/opstatus`.
 9 |     * return `true` when any operators is online and `false` when not.
10 | 
11 | 2. Get any operators online status in specificed group:
12 | 
13 |     * request URL: `<MIBEW-BASE-URL>/opstatus/group/<GROUP-ID>`.
14 |     * return `true` when any operators in this group is online and `false` when not.
15 | 
16 | 3. Get an operator online status by operator code:
17 | 
18 |     * Request URL: `<MIBEW-BASE-URL>/opstatus/<OPERATOR-CODE>`.
19 |     * return `true` when operator is online or `false` when not.
20 | 
21 | 4. Use callback parameter:
22 | 
23 |     Just insert `<script>` tag and set `src` to URL above and add `callback` parameter
24 |     
25 |     * `<MIBEW-BASE-URL>/opstatus?callback=<CALLBACK_FUNCTION>`
26 |     * `<MIBEW-BASE-URL>/opstatus/<OPERATOR-CODE>?callback=<CALLBACK_FUNCTION>`
27 |     
28 |     will return bellow and run `CALLBACK_FUNCTION` automatically.
29 | 
30 |     ```javascript
31 |     /**/CALLBACK_FUNCTION(status);
32 |     ```
33 | 
34 | # Install
35 | 
36 | 1. Get the archive with the plugin sources. You can download it from the [official site](https://mibew.org/plugins#mibew-operator-status) or build the plugin from sources.
37 | 
38 | 2. Untar/unzip the plugin's archive.
39 | 
40 | 3. Put files of the plugins to the `<MIBEW-ROOT>/plugins` folder.
41 | 
42 | 4. Navigate to `<MIBEW-BASE-URL>/operator/plugin` page and enable the plugin.
43 | 
44 | **Tips**: if you plugin state is "not initialized", please check `<MIBEW-ROOT>/configs/config.yml` file is not:
45 | 
46 | ```yml
47 | ...
48 | plugins: []
49 | ...
50 | ```
51 | and should be like this:
52 | 
53 | ```yml
54 | ...
55 | plugins:
56 |     "SomePlugin":
57 |         key: value
58 | ...
59 | ```
60 | 
61 | # Build from sources
62 | 
63 | 1. Obtain a copy of the repository using `git clone`, download button, or another way.
64 | 2. Install [node.js](http://nodejs.org/) and [npm](https://www.npmjs.org/).
65 | 3. Install [Gulp](http://gulpjs.com/).
66 | 4. Install npm dependencies using `npm install`.
67 | 5. Run Gulp to build the sources using `gulp default`.
68 | 
69 | Finally `.tar.gz` and `.zip` archives of the ready-to-use Plugin will be available in release directory.
70 | 
71 | # License
72 | 
73 | [MIT](LICENSE)
74 | 


--------------------------------------------------------------------------------
/Controller/OperatorStatusController.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /*
  3 | * MIT License
  4 | *
  5 | * Copyright (c) 2016 everyx (lunt.luo@gmail.com)
  6 | *
  7 | * Permission is hereby granted, free of charge, to any person obtaining a copy
  8 | * of this software and associated documentation files (the "Software"), to deal
  9 | * in the Software without restriction, including without limitation the rights
 10 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 11 | * copies of the Software, and to permit persons to whom the Software is
 12 | * furnished to do so, subject to the following conditions:
 13 | *
 14 | * The above copyright notice and this permission notice shall be included in all
 15 | * copies or substantial portions of the Software.
 16 | *
 17 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 18 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 19 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 20 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 21 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 22 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 23 | * SOFTWARE.
 24 | */
 25 | 
 26 | namespace Mibew\Mibew\Plugin\OperatorStatus\Controller;
 27 | 
 28 | use Mibew\Settings;
 29 | use Mibew\Controller\AbstractController;
 30 | use Symfony\Component\HttpFoundation\Request;
 31 | use Symfony\Component\HttpFoundation\Response;
 32 | use Symfony\Component\HttpFoundation\JsonResponse;
 33 | 
 34 | /**
 35 | * Operator Status actions
 36 | */
 37 | class OperatorStatusController extends AbstractController
 38 | {
 39 |     /**
 40 |     * Returns true or false of whether an operator is online or not.
 41 |     *
 42 |     * @param  Request  $request
 43 |     * @return Response Rendered page content
 44 |     */
 45 |     public function isOperatorOnlineAction(Request $request)
 46 |     {
 47 |         $is_online = false;
 48 | 
 49 |         $opcode = $request->attributes->get('opcode');
 50 |         $online_operators = get_online_operators();
 51 |         foreach ($online_operators as $item) {
 52 |             if ($opcode == $item['code']) {
 53 |                 $is_online = true;
 54 |                 break;
 55 |             }
 56 |         }
 57 | 
 58 |         $callback = $request->query->get('callback');
 59 |         return $this->prepareResponse($is_online, $callback);
 60 |     }
 61 | 
 62 |     /**
 63 |     * Returns true or false of whether any operators is online or not.
 64 |     *
 65 |     * @param  Request  $request
 66 |     * @return Response Rendered page content
 67 |     */
 68 |     public function hasOnlineOperatorsAction(Request $request)
 69 |     {
 70 |         $is_online = has_online_operators();
 71 | 
 72 |         $callback = $request->query->get('callback');
 73 |         return $this->prepareResponse($is_online, $callback);
 74 |     }
 75 | 
 76 |     /**
 77 |     * Returns true or false of whether any operators in specificed group is online or not.
 78 |     *
 79 |     * @param  Request  $request
 80 |     * @return Response Rendered page content
 81 |     */
 82 |     public function isOperatorGroupOnlineAction(Request $request)
 83 |     {
 84 |         $is_online = false;
 85 | 
 86 |         $group_id = $request->attributes->get('group_id');
 87 |         if (Settings::get('enablegroups') == '1') {
 88 |             $is_online = has_online_operators($group_id);
 89 |         }
 90 | 
 91 |         $callback = $request->query->get('callback');
 92 |         return $this->prepareResponse($is_online, $callback);
 93 |     }
 94 | 
 95 |     /**
 96 |     * Returns prepared response: JSONP or plain text.
 97 |     *
 98 |     * @param  Boolean  $is_online
 99 |     * @param  String   $callback
100 |     * @return Response Rendered page content
101 |     */
102 |     private function prepareResponse($is_online, $callback) {
103 |         $response = NULL;
104 | 
105 |         if ( empty($callback) ) {
106 |             $response = new Response( $is_online ? 'true' : 'false' );
107 |             $response->headers->set('Access-Control-Allow-Origin', '*');
108 |         } else {
109 |             $response = new JsonResponse($is_online);
110 |             $response->setCallback($callback);
111 |         }
112 | 
113 |         return $response;
114 |     }
115 | }
116 | 


--------------------------------------------------------------------------------