vendor/jackalope/jackalope/src/Jackalope/Repository.php line 155

  1. <?php
  3. namespace Jackalope;
  5. use Jackalope\Transaction\UserTransaction;
  6. use ReflectionClass;
  7. use Jackalope\Transport\TransportInterface;
  8. use Jackalope\Transport\TransactionInterface;
  9. use PHPCR\CredentialsInterface;
  10. use PHPCR\RepositoryException;
  11. use PHPCR\RepositoryInterface;
  13. /**
  14.  * {@inheritDoc}
  15.  *
  16.  * @license http://www.apache.org/licenses Apache License Version 2.0, January 2004
  17.  * @license http://opensource.org/licenses/MIT MIT License
  18.  *
  19.  * @api
  20.  */
  21. class Repository implements RepositoryInterface
  22. {
  23.     /**
  24.      * The descriptor key for the version of the specification that this repository implements.
  25.      * For JCR 2.0 the value of this descriptor is the string "2.0".
  26.      *
  27.      * @api
  28.      */
  29.     const JACKALOPE_OPTION_STREAM_WRAPPER = 'jackalope.option.stream_wrapper';
  31.     protected $jackalopeNotImplemented = [
  32.         // https://github.com/jackalope/jackalope/issues/217
  33.         'jackalope.not_implemented.node.definition' => true,
  35.         // https://github.com/jackalope/jackalope/issues/218
  36.         'jackalope.not_implemented.node.set_primary_type' => true,
  38.         // https://github.com/jackalope/jackalope/issues/219
  39.         'jackalope.not_implemented.node.can_add_mixin' => true,
  41.         // https://github.com/jackalope/jackalope/issues/220
  42.         'jackalope.not_implemented.node_type.unregister' => true,
  44.         // https://github.com/jackalope/jackalope/issues/221
  45.         'jackalope.not_implemented.session.impersonate' => true,
  47.         // https://github.com/jackalope/jackalope/issues/222
  48.         'jackalope.not_implemented.session.set_namespace_prefix' => true,
  50.         // https://github.com/jackalope/jackalope/issues/54
  51.         'jackalope.not_implemented.version.version_labels' => true,
  53.         // https://github.com/jackalope/jackalope/issues/55
  54.         'jackalope.not_implemented.version.merge' => true,
  56.         // https://github.com/jackalope/jackalope/issues/224
  57.         'jackalope.not_implemented.version.configuration' => true,
  59.         // https://github.com/jackalope/jackalope/issues/223
  60.         'jackalope.not_implemented.version.activity' => true,
  62.         // https://github.com/jackalope/jackalope/issues/67
  63.         'jackalope.not_implemented.lock_token' => true,
  65.         // https://github.com/jackalope/jackalope/issues/67
  66.         'jackalope.not_implemented.get_lock' => true,
  68.         // https://github.com/jackalope/jackalope/issues/67
  69.         'jackalope.not_implemented.non_session_scoped_lock' => true,
  70.     ];
  72.     /**
  73.      * flag to call stream_wrapper_register only once
  74.      */
  75.     protected static $binaryStreamWrapperRegistered;
  77.     /**
  78.      * The factory to instantiate objects
  79.      *
  80.      * @var FactoryInterface
  81.      */
  82.     protected $factory;
  84.     /**
  85.      * The transport to use
  86.      *
  87.      * @var TransportInterface
  88.      */
  89.     protected $transport;
  91.     /**
  92.      * List of supported options
  93.      *
  94.      * @var array
  95.      */
  96.     protected $options = [
  97.         // this is OPTION_TRANSACTIONS_SUPPORTED
  98.         'transactions' => true,
  99.         // this is JACKALOPE_OPTION_STREAM_WRAPPER
  100.         'stream_wrapper' => true,
  101.         Session::OPTION_AUTO_LASTMODIFIED => true,
  102.     ];
  104.     /**
  105.      * Cached array of repository descriptors. Each is either a string or an
  106.      * array of strings.
  107.      *
  108.      * @var array
  109.      */
  110.     protected $descriptors;
  112.     /**
  113.      * Create repository with the option to overwrite the factory and bound to
  114.      * a transport.
  115.      *
  116.      * Use RepositoryFactoryDoctrineDBAL or RepositoryFactoryJackrabbit to
  117.      * instantiate this class.
  118.      *
  119.      * @param FactoryInterface $factory the object factory to use. If this is
  120.      *      null, the Jackalope\Factory is instantiated. Note that the
  121.      *      repository is the only class accepting null as factory.
  122.      * @param TransportInterface $transport transport implementation
  123.      * @param array              $options   defines optional features to enable/disable (see
  124.      *      $options property)
  125.      */
  126.     public function __construct(FactoryInterface $factory = null, TransportInterface $transport, array $options = null)
  127.     {
  128.         $this->factory = null === $factory ? new Factory() : $factory;
  129.         $this->transport = $transport;
  130.         $this->options = array_merge($this->options, (array) $options);
  131.         $this->options['transactions'] = $this->options['transactions'] && $transport instanceof TransactionInterface;
  132.         // register a stream wrapper to lazily load binary property values
  133.         if (null === self::$binaryStreamWrapperRegistered) {
  134.             self::$binaryStreamWrapperRegistered = $this->options['stream_wrapper'];
  135.             if (self::$binaryStreamWrapperRegistered) {
  136.                 stream_wrapper_register('jackalope', BinaryStreamWrapper::class);
  137.             }
  138.         }
  139.     }
  141.     /**
  142.      * {@inheritDoc}
  143.      *
  144.      * @throws \InvalidArgumentException
  145.      *
  146.      * @api
  147.      */
  148.     public function login(CredentialsInterface $credentials = null, $workspaceName = null)
  149.     {
  150.         if (! $workspaceName = $this->transport->login($credentials, $workspaceName)) {
  151.             throw new RepositoryException('Transport failed to login without telling why');
  152.         }
  154.         /** @var $session Session */
  155.         $session = $this->factory->get(Session::class, [$this, $workspaceName, $credentials, $this->transport]);
  156.         $session->setSessionOption(Session::OPTION_AUTO_LASTMODIFIED, $this->options[Session::OPTION_AUTO_LASTMODIFIED]);
  157.         if ($this->options['transactions']) {
  158.             $utx = $this->factory->get(UserTransaction::class, [$this->transport, $session, $session->getObjectManager()]);
  159.             $session->getWorkspace()->setTransactionManager($utx);
  160.         }
  162.         return $session;
  163.     }
  165.     /**
  166.      * {@inheritDoc}
  167.      *
  168.      * @api
  169.      */
  170.     public function getDescriptorKeys()
  171.     {
  172.         if (null === $this->descriptors) {
  173.             $this->loadDescriptors();
  174.         }
  176.         return array_keys($this->descriptors);
  177.     }
  179.     /**
  180.      * {@inheritDoc}
  181.      *
  182.      * @api
  183.      */
  184.     public function isStandardDescriptor($key)
  185.     {
  186.         $ref = new ReflectionClass(RepositoryInterface::class);
  187.         $consts = $ref->getConstants();
  189.         return in_array($key, $consts);
  190.     }
  192.     /**
  193.      * {@inheritDoc}
  194.      *
  195.      * @api
  196.      */
  197.     public function getDescriptor($key)
  198.     {
  199.         // handle some of the keys locally
  200.         switch ($key) {
  201.             case self::JACKALOPE_OPTION_STREAM_WRAPPER:
  202.                 return $this->options['stream_wrapper'];
  203.             case self::OPTION_TRANSACTIONS_SUPPORTED:
  204.                 return $this->options['transactions'];
  205.             case self::OPTION_LIFECYCLE_SUPPORTED:
  206.             case self::OPTION_SHAREABLE_NODES_SUPPORTED:
  207.             case self::OPTION_RETENTION_SUPPORTED:
  208.             case self::OPTION_ACCESS_CONTROL_SUPPORTED:
  209.                 return false;
  210.         }
  212.         if (null === $this->descriptors) {
  213.             $this->loadDescriptors();
  214.         }
  216.         return (isset($this->descriptors[$key])) ?  $this->descriptors[$key] : null;
  217.     }
  219.     /**
  220.      * Load the descriptors into $this->descriptors
  221.      *
  222.      * Most of them come from the transport to allow for non-feature complete
  223.      * transports.
  224.      *
  225.      * @throws RepositoryException
  226.      */
  227.     protected function loadDescriptors()
  228.     {
  229.         $this->descriptors = array_merge(
  230.             $this->jackalopeNotImplemented,
  231.             $this->transport->getRepositoryDescriptors()
  232.         );
  233.     }
  234. }