phorge-arcanist/src/workflow/ArcanistExportWorkflow.php

<?php

/*
 * Copyright 2012 Facebook, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/**
 * Exports changes from Differential or the working copy to a file.
 *
 * @group workflow
 */
final class ArcanistExportWorkflow extends ArcanistBaseWorkflow {

  const SOURCE_LOCAL      = 'local';
  const SOURCE_DIFF       = 'diff';
  const SOURCE_REVISION   = 'revision';

  const FORMAT_GIT        = 'git';
  const FORMAT_UNIFIED    = 'unified';
  const FORMAT_BUNDLE     = 'arcbundle';

  private $source;
  private $sourceID;
  private $format;

  public function getWorkflowName() {
    return 'export';
  }

  public function getCommandSynopses() {
    return phutil_console_format(<<<EOTEXT
      **export** [__paths__] __format__ (svn)
      **export** [__commit_range__] __format__ (git)
      **export** __--revision__ __revision_id__ __format__
      **export** __--diff__ __diff_id__ __format__
EOTEXT
      );
  }

  public function getCommandHelp() {
    return phutil_console_format(<<<EOTEXT
          Supports: git, svn
          Export the local changeset (or a Differential changeset) to a file,
          in some __format__: git diff (__--git__), unified diff
          (__--unified__), or arc bundle (__--arcbundle__ __path__) format.
EOTEXT
      );
  }

  public function getArguments() {
    return array(
      'git' => array(
        'help' =>
          "Export change as a git patch. This format is more complete than ".
          "unified, but less complete than arc bundles. These patches can be ".
          "applied with 'git apply' or 'arc patch'.",
      ),
      'unified' => array(
        'help' =>
          "Export change as a unified patch. This format is less complete ".
          "than git patches or arc bundles. These patches can be applied with ".
          "'patch' or 'arc patch'.",
      ),
      'arcbundle' => array(
        'param' => 'file',
        'help' =>
          "Export change as an arc bundle. This format can represent all ".
          "changes. These bundles can be applied with 'arc patch'.",
      ),
      'encoding' => array(
        'param' => 'encoding',
        'help' =>
          "Attempt to convert non UTF-8 patch into specified encoding.",
      ),
      'revision' => array(
        'param' => 'revision_id',
        'help' =>
          "Instead of exporting changes from the working copy, export them ".
          "from a Differential revision."
      ),
      'diff' => array(
        'param' => 'diff_id',
        'help' =>
          "Instead of exporting changes from the working copy, export them ".
          "from a Differential diff."
      ),
      '*' => 'paths',
    );
  }


  protected function didParseArguments() {
    $source = self::SOURCE_LOCAL;
    $requested = 0;
    if ($this->getArgument('revision')) {
      $source = self::SOURCE_REVISION;
      $requested++;

      $source_id = $this->getArgument($source);
      $this->sourceID = $this->normalizeRevisionID($source_id);
    }
    if ($this->getArgument('diff')) {
      $source = self::SOURCE_DIFF;
      $requested++;

      $this->sourceID = $this->getArgument($source);
    }
    $this->source = $source;

    if ($requested > 1) {
      throw new ArcanistUsageException(
      "Options '--revision' and '--diff' are not compatible. Choose exactly ".
      "one change source.");
    }


    $format = null;
    $requested = 0;
    if ($this->getArgument('git')) {
      $format = self::FORMAT_GIT;
      $requested++;
    }
    if ($this->getArgument('unified')) {
      $format = self::FORMAT_UNIFIED;
      $requested++;
    }
    if ($this->getArgument('arcbundle')) {
      $format = self::FORMAT_BUNDLE;
      $requested++;
    }

    if ($requested === 0) {
      throw new ArcanistUsageException(
        "Specify one of '--git', '--unified' or '--arcbundle <path>' to ".
        "choose an export format.");
    } else if ($requested > 1) {
      throw new ArcanistUsageException(
        "Options '--git', '--unified' and '--arcbundle' are not compatible. ".
        "Choose exactly one export format.");
    }

    $this->format = $format;
  }

  public function requiresConduit() {
    return true;
  }

  public function requiresAuthentication() {
    return $this->requiresConduit();
  }

  public function requiresRepositoryAPI() {
    return $this->getSource() == self::SOURCE_LOCAL;
  }

  public function requiresWorkingCopy() {
    return $this->getSource() == self::SOURCE_LOCAL;
  }

  private function getSource() {
    return $this->source;
  }

  private function getSourceID() {
    return $this->sourceID;
  }

  private function getFormat() {
    return $this->format;
  }

  public function run() {

    $source = $this->getSource();

    switch ($source) {
      case self::SOURCE_LOCAL:
        $repository_api = $this->getRepositoryAPI();
        $parser = new ArcanistDiffParser();
        $parser->setRepositorAPI($repository_api);

        if ($repository_api instanceof ArcanistGitAPI) {
          $repository_api->parseRelativeLocalCommit(
            $this->getArgument('paths'));
          $diff = $repository_api->getFullGitDiff();
          $changes = $parser->parseDiff($diff);
        } else {
          // TODO: paths support
          $paths = $repository_api->getWorkingCopyStatus();
          $changes = $parser->parseSubversionDiff(
            $repository_api,
            $paths);
        }

        $bundle = ArcanistBundle::newFromChanges($changes);
        $bundle->setProjectID($this->getWorkingCopy()->getProjectID());
        $bundle->setBaseRevision(
          $repository_api->getSourceControlBaseRevision());
        // note we can't get a revision ID for SOURCE_LOCAL
        break;
      case self::SOURCE_REVISION:
        $bundle = $this->loadRevisionBundleFromConduit(
          $this->getConduit(),
          $this->getSourceID());
        break;
      case self::SOURCE_DIFF:
        $bundle = $this->loadDiffBundleFromConduit(
          $this->getConduit(),
          $this->getSourceID());
        break;
    }

    $try_encoding = nonempty($this->getArgument('encoding'), null);
    if (!$try_encoding) {
      try {
        $project_info = $this->getConduit()->callMethodSynchronous(
          'arcanist.projectinfo',
          array(
            'name' => $bundle->getProjectID(),
          ));
        $try_encoding = $project_info['encoding'];
      } catch (ConduitClientException $e) {
        $try_encoding = null;
      }
    }

    if ($try_encoding) {
      $bundle->setEncoding($try_encoding);
    }

    $format = $this->getFormat();

    switch ($format) {
      case self::FORMAT_GIT:
        echo $bundle->toGitPatch();
        break;
      case self::FORMAT_UNIFIED:
        echo $bundle->toUnifiedDiff();
        break;
      case self::FORMAT_BUNDLE:
        $path = $this->getArgument('arcbundle');
        echo "Writing bundle to '{$path}'...\n";
        $bundle->writeToDisk($path);
        echo "done.\n";
        break;
    }

    return 0;
  }
}