Add Discord webhook for server status updates

Author: carlbennett

etc/config.sample.json

@@ -56,6 +56,11 @@
       "ignore_event_types": [3,5,7,8,9,10,11],
       "webhook": null
     },
+    "forward_server_updates": {
+      "enabled": false,
+      "ignore_server_ids": [],
+      "webhook": null
+    },
     "invite_code": "u87WVeu",
     "server_id": 405789880749260820
   },

src/controllers/Server/UpdateJob.php

@@ -2,6 +2,9 @@
 
 namespace BNETDocs\Controllers\Server;
 
+use \BNETDocs\Libraries\Discord\Embed as DiscordEmbed;
+use \BNETDocs\Libraries\Discord\EmbedField as DiscordEmbedField;
+use \BNETDocs\Libraries\Discord\Webhook as DiscordWebhook;
 use \BNETDocs\Libraries\Exceptions\ServerNotFoundException;
 use \BNETDocs\Libraries\Server;
 
@@ -16,6 +19,11 @@
 use \DateTimeZone;
 
 class UpdateJob extends Controller {
+
+  const S_DISABLED = ':no_entry: Disabled';
+  const S_ONLINE   = ':white_check_mark: Online';
+  const S_OFFLINE  = ':x: Offline';
+  
   public function &run( Router &$router, ViewLib &$view, array &$args ) {
     $model = new UpdateJobModel();
     $action = $router->getRequestMethod();
@@ -36,7 +44,7 @@ public function &run( Router &$router, ViewLib &$view, array &$args ) {
       );
 
       $status = (
-        isset( $q[ 'status' ]) ? $q[ 'status' ] : null
+        isset( $q[ 'status' ]) ? (int) $q[ 'status' ] : null
       );
 
       if ( !is_null( $server_id )) $server_id = (int) $server_id;
@@ -47,13 +55,9 @@ public function &run( Router &$router, ViewLib &$view, array &$args ) {
       );
 
       if ( !( is_int( $server_id ) && is_int( $status ))) {
-
         $model->_responseCode = 400;
-
       } else if ( !$authenticated ) {
-
         $model->_responseCode = 403;
-
       } else {
 
         try {
@@ -63,24 +67,88 @@ public function &run( Router &$router, ViewLib &$view, array &$args ) {
         }
 
         if ( !$model->server ) {
-
           $model->_responseCode = 404;
-
         } else {
 
           $model->old_status_bitmask = $model->server->getStatusBitmask();
-
           $model->server->setStatusBitmask( $status );
 
           if ( $model->server->save() ) {
+            $discord = Common::$config->discord->forward_server_updates;
+            if ( $discord && $discord->enabled
+              && !in_array( $server_id, $discord->ignore_server_ids )) {
+              self::dispatchDiscord(
+                $model->server, $discord->webhook,
+                $model->old_status_bitmask, $status
+              );
+            }
+
             $model->_responseCode = 200;
           }
-
         }
       }
     }
 
     $view->render( $model );
     return $model;
   }
+
+  protected static function dispatchDiscord( $server, $webhook, $old, $new ) {
+    if ($old === $new) return;
+
+    if ($old & Server::STATUS_DISABLED) {
+      $old_status = self::S_DISABLED;
+    } else if ($old & Server::STATUS_ONLINE) {
+      $old_status = self::S_ONLINE;
+    } else if (!($old & Server::STATUS_ONLINE)) {
+      $old_status = self::S_OFFLINE;
+    } else {
+      $old_status = sprintf('Unknown (%d)', $old);
+    }
+
+    if ($new & Server::STATUS_DISABLED) {
+      $title = 'Server Disabled';
+      $new_status = self::S_DISABLED;
+    } else if ($new & Server::STATUS_ONLINE) {
+      $title = 'Server Online';
+      $new_status = self::S_ONLINE;
+    } else if (!($new & Server::STATUS_ONLINE)) {
+      $title = 'Server Offline';
+      $new_status = self::S_OFFLINE;
+    } else {
+      $title = 'Generic Status Change';
+      $new_status = sprintf('Unknown (%d)', $new);
+    }
+
+    $label = $server->getLabel();
+
+    if (!empty($label)) {
+      $title .= ': ' . $label;
+    }
+
+    $webhook = new DiscordWebhook($webhook);
+    $embed   = new DiscordEmbed();
+
+    $embed->setUrl($server->getURI());
+    $embed->setTitle($title);
+    $embed->setTimestamp(new DateTime('now', new DateTimeZone('Etc/UTC')));
+
+    $data = array();
+    $data['Type'] = $server->getType()->getLabel();
+
+    if (!empty($label)) {
+      $data['Label'] = $label;
+    }
+
+    $data['Server'] = $server->getAddress() . ':' . $server->getPort();
+    $data['Status'] = $old_status . ' → ' . $new_status;
+
+    foreach ($data as $key => $value) {
+      $field = new DiscordEmbedField($key, $value, true);
+      $embed->addField($field);
+    }
+
+    $webhook->addEmbed($embed);
+    $webhook->send();
+  }
 }

src/libraries/Server.php

@@ -2,11 +2,14 @@
 
 namespace BNETDocs\Libraries;
 
+use \BNETDocs\Libraries\Exceptions\QueryException;
+use \BNETDocs\Libraries\Exceptions\ServerNotFoundException;
+use \BNETDocs\Libraries\ServerType;
+
 use \CarlBennett\MVC\Libraries\Common;
 use \CarlBennett\MVC\Libraries\Database;
 use \CarlBennett\MVC\Libraries\DatabaseDriver;
-use \BNETDocs\Libraries\Exceptions\QueryException;
-use \BNETDocs\Libraries\Exceptions\ServerNotFoundException;
+
 use \DateTime;
 use \DateTimeZone;
 use \InvalidArgumentException;
@@ -192,6 +195,10 @@ public function getStatusBitmask() {
     return $this->status_bitmask;
   }
 
+  public function getType() {
+    return new ServerType($this->type_id);
+  }
+
   public function getTypeId() {
     return $this->type_id;
   }
@@ -225,6 +232,18 @@ public function getUserId() {
     return $this->user_id;
   }
 
+  public function isDisabled() {
+    return ($this->status_bitmask & self::STATUS_DISABLED);
+  }
+
+  public function isOffline() {
+    return (!$this->isOnline());
+  }
+
+  public function isOnline() {
+    return ($this->status_bitmask & self::STATUS_ONLINE);
+  }
+
   public function jsonSerialize() {
     $created_datetime = $this->getCreatedDateTime();
     if (!is_null($created_datetime)) $created_datetime = [