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