Prepare SSH connections for proxying

Summary:
Ref T7034.

In a cluster environment, when a user connects with a VCS request over SSH (like `git pull`), the receiving server may need to proxy it to a server which can actually satisfy the request.

In order to proxy the request, we need to know which repository the user is interested in accessing.

Split the SSH workflow into two steps:

  # First, identify the repository.
  # Then, execute the operation.

In the future, this will allow us to put a possible "proxy the whole thing somewhere else" step in the middle, mirroring the behavior of Conduit.

This is trivially easy in `git` and `hg`. Both identify the repository on the commmand line.

This is fiendishly complex in `svn`, for the same reasons that hosting SVN was hard in the first place. Specifically:

  - The client doesn't tell us what it's after.
  - To get it to tell us, we have to send it a server capabilities string //first//.
  - We can't just start an `svnserve` process and read the repository out after a little while, because we may need to proxy the request once we figure out the repository.
  - We can't consume the client protocol frame that tells us what the client wants, because when we start the real server request it won't know what the client is after if it never receives that frame.
  - On the other hand, we must consume the second copy of the server protocol frame that would be sent to the client, or they'll get two "HELLO" messages and not know what to do.

The approach here is straightforward, but the implementation is not trivial. Roughly:

  - Start `svnserve`, read the "hello" frame from it.
  - Kill `svnserve`.
  - Send the "hello" to the client.
  - Wait for the client to send us "I want repository X".
  - Save the message it sent us in the "peekBuffer".
  - Return "this is a request for repository X", so we can proxy it.

Then, to continue the request:

  - Start the real `svnserve`.
  - Read the "hello" frame from it and throw it away.
  - Write the data in the "peekBuffer" to it, as though we'd just received it from the client.
  - State of the world is normal again, so we can continue.

Also fixed some other issues:

  - SVN could choke if `repository.default-local-path` contained extra slashes.
  - PHP might emit some complaints when executing the commit hook; silence those.

Test Plan: Pushed and pulled repositories in SVN, Mercurial and Git.

Reviewers: btrahan

Reviewed By: btrahan

Subscribers: epriestley

Maniphest Tasks: T7034

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

Author: epriestley

resources/celerity/map.php

