Add DoorkeeperExternalObject

Summary:
Ref T2852. This table holds data about external objects and allows us to write edges to them.

Objects are identified with an `<applicationType, applicationDomain, objectType, objectID>` tuple. For example, Asana tasks will be, e.g., `<asana, asana.com, asana:task, 93829279873>` or similar.

Test Plan: Ran storage upgrade.

Reviewers: btrahan

Reviewed By: btrahan

CC: aran

Maniphest Tasks: T2852

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

resources/sql/patches/20130622.doorkeeper.sql

@@ -0,0 +1,35 @@
+CREATE TABLE {$NAMESPACE}_doorkeeper.doorkeeper_externalobject (
+  id INT UNSIGNED NOT NULL AUTO_INCREMENT PRIMARY KEY,
+  phid VARCHAR(64) NOT NULL COLLATE utf8_bin,
+  objectKey CHAR(12) NOT NULL COLLATE utf8_bin,
+  applicationType VARCHAR(32) NOT NULL COLLATE utf8_bin,
+  applicationDomain VARCHAR(32) NOT NULL COLLATE utf8_bin,
+  objectType VARCHAR(32) NOT NULL COLLATE utf8_bin,
+  objectID VARCHAR(64) NOT NULL COLLATE utf8_bin,
+  objectURI VARCHAR(128) COLLATE utf8_bin,
+  importerPHID VARCHAR(64) COLLATE utf8_bin,
+  properties LONGTEXT NOT NULL COLLATE utf8_bin,
+  viewPolicy VARCHAR(64) NOT NULL COLLATE utf8_bin,
+  dateCreated INT UNSIGNED NOT NULL,
+  dateModified INT UNSIGNED NOT NULL,
+  UNIQUE KEY `key_phid` (phid),
+  UNIQUE KEY `key_object` (objectKey),
+  KEY `key_full` (applicationType, applicationDomain, objectType, objectID)
+) ENGINE=InnoDB, COLLATE utf8_general_ci;
+
+CREATE TABLE {$NAMESPACE}_doorkeeper.edge (
+  src VARCHAR(64) NOT NULL COLLATE utf8_bin,
+  type INT UNSIGNED NOT NULL COLLATE utf8_bin,
+  dst VARCHAR(64) NOT NULL COLLATE utf8_bin,
+  dateCreated INT UNSIGNED NOT NULL,
+  seq INT UNSIGNED NOT NULL,
+  dataID INT UNSIGNED,
+  PRIMARY KEY (src, type, dst),
+  KEY (src, type, dateCreated, seq)
+) ENGINE=InnoDB, COLLATE utf8_general_ci;
+
+CREATE TABLE {$NAMESPACE}_doorkeeper.edgedata (
+  id INT UNSIGNED NOT NULL PRIMARY KEY AUTO_INCREMENT,
+  data LONGTEXT NOT NULL COLLATE utf8_bin
+) ENGINE=InnoDB, COLLATE utf8_general_ci;
+

src/__phutil_library_map__.php

