gnu-social/plugins/ExtendedProfile/actions/profiledetailsettings.php

608 lines
18 KiB
PHP
Raw Normal View History

<?php
/*
* StatusNet - the distributed open-source microblogging tool
* Copyright (C) 2011, StatusNet, Inc.
*
* 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/>.
*/
if (!defined('GNUSOCIAL')) {
exit(1);
}
2011-03-11 10:13:34 +09:00
class ProfileDetailSettingsAction extends ProfileSettingsAction
{
/**
* Title of the page
*
* @return string Title of the page
*/
public function title()
{
2011-06-05 18:35:11 +09:00
// TRANS: Title for extended profile settings.
// TRANS: %%site.name%% is the name of the site.
return _m('Extended profile settings');
}
protected function doPost()
{
if ($this->arg('save')) {
return $this->saveDetails();
}
// TRANS: Message given submitting a form with an unknown action.
throw new ClientException(_m('Unexpected form submission.'));
}
public function showContent()
{
$widget = new ExtendedProfileWidget(
$this,
$this->scoped,
ExtendedProfileWidget::EDITABLE
);
$widget->show();
}
public function saveDetails()
{
common_debug(var_export($_POST, true));
$this->saveStandardProfileDetails();
$simpleFieldNames = ['title', 'spouse', 'kids', 'manager'];
$dateFieldNames = ['birthday'];
foreach ($simpleFieldNames as $name) {
$value = $this->trimmed('extprofile-' . $name);
$this->saveField($name, $value);
}
foreach ($dateFieldNames as $name) {
$value = $this->trimmed('extprofile-' . $name);
$date_val = $this->parseDate($name, $value);
$this->saveField($name, null, null, null, $date_val);
}
2011-03-11 07:14:21 +09:00
$this->savePhoneNumbers();
$this->saveIms();
$this->saveWebsites();
$this->saveExperiences();
$this->saveEducations();
$this->saveCustomFields($this);
2011-06-05 18:35:11 +09:00
// TRANS: Success message after saving extended profile details.
return _m('Details saved.');
}
public function parseDate($fieldname, $datestr, $required = false)
2011-03-16 07:35:00 +09:00
{
if (empty($datestr)) {
if ($required) {
$msg = sprintf(
// TRANS: Exception thrown when no date was entered in a required date field.
// TRANS: %s is the field name.
_m('You must supply a date for "%s".'),
$fieldname
);
throw new Exception($msg);
}
2011-03-16 07:35:00 +09:00
} else {
$ts = strtotime($datestr);
if ($ts === false) {
throw new Exception(
sprintf(
// TRANS: Exception thrown on incorrect data input.
// TRANS: %1$s is a field name, %2$s is the incorrect input.
_m('Invalid date entered for "%1$s": %2$s.'),
2011-03-16 07:35:00 +09:00
$fieldname,
$ts
)
);
}
return common_sql_date($ts);
}
return null;
}
public function savePhoneNumbers()
{
common_debug('save phone numbers');
2011-03-11 07:14:21 +09:00
$phones = $this->findPhoneNumbers();
$this->removeAll('phone');
$i = 0;
foreach ($phones as $phone) {
if (!empty($phone['value'])) {
++$i;
$this->saveField(
'phone',
$phone['value'],
$phone['rel'],
$i
);
}
2011-03-11 07:14:21 +09:00
}
}
public function findPhoneNumbers()
{
// Form vals look like this:
// 'extprofile-phone-1' => '11332',
// 'extprofile-phone-1-rel' => 'mobile',
$phones = $this->sliceParams('phone', 2);
$phone_array = [];
2011-03-11 07:14:21 +09:00
foreach ($phones as $phone) {
2011-03-11 07:14:21 +09:00
list($number, $rel) = array_values($phone);
$phone_array[] = [
2011-03-11 07:14:21 +09:00
'value' => $number,
'rel' => $rel
];
2011-03-11 07:14:21 +09:00
}
return $phone_array;
}
public function findIms()
{
// Form vals look like this:
// 'extprofile-im-0' => 'jed',
// 'extprofile-im-0-rel' => 'yahoo',
$ims = $this->sliceParams('im', 2);
$imArray = array();
foreach ($ims as $im) {
list($id, $rel) = array_values($im);
$imArray[] = [
'value' => $id,
'rel' => $rel
];
}
return $imArray;
}
public function saveIms()
{
common_debug('save ims');
$ims = $this->findIms();
$this->removeAll('im');
$i = 0;
foreach ($ims as $im) {
if (!empty($im['value'])) {
++$i;
$this->saveField(
'im',
$im['value'],
$im['rel'],
$i
);
}
}
}
public function findWebsites()
{
2011-03-16 02:10:18 +09:00
// Form vals look like this:
$sites = $this->sliceParams('website', 2);
$wsArray = array();
foreach ($sites as $site) {
list($id, $rel) = array_values($site);
$wsArray[] = array(
'value' => $id,
'rel' => $rel
2011-03-16 02:10:18 +09:00
);
}
return $wsArray;
}
public function saveWebsites()
{
common_debug('save websites');
2011-03-16 02:10:18 +09:00
$sites = $this->findWebsites();
$this->removeAll('website');
2011-03-16 02:10:18 +09:00
$i = 0;
foreach ($sites as $site) {
if (!empty($site['value']) && !common_valid_http_url($site['value'])) {
// TRANS: Exception thrown when entering an invalid URL.
// TRANS: %s is the invalid URL.
throw new Exception(sprintf(_m('Invalid URL: %s.'), $site['value']));
}
2011-03-16 02:10:18 +09:00
if (!empty($site['value'])) {
++$i;
$this->saveField(
'website',
$site['value'],
$site['rel'],
$i
);
}
}
}
public function findExperiences()
{
// Form vals look like this:
// 'extprofile-experience-0' => 'Bozotronix',
// 'extprofile-experience-0-current' => 'true'
// 'extprofile-experience-0-start' => '1/5/10',
// 'extprofile-experience-0-end' => '2/3/11',
$experiences = $this->sliceParams('experience', 4);
$expArray = array();
foreach ($experiences as $exp) {
if (count($exp) === 4) {
[$company, $current, $end, $start] = array_values($exp);
} else {
$end = null;
[$company, $current, $start] = array_values($exp);
}
if (!empty($company)) {
$expArray[] = array(
'company' => $company,
'start' => $this->parseDate('Start', $start, true),
'end' => ($current == 'false') ? $this->parseDate('End', $end, true) : null,
'current' => ($current == 'false') ? false : true
);
}
}
return $expArray;
}
public function saveExperiences()
{
common_debug('save experiences');
$experiences = $this->findExperiences();
$this->removeAll('company');
$this->removeAll('start');
$this->removeAll('end'); // also stores 'current'
$i = 0;
foreach ($experiences as $experience) {
if (!empty($experience['company'])) {
++$i;
$this->saveField(
'company',
$experience['company'],
null,
$i
);
$this->saveField(
'start',
null,
null,
$i,
$experience['start']
);
// Save "current" employer indicator in rel
if ($experience['current']) {
$this->saveField(
'end',
null,
'current', // rel
$i
);
} else {
$this->saveField(
'end',
null,
null,
$i,
$experience['end']
);
}
}
}
}
public function findEducations()
{
// Form vals look like this:
// 'extprofile-education-0-school' => 'Pigdog',
// 'extprofile-education-0-degree' => 'BA',
// 'extprofile-education-0-description' => 'Blar',
// 'extprofile-education-0-start' => '05/22/99',
// 'extprofile-education-0-end' => '05/22/05',
$edus = $this->sliceParams('education', 5);
$eduArray = array();
foreach ($edus as $edu) {
list($school, $degree, $description, $end, $start) = array_values($edu);
if (!empty($school)) {
$eduArray[] = array(
'school' => $school,
'degree' => $degree,
'description' => $description,
'start' => $this->parseDate('Start', $start, true),
'end' => $this->parseDate('End', $end, true)
);
}
}
return $eduArray;
}
public function saveEducations()
{
common_debug('save educations');
$edus = $this->findEducations();
common_debug(var_export($edus, true));
$this->removeAll('school');
$this->removeAll('degree');
$this->removeAll('degree_descr');
$this->removeAll('school_start');
$this->removeAll('school_end');
$i = 0;
foreach ($edus as $edu) {
if (!empty($edu['school'])) {
++$i;
$this->saveField(
'school',
$edu['school'],
null,
$i
);
$this->saveField(
'degree',
$edu['degree'],
null,
$i
);
$this->saveField(
'degree_descr',
$edu['description'],
null,
$i
);
$this->saveField(
'school_start',
null,
null,
$i,
$edu['start']
);
$this->saveField(
'school_end',
null,
null,
$i,
$edu['end']
);
}
}
}
public function arraySplit($array, $pieces)
{
2011-03-11 07:14:21 +09:00
if ($pieces < 2) {
return array($array);
}
$newCount = ceil(count($array) / $pieces);
$a = array_slice($array, 0, $newCount);
$b = $this->arraySplit(array_slice($array, $newCount), $pieces - 1);
2011-03-11 07:14:21 +09:00
return array_merge(array($a), $b);
}
public function findMultiParams($type)
{
2011-03-11 07:14:21 +09:00
$formVals = array();
$target = $type;
2011-03-11 07:14:21 +09:00
foreach ($_POST as $key => $val) {
if (strrpos('extprofile-' . $key, $target) !== false) {
$formVals[$key] = $val;
}
}
return $formVals;
}
public function sliceParams($key, $size)
{
$slice = array();
$params = $this->findMultiParams($key);
ksort($params);
$slice = $this->arraySplit($params, sizeof($params) / $size);
return $slice;
}
2011-03-11 07:14:21 +09:00
/**
* Save an extended profile field as a Profile_detail
*
* @param string $name field name
* @param string $value field value
* @param string|null $rel field rel (type)
* @param int|null $index index (fields can have multiple values)
* @param string|null $date date related date
* @throws ServerException
2011-03-11 07:14:21 +09:00
*/
public function saveField(string $name, ?string $value, ?string $rel = null, ?int $index = null, ?string $date = null)
2011-03-11 07:14:21 +09:00
{
common_debug('save ' . $name);
$detail = new Profile_detail();
$detail->profile_id = $this->scoped->getID();
$detail->field_name = $name;
2011-03-11 07:14:21 +09:00
$detail->value_index = $index;
if ($detail->find(true)) {
// Found an existing Profile Detail, let's update it!
$orig = clone($detail);
$detail->field_value = $value ?? $detail->sqlValue('NULL');
$detail->rel = $rel ?? $detail->sqlValue('NULL');
$detail->date = $date ?? $detail->sqlValue('NULL');
if (!$detail->update($orig)) {
common_log_db_error($detail, 'UPDATE', __FILE__);
2011-06-05 18:35:11 +09:00
// TRANS: Server error displayed when a field could not be saved in the database.
throw new ServerException(_m('Could not save profile details.'));
2011-03-10 11:00:24 +09:00
}
} elseif (!empty($rel) || !empty($value) || !empty($date)) {
// It's the first time, let's insert, if there is anything to insert.
$detail->rel = $rel;
$detail->field_value = $value;
$detail->date = $date;
$detail->created = common_sql_now();
2011-03-10 11:00:24 +09:00
if (!$detail->insert()) {
common_log_db_error($detail, 'INSERT', __FILE__);
2011-06-05 18:35:11 +09:00
// TRANS: Server error displayed when a field could not be saved in the database.
throw new ServerException(_m('Could not save profile details.'));
2011-03-11 07:14:21 +09:00
}
}
$detail->free();
}
public function removeAll($name)
{
$detail = new Profile_detail();
$detail->profile_id = $this->scoped->getID();
$detail->field_name = $name;
$detail->delete();
$detail->free();
}
/**
* Save fields that should be stored in the main profile object
*
* XXX: There's a lot of dupe code here from ProfileSettingsAction.
* Do not want.
*/
public function saveStandardProfileDetails()
{
$fullname = $this->trimmed('extprofile-fullname');
$location = $this->trimmed('extprofile-location');
$tagstring = $this->trimmed('extprofile-tags');
$bio = $this->trimmed('extprofile-bio');
if ($tagstring) {
$tags = array_map(
'common_canonical_tag',
preg_split('/[\s,]+/', $tagstring)
);
} else {
$tags = [];
}
foreach ($tags as $tag) {
if (!common_valid_profile_tag($tag)) {
// TRANS: Validation error in form for profile settings.
// TRANS: %s is an invalid tag.
throw new Exception(sprintf(_m('Invalid tag: "%s".'), $tag));
}
}
$oldTags = Profile_tag::getSelfTagsArray($this->scoped);
$newTags = array_diff($tags, $oldTags);
if ($fullname != $this->scoped->getFullname()
|| $location != $this->scoped->location
|| !empty($newTags)
|| $bio != $this->scoped->getDescription()) {
$orig = clone($this->scoped);
// Skipping nickname change here until we add logic for when the site allows it or not
// old Profilesettings will still let us do that.
$this->scoped->fullname = $fullname;
$this->scoped->bio = $bio;
$this->scoped->location = $location;
$loc = Location::fromName($location);
if (empty($loc)) {
$this->scoped->lat = null;
$this->scoped->lon = null;
$this->scoped->location_id = null;
$this->scoped->location_ns = null;
} else {
$this->scoped->lat = $loc->lat;
$this->scoped->lon = $loc->lon;
$this->scoped->location_id = $loc->location_id;
$this->scoped->location_ns = $loc->location_ns;
}
$result = $this->scoped->update($orig);
if ($result === false) {
common_log_db_error($this->scoped, 'UPDATE', __FILE__);
// TRANS: Server error thrown when user profile settings could not be saved.
throw new ServerException(_m('Could not save profile.'));
}
// Set the user tags
$result = Profile_tag::setSelfTags($this->scoped, $tags);
Event::handle('EndProfileSaveForm', array($this));
}
}
private function saveCustomFields($action)
{
common_debug('save custom fields');
$fields = GNUsocialProfileExtensionField::allFields();
$user = common_current_user();
$profile = $user->getProfile();
foreach ($fields as $field) {
$val = $action->trimmed('extprofile-' . $field->systemname);
if (empty($val)) {
continue;
}
$response = new GNUsocialProfileExtensionResponse();
$response->profile_id = $profile->id;
$response->extension_id = $field->id;
if ($response->find()) {
$response->fetch();
$response->value = $val;
if ($response->validate()) {
if (empty($val)) {
$response->delete();
} else {
$response->update();
}
}
} else {
$response->value = $val;
$response->insert();
}
}
}
}