. /** * Update a group's profile * * @category API * @package GNUsocial * @author Zach Copley * @copyright 2010 StatusNet, Inc. * @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later */ defined('GNUSOCIAL') || die(); /** * API analog to the group edit page * * @category API * @package GNUsocial * @author Zach Copley * @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later */ class ApiGroupProfileUpdateAction extends ApiAuthAction { protected $needPost = true; /** * Take arguments for running * * @param array $args $_REQUEST args * * @return boolean success flag * */ protected function prepare(array $args=array()) { parent::prepare($args); $this->nickname = Nickname::normalize($this->trimmed('nickname')); $this->fullname = $this->trimmed('fullname'); $this->homepage = $this->trimmed('homepage'); $this->description = $this->trimmed('description'); $this->location = $this->trimmed('location'); $this->aliasstring = $this->trimmed('aliases'); $this->user = $this->auth_user; $this->group = $this->getTargetGroup($this->arg('id')); return true; } /** * Handle the request * * See which request params have been set, and update the profile * * @return void */ protected function handle() { parent::handle(); if (!in_array($this->format, array('xml', 'json'))) { // TRANS: Client error displayed when coming across a non-supported API method. $this->clientError(_('API method not found.'), 404); } if (empty($this->user)) { // TRANS: Client error displayed when not providing a user or an invalid user. $this->clientError(_('No such user.'), 404); } if (empty($this->group)) { // TRANS: Client error displayed when not providing a group or an invalid group. $this->clientError(_('Group not found.'), 404); } if (!$this->user->isAdmin($this->group)) { // TRANS: Client error displayed when trying to edit a group without being an admin. $this->clientError(_('You must be an admin to edit the group.'), 403); } $this->group->query('START TRANSACTION'); $orig = clone($this->group); try { if (common_config('profile', 'changenick') == true && $this->group->nickname !== $this->nickname) { try { $this->group->nickname = Nickname::normalize($this->nickname, true); } catch (NicknameException $e) { throw new ApiValidationException($e->getMessage()); } $this->group->mainpage = common_local_url( 'showgroup', ['nickname' => $this->group->nickname] ); } if (!empty($this->fullname)) { $this->validateFullname(); $this->group->fullname = $this->fullname; } if (!empty($this->homepage)) { $this->validateHomepage(); $this->group->homepage = $this->homepage; } if (!empty($this->description)) { $this->validateDescription(); $this->group->description = $this->decription; } if (!empty($this->location)) { $this->validateLocation(); $this->group->location = $this->location; } } catch (ApiValidationException $ave) { $this->clientError($ave->getMessage(), 400); } $result = $this->group->update($orig); if (!$result) { common_log_db_error($this->group, 'UPDATE', __FILE__); // TRANS: Server error displayed when group update fails. $this->serverError(_('Could not update group.')); } $aliases = array(); try { if (!empty($this->aliasstring)) { $aliases = $this->validateAliases(); } } catch (ApiValidationException $ave) { $this->clientError($ave->getMessage(), 403); } $result = $this->group->setAliases($aliases); if (!$result) { // TRANS: Server error displayed when adding group aliases fails. $this->serverError(_('Could not create aliases.')); } $this->group->query('COMMIT'); switch ($this->format) { case 'xml': $this->showSingleXmlGroup($this->group); break; case 'json': $this->showSingleJsonGroup($this->group); break; default: // TRANS: Client error displayed when coming across a non-supported API method. $this->clientError(_('API method not found.'), 404); } } public function validateHomepage() { if (!is_null($this->homepage) && (strlen($this->homepage) > 0) && !common_valid_http_url($this->homepage)) { throw new ApiValidationException( // TRANS: API validation exception thrown when homepage URL does not validate. _('Homepage is not a valid URL.') ); } } public function validateFullname() { if (!is_null($this->fullname) && mb_strlen($this->fullname) > 255) { throw new ApiValidationException( // TRANS: API validation exception thrown when full name does not validate. _('Full name is too long (maximum 255 characters).') ); } } public function validateDescription() { if (User_group::descriptionTooLong($this->description)) { // TRANS: API validation exception thrown when description does not validate. // TRANS: %d is the maximum description length and used for plural. throw new ApiValidationException(sprintf( _m('Description is too long (maximum %d character).', 'Description is too long (maximum %d characters).', User_group::maxDescription()), User_group::maxDescription() )); } } public function validateLocation() { if (!is_null($this->location) && mb_strlen($this->location) > 255) { throw new ApiValidationException( // TRANS: API validation exception thrown when location does not validate. _('Location is too long (maximum 255 characters).') ); } } public function validateAliases() { try { $aliases = array_map( ['Nickname', 'normalize'], array_unique(preg_split('/[\s,]+/', $this->aliasstring)) ); } catch (NicknameException $e) { throw new ApiValidationException(sprintf('Error processing aliases: %s', $e->getMessage())); } if (count($aliases) > common_config('group', 'maxaliases')) { // TRANS: API validation exception thrown when aliases do not validate. // TRANS: %d is the maximum number of aliases and used for plural. throw new ApiValidationException(sprintf( _m('Too many aliases! Maximum %d allowed.', 'Too many aliases! Maximum %d allowed.', common_config('group', 'maxaliases')), common_config('group', 'maxaliases') )); } return $aliases; } }