gnusocial/actions/editgroup.php

<?php
// This file is part of GNU social - https://www.gnu.org/software/social
//
// GNU social 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.
//
// GNU social 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 GNU social.  If not, see <http://www.gnu.org/licenses/>.

/**
 * Edit an existing group
 *
 * @category  Group
 * @package   GNUsocial
 * @author    Evan Prodromou <evan@status.net>
 * @author    Sarven Capadisli <csarven@status.net>
 * @author    Zach Copley <zach@status.net>
 * @copyright 2008-2011 StatusNet, Inc.
 * @license   https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
 */

defined('GNUSOCIAL') || die();

/**
 * Add a new group
 *
 * This is the form for adding a new group
 *
 * @category  Group
 * @package   GNUsocial
 * @author    Evan Prodromou <evan@status.net>
 * @author    Zach Copley <zach@status.net>
 * @author    Alexei Sorokin <sor.alexei@meowr.ru>
 * @license   https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
 */
class EditgroupAction extends GroupAction
{
    public $message = null;
    public $success = null;
    protected $canPost = true;

    public function title()
    {
        // TRANS: Title for form to edit a group. %s is a group nickname.
        return sprintf(_('Edit %s group'), $this->group->nickname);
    }

    public function showContent()
    {
        $form = new GroupEditForm($this, $this->group);
        $form->show();
    }

    public function showPageNoticeBlock()
    {
        parent::showPageNoticeBlock();

        if ($this->message) {
            $this->element(
                'p',
                ($this->success) ? 'success' : 'error',
                $this->message
            );
        } else {
            $this->element(
                'p',
                'instructions',
                // TRANS: Form instructions for group edit form.
                _('Use this form to edit the group.')
            );
        }
    }

    public function showScripts()
    {
        parent::showScripts();
        $this->autofocus('fullname');
    }

    /**
     * Prepare to run
     * @param array $args
     * @return bool
     * @throws ClientException
     * @throws NicknameException
     */

    protected function prepare(array $args = [])
    {
        parent::prepare($args);

        if (!common_logged_in()) {
            // TRANS: Client error displayed trying to edit a group while not logged in.
            $this->clientError(_('You must be logged in to create a group.'));
        }

        $nickname_arg = $this->trimmed('nickname');
        $nickname = common_canonical_nickname($nickname_arg);

        // Permanent redirect on non-canonical nickname

        if ($nickname_arg != $nickname) {
            $args = ['nickname' => $nickname];
            common_redirect(common_local_url('editgroup', $args), 301);
        }

        if (!$nickname) {
            // TRANS: Client error displayed trying to edit a group while not proving a nickname for the group to edit.
            $this->clientError(_('No nickname.'), 404);
        }

        $groupid = $this->trimmed('groupid');

        if ($groupid) {
            $this->group = User_group::getKV('id', $groupid);
        } else {
            $local = Local_group::getKV('nickname', $nickname);
            if ($local) {
                $this->group = User_group::getKV('id', $local->group_id);
            }
        }

        if (!$this->group) {
            // TRANS: Client error displayed trying to edit a non-existing group.
            $this->clientError(_('No such group.'), 404);
        }

        $cur = common_current_user();

        if (!$cur->isAdmin($this->group)) {
            // TRANS: Client error displayed trying to edit a group while not being a group admin.
            $this->clientError(_('You must be an admin to edit the group.'), 403);
        }

        return true;
    }

