Page Menu
Home
c4science
Search
Configure Global Search
Log In
Files
F79286617
PhabricatorUserPreferences.php
No One
Temporary
Actions
Download File
Edit File
Delete File
View Transforms
Subscribe
Mute Notifications
Award Token
Subscribers
None
File Metadata
Details
File Info
Storage
Attached
Created
Sun, Aug 25, 15:53
Size
6 KB
Mime Type
text/x-php
Expires
Tue, Aug 27, 15:53 (1 d, 21 h)
Engine
blob
Format
Raw Data
Handle
20171084
Attached To
rPH Phabricator
PhabricatorUserPreferences.php
View Options
<?php
final
class
PhabricatorUserPreferences
extends
PhabricatorUserDAO
implements
PhabricatorPolicyInterface
,
PhabricatorDestructibleInterface
,
PhabricatorApplicationTransactionInterface
{
const
BUILTIN_GLOBAL_DEFAULT
=
'global'
;
protected
$userPHID
;
protected
$preferences
=
array
();
protected
$builtinKey
;
private
$user
=
self
::
ATTACHABLE
;
private
$defaultSettings
;
protected
function
getConfiguration
()
{
return
array
(
self
::
CONFIG_AUX_PHID
=>
true
,
self
::
CONFIG_SERIALIZATION
=>
array
(
'preferences'
=>
self
::
SERIALIZATION_JSON
,
),
self
::
CONFIG_COLUMN_SCHEMA
=>
array
(
'userPHID'
=>
'phid?'
,
'builtinKey'
=>
'text32?'
,
),
self
::
CONFIG_KEY_SCHEMA
=>
array
(
'key_user'
=>
array
(
'columns'
=>
array
(
'userPHID'
),
'unique'
=>
true
,
),
'key_builtin'
=>
array
(
'columns'
=>
array
(
'builtinKey'
),
'unique'
=>
true
,
),
),
)
+
parent
::
getConfiguration
();
}
public
function
generatePHID
()
{
return
PhabricatorPHID
::
generateNewPHID
(
PhabricatorUserPreferencesPHIDType
::
TYPECONST
);
}
public
function
getPreference
(
$key
,
$default
=
null
)
{
return
idx
(
$this
->
preferences
,
$key
,
$default
);
}
public
function
setPreference
(
$key
,
$value
)
{
$this
->
preferences
[
$key
]
=
$value
;
return
$this
;
}
public
function
unsetPreference
(
$key
)
{
unset
(
$this
->
preferences
[
$key
]);
return
$this
;
}
public
function
getDefaultValue
(
$key
)
{
if
(
$this
->
defaultSettings
)
{
return
$this
->
defaultSettings
->
getSettingValue
(
$key
);
}
$setting
=
self
::
getSettingObject
(
$key
);
if
(!
$setting
)
{
return
null
;
}
$setting
=
id
(
clone
$setting
)
->
setViewer
(
$this
->
getUser
());
return
$setting
->
getSettingDefaultValue
();
}
public
function
getSettingValue
(
$key
)
{
if
(
array_key_exists
(
$key
,
$this
->
preferences
))
{
return
$this
->
preferences
[
$key
];
}
return
$this
->
getDefaultValue
(
$key
);
}
private
static
function
getSettingObject
(
$key
)
{
$settings
=
PhabricatorSetting
::
getAllSettings
();
return
idx
(
$settings
,
$key
);
}
public
function
attachDefaultSettings
(
PhabricatorUserPreferences
$settings
)
{
$this
->
defaultSettings
=
$settings
;
return
$this
;
}
public
function
attachUser
(
PhabricatorUser
$user
=
null
)
{
$this
->
user
=
$user
;
return
$this
;
}
public
function
getUser
()
{
return
$this
->
assertAttached
(
$this
->
user
);
}
public
function
hasManagedUser
()
{
$user_phid
=
$this
->
getUserPHID
();
if
(!
$user_phid
)
{
return
false
;
}
$user
=
$this
->
getUser
();
if
(
$user
->
getIsSystemAgent
()
||
$user
->
getIsMailingList
())
{
return
true
;
}
return
false
;
}
/**
* Load or create a preferences object for the given user.
*
* @param PhabricatorUser User to load or create preferences for.
*/
public
static
function
loadUserPreferences
(
PhabricatorUser
$user
)
{
return
id
(
new
PhabricatorUserPreferencesQuery
())
->
setViewer
(
$user
)
->
withUsers
(
array
(
$user
))
->
needSyntheticPreferences
(
true
)
->
executeOne
();
}
/**
* Load or create a global preferences object.
*
* If no global preferences exist, an empty preferences object is returned.
*
* @param PhabricatorUser Viewing user.
*/
public
static
function
loadGlobalPreferences
(
PhabricatorUser
$viewer
)
{
$global
=
id
(
new
PhabricatorUserPreferencesQuery
())
->
setViewer
(
$viewer
)
->
withBuiltinKeys
(
array
(
self
::
BUILTIN_GLOBAL_DEFAULT
,
))
->
executeOne
();
if
(!
$global
)
{
$global
=
id
(
new
self
())
->
attachUser
(
new
PhabricatorUser
());
}
return
$global
;
}
public
function
newTransaction
(
$key
,
$value
)
{
$setting_property
=
PhabricatorUserPreferencesTransaction
::
PROPERTY_SETTING
;
$xaction_type
=
PhabricatorUserPreferencesTransaction
::
TYPE_SETTING
;
return
id
(
clone
$this
->
getApplicationTransactionTemplate
())
->
setTransactionType
(
$xaction_type
)
->
setMetadataValue
(
$setting_property
,
$key
)
->
setNewValue
(
$value
);
}
public
function
getEditURI
()
{
if
(
$this
->
getUser
())
{
return
'/settings/user/'
.
$this
->
getUser
()->
getUsername
().
'/'
;
}
else
{
return
'/settings/builtin/'
.
$this
->
getBuiltinKey
().
'/'
;
}
}
public
function
getDisplayName
()
{
if
(
$this
->
getBuiltinKey
())
{
return
pht
(
'Global Default Settings'
);
}
return
pht
(
'Personal Settings'
);
}
/* -( PhabricatorPolicyInterface )----------------------------------------- */
public
function
getCapabilities
()
{
return
array
(
PhabricatorPolicyCapability
::
CAN_VIEW
,
PhabricatorPolicyCapability
::
CAN_EDIT
,
);
}
public
function
getPolicy
(
$capability
)
{
switch
(
$capability
)
{
case
PhabricatorPolicyCapability
::
CAN_VIEW
:
$user_phid
=
$this
->
getUserPHID
();
if
(
$user_phid
)
{
return
$user_phid
;
}
return
PhabricatorPolicies
::
getMostOpenPolicy
();
case
PhabricatorPolicyCapability
::
CAN_EDIT
:
if
(
$this
->
hasManagedUser
())
{
return
PhabricatorPolicies
::
POLICY_ADMIN
;
}
$user_phid
=
$this
->
getUserPHID
();
if
(
$user_phid
)
{
return
$user_phid
;
}
return
PhabricatorPolicies
::
POLICY_ADMIN
;
}
}
public
function
hasAutomaticCapability
(
$capability
,
PhabricatorUser
$viewer
)
{
if
(
$this
->
hasManagedUser
())
{
if
(
$viewer
->
getIsAdmin
())
{
return
true
;
}
}
switch
(
$this
->
getBuiltinKey
())
{
case
self
::
BUILTIN_GLOBAL_DEFAULT
:
// NOTE: Without this policy exception, the logged-out viewer can not
// see global preferences.
return
true
;
}
return
false
;
}
/* -( PhabricatorDestructibleInterface )----------------------------------- */
public
function
destroyObjectPermanently
(
PhabricatorDestructionEngine
$engine
)
{
$this
->
delete
();
}
/* -( PhabricatorApplicationTransactionInterface )------------------------- */
public
function
getApplicationTransactionEditor
()
{
return
new
PhabricatorUserPreferencesEditor
();
}
public
function
getApplicationTransactionTemplate
()
{
return
new
PhabricatorUserPreferencesTransaction
();
}
}
Event Timeline
Log In to Comment