3 namespace Friendica\Repository;
5 use Friendica\BaseModel;
6 use Friendica\BaseRepository;
7 use Friendica\Collection;
8 use Friendica\Database\Database;
9 use Friendica\Database\DBA;
12 use Friendica\Util\DateTimeFormat;
13 use Psr\Log\LoggerInterface;
15 class ProfileField extends BaseRepository
17 protected static $table_name = 'profile_field';
19 protected static $model_class = Model\ProfileField::class;
21 protected static $collection_class = Collection\ProfileFields::class;
23 /** @var PermissionSet */
24 private $permissionSet;
26 public function __construct(Database $dba, LoggerInterface $logger, PermissionSet $permissionSet)
28 parent::__construct($dba, $logger);
30 $this->permissionSet = $permissionSet;
35 * @return Model\ProfileField
37 protected function create(array $data)
39 return new Model\ProfileField($this->dba, $this->logger, $this->permissionSet, $data);
43 * @param array $condition
44 * @return Model\ProfileField
45 * @throws \Friendica\Network\HTTPException\NotFoundException
47 public function selectFirst(array $condition)
49 return parent::selectFirst($condition);
53 * @param array $condition
54 * @param array $params
55 * @return Collection\ProfileFields
58 public function select(array $condition = [], array $params = [])
60 return parent::select($condition, $params);
64 * @param array $condition
65 * @param array $params
66 * @param int|null $max_id
67 * @param int|null $since_id
69 * @return Collection\ProfileFields
72 public function selectByBoundaries(array $condition = [], array $params = [], int $max_id = null, int $since_id = null, int $limit = self::LIMIT)
74 return parent::selectByBoundaries($condition, $params, $max_id, $since_id, $limit);
78 * @param int $uid Field owner user Id
79 * @return Collection\ProfileFields
82 public function selectByUserId(int $uid)
86 ['order' => ['order']]
91 * Retrieve all custom profile field a given contact is able to access to, including public profile fields.
93 * @param int $cid Private contact id, must be owned by $uid
94 * @param int $uid Field owner user id
95 * @return Collection\ProfileFields
98 public function selectByContactId(int $cid, int $uid)
100 $permissionSets = $this->permissionSet->selectByContactId($cid, $uid);
102 $psids = $permissionSets->column('id');
104 // Includes public custom fields
107 return $this->select(
108 ['uid' => $uid, 'psid' => $psids],
109 ['order' => ['order']]
114 * @param array $fields
115 * @return Model\ProfileField|bool
118 public function insert(array $fields)
120 $fields['created'] = DateTimeFormat::utcNow();
121 $fields['edited'] = DateTimeFormat::utcNow();
123 return parent::insert($fields);
127 * @param Model\ProfileField $model
131 public function update(BaseModel $model)
133 $model->edited = DateTimeFormat::utcNow();
135 return parent::update($model);
139 * @param int $uid User Id
140 * @param Collection\ProfileFields $profileFields Collection of existing profile fields
141 * @param array $profileFieldInputs Array of profile field form inputs indexed by profile field id
142 * @param array $profileFieldOrder List of profile field id in order
143 * @return Collection\ProfileFields
146 public function updateCollectionFromForm(int $uid, Collection\ProfileFields $profileFields, array $profileFieldInputs, array $profileFieldOrder)
148 $aclFormatter = DI::aclFormatter();
150 // Returns an associative array of id => order values
151 $profileFieldOrder = array_flip($profileFieldOrder);
153 // Creation of the new field
154 if (!empty($profileFieldInputs['new']['label'])) {
155 $psid = $this->permissionSet->getIdFromACL(
157 $aclFormatter->toString($profileFieldInputs['new']['contact_allow'] ?? ''),
158 $aclFormatter->toString($profileFieldInputs['new']['group_allow'] ?? ''),
159 $aclFormatter->toString($profileFieldInputs['new']['contact_deny'] ?? ''),
160 $aclFormatter->toString($profileFieldInputs['new']['group_deny'] ?? '')
163 $newProfileField = $this->insert([
165 'label' => $profileFieldInputs['new']['label'],
166 'value' => $profileFieldInputs['new']['value'],
168 'order' => $profileFieldOrder['new'],
171 $profileFieldInputs[$newProfileField->id] = $profileFieldInputs['new'];
172 $profileFieldOrder[$newProfileField->id] = $profileFieldOrder['new'];
174 $profileFields[] = $newProfileField;
177 unset($profileFieldInputs['new']);
178 unset($profileFieldOrder['new']);
180 // Prunes profile field whose label has been emptied
181 $profileFields = $profileFields->filter(function (Model\ProfileField $profileField) use (&$profileFieldInputs, &$profileFieldOrder) {
182 $keepModel = !isset($profileFieldInputs[$profileField->id]) || !empty($profileFieldInputs[$profileField->id]['label']);
185 unset($profileFieldInputs[$profileField->id]);
186 unset($profileFieldOrder[$profileField->id]);
187 $this->delete($profileField);
193 // Regenerates the order values if items were deleted
194 $profileFieldOrder = array_flip(array_keys($profileFieldOrder));
196 // Update existing profile fields from form values
197 $profileFields = $profileFields->map(function (Model\ProfileField $profileField) use ($uid, $aclFormatter, &$profileFieldInputs, &$profileFieldOrder) {
198 if (isset($profileFieldInputs[$profileField->id]) && isset($profileFieldOrder[$profileField->id])) {
199 $psid = $this->permissionSet->getIdFromACL(
201 $aclFormatter->toString($profileFieldInputs[$profileField->id]['contact_allow'] ?? ''),
202 $aclFormatter->toString($profileFieldInputs[$profileField->id]['group_allow'] ?? ''),
203 $aclFormatter->toString($profileFieldInputs[$profileField->id]['contact_deny'] ?? ''),
204 $aclFormatter->toString($profileFieldInputs[$profileField->id]['group_deny'] ?? '')
207 $profileField->psid = $psid;
208 $profileField->label = $profileFieldInputs[$profileField->id]['label'];
209 $profileField->value = $profileFieldInputs[$profileField->id]['value'];
210 $profileField->order = $profileFieldOrder[$profileField->id];
212 unset($profileFieldInputs[$profileField->id]);
213 unset($profileFieldOrder[$profileField->id]);
216 return $profileField;
219 return $profileFields;
223 * Migrates a legacy profile to the new slimmer profile with extra custom fields.
224 * Multi profiles are converted to ACl-protected custom fields and deleted.
226 * @param array $profile Profile table row
229 public function migrateFromProfile(array $profile)
231 // Already processed, aborting
232 if ($profile['is-default'] === null) {
236 if (!$profile['is-default']) {
237 $contacts = Model\Contact::selectToArray(['id'], ['uid' => $profile['uid'], 'profile-id' => $profile['id']]);
238 if (!count($contacts)) {
239 // No contact visibility selected defaults to user-only permission
240 $contacts = Model\Contact::selectToArray(['id'], ['uid' => $profile['uid'], 'self' => true]);
243 $allow_cid = DI::aclFormatter()->toString(array_column($contacts, 'id'));
246 $psid = DI::permissionSet()->getIdFromACL($profile['uid'], $allow_cid ?? '');
251 'hometown' => DI::l10n()->t('Hometown:'),
252 'gender' => DI::l10n()->t('Gender:'),
253 'marital' => DI::l10n()->t('Marital Status:'),
254 'with' => DI::l10n()->t('With:'),
255 'howlong' => DI::l10n()->t('Since:'),
256 'sexual' => DI::l10n()->t('Sexual Preference:'),
257 'politic' => DI::l10n()->t('Political Views:'),
258 'religion' => DI::l10n()->t('Religious Views:'),
259 'likes' => DI::l10n()->t('Likes:'),
260 'dislikes' => DI::l10n()->t('Dislikes:'),
261 'about' => DI::l10n()->t('About:'),
262 'summary' => DI::l10n()->t('Summary'),
263 'music' => DI::l10n()->t('Musical interests'),
264 'book' => DI::l10n()->t('Books, literature'),
265 'tv' => DI::l10n()->t('Television'),
266 'film' => DI::l10n()->t('Film/dance/culture/entertainment'),
267 'interest' => DI::l10n()->t('Hobbies/Interests'),
268 'romance' => DI::l10n()->t('Love/romance'),
269 'work' => DI::l10n()->t('Work/employment'),
270 'education' => DI::l10n()->t('School/education'),
271 'contact' => DI::l10n()->t('Contact information and Social Networks'),
274 foreach ($custom_fields as $field => $label) {
275 if (!empty($profile[$field]) && $profile[$field] > DBA::NULL_DATE && $profile[$field] > DBA::NULL_DATETIME) {
276 DI::profileField()->insert([
277 'uid' => $profile['uid'],
280 'label' => trim($label, ':'),
281 'value' => $profile[$field],
285 $profile[$field] = null;
288 if ($profile['is-default']) {
289 $profile['profile-name'] = null;
290 $profile['is-default'] = null;
291 DI::dba()->update('profile', $profile, ['id' => $profile['id']]);
292 } elseif (!empty($profile['id'])) {
293 DI::dba()->delete('profile', ['id' => $profile['id']]);