Subversion-Projekte lars-tiefland.php_share

<?php

/* vim: set expandtab tabstop=4 shiftwidth=4: */

// +----------------------------------------------------------------------+

// | PHP version 5                                                        |

// +----------------------------------------------------------------------+

// | Copyright (c) 2004-2007, Clay Loveless                               |

// | All rights reserved.                                                 |

// +----------------------------------------------------------------------+

// | This LICENSE is in the BSD license style.                            |

// | http://www.opensource.org/licenses/bsd-license.php                   |

// |                                                                      |

// | Redistribution and use in source and binary forms, with or without   |

// | modification, are permitted provided that the following conditions   |

// | are met:                                                             |

// |                                                                      |

// |  * Redistributions of source code must retain the above copyright    |

// |    notice, this list of conditions and the following disclaimer.     |

// |                                                                      |

// |  * Redistributions in binary form must reproduce the above           |

// |    copyright notice, this list of conditions and the following       |

// |    disclaimer in the documentation and/or other materials provided   |

// |    with the distribution.                                            |

// |                                                                      |

// |  * Neither the name of Clay Loveless nor the names of contributors   |

// |    may be used to endorse or promote products derived from this      |

// |    software without specific prior written permission.               |

// |                                                                      |

// | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS  |

// | "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT    |

// | LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS    |

// | FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE      |

// | COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,  |

// | INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, |

// | BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;     |

// | LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER     |

// | CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT   |

// | LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN    |

// | ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE      |

// | POSSIBILITY OF SUCH DAMAGE.                                          |

// +----------------------------------------------------------------------+

// | Author: Clay Loveless <clay@killersoft.com>                          |

// +----------------------------------------------------------------------+

//

// $Id: Cleanup.php 286753 2009-08-03 19:37:03Z mrook $

//

/**

 * @package     VersionControl_SVN

 * @category    VersionControl

 * @author      Clay Loveless <clay@killersoft.com>

 */

/**

 * Subversion Cleanup command manager class

 *

 * Recursively clean up the working copy indicated by PATH, removing

 * locks, resuming unfinished operations, etc.

 *

 * $options is an array containing one or more options

 * defined by the following associative keys:

 *

 * <code>

 *

 * $switches = array(

 *  'config-dir'    =>  'Path to a Subversion configuration directory',

 *  'diff3-cmd'     =>  'ARG'

 *                      // Use ARG as merge command.

 * );

 *

 * </code>

 *

 * If a path is not used in the $args array, the default path of '.' will

 * be assumed.

 *

 * Note: Subversion does not offer an XML output option for this subcommand

 *

 * Note: There is no output from the svn cleanup command!

 *

 * Usage example:

 * <code>

 * <?php

 * require_once 'VersionControl/SVN.php';

 *

 * // Setup error handling -- always a good idea!

 * $svnstack = &PEAR_ErrorStack::singleton('VersionControl_SVN');

 *

 * // Pass array of subcommands we need to factory

 * $svn = VersionControl_SVN::factory(array('cleanup'), $options);

 *

 * // Define any switches and aguments we may need

 * $args = array('/path/to/working_copy');

 *

 * // Run command

 * if ($output = $svn->cleanup->run($args)) {

 *     print_r($output);

 * } else {

 *     if (count($errs = $svnstack->getErrors())) {

 *         foreach ($errs as $err) {

 *             echo '<br />'.$err['message']."<br />\n";

 *             echo "Command used: " . $err['params']['cmd'];

 *         }

 *     }

 * }

 * ?>

 * </code>

 *

 * @package  VersionControl_SVN

 * @version  0.3.4

 * @category SCM

 * @author   Clay Loveless <clay@killersoft.com>

 */

class VersionControl_SVN_Cleanup extends VersionControl_SVN

{

    /**

     * Valid switches for svn cleanup

     *

     * @var     array

     * @access  public

     */

    var $valid_switches = array('config-dir',

                                'config_dir',

                                'diff3-cmd'

                                );

    /**

     * Command-line arguments that should be passed

     * <b>outside</b> of those specified in {@link switches}.

     *

     * @var     array

     * @access  public

     */

    var $args = array();

    /**

     * Minimum number of args required by this subcommand.

     * See {@link http://svnbook.red-bean.com/svnbook/ Version Control with Subversion},

     * Subversion Complete Reference for details on arguments for this subcommand.

     * @var     int

     * @access  public

     */

    var $min_args = 0;

    /**

     * Switches required by this subcommand.

     * See {@link http://svnbook.red-bean.com/svnbook/ Version Control with Subversion},

     * Subversion Complete Reference for details on arguments for this subcommand.

     * @var     array

     * @access  public

     */

    var $required_switches = array();

    /**

     * Use exec or passthru to get results from command.

     * @var     bool

     * @access  public

     */

    var $passthru = false;

    /**

     * Prepare the svn subcommand switches.

     *

     * @param   void

     * @return  int    true on success, false on failure. Check PEAR_ErrorStack

     *                 for error details, if any.

     */

    function prepare()

    {

        $meets_requirements = $this->checkCommandRequirements();

        if (!$meets_requirements) {

            return false;

        }

        $valid_switches     = $this->valid_switches;

        $switches           = $this->switches;

        $args               = $this->args;

        $fetchmode          = $this->fetchmode;

        $invalid_switches   = array();

        $_switches          = '';

        foreach ($switches as $switch => $val) {

            if (in_array($switch, $valid_switches)) {

                $switch = str_replace('_', '-', $switch);

                switch ($switch) {

                    case 'config-dir':

                    case 'diff3-cmd':

                        $_switches .= "--$switch $val ";

                        break;

                    default:

                        // that's all, folks!

                        break;

                }

            } else {

                $invalid_switches[] = $switch;

            }

        }

        $_switches = trim($_switches);

        $this->_switches = $_switches;

        $cmd = "$this->svn_path $this->_svn_cmd $_switches";

        if (!empty($args)) {

            $cmd .= ' '. join(' ', $args);

        }

        $this->_prepped_cmd = $cmd;

        $this->prepared = true;

        $invalid = count($invalid_switches);

        if ($invalid > 0) {

            $params['was'] = 'was';

            $params['is_invalid_switch'] = 'is an invalid switch';

            if ($invalid > 1) {

                $params['was'] = 'were';

                $params['is_invalid_switch'] = 'are invalid switches';

            }

            $params['list'] = $invalid_switches;

            $params['switches'] = $switches;

            $params['_svn_cmd'] = ucfirst($this->_svn_cmd);

            $this->_stack->push(VERSIONCONTROL_SVN_NOTICE_INVALID_SWITCH, 'notice', $params);

        }

        return true;

    }

    /// }}}

}

/// }}}

?>