Fix failure to record pullerPHID in repository pull logs

Summary:
See PHI305. Ref T13046.

The SSH workflows currently extend `PhabricatorManagementWorkflow` to benefit from sharing all the standard argument parsing code. Sharing the parsing code is good, but it also means they inherit a `getViewer()` method which returns the ommnipotent viewer.

This is appropriate for everything else which extends `ManagementWorkflow` (like `bin/storage`, `bin/auth`, etc.) but not appropriate for SSH workflows, which have a real user.

This caused a bug with the pull logs where `pullerPHID` was not recorded properly. We used `$this->getViewer()->getPHID()` but the correct code was `$this->getUser()->getPHID()`.

To harden this against future mistakes:

  - Don't extend `ManagementWorkflow`. Extend `PhutilArgumentWorkflow` instead. We **only** want the argument parsing code.
  - Rename `get/setUser()` to `get/setSSHUser()` to make them explicit.

Then, fix the pull log bug by calling `getSSHUser()` instead of `getViewer()`.

Test Plan:
  - Pulled and pushed to a repository over SSH.
  - Grepped all the SSH stuff for the altered symbols.
  -  Saw pulls record a valid `pullerPHID` in the pull log.
  - Used `echo {} | ssh ... conduit conduit.ping` to test conduit over SSH.

Reviewers: amckinley

Reviewed By: amckinley

Maniphest Tasks: T13046

Differential Revision: https://secure.phabricator.com/D18912

Author: epriestley

scripts/ssh/ssh-exec.php

@@ -245,7 +245,7 @@
   }
 
   $workflow = $parsed_args->parseWorkflows($workflows);
-  $workflow->setUser($user);
+  $workflow->setSSHUser($user);
   $workflow->setOriginalArguments($original_argv);
   $workflow->setIsClusterRequest($is_cluster_request);
 

src/__phutil_library_map__.php

@@ -9620,7 +9620,7 @@
     'PhabricatorSSHKeysSettingsPanel' => 'PhabricatorSettingsPanel',
     'PhabricatorSSHLog' => 'Phobject',
     'PhabricatorSSHPassthruCommand' => 'Phobject',
