includes/svnlib.php

   1 <?php
   2 /*=====================================================================*\
   3 || ###################################################################
   4 || # ViewSVN [#]version[#]
   5 || # Copyright ©2002-[#]year[#] Iris Studios, Inc.
   6 || #
   7 || # This program is free software; you can redistribute it and/or modify
   8 || # it under the terms of the GNU General Public License as published by
   9 || # the Free Software Foundation; version [#]gpl[#] of the License.
  10 || #
  11 || # This program is distributed in the hope that it will be useful, but
  12 || # WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  13 || # or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
  14 || # more details.
  15 || #
  16 || # You should have received a copy of the GNU General Public License along
  17 || # with this program; if not, write to the Free Software Foundation, Inc.,
  18 || # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
  19 || ###################################################################
  20 \*=====================================================================*/
  21
  22 /**
  23 * Command line library and SVN-PHP bridge extension
  24 *
  25 * @package      ViewSVN
  26 */
  27
  28 /**
  29 * This class acts as the bridge between the command line Xquery class
  30 * and the various display files. It handles preparation of Xquery
  31 * code.
  32 *
  33 * @package      ViewSVN
  34 * @version      $Id$
  35 */
  36 class SVNLib
  37 {
  38         /**
  39         * Path to the SVN binary
  40         * @var  string
  41         * @access       private
  42         */
  43         var $svnpath;
  44
  45         /**
  46         * Controller
  47         * @var  object
  48         * @access       private
  49         */
  50         var $controller;
  51
  52         // ###################################################################
  53         /**
  54         * Constructor: validate SVN path
  55         *
  56         * @param        object  Controller
  57         */
  58         function SVNLib(&$controller)
  59         {
  60                 $this->controller =& $controller;
  61
  62                 $this->svnpath =& $this->controller->xquery->cmd($this->controller->registry->svnpath);
  63
  64                 $access = $this->controller->xquery->exec($this->svnpath . ' --version');
  65
  66                 if (!$access)
  67                 {
  68                         $this->controller->registry->trigger->error($this->controller->registry->lang->string('The SVN binary could not be located'));
  69                 }
  70
  71                 if (!preg_match('#^svn, version (.*?)\)$#i', trim($access[0])))
  72                 {
  73                         $this->controller->registry->trigger->error($this->controller->registry->lang->string('The SVN binary does not appear to be valid (it failed our tests)'));
  74                 }
  75         }
  76
  77         // ###################################################################
  78         /**
  79         * Executes the SVN binary
  80         *
  81         * @access       private
  82         *
  83         * @param        string  Command
  84         *
  85         * @return       array   Output
  86         */
  87         function svn($command)
  88         {
  89                 $output = $this->controller->xquery->exec($this->svnpath . ' ' . $command . ' 2>&1');
  90
  91                 $temp = implode("\n", $output);
  92                 if (strpos($temp, '(apr' . '_err=') !== false)
  93                 {
  94                         $this->controller->registry->trigger->error(nl2br($temp));
  95                 }
  96                 return $output;
  97         }
  98
  99         // ###################################################################
 100         /**
 101         * This function is used to prepare a common command. It sends the
 102         * specified command along with the repository path and the current
 103         * node. The revision is either fectched from the argument list or
 104         * from the node, too.
 105         *
 106         * @access       public
 107         *
 108         * @param        string  SVN command
 109         * @param        bool    Alternate revision
 110         *
 111         * @return       array   Lines of output
 112         */
 113         function command($command, $rev = false)
 114         {
 115                 global $viewsvn;
 116
 117                 $revision = ($rev !== false ? $rev : SVNCommon::rev($this->controller->revnum));
 118
 119                 return $this->svn($command . ' ' . $this->controller->repospath . $this->controller->path . ($revision !== null ? '@' . $revision : ''));
 120         }
 121
 122         // ###################################################################
 123         /**
 124         * A library complicator function that handles the diff command because
 125         * the standard command() system does not work with more complex args.
 126         *
 127         * @access       public
 128         *
 129         * @param        integer Lower revision
 130         * @param        integer Higher revision
 131         *
 132         * @return       array   Lines of diff output
 133         */
 134         function diff($lorev, $hirev)
 135         {
 136                 global $viewsvn;
 137
 138                 $hirev = SVNCommon::rev($hirev);
 139                 $lorev = SVNCommon::rev($lorev);
 140                 if ($lorev == 'HEAD')
 141                 {
 142                         $lorev = 1;
 143                 }
 144
 145                 if (is_integer($hirev) AND is_integer($lorev))
 146                 {
 147                         if ($lorev > $hirev)
 148                         {
 149                                 $lorev = $hirev - 1;
 150                         }
 151                         if ($lorev == $hirev)
 152                         {
 153                                 $lorev = 0;
 154                         }
 155                 }
 156
 157                 return $this->svn('diff -r' . $lorev . ':' . $hirev . ' ' . $this->controller->repospath . $this->controller->path);
 158         }
 159
 160         // ###################################################################
 161         /**
 162         * A library complicator function to create log output. This is needed
 163         * because command() doesn't handle ranged revisions.
 164         *
 165         * @access       public
 166         *
 167         * @param        string  Repository
 168         * @param        string  Path
 169         * @param        integer Lower revision
 170         * @param        integer Higher revision
 171         *
 172         * @return       array   Lines of log output
 173         */
 174         function log($lorev, $hirev)
 175         {
 176                 global $viewsvn;
 177
 178                 $hirev = $this->rev($hirev);
 179                 $lorev = $this->rev($hirev);
 180                 if ($lorev == 'HEAD')
 181                 {
 182                         $lorev = 0;
 183                 }
 184
 185                 if (is_integer($hirev) AND is_integer($lorev))
 186                 {
 187                         if ($lorev > $hirev)
 188                         {
 189                                 $lorev = $hirev - 1;
 190                         }
 191                         if ($lorev == $hirev)
 192                         {
 193                                 $lorev = 0;
 194                         }
 195                 }
 196
 197                 $repospath = $viewsvn->repos->fetch_path($repos, false);
 198
 199                 return $this->svn('log -v -r' . $hirev . ':' . $lorev . ' ' . $repospath . $path);
 200         }
 201 }
 202
 203 /**
 204 * Annotation/blame system; constructs an array that is ready for output
 205 *
 206 * @package      ViewSVN
 207 * @version      $Id$
 208 */
 209 class SVNBlame
 210 {
 211         /**
 212         * Array of blame information
 213         * @var  array
 214         * @access       private
 215         */
 216         var $blame = array();
 217
 218         /**
 219         * Raw "svn blame" output
 220         * @var  array
 221         * @access       private
 222         */
 223         var $rawoutput;
 224
 225         // ###################################################################
 226         /**
 227         * Constructor: create blame and store data
 228         *
 229         * @param        object  Controller
 230         */
 231         function SVNBlame(&$controller)
 232         {
 233                 $this->rawoutput = $controller->library->command('blame');
 234                 $this->process();
 235         }
 236
 237         // ###################################################################
 238         /**
 239         * Returns blame for display
 240         *
 241         * @access       public
 242         *
 243         * @return       array   Blame data
 244         */
 245         function fetch()
 246         {
 247                 return $this->blame;
 248         }
 249
 250         // ###################################################################
 251         /**
 252         * Parses the blame data
 253         *
 254         * @access       private
 255         */
 256         function process()
 257         {
 258                 $lineno = 1;
 259
 260                 foreach ($this->rawoutput AS $line)
 261                 {
 262                         if (preg_match('#^\s+([0-9]+)\s+([\w\.\-_]+)\s(.*)$#', $line, $matches))
 263                         {
 264                                 $this->blame[] = array(
 265                                         'rev'           => $matches[1],
 266                                         'author'        => $matches[2],
 267                                         'line'          => $matches[3],
 268                                         'lineno'        => $lineno++
 269                                 );
 270                         }
 271                         // a blank line
 272                         else if (preg_match('#^\s+([0-9]+)\s+([\w\.\-_]+)$#', $line, $matches))
 273                         {
 274                                 $this->blame[] = array(
 275                                         'rev'           => $matches[1],
 276                                         'author'        => $matches[2],
 277                                         'line'          => '',
 278                                         'lineno'        => $lineno++
 279                                 );
 280                         }
 281                 }
 282         }
 283 }
 284
 285 /**
 286 * Diff system; constructs a diff array that is ready for output
 287 *
 288 * @package      ViewSVN
 289 * @version      $Id$
 290 */
 291 class SVNDiff
 292 {
 293         /**
 294         * Array of diff information
 295         * @var  array
 296         * @access       private
 297         */
 298         var $diff = array();
 299
 300         /**
 301         * Raw "svn diff" output
 302         * @var  array
 303         * @access       private
 304         */
 305         var $rawoutput;
 306
 307         // ###################################################################
 308         /**
 309         * Constructor: create and store diff data
 310         *
 311         * @param        object  Controller
 312         * @param        integer Lower revision
 313         * @param        integer Higher revision
 314         */
 315         function SVNDiff(&$controller, $lorev, $hirev)
 316         {
 317                 $this->rawoutput = $controller->library->diff($lorev, $hirev);
 318                 $this->process();
 319         }
 320
 321         // ###################################################################
 322         /**
 323         * Returns diffs for display
 324         *
 325         * @access       public
 326         *
 327         * @return       array   Diff data
 328         */
 329         function fetch()
 330         {
 331                 return $this->diff;
 332         }
 333
 334         // ###################################################################
 335         /**
 336         * Processes and prepares diff data
 337         *
 338         * @access       private
 339         */
 340         function process()
 341         {
 342                 global $viewsvn;
 343
 344                 $chunk = 0;
 345                 $indexcounter = null;
 346                 $curprop = '';
 347
 348                 $delstack = array();
 349
 350                 foreach ($this->rawoutput AS $line)
 351                 {
 352                         if (preg_match('#^@@ \-([0-9]*),([0-9]*) \+([0-9]*),([0-9]*) @@$#', $line, $bits))
 353                         {
 354                                 $property = false;
 355                                 $delstack = array();
 356                                 $this->diff["$index"][ ++$chunk ]['hunk'] = array('old' => array('line' => $bits[1], 'count' => $bits[2]), 'new' => array('line' => $bits[3], 'count' => $bits[4]));
 357                                 $lines['old'] = $this->diff["$index"]["$chunk"]['hunk']['old']['line'] - 1;
 358                                 $lines['new'] = $this->diff["$index"]["$chunk"]['hunk']['new']['line'] - 1;
 359                                 continue;
 360                         }
 361                         else if (preg_match('#^Property changes on: (.*?)$#', $line, $bits))
 362                         {
 363                                 $property = true;
 364                                 $index = $bits[1];
 365                                 $this->diff["$index"]['props'] = array();
 366                                 continue;
 367                         }
 368
 369                         if ($indexcounter <= 3 AND $indexcounter !== null)
 370                         {
 371                                 $indexcounter++;
 372                                 continue;
 373                         }
 374                         else if ($indexcounter == 3)
 375                         {
 376                                 $indexcounter = null;
 377                                 continue;
 378                         }
 379
 380                         if (preg_match('#^([\+\- ])(.*)#', $line, $matches) AND !$property)
 381                         {
 382                                 $act = $matches[1];
 383                                 $content = $matches[2];
 384
 385                                 if ($act == ' ')
 386                                 {
 387                                         $this->diff["$index"]["$chunk"][] = array(
 388                                                 'line'          => $content,
 389                                                 'act'           => '',
 390                                                 'oldlineno'     => ++$lines['old'],
 391                                                 'newlineno'     => ++$lines['new']
 392                                         );
 393
 394                                         $delstack = array();
 395                                 }
 396                                 else if ($act == '+')
 397                                 {
 398                                         // potential line delta
 399                                         if (sizeof($delstack) > 0)
 400                                         {
 401                                                 $lastline = array_shift($delstack);
 402
 403                                                 if ($delta = @$this->fetch_diff_extent($lastline['line'], $content))
 404                                                 {
 405                                                         if (strlen($lastline['line']) > ($delta['start'] - $delta['end']))
 406                                                         {
 407                                                                 $end = strlen($lastline['line']) + $delta['end'];
 408                                                                 $viewsvn->debug("RM delta- = " . $end);
 409                                                                 $change = '{@-' . '-}' . substr($lastline['line'], $delta['start'], $end - $delta['start']) . '{/@-' . '-}';
 410                                                                 $this->diff["$index"]["$chunk"]["$lastline[INDEX]"]['line'] = substr($lastline['line'], 0, $delta['start']) . $change . substr($lastline['line'], $end);
 411                                                         }
 412
 413                                                         if (strlen($content) > $delta['start'] - $delta['end'])
 414                                                         {
 415                                                                 $end = strlen($content) + $delta['end'];
 416                                                                 $viewsvn->debug("MK delta+ = " . $end);
 417                                                                 $change = '{@+' . '+}' . substr($content, $delta['start'], $end - $delta['start']) . '{/@+' . '+}';
 418                                                                 $content = substr($content, 0, $delta['start']) . $change . substr($content, $end);
 419                                                         }
 420                                                 }
 421                                         }
 422
 423                                         $this->diff["$index"]["$chunk"][] = array(
 424                                                 'line'          => $content,
 425                                                 'act'           => '+',
 426                                                 'oldlineno'     => '',
 427                                                 'newlineno'     => ++$lines['new']
 428                                         );
 429                                 }
 430                                 else if ($act == '-')
 431                                 {
 432                                         $this->diff["$index"]["$chunk"][] = $thearray = array(
 433                                                 'line'          => $content,
 434                                                 'act'           => '-',
 435                                                 'oldlineno'     => ++$lines['old'],
 436                                                 'newlineno'     => ''
 437                                         );
 438
 439                                         $key = sizeof($this->diff["$index"]["$chunk"]) - 2;
 440                                         $thearray['INDEX'] = $key;
 441
 442                                         array_push($delstack, $thearray);
 443                                 }
 444                         }
 445                         // whitespace lines
 446                         else
 447                         {
 448                                 if (preg_match('#^Index: (.*?)$#', $line, $matches))
 449                                 {
 450                                         $index = $matches[1];
 451                                         $indexcounter = 1;
 452                                         $chunk = 0;
 453                                         continue;
 454                                 }
 455
 456                                 if ($property)
 457                                 {
 458                                         if (preg_match('#^__*_$#', trim($line)))
 459                                         {
 460                                                 $viewsvn->debug("skipping: $line");
 461                                                 continue;
 462                                         }
 463
 464                                         if (preg_match('#Name: (.*?)$#', $line, $matches))
 465                                         {
 466                                                 $curprop = $matches[1];
 467                                                 $viewsvn->debug("prop: $curprop");
 468                                                 continue;
 469                                         }
 470                                         else
 471                                         {
 472                                                 if (preg_match('#^\s+?\+(.*)#', $line, $matches))
 473                                                 {
 474                                                         $mode = 'add';
 475                                                         $this->diff["$index"]['props']["$curprop"]['add'] .= $matches[1];
 476                                                 }
 477                                                 else if (preg_match('#^\s+?\-(.*)#', $line, $matches))
 478                                                 {
 479                                                         $mode = 'del';
 480                                                         $this->diff["$index"]['props']["$curprop"]['del'] .= $matches[1];
 481                                                 }
 482                                                 else if (!preg_match('#^\s+[\+\- ](.*)#', $line) AND trim($line) != '')
 483                                                 {
 484                                                         $this->diff["$index"]['props']["$curprop"]["$mode"] .= "\n" . $line;
 485                                                 }
 486                                                 continue;
 487                                         }
 488                                 }
 489
 490                                 $this->diff["$index"]["$chunk"][] = array(
 491                                         'line'          => '',
 492                                         'act'           => '',
 493                                         'oldlineno'     => ++$lines['old'],
 494                                         'newlineno'     => ++$lines['new']
 495                                 );
 496
 497                                 $delstack = array();
 498                         }
 499                 }
 500         }
 501
 502         // ###################################################################
 503         /**
 504         * Returns the amount of change that occured between two lines
 505         *
 506         * @access       private
 507         *
 508         * @param        string  Old line
 509         * @param        string  New line
 510         *
 511         * @return       array   Difference of positions
 512         */
 513         function fetch_diff_extent($old, $new)
 514         {
 515                 global $viewsvn;
 516
 517                 $start = 0;
 518                 $min = min(strlen($old), strlen($new));
 519
 520                 $viewsvn->debug("min1 = $min");
 521
 522                 while ($start < $min AND $old["$start"] == $new["$start"])
 523                 {
 524                         $start++;
 525                 }
 526
 527                 $end = -1;
 528                 $min = $min - $start;
 529
 530                 $viewsvn->debug("min2 = $min");
 531
 532                 $viewsvn->debug("checking: " . $old[ strlen($old) + $end ] . ' ==  ' . $new[ strlen($new) + $end ]);
 533
 534                 while (-$end <= $min AND $old[ strlen($old) + $end ] == $new[ strlen($new) + $end ])
 535                 {
 536                         $end--;
 537                 }
 538
 539                 return array('start' => $start, 'end' => $end + 1);
 540         }
 541 }
 542
 543 /*=====================================================================*\
 544 || ###################################################################
 545 || # $HeadURL$
 546 || # $Id$
 547 || ###################################################################
 548 \*=====================================================================*/
 549 ?>