4 // This is the minimalist denialist implementation that doesn't check it's
5 // pre-conditions and will screw up if you don't know what you're doing.
8 * Manage the current working directory as a stack.
16 function __construct($dirs = array()) {
26 $this->dirs
[] = getcwd();
28 throw new Exception("Failed to chdir($dir)");
33 $oldDir = array_pop($this->dirs
);
39 * FIXME: Why am I doing this? Can't we get a proper build-system for little
40 * CLI tools -- and then use prepackaged libraries?
45 * Given a link to a pull-request, determine which local repo
46 * it applies to and fetch any metadata.
49 * @param array $repos list of locally known repos
50 * @return PullRequest|NULL
52 public static function get($url, $repos) {
53 foreach ($repos as $repo => $relPath) {
54 if (preg_match("/^https:\/\/github.com\/(.*)\/(civicrm-{$repo})\/pull\/([0-9]+)(|\/commits|\/files)$/", $url, $matches)) {
55 list ($full, $githubUser, $githubRepo, $githubPr) = $matches;
57 $pr = new PullRequest();
59 $pr->data
= HttpClient
::getJson("https://api.github.com/repos/$githubUser/$githubRepo/pulls/$githubPr");
60 if (empty($pr->data
)) {
71 * @var string local repo name e.g. "core", "drupal"
80 public function getNumber() {
81 return $this->data
->number
;
85 * @return string name of the branch on the requestor's repo
87 public function getRequestorBranch() {
88 return $this->data
->head
->ref
;
92 * @return string URL of the requestor's repo
94 public function getRequestorRepoUrl() {
95 return $this->data
->head
->repo
->git_url
;
105 * @var string 'checkout', 'begin', 'help', etc
112 protected $baseBranch;
115 * @var array ($repoName => $gitRef)
122 protected $civiRoot = '.';
127 protected $drupalVersion = 7;
132 protected $dryRun = FALSE;
137 protected $fetch = FALSE;
142 protected $force = FALSE;
147 protected $rebase = FALSE;
150 * @var string, the word 'all' or comma-delimited list of repo names
152 protected $repoFilter = 'all';
155 * @var array ($repoName => $relPath)
162 protected $useGencode = FALSE;
167 protected $useSetup = FALSE;
170 * @var array, non-hyphenated arguments after the basedir
172 protected $arguments;
175 * @var string, the name of this program
187 function __construct() {
188 $this->dirStack
= new DirStack();
189 $this->repos
= array(
191 'drupal' => 'drupal',
192 'joomla' => 'joomla',
193 'packages' => 'packages',
194 'wordpress' => 'WordPress',
203 function main($args) {
204 if (!$this->parseOptions($args)) {
205 printf("Error parsing arguments\n");
210 // All operations relative to civiRoot
211 $this->dirStack
->push($this->civiRoot
);
213 // Filter branch list based on what repos actually exist
214 foreach (array_keys($this->repos
) as $repo) {
215 if (!is_dir($this->repos
[$repo])) {
216 unset($this->repos
[$repo]);
219 if (!isset($this->repos
['core']) ||
!isset($this->repos
['packages'])) {
220 return $this->returnError("Root appears to be invalid -- missing too many repos. Try --root=<dir>\n");
223 $this->repos
= $this->filterRepos($this->repoFilter
, $this->repos
);
226 switch ($this->action
) {
228 call_user_func_array(array($this, 'doCheckoutAll'), $this->arguments
);
231 call_user_func_array(array($this, 'doFetchAll'), $this->arguments
);
234 call_user_func_array(array($this, 'doStatusAll'), $this->arguments
);
237 call_user_func_array(array($this, 'doBegin'), $this->arguments
);
240 call_user_func_array(array($this, 'doResume'), $this->arguments
);
243 call_user_func_array(array($this, 'doReview'), $this->arguments
);
245 //case 'merge-forward':
246 // call_user_func_array(array($this, 'doMergeForward'), $this->arguments);
249 call_user_func_array(array($this, 'doPush'), $this->arguments
);
256 return $this->returnError("unrecognized action: {$this->action}\n");
259 if ($this->useSetup
) {
260 $this->run('core', $this->civiRoot
. '/bin', 'bash', 'setup.sh');
262 elseif ($this->useGencode
) {
263 $this->run('core', $this->civiRoot
. '/xml', 'php', 'GenCode.php');
266 $this->dirStack
->pop();
273 function parseOptions($args) {
274 $this->branches
= array();
275 $this->arguments
= array();
277 foreach ($args as $arg) {
278 if ($arg == '--fetch') {
281 elseif ($arg == '--rebase') {
282 $this->rebase
= TRUE;
284 elseif ($arg == '--dry-run' ||
$arg == '-n') {
285 $this->dryRun
= TRUE;
287 elseif ($arg == '--force' ||
$arg == '-f') {
290 elseif ($arg == '--gencode') {
291 $this->useGencode
= TRUE;
293 elseif ($arg == '--setup') {
294 $this->useSetup
= TRUE;
296 elseif (preg_match('/^--d([678])/', $arg, $matches)) {
297 $this->drupalVersion
= $matches[1];
299 elseif (preg_match('/^--root=(.*)/', $arg, $matches)) {
300 $this->civiRoot
= $matches[1];
302 elseif (preg_match('/^--repos=(.*)/', $arg, $matches)) {
303 $this->repoFilter
= $matches[1];
305 elseif (preg_match('/^--(core|packages|joomla|drupal|wordpress)=(.*)/', $arg, $matches)) {
306 $this->branches
[$matches[1]] = $matches[2];
308 elseif (preg_match('/^-/', $arg)) {
309 printf("unrecognized argument: %s\n", $arg);
313 $this->arguments
[] = $arg;
317 $this->program
= @array_shift
($this->arguments
);
318 $this->action
= @array_shift
($this->arguments
);
324 $program = basename($this->program
);
325 echo "Givi - Coordinate git checkouts across CiviCRM repositories\n";
327 echo " You have cloned and forked the CiviCRM repos. Each of the repos has two\n";
328 echo " remotes (origin + upstream). When working on a new PR, you generally want\n";
329 echo " to checkout official code (eg upstream/master) in all repos, but 1-2 repos\n";
330 echo " should use a custom branch (which tracks upstream/master).\n";
332 echo " $program [options] checkout <branch>\n";
333 echo " $program [options] fetch\n";
334 echo " $program [options] status\n";
335 echo " $program [options] begin <base-branch> [--core=<new-branch>|--drupal=<new-branch>|...] \n";
336 echo " $program [options] resume [--rebase] <base-branch> [--core=<custom-branch>|--drupal=<custom-branch>|...] \n";
337 echo " $program [options] review <base-branch> <pr-url-1> <pr-url-2>...\n";
338 #echo " $program [options] merge-forward <maintenace-branch> <development-branch>\n";
339 #echo " $program [options] push <remote> <branch>[:<branch>]\n";
341 echo " checkout: Checkout same branch name on all repos\n";
342 echo " fetch: Fetch remote changes on all repos\n";
343 echo " status: Display status on all repos\n";
344 echo " begin: Begin work on a new branch on some repo (and use base-branch for all others)\n";
345 echo " resume: Resume work on an existing branch on some repo (and use base-branch for all others)\n";
346 echo " review: Test work provided by someone else's pull-request. (If each repo has related PRs, then you can link to each of them.)\n";
347 #echo " merge-forward: On each repo, merge changes from maintenance branch to development branch\n";
348 #echo " push: On each repo, push a branch to a remote (Note: only intended for use with merge-forward)\n";
349 echo "Common options:\n";
350 echo " --dry-run: Don't do anything; only print commands that would be run\n";
351 echo " --d6: Specify that Drupal branches should use 6.x-* prefixes\n";
352 echo " --d7: Specify that Drupal branches should use 7.x-* prefixes (default)\n";
353 echo " -f: When switching branches, proceed even if the index or the working tree differs from HEAD. This is used to throw away local changes.\n";
354 echo " --fetch: Fetch the latest code before creating, updating, or checking-out anything\n";
355 echo " --repos=X: Restrict operations to the listed repos (comma-delimited list) (default: all)";
356 echo " --root=X: Specify CiviCRM root directory (default: .)\n";
357 echo " --gencode: Run xml/GenCode after checking out code\n";
358 echo " --setup: Run bin/setup.sh (incl xml/GenCode) after checking out code\n";
359 echo "Special options:\n";
360 echo " --core=X: Specify the branch to use on the core repository\n";
361 echo " --packages=X: Specify the branch to use on the packages repository\n";
362 echo " --drupal=X: Specify the branch to use on the drupal repository\n";
363 echo " --joomla=X: Specify the branch to use on the joomla repository\n";
364 echo " --wordpress=X: Specify the branch to use on the wordpress repository\n";
365 echo " --rebase: Perform a rebase before starting work\n";
366 echo "Known repositories:\n";
367 foreach ($this->repos
as $repo => $relPath) {
368 printf(" %-12s: %s\n", $repo, realpath($this->civiRoot
. DIRECTORY_SEPARATOR
. $relPath));
370 echo "When using 'begin' or 'resume' with a remote base-branch, most repositories\n";
371 echo "will have a detached HEAD. Only repos with an explicit branch will be real,\n";
372 echo "local branches.\n";
376 * @param null $baseBranch
380 function doCheckoutAll($baseBranch = NULL) {
382 return $this->returnError("Missing <branch>\n");
384 $branches = $this->resolveBranches($baseBranch, $this->branches
);
389 foreach ($this->repos
as $repo => $relPath) {
390 $filteredBranch = $this->filterBranchName($repo, $branches[$repo]);
391 $this->run($repo, $relPath, 'git', 'checkout', $filteredBranch, $this->force ?
'-f' : NULL);
399 function doStatusAll() {
400 foreach ($this->repos
as $repo => $relPath) {
401 $this->run($repo, $relPath, 'git', 'status');
407 * @param null $baseBranch
411 function doBegin($baseBranch = NULL) {
413 return $this->returnError("Missing <base-branch>\n");
415 if (empty($this->branches
)) {
416 return $this->returnError("Must specify a custom branch for at least one repository.\n");
418 $branches = $this->resolveBranches($baseBranch, $this->branches
);
423 foreach ($this->repos
as $repo => $relPath) {
424 $filteredBranch = $this->filterBranchName($repo, $branches[$repo]);
425 $filteredBaseBranch = $this->filterBranchName($repo, $baseBranch);
427 if ($filteredBranch == $filteredBaseBranch) {
428 $this->run($repo, $relPath, 'git', 'checkout', $filteredBranch, $this->force ?
'-f' : NULL);
431 $this->run($repo, $relPath, 'git', 'checkout', '-b', $filteredBranch, $filteredBaseBranch, $this->force ?
'-f' : NULL);
439 * @param null $baseBranch
444 function doResume($baseBranch = NULL) {
446 return $this->returnError("Missing <base-branch>\n");
448 if (empty($this->branches
)) {
449 return $this->returnError("Must specify a custom branch for at least one repository.\n");
451 $branches = $this->resolveBranches($baseBranch, $this->branches
);
456 foreach ($this->repos
as $repo => $relPath) {
457 $filteredBranch = $this->filterBranchName($repo, $branches[$repo]);
458 $filteredBaseBranch = $this->filterBranchName($repo, $baseBranch);
460 $this->run($repo, $relPath, 'git', 'checkout', $filteredBranch, $this->force ?
'-f' : NULL);
461 if ($filteredBranch != $filteredBaseBranch && $this->rebase
) {
462 list ($baseRemoteRepo, $baseRemoteBranch) = $this->parseBranchRepo($filteredBaseBranch);
463 $this->run($repo, $relPath, 'git', 'pull', '--rebase', $baseRemoteRepo, $baseRemoteBranch);
471 * @param null $baseBranch
475 function doReview($baseBranch = NULL) {
476 if (!$this->doCheckoutAll($baseBranch)) {
480 $args = func_get_args();
481 array_shift($args); // $baseBranch
483 $pullRequests = array();
484 foreach ($args as $prUrl) {
485 $pullRequest = PullRequest
::get($prUrl, $this->repos
);
487 $pullRequests[] = $pullRequest;
490 return $this->returnError("Invalid pull-request URL: $prUrl");
494 foreach ($pullRequests as $pullRequest) {
495 $repo = $pullRequest->repo
;
496 $branchName = 'pull-request-' . $pullRequest->getNumber();
497 if ($this->hasLocalBranch($repo, $branchName)) {
498 $this->run($repo, $this->repos
[$repo], 'git', 'branch', '-D', $branchName);
500 $this->run($repo, $this->repos
[$repo], 'git', 'checkout', '-b', $branchName); ## based on whatever was chosen by doCheckoutAll()
501 $this->run($repo, $this->repos
[$repo], 'git', 'pull', $pullRequest->getRequestorRepoUrl(), $pullRequest->getRequestorBranch());
509 If we want merge-forward changes to be subject to PR process, then this
510 should useful. Currently using a simpler process based on
511 toosl/scripts/merge-forward
513 function doMergeForward($maintBranch, $devBranch) {
515 return $this->returnError("Missing <maintenace-base-branch>\n");
518 return $this->returnError("Missing <development-base-branch>\n");
520 list ($maintBranchRepo, $maintBranchName) = $this->parseBranchRepo($maintBranch);
521 list ($devBranchRepo, $devBranchName) = $this->parseBranchRepo($devBranch);
523 $newBranchRepo = $devBranchRepo;
524 $newBranchName = $maintBranchName . '-' . $devBranchName . '-' . date('Y-m-d-H-i-s');
530 foreach ($this->repos as $repo => $relPath) {
531 $filteredMaintBranch = $this->filterBranchName($repo, $maintBranch);
532 $filteredDevBranch = $this->filterBranchName($repo, $devBranch);
533 $filteredNewBranchName = $this->filterBranchName($repo, $newBranchName);
535 $this->run($repo, $relPath, 'git', 'checkout', '-b', $filteredNewBranchName, $filteredDevBranch);
536 $this->run($repo, $relPath, 'git', 'merge', $filteredMaintBranch);
542 * @param $newBranchRepo
543 * @param $newBranchNames
547 function doPush($newBranchRepo, $newBranchNames) {
548 if (!$newBranchRepo) {
549 return $this->returnError("Missing <remote>\n");
551 if (!$newBranchNames) {
552 return $this->returnError("Missing <branch>[:<branch>]\n");
554 if (FALSE !== strpos($newBranchNames, ':')) {
555 list ($newBranchFromName, $newBranchToName) = explode(':', $newBranchNames);
556 foreach ($this->repos
as $repo => $relPath) {
557 $filteredFromName = $this->filterBranchName($repo, $newBranchFromName);
558 $filteredToName = $this->filterBranchName($repo, $newBranchToName);
560 $this->run($repo, $relPath, 'git', 'push', $newBranchRepo, $filteredFromName . ':' . $filteredToName);
564 foreach ($this->repos
as $repo => $relPath) {
565 $filteredName = $this->filterBranchName($repo, $newBranchNames);
566 $this->run($repo, $relPath, 'git', 'push', $newBranchRepo, $filteredName);
574 * Determine if a branch exists locally
576 * @param string $repo
577 * @param string $name branch name
580 function hasLocalBranch($repo, $name) {
581 $path = $this->repos
[$repo] . '/.git/refs/heads/' . $name;
582 return file_exists($path);
586 * Given a ref name, determine the repo and branch
588 * FIXME: only supports $refs like "foo" (implicit origin) or "myremote/foo"
591 * @param string $defaultRemote
596 function parseBranchRepo($ref, $defaultRemote = 'origin') {
597 $parts = explode('/', $ref);
598 if (count($parts) == 1) {
599 return array($defaultRemote, $parts[1]);
601 elseif (count($parts) == 2) {
605 throw new Exception("Failed to parse branch name ($ref)");
612 * Any items after $command will be escaped and added to $command
615 * @param string $runDir
616 * @param string $command
620 function run($repoName, $runDir, $command) {
621 $this->dirStack
->push($runDir);
623 $args = func_get_args();
627 foreach ($args as $arg) {
629 $command .= ' ' . escapeshellarg($arg);
632 printf("\n\n\nRUN [%s]: %s\n", $repoName, $command);
637 $r = system($command);
640 $this->dirStack
->pop();
644 function doFetchAll() {
645 foreach ($this->repos
as $repo => $relPath) {
646 $this->run($repo, $relPath, 'git', 'fetch', '--all');
651 * @param string $default branch to use by default
654 * @return array ($repoName => $gitRef)
656 function resolveBranches($default, $overrides) {
657 $branches = $overrides;
658 foreach ($this->repos
as $repo => $relPath) {
659 if (!isset($branches[$repo])) {
660 $branches[$repo] = $default;
672 function filterBranchName($repoName, $branchName) {
673 if ($branchName == '') {
676 if ($repoName == 'drupal') {
677 $parts = explode('/', $branchName);
678 $last = $this->drupalVersion
. '.x-' . array_pop($parts);
679 array_push($parts, $last);
680 return implode('/', $parts);
686 * @param string $filter e.g. "all" or "repo1,repo2"
687 * @param array $repos ($repoName => $repoDir)
690 * @return array ($repoName => $repoDir)
692 function filterRepos($filter, $repos) {
693 if ($filter == 'all') {
697 $inclRepos = explode(',', $filter);
698 $unknowns = array_diff($inclRepos, array_keys($repos));
699 if (!empty($unknowns)) {
700 throw new Exception("Unknown Repos: " . implode(',', $unknowns));
702 $unwanted = array_diff(array_keys($repos), $inclRepos);
703 foreach ($unwanted as $repo) {
704 unset($repos[$repo]);
714 function returnError($message) {
715 echo "\nERROR: ", $message, "\n\n";
731 static function download($url, $file) {
732 // PHP native client is unreliable PITA for HTTPS
733 if (exec("which wget")) {
734 self
::run('wget', '-q', '-O', $file, $url);
736 elseif (exec("which curl")) {
737 self
::run('curl', '-o', $file, $url);
740 // FIXME: really detect errors
749 static function getJson($url) {
750 $file = tempnam(sys_get_temp_dir(), 'givi-json-');
751 HttpClient
::download($url, $file);
752 $data = json_decode(file_get_contents($file));
760 * Any items after $command will be escaped and added to $command
762 * @param string $command
764 * @internal param string $runDir
767 static function run($command) {
768 $args = func_get_args();
770 foreach ($args as $arg) {
771 $command .= ' ' . escapeshellarg($arg);
773 printf("\n\n\nRUN: %s\n", $command);
774 $r = system($command);