-    'PhabricatorSSHWorkflow' => 'PhabricatorManagementWorkflow',
+    'PhabricatorSSHWorkflow' => 'PhutilArgumentWorkflow',
     'PhabricatorSavedQuery' => array(
       'PhabricatorSearchDAO',
       'PhabricatorPolicyInterface',

src/applications/conduit/ssh/ConduitSSHWorkflow.php

@@ -46,7 +46,7 @@ public function execute(PhutilArgumentParser $args) {
 
     try {
       $call = new ConduitCall($method, $params);
-      $call->setUser($this->getUser());
+      $call->setUser($this->getSSHUser());
 
       $result = $call->execute();
     } catch (ConduitException $ex) {
@@ -77,7 +77,7 @@ public function execute(PhutilArgumentParser $args) {
 
     $connection_id = idx($metadata, 'connectionID');
     $log = id(new PhabricatorConduitMethodCallLog())
-      ->setCallerPHID($this->getUser()->getPHID())
+      ->setCallerPHID($this->getSSHUser()->getPHID())
       ->setConnectionID($connection_id)
       ->setMethod($method)
       ->setError((string)$error_code)

src/applications/diffusion/ssh/DiffusionGitReceivePackSSHWorkflow.php

@@ -15,7 +15,7 @@ protected function didConstruct() {
 
   protected function executeRepositoryOperations() {
     $repository = $this->getRepository();
-    $viewer = $this->getUser();
+    $viewer = $this->getSSHUser();
     $device = AlmanacKeys::getLiveDevice();
 
     // This is a write, and must have write access.

src/applications/diffusion/ssh/DiffusionGitUploadPackSSHWorkflow.php

@@ -15,7 +15,7 @@ protected function didConstruct() {
 
   protected function executeRepositoryOperations() {
     $repository = $this->getRepository();
-    $viewer = $this->getUser();
+    $viewer = $this->getSSHUser();
     $device = AlmanacKeys::getLiveDevice();
 
     $skip_sync = $this->shouldSkipReadSynchronization();

src/applications/diffusion/ssh/DiffusionSSHWorkflow.php

@@ -26,7 +26,7 @@ public function getArgs() {
 
   public function getEnvironment() {
     $env = array(
-      DiffusionCommitHookEngine::ENV_USER => $this->getUser()->getUsername(),
+      DiffusionCommitHookEngine::ENV_USER => $this->getSSHUser()->getUsername(),
       DiffusionCommitHookEngine::ENV_REMOTE_PROTOCOL => 'ssh',
     );
 
@@ -122,14 +122,14 @@ protected function getProxyCommand() {
       $key_path,
       $port,
       $host,
-      '@'.$this->getUser()->getUsername(),
+      '@'.$this->getSSHUser()->getUsername(),
       $this->getOriginalArguments());
   }
 
   final public function execute(PhutilArgumentParser $args) {
     $this->args = $args;
 
-    $viewer = $this->getUser();
+    $viewer = $this->getSSHUser();
     $have_diffusion = PhabricatorApplication::isClassInstalledForViewer(
       'PhabricatorDiffusionApplication',
       $viewer);
@@ -164,7 +164,7 @@ final public function execute(PhutilArgumentParser $args) {
   }
 
   protected function loadRepositoryWithPath($path, $vcs) {
-    $viewer = $this->getUser();
+    $viewer = $this->getSSHUser();
 
     $info = PhabricatorRepository::parseRepositoryServicePath($path, $vcs);
     if ($info === null) {
@@ -214,7 +214,7 @@ protected function requireWriteAccess($protocol_command = null) {
     }
 
     $repository = $this->getRepository();
-    $viewer = $this->getUser();
+    $viewer = $this->getSSHUser();
 
     if ($viewer->isOmnipotent()) {
       throw new Exception(
@@ -252,7 +252,7 @@ protected function requireWriteAccess($protocol_command = null) {
   }
 
   protected function shouldSkipReadSynchronization() {
-    $viewer = $this->getUser();
+    $viewer = $this->getSSHUser();
 
     // Currently, the only case where devices interact over SSH without
     // assuming user credentials is when synchronizing before a read. These
@@ -265,7 +265,7 @@ protected function shouldSkipReadSynchronization() {
   }
 
   protected function newPullEvent() {
-    $viewer = $this->getViewer();
+    $viewer = $this->getSSHUser();
     $repository = $this->getRepository();
     $remote_address = $this->getSSHRemoteAddress();
 

src/applications/diffusion/ssh/DiffusionSubversionServeSSHWorkflow.php

@@ -154,7 +154,7 @@ protected function executeRepositoryOperations() {
     } else {
       $command = csprintf(
         'svnserve -t --tunnel-user=%s',
-        $this->getUser()->getUsername());
+        $this->getSSHUser()->getUsername());
       $cwd = PhabricatorEnv::getEmptyCWD();
     }
 

src/infrastructure/ssh/PhabricatorSSHWorkflow.php

@@ -1,8 +1,14 @@
 <?php
 
-abstract class PhabricatorSSHWorkflow extends PhabricatorManagementWorkflow {
+abstract class PhabricatorSSHWorkflow
+  extends PhutilArgumentWorkflow {
 
-  private $user;
+  // NOTE: We are explicitly extending "PhutilArgumentWorkflow", not
+  // "PhabricatorManagementWorkflow". We want to avoid inheriting "getViewer()"
+  // and other methods which assume workflows are administrative commands
+  // like `bin/storage`.
+
+  private $sshUser;
   private $iochannel;
   private $errorChannel;
   private $isClusterRequest;
@@ -21,13 +27,13 @@ public function getErrorChannel() {
     return $this->errorChannel;
   }
 
-  public function setUser(PhabricatorUser $user) {
-    $this->user = $user;
+  public function setSSHUser(PhabricatorUser $ssh_user) {
+    $this->sshUser = $ssh_user;
     return $this;
   }
 
-  public function getUser() {
-    return $this->user;
+  public function getSSHUser() {
+    return $this->sshUser;
   }
 
   public function setIOChannel(PhutilChannel $channel) {