src/applications/settings/editor/PhabricatorUserPreferencesEditor.php

   1 <?php
   2
   3 final class PhabricatorUserPreferencesEditor
   4   extends PhabricatorApplicationTransactionEditor {
   5
   6   public function getEditorApplicationClass() {
   7     return 'PhabricatorSettingsApplication';
   8   }
   9
  10   public function getEditorObjectsDescription() {
  11     return pht('Settings');
  12   }
  13
  14   public function getTransactionTypes() {
  15     $types = parent::getTransactionTypes();
  16
  17     $types[] = PhabricatorUserPreferencesTransaction::TYPE_SETTING;
  18
  19     return $types;
  20   }
  21
  22   protected function expandTransaction(
  23     PhabricatorLiskDAO $object,
  24     PhabricatorApplicationTransaction $xaction) {
  25
  26     $setting_key = $xaction->getMetadataValue(
  27       PhabricatorUserPreferencesTransaction::PROPERTY_SETTING);
  28
  29     $settings = $this->getSettings();
  30     $setting = idx($settings, $setting_key);
  31     if ($setting) {
  32       return $setting->expandSettingTransaction($object, $xaction);
  33     }
  34
  35     return parent::expandTransaction($object, $xaction);
  36   }
  37
  38
  39   protected function getCustomTransactionOldValue(
  40     PhabricatorLiskDAO $object,
  41     PhabricatorApplicationTransaction $xaction) {
  42
  43     $setting_key = $xaction->getMetadataValue(
  44       PhabricatorUserPreferencesTransaction::PROPERTY_SETTING);
  45
  46     switch ($xaction->getTransactionType()) {
  47       case PhabricatorUserPreferencesTransaction::TYPE_SETTING:
  48         return $object->getPreference($setting_key);
  49     }
  50
  51     return parent::getCustomTransactionOldValue($object, $xaction);
  52   }
  53
  54   protected function getCustomTransactionNewValue(
  55     PhabricatorLiskDAO $object,
  56     PhabricatorApplicationTransaction $xaction) {
  57
  58     $actor = $this->getActor();
  59
  60     $setting_key = $xaction->getMetadataValue(
  61       PhabricatorUserPreferencesTransaction::PROPERTY_SETTING);
  62
  63     $settings = PhabricatorSetting::getAllEnabledSettings($actor);
  64     $setting = $settings[$setting_key];
  65
  66     switch ($xaction->getTransactionType()) {
  67       case PhabricatorUserPreferencesTransaction::TYPE_SETTING:
  68         $value = $xaction->getNewValue();
  69         $value = $setting->getTransactionNewValue($value);
  70         return $value;
  71     }
  72
  73     return parent::getCustomTransactionNewValue($object, $xaction);
  74   }
  75
  76   protected function applyCustomInternalTransaction(
  77     PhabricatorLiskDAO $object,
  78     PhabricatorApplicationTransaction $xaction) {
  79
  80     $setting_key = $xaction->getMetadataValue(
  81       PhabricatorUserPreferencesTransaction::PROPERTY_SETTING);
  82
  83     switch ($xaction->getTransactionType()) {
  84       case PhabricatorUserPreferencesTransaction::TYPE_SETTING:
  85         $new_value = $xaction->getNewValue();
  86         if ($new_value === null) {
  87           $object->unsetPreference($setting_key);
  88         } else {
  89           $object->setPreference($setting_key, $new_value);
  90         }
  91         return;
  92     }
  93
  94     return parent::applyCustomInternalTransaction($object, $xaction);
  95   }
  96
  97   protected function applyCustomExternalTransaction(
  98     PhabricatorLiskDAO $object,
  99     PhabricatorApplicationTransaction $xaction) {
 100
 101     switch ($xaction->getTransactionType()) {
 102       case PhabricatorUserPreferencesTransaction::TYPE_SETTING:
 103         return;
 104     }
 105
 106     return parent::applyCustomExternalTransaction($object, $xaction);
 107   }
 108
 109   protected function validateTransaction(
 110     PhabricatorLiskDAO $object,
 111     $type,
 112     array $xactions) {
 113
 114     $errors = parent::validateTransaction($object, $type, $xactions);
 115     $settings = $this->getSettings();
 116
 117     switch ($type) {
 118       case PhabricatorUserPreferencesTransaction::TYPE_SETTING:
 119         foreach ($xactions as $xaction) {
 120           $setting_key = $xaction->getMetadataValue(
 121             PhabricatorUserPreferencesTransaction::PROPERTY_SETTING);
 122
 123           $setting = idx($settings, $setting_key);
 124           if (!$setting) {
 125             $errors[] = new PhabricatorApplicationTransactionValidationError(
 126               $type,
 127               pht('Invalid'),
 128               pht(
 129                 'There is no known application setting with key "%s".',
 130                 $setting_key),
 131               $xaction);
 132             continue;
 133           }
 134
 135           try {
 136             $setting->validateTransactionValue($xaction->getNewValue());
 137           } catch (Exception $ex) {
 138             $errors[] = new PhabricatorApplicationTransactionValidationError(
 139               $type,
 140               pht('Invalid'),
 141               $ex->getMessage(),
 142               $xaction);
 143           }
 144         }
 145         break;
 146     }
 147
 148     return $errors;
 149   }
 150
 151   protected function applyFinalEffects(
 152     PhabricatorLiskDAO $object,
 153     array $xactions) {
 154
 155     $user_phid = $object->getUserPHID();
 156     if ($user_phid) {
 157       PhabricatorUserCache::clearCache(
 158         PhabricatorUserPreferencesCacheType::KEY_PREFERENCES,
 159         $user_phid);
 160     } else {
 161       $cache = PhabricatorCaches::getMutableStructureCache();
 162       $cache->deleteKey(PhabricatorUser::getGlobalSettingsCacheKey());
 163
 164       PhabricatorUserCache::clearCacheForAllUsers(
 165         PhabricatorUserPreferencesCacheType::KEY_PREFERENCES);
 166     }
 167
 168     return $xactions;
 169   }
 170
 171   private function getSettings() {
 172     $actor = $this->getActor();
 173     $settings = PhabricatorSetting::getAllEnabledSettings($actor);
 174
 175     foreach ($settings as $key => $setting) {
 176       $setting = clone $setting;
 177       $setting->setViewer($actor);
 178       $settings[$key] = $setting;
 179     }
 180
 181     return $settings;
 182   }
 183
 184 }