Refactor packet layers from database into code

carlbennett · carlbennett · commit 8570f3690309 · 2019-12-31T14:41:52.000Z
diff --git a/src/controllers/Packet/Index.php b/src/controllers/Packet/Index.php
@@ -3,7 +3,7 @@
 namespace BNETDocs\Controllers\Packet;
 
 use \BNETDocs\Libraries\Packet;
-use \BNETDocs\Libraries\PacketApplicationLayer as PktAppLayer;
+use \BNETDocs\Libraries\Packet\Application as ApplicationLayer;
 use \BNETDocs\Models\Packet\Index as PacketIndexModel;
 use \BNETDocs\Views\Packet\IndexHtml as PacketIndexHtmlView;
 use \BNETDocs\Views\Packet\IndexJSON as PacketIndexJSONView;
@@ -62,7 +62,7 @@ public function &run( Router &$router, View &$view, array &$args ) {
         $order = null;
     }
 
-    $model->application_layers = PktAppLayer::getAllPacketApplicationLayers();
+    $model->application_layers = ApplicationLayer::getAllAsObjects();
 
     if ( empty( $model->pktapplayer )) {
       foreach ( $model->application_layers as $layer ) {
diff --git a/src/controllers/Packet/View.php b/src/controllers/Packet/View.php
@@ -7,10 +7,12 @@
 use \BNETDocs\Libraries\Packet;
 use \BNETDocs\Libraries\Product;
 use \BNETDocs\Models\Packet\View as PacketViewModel;
+
 use \CarlBennett\MVC\Libraries\Common;
 use \CarlBennett\MVC\Libraries\Controller;
 use \CarlBennett\MVC\Libraries\Router;
 use \CarlBennett\MVC\Libraries\View as ViewLib;
+
 use \DateTime;
 use \DateTimeZone;
 
diff --git a/src/libraries/Exceptions/CommentNotFoundException.php b/src/libraries/Exceptions/CommentNotFoundException.php
@@ -9,7 +9,7 @@
 class CommentNotFoundException extends BNETDocsException {
 
   public function __construct($query, Exception &$prev_ex = null) {
-    parent::__construct("Comment not found", 21, $prev_ex);
+    parent::__construct("Comment not found", 18, $prev_ex);
     Logger::logMetric("query", $query);
   }
 
diff --git a/src/libraries/Exceptions/EventNotFoundException.php b/src/libraries/Exceptions/EventNotFoundException.php
@@ -9,7 +9,7 @@
 class EventNotFoundException extends BNETDocsException {
 
   public function __construct($id, Exception &$prev_ex = null) {
-    parent::__construct('Event not found', 22, $prev_ex);
+    parent::__construct('Event not found', 19, $prev_ex);
     Logger::logMetric('event_id', $id);
   }
 
diff --git a/src/libraries/Exceptions/PacketApplicationLayerNotFoundException.php b/src/libraries/Exceptions/PacketApplicationLayerNotFoundException.php
diff --git a/src/libraries/Exceptions/PacketDirectionInvalidException.php b/src/libraries/Exceptions/PacketDirectionInvalidException.php
diff --git a/src/libraries/Exceptions/PacketTransportLayerNotFoundException.php b/src/libraries/Exceptions/PacketTransportLayerNotFoundException.php
diff --git a/src/libraries/Exceptions/ProductNotFoundException.php b/src/libraries/Exceptions/ProductNotFoundException.php
@@ -9,7 +9,7 @@
 class ProductNotFoundException extends BNETDocsException {
 
   public function __construct($query, Exception &$prev_ex = null) {
-    parent::__construct("Product not found", 20, $prev_ex);
+    parent::__construct("Product not found", 17, $prev_ex);
     Logger::logMetric("query", $query);
   }
 
diff --git a/src/libraries/Exceptions/Reference.md b/src/libraries/Exceptions/Reference.md
@@ -21,9 +21,6 @@ All of the following errors are subclassed from the `BNETDocsException` class.
 | 14         | `PacketNotFoundException`                 | Packet not found                                     |
 | 15         | `DocumentNotFoundException`               | Document not found                                   |
 | 16         | `RecaptchaException`                      | `$message`                                           |
-| 17         | `PacketApplicationLayerNotFoundException` | Packet application layer not found                   |
-| 18         | `PacketTransportLayerNotFoundException`   | Packet transport layer not found                     |
-| 19         | `PacketDirectionInvalidException`         | Packet direction is invalid                          |
-| 20         | `ProductNotFoundException`                | Product not found                                    |
-| 21         | `CommentNotFoundException`                | Comment not found                                    |
-| 22         | `EventNotFoundException`                  | Event not found                                      |
+| 17         | `ProductNotFoundException`                | Product not found                                    |
+| 18         | `CommentNotFoundException`                | Comment not found                                    |
+| 19         | `EventNotFoundException`                  | Event not found                                      |
diff --git a/src/libraries/Packet.php b/src/libraries/Packet.php
@@ -2,11 +2,10 @@
 
 namespace BNETDocs\Libraries;
 
-use \BNETDocs\Libraries\Exceptions\PacketDirectionInvalidException;
 use \BNETDocs\Libraries\Exceptions\PacketNotFoundException;
 use \BNETDocs\Libraries\Exceptions\QueryException;
-use \BNETDocs\Libraries\PacketApplicationLayer;
-use \BNETDocs\Libraries\PacketTransportLayer;
+use \BNETDocs\Libraries\Packet\Application as ApplicationLayer;
+use \BNETDocs\Libraries\Packet\Transport as TransportLayer;
 use \BNETDocs\Libraries\User;
 
 use \CarlBennett\MVC\Libraries\Common;
@@ -20,6 +19,7 @@
 use \PDO;
 use \PDOException;
 use \StdClass;
+use \UnexpectedValueException;
 
 class Packet implements JsonSerializable {
 
@@ -332,7 +332,7 @@ public function getOptionsBitmask() {
   }
 
   public function getPacketApplicationLayer() {
-    return new PacketApplicationLayer( $this->packet_application_layer );
+    return new ApplicationLayer( $this->packet_application_layer );
   }
 
   public function getPacketApplicationLayerId() {
@@ -349,7 +349,9 @@ public function getPacketDirectionLabel() {
       case self::DIRECTION_SERVER_CLIENT: return 'Server to Client';
       case self::DIRECTION_PEER_TO_PEER:  return 'Peer to Peer';
       default:
-        throw new PacketDirectionInvalidException( $this->packet_direction_id );
+        throw new UnexpectedValueException(sprintf(
+          'packet direction: %d is invalid', $this->packet_direction_id
+        ));
     }
   }
 
@@ -359,7 +361,9 @@ public function getPacketDirectionTag() {
       case self::DIRECTION_SERVER_CLIENT: return 'S>C';
       case self::DIRECTION_PEER_TO_PEER:  return 'P2P';
       default:
-        throw new PacketDirectionInvalidException( $this->packet_direction_id );
+        throw new UnexpectedValueException(sprintf(
+          'packet direction: %d is invalid', $this->packet_direction_id
+        ));
     }
   }
 
@@ -393,7 +397,7 @@ public function getPacketRemarks( $prepare ) {
   }
 
   public function getPacketTransportLayer() {
-    return new PacketTransportLayer( $this->packet_transport_layer_id );
+    return new TransportLayer( $this->packet_transport_layer_id );
   }
 
   public function getPacketTransportLayerId() {
diff --git a/src/libraries/Packet/Application.php b/src/libraries/Packet/Application.php
@@ -0,0 +1,47 @@
+<?php
+
+namespace BNETDocs\Libraries\Packet;
+
+use \BNETDocs\Libraries\Packet\Layer;
+use \OutOfBoundsException;
+
+class Application extends Layer {
+
+  protected static $table = array(
+    1 => array('Battle.net v1 TCP Messages', 'SID'),
+    2 => array('Battle.net v1 UDP Messages', 'PKT'),
+    3 => array('Realm Messages', 'MCP'),
+    4 => array('D2GS Messages', 'D2GS'),
+    5 => array('W3GS Messages', 'W3GS'),
+    6 => array('BotNet Messages', 'PACKET'),
+    7 => array('BNLS Messages', 'BNLS'),
+    8 => array('SCGP Messages', 'SCGP'),
+    9 => array('Battle.net v2 TCP Messages', 'SID2'),
+  );
+
+  protected function assign(int $id) {
+    if (!isset(self::$table[$id])) {
+      throw new OutOfBoundsException(sprintf(
+        'application id: %d not found', $id
+      ));
+    }
+
+    $this->id    = $id;
+    $this->label = self::$table[$id][0];
+    $this->tag   = self::$table[$id][1];
+  }
+
+  public static function getAllAsArray() {
+    return self::$table;
+  }
+
+  public static function getAllAsObjects() {
+    $r = array();
+    $k = array_keys(self::$table);
+    foreach ($k as $id) {
+      $r[] = new self($id);
+    }
+    return $r;
+  }
+
+}
diff --git a/src/libraries/Packet/Layer.php b/src/libraries/Packet/Layer.php
@@ -0,0 +1,31 @@
+<?php
+
+namespace BNETDocs\Libraries\Packet;
+
+abstract class Layer {
+
+  protected $id;
+  protected $label;
+  protected $tag;
+
+  public function __construct(int $id) {
+    $this->assign($id);
+  }
+
+  protected abstract function assign(int $id);
+  public abstract static function getAllAsArray();
+  public abstract static function getAllAsObjects();
+
+  public function getId() {
+    return $this->id;
+  }
+
+  public function getLabel() {
+    return $this->label;
+  }
+
+  public function getTag() {
+    return $this->tag;
+  }
+
+}
diff --git a/src/libraries/Packet/Transport.php b/src/libraries/Packet/Transport.php
@@ -0,0 +1,41 @@
+<?php
+
+namespace BNETDocs\Libraries\Packet;
+
+use \BNETDocs\Libraries\Packet\Layer;
+use \OutOfBoundsException;
+
+class Transport extends Layer {
+
+  protected static $table = array(
+    1 => array('Transmission Control Protocol', 'TCP'),
+    2 => array('User Datagram Protocol', 'UDP'),
+    3 => array('Internet Control Message Protocol', 'ICMP'),
+  );
+
+  protected function assign(int $id) {
+    if (!isset(self::$table[$id])) {
+      throw new OutOfBoundsException(sprintf(
+        'transport id: %d not found', $id
+      ));
+    }
+
+    $this->id    = $id;
+    $this->label = self::$table[$id][0];
+    $this->tag   = self::$table[$id][1];
+  }
+
+  public static function getAllAsArray() {
+    return self::$table;
+  }
+
+  public static function getAllAsObjects() {
+    $r = array();
+    $k = array_keys(self::$table);
+    foreach ($k as $id) {
+      $r[] = new self($id);
+    }
+    return $r;
+  }
+
+}
diff --git a/src/libraries/PacketApplicationLayer.php b/src/libraries/PacketApplicationLayer.php
diff --git a/src/libraries/PacketTransportLayer.php b/src/libraries/PacketTransportLayer.php

Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@`
`9`	`9`	`class CommentNotFoundException extends BNETDocsException {`
`10`	`10`
`11`	`11`	`public function __construct($query, Exception &$prev_ex = null) {`
`12`		`- parent::__construct("Comment not found", 21, $prev_ex);`
	`12`	`+ parent::__construct("Comment not found", 18, $prev_ex);`
`13`	`13`	`Logger::logMetric("query", $query);`
`14`	`14`	`}`
`15`	`15`
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@`
`9`	`9`	`class EventNotFoundException extends BNETDocsException {`
`10`	`10`
`11`	`11`	`public function __construct($id, Exception &$prev_ex = null) {`
`12`		`- parent::__construct('Event not found', 22, $prev_ex);`
	`12`	`+ parent::__construct('Event not found', 19, $prev_ex);`
`13`	`13`	`Logger::logMetric('event_id', $id);`
`14`	`14`	`}`
`15`	`15`
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@`
`9`	`9`	`class ProductNotFoundException extends BNETDocsException {`
`10`	`10`
`11`	`11`	`public function __construct($query, Exception &$prev_ex = null) {`
`12`		`- parent::__construct("Product not found", 20, $prev_ex);`
	`12`	`+ parent::__construct("Product not found", 17, $prev_ex);`
`13`	`13`	`Logger::logMetric("query", $query);`
`14`	`14`	`}`
`15`	`15`