1: 2: 3: 4: 5: 6: 7: 8: 9: 10: 11: 12: 13: 14: 15: 16: 17: 18: 19: 20: 21: 22: 23: 24: 25: 26: 27: 28: 29: 30: 31: 32: 33: 34: 35: 36: 37: 38: 39: 40: 41: 42: 43: 44: 45: 46: 47: 48: 49: 50: 51: 52: 53: 54: 55: 56: 57: 58: 59: 60: 61: 62: 63: 64: 65: 66: 67: 68: 69: 70: 71: 72: 73: 74: 75: 76: 77: 78: 79: 80: 81: 82: 83: 84: 85: 86: 87: 88: 89: 90: 91: 92: 93: 94: 95: 96: 97: 98: 99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208: 209: 210: 211: 212: 213: 214: 215: 216: 217: 218: 219: 220: 221: 222: 223: 224: 225: 226: 227: 228: 229: 230: 231: 232: 233: 234: 235: 236: 237: 238: 239: 240: 241: 242: 243: 244: 245: 246: 247: 248: 249: 250: 251: 252: 253: 254: 255: 256: 257: 258: 259: 260: 261: 262: 263: 264: 265: 266: 267: 268: 269: 270: 271: 272: 273: 274: 275: 276: 277: 278: 279: 280: 281: 282: 283: 284: 285: 286: 287: 288: 289: 290: 291: 292: 293: 294: 295: 296: 297: 298: 299: 300: 301: 302: 303: 304: 305: 306: 307: 308: 309: 310: 311: 312: 313: 314: 315: 316: 317: 318: 319: 320: 321: 322: 323: 324: 325: 326: 327: 328: 329: 330: 331: 332: 333: 334: 335: 336: 337: 338: 339: 340: 341: 342: 343: 344: 345: 346: 347: 348: 349: 350: 351: 352: 353: 354: 355: 356: 357: 358: 359: 360: 361: 362: 363: 364: 365: 366: 367: 368: 369: 370: 371: 372: 373: 374: 375: 376: 377: 378: 379: 380: 381: 382: 383: 384: 385: 386: 387: 388: 389: 390: 391: 392: 393: 394: 395: 396: 397: 398: 399: 400: 401: 402: 403: 404: 405: 406: 407: 408: 409: 410: 411: 412: 413: 414: 415: 416: 417: 418: 419: 420: 421: 422: 423: 424: 425: 426: 427: 428: 429: 430: 431: 432: 433: 434: 435: 436: 437: 438: 439: 440: 441: 442: 443: 444: 445: 446: 447: 448: 449: 450: 451: 452: 453: 454: 455: 456: 457: 458: 459: 460: 461: 462: 463: 464: 465: 466: 467: 468: 469: 470: 471: 472: 473: 474: 475: 476: 477: 478: 479: 480: 481: 482: 483: 484: 485: 486: 487: 488: 489: 490: 491: 492: 493: 494: 495: 496: 497: 498: 499: 500: 501: 502: 503: 504: 505: 506: 507: 508: 509: 510: 511: 512: 513: 514: 515: 516: 517: 518: 519: 520: 521: 522: 523: 524: 525: 526: 527: 528: 529: 530: 531: 532: 533: 534: 535: 536: 537: 538: 539: 540: 541: 542: 543: 544: 545: 546: 547: 548: 549: 550: 551: 552: 553: 554: 555: 556: 557: 558: 559: 560: 561: 562: 563: 564: 565: 566: 567: 568: 569: 570: 571: 572: 573: 574: 575: 576: 577: 578: 579: 580: 581: 582: 583: 584: 585: 586: 587: 588: 589: 590: 591: 592: 593: 594: 595: 596: 597: 598: 599: 600: 601: 602: 603: 604: 605: 606: 607: 608: 609: 610: 611: 612: 613: 614: 615: 616: 617: 618: 619: 620: 621: 622: 623: 624: 625: 626: 627: 628: 629: 630: 631: 632: 633: 634: 635: 636: 637: 638: 639: 640: 641: 642: 643: 644: 645: 646: 647: 648: 649: 650: 651: 652: 653: 654: 655: 656: 657: 658: 659: 660: 661: 662: 663: 664: 665: 666: 667: 668: 669: 670: 671: 672: 673: 674: 675: 676: 677: 678: 679: 680: 681: 682: 683: 684: 685: 686: 687: 688: 689: 690: 691: 692: 693: 694: 695: 696: 697: 698: 699: 700: 701: 702: 703: 704: 705: 706: 707: 708: 709: 710: 711: 712: 713: 714: 715: 716: 717: 718: 719: 720: 721: 722: 723: 724: 725: 726: 727: 728: 729: 730: 731: 732: 733: 734: 735: 736: 737: 738: 739: 740: 741: 742: 743: 744: 745: 746: 747: 748: 749: 750: 751: 752: 753: 754: 755: 756: 757: 758: 759: 760: 761: 762: 763: 764: 765: 766: 767: 768: 769: 770: 771: 772: 773: 774: 775: 776: 777: 778: 779: 780: 781: 782: 783: 784: 785: 786: 787: 788: 789: 790: 791: 792: 793: 794: 795: 796: 797: 798: 799: 800: 801: 802: 803: 804: 805: 806: 807: 808: 809: 810: 811: 812: <?php
namespace CzProject\GitPhp;
class GitRepository
{
/** @var string */
protected $repository;
/** @var string|NULL @internal */
protected $cwd;
/**
* @param string
* @throws GitException
*/
public function __construct($repository)
{
if(basename($repository) === '.git')
{
$repository = dirname($repository);
}
$this->repository = realpath($repository);
if($this->repository === FALSE)
{
throw new GitException("Repository '$repository' not found.");
}
}
/**
* @return string
*/
public function getRepositoryPath()
{
return $this->repository;
}
/**
* Creates a tag.
* `git tag <name>`
* @param string
* @param array|NULL
* @throws GitException
* @return static
*/
public function createTag($name, $options = NULL)
{
return $this->begin()
->run('git tag', $options, $name)
->end();
}
/**
* Removes tag.
* `git tag -d <name>`
* @param string
* @throws GitException
* @return static
*/
public function removeTag($name)
{
return $this->begin()
->run('git tag', array(
'-d' => $name,
))
->end();
}
/**
* Renames tag.
* `git tag <new> <old>`
* `git tag -d <old>`
* @param string
* @param string
* @throws GitException
* @return static
*/
public function renameTag($oldName, $newName)
{
return $this->begin()
// http://stackoverflow.com/a/1873932
// create new as alias to old (`git tag NEW OLD`)
->run('git tag', $newName, $oldName)
// delete old (`git tag -d OLD`)
->removeTag($oldName) // WARN! removeTag() calls end() method!!!
->end();
}
/**
* Returns list of tags in repo.
* @return string[]|NULL NULL => no tags
* @throws GitException
*/
public function getTags()
{
return $this->extractFromCommand('git tag', 'trim');
}
/**
* Merges branches.
* `git merge <options> <name>`
* @param string
* @param array|NULL
* @throws GitException
* @return static
*/
public function merge($branch, $options = NULL)
{
return $this->begin()
->run('git merge', $options, $branch)
->end();
}
/**
* Creates new branch.
* `git branch <name>`
* (optionaly) `git checkout <name>`
* @param string
* @param bool
* @throws GitException
* @return static
*/
public function createBranch($name, $checkout = FALSE)
{
$this->begin();
// git branch $name
$this->run('git branch', $name);
if($checkout)
{
$this->checkout($name);
}
return $this->end();
}
/**
* Removes branch.
* `git branch -d <name>`
* @param string
* @throws GitException
* @return static
*/
public function removeBranch($name)
{
return $this->begin()
->run('git branch', array(
'-d' => $name,
))
->end();
}
/**
* Gets name of current branch
* `git branch` + magic
* @return string
* @throws GitException
*/
public function getCurrentBranchName()
{
try
{
$branch = $this->extractFromCommand('git branch -a', function($value) {
if(isset($value[0]) && $value[0] === '*')
{
return trim(substr($value, 1));
}
return FALSE;
});
if(is_array($branch))
{
return $branch[0];
}
}
catch(GitException $e) {}
throw new GitException('Getting current branch name failed.');
}
/**
* Returns list of all (local & remote) branches in repo.
* @return string[]|NULL NULL => no branches
* @throws GitException
*/
public function getBranches()
{
return $this->extractFromCommand('git branch -a', function($value) {
return trim(substr($value, 1));
});
}
/**
* Returns list of remote branches in repo.
* @return string[]|NULL NULL => no branches
* @throws GitException
*/
public function getRemoteBranches()
{
return $this->extractFromCommand('git branch -r', function($value) {
return trim(substr($value, 1));
});
}
/**
* Returns list of local branches in repo.
* @return string[]|NULL NULL => no branches
* @throws GitException
*/
public function getLocalBranches()
{
return $this->extractFromCommand('git branch', function($value) {
return trim(substr($value, 1));
});
}
/**
* Checkout branch.
* `git checkout <branch>`
* @param string
* @throws GitException
* @return static
*/
public function checkout($name)
{
return $this->begin()
->run('git checkout', $name)
->end();
}
/**
* Removes file(s).
* `git rm <file>`
* @param string|string[]
* @throws GitException
* @return static
*/
public function removeFile($file)
{
if(!is_array($file))
{
$file = func_get_args();
}
$this->begin();
foreach($file as $item)
{
$this->run('git rm', $item, '-r');
}
return $this->end();
}
/**
* Adds file(s).
* `git add <file>`
* @param string|string[]
* @throws GitException
* @return static
*/
public function addFile($file)
{
if(!is_array($file))
{
$file = func_get_args();
}
$this->begin();
foreach($file as $item)
{
// make sure the given item exists
// this can be a file or an directory, git supports both
$path = Helpers::isAbsolute($item) ? $item : ($this->getRepositoryPath() . DIRECTORY_SEPARATOR . $item);
if (!file_exists($path)) {
throw new GitException("The path at '$item' does not represent a valid file.");
}
$this->run('git add', $item);
}
return $this->end();
}
/**
* Adds all created, modified & removed files.
* `git add --all`
* @throws GitException
* @return static
*/
public function addAllChanges()
{
return $this->begin()
->run('git add --all')
->end();
}
/**
* Renames file(s).
* `git mv <file>`
* @param string|string[] from: array('from' => 'to', ...) || (from, to)
* @param string|NULL
* @throws GitException
* @return static
*/
public function renameFile($file, $to = NULL)
{
if(!is_array($file)) // rename(file, to);
{
$file = array(
$file => $to,
);
}
$this->begin();
foreach($file as $from => $to)
{
$this->run('git mv', $from, $to);
}
return $this->end();
}
/**
* Commits changes
* `git commit <params> -m <message>`
* @param string
* @param string[] param => value
* @throws GitException
* @return static
*/
public function commit($message, $params = NULL)
{
if(!is_array($params))
{
$params = array();
}
return $this->begin()
->run("git commit", $params, array(
'-m' => $message,
))
->end();
}
/**
* Returns last commit ID on current branch
* `git log --pretty=format:"%H" -n 1`
* @return string|NULL
* @throws GitException
*/
public function getLastCommitId()
{
$this->begin();
$lastLine = exec('git log --pretty=format:"%H" -n 1 2>&1');
$this->end();
if (preg_match('/^[0-9a-f]{40}$/i', $lastLine)) {
return $lastLine;
}
return NULL;
}
/**
* Exists changes?
* `git status` + magic
* @return bool
* @throws GitException
*/
public function hasChanges()
{
// Make sure the `git status` gets a refreshed look at the working tree.
$this->begin()
->run('git update-index -q --refresh')
->end();
$output = $this->extractFromCommand('git status --porcelain');
return !empty($output);
}
/**
* @deprecated
* @throws GitException
*/
public function isChanges()
{
return $this->hasChanges();
}
/**
* Pull changes from a remote
* @param string|NULL
* @param array|NULL
* @return static
* @throws GitException
*/
public function pull($remote = NULL, array $params = NULL)
{
if(!is_array($params))
{
$params = array();
}
return $this->begin()
->run("git pull $remote", $params)
->end();
}
/**
* Push changes to a remote
* @param string|NULL
* @param array|NULL
* @return static
* @throws GitException
*/
public function push($remote = NULL, array $params = NULL)
{
if(!is_array($params))
{
$params = array();
}
return $this->begin()
->run("git push $remote", $params)
->end();
}
/**
* Run fetch command to get latest branches
* @param string|NULL
* @param array|NULL
* @return static
* @throws GitException
*/
public function fetch($remote = NULL, array $params = NULL)
{
if(!is_array($params))
{
$params = array();
}
return $this->begin()
->run("git fetch $remote", $params)
->end();
}
/**
* Adds new remote repository
* @param string
* @param string
* @param array|NULL
* @return static
* @throws GitException
*/
public function addRemote($name, $url, array $params = NULL)
{
return $this->begin()
->run('git remote add', $params, $name, $url)
->end();
}
/**
* Renames remote repository
* @param string
* @param string
* @return static
* @throws GitException
*/
public function renameRemote($oldName, $newName)
{
return $this->begin()
->run('git remote rename', $oldName, $newName)
->end();
}
/**
* Removes remote repository
* @param string
* @return static
* @throws GitException
*/
public function removeRemote($name)
{
return $this->begin()
->run('git remote remove', $name)
->end();
}
/**
* Changes remote repository URL
* @param string
* @param string
* @param array|NULL
* @return static
* @throws GitException
*/
public function setRemoteUrl($name, $url, array $params = NULL)
{
return $this->begin()
->run('git remote set-url', $params, $name, $url)
->end();
}
/**
* @param string|string[]
* @return string[] returns output
* @throws GitException
*/
public function execute($cmd)
{
if (!is_array($cmd)) {
$cmd = array($cmd);
}
array_unshift($cmd, 'git');
$cmd = self::processCommand($cmd);
$this->begin();
exec($cmd . ' 2>&1', $output, $ret);
$this->end();
if($ret !== 0)
{
throw new GitException("Command '$cmd' failed (exit-code $ret).", $ret);
}
return $output;
}
/**
* @return static
*/
protected function begin()
{
if($this->cwd === NULL) // TODO: good idea??
{
$this->cwd = getcwd();
chdir($this->repository);
}
return $this;
}
/**
* @return static
*/
protected function end()
{
if(is_string($this->cwd))
{
chdir($this->cwd);
}
$this->cwd = NULL;
return $this;
}
/**
* @param string
* @param callback|NULL
* @return string[]|NULL
* @throws GitException
*/
protected function extractFromCommand($cmd, $filter = NULL)
{
$output = array();
$exitCode = NULL;
$this->begin();
exec("$cmd", $output, $exitCode);
$this->end();
if($exitCode !== 0 || !is_array($output))
{
throw new GitException("Command $cmd failed.");
}
if($filter !== NULL)
{
$newArray = array();
foreach($output as $line)
{
$value = $filter($line);
if($value === FALSE)
{
continue;
}
$newArray[] = $value;
}
$output = $newArray;
}
if(!isset($output[0])) // empty array
{
return NULL;
}
return $output;
}
/**
* Runs command.
* @param string|array
* @return static
* @throws GitException
*/
protected function run($cmd/*, $options = NULL*/)
{
$args = func_get_args();
$cmd = self::processCommand($args);
exec($cmd . ' 2>&1', $output, $ret);
if($ret !== 0)
{
throw new GitException("Command '$cmd' failed (exit-code $ret).", $ret);
}
return $this;
}
protected static function processCommand(array $args)
{
$cmd = array();
$programName = array_shift($args);
foreach($args as $arg)
{
if(is_array($arg))
{
foreach($arg as $key => $value)
{
$_c = '';
if(is_string($key))
{
$_c = "$key ";
}
$cmd[] = $_c . escapeshellarg($value);
}
}
elseif(is_scalar($arg) && !is_bool($arg))
{
$cmd[] = escapeshellarg($arg);
}
}
return "$programName " . implode(' ', $cmd);
}
/**
* Init repo in directory
* @param string
* @param array|NULL
* @return static
* @throws GitException
*/
public static function init($directory, array $params = NULL)
{
if(is_dir("$directory/.git"))
{
throw new GitException("Repo already exists in $directory.");
}
if(!is_dir($directory) && !@mkdir($directory, 0777, TRUE)) // intentionally @; not atomic; from Nette FW
{
throw new GitException("Unable to create directory '$directory'.");
}
$cwd = getcwd();
chdir($directory);
exec(self::processCommand(array(
'git init',
$params,
$directory,
)), $output, $returnCode);
if($returnCode !== 0)
{
throw new GitException("Git init failed (directory $directory).");
}
$repo = getcwd();
chdir($cwd);
return new static($repo);
}
/**
* Clones GIT repository from $url into $directory
* @param string
* @param string|NULL
* @param array|NULL
* @return static
* @throws GitException
*/
public static function cloneRepository($url, $directory = NULL, array $params = NULL)
{
if($directory !== NULL && is_dir("$directory/.git"))
{
throw new GitException("Repo already exists in $directory.");
}
$cwd = getcwd();
if($directory === NULL)
{
$directory = Helpers::extractRepositoryNameFromUrl($url);
$directory = "$cwd/$directory";
}
elseif(!Helpers::isAbsolute($directory))
{
$directory = "$cwd/$directory";
}
if ($params === NULL) {
$params = '-q';
}
exec(self::processCommand(array(
'git clone',
$params,
$url,
$directory
)), $output, $returnCode);
if($returnCode !== 0)
{
throw new GitException("Git clone failed (directory $directory).");
}
return new static($directory);
}
/**
* @param string
* @param array|NULL
* @return bool
*/
public static function isRemoteUrlReadable($url, array $refs = NULL)
{
$env = '';
if (DIRECTORY_SEPARATOR === '\\') { // Windows
$env = 'set GIT_TERMINAL_PROMPT=0 &&';
} else {
$env = 'GIT_TERMINAL_PROMPT=0';
}
exec(self::processCommand(array(
$env . ' git ls-remote',
'--heads',
'--quiet',
'--exit-code',
$url,
$refs,
)) . ' 2>&1', $output, $returnCode);
return $returnCode === 0;
}
}