inc/functions.php

   1 <?php
   2 /** @file
   3  * Functions used by ViewGit.
   4  */
   5
   6 function debug($msg)
   7 {
   8         global $conf;
   9
  10         if ($conf['debug']) {
  11                 file_put_contents('php://stderr', gmstrftime('%H:%M:%S') ." viewgit: $_SERVER[REMOTE_ADDR]:$_SERVER[REMOTE_PORT] $msg\n", FILE_APPEND);
  12         }
  13 }
  14
  15 /**
  16  * Format author's name & wrap it to links etc.
  17  */
  18 function format_author($author)
  19 {
  20         global $page;
  21
  22         if (isset($page['project'])) {
  23                 // FIXME 'h' - use only if available
  24                 return '<a href="'. makelink(array('a' => 'search', 'p' => $page['project'], 'h' => 'HEAD', 'st' => 'author', 's' => $author)) .'">'. htmlentities_wrapper($author) .'</a>';
  25         } else {
  26                 return htmlentities_wrapper($author);
  27         }
  28 }
  29
  30 /**
  31  * Formats "git diff" output into xhtml.
  32  * @return array(array of filenames, xhtml)
  33  */
  34 function format_diff($text)
  35 {
  36         $files = array();
  37
  38         // match every "^diff --git a/<path> b/<path>$" line
  39         foreach (explode("\n", $text) as $line) {
  40                 if (preg_match('#^diff --git a/(.*) b/(.*)$#', $line, $matches) > 0) {
  41                         $files[$matches[1]] = urlencode($matches[1]);
  42                 }
  43         }
  44
  45         $text = htmlentities_wrapper($text);
  46
  47         $text = preg_replace(
  48                 array(
  49                         '/^(\+.*)$/m',
  50                         '/^(-.*)$/m',
  51                         '/^(@.*)$/m',
  52                         '/^([^d\+-@].*)$/m',
  53                 ),
  54                 array(
  55                         '<span class="add">$1</span>',
  56                         '<span class="del">$1</span>',
  57                         '<span class="pos">$1</span>',
  58                         '<span class="etc">$1</span>',
  59                 ),
  60                 $text);
  61         $text = preg_replace_callback('#^diff --git a/(.*) b/(.*)$#m',
  62                 create_function(
  63                         '$m',
  64                         'return "<span class=\"diffline\"><a name=\"". urlencode($m[1]) ."\">diff --git a/$m[1] b/$m[2]</a></span>";'
  65                 ),
  66                 $text);
  67
  68         return array($files, $text);
  69 }
  70
  71 /**
  72  * Get project information from config and git, name/description and HEAD
  73  * commit info are returned in an array.
  74  */
  75 function get_project_info($name)
  76 {
  77         global $conf;
  78
  79         $info = $conf['projects'][$name];
  80         $info['name'] = $name;
  81
  82         // If description is not set, read it from the repository's description
  83         if (!isset($info['description'])) {
  84                 $info['description'] = file_get_contents($info['repo'] .'/description');
  85         }
  86
  87         $headinfo = git_get_commit_info($name, 'HEAD');
  88         $info['head_stamp'] = $headinfo['author_utcstamp'];
  89         $info['head_datetime'] = gmstrftime($conf['datetime'], $headinfo['author_utcstamp']);
  90         $info['head_hash'] = $headinfo['h'];
  91         $info['head_tree'] = $headinfo['tree'];
  92
  93         return $info;
  94 }
  95
  96 /**
  97  * Get diff between given revisions as text.
  98  */
  99 function git_diff($project, $from, $to)
 100 {
 101         return join("\n", run_git($project, "diff \"$from..$to\""));
 102 }
 103
 104 function git_diffstat($project, $commit, $commit_base = null)
 105 {
 106         if (is_null($commit_base)) {
 107                 $commit_base = "$commit^";
 108         }
 109         return join("\n", run_git($project, "diff --stat $commit_base..$commit"));
 110 }
 111
 112 /**
 113  * Get details of a commit: tree, parents, author/committer (name, mail, date), message
 114  */
 115 function git_get_commit_info($project, $hash = 'HEAD', $path = null)
 116 {
 117         global $conf;
 118
 119         $info = array();
 120         $info['h_name'] = $hash;
 121         $info['message_full'] = '';
 122         $info['parents'] = array();
 123
 124         $extra = '';
 125         if (isset($path)) {
 126                 $extra = '-- '. escapeshellarg($path);
 127         }
 128
 129         $output = run_git($project, "rev-list --header --max-count=1 $hash $extra");
 130         // tree <h>
 131         // parent <h>
 132         // author <name> "<"<mail>">" <stamp> <timezone>
 133         // committer
 134         // <empty>
 135         //     <message>
 136         $pattern = '/^(author|committer) ([^<]+) <([^>]*)> ([0-9]+) (.*)$/';
 137         foreach ($output as $line) {
 138                 if (substr($line, 0, 4) === 'tree') {
 139                         $info['tree'] = substr($line, 5);
 140                 }
 141                 // may be repeated multiple times for merge/octopus
 142                 elseif (substr($line, 0, 6) === 'parent') {
 143                         $info['parents'][] = substr($line, 7);
 144                 }
 145                 elseif (preg_match($pattern, $line, $matches) > 0) {
 146                         $info[$matches[1] .'_name'] = $matches[2];
 147                         $info[$matches[1] .'_mail'] = $matches[3];
 148                         $info[$matches[1] .'_stamp'] = $matches[4] + ((intval($matches[5]) / 100.0) * 3600);
 149                         $info[$matches[1] .'_timezone'] = $matches[5];
 150                         $info[$matches[1] .'_utcstamp'] = $matches[4];
 151
 152                         if (isset($conf['mail_filter'])) {
 153                                 $info[$matches[1] .'_mail'] = $conf['mail_filter']($info[$matches[1] .'_mail']);
 154                         }
 155                 }
 156                 // Lines starting with four spaces and empty lines after first such line are part of commit message
 157                 elseif (substr($line, 0, 4) === '    ' || (strlen($line) == 0 && isset($info['message']))) {
 158                         $info['message_full'] .= substr($line, 4) ."\n";
 159                         if (!isset($info['message'])) {
 160                                 $info['message'] = substr($line, 4, $conf['commit_message_maxlen']);
 161                                 $info['message_firstline'] = substr($line, 4);
 162                         }
 163                 }
 164                 elseif (preg_match('/^[0-9a-f]{40}$/', $line) > 0) {
 165                         $info['h'] = $line;
 166                 }
 167         }
 168
 169         // This is a workaround for the unlikely situation where a commit does
 170         // not have a message. Such a commit can be created with the following
 171         // command:
 172         // git commit --allow-empty -m '' --cleanup=verbatim
 173         if (!array_key_exists('message', $info)) {
 174                 $info['message'] = '(no message)';
 175                 $info['message_firstline'] = '(no message)';
 176         }
 177
 178         $info['author_datetime'] = gmstrftime($conf['datetime_full'], $info['author_utcstamp']);
 179         $info['author_datetime_local'] = gmstrftime($conf['datetime_full'], $info['author_stamp']) .' '. $info['author_timezone'];
 180         $info['committer_datetime'] = gmstrftime($conf['datetime_full'], $info['committer_utcstamp']);
 181         $info['committer_datetime_local'] = gmstrftime($conf['datetime_full'], $info['committer_stamp']) .' '. $info['committer_timezone'];
 182
 183         $info['affected_files'] = array();
 184         $affected_files = run_git($project, "show --pretty=\"format:\" --name-only $hash");
 185         foreach ($affected_files as $file ) {
 186                 // The format above contains a blank line; Skip it.
 187                 if ($file == '') {
 188                         continue;
 189                 }
 190
 191                 $output = run_git($project, "ls-tree $hash $file");
 192                 foreach ($output as $line) {
 193                         $parts = preg_split('/\s+/', $line, 4);
 194                         $info['affected_files'][] = array('name' => $parts[3], 'hash' => $parts[2]);
 195                 }
 196         }
 197
 198         return $info;
 199 }
 200
 201 /**
 202  * Get list of heads (branches) for a project.
 203  */
 204 function git_get_heads($project)
 205 {
 206         $heads = array();
 207
 208         $output = run_git($project, 'show-ref --heads');
 209         foreach ($output as $line) {
 210                 $fullname = substr($line, 41);
 211                 $tmp = explode('/', $fullname);
 212                 $name = array_pop($tmp);
 213                 $heads[] = array('h' => substr($line, 0, 40), 'fullname' => "$fullname", 'name' => "$name");
 214         }
 215
 216         return $heads;
 217 }
 218
 219 /**
 220  * Get array containing path information for parts, starting from root_hash.
 221  *
 222  * @param root_hash commit/tree hash for the root tree
 223  * @param path path
 224  */
 225 function git_get_path_info($project, $root_hash, $path)
 226 {
 227         if (strlen($path) > 0) {
 228                 $parts = explode('/', $path);
 229         } else {
 230                 $parts = array();
 231         }
 232
 233         $pathinfo = array();
 234
 235         $tid = $root_hash;
 236         $pathinfo = array();
 237         foreach ($parts as $p) {
 238                 $entry = git_ls_tree_part($project, $tid, $p);
 239                 if (is_null($entry)) {
 240                         die("Invalid path info: $path");
 241                 }
 242                 $pathinfo[] = $entry;
 243                 $tid = $entry['hash'];
 244         }
 245
 246         return $pathinfo;
 247 }
 248
 249 /**
 250  * Get revision list starting from given commit.
 251  * @param skip how many hashes to skip from the beginning
 252  * @param max_count number of commit hashes to return, or all if not given
 253  * @param start revision to start from, or HEAD if not given
 254  */
 255 function git_get_rev_list($project, $skip = 0, $max_count = null, $start = 'HEAD')
 256 {
 257         $cmd = "rev-list ";
 258         if ($skip != 0) {
 259                 $cmd .= "--skip=$skip ";
 260         }
 261         if (!is_null($max_count)) {
 262                 $cmd .= "--max-count=$max_count ";
 263         }
 264         $cmd .= $start;
 265
 266         return run_git($project, $cmd);
 267 }
 268
 269 /**
 270  * Get list of tags for a project.
 271  */
 272 function git_get_tags($project)
 273 {
 274         $tags = array();
 275
 276         $output = run_git($project, 'show-ref --tags');
 277         foreach ($output as $line) {
 278                 $fullname = substr($line, 41);
 279                 $tmp = explode('/', $fullname);
 280                 $name = array_pop($tmp);
 281                 $tags[] = array('h' => substr($line, 0, 40), 'fullname' => $fullname, 'name' => $name);
 282         }
 283         return $tags;
 284 }
 285
 286 /**
 287  * Get information about objects in a tree.
 288  * @param tree tree or commit hash
 289  * @return list of arrays containing name, mode, type, hash
 290  */
 291 function git_ls_tree($project, $tree)
 292 {
 293         $entries = array();
 294         $output = run_git($project, "ls-tree $tree");
 295         // 100644 blob 493b7fc4296d64af45dac64bceac2d9a96c958c1    .gitignore
 296         // 040000 tree 715c78b1011dc58106da2a1af2fe0aa4c829542f    doc
 297         foreach ($output as $line) {
 298                 $parts = preg_split('/\s+/', $line, 4);
 299                 $entries[] = array('name' => $parts[3], 'mode' => $parts[0], 'type' => $parts[1], 'hash' => $parts[2]);
 300         }
 301
 302         return $entries;
 303 }
 304
 305 /**
 306  * Get information about the given object in a tree, or null if not in the tree.
 307  */
 308 function git_ls_tree_part($project, $tree, $name)
 309 {
 310         $entries = git_ls_tree($project, $tree);
 311         foreach ($entries as $entry) {
 312                 if ($entry['name'] === $name) {
 313                         return $entry;
 314                 }
 315         }
 316         return null;
 317 }
 318
 319 /**
 320  * Get the ref list as dict: hash -> list of names.
 321  * @param tags whether to show tags
 322  * @param heads whether to show heads
 323  * @param remotes whether to show remote heads, currently implies tags and heads too.
 324  */
 325 function git_ref_list($project, $tags = true, $heads = true, $remotes = true)
 326 {
 327         $cmd = "show-ref --dereference";
 328         if (!$remotes) {
 329                 if ($tags) { $cmd .= " --tags"; }
 330                 if ($heads) { $cmd .= " --heads"; }
 331         }
 332
 333         $result = array();
 334         $output = run_git($project, $cmd);
 335         foreach ($output as $line) {
 336                 // <hash> <ref>
 337                 $parts = explode(' ', $line, 2);
 338                 $name = str_replace(array('refs/', '^{}'), array('', ''), $parts[1]);
 339                 $result[$parts[0]][] = $name;
 340         }
 341         return $result;
 342 }
 343
 344 /**
 345  * Find commits based on search type and string.
 346  */
 347 function git_search_commits($project, $branch, $type, $string)
 348 {
 349         // git log -sFOO
 350         if ($type == 'change') {
 351                 $cmd = 'log -S'. escapeshellarg($string);
 352         }
 353         elseif ($type == 'commit') {
 354                 $cmd = 'log -i --grep='. escapeshellarg($string);
 355         }
 356         elseif ($type == 'author') {
 357                 $cmd = 'log -i --author='. escapeshellarg($string);
 358         }
 359         elseif ($type == 'committer') {
 360                 $cmd = 'log -i --committer='. escapeshellarg($string);
 361         }
 362         else {
 363                 die('Unsupported type');
 364         }
 365         $cmd .= ' '. $branch;
 366         $lines = run_git($project, $cmd);
 367
 368         $result = array();
 369         foreach ($lines as $line) {
 370                 if (preg_match('/^commit (.*?)$/', $line, $matches)) {
 371                         $result[] = $matches[1];
 372                 }
 373         }
 374         return $result;
 375 }
 376
 377 /**
 378  * Get shortlog entries for the given project.
 379  */
 380 function handle_shortlog($project, $hash = 'HEAD', $page = 0)
 381 {
 382         global $conf;
 383
 384         $refs_by_hash = git_ref_list($project, true, true, $conf['shortlog_remote_labels']);
 385
 386         $result = array();
 387         $revs = git_get_rev_list($project, $page * $conf['summary_shortlog'], $conf['summary_shortlog'], $hash);
 388         foreach ($revs as $rev) {
 389                 $info = git_get_commit_info($project, $rev);
 390                 $refs = array();
 391                 if (in_array($rev, array_keys($refs_by_hash))) {
 392                         $refs = $refs_by_hash[$rev];
 393                 }
 394                 $result[] = array(
 395                         'author' => $info['author_name'],
 396                         'date' => gmstrftime($conf['datetime'], $info['author_utcstamp']),
 397                         'message' => $info['message'],
 398                         'commit_id' => $rev,
 399                         'tree' => $info['tree'],
 400                         'refs' => $refs,
 401                 );
 402         }
 403         #print_r($result);
 404         #die();
 405
 406         return $result;
 407 }
 408
 409 /**
 410  * Fetch tags data, newest first.
 411  *
 412  * @param limit maximum number of tags to return
 413  */
 414 function handle_tags($project, $limit = 0)
 415 {
 416         global $conf;
 417
 418         $tags = git_get_tags($project);
 419         $result = array();
 420         foreach ($tags as $tag) {
 421                 $info = git_get_commit_info($project, $tag['h']);
 422                 $result[] = array(
 423                         'stamp' => $info['author_utcstamp'],
 424                         'date' => gmstrftime($conf['datetime'], $info['author_utcstamp']),
 425                         'h' => $tag['h'],
 426                         'fullname' => $tag['fullname'],
 427                         'name' => $tag['name'],
 428                 );
 429         }
 430
 431         // sort tags newest first
 432         // aka. two more reasons to hate PHP (figuring those out is your homework:)
 433         usort($result, create_function(
 434                 '$x, $y',
 435                 '$a = $x["stamp"]; $b = $y["stamp"]; return ($a == $b ? 0 : ($a > $b ? -1 : 1));'
 436         ));
 437
 438         // TODO optimize this some way, currently all tags are fetched when only a
 439         // few are shown. The problem is that without fetching the commit info
 440         // above, we can't sort using dates, only by tag name...
 441         if ($limit > 0) {
 442                 $result = array_splice($result, 0, $limit);
 443         }
 444
 445         return $result;
 446 }
 447
 448 function htmlentities_wrapper($text)
 449 {
 450         return htmlentities(@iconv('UTF-8', 'UTF-8//IGNORE', $text), ENT_NOQUOTES, 'UTF-8');
 451 }
 452
 453 function xmlentities_wrapper($text)
 454 {
 455         return str_replace(array('&', '<'), array('&#x26;', '&#x3C;'), @iconv('UTF-8', 'UTF-8//IGNORE', $text));
 456 }
 457
 458 /**
 459  * Return a URL that contains the given parameters.
 460  */
 461 function makelink($dict)
 462 {
 463         $params = array();
 464         foreach ($dict as $k => $v) {
 465                 $params[] = rawurlencode($k) .'='. str_replace('%2F', '/', rawurlencode($v));
 466         }
 467         if (count($params) > 0) {
 468                 return '?'. htmlentities_wrapper(join('&', $params));
 469         }
 470         return '';
 471 }
 472
 473 /**
 474  * Obfuscate the e-mail address.
 475  */
 476 function obfuscate_mail($mail)
 477 {
 478         return str_replace(array('@', '.'), array(' at ', ' dot '), $mail);
 479 }
 480
 481 /**
 482  * Used to format RSS item title and description.
 483  *
 484  * @param info commit info from git_get_commit_info()
 485  */
 486 function rss_item_format($format, $info)
 487 {
 488         return preg_replace(array(
 489                 '/{AUTHOR}/',
 490                 '/{AUTHOR_MAIL}/',
 491                 '/{SHORTLOG}/',
 492                 '/{LOG}/',
 493                 '/{COMMITTER}/',
 494                 '/{COMMITTER_MAIL}/',
 495                 '/{DIFFSTAT}/',
 496         ), array(
 497                 htmlentities_wrapper($info['author_name']),
 498                 htmlentities_wrapper($info['author_mail']),
 499                 htmlentities_wrapper($info['message_firstline']),
 500                 htmlentities_wrapper($info['message_full']),
 501                 htmlentities_wrapper($info['committer_name']),
 502                 htmlentities_wrapper($info['committer_mail']),
 503                 htmlentities_wrapper(isset($info['diffstat']) ? $info['diffstat'] : ''),
 504         ), $format);
 505 }
 506
 507 function rss_pubdate($secs)
 508 {
 509         return gmdate('D, d M Y H:i:s O', $secs);
 510 }
 511
 512 /**
 513  * Executes a git command in the project repo.
 514  * @return array of output lines
 515  */
 516 function run_git($project, $command)
 517 {
 518         global $conf;
 519
 520         $output = array();
 521         $cmd = $conf['git'] ." --git-dir=". escapeshellarg($conf['projects'][$project]['repo']) ." $command";
 522         $ret = 0;
 523         exec($cmd, $output, $ret);
 524         if ($conf['debug_command_trace']) {
 525                 static $count = 0;
 526                 $count++;
 527                 trigger_error("[$count]\$ $cmd [exit $ret]");
 528         }
 529         //if ($ret != 0) { die('FATAL: exec() for git failed, is the path properly configured?'); }
 530         return $output;
 531 }
 532
 533 /**
 534  * Executes a git command in the project repo, sending output directly to the
 535  * client.
 536  */
 537 function run_git_passthru($project, $command)
 538 {
 539         global $conf;
 540
 541         $cmd = $conf['git'] ." --git-dir=". escapeshellarg($conf['projects'][$project]['repo']) ." $command";
 542         $result = 0;
 543         passthru($cmd, $result);
 544         return $result;
 545 }
 546
 547 /**
 548  * Makes sure the given project is valid. If it's not, this function will
 549  * die().
 550  * @return the project
 551  */
 552 function validate_project($project)
 553 {
 554         global $conf;
 555
 556         if (!in_array($project, array_keys($conf['projects']))) {
 557                 die('Invalid project');
 558         }
 559         return $project;
 560 }
 561
 562 /**
 563  * Makes sure the given hash is valid. If it's not, this function will die().
 564  * @return the hash
 565  */
 566 function validate_hash($hash)
 567 {
 568         if (!preg_match('/^[0-9a-z]{40}$/', $hash) && !preg_match('!^refs/(heads|tags)/[-_.0-9a-zA-Z]+$!', $hash) && $hash !== 'HEAD') {
 569                 die('Invalid hash');
 570
 571         }
 572         return $hash;
 573 }
 574
 575 /**
 576  * Custom error handler for ViewGit. The errors are pushed to $page['notices']
 577  * and displayed by templates/header.php.
 578  */
 579 function vg_error_handler($errno, $errstr, $errfile, $errline)
 580 {
 581         global $page;
 582
 583         $mask = ini_get('error_reporting');
 584
 585         $class = 'error';
 586
 587         // If mask for this error is not enabled, return silently
 588         if (!($errno & $mask)) {
 589                 return true;
 590         }
 591
 592         // Remove any preceding path until viewgit's directory
 593         $file = $errfile;
 594         $file = strstr($file, 'viewgit/');
 595
 596         $message = "$file:$errline $errstr [$errno]";
 597
 598         switch ($errno) {
 599                 case E_ERROR:
 600                         $class = 'error';
 601                         break;
 602                 case E_WARNING:
 603                         $class = 'warning';
 604                         break;
 605                 case E_NOTICE:
 606                 case E_STRICT:
 607                 default:
 608                         $class = 'info';
 609                         break;
 610         }
 611
 612         $page['notices'][] = array(
 613                 'message' => $message,
 614                 'class' => $class,
 615         );
 616
 617         return true;
 618 }
 619