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         return $info;
 184 }
 185
 186 /**
 187  * Get list of heads (branches) for a project.
 188  */
 189 function git_get_heads($project)
 190 {
 191         $heads = array();
 192
 193         $output = run_git($project, 'show-ref --heads');
 194         foreach ($output as $line) {
 195                 $fullname = substr($line, 41);
 196                 $tmp = explode('/', $fullname);
 197                 $name = array_pop($tmp);
 198                 $heads[] = array('h' => substr($line, 0, 40), 'fullname' => "$fullname", 'name' => "$name");
 199         }
 200
 201         return $heads;
 202 }
 203
 204 /**
 205  * Get array containing path information for parts, starting from root_hash.
 206  *
 207  * @param root_hash commit/tree hash for the root tree
 208  * @param path path
 209  */
 210 function git_get_path_info($project, $root_hash, $path)
 211 {
 212         if (strlen($path) > 0) {
 213                 $parts = explode('/', $path);
 214         } else {
 215                 $parts = array();
 216         }
 217
 218         $pathinfo = array();
 219
 220         $tid = $root_hash;
 221         $pathinfo = array();
 222         foreach ($parts as $p) {
 223                 $entry = git_ls_tree_part($project, $tid, $p);
 224                 if (is_null($entry)) {
 225                         die("Invalid path info: $path");
 226                 }
 227                 $pathinfo[] = $entry;
 228                 $tid = $entry['hash'];
 229         }
 230
 231         return $pathinfo;
 232 }
 233
 234 /**
 235  * Get revision list starting from given commit.
 236  * @param skip how many hashes to skip from the beginning
 237  * @param max_count number of commit hashes to return, or all if not given
 238  * @param start revision to start from, or HEAD if not given
 239  */
 240 function git_get_rev_list($project, $skip = 0, $max_count = null, $start = 'HEAD')
 241 {
 242         $cmd = "rev-list ";
 243         if ($skip != 0) {
 244                 $cmd .= "--skip=$skip ";
 245         }
 246         if (!is_null($max_count)) {
 247                 $cmd .= "--max-count=$max_count ";
 248         }
 249         $cmd .= $start;
 250
 251         return run_git($project, $cmd);
 252 }
 253
 254 /**
 255  * Get list of tags for a project.
 256  */
 257 function git_get_tags($project)
 258 {
 259         $tags = array();
 260
 261         $output = run_git($project, 'show-ref --tags');
 262         foreach ($output as $line) {
 263                 $fullname = substr($line, 41);
 264                 $tmp = explode('/', $fullname);
 265                 $name = array_pop($tmp);
 266                 $tags[] = array('h' => substr($line, 0, 40), 'fullname' => $fullname, 'name' => $name);
 267         }
 268         return $tags;
 269 }
 270
 271 /**
 272  * Get information about objects in a tree.
 273  * @param tree tree or commit hash
 274  * @return list of arrays containing name, mode, type, hash
 275  */
 276 function git_ls_tree($project, $tree)
 277 {
 278         $entries = array();
 279         $output = run_git($project, "ls-tree $tree");
 280         // 100644 blob 493b7fc4296d64af45dac64bceac2d9a96c958c1    .gitignore
 281         // 040000 tree 715c78b1011dc58106da2a1af2fe0aa4c829542f    doc
 282         foreach ($output as $line) {
 283                 $parts = preg_split('/\s+/', $line, 4);
 284                 $entries[] = array('name' => $parts[3], 'mode' => $parts[0], 'type' => $parts[1], 'hash' => $parts[2]);
 285         }
 286
 287         return $entries;
 288 }
 289
 290 /**
 291  * Get information about the given object in a tree, or null if not in the tree.
 292  */
 293 function git_ls_tree_part($project, $tree, $name)
 294 {
 295         $entries = git_ls_tree($project, $tree);
 296         foreach ($entries as $entry) {
 297                 if ($entry['name'] === $name) {
 298                         return $entry;
 299                 }
 300         }
 301         return null;
 302 }
 303
 304 /**
 305  * Get the ref list as dict: hash -> list of names.
 306  * @param tags whether to show tags
 307  * @param heads whether to show heads
 308  * @param remotes whether to show remote heads, currently implies tags and heads too.
 309  */
 310 function git_ref_list($project, $tags = true, $heads = true, $remotes = true)
 311 {
 312         $cmd = "show-ref --dereference";
 313         if (!$remotes) {
 314                 if ($tags) { $cmd .= " --tags"; }
 315                 if ($heads) { $cmd .= " --heads"; }
 316         }
 317
 318         $result = array();
 319         $output = run_git($project, $cmd);
 320         foreach ($output as $line) {
 321                 // <hash> <ref>
 322                 $parts = explode(' ', $line, 2);
 323                 $name = str_replace(array('refs/', '^{}'), array('', ''), $parts[1]);
 324                 $result[$parts[0]][] = $name;
 325         }
 326         return $result;
 327 }
 328
 329 /**
 330  * Find commits based on search type and string.
 331  */
 332 function git_search_commits($project, $branch, $type, $string)
 333 {
 334         // git log -sFOO
 335         if ($type == 'change') {
 336                 $cmd = 'log -S'. escapeshellarg($string);
 337         }
 338         elseif ($type == 'commit') {
 339                 $cmd = 'log -i --grep='. escapeshellarg($string);
 340         }
 341         elseif ($type == 'author') {
 342                 $cmd = 'log -i --author='. escapeshellarg($string);
 343         }
 344         elseif ($type == 'committer') {
 345                 $cmd = 'log -i --committer='. escapeshellarg($string);
 346         }
 347         else {
 348                 die('Unsupported type');
 349         }
 350         $cmd .= ' '. $branch;
 351         $lines = run_git($project, $cmd);
 352
 353         $result = array();
 354         foreach ($lines as $line) {
 355                 if (preg_match('/^commit (.*?)$/', $line, $matches)) {
 356                         $result[] = $matches[1];
 357                 }
 358         }
 359         return $result;
 360 }
 361
 362 /**
 363  * Get shortlog entries for the given project.
 364  */
 365 function handle_shortlog($project, $hash = 'HEAD', $page = 0)
 366 {
 367         global $conf;
 368
 369         $refs_by_hash = git_ref_list($project, true, true, $conf['shortlog_remote_labels']);
 370
 371         $result = array();
 372         $revs = git_get_rev_list($project, $page * $conf['summary_shortlog'], $conf['summary_shortlog'], $hash);
 373         foreach ($revs as $rev) {
 374                 $info = git_get_commit_info($project, $rev);
 375                 $refs = array();
 376                 if (in_array($rev, array_keys($refs_by_hash))) {
 377                         $refs = $refs_by_hash[$rev];
 378                 }
 379                 $result[] = array(
 380                         'author' => $info['author_name'],
 381                         'date' => gmstrftime($conf['datetime'], $info['author_utcstamp']),
 382                         'message' => $info['message'],
 383                         'commit_id' => $rev,
 384                         'tree' => $info['tree'],
 385                         'refs' => $refs,
 386                 );
 387         }
 388         #print_r($result);
 389         #die();
 390
 391         return $result;
 392 }
 393
 394 /**
 395  * Fetch tags data, newest first.
 396  *
 397  * @param limit maximum number of tags to return
 398  */
 399 function handle_tags($project, $limit = 0)
 400 {
 401         global $conf;
 402
 403         $tags = git_get_tags($project);
 404         $result = array();
 405         foreach ($tags as $tag) {
 406                 $info = git_get_commit_info($project, $tag['h']);
 407                 $result[] = array(
 408                         'stamp' => $info['author_utcstamp'],
 409                         'date' => gmstrftime($conf['datetime'], $info['author_utcstamp']),
 410                         'h' => $tag['h'],
 411                         'fullname' => $tag['fullname'],
 412                         'name' => $tag['name'],
 413                 );
 414         }
 415
 416         // sort tags newest first
 417         // aka. two more reasons to hate PHP (figuring those out is your homework:)
 418         usort($result, create_function(
 419                 '$x, $y',
 420                 '$a = $x["stamp"]; $b = $y["stamp"]; return ($a == $b ? 0 : ($a > $b ? -1 : 1));'
 421         ));
 422
 423         // TODO optimize this some way, currently all tags are fetched when only a
 424         // few are shown. The problem is that without fetching the commit info
 425         // above, we can't sort using dates, only by tag name...
 426         if ($limit > 0) {
 427                 $result = array_splice($result, 0, $limit);
 428         }
 429
 430         return $result;
 431 }
 432
 433 function htmlentities_wrapper($text)
 434 {
 435         return htmlentities(@iconv('UTF-8', 'UTF-8//IGNORE', $text), ENT_NOQUOTES, 'UTF-8');
 436 }
 437
 438 function xmlentities_wrapper($text)
 439 {
 440         return str_replace(array('&', '<'), array('&#x26;', '&#x3C;'), @iconv('UTF-8', 'UTF-8//IGNORE', $text));
 441 }
 442
 443 /**
 444  * Return a URL that contains the given parameters.
 445  */
 446 function makelink($dict)
 447 {
 448         $params = array();
 449         foreach ($dict as $k => $v) {
 450                 $params[] = rawurlencode($k) .'='. str_replace('%2F', '/', rawurlencode($v));
 451         }
 452         if (count($params) > 0) {
 453                 return '?'. htmlentities_wrapper(join('&', $params));
 454         }
 455         return '';
 456 }
 457
 458 /**
 459  * Obfuscate the e-mail address.
 460  */
 461 function obfuscate_mail($mail)
 462 {
 463         return str_replace(array('@', '.'), array(' at ', ' dot '), $mail);
 464 }
 465
 466 /**
 467  * Used to format RSS item title and description.
 468  *
 469  * @param info commit info from git_get_commit_info()
 470  */
 471 function rss_item_format($format, $info)
 472 {
 473         return preg_replace(array(
 474                 '/{AUTHOR}/',
 475                 '/{AUTHOR_MAIL}/',
 476                 '/{SHORTLOG}/',
 477                 '/{LOG}/',
 478                 '/{COMMITTER}/',
 479                 '/{COMMITTER_MAIL}/',
 480                 '/{DIFFSTAT}/',
 481         ), array(
 482                 htmlentities_wrapper($info['author_name']),
 483                 htmlentities_wrapper($info['author_mail']),
 484                 htmlentities_wrapper($info['message_firstline']),
 485                 htmlentities_wrapper($info['message_full']),
 486                 htmlentities_wrapper($info['committer_name']),
 487                 htmlentities_wrapper($info['committer_mail']),
 488                 htmlentities_wrapper(isset($info['diffstat']) ? $info['diffstat'] : ''),
 489         ), $format);
 490 }
 491
 492 function rss_pubdate($secs)
 493 {
 494         return gmdate('D, d M Y H:i:s O', $secs);
 495 }
 496
 497 /**
 498  * Executes a git command in the project repo.
 499  * @return array of output lines
 500  */
 501 function run_git($project, $command)
 502 {
 503         global $conf;
 504
 505         $output = array();
 506         $cmd = $conf['git'] ." --git-dir=". escapeshellarg($conf['projects'][$project]['repo']) ." $command";
 507         $ret = 0;
 508         exec($cmd, $output, $ret);
 509         if ($conf['debug_command_trace']) {
 510                 static $count = 0;
 511                 $count++;
 512                 trigger_error("[$count]\$ $cmd [exit $ret]");
 513         }
 514         //if ($ret != 0) { die('FATAL: exec() for git failed, is the path properly configured?'); }
 515         return $output;
 516 }
 517
 518 /**
 519  * Executes a git command in the project repo, sending output directly to the
 520  * client.
 521  */
 522 function run_git_passthru($project, $command)
 523 {
 524         global $conf;
 525
 526         $cmd = $conf['git'] ." --git-dir=". escapeshellarg($conf['projects'][$project]['repo']) ." $command";
 527         $result = 0;
 528         passthru($cmd, $result);
 529         return $result;
 530 }
 531
 532 /**
 533  * Makes sure the given project is valid. If it's not, this function will
 534  * die().
 535  * @return the project
 536  */
 537 function validate_project($project)
 538 {
 539         global $conf;
 540
 541         if (!in_array($project, array_keys($conf['projects']))) {
 542                 die('Invalid project');
 543         }
 544         return $project;
 545 }
 546
 547 /**
 548  * Makes sure the given hash is valid. If it's not, this function will die().
 549  * @return the hash
 550  */
 551 function validate_hash($hash)
 552 {
 553         if (!preg_match('/^[0-9a-z]{40}$/', $hash) && !preg_match('!^refs/(heads|tags)/[-_.0-9a-zA-Z]+$!', $hash) && $hash !== 'HEAD') {
 554                 die('Invalid hash');
 555
 556         }
 557         return $hash;
 558 }
 559
 560 /**
 561  * Custom error handler for ViewGit. The errors are pushed to $page['notices']
 562  * and displayed by templates/header.php.
 563  */
 564 function vg_error_handler($errno, $errstr, $errfile, $errline)
 565 {
 566         global $page;
 567
 568         $mask = ini_get('error_reporting');
 569
 570         $class = 'error';
 571
 572         // If mask for this error is not enabled, return silently
 573         if (!($errno & $mask)) {
 574                 return true;
 575         }
 576
 577         // Remove any preceding path until viewgit's directory
 578         $file = $errfile;
 579         $file = strstr($file, 'viewgit/');
 580
 581         $message = "$file:$errline $errstr [$errno]";
 582
 583         switch ($errno) {
 584                 case E_ERROR:
 585                         $class = 'error';
 586                         break;
 587                 case E_WARNING:
 588                         $class = 'warning';
 589                         break;
 590                 case E_NOTICE:
 591                 case E_STRICT:
 592                 default:
 593                         $class = 'info';
 594                         break;
 595         }
 596
 597         $page['notices'][] = array(
 598                 'message' => $message,
 599                 'class' => $class,
 600         );
 601
 602         return true;
 603 }
 604