Support for deactivating commands if they are not supported

dantleech · dantleech · commit 261c4de2d341 · 2014-03-29T10:08:22.000+01:00
diff --git a/features/repository_descriptor_list.feature b/features/repository_descriptor_list.feature
@@ -8,6 +8,6 @@ Feature: List Repository Descriptors
         And I execute the "repository:descriptor:list" command
         Then the command should not fail
         And I should see a table containing the following rows:
-            | Key                   | Value                       |
-            | jcr.repository.name   | Jackrabbit                  |
-            | jcr.repository.vendor | Apache Software Foundation  |
+            | Key                   | Value                       | Standard? |
+            | jcr.repository.name   | Jackrabbit                  | yes       |
+            | jcr.repository.vendor | Apache Software Foundation  | yes       |
diff --git a/src/PHPCR/Shell/Console/Application/ShellApplication.php b/src/PHPCR/Shell/Console/Application/ShellApplication.php
@@ -95,6 +95,8 @@
 use Jackalope\NotImplementedException;
 use Symfony\Component\Console\Formatter\OutputFormatterStyle;
 use Symfony\Component\Console\Formatter\OutputFormatter;
+use PHPCR\Shell\Console\Helper\RepositoryHelper;
+use PHPCR\Shell\Console\Command\PhpcrShellCommand;
 
 class ShellApplication extends Application
 {
@@ -136,6 +138,16 @@ public function init()
             $this->transports[$transport->getName()] = $transport;;
         }
 
+        $session = $this->getSession($this->sessionInput);
+
+        $this->getHelperSet()->set(new EditorHelper($session));
+        $this->getHelperSet()->set(new PhpcrConsoleDumperHelper());
+        $this->getHelperSet()->set(new PhpcrHelper($session));
+        $this->getHelperSet()->set(new ResultFormatterHelper());
+        $this->getHelperSet()->set(new TextHelper());
+        $this->getHelperSet()->set(new NodeHelper($session));
+        $this->getHelperSet()->set(new RepositoryHelper($session->getRepository()));
+
         // add new commands
         $this->add(new AccessControlPrivilegeListCommand());
         $this->add(new RepositoryDescriptorListCommand());
@@ -239,15 +251,6 @@ public function init()
             ->setName('workspace-purge')
         );
 
-        $this->initSession();
-
-        $this->getHelperSet()->set(new EditorHelper($this->session));
-        $this->getHelperSet()->set(new PhpcrConsoleDumperHelper());
-        $this->getHelperSet()->set(new PhpcrHelper($this->session));
-        $this->getHelperSet()->set(new ResultFormatterHelper());
-        $this->getHelperSet()->set(new TextHelper());
-        $this->getHelperSet()->set(new NodeHelper($this->session));
-
         $this->initialized = true;
     }
 
diff --git a/src/PHPCR/Shell/Console/Command/LockInfoCommand.php b/src/PHPCR/Shell/Console/Command/LockInfoCommand.php
@@ -7,8 +7,9 @@
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputOption;
+use PHPCR\RepositoryInterface;
 
-class LockInfoCommand extends Command
+class LockInfoCommand extends PhpcrShellCommand
 {
     protected function configure()
     {
@@ -22,7 +23,10 @@ protected function configure()
 This may be either of the lock on that node itself or a deep lock on a node
 above that node.
 HERE
-        );
+    );
+
+        $this->requiresDescriptor(RepositoryInterface::OPTION_LOCKING_SUPPORTED, true);
+        $this->dequiresDescriptor('jackalope.not_implemented.lock.get');
     }
 
     public function execute(InputInterface $input, OutputInterface $output)
diff --git a/src/PHPCR/Shell/Console/Command/LockLockCommand.php b/src/PHPCR/Shell/Console/Command/LockLockCommand.php
@@ -7,8 +7,9 @@
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputOption;
+use PHPCR\RepositoryInterface;
 
-class LockLockCommand extends Command
+class LockLockCommand extends PhpcrShellCommand
 {
     protected function configure()
     {
@@ -50,7 +51,8 @@ protected function configure()
 
 It is possible to lock a node even if it is checked-in.
 HERE
-        );
+    );
+        $this->requiresDescriptor(RepositoryInterface::OPTION_LOCKING_SUPPORTED, true);
     }
 
     public function execute(InputInterface $input, OutputInterface $output)
diff --git a/src/PHPCR/Shell/Console/Command/LockRefreshCommand.php b/src/PHPCR/Shell/Console/Command/LockRefreshCommand.php
@@ -7,8 +7,9 @@
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputOption;
+use PHPCR\RepositoryInterface;
 
