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,6 +15,9 @@
             "url": "https://git.aerex.me/Aerex/baikal-storage-plugin"
         }
     ],
+    "bin": [
+      "bin/baikalstorage"
+    ],
     "require": {
         "php": ">=5.5",
         "sabre/dav"     : "~4.1.0",
@@ -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_category_prefix: 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/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/TaskwarriorConfig.php

@@ -17,12 +17,12 @@ class TaskwarriorConfig {
                   ->defaultValue('~/.taskrc')
                   ->info('The enivronment variable overrides the default and the command line specification of the .taskrc file')
                 ->end()
-                ->scalarNode('project_category_prefix')
-                  ->defaultValue('project_')
-                  ->info('The word after the given prefix for a iCal category will be used to identify a task\'s 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/Plugin.php

@@ -33,10 +33,11 @@ class Plugin extends ServerPlugin {
      */
     protected $storageManager;
 
+    /**
+     * @var $rawconfigs 
+     */
     protected $rawConfigs;
     
-
-    
     /**
      * Creates the Storage plugin
      *
@@ -49,6 +50,16 @@ class Plugin extends ServerPlugin {
       $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) {
       $this->config = new ConfigBuilder($configFile);
       $this->config->add(new TaskwarriorConfig());
@@ -61,7 +72,8 @@ class Plugin extends ServerPlugin {
      */
 
     public function initializeStorages($configs) {
-      $taskwarrior = new Taskwarrior(new Console(['rc.verbose=nothing', 'rc.hooks=off', 'rc.confirmation=no']),  $configs, new Logger($configs, 'Taskwarrior'));
+        $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); 
     }
 
@@ -115,8 +127,6 @@ class Plugin extends ServerPlugin {
         }
     }
 
-    
-
     /**
      * This method handles the PUT method.
      *
@@ -127,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){
@@ -187,7 +200,10 @@ class Plugin extends ServerPlugin {
         $paths = explode('/', $path);
         if (sizeof($paths) > 1) {
           $uid = str_replace('.ics', '', $paths[sizeof($paths)-1]);
-          $this->storageManager->remove($uid);
+          // 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);
@@ -284,10 +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,7 @@ class StorageManager {
       if (!isset($storage)){
         throw new \Exception();
       }
-      $storage->save($calendar);
+      $storage->save($calendar, $displayname);
     }
   }
 
@@ -60,3 +72,4 @@ class StorageManager {
     }
   }
 }
+

lib/Storages/IStorage.php

@@ -5,9 +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 getConfigBrowser();
  public function updateConfigs($postData);
 }
+

lib/Storages/Taskwarrior.php

@@ -18,11 +18,6 @@ class Taskwarrior implements IStorage {
   }
 
   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>taskrc</th>';
     $html .= '<td>The enivronment variable overrides the default and the command line specification of the .taskrc file</td>';
@@ -34,9 +29,9 @@ class Taskwarrior implements IStorage {
     $html .= '<td><input name="tw_taskdata" type="text" value="' . $this->configs['taskdata'] . '"></td>';
     $html .= '</tr>';
     $html .= '<tr>';
-    $html .= '<th>project_category_prefix</th>';
-    $html .= "<td>The word after the given prefix for a iCal category will be used to identify a task's project</td>";
-    $html .= '<td><input name="tw_project_category_prefix" placeholder ="project_" name="tw_project_category_prefix" type="text" value="' . $this->configs['project_category_prefix'] . '"></td>';
+    $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;
   }
@@ -49,9 +44,8 @@ class Taskwarrior implements IStorage {
     if (isset($postData['tw_taskdata'])){
       $this->configs['taskdata'] = $postData['tw_taskdata'];
     }
-
-    if (isset($postData['tw_project_category_prefix'])){
-      $this->configs['project_category_prefix'] = $postData['tw_project_category_prefix'];
+    if (isset($postData['tw_default_calendar'])){
+      $this->configs['default_calendar'] = $postData['tw_default_calendar'];
     }
 
     return $this->configs;
@@ -59,7 +53,8 @@ class Taskwarrior implements IStorage {
   }
 
   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);
@@ -68,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 {
@@ -129,8 +123,10 @@ class Taskwarrior implements IStorage {
       }
     }
 
-    if (isset($vtodo->DUE)){
+    if (isset($vtodo->DUE)) {
       $task['due'] = $vtodo->DUE->getDateTime()->format(\DateTime::ISO8601);
+    } else if (isset($task['due'])) {
+      $task['due'] = '';
     }
 
     if (isset($vtodo->RRULE)) {
@@ -164,40 +160,35 @@ class Taskwarrior implements IStorage {
     }
 
     if (isset($vtodo->CATEGORIES)) {
-      $task['tags'] = [];
-        foreach ($vtodo->CATEGORIES as $category) {
-          if (isset($this->configs['project_category_prefix'])) {
-            $projTagSuffixRegExp = sprintf('/^%s/', $this->configs['project_category_prefix']);
-            if (preg_match($projTagSuffixRegExp, $category)) {
-              $task['project'] = preg_replace($projTagSuffixRegExp, '', $category);
-              continue;
-            }
-          }
-          $task['tags'] = $category;
-        }
+      $task['tags'] = $vtodo->CATEGORIES->getJsonValue();
       }
 
     if (isset($vtodo->GEO)){
       $task['geo'] = $vtodo->GEO->getRawMimeDirValue();
     }
 
+    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());
@@ -209,6 +200,10 @@ class Taskwarrior implements IStorage {
     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'];
@@ -218,6 +213,7 @@ class Taskwarrior implements IStorage {
         $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 {

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

@@ -40,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_category_prefix', $taskwarriorConfigs, 'taskwarrior config is missing project_category_prefix property');
-    $this->assertEquals($taskwarriorConfigs['project_category_prefix'], 'project_');
   }
 }
 

tests/Configs/Fixtures/TaskwarriorConfig.yaml

@@ -6,4 +6,3 @@ storages:
   taskwarrior:
     taskdata: /home/aerex/.task
     taskrc: /home/aerex/.taskrc
-    project_category_prefix: project_