Merge remote-tracking branch 'origin/master' into command-helpers

Conflicts:
	src/PHPCR/Util/Console/Command/BaseCommand.php

Author: dbu

CHANGELOG.md

@@ -0,0 +1,4 @@
+Changelog
+=========
+
+* **2013-06-15**: [Command] Added `--apply-closure` option to `phpcr:nodes:update` command.

LICENSE.txt

@@ -1,3 +1,26 @@
+phpcr-utils is dual licensed under the MIT license and the Apache License Version 2.0.
+
+    The MIT License (MIT)
+
+    Copyright (c) 2013 Liip and others
+
+    Permission is hereby granted, free of charge, to any person obtaining a copy of
+    this software and associated documentation files (the "Software"), to deal in
+    the Software without restriction, including without limitation the rights to
+    use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+    the Software, and to permit persons to whom the Software is furnished to do so,
+    subject to the following conditions:
+
+    The above copyright notice and this permission notice shall be included in all
+    copies or substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+    FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+    COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+    IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+    CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
 
                                  Apache License
                            Version 2.0, January 2004
@@ -187,7 +210,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright [yyyy] [name of copyright owner]
+   Copyright 2010-2013 Liip and others
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
@@ -200,65 +223,3 @@
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.
-
-
-APACHE JACKRABBIT SUBCOMPONENTS
-
-Apache Jackrabbit includes parts with separate copyright notices and license
-terms. Your use of these subcomponents is subject to the terms and conditions
-of the following licenses:
-
-    XPath 2.0/XQuery 1.0 Parser:
-    http://www.w3.org/2002/11/xquery-xpath-applets/xgrammar.zip
-
-    Copyright (C) 2002 World Wide Web Consortium, (Massachusetts Institute of
-    Technology, European Research Consortium for Informatics and Mathematics,
-    Keio University). All Rights Reserved.
-
-    This work is distributed under the W3C(R) Software License in the hope
-    that it will be useful, but WITHOUT ANY WARRANTY; without even the
-    implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
-
-    W3C(R) SOFTWARE NOTICE AND LICENSE
-    http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231
-
-    This work (and included software, documentation such as READMEs, or
-    other related items) is being provided by the copyright holders under
-    the following license. By obtaining, using and/or copying this work,
-    you (the licensee) agree that you have read, understood, and will comply
-    with the following terms and conditions.
-
-    Permission to copy, modify, and distribute this software and its
-    documentation, with or without modification, for any purpose and
-    without fee or royalty is hereby granted, provided that you include
-    the following on ALL copies of the software and documentation or
-    portions thereof, including modifications:
-
-       1. The full text of this NOTICE in a location viewable to users
-          of the redistributed or derivative work.
-
-       2. Any pre-existing intellectual property disclaimers, notices,
-          or terms and conditions. If none exist, the W3C Software Short
-          Notice should be included (hypertext is preferred, text is
-          permitted) within the body of any redistributed or derivative code.
-
-       3. Notice of any changes or modifications to the files, including
-          the date changes were made. (We recommend you provide URIs to the
-          location from which the code is derived.)
-
-    THIS SOFTWARE AND DOCUMENTATION IS PROVIDED "AS IS," AND COPYRIGHT
-    HOLDERS MAKE NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED,
-    INCLUDING BUT NOT LIMITED TO, WARRANTIES OF MERCHANTABILITY OR FITNESS
-    FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF THE SOFTWARE OR
-    DOCUMENTATION WILL NOT INFRINGE ANY THIRD PARTY PATENTS, COPYRIGHTS,
-    TRADEMARKS OR OTHER RIGHTS.
-
-    COPYRIGHT HOLDERS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL
-    OR CONSEQUENTIAL DAMAGES ARISING OUT OF ANY USE OF THE SOFTWARE OR
-    DOCUMENTATION.
-
-    The name and trademarks of copyright holders may NOT be used in
-    advertising or publicity pertaining to the software without specific,
-    written prior permission. Title to copyright in this software and
-    any associated documentation will at all times remain with
-    copyright holders.

README.md

