Compare commits
No commits in common. "master" and "0.0.1" have entirely different histories.
1
.gitignore
vendored
1
.gitignore
vendored
@ -1,4 +1,3 @@
|
||||
vendor/
|
||||
main.uml
|
||||
composer.lock
|
||||
.phpunit.result.cache
|
||||
|
||||
25
README.md
25
README.md
@ -1,25 +0,0 @@
|
||||
# baikal-storage-plugin
|
||||
|
||||
## Note
|
||||
Plugin is still a work in progress
|
||||
|
||||
## Install
|
||||
```
|
||||
composer require aerex/baikal-storage-plugin
|
||||
```
|
||||
|
||||
## Configuration
|
||||
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 the end of the `Server.php` file located under `Core/Frameworks/Baikal/Core/Server.php`. For example
|
||||
|
||||
```
|
||||
$this->server->addPlugin(new \Aerex\BaikalStorage\Plugin(<absolute/path/of/config.yaml)
|
||||
```
|
||||
@ -1,12 +0,0 @@
|
||||
#!/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();
|
||||
@ -15,25 +15,20 @@
|
||||
"url": "https://git.aerex.me/Aerex/baikal-storage-plugin"
|
||||
}
|
||||
],
|
||||
"bin": [
|
||||
"bin/baikalstorage"
|
||||
],
|
||||
"require": {
|
||||
"php": ">=5.5",
|
||||
"sabre/dav" : "~4.1.0",
|
||||
"sabre/dav" : "~4.0.2",
|
||||
"sabre/vobject": "^4.0",
|
||||
"easycorp/easy-log-handler": "^1.0",
|
||||
"nesbot/carbon": "^2.0.0",
|
||||
"laminas/laminas-validator": "^2.13",
|
||||
"laminas/laminas-stdlib": "^3.2",
|
||||
"psr/container": "^1.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"
|
||||
"symfony/config": "^5.0",
|
||||
"symfony/process": "^3.4"
|
||||
},
|
||||
"require-dev": {
|
||||
"phpunit/phpunit": "^8.5.3"
|
||||
"phpunit/phpunit": "^7.4"
|
||||
},
|
||||
"authors": [
|
||||
{
|
||||
|
||||
@ -1,6 +0,0 @@
|
||||
logger:
|
||||
file: /home/user/baikal-storage-plugin.log
|
||||
level: 'DEBUG'
|
||||
taskwarrior:
|
||||
taskdata: /home/user/.task
|
||||
taskrc: /home/user/.taskrc
|
||||
@ -1,10 +0,0 @@
|
||||
<?php
|
||||
|
||||
class Browser {
|
||||
|
||||
public function generateDropDown(
|
||||
|
||||
|
||||
|
||||
}
|
||||
|
||||
@ -1,158 +0,0 @@
|
||||
<?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);
|
||||
}
|
||||
}
|
||||
@ -11,7 +11,7 @@ class ConfigBuilder implements ConfigurationInterface {
|
||||
private $configs = [];
|
||||
private $configFile;
|
||||
|
||||
public function __construct($configFile) {
|
||||
public function __construct($configFile = '~/.config/baikal') {
|
||||
$this->configFile = $configFile;
|
||||
$this->processor = new Processor();
|
||||
}
|
||||
@ -21,28 +21,9 @@ class ConfigBuilder implements ConfigurationInterface {
|
||||
}
|
||||
|
||||
public function getConfigTreeBuilder() {
|
||||
$treeBuilder = new TreeBuilder();
|
||||
$rootNode = $treeBuilder->root('configs');
|
||||
$ref = $rootNode->children()
|
||||
->arrayNode('general')
|
||||
->children()
|
||||
->arrayNode('logger')
|
||||
->canBeEnabled()
|
||||
->children()
|
||||
->scalarNode('file')->end()
|
||||
->scalarNode('level')
|
||||
->defaultValue('ERROR')
|
||||
->validate()
|
||||
->IfNotInArray(['DEBUG', 'INFO', 'NOTICE', 'WARNING', 'ERROR', 'CRITICAL', 'ALERT', 'EMERGENCY'])
|
||||
->thenInvalid('Invalid log level %s')
|
||||
->end()
|
||||
->end()
|
||||
->end()
|
||||
->end()
|
||||
->end()
|
||||
->end()
|
||||
->arrayNode('storages')
|
||||
->children();
|
||||
$treeBuilder = new TreeBuilder('configs');
|
||||
$rootNode = $treeBuilder->getRootNode();
|
||||
$ref = $rootNode->children();
|
||||
foreach ($this->configs as $config) {
|
||||
$ref = $ref->append($config->get());
|
||||
}
|
||||
@ -51,7 +32,11 @@ class ConfigBuilder implements ConfigurationInterface {
|
||||
}
|
||||
|
||||
public function readContent() {
|
||||
return file_get_contents($this->configFile);
|
||||
if (!is_dir($this->configFile)) {
|
||||
mkdir($this->configFile);
|
||||
}
|
||||
$contents = sprintf('%s/storage.yml', $this->configFile);
|
||||
return file_get_contents($contents);
|
||||
}
|
||||
|
||||
public function loadYaml() {
|
||||
@ -59,9 +44,4 @@ 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);
|
||||
}
|
||||
}
|
||||
|
||||
@ -2,27 +2,16 @@
|
||||
|
||||
namespace Aerex\BaikalStorage\Configs;
|
||||
|
||||
use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
|
||||
use Symfony\Component\Config\Definition\Builder\TreeBuilder;
|
||||
|
||||
class TaskwarriorConfig {
|
||||
public function get() {
|
||||
$node = new ArrayNodeDefinition('taskwarrior');
|
||||
$node->canBeEnabled()
|
||||
->children()
|
||||
->scalarNode('taskdata')
|
||||
$treeBuilder = new TreeBuilder('taskwarrior');
|
||||
$node = $treeBuilder->getRootNode();
|
||||
$node->children()
|
||||
->scalarNode('data_dir')
|
||||
->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('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;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@ -16,23 +16,22 @@ class Console extends AbstractConsole {
|
||||
if (is_array($input)) {
|
||||
return json_encode($input);
|
||||
}
|
||||
return $input;
|
||||
}
|
||||
|
||||
public function execute($cmd, $args, $input = null, $envs = []) {
|
||||
public function execute($cmd, $args, $input = null) {
|
||||
$stdin[] = $cmd;
|
||||
$stdin = array_merge($stdin, $this->defaultArgs, $args);
|
||||
$stdin[] = array_merge($stdin, $this->defaultArgs, $args);
|
||||
|
||||
if (isset($input)) {
|
||||
$input = $this->convertToString($input);
|
||||
$stdin[] = $this->convertToString($input);
|
||||
$process = new Process($stdin);
|
||||
}
|
||||
$process = new Process(implode(' ', $stdin), null, $envs, $input);
|
||||
$process->inheritEnvironmentVariables();
|
||||
|
||||
try {
|
||||
$process->mustRun();
|
||||
return $process->getOutput();
|
||||
} catch (ProcessFailedException $error) {
|
||||
echo $error->getMessage();
|
||||
throw $error;
|
||||
}
|
||||
}
|
||||
|
||||
@ -1,77 +0,0 @@
|
||||
<?php
|
||||
|
||||
namespace Aerex\BaikalStorage;
|
||||
use Monolog\Logger as Monolog;
|
||||
use Monolog\Handler\StreamHandler;
|
||||
|
||||
class Logger {
|
||||
|
||||
private $configs = ['enabled' => false];
|
||||
|
||||
function __construct($configs, $tag) {
|
||||
if (isset($configs['general']) && isset($configs['general']['logger'])) {
|
||||
$this->configs = $configs['general']['logger'];
|
||||
}
|
||||
if ($this->configs['enabled']) {
|
||||
$this->createLoggerFile();
|
||||
$this->logger = new Monolog($tag);
|
||||
$logLevel = Monolog::getLevels()[$this->configs['level']];
|
||||
$this->logger->pushHandler(new StreamHandler($this->configs['file'], $logLevel));
|
||||
}
|
||||
}
|
||||
|
||||
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']));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
public function debug($message) {
|
||||
if ($this->configs['enabled']) {
|
||||
$this->logger->debug($message);
|
||||
}
|
||||
}
|
||||
|
||||
public function info($message) {
|
||||
if ($this->configs['enabled']) {
|
||||
$this->logger->info($message);
|
||||
}
|
||||
}
|
||||
|
||||
public function notice($message) {
|
||||
if ($this->configs['enabled']) {
|
||||
$this->logger->notice($message);
|
||||
}
|
||||
}
|
||||
public function warn($message) {
|
||||
if ($this->configs['enabled']) {
|
||||
$this->logger->warning($message);
|
||||
}
|
||||
}
|
||||
|
||||
public function error($message) {
|
||||
if ($this->configs['enabled']) {
|
||||
$this->logger->error($message);
|
||||
}
|
||||
}
|
||||
|
||||
public function critical($message) {
|
||||
if ($this->configs['enabled']) {
|
||||
$this->logger->critical($message);
|
||||
}
|
||||
}
|
||||
public function alert($message) {
|
||||
if ($this->configs['enabled']) {
|
||||
$this->logger->alert($message);
|
||||
}
|
||||
}
|
||||
|
||||
public function emergency($message) {
|
||||
if ($this->configs['enabled']) {
|
||||
$this->logger->emergency($message);
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
200
lib/Plugin.php
200
lib/Plugin.php
@ -2,8 +2,6 @@
|
||||
|
||||
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;
|
||||
@ -34,36 +32,25 @@ class Plugin extends ServerPlugin {
|
||||
protected $storageManager;
|
||||
|
||||
/**
|
||||
* @var $rawconfigs
|
||||
* @var ConfigBuilder
|
||||
*/
|
||||
protected $rawConfigs;
|
||||
|
||||
protected $config;
|
||||
|
||||
/**
|
||||
* Creates the Storage plugin
|
||||
* Creates the Taskwarrior plugin
|
||||
*
|
||||
* @param CalendarProcessor $TWCalManager
|
||||
*
|
||||
*/
|
||||
function __construct($configFile){
|
||||
$this->rawConfigs = $this->buildConfigurations($configFile);
|
||||
$this->storageManager = new StorageManager($this->rawConfigs);
|
||||
$this->initializeStorages($this->rawConfigs);
|
||||
function __construct($config = null){
|
||||
if (isset($config)) {
|
||||
$this->config = $config;
|
||||
} else {
|
||||
$this->config = new ConfigBuilder();
|
||||
}
|
||||
|
||||
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());
|
||||
return $this->config->loadYaml();
|
||||
$this->storageManager = new StorageManager($this->config);
|
||||
$this->addStorages();
|
||||
}
|
||||
|
||||
/**
|
||||
@ -71,10 +58,10 @@ 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'));
|
||||
public function addStorages() {
|
||||
$taskwarrior = new Taskwarrior(new Console(['rc.verbose=nothing', 'rc.hooks=off']), new TaskwarriorConfig());
|
||||
$this->storageManager->addStorage(Taskwarrior::NAME, $taskwarrior);
|
||||
$this->storageManager->init();
|
||||
}
|
||||
|
||||
/**
|
||||
@ -98,13 +85,14 @@ class Plugin extends ServerPlugin {
|
||||
*/
|
||||
function getPluginName() {
|
||||
|
||||
return 'baikal-storage';
|
||||
return 'taskwarrior';
|
||||
|
||||
}
|
||||
/**
|
||||
* 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 calls to
|
||||
* filenames that are known to match the 'temporary file' regex.
|
||||
*
|
||||
* @param RequestInterface $request
|
||||
* @param ResponseInterface $response
|
||||
@ -117,15 +105,11 @@ 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.
|
||||
@ -137,11 +121,8 @@ class Plugin extends ServerPlugin {
|
||||
function httpPut(RequestInterface $request){
|
||||
$body = $request->getBodyAsString();
|
||||
$vCal = \Sabre\VObject\Reader::read($body);
|
||||
$displayname = $this->getDisplayName($request->getPath());
|
||||
try {
|
||||
if (!$this->storageManager->fromStorageSource($vCal)) {
|
||||
$this->storageManager->import($vCal, $displayname);
|
||||
}
|
||||
$this->storageManager->import($vCal);
|
||||
} catch(BadRequest $e){
|
||||
throw new BadRequest($e->getMessage(), null, $e);
|
||||
} catch(\Exception $e){
|
||||
@ -152,139 +133,6 @@ 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.
|
||||
*
|
||||
@ -300,11 +148,9 @@ class Plugin extends ServerPlugin {
|
||||
|
||||
return [
|
||||
'name' => $this->getPluginName(),
|
||||
'description' => 'The plugin provides synchronization between remote storages and iCal todo events',
|
||||
'link' => 'https://git.aerex.me/Aerex/baikal-storage-plugin',
|
||||
'config' => true
|
||||
'description' => 'The plugin provides synchronization between taskwarrior tasks and iCAL events',
|
||||
'link' => null,
|
||||
];
|
||||
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@ -3,6 +3,7 @@
|
||||
namespace Aerex\BaikalStorage;
|
||||
|
||||
use Sabre\VObject\Component\VCalendar as Calendar;
|
||||
use Aerex\BaikalStorage\Configs\ConfigBuilder;
|
||||
|
||||
class StorageManager {
|
||||
|
||||
@ -14,24 +15,13 @@ class StorageManager {
|
||||
|
||||
|
||||
/**
|
||||
* @var array()
|
||||
* @var Config
|
||||
*/
|
||||
private $configBuilder;
|
||||
private $configs;
|
||||
|
||||
public function __construct($configs){
|
||||
$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 __construct($configBuilder){
|
||||
$this->configBuilder = $configBuilder;
|
||||
}
|
||||
|
||||
public function getStorages() {
|
||||
@ -43,33 +33,25 @@ class StorageManager {
|
||||
}
|
||||
|
||||
public function addStorage($name, $storage) {
|
||||
$this->configBuilder->add($storage->getConfig());
|
||||
$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');
|
||||
}
|
||||
foreach ($this->configs['storages'] as $key => $value) {
|
||||
$storage = $this->storages[$key];
|
||||
if (!isset($storage)){
|
||||
throw new \Exception();
|
||||
}
|
||||
$storage->save($calendar, $displayname);
|
||||
}
|
||||
public function init() {
|
||||
$this->configs = $this->configBuilder->loadYaml();
|
||||
}
|
||||
|
||||
public function remove($uid) {
|
||||
public function import(Calendar $calendar) {
|
||||
if (!isset($this->configs)) {
|
||||
throw new \Exception('StorageManger was not initialize or configs are not defined');
|
||||
}
|
||||
foreach ($this->configs['storages'] as $key => $value) {
|
||||
foreach ($this->configs as $key => $value) {
|
||||
$storage = $this->storages[$key];
|
||||
if (!isset($storage)){
|
||||
throw new \Exception();
|
||||
}
|
||||
$storage->remove($uid);
|
||||
$storage->setRawConfigs($this->configs[$key]);
|
||||
$storage->save($calendar);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@ -5,10 +5,8 @@ namespace Aerex\BaikalStorage\Storages;
|
||||
use Sabre\VObject\Component\VCalendar as Calendar;
|
||||
|
||||
interface IStorage {
|
||||
public function save(Calendar $c, string $displayname);
|
||||
public function remove($uid);
|
||||
public function save(Calendar $c);
|
||||
public function refresh();
|
||||
public function getConfigBrowser();
|
||||
public function updateConfigs($postData);
|
||||
public function getConfig();
|
||||
public function setRawConfigs();
|
||||
}
|
||||
|
||||
|
||||
@ -3,228 +3,87 @@
|
||||
namespace Aerex\BaikalStorage\Storages;
|
||||
|
||||
use Sabre\VObject\Component\VCalendar as Calendar;
|
||||
use Carbon\Carbon;
|
||||
|
||||
class Taskwarrior implements IStorage {
|
||||
|
||||
private const DATA_FILES = ['pending.data', 'completed.data', 'undo.data'];
|
||||
private $rawConfigs;
|
||||
public const NAME = 'taskwarrior';
|
||||
private $tasks = [];
|
||||
private $configs;
|
||||
private $logger;
|
||||
|
||||
public function __construct($console, $configs, $logger) {
|
||||
public function __construct($console, $config) {
|
||||
$this->console = $console;
|
||||
$this->configs = $configs['storages']['taskwarrior'];
|
||||
$this->logger = $logger;
|
||||
$this->config = $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 getConfig() {
|
||||
return $this->config;
|
||||
}
|
||||
|
||||
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 setRawConfigs($rawConfigs) {
|
||||
$this->rawConfigs = $rawConfigs;
|
||||
}
|
||||
|
||||
public function refresh() {
|
||||
$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);
|
||||
foreach ($this->tasks as $task) {
|
||||
if (isset($task['uid'])) {
|
||||
$this->tasks[$task['uid']] = $task;
|
||||
$dataDir = $this->rawConfigs['data_dir'];
|
||||
$fp = fopen(sprintf('%s/taskwarrior-baikal-storage.lock', $dataDir), 'a');
|
||||
|
||||
if (!$fp || !flock($fp, LOCK_EX | LOCK_NB, $eWouldBlock) || $eWouldBlock) {
|
||||
fputs(STDERR, 'Could not get lock');
|
||||
}
|
||||
|
||||
$mtime = 0;
|
||||
$tasksUpdated = false;
|
||||
foreach (Taskwarrior::DATA_FILES as $dataFile) {
|
||||
$fmtime = filemtime(sprintf('%s/%s', $this->config['data_dir'], $dataFile));
|
||||
if ($fmtime > $mtime) {
|
||||
$mtime = $fmtime;
|
||||
$tasksUpdated = true;
|
||||
}
|
||||
}
|
||||
|
||||
public function vObjectToTask($vtodo, string $displayname) {
|
||||
if (isset($this->tasks[(string)$vtodo->UID])) {
|
||||
$task = $this->tasks[(string)$vtodo->UID];
|
||||
if ($tasksUpdated) {
|
||||
$tasks = $this->console->execute('task', ['export']);
|
||||
foreach ($tasks as $task) {
|
||||
$this->tasks[$task['uuid']] = $task;
|
||||
}
|
||||
}
|
||||
fclose($fp);
|
||||
unlink(sprintf('%s/taskwarrior-baikal-storage.lock', $dataDir));
|
||||
}
|
||||
|
||||
public function vObjectToTask($vtodo) {
|
||||
if ($this->tasks['uid'] == $vtodo->UID) {
|
||||
$task = $this->tasks['uid'];
|
||||
} else {
|
||||
$task = [];
|
||||
$task['uid'] = (string)$vtodo->UID;
|
||||
$task['uid'] = $vtodo->UID;
|
||||
}
|
||||
|
||||
if (isset($vtodo->SUMMARY)){
|
||||
$task['description'] = (string)$vtodo->SUMMARY;
|
||||
|
||||
if (!isset($vtodo->DESCRIPTION) && isset($vtodo->SUMMARY)){
|
||||
$task['description'] = $vtodo->SUMMARY;
|
||||
} else {
|
||||
$task['description'] = $vtodo->DESCRIPTION;
|
||||
}
|
||||
|
||||
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->DTSTAMP)){
|
||||
$task['entry'] = new Carbon($vtodo->DTSTAMP->getDateTime()->format(\DateTime::W3C));
|
||||
}
|
||||
|
||||
if (isset($vtodo->DTSTART)) {
|
||||
$task['start'] = $vtodo->DTSTART->getDateTime()->format(\DateTime::ISO8601);
|
||||
}
|
||||
|
||||
if (isset($vtodo->DTEND)){
|
||||
$task['end'] = $vtodo->DTEND->getDateTime()->format(\DateTime::ISO8601);
|
||||
}
|
||||
|
||||
if (isset($vtodo->{'LAST-MODIFIED'})) {
|
||||
$task['modified'] = $vtodo->{'LAST-MODIFIED'}->getDateTime()->format(\DateTime::ISO8601);
|
||||
}
|
||||
|
||||
if (isset($vtodo->PRIORITY)) {
|
||||
$priority = $vtodo->PRIORITY->getJsonValue();
|
||||
if ($priority < 5) {
|
||||
$task['priority'] = 'H';
|
||||
} else if ($priority === 5) {
|
||||
$task['priority'] = 'M';
|
||||
} else if ($priority > 5 && $priority < 10) {
|
||||
$task['priority'] = 'L';
|
||||
}
|
||||
}
|
||||
|
||||
if (isset($vtodo->DUE)) {
|
||||
$task['due'] = $vtodo->DUE->getDateTime()->format(\DateTime::ISO8601);
|
||||
} else if (isset($task['due'])) {
|
||||
$task['due'] = '';
|
||||
}
|
||||
|
||||
if (isset($vtodo->RRULE)) {
|
||||
$rules = $vtodo->RRULE->getParts();
|
||||
if (isset($rules['FREQ'])) {
|
||||
$task['recu'] = $rules['FREQ'];
|
||||
}
|
||||
if (isset($rules['UNTIL'])) {
|
||||
$task['until'] = $rules['UNTIL'];
|
||||
}
|
||||
}
|
||||
|
||||
if (isset($vtodo->STATUS)) {
|
||||
switch((string)$vtodo->STATUS) {
|
||||
case 'NEEDS-ACTION':
|
||||
$task['status'] = 'pending';
|
||||
break;
|
||||
case 'COMPLETED':
|
||||
$task['status'] = 'completed';
|
||||
if (!isset($task['end'])) {
|
||||
$task['end'] = $vtodo->DTSTAMP->getDateTime()->format(\DateTime::ISO8601);
|
||||
}
|
||||
break;
|
||||
case 'CANCELED':
|
||||
$task['status'] = 'deleted';
|
||||
if (!isset($task['end'])) {
|
||||
$task['end'] = $vtodo->DTSTAMP->getDateTime()->format(\DateTime::ISO8601);
|
||||
}
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
if (isset($vtodo->CATEGORIES)) {
|
||||
$task['tags'] = $vtodo->CATEGORIES->getJsonValue();
|
||||
}
|
||||
|
||||
if (isset($vtodo->GEO)){
|
||||
$task['geo'] = $vtodo->GEO->getRawMimeDirValue();
|
||||
}
|
||||
|
||||
if ($this->configs['default_calendar'] != $displayname) {
|
||||
$task['project'] = $displayname;
|
||||
if (isset($vtodo->DUE)){
|
||||
$task['due'] = new Carbon($vtodo->DUE->getDateTime()->format(\DateTime::W3C));
|
||||
}
|
||||
|
||||
return $task;
|
||||
}
|
||||
|
||||
public function save(Calendar $c, string $displayname) {
|
||||
try {
|
||||
public function save(Calendar $c) {
|
||||
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, $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;
|
||||
}
|
||||
|
||||
$task = $this->vObjectToTask($c->VTODO);
|
||||
$this->console->execute('task', ['import'], $task);
|
||||
}
|
||||
}
|
||||
|
||||
@ -8,8 +8,8 @@
|
||||
beStrictAboutTestsThatDoNotTestAnything="true">
|
||||
|
||||
|
||||
<testsuite name="Baikal Storage Plugin Tests">
|
||||
<directory>./tests/</directory>
|
||||
<testsuite name="Baikal Storage Plug Tests">
|
||||
<directory>./lib/tests</directory>
|
||||
</testsuite>
|
||||
|
||||
<filter>
|
||||
|
||||
@ -1,45 +0,0 @@
|
||||
<?php
|
||||
namespace Aerex\BaikalStorage;
|
||||
|
||||
use PHPUnit\Framework\TestCase;
|
||||
use Aerex\BaikalStorage\Configs\ConfigBuilder;
|
||||
use Aerex\BaikalStorage\Configs\TaskwarriorConfig;
|
||||
|
||||
class ConfigTest extends TestCase {
|
||||
|
||||
/**
|
||||
* @var \PHPUnit_Framework_MockObject_MockObject
|
||||
* */
|
||||
|
||||
public $mockConfigBuilder;
|
||||
|
||||
public function testGeneralLoggerConfigs() {
|
||||
$configs = new ConfigBuilder(__DIR__ . '/Fixtures/LoggerConfig.yaml');
|
||||
$contents = $configs->loadYaml();
|
||||
$this->assertEquals(sizeof($contents), 1);
|
||||
$this->assertArrayHasKey('general', $contents, 'config missing general config');
|
||||
$generalConfigs = $contents['general'];
|
||||
$this->assertArrayHasKey('logger', $generalConfigs, 'general config is missing logger property');
|
||||
$this->assertArrayHasKey('file', $generalConfigs['logger'], 'general logger config missing file property');
|
||||
$this->assertEquals($generalConfigs['logger']['file'], '/home/user/logger.yaml');
|
||||
$this->assertArrayHasKey('level', $generalConfigs['logger'], 'general logger config missing level property');
|
||||
$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']);
|
||||
}
|
||||
|
||||
public function testTaskwarriorConfig() {
|
||||
$configs = new ConfigBuilder(__DIR__ . '/Fixtures/TaskwarriorConfig.yaml');
|
||||
$configs->add(new TaskwarriorConfig());
|
||||
$contents = $configs->loadYaml();
|
||||
$this->assertEquals(sizeof($contents), 2);
|
||||
$this->assertArrayHasKey('storages', $contents, 'storages config missing');
|
||||
$this->assertArrayHasKey('taskwarrior', $contents['storages'], 'storage config missing taskwarrior property');
|
||||
$taskwarriorConfigs = $contents['storages']['taskwarrior'];
|
||||
$this->assertArrayHasKey('taskrc', $taskwarriorConfigs, 'taskwarrior config is missing taskrc property');
|
||||
$this->assertEquals($taskwarriorConfigs['taskrc'], '/home/aerex/.taskrc');
|
||||
$this->assertArrayHasKey('taskdata', $taskwarriorConfigs, 'taskwarrior config is missing taskdata property');
|
||||
$this->assertEquals($taskwarriorConfigs['taskdata'], '/home/aerex/.task');
|
||||
}
|
||||
}
|
||||
|
||||
@ -1,3 +0,0 @@
|
||||
general:
|
||||
logger:
|
||||
file: /home/user/logger.yaml
|
||||
@ -1,8 +0,0 @@
|
||||
general:
|
||||
logger:
|
||||
file: /home/aerex/baikal-storage-plugin.log
|
||||
level: DEBUG
|
||||
storages:
|
||||
taskwarrior:
|
||||
taskdata: /home/aerex/.task
|
||||
taskrc: /home/aerex/.taskrc
|
||||
2
tests/Fixtures/taskwarrior_config.yml
Normal file
2
tests/Fixtures/taskwarrior_config.yml
Normal file
@ -0,0 +1,2 @@
|
||||
taskwarrior:
|
||||
data_dir: '~/task'
|
||||
@ -5,8 +5,9 @@ namespace Aerex\BaikalStorage;
|
||||
use PHPUnit\Framework\TestCase;
|
||||
use Aerex\BaikalStorage\AbstractConsole;
|
||||
use Aerex\BaikalStorage\Configs\ConfigBuilder;
|
||||
use Aerex\BaikalStorage\Configs\TaskwarriorConfig;
|
||||
use Aerex\BaikalStorage\Storages\Taskwarrior;
|
||||
use Aerex\BaikalStorage\Logger;
|
||||
use Aerex\BaikalStorage\Storages\IStorage;
|
||||
use Sabre\VObject\Component\VCalendar as Calendar;
|
||||
|
||||
class StorageManagerTest extends TestCase {
|
||||
@ -20,42 +21,50 @@ class StorageManagerTest extends TestCase {
|
||||
|
||||
public $mockConfigBuilder;
|
||||
|
||||
protected function setUp(): void {
|
||||
function setUp() {
|
||||
$this->mockConfigBuilder = $this->getMockBuilder(ConfigBuilder::class)
|
||||
->setMethods(['readContent'])
|
||||
->setConstructorArgs([''])
|
||||
->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' => '']
|
||||
]
|
||||
];
|
||||
}
|
||||
$this->mockStorage = $this->createMock(IStorage::class);
|
||||
}
|
||||
|
||||
public function testAddTaskwarriorStorage() {
|
||||
$tw = new Taskwarrior($this->mockConsole, $this->configs, $this->mockLogger);
|
||||
public function testAddTaskwarriorStorage() {
|
||||
$this->mockConfigBuilder->expects($this->once())
|
||||
->method('readContent')
|
||||
->willReturn(file_get_contents(__DIR__ . '/Fixtures/taskwarrior_config.yml'));
|
||||
$tw = new Taskwarrior($this->mockConsole, new TaskwarriorConfig());
|
||||
$manager = new StorageManager($this->mockConfigBuilder);
|
||||
$manager->addStorage(Taskwarrior::NAME, $tw);
|
||||
$storages = $manager->getStorages();
|
||||
$this->configs = $manager->getConfigs();
|
||||
$manager->init();
|
||||
$configs = $manager->getConfigs();
|
||||
$this->assertEquals(sizeof(array_keys($storages)), 1, 'Taskwarrior storage was not added');
|
||||
$this->assertEquals(sizeof(array_keys($configs)), 1, 'Taskwarrior config was not loaded');
|
||||
$this->assertArrayHasKey('taskwarrior', $storages, 'Storages should have taskwarrior');
|
||||
$this->assertArrayHasKey('taskwarrior', $configs, 'Configs should have taskwarrior');
|
||||
}
|
||||
|
||||
public function testTaskwarriorImport() {
|
||||
$cal = new Calendar();
|
||||
$this->mockConfigBuilder->expects($this->once())
|
||||
->method('readContent')
|
||||
->willReturn(file_get_contents(__DIR__ . '/Fixtures/taskwarrior_config.yml'));
|
||||
$this->mockStorage->expects($this->once())
|
||||
->method('save')
|
||||
->with($this->equalTo($cal));
|
||||
$this->mockStorage->expects($this->once())
|
||||
->method('setRawConfigs')
|
||||
->with($this->equalTo(['data_dir' => '~/.task']));
|
||||
$this->mockStorage->expects($this->once())
|
||||
->method('getConfig')
|
||||
->willReturn(new TaskwarriorConfig());
|
||||
|
||||
$manager = new StorageManager($this->configs);
|
||||
$manager = new StorageManager($this->mockConfigBuilder);
|
||||
$manager->addStorage(Taskwarrior::NAME, $this->mockStorage);
|
||||
$manager->init();
|
||||
|
||||
$manager->import($cal);
|
||||
|
||||
}
|
||||
|
||||
@ -1,95 +0,0 @@
|
||||
<?php
|
||||
|
||||
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;
|
||||
|
||||
class TaskwarriorTest extends TestCase {
|
||||
|
||||
/**
|
||||
* @var \PHPUnit_Framework_MockObject_MockObject
|
||||
* */
|
||||
private $mockConsole;
|
||||
|
||||
protected function setUp(): void {
|
||||
$this->mockConsole = $this->createMock(AbstractConsole::class);
|
||||
$this->mockLogger = $this->createMock(Logger::class);
|
||||
}
|
||||
|
||||
public function testVObjectToTask() {
|
||||
$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()->format(\DateTime::ISO8601), $task['due']);
|
||||
$this->assertArrayHasKey('entry', $task, 'task should have an 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()->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']);
|
||||
//
|
||||
// }
|
||||
|
||||
}
|
||||
Loading…
Reference in New Issue
Block a user