Remove the ServerQueue from the ServerProtocolHandlerInterface. The h…

…andler should be constructed with it.
FreeDSx · Aug 6, 2023 · 10c88b0 · 10c88b0
1 parent 85c5547
commit 10c88b0
Show file tree

Hide file tree

Showing 31 changed files with 233 additions and 162 deletions.
diff --git a/src/FreeDSx/Ldap/Container.php b/src/FreeDSx/Ldap/Container.php
@@ -22,7 +22,6 @@
 use FreeDSx\Ldap\Protocol\ServerAuthorization;
 use FreeDSx\Ldap\Server\HandlerFactoryInterface;
 use FreeDSx\Ldap\Server\RequestHandler\HandlerFactory;
-use FreeDSx\Ldap\Server\RequestHistory;
 use FreeDSx\Ldap\Server\ServerProtocolFactory;
 use FreeDSx\Ldap\Server\ServerRunner\PcntlServerRunner;
 use FreeDSx\Ldap\Server\ServerRunner\ServerRunnerInterface;
@@ -153,10 +152,6 @@ className: ServerRunnerInterface::class,
             className: ServerAuthorization::class,
             factory: $this->makeServerAuthorizer(...),
         );
-        $this->registerFactory(
-            className: ServerProtocolHandlerFactory::class,
-            factory: $this->makeServerProtocolHandlerFactory(...),
-        );
     }
 
     private function makeClientProtocolHandler(): ClientProtocolHandler
@@ -199,8 +194,7 @@ private function makeServerProtocolFactory(): ServerProtocolFactory
     {
         return new ServerProtocolFactory(
             handlerFactory: $this->get(HandlerFactoryInterface::class),
-            logger: $this->get(ServerOptions::class)->getLogger(),
-            serverProtocolHandlerFactory: $this->get(ServerProtocolHandlerFactory::class),
+            options: $this->get(ServerOptions::class),
             serverAuthorization: $this->get(ServerAuthorization::class),
         );
     }
@@ -232,13 +226,4 @@ private function makeServerAuthorizer(): ServerAuthorization
     {
         return new ServerAuthorization($this->get(ServerOptions::class));
     }
-
-    private function makeServerProtocolHandlerFactory(): ServerProtocolHandlerFactory
-    {
-        return new ServerProtocolHandlerFactory(
-            handlerFactory: $this->get(HandlerFactoryInterface::class),
-            options: $this->get(ServerOptions::class),
-            requestHistory: new RequestHistory(),
-        );
-    }
 }
diff --git a/src/FreeDSx/Ldap/Protocol/Factory/ServerBindHandlerFactory.php b/src/FreeDSx/Ldap/Protocol/Factory/ServerBindHandlerFactory.php
@@ -18,6 +18,7 @@
 use FreeDSx\Ldap\Operation\Request\RequestInterface;
 use FreeDSx\Ldap\Operation\Request\SimpleBindRequest;
 use FreeDSx\Ldap\Operation\ResultCode;
+use FreeDSx\Ldap\Protocol\Queue\ServerQueue;
 use FreeDSx\Ldap\Protocol\ServerProtocolHandler\BindHandlerInterface;
 use FreeDSx\Ldap\Protocol\ServerProtocolHandler\ServerAnonBindHandler;
 use FreeDSx\Ldap\Protocol\ServerProtocolHandler\ServerBindHandler;
