1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
|
<?php
declare(strict_types=1);
/**
* @copyright 2021 Christopher Ng <chrng8@gmail.com>
*
* @author Christopher Ng <chrng8@gmail.com>
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
namespace OC\Core\Db;
use function Safe\json_decode;
use function Safe\json_encode;
use \JsonSerializable;
use OCP\Accounts\IAccountManager;
use OCP\AppFramework\Db\Entity;
use OCP\Profile\ParameterDoesNotExistException;
/**
* @method string getUserId()
* @method void setUserId(string $userId)
* @method string getConfig()
* @method void setConfig(string $config)
*/
class ProfileConfig extends Entity implements JsonSerializable {
/**
* Visible to users, guests, and public access
*
* @since 23.0.0
*/
public const VISIBILITY_SHOW = 'show';
/**
* Visible to users and guests
*
* @since 23.0.0
*/
public const VISIBILITY_SHOW_USERS_ONLY = 'show_users_only';
/**
* Visible to nobody
*
* @since 23.0.0
*/
public const VISIBILITY_HIDE = 'hide';
/**
* Default account property visibility
*
* @since 23.0.0
*/
public const DEFAULT_PROPERTY_VISIBILITY = [
IAccountManager::PROPERTY_ADDRESS => self::VISIBILITY_SHOW_USERS_ONLY,
IAccountManager::PROPERTY_AVATAR => self::VISIBILITY_SHOW,
IAccountManager::PROPERTY_BIOGRAPHY => self::VISIBILITY_SHOW,
IAccountManager::PROPERTY_DISPLAYNAME => self::VISIBILITY_SHOW,
IAccountManager::PROPERTY_HEADLINE => self::VISIBILITY_SHOW,
IAccountManager::PROPERTY_ORGANISATION => self::VISIBILITY_SHOW,
IAccountManager::PROPERTY_ROLE => self::VISIBILITY_SHOW,
IAccountManager::PROPERTY_EMAIL => self::VISIBILITY_SHOW_USERS_ONLY,
IAccountManager::PROPERTY_PHONE => self::VISIBILITY_SHOW_USERS_ONLY,
IAccountManager::PROPERTY_TWITTER => self::VISIBILITY_SHOW,
IAccountManager::PROPERTY_WEBSITE => self::VISIBILITY_SHOW,
];
/**
* Default visibility
*
* @since 23.0.0
*/
public const DEFAULT_VISIBILITY = self::VISIBILITY_SHOW_USERS_ONLY;
/** @var string */
protected $userId;
/** @var string */
protected $config;
public function __construct() {
$this->addType('userId', 'string');
$this->addType('config', 'string');
}
/**
* Returns the config in an associative array
*/
public function getConfigArray(): array {
return json_decode($this->config, true);
}
/**
* Set the config
*/
public function setConfigArray(array $config): void {
$this->setConfig(json_encode($config));
}
/**
* Returns the visibility map in an associative array
*/
public function getVisibilityMap(): array {
$config = $this->getConfigArray();
$visibilityMap = [];
foreach ($config as $paramId => $paramConfig) {
$visibilityMap[$paramId] = $paramConfig['visibility'];
}
return $visibilityMap;
}
/**
* Set the visibility map
*/
public function setVisibilityMap(array $visibilityMap): void {
$config = $this->getConfigArray();
foreach ($visibilityMap as $paramId => $visibility) {
$config[$paramId] = array_merge(
$config[$paramId] ?: [],
['visibility' => $visibility],
);
}
$this->setConfigArray($config);
}
/**
* Returns the visibility of the parameter
*
* @throws ParameterDoesNotExistException
*/
public function getVisibility(string $paramId): string {
$visibilityMap = $this->getVisibilityMap();
if (isset($visibilityMap[$paramId])) {
return $visibilityMap[$paramId];
}
throw new ParameterDoesNotExistException($paramId);
}
/**
* Set the visibility of the parameter
*/
public function setVisibility(string $paramId, string $visibility): void {
$visibilityMap = $this->getVisibilityMap();
$visibilityMap[$paramId] = $visibility;
$this->setVisibilityMap($visibilityMap);
}
public function jsonSerialize(): array {
return [
'userId' => $this->userId,
'config' => $this->getConfigArray(),
];
}
}
|