@@ -6,8 +6,12 @@ If you are using or implementing [PHPCR](https://github.com/phpcr/phpcr) you
 probably want some of the things in here.
 
 PHPCR Users: Note that your PHPCR implementation probably already bundles the
-utils. Jackalope for example depends on them and they are found in its
-lib/phpcr-utils folder.
+utils.
+
+## License
+
+This code is dual licensed under the MIT license and the Apache License Version
+2.0. Please see the file LICENSE in this folder.
 
 
 # Documentation
@@ -18,7 +22,7 @@ classes for common tasks.
 
 ## Commands
 
-There are a couple of useful commands to interact with a phpcr repository.
+There are a couple of useful commands to interact with a PHPCR repository.
 
 To use the console, make sure you have initialized the git submodules of
 phpcr-utils, then copy cli-config.php.dist to cli-config.php and adjust it
@@ -28,36 +32,35 @@ NOTE: If you are using PHPCR inside of Symfony, the DoctrinePHPCRBundle
 provides the commands inside the normal Symfony console and you don't need to
 prepare anything special.
 
-* ``phpcr:workspace:create <name>``: Create the workspace name in the configured repository
-* ``phpcr:register-node-types --allow-update [cnd-file]``: Register namespaces and node types from a "Compact Node Type Definition" .cnd file
-* ``phpcr:dump [--sys_nodes[="..."]] [--props[="..."]] [path]``: Show the node names
-     under the specified path. If you set sys_nodes=yes you will also see system nodes.
-     If you set props=yes you will additionally see all properties of the dumped nodes.
-* ``phpcr:purge``: Remove all content from the configured repository in the
-     configured workspace
-* ``phpcr:sql2``: Run a query in the JCR SQL2 language against the repository and dump
-     the resulting rows to the console.
-
-**TODO:**
-
-* Implement commands for phpcr:import and phpcr:export to import and export the
-    PHPCR document view and system view XML dumps.
-* Implement a simple .cnd parser in PHP and use it to make register-node-types
-    work with all repositories
-
+To get a list of the available commands, run `bin/phpcr` or set the commands up
+in your application. Running `bin/phpcr help <command-name>` outputs the
+documentation of that command.
 
 ## Helper Classes
 
 The helper classes provide implementations for basic common tasks to help users
-and implementors of PHPCR. They are all in the namespace PHPCR\Util
+and implementers of PHPCR. They are all in the namespace PHPCR\Util
 
+### PathHelper
 
-### TraversingItemVisitor
+Used to manipulate paths. Implementations are recommended to use this, and
+applications also profit from it. Using `dirname` and similar file system
+operations on paths is not compatible with Microsoft Windows systems, thus you
+should always use the methods in PathHelper.
 
-This ``ItemVisitorInterface`` implementation is a basic implementation of crawling
-a PHPCR tree. You can extend it to define what it should do while crawling the
-tree.
+### NodeHelper
 
+This helper has some generally useful methods like one to generate empty
+`nt:unstructured` nodes to make sure a parent path exists. It also provides
+some useful helper methods for implementations.
+
+### UUIDHelper
+
+This little helper is mainly of interest for PHPCR implementers. It generates
+valid *Universally Unique IDs* and can determine whether a given string is a
+valid UUID.
+We recommend all implementations to use this implementation to guarantee
+consistent behaviour.
 
 ### QOM QueryBuilder
 
@@ -66,25 +69,14 @@ The ``QueryBuilder`` is a fluent query builder with method names matching the
 on top of the QOM factory. It is the easiest way to programmatically build a
 PHPCR query.
 
-
 ### Query Object Model Converter
 
 In the PHPCR\Util\QOM namespace we provide, implementation-independant code to
 convert between SQL2 and QOM. ``Sql2ToQomQueryConverter`` parses SQL2 queries
 into QOM . ``QomToSql2QueryConverter`` generates SQL2 out of a QOM.
 
+### TraversingItemVisitor
 
-### UUIDHelper
-
-This little helper is mainly of interest for PHPCR implementors. It generates
-valid *Universally Unique IDs* and can determine wheter a given string is a
-valid UUID.
-We recommend all implementations to use this implementation to guarantee
-constistent behaviour.
-
-
-# TODO
-
-Move tests about the query converter from phpcr-api-tests tests/06_Query/QOM to
-the tests folder. How to do the tests without a QOM factory implementation?
-
+This ``ItemVisitorInterface`` implementation is a basic implementation of crawling
+a PHPCR tree. You can extend it to define what it should do while crawling the
+tree.

bin/phpcr

@@ -44,6 +44,7 @@ $cli->addCommands(array(
     new \PHPCR\Util\Console\Command\NodeMoveCommand(),
     new \PHPCR\Util\Console\Command\NodeRemoveCommand(),
     new \PHPCR\Util\Console\Command\NodeTouchCommand(),
+    new \PHPCR\Util\Console\Command\NodesUpdateCommand(),
     new \PHPCR\Util\Console\Command\NodeTypeListCommand(),
     new \PHPCR\Util\Console\Command\NodeTypeRegisterCommand(),
     new \PHPCR\Util\Console\Command\WorkspaceCreateCommand(),

composer.json

@@ -4,7 +4,10 @@
     "description": "PHP Content Repository implementation independant utilities",
     "keywords": ["phpcr", "contentrepository", "cli"],
     "homepage": "http://phpcr.github.com",
-    "license": "Apache-2.0",
+    "license": [
+        "MIT",
+        "Apache-2.0"
+    ],
     "authors": [
         {
             "name": "David Buchmann",
@@ -25,7 +28,7 @@
     ],
     "require": {
         "php": ">=5.3.0",
-        "phpcr/phpcr": "~2.1.0-beta10",
+        "phpcr/phpcr": "~2.1.0",
         "symfony/console": "~2.0"
     },
     "autoload": {

src/PHPCR/Util/CND/Exception/ParserException.php

@@ -2,11 +2,15 @@
 
 namespace PHPCR\Util\CND\Exception;
 
-use PHPCR\Util\CND\Scanner\TokenQueue,
-    PHPCR\Util\CND\Scanner\GenericToken;
+use PHPCR\Util\CND\Scanner\TokenQueue;
+use PHPCR\Util\CND\Scanner\GenericToken;
 
 /**
  * @author Daniel Barsotti <[email protected]>
+ *
+ * @license http://www.apache.org/licenses Apache License Version 2.0, January 2004
+ * @license http://opensource.org/licenses/MIT MIT License
+ *
  */
 class ParserException extends \Exception
 {
@@ -17,7 +21,7 @@ public function __construct(TokenQueue $queue, $msg)
 
         // construct a lookup of the next tokens
         $lookup = '';
-        for($i = 1; $i <= 5; $i++) {
+        for ($i = 1; $i <= 5; $i++) {
             if ($queue->isEof()) {
                 break;
             }

src/PHPCR/Util/CND/Exception/ScannerException.php

@@ -5,6 +5,9 @@
 use PHPCR\Util\CND\Reader\ReaderInterface;
 
 /**
+ * @license http://www.apache.org/licenses Apache License Version 2.0, January 2004
+ * @license http://opensource.org/licenses/MIT MIT License
+ *
  * @author Daniel Barsotti <[email protected]>
  */
 class ScannerException extends \Exception

src/PHPCR/Util/CND/Parser/AbstractParser.php

@@ -15,12 +15,16 @@
  *      - expectToken           - expect the next token to match
  *      - checkAndExpectToken   - check and then expect the next token to match
  *
+ * @license http://www.apache.org/licenses Apache License Version 2.0, January 2004
+ * @license http://opensource.org/licenses/MIT MIT License
+ *
  * @author Daniel Barsotti <[email protected]>
  */
 abstract class AbstractParser
 {
     /**
      * The token queue
+     *
      * @var TokenQueue
      */
     protected $tokenQueue;
@@ -30,11 +34,11 @@ abstract class AbstractParser
      * If the data is not provided (equal to null) then only the token type is checked.
      * Return false otherwise.
      *
-     * @param int $type The expected token type
-     * @param null|string $data The expected data or null
-     * @param bool $ignoreCase whether to do string comparisons case insensitive or sensitive
+     * @param int         $type       The expected token type
+     * @param null|string $data       The expected data or null
+     * @param bool        $ignoreCase whether to do string comparisons case insensitive or sensitive
      *
-     * @return bool
+     * @return boolean
      */
     protected function checkToken($type, $data = null, $ignoreCase = false)
     {
@@ -65,7 +69,7 @@ protected function checkToken($type, $data = null, $ignoreCase = false)
      * @param int   $type
      * @param array $data
      *
-     * @return bool
+     * @return boolean
      */
     protected function checkTokenIn($type, array $data, $ignoreCase = false)
     {
@@ -82,7 +86,7 @@ protected function checkTokenIn($type, array $data, $ignoreCase = false)
      * Check if the next token matches the expected type and data. If it does, then consume and return it,
      * otherwise throw an exception.
      *
-     * @param int $type The expected token type
+     * @param int         $type The expected token type
      * @param null|string $data The expected token data or null
      *
      * @return Token
@@ -106,15 +110,17 @@ protected function expectToken($type, $data = null)
      * Check if the next token matches the expected type and data. If it does, then consume it, otherwise
      * return false.
      *
-     * @param int $type The expected token type
+     * @param int         $type The expected token type
      * @param null|string $data The expected token data or null
-     * @return bool|Token
+     *
+     * @return boolean|Token
      */
     protected function checkAndExpectToken($type, $data = null)
     {
         if ($this->checkToken($type, $data)) {
             $token = $this->tokenQueue->peek();
             $this->tokenQueue->next();
+
             return $token;
         }