src/Core/Console/DocBloxErrorChecker.php

   1 <?php
   2
   3 namespace Friendica\Core\Console;
   4
   5 /**
   6  * When I installed docblox, I had the experience that it does not generate any output at all.
   7  * This script may be used to find that kind of problems with the documentation build process.
   8  * If docblox generates output, use another approach for debugging.
   9  *
  10  * Basically, docblox takes a list of files to build documentation from. This script assumes there is a file or set of files
  11  * breaking the build when it is included in that list. It tries to calculate the smallest list containing these files.
  12  * Unfortunatly, the original problem is NP-complete, so what the script does is a best guess only.
  13  *
  14  * So it starts with a list of all files in the project.
  15  * If that list can't be build, it cuts it in two parts and tries both parts independently. If only one of them breaks,
  16  * it takes that one and tries the same independently. If both break, it assumes this is the smallest set. This assumption
  17  * is not necessarily true. Maybe the smallest set consists of two files and both of them were in different parts when
  18  * the list was divided, but by now it is my best guess. To make this assumption better, the list is shuffled after every step.
  19  *
  20  * After that, the script tries to remove a file from the list. It tests if the list breaks and if so, it
  21  * assumes that the file it removed belongs to the set of erroneous files.
  22  * This is done for all files, so, in the end removing one file leads to a working doc build.
  23  *
  24  * @author Alexander Kampmann
  25  * @author Hypolite Petovan <hypolite@mrpetovan.com>
  26  */
  27 class DocBloxErrorChecker extends \Asika\SimpleConsole\Console
  28 {
  29
  30         protected $helpOptions = ['h', 'help', '?'];
  31
  32         protected function getHelp()
  33         {
  34                 $help = <<<HELP
  35 console docbloxerrorchecker - Checks the file tree for docblox errors
  36 Usage
  37         bin/console docbloxerrorchecker [-h|--help|-?] [-v]
  38
  39 Options
  40     -h|--help|-? Show help information
  41     -v           Show more debug information.
  42 HELP;
  43                 return $help;
  44         }
  45
  46         protected function doExecute()
  47         {
  48                 if ($this->getOption('v')) {
  49                         $this->out('Class: ' . __CLASS__);
  50                         $this->out('Arguments: ' . var_export($this->args, true));
  51                         $this->out('Options: ' . var_export($this->options, true));
  52                 }
  53
  54                 if (count($this->args) > 0) {
  55                         throw new \Asika\SimpleConsole\CommandArgsException('Too many arguments');
  56                 }
  57
  58                 if (!$this->commandExists('docblox')) {
  59                         throw new \RuntimeException('DocBlox isn\'t available.');
  60                 }
  61
  62                 $dir = \get_app()->getBasePath();
  63
  64                 //stack for dirs to search
  65                 $dirstack = [];
  66                 //list of source files
  67                 $filelist = [];
  68
  69                 //loop over all files in $dir
  70                 while ($dh = opendir($dir)) {
  71                         while ($file = readdir($dh)) {
  72                                 if (is_dir($dir . "/" . $file)) {
  73                                         //add to directory stack
  74                                         if (strpos($file, '.') !== 0) {
  75                                                 array_push($dirstack, $dir . "/" . $file);
  76                                                 $this->out('dir ' . $dir . '/' . $file);
  77                                         }
  78                                 } else {
  79                                         //test if it is a source file and add to filelist
  80                                         if (substr($file, strlen($file) - 4) == ".php") {
  81                                                 array_push($filelist, $dir . "/" . $file);
  82                                                 $this->out($dir . '/' . $file);
  83                                         }
  84                                 }
  85                         }
  86                         //look at the next dir
  87                         $dir = array_pop($dirstack);
  88                 }
  89
  90                 //check the entire set
  91                 if ($this->runs($filelist)) {
  92                         throw new \RuntimeException("I can not detect a problem.");
  93                 }
  94
  95                 //check half of the set and discard if that half is okay
  96                 $res = $filelist;
  97                 $i = count($res);
  98                 do {
  99                         $this->out($i . '/' . count($filelist) . ' elements remaining.');
 100                         $res = $this->reduce($res, count($res) / 2);
 101                         shuffle($res);
 102                         $i = count($res);
 103                 } while (count($res) < $i);
 104
 105                 //check one file after another
 106                 $needed = [];
 107
 108                 while (count($res) != 0) {
 109                         $file = array_pop($res);
 110
 111                         if ($this->runs(array_merge($res, $needed))) {
 112                                 $this->out('needs: ' . $file . ' and file count ' . count($needed));
 113                                 array_push($needed, $file);
 114                         }
 115                 }
 116
 117                 $this->out('Smallest Set is: ' . $this->namesList($needed) . ' with ' . count($needed) . ' files. ');
 118
 119                 return 0;
 120         }
 121
 122         private function commandExists($command)
 123         {
 124                 $prefix = strpos(strtolower(PHP_OS),'win') > -1 ? 'where' : 'which';
 125                 exec("{$prefix} {$command}", $output, $returnVal);
 126                 return $returnVal === 0;
 127         }
 128
 129         /**
 130          * This function generates a comma separated list of file names.
 131          *
 132          * @param array $fileset Set of file names
 133          *
 134          * @return string comma-separated list of the file names
 135          */
 136         private function namesList($fileset)
 137         {
 138                 return implode(',', $fileset);
 139         }
 140
 141         /**
 142          * This functions runs phpdoc on the provided list of files
 143          *
 144          * @param array $fileset Set of filenames
 145          *
 146          * @return bool true, if that set can be built
 147          */
 148         private function runs($fileset)
 149         {
 150                 $fsParam = $this->namesList($fileset);
 151                 $this->exec('docblox -t phpdoc_out -f ' . $fsParam);
 152                 if (file_exists("phpdoc_out/index.html")) {
 153                         $this->out('Subset ' . $fsParam . ' is okay.');
 154                         $this->exec('rm -r phpdoc_out');
 155                         return true;
 156                 } else {
 157                         $this->out('Subset ' . $fsParam . ' failed.');
 158                         return false;
 159                 }
 160         }
 161
 162         /**
 163          * This functions cuts down a fileset by removing files until it finally works.
 164          * it was meant to be recursive, but php's maximum stack size is to small. So it just simulates recursion.
 165          *
 166          * In that version, it does not necessarily generate the smallest set, because it may not alter the elements order enough.
 167          *
 168          * @param array $fileset set of filenames
 169          * @param int $ps number of files in subsets
 170          *
 171          * @return array a part of $fileset, that crashes
 172          */
 173         private function reduce($fileset, $ps)
 174         {
 175                 //split array...
 176                 $parts = array_chunk($fileset, $ps);
 177                 //filter working subsets...
 178                 $parts = array_filter($parts, [$this, 'runs']);
 179                 //melt remaining parts together
 180                 if (is_array($parts)) {
 181                         return array_reduce($parts, "array_merge", []);
 182                 }
 183                 return [];
 184         }
 185
 186 }