Merge pull request #22 from nanbando/feature/optional-global-config

Changed requirement of global configuration to optional

README.md

@@ -27,6 +27,7 @@ wget http://nanbando.github.io/core/nanbando.phar.pubkey
 chmod +x nanbando.phar
 mv nanbando.phar /usr/local/bin/nanbando
 mv nanbando.phar.pubkey /usr/local/bin/nanbando.pubkey
+nanbando check
 ```
 
 After first installation you can update the application with a built-in command.

docs/configuration.rst

@@ -1,7 +1,12 @@
 Configuration
 =============
 
-The configuration is devided into two parts - global and project configuration.
+The configuration is devided into two parts - global (optional) and project configuration.
+
+.. warning::
+
+ After changing configuration please run command ``reconfigure`` to be sure that the configuration will be used for
+ recreating the symfony container.
 
 Global Configuration
 --------------------
@@ -13,7 +18,7 @@ Put this configuration into ``~/.nanbando.yml``.
 
  nanbando:
  storage:
- local_directory: "%home%/nanbando/local"
+ local_directory: "%home%/nanbando"
  remote_service: filesystem.remote
 
  oneup_flysystem:
@@ -36,6 +41,10 @@ Put this configuration into ``~/.nanbando.yml``.
 For nanbando you have to define the local directory, where the backup command can place the backup archives, and the
 remote filesystem-service which can be configured in the ``oneup_flysystem`` extension.
 
+By default the ``local_directory`` will be set to ``%home%/nanbando`` and the ``remote_service`` will be ``null``. This
+leads to local backups will work out of the box but all commands (``fetch``, ``push``) which needs the remote-storage
+will be disabled.
+
 Local Configuration
 -------------------
 

docs/installation.rst

@@ -20,3 +20,5 @@ After first installation you can update the application with a built-in command.
 .. note::
 
  The executable is signed with a OpenSSL private key. This ensures the origin of the build.
+
+Check the configuration state of your application by using the command ``nanbando check``.

src/Bundle/Command/CheckCommand.php

@@ -0,0 +1,114 @@
+<?php
+
+namespace Nanbando\Bundle\Command;
+
+use Nanbando\Core\Plugin\PluginRegistry;
+use Symfony\Bundle\FrameworkBundle\Command\ContainerAwareCommand;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Console\Style\SymfonyStyle;
+use Symfony\Component\OptionsResolver\Exception\InvalidArgumentException;
+use Symfony\Component\OptionsResolver\OptionsResolver;
+
+class CheckCommand extends ContainerAwareCommand
+{
+ /**
+ * {@inheritdoc}
+ */
+ protected function configure()
+ {
+ $this
+ ->setName('check')
+ ->setDescription('Checks configuration issues')
+ ->setHelp(
+ <<<EOT
+The <info>{$this->getName()}</info> command looks for configuration issues
+
+EOT
+ );
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ protected function execute(InputInterface $input, OutputInterface $output)
+ {
+ $io = new SymfonyStyle($input, $output);
+
+ $io->title('Configuration Check Report');
+
+ $io->writeln('Local directory: ' . $this->getContainer()->getParameter('nanbando.storage.local_directory'));
+
+ if (!$this->getContainer()->has('filesystem.remote')) {
+ $io->warning(
+ 'No remote storage configuration found. This leads into disabled "fetch" and "push" commands.' .
+ 'Please follow the documentation for global configuration.' . PHP_EOL . PHP_EOL .
+ 'http://nanbando.readthedocs.io/en/latest/configuration.html#global-configuration'
+ );
+ } else {
+ $io->writeln('Remote Storage: YES');
+ }
+
+ $backups = $this->getContainer()->getParameter('nanbando.backup');
+ if (0 === count($backups)) {
+ $io->warning(
+ 'No backup configuration found. Please follow the documentation for local configuration.' . PHP_EOL . PHP_EOL .
+ 'http://nanbando.readthedocs.io/en/latest/configuration.html#local-configuration'
+ );
+ }
+
+ $this->checkBackups($io, $backups);
+
+ $io->writeln('');
+ }
+
+ /**
+ * Check backup-configuration.
+ *
+ * @param SymfonyStyle $io
+ * @param array $backups
+ */
+ private function checkBackups(SymfonyStyle $io, array $backups)
+ {
+ /** @var PluginRegistry $plugins */
+ $plugins = $this->getContainer()->get('plugins');
+ foreach ($backups as $name => $backup) {
+ $this->checkBackup($plugins, $io, $name, $backup);
+ }
+ }
+
+ /**
+ * Check single backup-configuration.
+ *
+ * @param PluginRegistry $plugins
+ * @param SymfonyStyle $io
+ * @param string $name
+ * @param array $backup
+ *
+ * @return bool
+ */
+ private function checkBackup(PluginRegistry $plugins, SymfonyStyle $io, $name, array $backup)
+ {
+ $io->section('Backup: ' . $name);
+ if (!$plugins->has($backup['plugin'])) {
+ $io->warning(sprintf('Plugin "%s" not found', $backup['plugin']));
+
+ return false;
+ }
+
+ $optionsResolver = new OptionsResolver();
+ $plugins->getPlugin($backup['plugin'])->configureOptionsResolver($optionsResolver);
+
+ try {
+ $optionsResolver->resolve($backup['parameter']);
+ } catch (InvalidArgumentException $e) {
+ $io->warning(sprintf('Parameter not valid' . PHP_EOL . PHP_EOL . 'Message: "%s"', $e->getMessage()));
+
+ return false;
+ }
+
+ $io->writeln('OK');
+
+ return true;
+ }
+}

src/Bundle/Command/FetchCommand.php

@@ -75,4 +75,12 @@ protected function execute(InputInterface $input, OutputInterface $output)
  $storage->fetch($file);
  }
  }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function isEnabled()
+ {
+ return $this->getContainer()->has('filesystem.remote');
+ }
 }

src/Bundle/Command/PushCommand.php

@@ -37,4 +37,12 @@ protected function execute(InputInterface $input, OutputInterface $output)
  $storage->push($file);
  }
  }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function isEnabled()
+ {
+ return $this->getContainer()->has('filesystem.remote');
+ }
 }

src/Bundle/DependencyInjection/Configuration.php

@@ -4,6 +4,7 @@
 
 use Symfony\Component\Config\Definition\Builder\TreeBuilder;
 use Symfony\Component\Config\Definition\ConfigurationInterface;
+use Webmozart\PathUtil\Path;
 
 class Configuration implements ConfigurationInterface
 {
@@ -31,8 +32,11 @@ public function getConfigTreeBuilder()
  ->end()
  ->end()
  ->arrayNode('storage')
+ ->addDefaultsIfNotSet()
  ->children()
- ->scalarNode('local_directory')->end()
+ ->scalarNode('local_directory')
+ ->defaultValue(Path::join([Path::getHomeDirectory(), 'nanbando']))
+ ->end()
  ->scalarNode('remote_service')->end()
  ->end()
  ->end()

src/Bundle/DependencyInjection/NanbandoExtension.php

@@ -24,7 +24,12 @@ public function load(array $configs, ContainerBuilder $container)
  $container->setParameter('nanbando.temp', $config['temp']);
  $container->setParameter('nanbando.backup', $config['backup']);
  $container->setParameter('nanbando.storage.local_directory', $config['storage']['local_directory']);
- $container->setParameter('nanbando.storage.remote_service', $config['storage']['remote_service']);
+
+ if (array_key_exists('remote_service', $config['storage'])
+ && $config['storage']['remote_service'] !== 'filesystem.remote'
+ ) {
+ $container->setAlias('filesystem.remote', $config['storage']['remote_service']);
+ }
 
  $container->prependExtensionConfig(
  'oneup_flysystem',

src/Bundle/Resources/config/services.xml

@@ -32,9 +32,9 @@
  <service id="storage" class="Nanbando\Core\Storage\LocalStorage">
  <argument type="string">%nanbando.name%</argument>
  <argument type="service" id="temporary_files"/>
- <argument type="service" id="filesystem.local"/>
- <argument type="service" id="filesystem.remote"/>
  <argument type="service" id="slugify"/>
+ <argument type="service" id="filesystem.local"/>
+ <argument type="service" id="filesystem.remote" on-invalid="null"/>
  </service>
 
  <!-- core service -->

src/Core/Flysystem/PrefixAdapter.php

@@ -19,7 +19,7 @@ class PrefixAdapter implements AdapterInterface
  private $adapter;
 
  /**
- * @param string  $root
+ * @param string $root
  * @param AdapterInterface $adapter
  */
  public function __construct($root, AdapterInterface $adapter)

src/Core/Storage/LocalStorage.php

@@ -39,16 +39,16 @@ class LocalStorage implements StorageInterface
  /**
  * @param string $name
  * @param TemporaryFileManager $temporaryFileManager
+ * @param SlugifyInterface $slugify
  * @param Filesystem $localFilesystem
  * @param Filesystem $remoteFilesystem
- * @param SlugifyInterface $slugify
  */
  public function __construct(
  $name,
  TemporaryFileManager $temporaryFileManager,
+ SlugifyInterface $slugify,
  Filesystem $localFilesystem,
- Filesystem $remoteFilesystem,
- SlugifyInterface $slugify
+ Filesystem $remoteFilesystem = null
  ) {
  $this->name = $name;
  $this->temporaryFileManager = $temporaryFileManager;
@@ -121,6 +121,10 @@ public function localListing()
  */
  public function remoteListing()
  {
+ if (!$this->remoteFilesystem) {
+ throw new RemoteStorageNotConfiguredException();
+ }
+
  return $this->listing($this->remoteFilesystem);
  }
 
@@ -142,6 +146,10 @@ public function size(Filesystem $filesystem)
  */
  public function fetch($file)
  {
+ if (!$this->remoteFilesystem) {
+ throw new RemoteStorageNotConfiguredException();
+ }
+
  $path = sprintf('%s/%s.zip', $this->name, $file);
 
  if (false === ($stream = $this->remoteFilesystem->readStream($path))) {
@@ -156,6 +164,10 @@ public function fetch($file)
  */
  public function push($file)
  {
+ if (!$this->remoteFilesystem) {
+ throw new RemoteStorageNotConfiguredException();
+ }
+
  $path = sprintf('%s/%s.zip', $this->name, $file);
 
  if (false === ($stream = $this->localFilesystem->readStream($path))) {

src/Core/Storage/RemoteStorageNotConfiguredException.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace Nanbando\Core\Storage;
+
+class RemoteStorageNotConfiguredException extends \Exception
+{
+ public function __construct()
+ {
+ parent::__construct('RemoteStorage was not configured.');
+ }
+}