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

snapshotadminpanel.php 7.21 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
<?php
/**
 * StatusNet, the distributed open-source microblogging tool
 *
 * Snapshots 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);
}

/**
 * Manage snapshots
 *
 * @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 SnapshotadminpanelAction extends AdminPanelAction
{
    /**
     * Returns the page title
     *
     * @return string page title
     */
    function title()
    {
52 53
        // TRANS: Title for admin panel to configure snapshots.
        return _m('TITLE','Snapshots');
54 55 56 57 58 59 60 61 62
    }

    /**
     * Instructions for using this form.
     *
     * @return string instructions
     */
    function getInstructions()
    {
63
        // TRANS: Instructions for admin panel to configure snapshots.
64 65 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 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123
        return _('Manage snapshot configuration');
    }

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

    /**
     * Save settings from the form
     *
     * @return void
     */
    function saveSettings()
    {
        static $settings = array(
            'snapshot' => array('run', 'reporturl', 'frequency')
        );

        $values = array();

        foreach ($settings as $section => $parts) {
            foreach ($parts as $setting) {
                $values[$section][$setting] = $this->trimmed($setting);
            }
        }

        // This throws an exception on validation errors

        $this->validate($values);

        // assert(all values are valid);

        $config = new Config();

        $config->query('BEGIN');

        foreach ($settings as $section => $parts) {
            foreach ($parts as $setting) {
                Config::save($section, $setting, $values[$section][$setting]);
            }
        }

        $config->query('COMMIT');

        return;
    }

    function validate(&$values)
    {
        // Validate snapshot run value

        if (!in_array($values['snapshot']['run'], array('web', 'cron', 'never'))) {
124
            // TRANS: Client error displayed on admin panel for snapshots when providing an invalid run value.
125
            $this->clientError(_('Invalid snapshot run value.'));
126 127 128 129 130
        }

        // Validate snapshot frequency value

        if (!Validate::number($values['snapshot']['frequency'])) {
131
            // TRANS: Client error displayed on admin panel for snapshots when providing an invalid value for frequency.
132
            $this->clientError(_('Snapshot frequency must be a number.'));
133 134 135 136 137 138 139 140 141 142
        }

        // Validate report URL

        if (!is_null($values['snapshot']['reporturl'])
            && !Validate::uri(
                $values['snapshot']['reporturl'],
                array('allowed_schemes' => array('http', 'https')
            )
        )) {
143
            // TRANS: Client error displayed on admin panel for snapshots when providing an invalid report URL.
144
            $this->clientError(_('Invalid snapshot report URL.'));
145 146 147 148
        }
    }
}

149
// @todo FIXME: add documentation
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 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192
class SnapshotAdminPanelForm extends AdminForm
{
    /**
     * ID of the form
     *
     * @return int ID of the form
     */
    function id()
    {
        return 'form_snapshot_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('snapshotadminpanel');
    }

    /**
     * Data elements of the form
     *
     * @return void
     */
    function formData()
    {
        $this->out->elementStart(
            'fieldset',
            array('id' => 'settings_admin_snapshots')
        );
193 194
        // TRANS: Fieldset legend on admin panel for snapshots.
        $this->out->element('legend', null, _m('LEGEND','Snapshots'));
195 196 197
        $this->out->elementStart('ul', 'form_data');
        $this->li();
        $snapshot = array(
198
            // TRANS: Option in dropdown for snapshot method in admin panel for snapshots.
Siebrand Mazeland's avatar
Siebrand Mazeland committed
199
            'web' => _('Randomly during web hit'),
200
            // TRANS: Option in dropdown for snapshot method in admin panel for snapshots.
201
            'cron'  => _('In a scheduled job'),
202
            // TRANS: Option in dropdown for snapshot method in admin panel for snapshots.
203 204 205 206
            'never' => _('Never')
        );
        $this->out->dropdown(
            'run',
207
            // TRANS: Dropdown label for snapshot method in admin panel for snapshots.
208 209
            _('Data snapshots'),
            $snapshot,
210 211
            // TRANS: Dropdown title for snapshot method in admin panel for snapshots.
            _('When to send statistical data to status.net servers.'),
212 213 214 215 216 217 218 219
            false,
            $this->value('run', 'snapshot')
        );
        $this->unli();

        $this->li();
        $this->input(
            'frequency',
220
            // TRANS: Input field label for snapshot frequency in admin panel for snapshots.
221
            _('Frequency'),
222 223
            // TRANS: Input field title for snapshot frequency in admin panel for snapshots.
            _('Snapshots will be sent once every N web hits.'),
224 225 226 227 228 229 230
            'snapshot'
        );
        $this->unli();

        $this->li();
        $this->input(
            'reporturl',
231
            // TRANS: Input field label for snapshot report URL in admin panel for snapshots.
232
            _('Report URL'),
233 234
            // TRANS: Input field title for snapshot report URL in admin panel for snapshots.
            _('Snapshots will be sent to this URL.'),
235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250
            'snapshot'
        );
        $this->unli();
        $this->out->elementEnd('ul');
        $this->out->elementEnd('fieldset');
    }

    /**
     * Action elements
     *
     * @return void
     */
    function formActions()
    {
        $this->out->submit(
            'submit',
251 252
            // TRANS: Button text to save snapshot settings.
            _m('BUTTON','Save'),
253 254
            'submit',
            null,
255 256
            // TRANS: Title for button to save snapshot settings.
            _('Save snapshot settings.')
257 258 259
        );
    }
}