-class LockRefreshCommand extends Command
+class LockRefreshCommand extends PhpcrShellCommand
 {
     protected function configure()
     {
@@ -23,6 +24,8 @@ protected function configure()
 has no effect.
 HERE
         );
+        $this->requiresDescriptor(RepositoryInterface::OPTION_LOCKING_SUPPORTED, true);
+        $this->dequiresDescriptor('jackalope.not_implemented.lock.refresh');
     }
 
     public function execute(InputInterface $input, OutputInterface $output)
diff --git a/src/PHPCR/Shell/Console/Command/LockTokenAddCommand.php b/src/PHPCR/Shell/Console/Command/LockTokenAddCommand.php
@@ -7,8 +7,9 @@
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputOption;
+use PHPCR\RepositoryInterface;
 
-class LockTokenAddCommand extends Command
+class LockTokenAddCommand extends PhpcrShellCommand
 {
     protected function configure()
     {
@@ -22,6 +23,8 @@ protected function configure()
 specified by that particular lock token.
 HERE
         );
+        $this->requiresDescriptor(RepositoryInterface::OPTION_LOCKING_SUPPORTED, true);
+        $this->dequiresDescriptor('jackalope.not_implemented.lock.token');
     }
 
     public function execute(InputInterface $input, OutputInterface $output)
diff --git a/src/PHPCR/Shell/Console/Command/LockTokenListCommand.php b/src/PHPCR/Shell/Console/Command/LockTokenListCommand.php
@@ -7,8 +7,9 @@
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputOption;
+use PHPCR\RepositoryInterface;
 
-class LockTokenListCommand extends Command
+class LockTokenListCommand extends PhpcrShellCommand
 {
     protected function configure()
     {
@@ -22,6 +23,8 @@ protected function configure()
 locks, since session-scoped locks do not have tokens.
 HERE
         );
+        $this->requiresDescriptor(RepositoryInterface::OPTION_LOCKING_SUPPORTED, true);
+        $this->dequiresDescriptor('jackalope.not_implemented.lock.token');
     }
 
     public function execute(InputInterface $input, OutputInterface $output)
diff --git a/src/PHPCR/Shell/Console/Command/LockTokenRemoveCommand.php b/src/PHPCR/Shell/Console/Command/LockTokenRemoveCommand.php
@@ -7,8 +7,9 @@
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputOption;
+use PHPCR\RepositoryInterface;
 
-class LockTokenRemoveCommand extends Command
+class LockTokenRemoveCommand extends PhpcrShellCommand
 {
     protected function configure()
     {
@@ -19,6 +20,8 @@ protected function configure()
 Removes the specified lock token from the current Session.
 HERE
         );
+        $this->requiresDescriptor(RepositoryInterface::OPTION_LOCKING_SUPPORTED, true);
+        $this->dequiresDescriptor('jackalope.not_implemented.lock.token');
     }
 
     public function execute(InputInterface $input, OutputInterface $output)
diff --git a/src/PHPCR/Shell/Console/Command/LockUnlockCommand.php b/src/PHPCR/Shell/Console/Command/LockUnlockCommand.php
@@ -7,8 +7,9 @@
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputOption;
+use PHPCR\RepositoryInterface;
 
-class LockUnlockCommand extends Command
+class LockUnlockCommand extends PhpcrShellCommand
 {
     protected function configure()
     {
@@ -35,6 +36,7 @@ protected function configure()
 lock-related properties will be changed despite the checked-in status).
 HERE
         );
+        $this->requiresDescriptor(RepositoryInterface::OPTION_LOCKING_SUPPORTED, true);
     }
 
     public function execute(InputInterface $input, OutputInterface $output)
diff --git a/src/PHPCR/Shell/Console/Command/NodeLifecycleFollowCommand.php b/src/PHPCR/Shell/Console/Command/NodeLifecycleFollowCommand.php
@@ -10,8 +10,9 @@
 use PHPCR\NodeType\NoSuchNodeTypeException;
 use PHPCR\Util\CND\Parser\CndParser;
 use PHPCR\NamespaceException;
+use PHPCR\RepositoryInterface;
 
-class NodeLifecycleFollowCommand extends Command
+class NodeLifecycleFollowCommand extends PhpcrShellCommand
 {
     protected function configure()
     {
@@ -30,6 +31,8 @@ protected function configure()
 need to call save.
 HERE
         );
+
+        $this->requiresDescriptor(RepositoryInterface::OPTION_LIFECYCLE_SUPPORTED, true);
     }
 
     public function execute(InputInterface $input, OutputInterface $output)
diff --git a/src/PHPCR/Shell/Console/Command/NodeLifecycleListCommand.php b/src/PHPCR/Shell/Console/Command/NodeLifecycleListCommand.php
@@ -10,8 +10,9 @@
 use PHPCR\NodeType\NoSuchNodeTypeException;
 use PHPCR\Util\CND\Parser\CndParser;
 use PHPCR\NamespaceException;
