src/applications/search/storage/PhabricatorProfileMenuItemConfiguration.php

   1 <?php
   2
   3 final class PhabricatorProfileMenuItemConfiguration
   4   extends PhabricatorSearchDAO
   5   implements
   6     PhabricatorPolicyInterface,
   7     PhabricatorExtendedPolicyInterface,
   8     PhabricatorApplicationTransactionInterface,
   9     PhabricatorIndexableInterface {
  10
  11   protected $profilePHID;
  12   protected $menuItemKey;
  13   protected $builtinKey;
  14   protected $menuItemOrder;
  15   protected $visibility;
  16   protected $customPHID;
  17   protected $menuItemProperties = array();
  18
  19   private $profileObject = self::ATTACHABLE;
  20   private $menuItem = self::ATTACHABLE;
  21   private $isHeadItem = false;
  22   private $isTailItem = false;
  23
  24   const VISIBILITY_DEFAULT = 'default';
  25   const VISIBILITY_VISIBLE = 'visible';
  26   const VISIBILITY_DISABLED = 'disabled';
  27
  28   public function getTableName() {
  29     // For now, this class uses an older table name.
  30     return 'search_profilepanelconfiguration';
  31   }
  32
  33   public static function initializeNewBuiltin() {
  34     return id(new self())
  35       ->setVisibility(self::VISIBILITY_VISIBLE);
  36   }
  37
  38   public static function initializeNewItem(
  39     $profile_object,
  40     PhabricatorProfileMenuItem $item,
  41     $custom_phid) {
  42
  43     return self::initializeNewBuiltin()
  44       ->setProfilePHID($profile_object->getPHID())
  45       ->setMenuItemKey($item->getMenuItemKey())
  46       ->attachMenuItem($item)
  47       ->attachProfileObject($profile_object)
  48       ->setCustomPHID($custom_phid);
  49   }
  50
  51   protected function getConfiguration() {
  52     return array(
  53       self::CONFIG_AUX_PHID => true,
  54       self::CONFIG_SERIALIZATION => array(
  55         'menuItemProperties' => self::SERIALIZATION_JSON,
  56       ),
  57       self::CONFIG_COLUMN_SCHEMA => array(
  58         'menuItemKey' => 'text64',
  59         'builtinKey' => 'text64?',
  60         'menuItemOrder' => 'uint32?',
  61         'customPHID' => 'phid?',
  62         'visibility' => 'text32',
  63       ),
  64       self::CONFIG_KEY_SCHEMA => array(
  65         'key_profile' => array(
  66           'columns' => array('profilePHID', 'menuItemOrder'),
  67         ),
  68       ),
  69     ) + parent::getConfiguration();
  70   }
  71
  72   public function generatePHID() {
  73     return PhabricatorPHID::generateNewPHID(
  74       PhabricatorProfileMenuItemPHIDType::TYPECONST);
  75   }
  76
  77   public function attachMenuItem(PhabricatorProfileMenuItem $item) {
  78     $this->menuItem = $item;
  79     return $this;
  80   }
  81
  82   public function getMenuItem() {
  83     return $this->assertAttached($this->menuItem);
  84   }
  85
  86   public function attachProfileObject($profile_object) {
  87     $this->profileObject = $profile_object;
  88     return $this;
  89   }
  90
  91   public function getProfileObject() {
  92     return $this->assertAttached($this->profileObject);
  93   }
  94
  95   public function setMenuItemProperty($key, $value) {
  96     $this->menuItemProperties[$key] = $value;
  97     return $this;
  98   }
  99
 100   public function getMenuItemProperty($key, $default = null) {
 101     return idx($this->menuItemProperties, $key, $default);
 102   }
 103
 104   public function getMenuItemTypeName() {
 105     return $this->getMenuItem()->getMenuItemTypeName();
 106   }
 107
 108   public function getDisplayName() {
 109     return $this->getMenuItem()->getDisplayName($this);
 110   }
 111
 112   public function canMakeDefault() {
 113     return $this->getMenuItem()->canMakeDefault($this);
 114   }
 115
 116   public function canHideMenuItem() {
 117     return $this->getMenuItem()->canHideMenuItem($this);
 118   }
 119
 120   public function shouldEnableForObject($object) {
 121     return $this->getMenuItem()->shouldEnableForObject($object);
 122   }
 123
 124   public function willGetMenuItemViewList(array $items) {
 125     return $this->getMenuItem()->willGetMenuItemViewList($items);
 126   }
 127
 128   public function getMenuItemViewList() {
 129     return $this->getMenuItem()->getMenuItemViewList($this);
 130   }
 131
 132   public function validateTransactions(array $map) {
 133     $item = $this->getMenuItem();
 134
 135     $fields = $item->buildEditEngineFields($this);
 136     $errors = array();
 137     foreach ($fields as $field) {
 138       $field_key = $field->getKey();
 139
 140       $xactions = idx($map, $field_key, array());
 141       $value = $this->getMenuItemProperty($field_key);
 142
 143       $field_errors = $item->validateTransactions(
 144         $this,
 145         $field_key,
 146         $value,
 147         $xactions);
 148       foreach ($field_errors as $error) {
 149         $errors[] = $error;
 150       }
 151     }
 152
 153     return $errors;
 154   }
 155
 156   public function getSortVector() {
 157     // Sort custom items above global items.
 158     if ($this->getCustomPHID()) {
 159       $is_global = 0;
 160     } else {
 161       $is_global = 1;
 162     }
 163
 164     // Sort "head" items above other items and "tail" items after other items.
 165     if ($this->getIsHeadItem()) {
 166       $force_position = 0;
 167     } else if ($this->getIsTailItem()) {
 168       $force_position = 2;
 169     } else {
 170       $force_position = 1;
 171     }
 172
 173     // Sort items with an explicit order above items without an explicit order,
 174     // so any newly created builtins go to the bottom.
 175     $order = $this->getMenuItemOrder();
 176     if ($order !== null) {
 177       $has_order = 0;
 178     } else {
 179       $has_order = 1;
 180     }
 181
 182     return id(new PhutilSortVector())
 183       ->addInt($is_global)
 184       ->addInt($force_position)
 185       ->addInt($has_order)
 186       ->addInt((int)$order)
 187       ->addInt((int)$this->getID());
 188   }
 189
 190   public function isDisabled() {
 191     if (!$this->canHideMenuItem()) {
 192       return false;
 193     }
 194     return ($this->getVisibility() === self::VISIBILITY_DISABLED);
 195   }
 196
 197   public function isDefault() {
 198     return ($this->getVisibility() === self::VISIBILITY_DEFAULT);
 199   }
 200
 201   public function getItemIdentifier() {
 202     $id = $this->getID();
 203
 204     if ($id) {
 205       return (int)$id;
 206     }
 207
 208     return $this->getBuiltinKey();
 209   }
 210
 211   public function getDefaultMenuItemKey() {
 212     if ($this->getBuiltinKey()) {
 213       return $this->getBuiltinKey();
 214     }
 215
 216     return $this->getPHID();
 217   }
 218
 219   public function newPageContent() {
 220     return $this->getMenuItem()->newPageContent($this);
 221   }
 222
 223   public function setIsHeadItem($is_head_item) {
 224     $this->isHeadItem = $is_head_item;
 225     return $this;
 226   }
 227
 228   public function getIsHeadItem() {
 229     return $this->isHeadItem;
 230   }
 231
 232   public function setIsTailItem($is_tail_item) {
 233     $this->isTailItem = $is_tail_item;
 234     return $this;
 235   }
 236
 237   public function getIsTailItem() {
 238     return $this->isTailItem;
 239   }
 240
 241   public function matchesIdentifier($identifier) {
 242     if (!strlen($identifier)) {
 243       return false;
 244     }
 245
 246     if (ctype_digit($identifier)) {
 247       if ((int)$this->getID() === (int)$identifier) {
 248         return true;
 249       }
 250     }
 251
 252     if ((string)$this->getBuiltinKey() === (string)$identifier) {
 253       return true;
 254     }
 255
 256     return false;
 257   }
 258
 259   public function getAffectedObjectPHIDs() {
 260     return $this->getMenuItem()->getAffectedObjectPHIDs($this);
 261   }
 262
 263   public function getProfileMenuTypeDescription() {
 264     $profile_phid = $this->getProfilePHID();
 265
 266     $home_phid = id(new PhabricatorHomeApplication())->getPHID();
 267     if ($profile_phid === $home_phid) {
 268       return pht('Home Menu');
 269     }
 270
 271     $favorites_phid = id(new PhabricatorFavoritesApplication())->getPHID();
 272     if ($profile_phid === $favorites_phid) {
 273       return pht('Favorites Menu');
 274     }
 275
 276     switch (phid_get_type($profile_phid)) {
 277       case PhabricatorProjectProjectPHIDType::TYPECONST:
 278         return pht('Project Menu');
 279       case PhabricatorDashboardPortalPHIDType::TYPECONST:
 280         return pht('Portal Menu');
 281     }
 282
 283     return pht('Profile Menu');
 284   }
 285
 286   public function newUsageSortVector() {
 287     // Used to sort items in contexts where we're showing the usage of an
 288     // object in menus, like "Dashboard Used By" on Dashboard pages.
 289
 290     // Sort usage as a custom item after usage as a global item.
 291     if ($this->getCustomPHID()) {
 292       $is_personal = 1;
 293     } else {
 294       $is_personal = 0;
 295     }
 296
 297     return id(new PhutilSortVector())
 298       ->addInt($is_personal)
 299       ->addInt($this->getID());
 300   }
 301
 302
 303 /* -(  PhabricatorPolicyInterface  )----------------------------------------- */
 304
 305
 306   public function getCapabilities() {
 307     return array(
 308       PhabricatorPolicyCapability::CAN_VIEW,
 309       PhabricatorPolicyCapability::CAN_EDIT,
 310     );
 311   }
 312
 313
 314   public function getPolicy($capability) {
 315     return PhabricatorPolicies::getMostOpenPolicy();
 316   }
 317
 318
 319   public function hasAutomaticCapability($capability, PhabricatorUser $viewer) {
 320     return $this->getProfileObject()->hasAutomaticCapability(
 321       $capability,
 322       $viewer);
 323   }
 324
 325
 326 /* -(  PhabricatorExtendedPolicyInterface  )--------------------------------- */
 327
 328
 329   public function getExtendedPolicy($capability, PhabricatorUser $viewer) {
 330     // If this is an item with a custom PHID (like a personal menu item),
 331     // we only require that the user can edit the corresponding custom
 332     // object (usually their own user profile), not the object that the
 333     // menu appears on (which may be an Application like Favorites or Home).
 334     if ($capability == PhabricatorPolicyCapability::CAN_EDIT) {
 335       if ($this->getCustomPHID()) {
 336         return array(
 337           array(
 338             $this->getCustomPHID(),
 339             $capability,
 340           ),
 341         );
 342       }
 343     }
 344
 345     return array(
 346       array(
 347         $this->getProfileObject(),
 348         $capability,
 349       ),
 350     );
 351   }
 352
 353
 354 /* -(  PhabricatorApplicationTransactionInterface  )------------------------- */
 355
 356
 357   public function getApplicationTransactionEditor() {
 358     return new PhabricatorProfileMenuEditor();
 359   }
 360
 361   public function getApplicationTransactionTemplate() {
 362     return new PhabricatorProfileMenuItemConfigurationTransaction();
 363   }
 364
 365 }