Chris@0: <?php
Chris@0: /**
Chris@0:  * Gitblame report for PHP_CodeSniffer.
Chris@0:  *
Chris@0:  * PHP version 5
Chris@0:  *
Chris@0:  * @category  PHP
Chris@0:  * @package   PHP_CodeSniffer
Chris@0:  * @author    Ben Selby <benmatselby@gmail.com>
Chris@0:  * @copyright 2009-2014 SQLI <www.sqli.com>
Chris@0:  * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600)
Chris@0:  * @license   https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
Chris@0:  * @link      http://pear.php.net/package/PHP_CodeSniffer
Chris@0:  */
Chris@0: 
Chris@0: /**
Chris@0:  * Gitblame report for PHP_CodeSniffer.
Chris@0:  *
Chris@0:  * PHP version 5
Chris@0:  *
Chris@0:  * @category  PHP
Chris@0:  * @package   PHP_CodeSniffer
Chris@0:  * @author    Ben Selby <benmatselby@gmail.com>
Chris@0:  * @copyright 2009-2014 SQLI <www.sqli.com>
Chris@0:  * @copyright 2006-2014 Squiz Pty Ltd (ABN 77 084 670 600)
Chris@0:  * @license   https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
Chris@0:  * @version   Release: 1.2.2
Chris@0:  * @link      http://pear.php.net/package/PHP_CodeSniffer
Chris@0:  */
Chris@0: class PHP_CodeSniffer_Reports_Gitblame extends PHP_CodeSniffer_Reports_VersionControl
Chris@0: {
Chris@0: 
Chris@0:     /**
Chris@0:      * The name of the report we want in the output
Chris@0:      *
Chris@0:      * @var string
Chris@0:      */
Chris@0:     protected $reportName = 'GIT';
Chris@0: 
Chris@0: 
Chris@0:     /**
Chris@0:      * Extract the author from a blame line.
Chris@0:      *
Chris@0:      * @param string $line Line to parse.
Chris@0:      *
Chris@0:      * @return mixed string or false if impossible to recover.
Chris@0:      */
Chris@0:     protected function getAuthor($line)
Chris@0:     {
Chris@0:         $blameParts = array();
Chris@0:         $line       = preg_replace('|\s+|', ' ', $line);
Chris@0:         preg_match(
Chris@0:             '|\(.+[0-9]{4}-[0-9]{2}-[0-9]{2}\s+[0-9]+\)|',
Chris@0:             $line,
Chris@0:             $blameParts
Chris@0:         );
Chris@0: 
Chris@0:         if (isset($blameParts[0]) === false) {
Chris@0:             return false;
Chris@0:         }
Chris@0: 
Chris@0:         $parts = explode(' ', $blameParts[0]);
Chris@0: 
Chris@0:         if (count($parts) < 2) {
Chris@0:             return false;
Chris@0:         }
Chris@0: 
Chris@0:         $parts  = array_slice($parts, 0, (count($parts) - 2));
Chris@0:         $author = preg_replace('|\(|', '', implode($parts, ' '));
Chris@0:         return $author;
Chris@0: 
Chris@0:     }//end getAuthor()
Chris@0: 
Chris@0: 
Chris@0:     /**
Chris@0:      * Gets the blame output.
Chris@0:      *
Chris@0:      * @param string $filename File to blame.
Chris@0:      *
Chris@0:      * @return array
Chris@0:      */
Chris@0:     protected function getBlameContent($filename)
Chris@0:     {
Chris@0:         $cwd = getcwd();
Chris@0: 
Chris@0:         chdir(dirname($filename));
Chris@0:         $command = 'git blame --date=short "'.$filename.'" 2>&1';
Chris@0:         $handle  = popen($command, 'r');
Chris@0:         if ($handle === false) {
Chris@0:             echo 'ERROR: Could not execute "'.$command.'"'.PHP_EOL.PHP_EOL;
Chris@0:             exit(2);
Chris@0:         }
Chris@0: 
Chris@0:         $rawContent = stream_get_contents($handle);
Chris@0:         fclose($handle);
Chris@0: 
Chris@0:         $blames = explode("\n", $rawContent);
Chris@0:         chdir($cwd);
Chris@0: 
Chris@0:         return $blames;
Chris@0: 
Chris@0:     }//end getBlameContent()
Chris@0: 
Chris@0: 
Chris@0: }//end class