+use PHPCR\RepositoryInterface;
 
-class NodeLifecycleListCommand extends Command
+class NodeLifecycleListCommand extends PhpcrShellCommand
 {
     protected function configure()
     {
@@ -21,6 +22,8 @@ protected function configure()
 Returns the list of valid state transitions for this node.
 HERE
         );
+
+        $this->requiresDescriptor(RepositoryInterface::OPTION_LIFECYCLE_SUPPORTED, true);
     }
 
     public function execute(InputInterface $input, OutputInterface $output)
diff --git a/src/PHPCR/Shell/Console/Command/NodeSharedRemoveCommand.php b/src/PHPCR/Shell/Console/Command/NodeSharedRemoveCommand.php
@@ -11,8 +11,9 @@
 use PHPCR\Util\CND\Parser\CndParser;
 use PHPCR\NamespaceException;
 use Symfony\Component\Console\Input\InputOption;
+use PHPCR\RepositoryInterface;
 
-class NodeSharedRemoveCommand extends Command
+class NodeSharedRemoveCommand extends PhpcrShellCommand
 {
     protected function configure()
     {
@@ -27,7 +28,9 @@ protected function configure()
 
 If this node is not shared this method removes only this node.
 HERE
-        );
+    );
+
+        $this->requiresDescriptor(RepositoryInterface::OPTION_SHAREABLE_NODES_SUPPORTED, true);
     }
 
     public function execute(InputInterface $input, OutputInterface $output)
diff --git a/src/PHPCR/Shell/Console/Command/NodeSharedShowCommand.php b/src/PHPCR/Shell/Console/Command/NodeSharedShowCommand.php
@@ -11,8 +11,9 @@
 use PHPCR\Util\CND\Parser\CndParser;
 use PHPCR\NamespaceException;
 use Symfony\Component\Console\Input\InputOption;
+use PHPCR\RepositoryInterface;
 
-class NodeSharedShowCommand extends Command
+class NodeSharedShowCommand extends PhpcrShellCommand
 {
     protected function configure()
     {
@@ -27,6 +28,8 @@ protected function configure()
 If this node is not shared then only this node is shown.
 HERE
         );
+
+        $this->requiresDescriptor(RepositoryInterface::OPTION_SHAREABLE_NODES_SUPPORTED, true);
     }
 
     public function execute(InputInterface $input, OutputInterface $output)
diff --git a/src/PHPCR/Shell/Console/Command/PhpcrShellCommand.php b/src/PHPCR/Shell/Console/Command/PhpcrShellCommand.php
@@ -0,0 +1,41 @@
+<?php
+
+namespace PHPCR\Shell\Console\Command;
+
+use Symfony\Component\Console\Command\Command;
+
+class PhpcrShellCommand extends Command
+{
+    protected $descriptorRequires = array();
+    protected $descriptorDequires = array();
+
+    public function requiresDescriptor($descriptorKey, $value = null)
+    {
+        $this->descriptorRequires[$descriptorKey] = $value;
+    }
+
+    public function dequiresDescriptor($descriptorKey, $value = null)
+    {
+        $this->descriptorDequires[$descriptorKey] = $value;
+    }
+
+    public function isEnabled()
+    {
+        foreach ($this->descriptorRequires as $key => $value) {
+            $has = $this->getHelper('repository')->hasDescriptor($key, $value);
+            if (!$has) {
+                return false;
+            }
+        }
+
+        foreach ($this->descriptorDequires as $key => $value) {
+            $has = $this->getHelper('repository')->hasDescriptor($key, $value);
+
+            if ($has) {
+                return false;
+            }
+        }
+
+        return true;
+    }
+}
diff --git a/src/PHPCR/Shell/Console/Command/RepositoryDescriptorListCommand.php b/src/PHPCR/Shell/Console/Command/RepositoryDescriptorListCommand.php
@@ -26,16 +26,30 @@ public function execute(InputInterface $input, OutputInterface $output)
         $keys = $repository->getDescriptorKeys();
 
         $table = clone $this->getHelper('table');
-        $table->setHeaders(array('Key', 'Value'));
+        $table->setHeaders(array('Key', 'Value', 'Standard?'));
 
         foreach ($keys as $key) {
             $descriptor = $repository->getDescriptor($key);
+            $isStandard = $repository->isStandardDescriptor($key);
             if (is_array($descriptor)) {
-                $descriptor = implode(', ', $descriptor);
+                $descriptor = implode(', ', $this->getDescriptorValue($descriptor));
             }
-            $table->addRow(array($key, $descriptor));
+            $table->addRow(array(
+                $key,
+                $this->getDescriptorValue($descriptor),
+                $isStandard ? 'yes' : 'no',
+            ));
         }
 
         $table->render($output);
     }
