| // +----------------------------------------------------------------------+ // // $Id$ // /** * @package VersionControl_SVN * @category VersionControl * @author Clay Loveless */ /** * Subversion Log command manager class * * $switches is an array containing one or more command line options * defined by the following associative keys: * * * * $switches = array( * 'username' => 'Subversion repository login', * 'password' => 'Subversion repository password', * 'config-dir' => 'Path to a Subversion configuration directory', * // [DEFAULT: null] * 'r [revision]' => 'ARG (some commands also take ARG1:ARG2 range) * A revision argument can be one of: * NUMBER revision number * "{" DATE "}" revision at start of the date * "HEAD" latest in repository * "BASE" base rev of item's working copy * "COMMITTED" last commit at or before BASE * "PREV" revision just before COMMITTED', * // either 'r' or 'revision' may be used * 'q [quiet]' => true|false, * // prints as little as possible * 'v [verbose]' => true|false, * // prints extra information * 'targets' => 'ARG', * // passes contents of file ARG as additional arguments * 'stop-on-copy' => true|false, * // do not cross copies while traversing history * 'incremental' => true|false, * // gives output suitable for concatenation * 'xml' => true|false, * // output in XML. Auto-set by fetchmodes VERSIONCONTROL_SVN_FETCHMODE_ASSOC, * // VERSIONCONTROL_SVN_FETCHMODE_XML and VERSIONCONTROL_SVN_FETCHMODE_OBJECT * 'no-auth-cache' => true|false * // Do not cache authentication tokens * * ); * * * * The non-interactive option available on the command-line * svn client may also be set (true|false), but it is set to true by default. * * Usage example: * * VERSIONCONTROL_SVN_FETCHMODE_ASSOC); * * // Pass array of subcommands we need to factory * $svn = VersionControl_SVN::factory(array('log'), $options); * * // Define any switches and aguments we may need * $switches = array('verbose' => true); * $args = array('svn://svn.example.com/repos/TestProject'); * * // Run command * if ($output = $svn->log->run($args, $switches)) { * print_r($output); * } else { * if (count($errs = $svnstack->getErrors())) { * foreach ($errs as $err) { * echo '
'.$err['message']."
\n"; * echo "Command used: " . $err['params']['cmd']; * } * } * } * ?> * * * @package VersionControl_SVN * @version @version@ * @category SCM * @author Clay Loveless */ class VersionControl_SVN_Log extends VersionControl_SVN { /** * Valid switches for svn log * * @var array * @access public */ var $valid_switches = array('r', 'q', 'v', 'revision', 'quiet', 'verbose', 'targets', 'stop-on-copy', 'stop_on_copy', 'incremental', 'xml', 'username', 'password', 'no-auth-cache', 'no_auth_cache', 'non-interactive', 'non_interactive', 'config-dir', 'config_dir', 'limit' ); /** * Command-line arguments that should be passed * outside 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. * * Defaults to non-interactive mode, and will auto-set the * --xml switch if $fetchmode is set to VERSIONCONTROL_SVN_FETCHMODE_XML, * VERSIONCONTROL_SVN_FETCHMODE_ASSOC or VERSIONCONTROL_SVN_FETCHMODE_OBJECT * * @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 'revision': case 'targets': case 'username': case 'password': case 'config-dir': case 'limit': $_switches .= "--$switch $val "; break; case 'r': $_switches .= "-$switch $val "; break; case 'quiet': case 'verbose': case 'xml': case 'no-auth-cache': case 'stop-on-copy': case 'non-interactive': if ($val === true) { $_switches .= "--$switch "; } break; case 'q': case 'v': if ($val === true) { $_switches .= "-$switch "; } break; default: // that's all, folks! break; } } else { $invalid_switches[] = $switch; } } // We don't want interactive mode if (strpos($_switches, 'non-interactive') === false) { $_switches .= '--non-interactive '; } $this->xml_avail = true; if ($fetchmode == VERSIONCONTROL_SVN_FETCHMODE_ASSOC || $fetchmode == VERSIONCONTROL_SVN_FETCHMODE_OBJECT || $fetchmode == VERSIONCONTROL_SVN_FETCHMODE_XML) { if (strpos($_switches, 'xml') === false) { $_switches .= '--xml '; } } $_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; } // }}} // {{{ parseOutput() /** * Handles output parsing of output of Log command. * * @param array $out Array of output captured by exec command in {@link run}. * @return mixed Returns output requested by fetchmode (if available), or raw output * if desired fetchmode is not available. * @access public */ function parseOutput($out) { $fetchmode = $this->fetchmode; $dir = realpath(dirname(__FILE__)) . '/Parsers'; switch($fetchmode) { case VERSIONCONTROL_SVN_FETCHMODE_RAW: return join("\n", $out); break; case VERSIONCONTROL_SVN_FETCHMODE_ARRAY: case VERSIONCONTROL_SVN_FETCHMODE_ASSOC: case VERSIONCONTROL_SVN_FETCHMODE_OBJECT: require_once $dir.'/Log.php'; $parser =& new VersionControl_SVN_Log_Parser; $parser->parseString(join("\n", $out)); if ($fetchmode == VERSIONCONTROL_SVN_FETCHMODE_OBJECT) { return (object) $parser->log; } return $parser->log; break; case VERSIONCONTROL_SVN_FETCHMODE_XML: // Return command's native XML output return join("\n", $out); break; default: // What you get with VERSIONCONTROL_SVN_FETCHMODE_DEFAULT return join("\n", $out); break; } } // }}} } // }}} ?>