@@ -533,6 +533,8 @@ phutil_register_library_map(array(
     'DivinerRenderer' => 'applications/diviner/renderer/DivinerRenderer.php',
     'DivinerStaticPublisher' => 'applications/diviner/publisher/DivinerStaticPublisher.php',
     'DivinerWorkflow' => 'applications/diviner/workflow/DivinerWorkflow.php',
+    'DoorkeeperDAO' => 'applications/doorkeeper/storage/DoorkeeperDAO.php',
+    'DoorkeeperExternalObject' => 'applications/doorkeeper/storage/DoorkeeperExternalObject.php',
     'DrydockAllocatorWorker' => 'applications/drydock/worker/DrydockAllocatorWorker.php',
     'DrydockApacheWebrootInterface' => 'applications/drydock/interface/webroot/DrydockApacheWebrootInterface.php',
     'DrydockBlueprint' => 'applications/drydock/blueprint/DrydockBlueprint.php',
@@ -2404,6 +2406,12 @@ phutil_register_library_map(array(
     'DivinerRemarkupRuleSymbol' => 'PhutilRemarkupRule',
     'DivinerStaticPublisher' => 'DivinerPublisher',
     'DivinerWorkflow' => 'PhutilArgumentWorkflow',
+    'DoorkeeperDAO' => 'PhabricatorLiskDAO',
+    'DoorkeeperExternalObject' =>
+    array(
+      0 => 'DoorkeeperDAO',
+      1 => 'PhabricatorPolicyInterface',
+    ),
     'DrydockAllocatorWorker' => 'PhabricatorWorker',
     'DrydockApacheWebrootInterface' => 'DrydockWebrootInterface',
     'DrydockCommandInterface' => 'DrydockInterface',

src/applications/doorkeeper/storage/DoorkeeperDAO.php

@@ -0,0 +1,9 @@
+<?php
+
+abstract class DoorkeeperDAO extends PhabricatorLiskDAO {
+
+  public function getApplicationName() {
+    return 'doorkeeper';
+  }
+
+}

src/applications/doorkeeper/storage/DoorkeeperExternalObject.php

@@ -0,0 +1,79 @@
+<?php
+
+final class DoorkeeperExternalObject extends DoorkeeperDAO
+  implements PhabricatorPolicyInterface {
+
+  protected $objectKey;
+  protected $applicationType;
+  protected $applicationDomain;
+  protected $objectType;
+  protected $objectID;
+  protected $objectURI;
+  protected $importerPHID;
+  protected $properties = array();
+  protected $viewPolicy;
+
+  public function getConfiguration() {
+    return array(
+      self::CONFIG_AUX_PHID => true,
+      self::CONFIG_SERIALIZATION => array(
+        'properties' => self::SERIALIZATION_JSON,
+      ),
+    ) + parent::getConfiguration();
+  }
+
+  public function generatePHID() {
+    return PhabricatorPHID::generateNewPHID(
+      PhabricatorPHIDConstants::PHID_TYPE_XOBJ);
+  }
+
+  public function getProperty($key, $default = null) {
+    return idx($this->properties, $key, $default);
+  }
+
+  public function setProperty($key, $value) {
+    $this->properties[$key] = $value;
+    return $this;
+  }
+
+  public function getObjectKey() {
+    $key = parent::getObjectKey();
+    if ($key === null) {
+      $key = PhabricatorHash::digestForIndex(
+        implode(
+          ':',
+          array(
+            $this->getApplicationType(),
+            $this->getApplicationDomain(),
+            $this->getObjectType(),
+            $this->getObjectID(),
+          )));
+    }
+    return $key;
+  }
+
+  public function save() {
+    if (!$this->objectKey) {
+      $this->objectKey = $this->getObjectKey();
+    }
+    return parent::save();
+  }
+
+
+/* -(  PhabricatorPolicyInterface  )----------------------------------------- */
+
+  public function getCapabilities() {
+    return array(
+      PhabricatorPolicyCapability::CAN_VIEW,
+    );
+  }
+
+  public function getPolicy($capability) {
+    return $this->viewPolicy;
+  }
+
+  public function hasAutomaticCapability($capability, PhabricatorUser $viewer) {
+    return false;
+  }
+
+}

src/applications/phid/PhabricatorPHIDConstants.php

@@ -48,6 +48,7 @@ final class PhabricatorPHIDConstants {
   const PHID_TYPE_BOOK    = 'BOOK';
   const PHID_TYPE_ATOM    = 'ATOM';
   const PHID_TYPE_AUTH    = 'AUTH';
+  const PHID_TYPE_XOBJ    = 'XOBJ';
 
   const PHID_TYPE_VOID    = 'VOID';
   const PHID_VOID         = 'PHID-VOID-00000000000000000000';

src/infrastructure/storage/patch/PhabricatorBuiltinPatchList.php

@@ -195,6 +195,10 @@ final class PhabricatorBuiltinPatchList extends PhabricatorSQLPatchList {
         'type' => 'db',
         'name' => 'auth',
       ),
+      'db.doorkeeper' => array(
+        'type' => 'db',
+        'name' => 'doorkeeper',
+      ),
       '0000.legacy.sql' => array(
         'type'    => 'sql',
         'name'    => $this->getPatchPath('0000.legacy.sql'),
@@ -1394,6 +1398,10 @@ final class PhabricatorBuiltinPatchList extends PhabricatorSQLPatchList {
         'type' => 'sql',
         'name' => $this->getPatchPath('20130621.diffcommentunphid.sql'),
       ),
+      '20130622.doorkeeper.sql' => array(
+        'type' => 'sql',
+        'name' => $this->getPatchPath('20130622.doorkeeper.sql'),
+      ),
     );
   }
 }