Merge pull request #150 in ZP/z-push from...

Merge pull request #150 in ZP/z-push from bugfix/ZP-641-filestatemachine-backend-storage-file to develop

* commit '5c7a4b19':
  ZP-641 Delete file only if it exists.
  ZP-641 CleanStates() has to stop after deleting one BS file.
  ZP-641 call GetState() with the "do not clean" flag, changed CleanStates() to delete exact bs files when being calles without uuid for bs type (needs better fixing in ZP-835).

(cherry picked from commit 3f1f999e)

src/lib/core/statemanager.php

@@ -300,7 +300,7 @@ class StateManager {
             return $this->statemachine->GetState($this->device->GetDeviceId(), IStateMachine::BACKENDSTORAGE, $this->uuid, $this->oldStateCounter, $this->deleteOldStates);
         }
         else {
-            return $this->statemachine->GetState($this->device->GetDeviceId(), IStateMachine::BACKENDSTORAGE, false, $this->device->GetFirstSyncTime());
+            return $this->statemachine->GetState($this->device->GetDeviceId(), IStateMachine::BACKENDSTORAGE, false, $this->device->GetFirstSyncTime(), false);
         }
     }
 

src/lib/default/filestatemachine.php

@@ -176,10 +176,16 @@ class FileStateMachine implements IStateMachine {
      * @throws StateInvalidException
      */
     public function CleanStates($devid, $type, $key, $counter = false) {
-        // Don't remove permanent backend storage files, unless we explicitily want that
-        if ($key === false && $type === IStateMachine::BACKENDSTORAGE && $counter != IStateMachine::HIGHEST_COUNTER) {
+        // Remove permanent backend storage files
+        // TODO remove this block and implement it as described in ZP-835
+        if ($key === false && $type === IStateMachine::BACKENDSTORAGE) {
+            $file = $this->getFullFilePath($devid, $type, $key, $counter);
+            if (file_exists($file)) {
+                ZLog::Write(LOGLEVEL_DEBUG, sprintf("FileStateMachine->CleanStates(): Deleting 'bs' file: '%s'", $file));
+                unlink($file);
                 return;
             }
+        }
 
         $matching_files = glob($this->getFullFilePath($devid, $type, $key). "*", GLOB_NOSORT);
         if (is_array($matching_files)) {

src/lib/interface/istatemachine.php

@@ -7,7 +7,7 @@
  *              Z-Push implements the FileStateMachine which
  *              saves states to disk.
  *              Backends provide their own IStateMachine
-                implementation of this interface and return
+ *              implementation of this interface and return
  *              an IStateMachine instance with IBackend->GetStateMachine().
  *              Old sync states are not deleted until a new sync state
  *              is requested.
@@ -60,7 +60,6 @@ interface IStateMachine {
     const FAILSAVE = "fs";
     const HIERARCHY = "hc";
     const BACKENDSTORAGE = "bs";
-    const HIGHEST_COUNTER = 99999999999;
 
     const STATEVERSION_01 = "1";    // Z-Push 2.0.x - default value if unset
     const STATEVERSION_02 = "2";    // Z-Push 2.1.0 Milestone 1

src/lib/utils/zpushadmin.php

@@ -282,7 +282,7 @@ class ZPushAdmin {
             StateManager::UnLinkState($device, false);
 
             // remove backend storage permanent data
-            ZPush::GetStateMachine()->CleanStates($device->GetDeviceId(), IStateMachine::BACKENDSTORAGE, false, IStateMachine::HIGHEST_COUNTER);
+            ZPush::GetStateMachine()->CleanStates($device->GetDeviceId(), IStateMachine::BACKENDSTORAGE, false, $device->GetFirstSyncTime());
 
             // remove devicedata and unlink user from device
             unset($devices[$user]);