docs: Cleaned up docs and added information on using cli

README.md

@@ -12,7 +12,7 @@ composer require aerex/baikal-storage-plugin
 You can use the CLI to help you generate a config file or use the example configuration provided in the project. Make sure the file is *writable* by your webserver (e.g Apache, Nginx).
 
 ### Use the CLI
-Run the command `./vendor/bin/baikalstorage` and follow the instructions
+Run the command `./vendor/baikalstorage` and follow the instructions
 
 ### Manual
 Copy the `example-config.yaml` file and rename it to `config.yaml`.

composer.json

@@ -12,7 +12,7 @@
     "repositories": [
         {
             "type": "vcs",
-            "url": "https://github.com/Aerex/baikal-storage-plugin"
+            "url": "https://git.aerex.me/Aerex/baikal-storage-plugin"
         }
     ],
     "bin": [
@@ -21,13 +21,13 @@
     "require": {
         "php": ">=5.5",
         "sabre/dav"     : "~4.1.0",
-        "sabre/vobject": "^4.2.1",
+        "sabre/vobject": "^4.0",
         "nesbot/carbon": "^2.0.0",
         "laminas/laminas-validator": "^2.13",
         "laminas/laminas-stdlib": "^3.2",
         "psr/container": "^1.0",
-        "symfony/config": "3.4|^4.0|^5.0",
-        "symfony/process": "^3.4|^4.0|^5.0",
+        "symfony/config": "3.4",
+        "symfony/process": "^3.4",
         "monolog/monolog": "^2.0",
         "symfony/yaml": "~3.0|~4.0",
         "symfony/console": "^3.4|^4.0|^5.0"

lib/Commands/CreateConfigFileCommand.php

@@ -22,12 +22,7 @@ class CreateConfigFileCommand extends Command {
 
   public function addtaskwarriorConfig() {
     $configs = [];
-    $taskrcQuestion = new Question('Where is the location for the taskrc file?');
-    $self = $this;
-    $taskrcQuestion->setAutocompleterCallback(function(string $input)  use ($self) {
-      return $self->autocompleteFilePathCallback($input);
-    });
-    $filePath = $this->io->askQuestion($taskrcQuestion);
+    $filePath = $this->io->askQuestion(new Question('Where is the location for the taskrc file?'));
     $taskrcFilePath = $filePath . '/.taskrc';
     if (!file_exists($taskrcFilePath)) {
       throw new \RuntimeException("The taskrc file  at $taskrcFilePath does not exist");
@@ -75,10 +70,7 @@ class CreateConfigFileCommand extends Command {
 
     // TODO: move create config file code block to function
     $question = new Question('Where to create `config.yaml` configuration file?');
-    $self = $this;
-    $question->setAutocompleterCallback(function(string $input)  use ($self) {
-      return $self->autocompleteFilePathCallback($input);
-    });
+    $question->setAutocompleterCallback($this->autocompleteFilePathCallback);
     $filePath = $this->io->askQuestion($question);
 
     try {
@@ -133,14 +125,7 @@ class CreateConfigFileCommand extends Command {
     $this->configs['general'] = [];
     if ($this->io->confirm('Enable logging?')) {
       $this->configs['general']['logger'] = [];
-
-      $logFileQuestion = new Question('Where to create log file?');
-      $self = $this;
-      $logFileQuestion->setAutocompleterCallback(function(string $input)  use ($self) {
-        return $self->autocompleteFilePathCallback($input);
-      });
-      $logFilePath = $this->io->askQuestion($logFileQuestion);
-
+      $logFilePath = $this->io->askQuestion(new Question('Where to create log file?'));
       $this->configs['general']['logger']['file'] = $this->verifyAndCreateFile($logFilePath, CreateConfigFileCommand::$LOGGER_FILE_NAME);
 
       $logLevelChoiceQuestion = new ChoiceQuestion('Log level (defaults to ERROR)', array_keys(Monolog::getLevels()), 4);

lib/Plugin.php

@@ -14,7 +14,7 @@ use Sabre\DAV\ServerPlugin;
 use Sabre\DAV\Server;
 
 /**
- * The plugin to interact with Baikal and external storages
+ * The plugin to interact with Baikal and external storages 
  *
  */
 class Plugin extends ServerPlugin {
@@ -34,10 +34,10 @@ class Plugin extends ServerPlugin {
     protected $storageManager;
 
     /**
-     * @var $rawconfigs
+     * @var $rawconfigs 
      */
     protected $rawConfigs;
-
+    
     /**
      * Creates the Storage plugin
      *
@@ -47,12 +47,11 @@ class Plugin extends ServerPlugin {
     function __construct($configFile){
       $this->rawConfigs = $this->buildConfigurations($configFile);
       $this->storageManager = new StorageManager($this->rawConfigs);
-      $this->logger = new Logger($this->rawConfigs, 'BaikalStorage');
       $this->initializeStorages($this->rawConfigs);
     }
 
     private function getDisplayName($path) {
-      // Remove filepath
+      // Remove filepath (e.g Remove xxxx.ics from calendars/collection_name/xxxx.ics)
       $urlParts = explode('/', $path);
       $calendarUrl = implode('/', array_slice($urlParts, 0, sizeof($urlParts)-1));
 
@@ -73,9 +72,9 @@ class Plugin extends ServerPlugin {
      */
 
     public function initializeStorages($configs) {
-        $taskwarrior = new Taskwarrior(new Console(['rc.verbose=nothing',
+        $taskwarrior = new Taskwarrior(new Console(['rc.verbose=nothing', 
                 'rc.hooks=off', 'rc.confirmation=no']),  $configs, new Logger($configs, 'Taskwarrior'));
-      $this->storageManager->addStorage(Taskwarrior::NAME, $taskwarrior);
+      $this->storageManager->addStorage(Taskwarrior::NAME, $taskwarrior); 
     }
 
     /**
@@ -105,7 +104,7 @@ class Plugin extends ServerPlugin {
     /**
      * This method is called before any HTTP method handler.
      *
-     * This method intercepts any GET, DELETE, PUT and PROPFIND.
+     * This method intercepts any GET, DELETE, PUT and PROPFIND. 
      *
      * @param RequestInterface  $request
      * @param ResponseInterface $response
@@ -119,7 +118,7 @@ class Plugin extends ServerPlugin {
             case 'PUT':
                 $this->httpPut($request, $response);
                 break;
-            case 'POST':
+            case 'POST': 
                 $this->httpPost($request, $response);
                 break;
             case 'DELETE':
@@ -164,7 +163,7 @@ class Plugin extends ServerPlugin {
         $body = $request->getBodyAsString();
         if (isset($postVars['baikalStorage']))  {
           foreach ($this->storageManager->getStorages() as $storage) {
-            if ($storage::NAME == $postVars['baikalStorage']
+            if ($storage::NAME == $postVars['baikalStorage'] 
               && $postVars['baikalStorageAction'] == 'saveConfigs') {
               $updateStorageConfigs = $storage->updateConfigs($postVars);
               $this->rawConfigs['storages'][$postVars['baikalStorage']] = $updateStorageConfigs;
@@ -185,7 +184,7 @@ class Plugin extends ServerPlugin {
         $response->setStatus(302);
         $request->setBody($body);
 
-    }
+    } 
     /**
      * This method handles the DELETE method.
      *
@@ -215,7 +214,7 @@ class Plugin extends ServerPlugin {
 
     }
 
-
+    
 
     /**
      * Generates the 'general' configuration section
@@ -226,7 +225,7 @@ class Plugin extends ServerPlugin {
       $configuredLogLevel = '';
       $logFilePath = '';
       if (isset($this->rawConfigs['general'])
-        && isset($this->rawConfigs['general']['logger'])
+        && isset($this->rawConfigs['general']['logger']) 
         && $this->rawConfigs['general']['logger']['enabled']) {
         $configuredLogLevel = $this->rawConfigs['general']['logger']['level'];
         $logFilePath = $this->rawConfigs['general']['logger']['file'];
@@ -308,3 +307,4 @@ class Plugin extends ServerPlugin {
 
     }
 }
+

lib/StorageManager.php

@@ -10,8 +10,8 @@ class StorageManager {
    * @var Storage[]
    */
 
-  private $storages = [];
-
+  private $storages = []; 
+    
 
   /**
    * @var array()
@@ -19,11 +19,7 @@ class StorageManager {
   private $configs;
 
   public function __construct($configs){
-    $this->configs = $configs;
-  }
-
-  public function getStorages() {
-    return $this->storages;
+    $this->configs = $configs; 
   }
 
   public function fromStorageSource(Calendar $calendar) {
@@ -38,18 +34,21 @@ class StorageManager {
     return false;
   }
 
+  public function getStorages() {
+    return $this->storages;
+  } 
 
   public function getConfigs() {
     return $this->configs;
   }
 
   public function addStorage($name, $storage) {
-   $this->storages[$name] = $storage;
+   $this->storages[$name] = $storage; 
   }
 
   public function import(Calendar $calendar, string $displayname) {
     if (!isset($this->configs)) {
-      throw new \Exception('StorageManger was not initialize or configs are not defined');
+      throw new \Exception('StorageManger was not initialize or configs are not defined'); 
     }
     foreach ($this->configs['storages'] as $key => $value) {
       $storage = $this->storages[$key];
@@ -62,7 +61,7 @@ class StorageManager {
 
   public function remove($uid) {
     if (!isset($this->configs)) {
-      throw new \Exception('StorageManger was not initialize or configs are not defined');
+      throw new \Exception('StorageManger was not initialize or configs are not defined'); 
     }
     foreach ($this->configs['storages'] as $key => $value) {
       $storage = $this->storages[$key];
@@ -73,3 +72,4 @@ class StorageManager {
     }
   }
 }
+

lib/Storages/IStorage.php

@@ -11,3 +11,4 @@ interface IStorage {
  public function getConfigBrowser();
  public function updateConfigs($postData);
 }
+

lib/Storages/Taskwarrior.php

@@ -14,7 +14,7 @@ class Taskwarrior implements IStorage {
   public function __construct($console, $configs, $logger) {
     $this->console = $console;
     $this->configs = $configs['storages']['taskwarrior'];
-    $this->logger = $logger;
+    $this->logger = $logger; 
   }
 
   public function getConfigBrowser() {
@@ -54,7 +54,7 @@ class Taskwarrior implements IStorage {
 
   public function refresh() {
     $this->logger->info('Syncing taskwarrior tasks...');
-    $this->console->execute('task', ['sync'], null,
+    $this->console->execute('task', ['sync'], null, 
       ['TASKRC' => $this->configs['taskrc'],'TASKDATA' => $this->configs['taskdata']]);
       $this->tasks = json_decode($this->console->execute('task', ['export'], null,
         ['TASKRC' => $this->configs['taskrc'], 'TASKDATA' => $this->configs['taskdata']]), true);
@@ -75,7 +75,7 @@ class Taskwarrior implements IStorage {
 
     if (isset($vtodo->SUMMARY)){
       $task['description'] = (string)$vtodo->SUMMARY;
-    }
+    } 
 
     if (isset($vtodo->DESCRIPTION)) {
       $annotations = [];
@@ -98,7 +98,7 @@ class Taskwarrior implements IStorage {
     }
     if (!isset($task['entry'])){
       $task['entry'] = $vtodo->DTSTAMP->getDateTime()->format(\DateTime::ISO8601);
-    }
+    } 
 
     if (isset($vtodo->DTSTART)) {
       $task['start'] = $vtodo->DTSTART->getDateTime()->format(\DateTime::ISO8601);
@@ -179,7 +179,6 @@ class Taskwarrior implements IStorage {
       if (!isset($c->VTODO)){
         throw new \Exception('Calendar event does not contain VTODO');
       }
-      $this->logger->info(sprintf('Executing on calendar %s', $displayname));
       $this->logger->info(json_encode($c->jsonSerialize()));
       $this->refresh();
       $task = $this->vObjectToTask($c->VTODO, $displayname);
@@ -187,7 +186,7 @@ class Taskwarrior implements IStorage {
       $this->logger->info(
         sprintf('Executing TASKRC = %s TASKDATA = %s task import %s', $this->configs['taskrc'], $this->configs['taskdata'], json_encode($task))
       );
-      $output = $this->console->execute('task', ['import'], $task,
+      $output = $this->console->execute('task', ['import'], $task, 
         ['TASKRC' => $this->configs['taskrc'],'TASKDATA' => $this->configs['taskdata']]);
       $this->refresh();
       $this->logger->info($output);
@@ -202,17 +201,16 @@ class Taskwarrior implements IStorage {
       $this->logger->info(sprintf('Deleting iCal %s from taskwarrior', $uid));
       $this->refresh();
       if (!array_key_exists((string)$uid, $this->tasks)) {
-        $this->logger->warn(sprintf('Could not find task %s to be remove. Skipping', (string)$uid));
+        $this->logger->warn(sprintf('Could not find task %s to be remove. Skipping', (string)$uid)); 
         return;
       }
       $task = $this->tasks[(string)$uid];
       if (isset($task) && $task['status'] !== 'deleted') {
-        $this->logger->info(sprintf('Deleting iCal %s from taskwarrior', $uid));
         $uuid = $task['uuid'];
         $this->logger->info(
-          sprintf('Executing TASKRC = %s TASKDATA = %s task delete %s', $this->configs['taskrc'], $this->configs['taskdata'], $uuid)
+          sprintf('Executing TASKRC = %s TASKDATA = %s task delete %s', $this->configs['taskrc'], $this->configs['taskdata'], $uuid) 
         );
-        $output = $this->console->execute('task', ['delete', (string)$uuid], null,
+        $output = $this->console->execute('task', ['delete', (string)$uuid], null, 
           ['TASKRC' => $this->configs['taskrc'],'TASKDATA' => $this->configs['taskdata']]);
         $this->logger->info($output);
         $this->refresh();
@@ -227,5 +225,6 @@ class Taskwarrior implements IStorage {
       $this->logger->error($e->getTraceAsString());
       throw $e;
     }
+
   }
 }