@@ -29,6 +30,10 @@
  */
 class ServerBindHandlerFactory
 {
+    public function __construct(private readonly ServerQueue $queue)
+    {
+    }
+
     /**
      * Get the bind handler specific to the request.
      *
@@ -37,9 +42,9 @@ class ServerBindHandlerFactory
     public function get(RequestInterface $request): BindHandlerInterface
     {
         if ($request instanceof SimpleBindRequest) {
-            return new ServerBindHandler();
+            return new ServerBindHandler($this->queue);
         } elseif ($request instanceof AnonBindRequest) {
-            return new ServerAnonBindHandler();
+            return new ServerAnonBindHandler($this->queue);
         } else {
             throw new OperationException(
                 'The authentication type requested is not supported.',

diff --git a/src/FreeDSx/Ldap/Protocol/Factory/ServerProtocolHandlerFactory.php b/src/FreeDSx/Ldap/Protocol/Factory/ServerProtocolHandlerFactory.php
@@ -19,6 +19,7 @@
 use FreeDSx\Ldap\Operation\Request\RequestInterface;
 use FreeDSx\Ldap\Operation\Request\SearchRequest;
 use FreeDSx\Ldap\Operation\Request\UnbindRequest;
+use FreeDSx\Ldap\Protocol\Queue\ServerQueue;
 use FreeDSx\Ldap\Protocol\ServerProtocolHandler;
 use FreeDSx\Ldap\Protocol\ServerProtocolHandler\ServerProtocolHandlerInterface;
 use FreeDSx\Ldap\Server\HandlerFactoryInterface;
@@ -36,6 +37,7 @@ public function __construct(
         private readonly HandlerFactoryInterface $handlerFactory,
         private readonly ServerOptions $options,
         private readonly RequestHistory $requestHistory,
+        private readonly ServerQueue $queue,
     ) {
     }
 
@@ -44,19 +46,22 @@ public function get(
         ControlBag $controls
     ): ServerProtocolHandlerInterface {
         if ($request instanceof ExtendedRequest && $request->getName() === ExtendedRequest::OID_WHOAMI) {
-            return new ServerProtocolHandler\ServerWhoAmIHandler();
+            return new ServerProtocolHandler\ServerWhoAmIHandler($this->queue);
         } elseif ($request instanceof ExtendedRequest && $request->getName() === ExtendedRequest::OID_START_TLS) {
-            return new ServerProtocolHandler\ServerStartTlsHandler($this->options);
+            return new ServerProtocolHandler\ServerStartTlsHandler(
+                options: $this->options,
+                queue: $this->queue,
+            );
         } elseif ($this->isRootDseSearch($request)) {
             return $this->getRootDseHandler();
         } elseif ($this->isPagingSearch($request, $controls)) {
             return $this->getPagingHandler();
         } elseif ($request instanceof SearchRequest) {
-            return new ServerProtocolHandler\ServerSearchHandler();
+            return new ServerProtocolHandler\ServerSearchHandler($this->queue);
         } elseif ($request instanceof UnbindRequest) {
-            return new ServerProtocolHandler\ServerUnbindHandler();
+            return new ServerProtocolHandler\ServerUnbindHandler($this->queue);
         } else {
-            return new ServerProtocolHandler\ServerDispatchHandler();
+            return new ServerProtocolHandler\ServerDispatchHandler($this->queue);
         }
     }
 
@@ -83,8 +88,9 @@ private function getRootDseHandler(): ServerProtocolHandler\ServerRootDseHandler
         $rootDseHandler = $this->handlerFactory->makeRootDseHandler();
 
         return new ServerProtocolHandler\ServerRootDseHandler(
-            $this->options,
-            $rootDseHandler,
+            options: $this->options,
+            queue: $this->queue,
+            rootDseHandler: $rootDseHandler,
         );
     }
 
@@ -93,12 +99,13 @@ private function getPagingHandler(): ServerProtocolHandlerInterface
         $pagingHandler = $this->handlerFactory->makePagingHandler();
 
         if (!$pagingHandler) {
-            return new ServerProtocolHandler\ServerPagingUnsupportedHandler();
+            return new ServerProtocolHandler\ServerPagingUnsupportedHandler($this->queue);
         }
 
         return new ServerProtocolHandler\ServerPagingHandler(
-            $pagingHandler,
-            $this->requestHistory
+            queue: $this->queue,
+            pagingHandler: $pagingHandler,
+            requestHistory: $this->requestHistory,
         );
     }
 }
diff --git a/src/FreeDSx/Ldap/Protocol/ServerProtocolHandler.php b/src/FreeDSx/Ldap/Protocol/ServerProtocolHandler.php
@@ -53,7 +53,7 @@ public function __construct(
         private readonly ?LoggerInterface $logger,
         private readonly ServerProtocolHandlerFactory $protocolHandlerFactory,
         private readonly ServerAuthorization $authorizer,
-        private readonly ServerBindHandlerFactory $bindHandlerFactory = new ServerBindHandlerFactory(),
+        private readonly ServerBindHandlerFactory $bindHandlerFactory,
         private readonly ResponseFactory $responseFactory = new ResponseFactory()
     ) {
     }
@@ -169,8 +169,7 @@ private function dispatchRequest(LdapMessageRequest $message): void
             $handler->handleRequest(
                 $message,
                 $this->authorizer->getToken(),
-                $this->handlerFactory->makeRequestHandler(),
-                $this->queue
+                $this->handlerFactory->makeRequestHandler()
             );
         # Authentication is required, but they have not authenticated...
         } else {

diff --git a/src/FreeDSx/Ldap/Protocol/ServerProtocolHandler/BaseServerHandler.php b/src/FreeDSx/Ldap/Protocol/ServerProtocolHandler/BaseServerHandler.php
@@ -22,10 +22,7 @@
  */
 abstract class BaseServerHandler
 {
-    protected ResponseFactory $responseFactory;
-
-    public function __construct(ResponseFactory $responseFactory = null)
+    public function __construct(protected readonly ResponseFactory $responseFactory = new ResponseFactory())
     {
-        $this->responseFactory = $responseFactory ?? new ResponseFactory();
     }
 }
diff --git a/src/FreeDSx/Ldap/Protocol/ServerProtocolHandler/ServerAnonBindHandler.php b/src/FreeDSx/Ldap/Protocol/ServerProtocolHandler/ServerAnonBindHandler.php
@@ -17,6 +17,7 @@
 use FreeDSx\Ldap\Exception\OperationException;
 use FreeDSx\Ldap\Exception\RuntimeException;
 use FreeDSx\Ldap\Operation\Request\AnonBindRequest;
+use FreeDSx\Ldap\Protocol\Factory\ResponseFactory;
 use FreeDSx\Ldap\Protocol\LdapMessageRequest;
 use FreeDSx\Ldap\Protocol\Queue\ServerQueue;
 use FreeDSx\Ldap\Server\RequestHandler\RequestHandlerInterface;
@@ -30,6 +31,11 @@
  */
 class ServerAnonBindHandler extends ServerBindHandler
 {
+    public function __construct(private readonly ServerQueue $queue)
+    {
+        parent::__construct($this->queue);
+    }
+
     /**
      * {@inheritDoc}
      * @throws EncoderException
@@ -50,7 +56,7 @@ public function handleBind(
         }
 
         $this->validateVersion($request);
-        $queue->sendMessage($this->responseFactory->getStandardResponse($message));
+        $this->queue->sendMessage($this->responseFactory->getStandardResponse($message));
 
         return new AnonToken(
             $request->getUsername(),

diff --git a/src/FreeDSx/Ldap/Protocol/ServerProtocolHandler/ServerBindHandler.php b/src/FreeDSx/Ldap/Protocol/ServerProtocolHandler/ServerBindHandler.php
@@ -18,6 +18,7 @@
 use FreeDSx\Ldap\Operation\Request\BindRequest;
 use FreeDSx\Ldap\Operation\Request\SimpleBindRequest;
 use FreeDSx\Ldap\Operation\ResultCode;
+use FreeDSx\Ldap\Protocol\Factory\ResponseFactory;
 use FreeDSx\Ldap\Protocol\LdapMessageRequest;
 use FreeDSx\Ldap\Protocol\Queue\ServerQueue;
 use FreeDSx\Ldap\Server\RequestHandler\RequestHandlerInterface;
@@ -31,6 +32,11 @@
  */
 class ServerBindHandler extends BaseServerHandler implements BindHandlerInterface
 {
+    public function __construct(private readonly ServerQueue $queue)
+    {
+        parent::__construct();
+    }
+
     /**
      * {@inheritDoc}
      * @throws RuntimeException
@@ -52,7 +58,7 @@ public function handleBind(
 
         $this->validateVersion($request);
         $token = $this->simpleBind($dispatcher, $request);
-        $queue->sendMessage($this->responseFactory->getStandardResponse($message));
+        $this->queue->sendMessage($this->responseFactory->getStandardResponse($message));
 
         return $token;
     }

diff --git a/src/FreeDSx/Ldap/Protocol/ServerProtocolHandler/ServerDispatchHandler.php b/src/FreeDSx/Ldap/Protocol/ServerProtocolHandler/ServerDispatchHandler.php
@@ -17,6 +17,7 @@
 use FreeDSx\Ldap\Exception\OperationException;
 use FreeDSx\Ldap\Operation\Request;
 use FreeDSx\Ldap\Operation\ResultCode;
+use FreeDSx\Ldap\Protocol\Factory\ResponseFactory;
 use FreeDSx\Ldap\Protocol\LdapMessageRequest;
 use FreeDSx\Ldap\Protocol\Queue\ServerQueue;
 use FreeDSx\Ldap\Server\RequestContext;
@@ -30,6 +31,11 @@
  */
 class ServerDispatchHandler extends BaseServerHandler implements ServerProtocolHandlerInterface
 {
+    public function __construct(private readonly ServerQueue $queue)
+    {
+        parent::__construct();
+    }
+
     /**
      * {@inheritDoc}
      * @throws OperationException
@@ -38,8 +44,7 @@ class ServerDispatchHandler extends BaseServerHandler implements ServerProtocolH
     public function handleRequest(
         LdapMessageRequest $message,
         TokenInterface $token,
-        RequestHandlerInterface $dispatcher,
-        ServerQueue $queue
+        RequestHandlerInterface $dispatcher
     ): void {
         $context = new RequestContext($message->controls(), $token);
         $request = $message->getRequest();
@@ -63,6 +68,6 @@ public function handleRequest(
             );
         }
 
-        $queue->sendMessage($this->responseFactory->getStandardResponse($message));
+        $this->queue->sendMessage($this->responseFactory->getStandardResponse($message));
     }
 }
diff --git a/src/FreeDSx/Ldap/Protocol/ServerProtocolHandler/ServerPagingHandler.php b/src/FreeDSx/Ldap/Protocol/ServerProtocolHandler/ServerPagingHandler.php
@@ -41,20 +41,12 @@ class ServerPagingHandler implements ServerProtocolHandlerInterface
 {
     use ServerSearchTrait;
 
-    private PagingHandlerInterface $pagingHandler;
-
-    private RequestHistory $requestHistory;
-
-    private PagingRequestComparator $requestComparator;
-
     public function __construct(
-        PagingHandlerInterface $pagingHandler,
-        RequestHistory $requestHistory,
-        ?PagingRequestComparator $requestComparator = null
+        private readonly ServerQueue $queue,
+        private readonly PagingHandlerInterface $pagingHandler,
+        private readonly RequestHistory $requestHistory,
+        private readonly PagingRequestComparator $requestComparator = new PagingRequestComparator(),
     ) {
-        $this->pagingHandler = $pagingHandler;
-        $this->requestHistory = $requestHistory;
-        $this->requestComparator = $requestComparator ?? new PagingRequestComparator();
     }
 
     /**
@@ -64,8 +56,7 @@ public function __construct(
     public function handleRequest(
         LdapMessageRequest $message,
         TokenInterface $token,
-        RequestHandlerInterface $dispatcher,
-        ServerQueue $queue
+        RequestHandlerInterface $dispatcher
     ): void {
         $context = new RequestContext(
             $message->controls(),
@@ -128,7 +119,7 @@ public function handleRequest(
         $this->sendEntriesToClient(
             $searchResult,
             $message,
-            $queue,
+            $this->queue,
             ...$controls
         );
     }

diff --git a/src/FreeDSx/Ldap/Protocol/ServerProtocolHandler/ServerPagingUnsupportedHandler.php b/src/FreeDSx/Ldap/Protocol/ServerProtocolHandler/ServerPagingUnsupportedHandler.php
@@ -30,14 +30,17 @@ class ServerPagingUnsupportedHandler implements ServerProtocolHandlerInterface
 {
     use ServerSearchTrait;
 
+    public function __construct(private readonly ServerQueue $queue)
+    {
+    }
+
     /**
      * @inheritDoc
      */
     public function handleRequest(
         LdapMessageRequest $message,
         TokenInterface $token,
-        RequestHandlerInterface $dispatcher,
-        ServerQueue $queue
+        RequestHandlerInterface $dispatcher
     ): void {
         $context = new RequestContext(
             $message->controls(),
@@ -80,7 +83,7 @@ public function handleRequest(
         $this->sendEntriesToClient(
             $searchResult,
             $message,
-            $queue
+            $this->queue
         );
     }
 }
diff --git a/src/FreeDSx/Ldap/Protocol/ServerProtocolHandler/ServerProtocolHandlerInterface.php b/src/FreeDSx/Ldap/Protocol/ServerProtocolHandler/ServerProtocolHandlerInterface.php
@@ -15,7 +15,6 @@
 
 use FreeDSx\Ldap\Exception\OperationException;
 use FreeDSx\Ldap\Protocol\LdapMessageRequest;
-use FreeDSx\Ldap\Protocol\Queue\ServerQueue;
 use FreeDSx\Ldap\Server\RequestHandler\RequestHandlerInterface;
 use FreeDSx\Ldap\Server\Token\TokenInterface;
 use FreeDSx\Socket\Exception\ConnectionException;
@@ -38,6 +37,5 @@ public function handleRequest(
         LdapMessageRequest $message,
         TokenInterface $token,
         RequestHandlerInterface $dispatcher,
-        ServerQueue $queue,
     ): void;
 }
diff --git a/src/FreeDSx/Ldap/Protocol/ServerProtocolHandler/ServerRootDseHandler.php b/src/FreeDSx/Ldap/Protocol/ServerProtocolHandler/ServerRootDseHandler.php
@@ -40,6 +40,7 @@ class ServerRootDseHandler implements ServerProtocolHandlerInterface
 {
     public function __construct(
         private readonly ServerOptions $options,
+        private readonly ServerQueue $queue,
         private readonly ?RootDseHandlerInterface $rootDseHandler = null
     ) {
     }
@@ -51,8 +52,7 @@ public function __construct(
     public function handleRequest(
         LdapMessageRequest $message,
         TokenInterface $token,
-        RequestHandlerInterface $dispatcher,
-        ServerQueue $queue
+        RequestHandlerInterface $dispatcher
     ): void {
         $entry = Entry::fromArray('', [
             'namingContexts' => $this->options->getDseNamingContexts(),
@@ -93,7 +93,7 @@ public function handleRequest(
             );
         }
 
-        $queue->sendMessage(
+        $this->queue->sendMessage(
             new LdapMessageResponse(
                 $message->getMessageId(),
                 new SearchResultEntry($entry)