@@ -7,7 +7,7 @@
  */
 return array(
   'names' => array(
-    'core.pkg.css' => '04a24e98',
+    'core.pkg.css' => '8815f87d',
     'core.pkg.js' => 'efa12ecc',
     'darkconsole.pkg.js' => '8ab24e01',
     'differential.pkg.css' => '8af45893',
@@ -125,7 +125,7 @@
     'rsrc/css/phui/phui-action-list.css' => '9ee9910a',
     'rsrc/css/phui/phui-box.css' => '7b3a2eed',
     'rsrc/css/phui/phui-button.css' => '008ba5e2',
-    'rsrc/css/phui/phui-crumbs-view.css' => '3e362700',
+    'rsrc/css/phui/phui-crumbs-view.css' => '646a8830',
     'rsrc/css/phui/phui-document.css' => 'bbeb1890',
     'rsrc/css/phui/phui-feed-story.css' => 'c9f3a0b5',
     'rsrc/css/phui/phui-fontkit.css' => '9c3d2dce',
@@ -137,7 +137,7 @@
     'rsrc/css/phui/phui-info-panel.css' => '27ea50a1',
     'rsrc/css/phui/phui-list.css' => '53deb25c',
     'rsrc/css/phui/phui-object-box.css' => '0d47b3c8',
-    'rsrc/css/phui/phui-object-item-list-view.css' => '832c58fe',
+    'rsrc/css/phui/phui-object-item-list-view.css' => '2686a80e',
     'rsrc/css/phui/phui-pinboard-view.css' => '3dd4a269',
     'rsrc/css/phui/phui-property-list-view.css' => '51480060',
     'rsrc/css/phui/phui-remarkup-preview.css' => '19ad512b',
@@ -770,7 +770,7 @@
     'phui-calendar-day-css' => 'de035c8a',
     'phui-calendar-list-css' => 'c1d0ca59',
     'phui-calendar-month-css' => 'a92e47d2',
-    'phui-crumbs-view-css' => '3e362700',
+    'phui-crumbs-view-css' => '646a8830',
     'phui-document-view-css' => 'bbeb1890',
     'phui-feed-story-css' => 'c9f3a0b5',
     'phui-font-icon-base-css' => '3dad2ae3',
@@ -783,7 +783,7 @@
     'phui-info-panel-css' => '27ea50a1',
     'phui-list-view-css' => '53deb25c',
     'phui-object-box-css' => '0d47b3c8',
-    'phui-object-item-list-view-css' => '832c58fe',
+    'phui-object-item-list-view-css' => '2686a80e',
     'phui-pinboard-view-css' => '3dd4a269',
     'phui-property-list-view-css' => '51480060',
     'phui-remarkup-preview-css' => '19ad512b',

scripts/repository/commit_hook.php

@@ -1,6 +1,15 @@
-#!/usr/bin/env php
+#!/usr/bin/env TERM=dumb php
 <?php
 
+// NOTE: Note that we're specifying TERM=dumb above when invoking the PHP
+// interpreter. This suppresses an error which looks like this:
+//
+//   No entry for terminal type "unknown";
+//   using dumb terminal settings.
+//
+// This arises from somewhere in the PHP startup machinery if TERM is not
+// set to a recognized value.
+
 // Commit hooks execute in an unusual context where the environment may be
 // unavailable, particularly in SVN. The first parameter to this script is
 // either a bare repository identifier ("X"), or a repository identifier

src/applications/diffusion/ssh/DiffusionGitReceivePackSSHWorkflow.php

@@ -14,9 +14,7 @@ protected function didConstruct() {
   }
 
   protected function executeRepositoryOperations() {
-    $args = $this->getArgs();
-    $path = head($args->getArg('dir'));
-    $repository = $this->loadRepository($path);
+    $repository = $this->getRepository();
 
     // This is a write, and must have write access.
     $this->requireWriteAccess();

src/applications/diffusion/ssh/DiffusionGitSSHWorkflow.php

@@ -7,6 +7,12 @@ protected function writeError($message) {
     return parent::writeError($message."\n");
   }
 
+  protected function identifyRepository() {
+    $args = $this->getArgs();
+    $path = head($args->getArg('dir'));
+    return $this->loadRepositoryWithPath($path);
+  }
+
   protected function waitForGitClient() {
     $io_channel = $this->getIOChannel();
 

src/applications/diffusion/ssh/DiffusionGitUploadPackSSHWorkflow.php

@@ -14,9 +14,7 @@ protected function didConstruct() {
   }
 
   protected function executeRepositoryOperations() {
-    $args = $this->getArgs();
-    $path = head($args->getArg('dir'));
-    $repository = $this->loadRepository($path);
+    $repository = $this->getRepository();
 
     $command = csprintf('git-upload-pack -- %s', $repository->getLocalPath());
     $command = PhabricatorDaemon::sudoCommandAsDaemonUser($command);

src/applications/diffusion/ssh/DiffusionMercurialServeSSHWorkflow.php

@@ -24,11 +24,14 @@ protected function didConstruct() {
       ));
   }
 
-  protected function executeRepositoryOperations() {
+  protected function identifyRepository() {
     $args = $this->getArgs();
     $path = $args->getArg('repository');
-    $repository = $this->loadRepository($path);
+    return $this->loadRepositoryWithPath($path);
+  }
 
+  protected function executeRepositoryOperations() {
+    $repository = $this->getRepository();
     $args = $this->getArgs();
 
     if (!$args->getArg('stdio')) {

src/applications/diffusion/ssh/DiffusionSSHWorkflow.php

@@ -8,11 +8,16 @@ abstract class DiffusionSSHWorkflow extends PhabricatorSSHWorkflow {
 
   public function getRepository() {
     if (!$this->repository) {
-      throw new Exception('Call loadRepository() before getRepository()!');
+      throw new Exception(pht('Repository is not available yet!'));
     }
     return $this->repository;
   }
 
+  private function setRepository(PhabricatorRepository $repository) {
+    $this->repository = $repository;
+    return $this;
+  }
+
   public function getArgs() {
     return $this->args;
   }
@@ -33,6 +38,10 @@ public function getEnvironment() {
     return $env;
   }
 
+  /**
+   * Identify and load the affected repository.
+   */
+  abstract protected function identifyRepository();
   abstract protected function executeRepositoryOperations();
 
   protected function writeError($message) {
@@ -43,6 +52,12 @@ protected function writeError($message) {
   final public function execute(PhutilArgumentParser $args) {
     $this->args = $args;
 
+    $repository = $this->identifyRepository();
+    $this->setRepository($repository);
+
+    // TODO: Here, we would make a proxying decision, had I implemented
+    // proxying yet.
+
     try {
       return $this->executeRepositoryOperations();
     } catch (Exception $ex) {
@@ -51,7 +66,7 @@ final public function execute(PhutilArgumentParser $args) {
     }
   }
 
-  protected function loadRepository($path) {
+  protected function loadRepositoryWithPath($path) {
     $viewer = $this->getUser();
 
     $regex = '@^/?diffusion/(?P<callsign>[A-Z]+)(?:/|\z)@';
@@ -88,8 +103,6 @@ protected function loadRepository($path) {
           pht('This repository is not available over SSH.'));
     }
 
-    $this->repository = $repository;
-
     return $repository;
   }