docs: Cleaned up docs and added information on using cli

- chore: Cleaned up comments and plugin info

README.md

@@ -1,15 +1,25 @@
 # baikal-storage-plugin
 
+## Note
+Plugin is still a work in progress
+
 ## Install
 ```
 composer require aerex/baikal-storage-plugin
 ```
 
 ## Configuration
-Copy sample configuration to your baikal installation. Make sure that the folder is writable 
+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/baikalstorage` and follow the instructions
+
+### Manual
+Copy the `example-config.yaml` file and rename it to `config.yaml`.
 
 ## Usage
-- Add the plugin to `Core/Frameworks/Baikal/Core/Server.php` 
+- Add the plugin to the end of the  `Server.php` file located under `Core/Frameworks/Baikal/Core/Server.php`. For example
+
 ```
-$this->server->addPlugin(new \Aerex\BaikalStorage\Plugin(<path-of-config-file>))
+$this->server->addPlugin(new \Aerex\BaikalStorage\Plugin(<absolute/path/of/config.yaml)
 ```

bin/baikalstorage

@@ -0,0 +1,12 @@
+#!/usr/bin/env php
+<?php
+require __DIR__.'/../vendor/autoload.php';
+
+use Symfony\Component\Console\Application;
+use Aerex\BaikalStorage\Commands\CreateConfigFileCommand;
+
+$application = new Application();
+
+$application->add(new CreateConfigFileCommand());
+$application->setName('Baikal Storage Plugin');
+$application->run(); 

composer.json

@@ -15,9 +15,12 @@
             "url": "https://git.aerex.me/Aerex/baikal-storage-plugin"
         }
     ],
+    "bin": [
+      "bin/baikalstorage"
+    ],
     "require": {
         "php": ">=5.5",
-        "sabre/dav"     : "~4.0.2",
+        "sabre/dav"     : "~4.1.0",
         "sabre/vobject": "^4.0",
         "nesbot/carbon": "^2.0.0",
         "laminas/laminas-validator": "^2.13",
@@ -26,7 +29,8 @@
         "symfony/config": "3.4",
         "symfony/process": "^3.4",
         "monolog/monolog": "^2.0",
-        "symfony/yaml": "~3.0|~4.0"
+        "symfony/yaml": "~3.0|~4.0",
+        "symfony/console": "^3.4|^4.0|^5.0"
     },
     "require-dev": {
         "phpunit/phpunit": "^8.5.3"

config.yaml

@@ -1,7 +0,0 @@
-logger:
-  file: /home/aerex/baikal-storage-plugin.log
-  level: 'DEBUG'
-taskwarrior:
-  taskdata: /home/aerex/.task
-  taskrc: /home/aerex/.taskrc
-  project_tag_suffix: project_

example-config.yaml

@@ -0,0 +1,6 @@
+logger:
+  file: /home/user/baikal-storage-plugin.log
+  level: 'DEBUG'
+taskwarrior:
+  taskdata: /home/user/.task
+  taskrc: /home/user/.taskrc

lib/Browser.php

@@ -0,0 +1,10 @@
+<?php
+
+class Browser {
+
+  public function generateDropDown(
+
+  
+
+}
+

lib/Commands/CreateConfigFileCommand.php

@@ -0,0 +1,158 @@
+<?php
+
+namespace Aerex\BaikalStorage\Commands;
+
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Question\Question;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Style\SymfonyStyle;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Console\Question\ChoiceQuestion;
+use Monolog\Logger as Monolog;
+use Aerex\BaikalStorage\Configs\ConfigBuilder;
+
+class CreateConfigFileCommand extends Command {
+  protected $io;
+
+  protected static $defaultName = 'app:create-config';
+  protected static $CONFIG_FILE_NAME = 'config.yaml';
+  protected static $LOGGER_FILE_NAME = 'log';
+  private $configs = [];
+  private $fullFilePath;
+
+  public function addtaskwarriorConfig() {
+    $configs = [];
+    $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");
+    }
+    $configs['taskrc'] = $taskrcFilePath;
+    $filePath = $this->io->askQuestion(new Question('Where is the data location (taskdata)'));
+    $taskDataFilePath = $filePath;
+    if (!file_exists($taskDataFilePath)) {
+      throw new \RuntimeException("The task.data location $taskDataFilePath does not exist");
+    }
+    $configs['taskdata'] = $taskDataFilePath;
+    $displayName = $this->io->askQuestion(new Question('What is the displayname for the default calendar (e.g default)'));
+    $configs['default_calendar'] = isset($displayName) ? $displayName : 'default';
+    $this->configs['storages']['taskwarior'] = $configs;
+  }
+
+  protected function configure() {
+    $this
+      ->setName('create-config')
+      ->setDescription('Create baikal storage plugin configuration file');
+    }
+
+  protected function autocompleteFilePathCallback(string $input): array {
+      // Strip any characters from the last slash to the end of the string
+      // to keep only the last directory and generate suggestions for it
+      $inputPath = preg_replace('%(/|^)[^/]*$%', '$1', $input);
+      $inputPath = '' === $inputPath ? '.': $inputPath;
+
+      $foundFilesAndDirs = scandir($inputPath) ?: [];
+
+      // Excluded restricted directories
+      $restrictedDirs = ['dev', 'bin', 'boot', 'etc', 'input', 'lib',
+          'lib64', 'mnt', 'proc', 'run', 'sbin', 'sys', 'srv', 'usr', 'var'];
+      $foundSafeFileAndDirs = array_diff($foundFilesAndDirs, $restrictedDirs);
+
+      return array_map(function($dirOrFile) use ($inputPath) {
+          return $inputPath.$dirOrFile;
+      }, $foundSafeFileAndDirs);
+  }
+
+  protected function execute(InputInterface $input, OutputInterface $output) {
+    $this->io = new SymfonyStyle($input, $output);
+
+    $this->io->title('Baikal Storage Plugin Configuration Creation');
+
+    // TODO: move create config file code block to function
+    $question = new Question('Where to create `config.yaml` configuration file?');
+    $question->setAutocompleterCallback($this->autocompleteFilePathCallback);
+    $filePath = $this->io->askQuestion($question);
+
+    try {
+        $this->fullFilePath = $this->verifyAndCreateFile($filePath, CreateConfigFileCommand::$CONFIG_FILE_NAME);
+        $this->setupGeneralConfigs()
+            ->setupStorages()
+            ->saveConfigs();
+    } catch (\Exception $e) {
+        return Command::FAILURE;
+    }
+
+    $this->output->writeln("`config.yaml file created at $filePath");
+
+    return Command::SUCCESS;
+  }
+
+  protected function getStorageNames() {
+    $storageDir = __DIR__ . '/../Storages';
+    $storageFiles = scandir($storageDir);
+    $storages = array_values(array_filter($storageFiles, function($storageFile) use ($storageDir) {
+      return !preg_match('/^IStorage/', $storageFile) && !is_dir("$storageDir/$storageFile");
+    }));
+    array_walk($storages, function(&$storage) {
+      $storage = strtolower(preg_replace('/\.php/', '', $storage));
+    });
+    return $storages;
+  }
+
+  protected function verifyAndCreateFile($filePath, $fileName) {
+    if (empty($filePath)) {
+      throw new \RuntimeException('Configuration file path cannot be empty');
+    }
+
+    if (!is_dir($filePath)) {
+      throw new \RuntimeException("File path $filePath does not exist");
+    }
+
+    if ((strrpos($filePath, '/') + 1) === strlen($filePath)) {
+      $fullFilePath = substr($filePath, 0, -1) . $fileName;
+    } else {
+      $fullFilePath = $filePath . '/' . $fileName;
+    }
+
+    if (file_exists($fullFilePath)) {
+      throw new \RuntimeException("The configuration file at $this->fullFilePath already exists");
+    }
+     return $fullFilePath;
+  }
+
+  protected function setupGeneralConfigs() {
+    $this->io->section('Setting up general configurations');
+    $this->configs['general'] = [];
+    if ($this->io->confirm('Enable logging?')) {
+      $this->configs['general']['logger'] = [];
+      $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);
+      $logLevelChoiceQuestion->setErrorMessage('Log level %s is invalid');
+      $logLevel = $this->io->askQuestion($logLevelChoiceQuestion);
+      $this->configs['general']['logger']['level'] = $logLevel;
+    }
+    return $this;
+  }
+
+  protected function setupStorages() {
+    $this->configs['storages'] = [];
+    $this->io->section('Setup storage configurations');
+    $storagesMultiSelectQuestion = new ChoiceQuestion('Select the storages to add', $this->getStorageNames());
+    $storagesMultiSelectQuestion->setMultiselect(true);
+    $storagesMultiSelectQuestion->setErrorMessage('Storages %s is not supported');
+    $storages = $this->io->askQuestion($storagesMultiSelectQuestion);
+    foreach ($storages as $storage) {
+      $methodName = "add${storage}Config";
+      $storageConfigMethod = new \ReflectionMethod(CreateConfigFileCommand::class, $methodName);
+      $storageConfigMethod->invoke($this);
+    }
+    return $this;
+  }
+
+  protected function saveConfigs() {
+    $configBuilder = new ConfigBuilder($this->fullFilePath);
+    $configBuilder->saveConfigs($this->configs);
+  }
+}