    protected function handlePost()
    {
        parent::handlePost();

        $cur = common_current_user();
        if (!$cur->isAdmin($this->group)) {
            // TRANS: Client error displayed trying to edit a group while not being a group admin.
            $this->clientError(_('You must be an admin to edit the group.'), 403);
        }

        if (Event::handle('StartGroupSaveForm', [$this])) {

            // $nickname will only be set if this changenick value is true.
            $nickname = null;
            if (common_config('profile', 'changenick') == true) {
                try {
                    $nickname = Nickname::normalize($this->trimmed('newnickname'), true);
                } catch (NicknameTakenException $e) {
                    // Abort only if the nickname is occupied by _another_ group
                    if ($e->profile->id != $this->group->profile_id) {
                        $this->setMessage($e->getMessage(), true);
                        return;
                    }
                    $nickname = Nickname::normalize($this->trimmed('newnickname')); // without in-use check this time
                } catch (NicknameException $e) {
                    $this->setMessage($e->getMessage(), true);
                    return;
                }
            }

            $fullname = $this->trimmed('fullname');
            $homepage = $this->trimmed('homepage');
            $description = $this->trimmed('description');
            $location = $this->trimmed('location');
            $aliasstring = $this->trimmed('aliases');
            $private = $this->boolean('private');

            if ($private) {
                $force_scope = 1;
                $join_policy = User_group::JOIN_POLICY_MODERATE;
            } else {
                $force_scope = 0;
                $join_policy = User_group::JOIN_POLICY_OPEN;
            }

            if (!is_null($homepage) && (strlen($homepage) > 0) &&
                !common_valid_http_url($homepage)) {
                // TRANS: Group edit form validation error.
                $this->setMessage(_('Homepage is not a valid URL.'), true);
                return;
            } elseif (!is_null($fullname) && mb_strlen($fullname) > 255) {
                // TRANS: Group edit form validation error.
                $this->setMessage(_('Full name is too long (maximum 255 characters).'), true);
                return;
            } elseif (User_group::descriptionTooLong($description)) {
                $this->setMessage(sprintf(
                // TRANS: Group edit form validation error.
                    _m(
                        'Description is too long (maximum %d character).',
                        'Description is too long (maximum %d characters).',
                        User_group::maxDescription()
                    ),
                    User_group::maxDescription()
                ), true);
                return;
            } elseif (!is_null($location) && mb_strlen($location) > 255) {
                // TRANS: Group edit form validation error.
                $this->setMessage(_('Location is too long (maximum 255 characters).'), true);
                return;
            }

            if (!empty($aliasstring)) {
                $aliases = array_map(
                    ['Nickname', 'normalize'],
                    array_unique(preg_split('/[\s,]+/', $aliasstring))
                );
            } else {
                $aliases = [];
            }

            if (count($aliases) > common_config('group', 'maxaliases')) {
                // TRANS: Group edit form validation error.
                // TRANS: %d is the maximum number of allowed aliases.
                $this->setMessage(sprintf(
                    _m(
                        'Too many aliases! Maximum %d allowed.',
                        'Too many aliases! Maximum %d allowed.',
                        common_config('group', 'maxaliases')
                    ),
                    common_config('group', 'maxaliases')
                ), true);
                return;
            }

            $this->group->query('START TRANSACTION');

            $orig = clone($this->group);

            if (common_config('profile', 'changenick') == true && $this->group->nickname !== $nickname) {
                assert(Nickname::normalize($nickname) === $nickname);
                common_debug("Changing group nickname from '{$this->group->nickname}' to '{$nickname}'.");
                $this->group->nickname = $nickname;
                $this->group->mainpage = common_local_url('showgroup', ['nickname' => $this->group->nickname]);
            }
            $this->group->fullname = $fullname;
            $this->group->homepage = $homepage;
            $this->group->description = $description;
            $this->group->location = $location;
            $this->group->join_policy = $join_policy;
            $this->group->force_scope = $force_scope;

            $result = $this->group->update($orig);

            if ($result === false) {
                common_log_db_error($this->group, 'UPDATE', __FILE__);
                // TRANS: Server error displayed when editing a group fails.
                $this->serverError(_('Could not update group.'));
            }

            $result = $this->group->setAliases($aliases);

            if (!$result) {
                // TRANS: Server error displayed when group aliases could not be added.
                $this->serverError(_('Could not create aliases.'));
            }

            $this->group->query('COMMIT');

            Event::handle('EndGroupSaveForm', [$this]);

            if ($this->group->nickname != $orig->nickname) {
                common_redirect(common_local_url('editgroup', ['nickname' => $this->group->nickname]), 303);
            }
        }

        // TRANS: Group edit form success message.
        $this->setMessage(_('Options saved.'));
    }

    public function setMessage($msg, $error = false)
    {
        $this->message = $msg;
        $this->success = !$error;
    }
}