We are no longer offering accounts on this server. Consider https://gitlab.freedesktop.org/ as a place to host projects.

sitenoticeadminpanel.php 4.9 KB
Newer Older
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
<?php
/**
 * StatusNet, the distributed open-source microblogging tool
 *
 * Site notice administration panel
 *
 * PHP version 5
 *
 * LICENCE: 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/>.
 *
 * @category  Settings
 * @package   StatusNet
 * @author    Zach Copley <zach@status.net>
 * @copyright 2010 StatusNet, Inc.
 * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
 * @link      http://status.net/
 */

if (!defined('STATUSNET')) {
    exit(1);
}

require_once INSTALLDIR.'/extlib/htmLawed/htmLawed.php';

/**
 * Update the site-wide notice text
 *
 * @category Admin
 * @package  StatusNet
 * @author   Zach Copley <zach@status.net>
 * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
 * @link     http://status.net/
 */
class SitenoticeadminpanelAction extends AdminPanelAction
{
    /**
     * Returns the page title
     *
     * @return string page title
     */
    function title()
    {
Siebrand Mazeland's avatar
Siebrand Mazeland committed
54
        // TRANS: Page title for site-wide notice tab in admin panel.
55 56 57 58 59 60 61 62 63 64
        return _('Site Notice');
    }

    /**
     * Instructions for using this form.
     *
     * @return string instructions
     */
    function getInstructions()
    {
Siebrand Mazeland's avatar
Siebrand Mazeland committed
65
        // TRANS: Instructions for site-wide notice tab in admin panel.
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
        return _('Edit site-wide message');
    }

    /**
     * Show the site notice admin panel form
     *
     * @return void
     */
    function showForm()
    {
        $form = new SiteNoticeAdminPanelForm($this);
        $form->show();
        return;
    }

    /**
     * Save settings from the form
     *
     * @return void
     */
    function saveSettings()
    {
        $siteNotice = $this->trimmed('site-notice');

        // assert(all values are valid);
        // This throws an exception on validation errors

93
        $this->validate($siteNotice);
94 95 96 97 98

        $config = new Config();

        $result = Config::save('site', 'notice', $siteNotice);

99
        if (!$result) {
Siebrand Mazeland's avatar
Siebrand Mazeland committed
100
            // TRANS: Server error displayed when saving a site-wide notice was impossible.
101
            $this->ServerError(_('Unable to save site notice.'));
102 103 104 105 106 107 108 109 110
        }
    }

    function validate(&$siteNotice)
    {
        // Validate notice text

        if (mb_strlen($siteNotice) > 255)  {
            $this->clientError(
Siebrand Mazeland's avatar
Siebrand Mazeland committed
111 112
                // TRANS: Client error displayed when a site-wide notice was longer than allowed.
                _('Maximum length for the site-wide notice is 255 characters.')
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 173 174
            );
        }

        // scrub HTML input

        $config = array(
            'safe' => 1,
            'deny_attribute' => 'id,style,on*'
        );

        $siteNotice = htmLawed($siteNotice, $config);
    }
}

class SiteNoticeAdminPanelForm extends AdminForm
{
    /**
     * ID of the form
     *
     * @return int ID of the form
     */

    function id()
    {
        return 'form_site_notice_admin_panel';
    }

    /**
     * class of the form
     *
     * @return string class of the form
     */

    function formClass()
    {
        return 'form_settings';
    }

    /**
     * Action of the form
     *
     * @return string URL of the action
     */

    function action()
    {
        return common_local_url('sitenoticeadminpanel');
    }

    /**
     * Data elements of the form
     *
     * @return void
     */

    function formData()
    {
        $this->out->elementStart('ul', 'form_data');

        $this->out->elementStart('li');
        $this->out->textarea(
            'site-notice',
Siebrand Mazeland's avatar
Siebrand Mazeland committed
175
            // TRANS: Label for site-wide notice text field in admin panel.
176 177
            _('Site notice text'),
            common_config('site', 'notice'),
Siebrand Mazeland's avatar
Siebrand Mazeland committed
178 179
            // TRANS: Tooltip for site-wide notice text field in admin panel.
            _('Site-wide notice text (255 characters maximum; HTML allowed)')
180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195
        );
        $this->out->elementEnd('li');

        $this->out->elementEnd('ul');
    }

    /**
     * Action elements
     *
     * @return void
     */

    function formActions()
    {
        $this->out->submit(
            'submit',
Siebrand Mazeland's avatar
Siebrand Mazeland committed
196 197
            // TRANS: Button text for saving site notice in admin panel.
            _m('BUTTON','Save'),
198 199
            'submit',
            null,
200
            // TRANS: Button title to save site notice in admin panel.
201
            _('Save site notice.')
202 203 204
        );
    }
}