lib/Configs/ConfigBuilder.php

@@ -6,7 +6,6 @@ use Symfony\Component\Config\Definition\ConfigurationInterface;
 use Symfony\Component\Config\Definition\Builder\TreeBuilder;
 use Symfony\Component\Config\Definition\Processor;
 use Symfony\Component\Yaml\Yaml;
-use Carbon\CarbonTimeZone;
 
 class ConfigBuilder implements ConfigurationInterface {
   private $configs = [];
@@ -40,13 +39,6 @@ class ConfigBuilder implements ConfigurationInterface {
                     ->end() 
                   ->end() 
                 ->end() 
-                ->scalarNode('timezone')
-                  ->defaultValue('UTC')
-                    ->validate()
-                      ->IfNotInArray(CarbonTimeZone::listIdentifiers())
-                      ->thenInvalid('Invalid timezone identifier %s')
-                    ->end() 
-                  ->end() 
                ->end() 
               ->end() 
             ->arrayNode('storages')
@@ -67,4 +59,9 @@ class ConfigBuilder implements ConfigurationInterface {
     $parseContents = Yaml::parse($contents);
     return $this->processor->processConfiguration($this, [$parseContents]);
   }
+
+  public function saveConfigs($configs) {
+    $yaml = Yaml::dump($configs, 3, 2);
+    file_put_contents($this->configFile, $yaml);
+  }
 }

lib/Configs/TaskwarriorConfig.php

@@ -11,15 +11,18 @@ class TaskwarriorConfig {
               ->children()
                 ->scalarNode('taskdata')
                   ->defaultValue('~/.task')
+                  ->info('The environment variable overrides the default and the command line, and the "data.location" configuration setting of the task data directory')
                 ->end()
                 ->scalarNode('taskrc')
                   ->defaultValue('~/.taskrc')
+                  ->info('The enivronment variable overrides the default and the command line specification of the .taskrc file')
                 ->end()
-                ->scalarNode('project_tag_suffix')
-                  ->defaultValue('project_')
+                ->scalarNode('default_calendar')
+                  ->info('The default calendar to send tasks if no task project is set. The value is the calendar\'s displayname')
                 ->end()
               ->end();
 
     return $node;
   }
 }
