<?php

final class ReleephWorkGetBranchConduitAPIMethod
  extends ReleephConduitAPIMethod {

  public function getAPIMethodName() {
    return 'releephwork.getbranch';
  }

  public function getMethodStatus() {
    return self::METHOD_STATUS_UNSTABLE;
  }

  public function getMethodDescription() {
    return 'Return information to help checkout / cut a Releeph branch.';
  }

  public function defineParamTypes() {
    return array(
      'branchPHID'  => 'required string',
    );
  }

  public function defineReturnType() {
    return 'dict<string, wild>';
  }

  public function defineErrorTypes() {
    return array();
  }

  protected function execute(ConduitAPIRequest $request) {
    $branch = id(new ReleephBranchQuery())
      ->setViewer($request->getUser())
      ->withPHIDs(array($request->getValue('branchPHID')))
      ->needCutPointCommits(true)
      ->executeOne();

    $cut_phid = $branch->getCutPointCommitPHID();
    $phids = array($cut_phid);
    $handles = id(new PhabricatorHandleQuery())
      ->setViewer($request->getUser())
      ->withPHIDs($phids)
      ->execute();

    $project = $branch->getProject();
    $repo = $project->getRepository();
    $commit = $branch->getCutPointCommit();

    return array(
      'branchName'      => $branch->getName(),
      'branchPHID'      => $branch->getPHID(),
      'vcsType'         => $repo->getVersionControlSystem(),
      'cutCommitID'     => $commit->getCommitIdentifier(),
      'cutCommitName'   => $handles[$cut_phid]->getName(),
      'creatorPHID'     => $branch->getCreatedByUserPHID(),
      'trunk'           => $project->getTrunkBranch(),
    );
  }

}