Provide sync session info on each entry / referral / syncIdSet handle…

…r as an optional parameter. This contains potentially needed information, such as the current cookie or the current stage / phase of the sync process.

src/FreeDSx/Ldap/Operation/Request/SyncRequest.php

@@ -10,6 +10,8 @@ class SyncRequest extends SearchRequest
 {
     private ?Closure $syncIdSetHandler = null;
 
+    private ?Closure $phaseChangeHandler = null;
+
     public function useSyncIdSetHandler(?Closure $syncIdSetHandler): self
     {
         $this->syncIdSetHandler = $syncIdSetHandler;
@@ -21,4 +23,16 @@ public function getSyncIdSetHandler(): ?Closure
     {
         return $this->syncIdSetHandler;
     }
+
+    public function usePhaseChangeHandler(?Closure $phaseChangeHandler): self
+    {
+        $this->phaseChangeHandler = $phaseChangeHandler;
+
+        return $this;
+    }
+
+    public function getPhaseChangeHandler(): ?Closure
+    {
+        return $this->phaseChangeHandler;
+    }
 }

src/FreeDSx/Ldap/Protocol/ClientProtocolHandler/ClientSyncHandler.php

@@ -99,16 +99,16 @@ private function initializeSync(LdapMessageRequest $messageTo): void
             ->getByClass(SyncRequestControl::class) ?? throw new RuntimeException(sprintf(
             'Expected a "%s", but there is none.',
             SyncRequestControl::class,
-        ));;
+        ));
 
         if ($this->isContentUpdatePoll()) {
-            $syncStage = Session::CONTENT_UPDATE;
+            $syncStage = Session::STAGE_PERSIST;
         } else {
-            $syncStage = Session::INITIAL_CONTENT;
+            $syncStage = Session::STAGE_REFRESH;
         }
 
         $this->session = new Session(
-            phase: $syncStage,
+            stage: $syncStage,
             cookie: $this->syncRequestControl->getCookie(),
         );
 
@@ -138,7 +138,8 @@ private function processSyncEntry(EntryResult $entryResult): void
 
         call_user_func(
             $this->syncEntryHandler,
-            new SyncEntryResult($entryResult)
+            new SyncEntryResult($entryResult),
+            $this->session,
         );
     }
 
@@ -150,7 +151,8 @@ private function processSyncReferral(ReferralResult $referralResult): void
 
         call_user_func(
             $this->syncReferralHandler,
-            new SyncReferralResult($referralResult)
+            new SyncReferralResult($referralResult),
+            $this->session,
         );
     }
 
@@ -161,12 +163,12 @@ private function processIntermediateResponse(LdapMessageResponse $messageFrom):
         if ($response instanceof SyncRefreshDelete) {
             $this->syncRequestControl->setCookie($response->getCookie());
             $this->session
-                ->updatePhase(Session::REFRESH)
+                ->updatePhase(Session::PHASE_DELETE)
                 ->updateCookie($response->getCookie());
         } elseif ($response instanceof SyncRefreshPresent) {
             $this->syncRequestControl->setCookie($response->getCookie());
             $this->session
-                ->updatePhase(Session::REFRESH)
+                ->updatePhase(Session::PHASE_PRESENT)
                 ->updateCookie($response->getCookie());
         } elseif ($response instanceof SyncNewCookie) {
             $this->session->updateCookie($response->getCookie());
@@ -198,4 +200,3 @@ private function isRefreshRequired(LdapMessageResponse $response): bool
         return $result->getResultCode() === ResultCode::SYNCHRONIZATION_REFRESH_REQUIRED;
     }
 }
-

src/FreeDSx/Ldap/Sync/Session.php

@@ -4,51 +4,79 @@
 
 final class Session
 {
-    public const INITIAL_CONTENT = 0;
+    public const PHASE_DELETE = 0;
 
-    public const CONTENT_UPDATE = 1;
+    public const PHASE_PRESENT = 1;
 
-    public const REFRESH_AND_PERSIST = 2;
+    public const STAGE_REFRESH = 0;
 
-    public const REFRESH = 3;
-
-    public const PERSIST = 4;
+    public const STAGE_PERSIST = 1;
 
     public function __construct(
-        private int $phase,
+        private int $stage,
         private ?string $cookie,
-    )
-    {}
+        private ?int $phase = null,
+    ) {}
+
+    /**
+     * The cookie that represents this sync session.
+     */
+    public function getCookie(): ?string
+    {
+        return $this->cookie;
+    }
 
     /**
      * The phase currently in progress for the sync session. One of:
      *
-     *   - {@see self::INITIAL_CONTENT}
-     *   - {@see self::CONTENT_UPDATE}
-     *   - {@see self::REFRESH_AND_PERSIST}
-     *   - {@see self::REFRESH}
-     *   - {@see self::PERSIST}
+     *   - {@see self::PHASE_DELETE}
+     *   - {@see self::PHASE_PRESENT}
      *
+     * May return null if neither of those phases are currently active.
      */
-    public function getPhase(): int
+    public function getPhase(): ?int
     {
         return $this->phase;
     }
 
+    public function isPhasePresent(): bool
+    {
+        return $this->phase === self::PHASE_PRESENT;
+    }
+
+    public function isPhaseDelete(): bool
+    {
+        return $this->phase === self::PHASE_DELETE;
+    }
+
+
+    public function isRefreshing(): bool
+    {
+        return $this->stage === self::STAGE_REFRESH;
+    }
+
+    public function isPersisting(): bool
+    {
+        return $this->stage === self::STAGE_PERSIST;
+    }
+
+
     /**
-     * The cookie that represents this sync session.
+     * @internal
      */
-    public function getCookie(): ?string
+    public function updatePhase(?int $phase): self
     {
-        return $this->cookie;
+        $this->phase = $phase;
+
+        return $this;
     }
 
     /**
      * @internal
      */
-    public function updatePhase(int $phase): self
+    public function updateStage(int $stage): self
     {
-        $this->phase = $phase;
+        $this->stage = $stage;
 
         return $this;
     }

src/FreeDSx/Ldap/Sync/SyncRepl.php

@@ -137,20 +137,32 @@ public function getCookie(): ?string
         return $this->cookie;
     }
 
-    public function useRefreshOnlyMode(): self
+    public function refreshOnly(): self
     {
         $this->mode = SyncRequestControl::MODE_REFRESH_ONLY;
 
         return $this;
     }
 
-    public function useRefreshAndPersistMode(): self
+    public function refreshAndPersist(): self
     {
         $this->mode = SyncRequestControl::MODE_REFRESH_AND_PERSIST;
 
         return $this;
     }
 
+    public function noTimeout(): self
+    {
+        $this->client->setOptions(
+            options: $this->client
+                ->getOptions()
+                ->setTimeoutRead(-1),
+            forceDisconnect: true,
+        );
+
+        return $this;
+    }
+
     public function sync(): void
     {
         $this->getResponseAndUpdateCookie(