src/applications/settings/editor/PhabricatorSettingsEditEngine.php

   1 <?php
   2
   3 final class PhabricatorSettingsEditEngine
   4   extends PhabricatorEditEngine {
   5
   6   const ENGINECONST = 'settings.settings';
   7
   8   private $isSelfEdit;
   9   private $profileURI;
  10   private $settingsPanel;
  11
  12   public function setIsSelfEdit($is_self_edit) {
  13     $this->isSelfEdit = $is_self_edit;
  14     return $this;
  15   }
  16
  17   public function getIsSelfEdit() {
  18     return $this->isSelfEdit;
  19   }
  20
  21   public function setProfileURI($profile_uri) {
  22     $this->profileURI = $profile_uri;
  23     return $this;
  24   }
  25
  26   public function getProfileURI() {
  27     return $this->profileURI;
  28   }
  29
  30   public function setSettingsPanel($settings_panel) {
  31     $this->settingsPanel = $settings_panel;
  32     return $this;
  33   }
  34
  35   public function getSettingsPanel() {
  36     return $this->settingsPanel;
  37   }
  38
  39   public function isEngineConfigurable() {
  40     return false;
  41   }
  42
  43   public function getEngineName() {
  44     return pht('Settings');
  45   }
  46
  47   public function getSummaryHeader() {
  48     return pht('Edit Settings Configurations');
  49   }
  50
  51   public function getSummaryText() {
  52     return pht('This engine is used to edit settings.');
  53   }
  54
  55   public function getEngineApplicationClass() {
  56     return 'PhabricatorSettingsApplication';
  57   }
  58
  59   protected function newEditableObject() {
  60     return new PhabricatorUserPreferences();
  61   }
  62
  63   protected function newObjectQuery() {
  64     return new PhabricatorUserPreferencesQuery();
  65   }
  66
  67   protected function getObjectCreateTitleText($object) {
  68     return pht('Create Settings');
  69   }
  70
  71   protected function getObjectCreateButtonText($object) {
  72     return pht('Create Settings');
  73   }
  74
  75   protected function getObjectEditTitleText($object) {
  76     $page = $this->getSelectedPage();
  77
  78     if ($page) {
  79       return $page->getLabel();
  80     }
  81
  82     return pht('Settings');
  83   }
  84
  85   protected function getObjectEditShortText($object) {
  86     if (!$object->getUser()) {
  87       return pht('Global Defaults');
  88     } else {
  89       if ($this->getIsSelfEdit()) {
  90         return pht('Personal Settings');
  91       } else {
  92         return pht('Account Settings');
  93       }
  94     }
  95   }
  96
  97   protected function getObjectCreateShortText() {
  98     return pht('Create Settings');
  99   }
 100
 101   protected function getObjectName() {
 102     $page = $this->getSelectedPage();
 103
 104     if ($page) {
 105       return $page->getLabel();
 106     }
 107
 108     return pht('Settings');
 109   }
 110
 111   protected function getPageHeader($object) {
 112     $user = $object->getUser();
 113     if ($user) {
 114       $text = pht('Edit Settings: %s', $user->getUserName());
 115     } else {
 116       $text = pht('Edit Global Settings');
 117     }
 118
 119     $header = id(new PHUIHeaderView())
 120       ->setHeader($text);
 121
 122     return $header;
 123   }
 124
 125   protected function getEditorURI() {
 126     throw new PhutilMethodNotImplementedException();
 127   }
 128
 129   protected function getObjectCreateCancelURI($object) {
 130     return '/settings/';
 131   }
 132
 133   protected function getObjectViewURI($object) {
 134     return $object->getEditURI();
 135   }
 136
 137   protected function getCreateNewObjectPolicy() {
 138     return PhabricatorPolicies::POLICY_ADMIN;
 139   }
 140
 141   public function getEffectiveObjectEditCancelURI($object) {
 142     if (!$object->getUser()) {
 143       return '/settings/';
 144     }
 145
 146     if ($this->getIsSelfEdit()) {
 147       return null;
 148     }
 149
 150     if ($this->getProfileURI()) {
 151       return $this->getProfileURI();
 152     }
 153
 154     return parent::getEffectiveObjectEditCancelURI($object);
 155   }
 156
 157   protected function newPages($object) {
 158     $viewer = $this->getViewer();
 159     $user = $object->getUser();
 160
 161     $panels = PhabricatorSettingsPanel::getAllDisplayPanels();
 162
 163     foreach ($panels as $key => $panel) {
 164       if (!($panel instanceof PhabricatorEditEngineSettingsPanel)) {
 165         unset($panels[$key]);
 166         continue;
 167       }
 168
 169       $panel->setViewer($viewer);
 170       if ($user) {
 171         $panel->setUser($user);
 172       }
 173     }
 174
 175     $pages = array();
 176     $uris = array();
 177     foreach ($panels as $key => $panel) {
 178       $uris[$key] = $panel->getPanelURI();
 179
 180       $page = $panel->newEditEnginePage();
 181       if (!$page) {
 182         continue;
 183       }
 184       $pages[] = $page;
 185     }
 186
 187     $more_pages = array(
 188       id(new PhabricatorEditPage())
 189         ->setKey('extra')
 190         ->setLabel(pht('Extra Settings'))
 191         ->setIsDefault(true),
 192     );
 193
 194     foreach ($more_pages as $page) {
 195       $pages[] = $page;
 196     }
 197
 198     return $pages;
 199   }
 200
 201   protected function buildCustomEditFields($object) {
 202     $viewer = $this->getViewer();
 203     $settings = PhabricatorSetting::getAllEnabledSettings($viewer);
 204
 205     foreach ($settings as $key => $setting) {
 206       $setting = clone $setting;
 207       $setting->setViewer($viewer);
 208       $settings[$key] = $setting;
 209     }
 210
 211     $settings = msortv($settings, 'getSettingOrderVector');
 212
 213     $fields = array();
 214     foreach ($settings as $setting) {
 215       foreach ($setting->newCustomEditFields($object) as $field) {
 216         $fields[] = $field;
 217       }
 218     }
 219
 220     return $fields;
 221   }
 222
 223   protected function getValidationExceptionShortMessage(
 224     PhabricatorApplicationTransactionValidationException $ex,
 225     PhabricatorEditField $field) {
 226
 227     // Settings fields all have the same transaction type so we need to make
 228     // sure the transaction is changing the same setting before matching an
 229     // error to a given field.
 230     $xaction_type = $field->getTransactionType();
 231     if ($xaction_type == PhabricatorUserPreferencesTransaction::TYPE_SETTING) {
 232       $property = PhabricatorUserPreferencesTransaction::PROPERTY_SETTING;
 233
 234       $field_setting = idx($field->getMetadata(), $property);
 235       foreach ($ex->getErrors() as $error) {
 236         if ($error->getType() !== $xaction_type) {
 237           continue;
 238         }
 239
 240         $xaction = $error->getTransaction();
 241         if (!$xaction) {
 242           continue;
 243         }
 244
 245         $xaction_setting = $xaction->getMetadataValue($property);
 246         if ($xaction_setting != $field_setting) {
 247           continue;
 248         }
 249
 250         $short_message = $error->getShortMessage();
 251         if ($short_message !== null) {
 252           return $short_message;
 253         }
 254       }
 255
 256       return null;
 257     }
 258
 259     return parent::getValidationExceptionShortMessage($ex, $field);
 260   }
 261
 262   protected function newEditFormHeadContent(
 263     PhabricatorEditEnginePageState $state) {
 264
 265     $content = array();
 266
 267     if ($state->getIsSave()) {
 268       $content[] = id(new PHUIInfoView())
 269         ->setSeverity(PHUIInfoView::SEVERITY_NOTICE)
 270         ->appendChild(pht('Changes saved.'));
 271     }
 272
 273     $panel = $this->getSettingsPanel();
 274     $content[] = $panel->newSettingsPanelEditFormHeadContent($state);
 275
 276     return $content;
 277   }
 278
 279   protected function newEditFormTailContent(
 280     PhabricatorEditEnginePageState $state) {
 281
 282     $content = array();
 283
 284     $panel = $this->getSettingsPanel();
 285     $content[] = $panel->newSettingsPanelEditFormTailContent($state);
 286
 287     return $content;
 288   }
 289
 290 }