+
+    private function getDescriptorValue($v)
+    {
+        if (is_bool($v)) {
+            return $v ? 'true' : 'false';
+        }
+
+        return $v;
+    }
 }
diff --git a/src/PHPCR/Shell/Console/Command/RetentionHoldAddCommand.php b/src/PHPCR/Shell/Console/Command/RetentionHoldAddCommand.php
@@ -7,8 +7,9 @@
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputOption;
+use PHPCR\RepositoryInterface;
 
-class RetentionHoldAddCommand extends Command
+class RetentionHoldAddCommand extends PhpcrShellCommand
 {
     protected function configure()
     {
@@ -26,6 +27,8 @@ protected function configure()
 specified. They are application-dependent.
 HERE
         );
+
+        $this->requiresDescriptor(RepositoryInterface::OPTION_RETENTION_SUPPORTED, true);
     }
 
     public function execute(InputInterface $input, OutputInterface $output)
diff --git a/src/PHPCR/Shell/Console/Command/RetentionHoldListCommand.php b/src/PHPCR/Shell/Console/Command/RetentionHoldListCommand.php
@@ -7,8 +7,9 @@
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputOption;
+use PHPCR\RepositoryInterface;
 
-class RetentionHoldListCommand extends Command
+class RetentionHoldListCommand extends PhpcrShellCommand
 {
     protected function configure()
     {
@@ -20,6 +21,8 @@ protected function configure()
 existing node at <info>absPath</info>.
 HERE
         );
+
+        $this->requiresDescriptor(RepositoryInterface::OPTION_RETENTION_SUPPORTED, true);
     }
 
     public function execute(InputInterface $input, OutputInterface $output)
diff --git a/src/PHPCR/Shell/Console/Command/RetentionHoldRemoveCommand.php b/src/PHPCR/Shell/Console/Command/RetentionHoldRemoveCommand.php
diff --git a/src/PHPCR/Shell/Console/Command/RetentionPolicyGetCommand.php b/src/PHPCR/Shell/Console/Command/RetentionPolicyGetCommand.php
diff --git a/src/PHPCR/Shell/Console/Command/RetentionPolicyRemoveCommand.php b/src/PHPCR/Shell/Console/Command/RetentionPolicyRemoveCommand.php
diff --git a/src/PHPCR/Shell/Console/Helper/RepositoryHelper.php b/src/PHPCR/Shell/Console/Helper/RepositoryHelper.php

Original file line number	Diff line number	Diff line change
`@@ -7,8 +7,9 @@`
`7`	`7`	`use Symfony\Component\Console\Output\OutputInterface;`
`8`	`8`	`use Symfony\Component\Console\Input\InputArgument;`
`9`	`9`	`use Symfony\Component\Console\Input\InputOption;`
	`10`	`+use PHPCR\RepositoryInterface;`
`10`	`11`
`11`		`-class LockLockCommand extends Command`
	`12`	`+class LockLockCommand extends PhpcrShellCommand`
`12`	`13`	`{`
`13`	`14`	`protected function configure()`
`14`	`15`	`{`
`@@ -50,7 +51,8 @@ protected function configure()`
`50`	`51`
`51`	`52`	`It is possible to lock a node even if it is checked-in.`
`52`	`53`	`HERE`
`53`		`- );`
	`54`	`+ );`
	`55`	`+ $this->requiresDescriptor(RepositoryInterface::OPTION_LOCKING_SUPPORTED, true);`
`54`	`56`	`}`
`55`	`57`
`56`	`58`	`public function execute(InputInterface $input, OutputInterface $output)`
Original file line number	Diff line number	Diff line change
`@@ -10,8 +10,9 @@`
`10`	`10`	`use PHPCR\NodeType\NoSuchNodeTypeException;`
`11`	`11`	`use PHPCR\Util\CND\Parser\CndParser;`
`12`	`12`	`use PHPCR\NamespaceException;`
	`13`	`+use PHPCR\RepositoryInterface;`
`13`	`14`
`14`		`-class NodeLifecycleFollowCommand extends Command`
	`15`	`+class NodeLifecycleFollowCommand extends PhpcrShellCommand`
`15`	`16`	`{`
`16`	`17`	`protected function configure()`
`17`	`18`	`{`
`@@ -30,6 +31,8 @@ protected function configure()`
`30`	`31`	`need to call save.`
`31`	`32`	`HERE`
`32`	`33`	`);`
	`34`	`+`
	`35`	`+ $this->requiresDescriptor(RepositoryInterface::OPTION_LIFECYCLE_SUPPORTED, true);`
`33`	`36`	`}`
`34`	`37`
`35`	`38`	`public function execute(InputInterface $input, OutputInterface $output)`