+

lib/Console.php

@@ -16,6 +16,7 @@ class Console extends AbstractConsole {
     if (is_array($input)) {
       return json_encode($input); 
     }
+    return $input;
   }
 
   public function execute($cmd, $args, $input = null, $envs = []) {

lib/Logger.php

@@ -20,7 +20,7 @@ class Logger {
     }
   }
 
-  private function createLoggerFile() {
+  public function createLoggerFile() {
     if (!file_exists($this->configs['file'])) {
       if (!fopen($this->configs['file'], 'w')) {
         throw new \Exception(sprintf('Could not create logger file %s', $this->configs['file']));
@@ -45,6 +45,11 @@ class Logger {
       $this->logger->notice($message);
     }
   } 
+  public function warn($message) {
+    if ($this->configs['enabled']) {
+      $this->logger->warning($message);
+    }
+  } 
 
   public function error($message) {
     if ($this->configs['enabled']) {

lib/Plugin.php

@@ -2,6 +2,8 @@
 
 namespace Aerex\BaikalStorage;
 
+use Aerex\BaikalStorage\Logger;
+use Monolog\Logger as Monolog;
 use Aerex\BaikalStorage\Storages\Taskwarrior;
 use Aerex\BaikalStorage\Configs\ConfigBuilder;
 use Aerex\BaikalStorage\Configs\TaskwarriorConfig;
@@ -31,17 +33,31 @@ class Plugin extends ServerPlugin {
      */
     protected $storageManager;
 
+    /**
+     * @var $rawconfigs 
+     */
+    protected $rawConfigs;
     
     /**
-     * Creates the Taskwarrior plugin
+     * Creates the Storage plugin
      *
      * @param CalendarProcessor $TWCalManager
      *
      */
     function __construct($configFile){
-      $configs = $this->buildConfigurations($configFile);
-      $this->storageManager = new StorageManager($configs);
-      $this->initializeStorages($configs);
+      $this->rawConfigs = $this->buildConfigurations($configFile);
+      $this->storageManager = new StorageManager($this->rawConfigs);
+      $this->initializeStorages($this->rawConfigs);
+    }
+
+    private function getDisplayName($path) {
+      // 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));
+
+      // Get displayname from collection
+      $properties = $this->server->getProperties($calendarUrl, ['{DAV:}displayname']);
+      return $properties['{DAV:}displayname'] ?? '';
     }
 
     public function buildConfigurations($configFile) {
@@ -56,7 +72,8 @@ class Plugin extends ServerPlugin {
      */
 
     public function initializeStorages($configs) {
-      $taskwarrior = new Taskwarrior(new Console(['rc.verbose=nothing', 'rc.hooks=off']),  $configs);
+        $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); 
     }
 
@@ -81,14 +98,13 @@ class Plugin extends ServerPlugin {
      */
     function getPluginName() {
 
-        return 'taskwarrior';
+        return 'baikal-storage';
 
     }
     /**
      * This method is called before any HTTP method handler.
      *
-     * This method intercepts any GET, DELETE, PUT and PROPFIND calls to
-     * filenames that are known to match the 'temporary file' regex.
+     * This method intercepts any GET, DELETE, PUT and PROPFIND. 
      *
      * @param RequestInterface  $request
      * @param ResponseInterface $response
@@ -101,11 +117,15 @@ class Plugin extends ServerPlugin {
         switch ($request->getMethod()) {
             case 'PUT':
                 $this->httpPut($request, $response);
-        }
+                break;
+            case 'POST': 
+                $this->httpPost($request, $response);
+                break;
+            case 'DELETE':
+                $this->httpDelete($request);
             return;
         }
-    
-    
+    }
 
     /**
      * This method handles the PUT method.
@@ -117,8 +137,11 @@ class Plugin extends ServerPlugin {
     function httpPut(RequestInterface $request){
       $body = $request->getBodyAsString();
       $vCal = \Sabre\VObject\Reader::read($body);
+      $displayname = $this->getDisplayName($request->getPath());
       try {
-        $this->storageManager->import($vCal);
+        if (!$this->storageManager->fromStorageSource($vCal)) {
+          $this->storageManager->import($vCal, $displayname);
+        }
       } catch(BadRequest $e){
           throw new BadRequest($e->getMessage(), null, $e);
       } catch(\Exception $e){
@@ -129,6 +152,139 @@ class Plugin extends ServerPlugin {
 
     }
 
+    /**
+     * This method handles the POST method.
+     *
+     * @param RequestInterface  $request
+     *
+     */
+    function httpPost(RequestInterface $request, ResponseInterface $response) {
+        $postVars = $request->getPostData();
+        $body = $request->getBodyAsString();
+        if (isset($postVars['baikalStorage']))  {
+          foreach ($this->storageManager->getStorages() as $storage) {
+            if ($storage::NAME == $postVars['baikalStorage'] 
+              && $postVars['baikalStorageAction'] == 'saveConfigs') {
+              $updateStorageConfigs = $storage->updateConfigs($postVars);
+              $this->rawConfigs['storages'][$postVars['baikalStorage']] = $updateStorageConfigs;
+            }
+          }
+
+        }
+        if (isset($postVars['logLevel'])) {
+          $this->rawConfigs['general']['logger']['level'] = $postVars['logLevel'];
+        }
+        if (isset($postVars['logFilePath'])) {
+          $this->rawConfigs['general']['logger']['file'] = $postVars['logFilePath'];
+        }
+
+        $this->config->saveConfigs($this->rawConfigs);
+
+        $response->setHeader('Location', $request->getUrl());
+        $response->setStatus(302);
+        $request->setBody($body);
+
+    } 
+    /**
+     * This method handles the DELETE method.
+     *
+     * @param RequestInterface  $request
+     * @param ResponseInterface  $response
+     *
+     */
+
+    public function httpDelete(RequestInterface $request) {
+      try {
+        $body = $request->getBodyAsString();
+        $path = $request->getPath();
+        $paths = explode('/', $path);
+        if (sizeof($paths) > 1) {
+          $uid = str_replace('.ics', '', $paths[sizeof($paths)-1]);
+          // Attempt to delete if we are removing an ics file
+          if ($uid != '') {
+            $this->storageManager->remove($uid);
+          }
+        }
+      } catch(BadRequest $e){
+        throw new BadRequest($e->getMessage(), null, $e);
+      } catch(\Exception $e){
+        throw new \Exception($e->getMessage(), null, $e);
+      }
+      $request->setBody($body);
+
+    }
+
+    
+
+    /**
+     * Generates the 'general' configuration section
+     * @return string
+     */
+
+    public function generateGeneralConfigSection() {
+      $configuredLogLevel = '';
+      $logFilePath = '';
+      if (isset($this->rawConfigs['general'])
+        && isset($this->rawConfigs['general']['logger']) 
+        && $this->rawConfigs['general']['logger']['enabled']) {
+        $configuredLogLevel = $this->rawConfigs['general']['logger']['level'];
+        $logFilePath = $this->rawConfigs['general']['logger']['file'];
+      }
+      $html  = '<form method="post" action="">';
+      $html .= '<section><h1>Configuration - Baikal Storage</h1>';
+      $html .= '<section><h2>general</h2>';
+      $html .= '<table class="propTable">';
+      $html .= '<tr>';
+      $html .= '<th>log level</th>';
+      $html .= '<td>The minimum log level </td>';
+      $html .=  '<td>';
+      $html .= '<select name="logLevel">';
+
+      foreach (Monolog::getLevels() as $key => $value) {
+        if ($key == $configuredLogLevel) {
+          $selected = ' selected ';
+        } else {
+          $selected = '';
+        }
+        $html .= '<option value="'. $key .'"' . $selected . '>'. $key .'</option>';
+      }
+      $html .= '</select>';
+
+      $html .= '</tr>';
+      $html .= '<tr>';
+      $html .= '<th>log file path</th>';
+      $html .= '<td>The absolute file path of the log</td>';
+      $html .= '<td><input name="logFilePath" placeholder="/opt/baikal/log" value='. $logFilePath . ' type="text" id="logFilePath"></input></td>';
+      $html .= '</tr>';
+      $html .= '<tr>';
+      $html .= '</table>';
+      $html .= '</section>';
+      return $html;
+    }
+
+    /**
+     * Returns a html to display an optional configuration page for the plugin
+     * @return array
+     */
+    public function getConfigBrowser() {
+      $html = $this->generateGeneralConfigSection();
+
+      foreach ($this->storageManager->getStorages() as $storage) {
+        $html .= '<section>';
+        $html .= '<h2>' . $storage::NAME . '</h2>';
+        $html .= '<table class="propTable">';
+        $html .= '<input type="hidden" name="baikalStorageAction" value="saveConfigs"></input>';
+        $html .= '<input type="hidden" name="baikalStorage" value="taskwarrior"></input>';
+        $html .= $storage->getConfigBrowser();
+        $html .= '</table>';
+        $html .= '</section>';
+        $html .= '<input type="submit" value="save"></input>';
+        $html .= '</form>';
+      }
+
+      return $html;
+    }
+
     /**
      * Returns a bunch of meta-data about the plugin.
      *
@@ -144,9 +300,11 @@ class Plugin extends ServerPlugin {
 
       return [
         'name'        => $this->getPluginName(),
-        'description' => 'The plugin provides synchronization between taskwarrior tasks and iCAL events',
-        'link'        => null,
+        'description' => 'The plugin provides synchronization between remote storages and iCal todo events',
+        'link'        => 'https://git.aerex.me/Aerex/baikal-storage-plugin',
+        'config'      => true
       ];
 
     }
 }
+

lib/StorageManager.php

@@ -22,6 +22,18 @@ class StorageManager {
     $this->configs = $configs; 
   }
 
+  public function fromStorageSource(Calendar $calendar) {
+    if (!isset($this->configs)) {
+      throw new \Exception('StorageManager was not initialize or configs are not defined');
+    }
+    foreach ($this->configs['storages'] as $storage => $value) {
+      if (stristr($calendar->PRODID, $storage)) {
+        return true;
+      }
+    }
+    return false;
+  }
+
   public function getStorages() {
     return $this->storages;
   } 
@@ -34,7 +46,7 @@ class StorageManager {
    $this->storages[$name] = $storage; 
   }
 
-  public function import(Calendar $calendar) {
+  public function import(Calendar $calendar, string $displayname) {
     if (!isset($this->configs)) {
       throw new \Exception('StorageManger was not initialize or configs are not defined'); 
     }
@@ -43,7 +55,21 @@ class StorageManager {
       if (!isset($storage)){
         throw new \Exception();
       }
-      $storage->save($calendar);
+      $storage->save($calendar, $displayname);
+    }
+  }
+
+  public function remove($uid) {
+    if (!isset($this->configs)) {
+      throw new \Exception('StorageManger was not initialize or configs are not defined'); 
+    }
+    foreach ($this->configs['storages'] as $key => $value) {
+      $storage = $this->storages[$key];
+      if (!isset($storage)){
+        throw new \Exception();
+      }
+      $storage->remove($uid);
     }
   }
 }
+

lib/Storages/IStorage.php

@@ -5,7 +5,10 @@ namespace Aerex\BaikalStorage\Storages;
 use Sabre\VObject\Component\VCalendar as Calendar;
 
 interface IStorage {
- public function save(Calendar $c);
+ public function save(Calendar $c, string $displayname);
+ public function remove($uid);
  public function refresh();
- public function getConfig();
+ public function getConfigBrowser();
+ public function updateConfigs($postData);
 }
+

lib/Storages/Taskwarrior.php

@@ -3,9 +3,6 @@
 namespace Aerex\BaikalStorage\Storages;
 
 use Sabre\VObject\Component\VCalendar as Calendar;
-use Aerex\BaikalStorage\Logger;
-use Carbon\Carbon;
-use Carbon\CarbonTimeZone;
 
 class Taskwarrior implements IStorage {
 
@@ -13,21 +10,51 @@ class Taskwarrior implements IStorage {
   private $tasks = [];
   private $configs;
   private $logger;
-  private $tz;
 
-  public function __construct($console, $configs) {
+  public function __construct($console, $configs, $logger) {
     $this->console = $console;
     $this->configs = $configs['storages']['taskwarrior'];
-    $this->logger = new Logger($configs, 'Taskwarrior');
-    $this->tz = new CarbonTimeZone($configs['general']['timezone']);
+    $this->logger = $logger; 
   }
 
-  public function getConfig() {
-    return $this->config;
+  public function getConfigBrowser() {
+    $html  = '<tr>';
+    $html .= '<th>taskrc</th>';
+    $html .= '<td>The enivronment variable overrides the default and the command line specification of the .taskrc file</td>';
+    $html .= '<td><input name="tw_taskrc" type="text" value="' . $this->configs['taskrc'] . '"></td>';
+    $html .= '</tr>';
+    $html .= '<tr>';
+    $html .= '<th>taskdata</th>';
+    $html .= '<td>The environment variable overrides the default and the command line, and the "data.location" configuration setting of the task data directory</td>';
+    $html .= '<td><input name="tw_taskdata" type="text" value="' . $this->configs['taskdata'] . '"></td>';
+    $html .= '</tr>';
+    $html .= '<tr>';
+    $html .= '<th>default_calendar</th>';
+    $html .= '<td>The default calendar to send tasks if no task project is set. The value is the calendar\'s displayname</td>';
+    $html .= '<td><input name="tw_default_calendar" type="text" value="' . $this->configs['default_calendar'] . '"></td>';
+    $html .= '</tr>';
+    return $html;
+  }
+
+  public function updateConfigs($postData) {
+    if (isset($postData['tw_taskrc'])) {
+      $this->configs['taskrc'] = $postData['tw_taskrc'];
+    }
+
+    if (isset($postData['tw_taskdata'])){
+      $this->configs['taskdata'] = $postData['tw_taskdata'];
+    }
+    if (isset($postData['tw_default_calendar'])){
+      $this->configs['default_calendar'] = $postData['tw_default_calendar'];
+    }
+
+    return $this->configs;
+
   }
 
   public function refresh() {
-    $output = $this->console->execute('task', ['sync'], null, 
+    $this->logger->info('Syncing taskwarrior tasks...');
+    $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);
@@ -36,10 +63,9 @@ class Taskwarrior implements IStorage {
           $this->tasks[$task['uid']] = $task;
         }
       }
-    $this->logger->info($output);
   }
 
-  public function vObjectToTask($vtodo) {
+  public function vObjectToTask($vtodo, string $displayname) {
     if (isset($this->tasks[(string)$vtodo->UID])) {
       $task = $this->tasks[(string)$vtodo->UID];
     } else {
@@ -49,24 +75,41 @@ class Taskwarrior implements IStorage {
 
     if (isset($vtodo->SUMMARY)){
       $task['description'] = (string)$vtodo->SUMMARY;
-    } else if(isset($vtodo->DESCRIPTION)) {
-      $task['description'] = (string)$vtodo->DESCRIPTION;
     } 
 
-    if (isset($vtodo->DTSTAMP)){
-      $task['entry'] = new Carbon($vtodo->DTSTAMP->getDateTime()->format(\DateTime::W3C), $this->tz);
+    if (isset($vtodo->DESCRIPTION)) {
+      $annotations = [];
+      if (isset($task['annotations'])) {
+        $annotations  = $task['annotations'];
+      }
+      $task['annotations'] = [];
+      $descriptionLines = explode('\n', $vtodo->DESCRIPTION);
+      foreach ($descriptionLines as $key => $descriptionLine) {
+          $annotationEntry = $vtodo->DTSTAMP->getDateTime()->modify("+$key second")->format(\DateTime::ISO8601);
+          foreach ($annotations as $annotation) {
+            if ($annotation['description'] == $descriptionLine) {
+              $annotationEntry = $annotation['entry'];
+              break;
+            }
+          }
+          array_push($annotations, ['description' => $descriptionLine, 'entry' => $annotationEntry]);
+          $task['annotations'] = $annotations;
+      }
+    }
+    if (!isset($task['entry'])){
+      $task['entry'] = $vtodo->DTSTAMP->getDateTime()->format(\DateTime::ISO8601);
     } 
 
     if (isset($vtodo->DTSTART)) {
-      $task['start'] = new Carbon($vtodo->DTSTART->getDateTime()->format(\DateTime::W3C), $this->tz);
+      $task['start'] = $vtodo->DTSTART->getDateTime()->format(\DateTime::ISO8601);
     }
 
     if (isset($vtodo->DTEND)){
-      $task['end'] = new Carbon($vtodo->DTEND->getDateTime()->format(\DateTime::W3C), $this->tz);
+      $task['end'] = $vtodo->DTEND->getDateTime()->format(\DateTime::ISO8601);
     }
 
     if (isset($vtodo->{'LAST-MODIFIED'})) {
-      $task['modified'] = new Carbon($vtodo->{'LAST-MODIFIED'}->getDateTime()->format(\DateTime::W3C), $this->tz);
+      $task['modified'] = $vtodo->{'LAST-MODIFIED'}->getDateTime()->format(\DateTime::ISO8601);
     }
 
     if (isset($vtodo->PRIORITY)) {
@@ -81,7 +124,9 @@ class Taskwarrior implements IStorage {
     }
 
     if (isset($vtodo->DUE)) {
-      $task['due'] = new Carbon($vtodo->DUE->getDateTime()); 
+      $task['due'] = $vtodo->DUE->getDateTime()->format(\DateTime::ISO8601);
+    } else if (isset($task['due'])) {
+      $task['due'] = '';
     }
 
     if (isset($vtodo->RRULE)) {
@@ -102,53 +147,84 @@ class Taskwarrior implements IStorage {
         case 'COMPLETED':
           $task['status'] = 'completed';
           if (!isset($task['end'])) {
-            $task['end'] = new Carbon($vtodo->DTSTAMP->getDateTime()->format(\DateTime::W3C), $this->tz);
+            $task['end'] = $vtodo->DTSTAMP->getDateTime()->format(\DateTime::ISO8601);
           }
           break;
         case 'CANCELED':
           $task['status'] = 'deleted';
           if (!isset($task['end'])) {
-            $task['end'] = new Carbon($vtodo->DTSTAMP->getDateTime()->format(\DateTime::W3C), $this->tz);
+            $task['end'] = $vtodo->DTSTAMP->getDateTime()->format(\DateTime::ISO8601);
           }
           break;
       }
     }
 
     if (isset($vtodo->CATEGORIES)) {
-      $task['tags'] = [];
-        foreach ($vtodo->CATEGORIES as $category) {
-          if (isset($this->configs['project_tag_suffix'])) {
-            $projTagSuffixRegExp = sprintf('/^%s/', $this->configs['project_tag_suffix']);
-            if (preg_match($projTagSuffixRegExp, $category)) {
-              $task['project'] = preg_replace($projTagSuffixRegExp, '', $category);
-              continue;
+      $task['tags'] = $vtodo->CATEGORIES->getJsonValue();
       }
+
+    if (isset($vtodo->GEO)){
+      $task['geo'] = $vtodo->GEO->getRawMimeDirValue();
     }
-          $task['tags'] = $category;
-        }
+
+    if ($this->configs['default_calendar'] != $displayname) {
+      $task['project'] = $displayname;
     }
 
       return $task;
   }
 
-  public function save(Calendar $c) {
+  public function save(Calendar $c, string $displayname) {
     try {
       if (!isset($c->VTODO)){
         throw new \Exception('Calendar event does not contain VTODO');
       }
       $this->logger->info(json_encode($c->jsonSerialize()));
       $this->refresh();
-      $task = $this->vObjectToTask($c->VTODO);
+      $task = $this->vObjectToTask($c->VTODO, $displayname);
       $this->logger->info(json_encode($task));
       $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, 
         ['TASKRC' => $this->configs['taskrc'],'TASKDATA' => $this->configs['taskdata']]);
+      $this->refresh();
       $this->logger->info($output);
     } catch (\Exception $e) {
       $this->logger->error($e->getTraceAsString());
       throw $e;
     }
   }
+
+  public function remove($uid) {
+    try {
+      $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)); 
+        return;
+      }
+      $task = $this->tasks[(string)$uid];
+      if (isset($task) && $task['status'] !== 'deleted') {
+        $uuid = $task['uuid'];
+        $this->logger->info(
+          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, 
+          ['TASKRC' => $this->configs['taskrc'],'TASKDATA' => $this->configs['taskdata']]);
+        $this->logger->info($output);
+        $this->refresh();
+      } else if (isset($task) && $task['status'] === 'deleted') {
+        $this->logger->warn(sprintf('Task %s has already been deleted', $task['uuid']));
+      } else {
+        $this->logger->error(sprintf('Could not find task for iCal %s to be deleted', $uid));
+      }
+
+    } catch (\Exception $e) {
+      $this->logger->error($e->getMessage());
+      $this->logger->error($e->getTraceAsString());
+      throw $e;
+    }
+
+  }
 }

phpunit.xml.dist

@@ -8,8 +8,8 @@
   beStrictAboutTestsThatDoNotTestAnything="true">
 
 
-<testsuite name="Baikal Storage Plug Tests">
-  <directory>./lib/tests/</directory>
+<testsuite name="Baikal Storage Plugin Tests">
+  <directory>./tests/</directory>
 </testsuite>
 
 <filter>

tests/Configs/ConfigTest.php

@@ -26,8 +26,6 @@ class ConfigTest extends TestCase {
     $this->assertEquals($generalConfigs['logger']['level'], 'ERROR', 'ERROR is not set as default logger level');
     $this->assertArrayHasKey('enabled', $generalConfigs['logger'], 'general config logger enabled property is missing');
     $this->assertTrue($generalConfigs['logger']['enabled']);
-    $this->assertArrayHasKey('timezone', $generalConfigs, 'general config is missing timezone property');
-    $this->assertEquals($generalConfigs['timezone'], 'UTC', 'UTC is not set as default timezone');
   }
 
   public function testTaskwarriorConfig() {
@@ -42,8 +40,6 @@ class ConfigTest extends TestCase {
     $this->assertEquals($taskwarriorConfigs['taskrc'], '/home/aerex/.taskrc');
     $this->assertArrayHasKey('taskdata', $taskwarriorConfigs, 'taskwarrior config is missing taskdata property');
     $this->assertEquals($taskwarriorConfigs['taskdata'], '/home/aerex/.task');
-    $this->assertArrayHasKey('project_tag_suffix', $taskwarriorConfigs, 'taskwarrior config is missing project_tag_suffix property');
-    $this->assertEquals($taskwarriorConfigs['project_tag_suffix'], 'project_');
   }
 }
 

tests/Configs/Fixtures/TaskwarriorConfig.yaml

@@ -2,9 +2,7 @@ general:
   logger:
     file: /home/aerex/baikal-storage-plugin.log
     level: DEBUG
-  timezone: 'America/Denver'
 storages:
   taskwarrior:
     taskdata: /home/aerex/.task
     taskrc: /home/aerex/.taskrc
-    project_tag_suffix: project_

tests/StorageManagerTest.php

@@ -6,7 +6,7 @@ use PHPUnit\Framework\TestCase;
 use Aerex\BaikalStorage\AbstractConsole;
 use Aerex\BaikalStorage\Configs\ConfigBuilder;
 use Aerex\BaikalStorage\Storages\Taskwarrior;
-use Aerex\BaikalStorage\Storages\IStorage;
+use Aerex\BaikalStorage\Logger;
 use Sabre\VObject\Component\VCalendar as Calendar;
 
 class StorageManagerTest extends TestCase {
@@ -27,15 +27,23 @@ class StorageManagerTest extends TestCase {
         ->getMock();
     $this->mockConsole = $this->createMock(AbstractConsole::class);
     $this->mockStorage = $this->createMock(Taskwarrior::class);
+    $this->mockLogger = $this->createMock(Logger::class);
+    $this->configs = [
+      'general' => [
+        'logger' => ['file' => '', 'level'=>  'DEBUG', 'enabled' => true]
+      ], 
+      'storages' => [
+        'taskwarrior' => ['taskrc' => '', 'taskdata' => '']
+      ]
+    ];
 }
 
 public function testAddTaskwarriorStorage() {
-    $configs = ['taskwarrior' => ['taskrc' => '', 'taskdata' => '']];
-    $tw = new Taskwarrior($this->mockConsole, $configs);
+    $tw = new Taskwarrior($this->mockConsole, $this->configs, $this->mockLogger);
     $manager = new StorageManager($this->mockConfigBuilder);
     $manager->addStorage(Taskwarrior::NAME, $tw);
     $storages = $manager->getStorages();
-    $configs = $manager->getConfigs();
+    $this->configs = $manager->getConfigs();
     $this->assertEquals(sizeof(array_keys($storages)), 1, 'Taskwarrior storage was not added');
     $this->assertArrayHasKey('taskwarrior', $storages, 'Storages should have taskwarrior');
   }
@@ -46,8 +54,7 @@ class StorageManagerTest extends TestCase {
       ->method('save')
         ->with($this->equalTo($cal));
 
-    $configs = ['taskwarrior' => ['taskrc' => '', 'taskdata' => '']];
-    $manager = new StorageManager($configs);
+    $manager = new StorageManager($this->configs);
     $manager->addStorage(Taskwarrior::NAME, $this->mockStorage);
     $manager->import($cal);
 

tests/Storages/TaskwarriorTest.php

@@ -4,6 +4,7 @@ namespace Aerex\BaikalStorage;
 
 use PHPUnit\Framework\TestCase;
 use Aerex\BaikalStorage\AbstractConsole;
+use Aerex\BaikalStorage\Logger;
 use Sabre\VObject\Component\VCalendar as Calendar;
 use Aerex\BaikalStorage\Storages\Taskwarrior;
 
@@ -16,11 +17,19 @@ class TaskwarriorTest extends TestCase {
 
   protected function setUp(): void {
     $this->mockConsole = $this->createMock(AbstractConsole::class);
+    $this->mockLogger = $this->createMock(Logger::class);
   }
 
   public function testVObjectToTask() {
-    $configs = ['taskwarrior' => ['taskrc' => '', 'taskdata' => ''], 'logger' => ['file' => '', 'level'=>  'DEBUG', 'enabled' => true]];
-    $this->taskwarrior = new Taskwarrior($this->mockConsole, $configs);
+    $configs = [
+      'general' => [
+        'logger' => ['file' => '', 'level'=>  'DEBUG', 'enabled' => true],
+      ], 
+      'storages' => [
+        'taskwarrior' => ['taskrc' => '', 'taskdata' => '']
+      ]
+    ];
+    $this->taskwarrior = new Taskwarrior($this->mockConsole, $configs, $this->mockLogger);
     $vcalendar = new Calendar([
       'VTODO' => [
         'SUMMARY' => 'Finish project',
@@ -40,11 +49,47 @@ class TaskwarriorTest extends TestCase {
    $this->assertArrayHasKey('description', $task, 'task should have description');
    $this->assertEquals((string)$vcalendar->VTODO->SUMMARY, $task['description']);
    $this->assertArrayHasKey('due', $task, 'task should have due');
-   $this->assertEquals($vcalendar->VTODO->DUE->getDateTime(), $task['due']);
+   $this->assertEquals($vcalendar->VTODO->DUE->getDateTime()->format(\DateTime::ISO8601), $task['due']);
    $this->assertArrayHasKey('entry', $task, 'task should have an entry');
-   $this->assertEquals($vcalendar->VTODO->DTSTAMP->getDateTime(), $task['entry']);
+   $this->assertEquals($vcalendar->VTODO->DTSTAMP->getDateTime()->format(\DateTime::ISO8601), $task['entry']);
    $this->assertArrayHasKey('start', $task, 'task should have start');
-   $this->assertEquals($vcalendar->VTODO->DTSTART->getDateTime(), $task['start']);
+   $this->assertEquals($vcalendar->VTODO->DTSTART->getDateTime()->format(\DateTime::ISO8601), $task['start']);
   }
+//  public function testVObjectToTaskWithDifferentTimezone() {
+//    $configs = [
+//      'general' => [
+//        'logger' => ['file' => '', 'level'=>  'DEBUG', 'enabled' => true],
+//      ], 
+//      'storages' => [
+//        'taskwarrior' => ['taskrc' => '', 'taskdata' => '']
+//      ]
+//    ];
+//    $this->taskwarrior = new Taskwarrior($this->mockConsole, $configs, $this->mockLogger);
+//    $vcalendar = new Calendar([
+//      'VTODO' => [
+//        'SUMMARY' => 'Finish project',
+//        'DTSTAMP' => new \DateTime('2020-07-04 10:00:00'),
+//        'DTSTART' => new \DateTime('2020-07-04 12:00:00'),
+//        'DTEND' => new \DateTime('2020-07-05 01:00:00'),
+//        'DUE'   => new \DateTime('2020-07-05 03:00:00'),
+//        'LAST_MODIFIED' => new \DateTime('2020-07-04 13:00:00'),
+//        'PRIORITY' => 5,
+//        'RRULE' => 'FREQ=MONTHLY'
+//      ]
+//    ]);
+//
+//   $task = $this->taskwarrior->vObjectToTask($vcalendar->VTODO);
+//   $this->assertArrayHasKey('uid', $task, 'task should have a uid');
+//   $this->assertEquals((string)$vcalendar->VTODO->UID, $task['uid']);
+//   $this->assertArrayHasKey('description', $task, 'task should have description');
+//   $this->assertEquals((string)$vcalendar->VTODO->SUMMARY, $task['description']);
+//   $this->assertArrayHasKey('due', $task, 'task should have due');
+//   $this->assertEquals($vcalendar->VTODO->DUE->getDateTime(), $task['due']);
+//   $this->assertArrayHasKey('entry', $task, 'task should have an entry');
+//   $this->assertEquals($vcalendar->VTODO->DTSTAMP->getDateTime(), $task['entry']);
+//   $this->assertArrayHasKey('start', $task, 'task should have start');
+//   $this->assertEquals($vcalendar->VTODO->DTSTART->getDateTime(), $task['start']);
+//
+//  }
 
 }