Subversion Repositories Applications.framework

#!/usr/local/bin/php

<?php

/**

 * A commit hook for SVN.

 *

 * PHP version 5

 *

 * @category  PHP

 * @package   PHP_CodeSniffer

 * @author    Jack Bates <ms419@freezone.co.uk>

 * @author    Greg Sherwood <gsherwood@squiz.net>

 * @copyright 2006 Squiz Pty Ltd (ABN 77 084 670 600)

 * @license   http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence

 * @version   CVS: $Id$

 * @link      http://pear.php.net/package/PHP_CodeSniffer

 */

if (is_file(dirname(__FILE__).'/../CodeSniffer/CLI.php') === true) {

    include_once dirname(__FILE__).'/../CodeSniffer/CLI.php';

} else {

    include_once 'PHP/CodeSniffer/CLI.php';

}

define('PHP_CODESNIFFER_SVNLOOK', '/usr/local/bin/svnlook');

/**

 * A class to process command line options.

 *

 * @category  PHP

 * @package   PHP_CodeSniffer

 * @author    Jack Bates <ms419@freezone.co.uk>

 * @author    Greg Sherwood <gsherwood@squiz.net>

 * @copyright 2006 Squiz Pty Ltd (ABN 77 084 670 600)

 * @license   http://matrix.squiz.net/developer/tools/php_cs/licence BSD Licence

 * @version   Release: @package_version@

 * @link      http://pear.php.net/package/PHP_CodeSniffer

 */

class PHP_CodeSniffer_SVN_Hook extends PHP_CodeSniffer_CLI

{

    /**

     * Get a list of default values for all possible command line arguments.

     *

     * @return array

     */

    public function getDefaults()

    {

        $defaults = parent::getDefaults();

        $defaults['svnArgs'] = array();

        return $defaults;

    }//end getDefaults()

    /**

     * Processes an unknown command line argument.

     *

     * All unkown args are sent to SVN commands.

     *

     * @param string $arg    The command line argument.

     * @param int    $pos    The position of the argument on the command line.

     * @param array  $values An array of values determined from CLI args.

     *

     * @return array The updated CLI values.

     * @see getCommandLineValues()

     */

    public function processUnknownArgument($arg, $pos, $values)

    {

        $values['svnArgs'][] = $arg;

        return $values;

    }//end processUnknownArgument()

    /**

     * Runs PHP_CodeSniffer over files are directories.

     *

     * @param array $values An array of values determined from CLI args.

     *

     * @return int The number of error and warning messages shown.

     * @see getCommandLineValues()

     */

    public function process($values=array())

    {

        if (empty($values) === true) {

            $values = parent::getCommandLineValues();

        }

        // Get list of files in this transaction.

        $command = PHP_CODESNIFFER_SVNLOOK.' changed '.implode(' ', $values['svnArgs']);

        $handle  = popen($command, 'r');

        if ($handle === false) {

            echo 'ERROR: Could not execute "'.$command.'"'.PHP_EOL.PHP_EOL;

            exit(2);

        }

        $contents = stream_get_contents($handle);

        fclose($handle);

        // Do not check deleted paths.

        $contents = preg_replace('/^D.*/m', null, $contents);

        // Drop the four characters representing the action which precede the path on

        // each line.

        $contents = preg_replace('/^.{4}/m', null, $contents);

        $values['standard'] = $this->validateStandard($values['standard']);

        if (PHP_CodeSniffer::isInstalledStandard($values['standard']) === false) {

            // They didn't select a valid coding standard, so help them

            // out by letting them know which standards are installed.

            echo 'ERROR: the "'.$values['standard'].'" coding standard is not installed. ';

            $this->printInstalledStandards();

            exit(2);

        }

        $phpcs = new PHP_CodeSniffer($values['verbosity'], $values['tabWidth']);

        // Set file extensions if they were specified. Otherwise,

        // let PHP_CodeSniffer decide on the defaults.

        if (empty($values['extensions']) === false) {

            $phpcs->setAllowedFileExtensions($values['extensions']);

        }

        // Set ignore patterns if they were specified.

        if (empty($values['ignored']) === false) {

            $phpcs->setIgnorePatterns($values['ignored']);

        }

        $phpcs->setTokenListeners($values['standard']);

        foreach (preg_split('/\v/', $contents, -1, PREG_SPLIT_NO_EMPTY) as $path) {

            // No need to process folders as each changed file is checked.

            if (substr($path, -1) === '/') {

                continue;

            }

            // Get the contents of each file, as it would be after this transaction.

            $command = PHP_CODESNIFFER_SVNLOOK.' cat '.implode(' ', $values['svnArgs']).' '.$path;

            $handle  = popen($command, 'r');

            if ($handle === false) {

                echo 'ERROR: Could not execute "'.$command.'"'.PHP_EOL.PHP_EOL;

                exit(2);

            }

            $contents = stream_get_contents($handle);

            fclose($handle);

            $phpcs->processFile($path, $contents);

        }//end foreach

        return parent::printErrorReport(

            $phpcs,

            $values['report'],

            $values['showWarnings'],

            $values['showSources'],

            $values['reportFile']

        );

    }//end process()

    /**

     * Prints out the usage information for this script.

     *

     * @return void

     */

    public function printUsage()

    {

        parent::printUsage();

        echo PHP_EOL;

        echo '    Each additional argument is passed to the `svnlook changed ...`'.PHP_EOL;

        echo '    and `svnlook cat ...` commands.  The report is printed on standard output,'.PHP_EOL;

        echo '    however Subversion displays only standard error to the user, so in a'.PHP_EOL;

        echo '    pre-commit hook, this script should be invoked as follows:'.PHP_EOL;

        echo PHP_EOL;

        echo '    '.basename($_SERVER['argv'][0]).' ... "$REPOS" -t "$TXN" >&2 || exit 1'.PHP_EOL;

    }//end printUsage()

}//end class

$phpcs = new PHP_CodeSniffer_SVN_Hook();

$phpcs->checkRequirements();

$numErrors = $phpcs->process();

if ($numErrors !== 0) {

    exit(1);

}

?>