src/applications/phortune/storage/PhortuneSubscription.php

   1 <?php
   2
   3 /**
   4  * A subscription bills users regularly.
   5  */
   6 final class PhortuneSubscription
   7   extends PhortuneDAO
   8   implements
   9     PhabricatorPolicyInterface,
  10     PhabricatorExtendedPolicyInterface,
  11     PhabricatorPolicyCodexInterface,
  12     PhabricatorApplicationTransactionInterface {
  13
  14   const STATUS_ACTIVE = 'active';
  15   const STATUS_CANCELLED = 'cancelled';
  16
  17   protected $accountPHID;
  18   protected $merchantPHID;
  19   protected $triggerPHID;
  20   protected $authorPHID;
  21   protected $defaultPaymentMethodPHID;
  22   protected $subscriptionClassKey;
  23   protected $subscriptionClass;
  24   protected $subscriptionRefKey;
  25   protected $subscriptionRef;
  26   protected $status;
  27   protected $metadata = array();
  28
  29   private $merchant = self::ATTACHABLE;
  30   private $account = self::ATTACHABLE;
  31   private $implementation = self::ATTACHABLE;
  32   private $trigger = self::ATTACHABLE;
  33
  34   protected function getConfiguration() {
  35     return array(
  36       self::CONFIG_AUX_PHID => true,
  37       self::CONFIG_SERIALIZATION => array(
  38         'metadata' => self::SERIALIZATION_JSON,
  39       ),
  40       self::CONFIG_COLUMN_SCHEMA => array(
  41         'defaultPaymentMethodPHID' => 'phid?',
  42         'subscriptionClassKey' => 'bytes12',
  43         'subscriptionClass' => 'text128',
  44         'subscriptionRefKey' => 'bytes12',
  45         'subscriptionRef' => 'text128',
  46         'status' => 'text32',
  47       ),
  48       self::CONFIG_KEY_SCHEMA => array(
  49         'key_subscription' => array(
  50           'columns' => array('subscriptionClassKey', 'subscriptionRefKey'),
  51           'unique' => true,
  52         ),
  53         'key_account' => array(
  54           'columns' => array('accountPHID'),
  55         ),
  56         'key_merchant' => array(
  57           'columns' => array('merchantPHID'),
  58         ),
  59       ),
  60     ) + parent::getConfiguration();
  61   }
  62
  63   public function getPHIDType() {
  64     return PhortuneSubscriptionPHIDType::TYPECONST;
  65   }
  66
  67   public static function initializeNewSubscription(
  68     PhortuneAccount $account,
  69     PhortuneMerchant $merchant,
  70     PhabricatorUser $author,
  71     PhortuneSubscriptionImplementation $implementation,
  72     PhabricatorTriggerClock $clock) {
  73
  74     $trigger = id(new PhabricatorWorkerTrigger())
  75       ->setClock($clock);
  76
  77     return id(new PhortuneSubscription())
  78       ->setStatus(self::STATUS_ACTIVE)
  79       ->setAccountPHID($account->getPHID())
  80       ->attachAccount($account)
  81       ->setMerchantPHID($merchant->getPHID())
  82       ->attachMerchant($merchant)
  83       ->setAuthorPHID($author->getPHID())
  84       ->setSubscriptionClass(get_class($implementation))
  85       ->setSubscriptionRef($implementation->getRef())
  86       ->attachImplementation($implementation)
  87       ->attachTrigger($trigger);
  88   }
  89
  90   public function attachImplementation(
  91     PhortuneSubscriptionImplementation $impl) {
  92     $this->implementation = $impl;
  93     return $this;
  94   }
  95
  96   public function getImplementation() {
  97     return $this->assertAttached($this->implementation);
  98   }
  99
 100   public function attachAccount(PhortuneAccount $account) {
 101     $this->account = $account;
 102     return $this;
 103   }
 104
 105   public function getAccount() {
 106     return $this->assertAttached($this->account);
 107   }
 108
 109   public function attachMerchant(PhortuneMerchant $merchant) {
 110     $this->merchant = $merchant;
 111     return $this;
 112   }
 113
 114   public function getMerchant() {
 115     return $this->assertAttached($this->merchant);
 116   }
 117
 118   public function attachTrigger(PhabricatorWorkerTrigger $trigger) {
 119     $this->trigger = $trigger;
 120     return $this;
 121   }
 122
 123   public function getTrigger() {
 124     return $this->assertAttached($this->trigger);
 125   }
 126
 127   public function save() {
 128     $this->subscriptionClassKey = PhabricatorHash::digestForIndex(
 129       $this->subscriptionClass);
 130
 131     $this->subscriptionRefKey = PhabricatorHash::digestForIndex(
 132       $this->subscriptionRef);
 133
 134     $is_new = (!$this->getID());
 135
 136     $this->openTransaction();
 137
 138       // If we're saving this subscription for the first time, we're also
 139       // going to set up the trigger for it.
 140       if ($is_new) {
 141         $trigger_phid = PhabricatorPHID::generateNewPHID(
 142           PhabricatorWorkerTriggerPHIDType::TYPECONST);
 143         $this->setTriggerPHID($trigger_phid);
 144       }
 145
 146       $result = parent::save();
 147
 148       if ($is_new) {
 149         $trigger_action = new PhabricatorScheduleTaskTriggerAction(
 150           array(
 151             'class' => 'PhortuneSubscriptionWorker',
 152             'data' => array(
 153               'subscriptionPHID' => $this->getPHID(),
 154             ),
 155             'options' => array(
 156               'objectPHID' => $this->getPHID(),
 157               'priority' => PhabricatorWorker::PRIORITY_BULK,
 158             ),
 159           ));
 160
 161         $trigger = $this->getTrigger();
 162         $trigger->setPHID($trigger_phid);
 163         $trigger->setAction($trigger_action);
 164         $trigger->save();
 165       }
 166     $this->saveTransaction();
 167
 168     $account = $this->getAccount();
 169     $merchant = $this->getMerchant();
 170     $account->writeMerchantEdge($merchant);
 171
 172     return $result;
 173   }
 174
 175   public function getSubscriptionName() {
 176     return $this->getImplementation()->getName($this);
 177   }
 178
 179   public function getSubscriptionFullName() {
 180     return $this->getImplementation()->getFullName($this);
 181   }
 182
 183   public function getSubscriptionCrumbName() {
 184     return $this->getImplementation()->getCrumbName($this);
 185   }
 186
 187   public function getCartName(PhortuneCart $cart) {
 188     return $this->getImplementation()->getCartName($this, $cart);
 189   }
 190
 191   public function getURI() {
 192     return urisprintf(
 193       '/phortune/account/%d/subscriptions/%d/',
 194       $this->getAccount()->getID(),
 195       $this->getID());
 196   }
 197
 198   public function getEditURI() {
 199     $account_id = $this->getAccount()->getID();
 200     $id = $this->getID();
 201
 202     return "/phortune/{$account_id}/subscription/edit/{$id}/";
 203   }
 204
 205   public function getMerchantURI() {
 206     $merchant_id = $this->getMerchant()->getID();
 207     $id = $this->getID();
 208     return "/phortune/merchant/{$merchant_id}/subscription/view/{$id}/";
 209   }
 210
 211   public function getCostForBillingPeriodAsCurrency($start_epoch, $end_epoch) {
 212     return $this->getImplementation()->getCostForBillingPeriodAsCurrency(
 213       $this,
 214       $start_epoch,
 215       $end_epoch);
 216   }
 217
 218   public function shouldInvoiceForBillingPeriod($start_epoch, $end_epoch) {
 219     return $this->getImplementation()->shouldInvoiceForBillingPeriod(
 220       $this,
 221       $start_epoch,
 222       $end_epoch);
 223   }
 224
 225   public function getPurchaseName(
 226     PhortuneProduct $product,
 227     PhortunePurchase $purchase) {
 228     return $this->getImplementation()->getPurchaseName(
 229       $this,
 230       $product,
 231       $purchase);
 232   }
 233
 234   public function getPurchaseURI(
 235     PhortuneProduct $product,
 236     PhortunePurchase $purchase) {
 237     return $this->getImplementation()->getPurchaseURI(
 238       $this,
 239       $product,
 240       $purchase);
 241   }
 242
 243   public function didPurchaseProduct(
 244     PhortuneProduct $product,
 245     PhortunePurchase $purchase) {
 246     return $this->getImplementation()->didPurchaseProduct(
 247       $this,
 248       $product,
 249       $purchase);
 250   }
 251
 252 /* -(  PhabricatorApplicationTransactionInterface  )------------------------- */
 253
 254
 255   public function getApplicationTransactionEditor() {
 256     return new PhortuneSubscriptionEditor();
 257   }
 258
 259   public function getApplicationTransactionTemplate() {
 260     return new PhortuneSubscriptionTransaction();
 261   }
 262
 263 /* -(  PhabricatorPolicyInterface  )----------------------------------------- */
 264
 265
 266   public function getCapabilities() {
 267     return array(
 268       PhabricatorPolicyCapability::CAN_VIEW,
 269       PhabricatorPolicyCapability::CAN_EDIT,
 270     );
 271   }
 272
 273   public function getPolicy($capability) {
 274     return PhabricatorPolicies::getMostOpenPolicy();
 275   }
 276
 277   public function hasAutomaticCapability($capability, PhabricatorUser $viewer) {
 278     // See T13366. If you can edit the merchant associated with this
 279     // subscription, you can view the subscription.
 280     if ($capability === PhabricatorPolicyCapability::CAN_VIEW) {
 281       $any_edit = PhortuneMerchantQuery::canViewersEditMerchants(
 282         array($viewer->getPHID()),
 283         array($this->getMerchantPHID()));
 284       if ($any_edit) {
 285         return true;
 286       }
 287     }
 288
 289     return false;
 290   }
 291
 292
 293 /* -(  PhabricatorExtendedPolicyInterface  )--------------------------------- */
 294
 295
 296   public function getExtendedPolicy($capability, PhabricatorUser $viewer) {
 297     if ($this->hasAutomaticCapability($capability, $viewer)) {
 298       return array();
 299     }
 300
 301     // See T13366. For blanket view and edit permissions on all subscriptions,
 302     // you must be able to edit the associated account.
 303     return array(
 304       array(
 305         $this->getAccount(),
 306         PhabricatorPolicyCapability::CAN_EDIT,
 307       ),
 308     );
 309   }
 310
 311
 312 /* -(  PhabricatorPolicyCodexInterface  )------------------------------------ */
 313
 314
 315   public function newPolicyCodex() {
 316     return new PhortuneSubscriptionPolicyCodex();
 317   }
 318
 319 }