From b503c9edb9adec822927a4f962366263f34baf3c Mon Sep 17 00:00:00 2001
From: flashwave <me@flash.moe>
Date: Thu, 15 Aug 2024 18:38:01 +0000
Subject: [PATCH] Added stuff for attribute based registration.

---
 src/IRpcActionHandler.php     | 18 ++++++++++
 src/RpcActionAttribute.php    | 67 +++++++++++++++++++++++++++++++++++
 src/RpcActionHandler.php      | 14 ++++++++
 src/RpcActionHandlerTrait.php | 16 +++++++++
 src/RpcProcedureAttribute.php | 20 +++++++++++
 src/RpcQueryAttribute.php     | 20 +++++++++++
 src/RpcServer.php             | 11 +++++-
 7 files changed, 165 insertions(+), 1 deletion(-)
 create mode 100644 src/IRpcActionHandler.php
 create mode 100644 src/RpcActionAttribute.php
 create mode 100644 src/RpcActionHandler.php
 create mode 100644 src/RpcActionHandlerTrait.php
 create mode 100644 src/RpcProcedureAttribute.php
 create mode 100644 src/RpcQueryAttribute.php

diff --git a/src/IRpcActionHandler.php b/src/IRpcActionHandler.php
new file mode 100644
index 0000000..1b97e97
--- /dev/null
+++ b/src/IRpcActionHandler.php
@@ -0,0 +1,18 @@
+<?php
+// IRpcActionHandler.php
+// Created: 2024-08-15
+// Updated: 2024-08-15
+
+namespace Aiwass;
+
+/**
+ * Provides the interface for RpcServer::register().
+ */
+interface IRpcActionHandler {
+    /**
+     * Registers axctions on a given RpcServer instance.
+     *
+     * @param RpcServer $server Target RPC server.
+     */
+    public function registerRpcActions(RpcServer $server): void;
+}
diff --git a/src/RpcActionAttribute.php b/src/RpcActionAttribute.php
new file mode 100644
index 0000000..ab5e769
--- /dev/null
+++ b/src/RpcActionAttribute.php
@@ -0,0 +1,67 @@
+<?php
+// RpcActionAttribute.php
+// Created: 2024-08-15
+// Updated: 2024-08-15
+
+namespace Aiwass;
+
+use Attribute;
+use ReflectionAttribute;
+use ReflectionObject;
+
+/**
+ * Provides base for attributes that mark methods in a class as RPC action handlers.
+ */
+#[Attribute(Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)]
+class RpcActionAttribute {
+    /**
+     * @param bool $isProcedure true if the action is a procedure, false if query.
+     * @param string $name Action name.
+     */
+    public function __construct(
+        private bool $isProcedure,
+        private string $name
+    ) {}
+
+    /**
+     * Returns whether the action is a procedure.
+     *
+     * @return bool
+     */
+    public function isProcedure(): bool {
+        return $this->isProcedure;
+    }
+
+    /**
+     * Returns the action name.
+     *
+     * @return string
+     */
+    public function getName(): string {
+        return $this->name;
+    }
+
+    /**
+     * Reads attributes from methods in a IRpcActionHandler instance and registers them to a given RpcServer instance.
+     *
+     * @param RpcServer $server RPC server instance.
+     * @param IRpcActionHandler $handler Handler instance.
+     */
+    public static function register(RpcServer $server, IRpcActionHandler $handler): void {
+        $objectInfo = new ReflectionObject($handler);
+        $methodInfos = $objectInfo->getMethods();
+
+        foreach($methodInfos as $methodInfo) {
+            $attrInfos = $methodInfo->getAttributes(RpcActionAttribute::class, ReflectionAttribute::IS_INSTANCEOF);
+
+            foreach($attrInfos as $attrInfo) {
+                $handlerInfo = $attrInfo->newInstance();
+                $server->registerAction(
+                    $handlerInfo->isProcedure(),
+                    $handlerInfo->getName(),
+                    $methodInfo->getClosure($methodInfo->isStatic() ? null : $handler)
+                );
+            }
+        }
+    }
+}
diff --git a/src/RpcActionHandler.php b/src/RpcActionHandler.php
new file mode 100644
index 0000000..cfbc3b5
--- /dev/null
+++ b/src/RpcActionHandler.php
@@ -0,0 +1,14 @@
+<?php
+// RpcActionHandler.php
+// Created: 2024-08-15
+// Updated: 2024-08-15
+
+namespace Aiwass;
+
+/**
+ * Provides an abstract class version of IRpcActionHandler that already includes the trait as well,
+ *  letting you only have to use one use statement rather than two!
+ */
+abstract class RpcActionHandler implements IRpcActionHandler {
+    use RpcActionHandlerTrait;
+}
diff --git a/src/RpcActionHandlerTrait.php b/src/RpcActionHandlerTrait.php
new file mode 100644
index 0000000..21d870c
--- /dev/null
+++ b/src/RpcActionHandlerTrait.php
@@ -0,0 +1,16 @@
+<?php
+// RpcActionHandlerTrait.php
+// Created: 2024-08-15
+// Updated: 2024-08-15
+
+namespace Aiwass;
+
+/**
+ * Provides an implementation of IRpcActionHandler::registerRpcActions that uses the attributes.
+ * For more advanced use, everything can be use'd separately and RpcActionAttribute::register called manually.
+ */
+trait RpcActionHandlerTrait {
+    public function registerRoutes(RpcServer $server): void {
+        RpcActionAttribute::register($server, $this);
+    }
+}
diff --git a/src/RpcProcedureAttribute.php b/src/RpcProcedureAttribute.php
new file mode 100644
index 0000000..acc32cf
--- /dev/null
+++ b/src/RpcProcedureAttribute.php
@@ -0,0 +1,20 @@
+<?php
+// RpcProcedureAttribute.php
+// Created: 2024-08-15
+// Updated: 2024-08-15
+
+namespace Aiwass;
+
+use Attribute;
+/**
+ * Provides an attribute for marking methods in a class as an RPC Query action.
+ */
+#[Attribute(Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)]
+class RpcProcedureAttribute extends RpcActionAttribute {
+    /**
+     * @param string $name Action name.
+     */
+    public function __construct(string $name) {
+        parent::__construct(true, $name);
+    }
+}
diff --git a/src/RpcQueryAttribute.php b/src/RpcQueryAttribute.php
new file mode 100644
index 0000000..417f612
--- /dev/null
+++ b/src/RpcQueryAttribute.php
@@ -0,0 +1,20 @@
+<?php
+// RpcQueryAttribute.php
+// Created: 2024-08-15
+// Updated: 2024-08-15
+
+namespace Aiwass;
+
+use Attribute;
+/**
+ * Provides an attribute for marking methods in a class as an RPC Query action.
+ */
+#[Attribute(Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)]
+class RpcQueryAttribute extends RpcActionAttribute {
+    /**
+     * @param string $name Action name.
+     */
+    public function __construct(string $name) {
+        parent::__construct(false, $name);
+    }
+}
diff --git a/src/RpcServer.php b/src/RpcServer.php
index 9f8a0dc..53d9b54 100644
--- a/src/RpcServer.php
+++ b/src/RpcServer.php
@@ -1,7 +1,7 @@
 <?php
 // RpcServer.php
 // Created: 2024-08-13
-// Updated: 2024-08-13
+// Updated: 2024-08-15
 
 namespace Aiwass;
 
@@ -40,6 +40,15 @@ class RpcServer {
         return new RpcRouteHandler($this);
     }
 
+    /**
+     * Registers a handler class.
+     *
+     * @param IRpcActionHandler $handler Handler to register.
+     */
+    public function register(IRpcActionHandler $handler): void {
+        $handler->registerRpcActions($this);
+    }
+
     /**
      * Registers an action.
      *