Chris@0: <?php
Chris@0: /**
Chris@0:  * A class to manage reporting.
Chris@0:  *
Chris@0:  * PHP version 5
Chris@0:  *
Chris@0:  * @category  PHP
Chris@0:  * @package   PHP_CodeSniffer
Chris@0:  * @author    Gabriele Santini <gsantini@sqli.com>
Chris@0:  * @author    Greg Sherwood <gsherwood@squiz.net>
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:  * A class to manage reporting.
Chris@0:  *
Chris@0:  * @category  PHP
Chris@0:  * @package   PHP_CodeSniffer
Chris@0:  * @author    Gabriele Santini <gsantini@sqli.com>
Chris@0:  * @author    Greg Sherwood <gsherwood@squiz.net>
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: @package_version@
Chris@0:  * @link      http://pear.php.net/package/PHP_CodeSniffer
Chris@0:  */
Chris@0: class PHP_CodeSniffer_Reporting
Chris@0: {
Chris@0: 
Chris@0:     /**
Chris@0:      * Total number of files that contain errors or warnings.
Chris@0:      *
Chris@0:      * @var int
Chris@0:      */
Chris@0:     public $totalFiles = 0;
Chris@0: 
Chris@0:     /**
Chris@0:      * Total number of errors found during the run.
Chris@0:      *
Chris@0:      * @var int
Chris@0:      */
Chris@0:     public $totalErrors = 0;
Chris@0: 
Chris@0:     /**
Chris@0:      * Total number of warnings found during the run.
Chris@0:      *
Chris@0:      * @var int
Chris@0:      */
Chris@0:     public $totalWarnings = 0;
Chris@0: 
Chris@0:     /**
Chris@0:      * Total number of errors/warnings that can be fixed.
Chris@0:      *
Chris@0:      * @var int
Chris@0:      */
Chris@0:     public $totalFixable = 0;
Chris@0: 
Chris@0:     /**
Chris@0:      * When the PHPCS run started.
Chris@0:      *
Chris@0:      * @var float
Chris@0:      */
Chris@0:     public static $startTime = 0;
Chris@0: 
Chris@0:     /**
Chris@0:      * A list of reports that have written partial report output.
Chris@0:      *
Chris@0:      * @var array
Chris@0:      */
Chris@0:     private $_cachedReports = array();
Chris@0: 
Chris@0:     /**
Chris@0:      * A cache of report objects.
Chris@0:      *
Chris@0:      * @var array
Chris@0:      */
Chris@0:     private $_reports = array();
Chris@0: 
Chris@0:     /**
Chris@0:      * A cache of opened tmp files.
Chris@0:      *
Chris@0:      * @var array
Chris@0:      */
Chris@0:     private $_tmpFiles = array();
Chris@0: 
Chris@0: 
Chris@0:     /**
Chris@0:      * Produce the appropriate report object based on $type parameter.
Chris@0:      *
Chris@0:      * @param string $type The type of the report.
Chris@0:      *
Chris@0:      * @return PHP_CodeSniffer_Report
Chris@0:      * @throws PHP_CodeSniffer_Exception If report is not available.
Chris@0:      */
Chris@0:     public function factory($type)
Chris@0:     {
Chris@0:         $type = ucfirst($type);
Chris@0:         if (isset($this->_reports[$type]) === true) {
Chris@0:             return $this->_reports[$type];
Chris@0:         }
Chris@0: 
Chris@0:         if (strpos($type, '.') !== false) {
Chris@0:             // This is a path to a custom report class.
Chris@0:             $filename = realpath($type);
Chris@0:             if ($filename === false) {
Chris@0:                 echo 'ERROR: Custom report "'.$type.'" not found'.PHP_EOL;
Chris@0:                 exit(2);
Chris@0:             }
Chris@0: 
Chris@0:             $reportClassName = 'PHP_CodeSniffer_Reports_'.basename($filename);
Chris@0:             $reportClassName = substr($reportClassName, 0, strpos($reportClassName, '.'));
Chris@0:             include_once $filename;
Chris@0:         } else {
Chris@0:             $filename        = $type.'.php';
Chris@0:             $reportClassName = 'PHP_CodeSniffer_Reports_'.$type;
Chris@0:             if (class_exists($reportClassName, true) === false) {
Chris@0:                 echo 'ERROR: Report type "'.$type.'" not found'.PHP_EOL;
Chris@0:                 exit(2);
Chris@0:             }
Chris@0:         }//end if
Chris@0: 
Chris@0:         $reportClass = new $reportClassName();
Chris@0:         if (false === ($reportClass instanceof PHP_CodeSniffer_Report)) {
Chris@0:             throw new PHP_CodeSniffer_Exception('Class "'.$reportClassName.'" must implement the "PHP_CodeSniffer_Report" interface.');
Chris@0:         }
Chris@0: 
Chris@0:         $this->_reports[$type] = $reportClass;
Chris@0:         return $this->_reports[$type];
Chris@0: 
Chris@0:     }//end factory()
Chris@0: 
Chris@0: 
Chris@0:     /**
Chris@0:      * Actually generates the report.
Chris@0:      *
Chris@0:      * @param PHP_CodeSniffer_File $phpcsFile The file that has been processed.
Chris@0:      * @param array                $cliValues An array of command line arguments.
Chris@0:      *
Chris@0:      * @return void
Chris@0:      */
Chris@0:     public function cacheFileReport(PHP_CodeSniffer_File $phpcsFile, array $cliValues)
Chris@0:     {
Chris@0:         if (isset($cliValues['reports']) === false) {
Chris@0:             // This happens during unit testing, or any time someone just wants
Chris@0:             // the error data and not the printed report.
Chris@0:             return;
Chris@0:         }
Chris@0: 
Chris@0:         $reportData  = $this->prepareFileReport($phpcsFile);
Chris@0:         $errorsShown = false;
Chris@0: 
Chris@0:         foreach ($cliValues['reports'] as $report => $output) {
Chris@0:             $reportClass = $this->factory($report);
Chris@0:             $report      = get_class($reportClass);
Chris@0: 
Chris@0:             ob_start();
Chris@0:             $result = $reportClass->generateFileReport($reportData, $phpcsFile, $cliValues['showSources'], $cliValues['reportWidth']);
Chris@0:             if ($result === true) {
Chris@0:                 $errorsShown = true;
Chris@0:             }
Chris@0: 
Chris@0:             $generatedReport = ob_get_contents();
Chris@0:             ob_end_clean();
Chris@0: 
Chris@0:             if ($output === null && $cliValues['reportFile'] !== null) {
Chris@0:                 $output = $cliValues['reportFile'];
Chris@0:             }
Chris@0: 
Chris@0:             if ($output === null) {
Chris@0:                 // Using a temp file.
Chris@0:                 if (isset($this->_tmpFiles[$report]) === false) {
Chris@0:                     if (function_exists('sys_get_temp_dir') === true) {
Chris@0:                         // This is needed for HHVM support, but only available from 5.2.1.
Chris@0:                         $this->_tmpFiles[$report] = fopen(tempnam(sys_get_temp_dir(), 'phpcs'), 'w');
Chris@0:                     } else {
Chris@0:                         $this->_tmpFiles[$report] = tmpfile();
Chris@0:                     }
Chris@0:                 }
Chris@0: 
Chris@0:                 fwrite($this->_tmpFiles[$report], $generatedReport);
Chris@0:             } else {
Chris@0:                 $flags = FILE_APPEND;
Chris@0:                 if (isset($this->_cachedReports[$report]) === false) {
Chris@0:                     $this->_cachedReports[$report] = true;
Chris@0:                     $flags = null;
Chris@0:                 }
Chris@0: 
Chris@0:                 file_put_contents($output, $generatedReport, $flags);
Chris@0:             }//end if
Chris@0:         }//end foreach
Chris@0: 
Chris@0:         if ($errorsShown === true) {
Chris@0:             $this->totalFiles++;
Chris@0:             $this->totalErrors   += $reportData['errors'];
Chris@0:             $this->totalWarnings += $reportData['warnings'];
Chris@0:             $this->totalFixable  += $reportData['fixable'];
Chris@0:         }
Chris@0: 
Chris@0:     }//end cacheFileReport()
Chris@0: 
Chris@0: 
Chris@0:     /**
Chris@0:      * Generates and prints a final report.
Chris@0:      *
Chris@0:      * Returns an array with the number of errors and the number of
Chris@0:      * warnings, in the form ['errors' => int, 'warnings' => int].
Chris@0:      *
Chris@0:      * @param string  $report      Report type.
Chris@0:      * @param boolean $showSources Show sources?
Chris@0:      * @param array   $cliValues   An array of command line arguments.
Chris@0:      * @param string  $reportFile  Report file to generate.
Chris@0:      * @param integer $reportWidth Report max width.
Chris@0:      *
Chris@0:      * @return int[]
Chris@0:      */
Chris@0:     public function printReport(
Chris@0:         $report,
Chris@0:         $showSources,
Chris@0:         array $cliValues,
Chris@0:         $reportFile='',
Chris@0:         $reportWidth=80
Chris@0:     ) {
Chris@0:         $reportClass = $this->factory($report);
Chris@0:         $report      = get_class($reportClass);
Chris@0: 
Chris@0:         if ($reportFile !== null) {
Chris@0:             $filename = $reportFile;
Chris@0:             $toScreen = false;
Chris@0: 
Chris@0:             if (file_exists($filename) === true
Chris@0:                 && isset($this->_cachedReports[$report]) === true
Chris@0:             ) {
Chris@0:                 $reportCache = file_get_contents($filename);
Chris@0:             } else {
Chris@0:                 $reportCache = '';
Chris@0:             }
Chris@0:         } else {
Chris@0:             if (isset($this->_tmpFiles[$report]) === true) {
Chris@0:                 $data        = stream_get_meta_data($this->_tmpFiles[$report]);
Chris@0:                 $filename    = $data['uri'];
Chris@0:                 $reportCache = file_get_contents($filename);
Chris@0:                 fclose($this->_tmpFiles[$report]);
Chris@0:             } else {
Chris@0:                 $reportCache = '';
Chris@0:                 $filename    = null;
Chris@0:             }
Chris@0: 
Chris@0:             $toScreen = true;
Chris@0:         }//end if
Chris@0: 
Chris@0:         ob_start();
Chris@0:         $reportClass->generate(
Chris@0:             $reportCache,
Chris@0:             $this->totalFiles,
Chris@0:             $this->totalErrors,
Chris@0:             $this->totalWarnings,
Chris@0:             $this->totalFixable,
Chris@0:             $showSources,
Chris@0:             $reportWidth,
Chris@0:             $toScreen
Chris@0:         );
Chris@0:         $generatedReport = ob_get_contents();
Chris@0:         ob_end_clean();
Chris@0: 
Chris@0:         if ($cliValues['colors'] !== true || $reportFile !== null) {
Chris@0:             $generatedReport = preg_replace('`\033\[[0-9]+m`', '', $generatedReport);
Chris@0:         }
Chris@0: 
Chris@0:         if ($reportFile !== null) {
Chris@0:             if (PHP_CODESNIFFER_VERBOSITY > 0) {
Chris@0:                 echo $generatedReport;
Chris@0:             }
Chris@0: 
Chris@0:             file_put_contents($reportFile, $generatedReport.PHP_EOL);
Chris@0:         } else {
Chris@0:             echo $generatedReport;
Chris@0:             if ($filename !== null && file_exists($filename) === true) {
Chris@0:                 unlink($filename);
Chris@0:             }
Chris@0:         }
Chris@0: 
Chris@0:         return array(
Chris@0:                 'errors'   => $this->totalErrors,
Chris@0:                 'warnings' => $this->totalWarnings,
Chris@0:                );
Chris@0: 
Chris@0:     }//end printReport()
Chris@0: 
Chris@0: 
Chris@0:     /**
Chris@0:      * Pre-process and package violations for all files.
Chris@0:      *
Chris@0:      * Used by error reports to get a packaged list of all errors in each file.
Chris@0:      *
Chris@0:      * @param PHP_CodeSniffer_File $phpcsFile The file that has been processed.
Chris@0:      *
Chris@0:      * @return array
Chris@0:      */
Chris@0:     public function prepareFileReport(PHP_CodeSniffer_File $phpcsFile)
Chris@0:     {
Chris@0:         $report = array(
Chris@0:                    'filename' => $phpcsFile->getFilename(),
Chris@0:                    'errors'   => $phpcsFile->getErrorCount(),
Chris@0:                    'warnings' => $phpcsFile->getWarningCount(),
Chris@0:                    'fixable'  => $phpcsFile->getFixableCount(),
Chris@0:                    'messages' => array(),
Chris@0:                   );
Chris@0: 
Chris@0:         if ($report['errors'] === 0 && $report['warnings'] === 0) {
Chris@0:             // Prefect score!
Chris@0:             return $report;
Chris@0:         }
Chris@0: 
Chris@0:         $errors = array();
Chris@0: 
Chris@0:         // Merge errors and warnings.
Chris@0:         foreach ($phpcsFile->getErrors() as $line => $lineErrors) {
Chris@0:             if (is_array($lineErrors) === false) {
Chris@0:                 continue;
Chris@0:             }
Chris@0: 
Chris@0:             foreach ($lineErrors as $column => $colErrors) {
Chris@0:                 $newErrors = array();
Chris@0:                 foreach ($colErrors as $data) {
Chris@0:                     $newErrors[] = array(
Chris@0:                                     'message'  => $data['message'],
Chris@0:                                     'source'   => $data['source'],
Chris@0:                                     'severity' => $data['severity'],
Chris@0:                                     'fixable'  => $data['fixable'],
Chris@0:                                     'type'     => 'ERROR',
Chris@0:                                    );
Chris@0:                 }//end foreach
Chris@0: 
Chris@0:                 $errors[$line][$column] = $newErrors;
Chris@0:             }//end foreach
Chris@0: 
Chris@0:             ksort($errors[$line]);
Chris@0:         }//end foreach
Chris@0: 
Chris@0:         foreach ($phpcsFile->getWarnings() as $line => $lineWarnings) {
Chris@0:             if (is_array($lineWarnings) === false) {
Chris@0:                 continue;
Chris@0:             }
Chris@0: 
Chris@0:             foreach ($lineWarnings as $column => $colWarnings) {
Chris@0:                 $newWarnings = array();
Chris@0:                 foreach ($colWarnings as $data) {
Chris@0:                     $newWarnings[] = array(
Chris@0:                                       'message'  => $data['message'],
Chris@0:                                       'source'   => $data['source'],
Chris@0:                                       'severity' => $data['severity'],
Chris@0:                                       'fixable'  => $data['fixable'],
Chris@0:                                       'type'     => 'WARNING',
Chris@0:                                      );
Chris@0:                 }//end foreach
Chris@0: 
Chris@0:                 if (isset($errors[$line]) === false) {
Chris@0:                     $errors[$line] = array();
Chris@0:                 }
Chris@0: 
Chris@0:                 if (isset($errors[$line][$column]) === true) {
Chris@0:                     $errors[$line][$column] = array_merge(
Chris@0:                         $newWarnings,
Chris@0:                         $errors[$line][$column]
Chris@0:                     );
Chris@0:                 } else {
Chris@0:                     $errors[$line][$column] = $newWarnings;
Chris@0:                 }
Chris@0:             }//end foreach
Chris@0: 
Chris@0:             ksort($errors[$line]);
Chris@0:         }//end foreach
Chris@0: 
Chris@0:         ksort($errors);
Chris@0:         $report['messages'] = $errors;
Chris@0:         return $report;
Chris@0: 
Chris@0:     }//end prepareFileReport()
Chris@0: 
Chris@0: 
Chris@0:     /**
Chris@0:      * Start recording time for the run.
Chris@0:      *
Chris@0:      * @return void
Chris@0:      */
Chris@0:     public static function startTiming()
Chris@0:     {
Chris@0: 
Chris@0:         self::$startTime = microtime(true);
Chris@0: 
Chris@0:     }//end startTiming()
Chris@0: 
Chris@0: 
Chris@0:     /**
Chris@0:      * Print information about the run.
Chris@0:      *
Chris@0:      * @return void
Chris@0:      */
Chris@0:     public static function printRunTime()
Chris@0:     {
Chris@0:         $time = ((microtime(true) - self::$startTime) * 1000);
Chris@0: 
Chris@0:         if ($time > 60000) {
Chris@0:             $mins = floor($time / 60000);
Chris@0:             $secs = round((($time % 60000) / 1000), 2);
Chris@0:             $time = $mins.' mins';
Chris@0:             if ($secs !== 0) {
Chris@0:                 $time .= ", $secs secs";
Chris@0:             }
Chris@0:         } else if ($time > 1000) {
Chris@0:             $time = round(($time / 1000), 2).' secs';
Chris@0:         } else {
Chris@0:             $time = round($time).'ms';
Chris@0:         }
Chris@0: 
Chris@0:         $mem = round((memory_get_peak_usage(true) / (1024 * 1024)), 2).'Mb';
Chris@0:         echo "Time: $time; Memory: $mem".PHP_EOL.PHP_EOL;
Chris@0: 
Chris@0:     }//end printRunTime()
Chris@0: 
Chris@0: 
Chris@0: }//end class