Move snapshot configuration to its own admin panel

Turn on with: $config['admin']['panels'][] = 'snapshot';

1 files changed, 251 insertions, 0 deletions

diff --git a/actions/snapshotadminpanel.php b/actions/snapshotadminpanel.php
new file mode 100644
index 000000000..a0c2315bc
--- /dev/null
+++ b/actions/snapshotadminpanel.php
@@ -0,0 +1,251 @@
+<?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()
+    {
+        return _('Snapshots');
+    }
+
+    /**
+     * Instructions for using this form.
+     *
+     * @return string instructions
+     */
+
+    function getInstructions()
+    {
+        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'))) {
+            $this->clientError(_("Invalid snapshot run value."));
+        }
+
+        // Validate snapshot frequency value
+
+        if (!Validate::number($values['snapshot']['frequency'])) {
+            $this->clientError(_("Snapshot frequency must be a number."));
+        }
+
+        // Validate report URL
+
+        if (!is_null($values['snapshot']['reporturl'])
+            && !Validate::uri(
+                $values['snapshot']['reporturl'],
+                array('allowed_schemes' => array('http', 'https')
+            )
+        )) {
+            $this->clientError(_("Invalid snapshot report URL."));
+        }
+    }
+}
+
+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')
+        );
+        $this->out->element('legend', null, _('Snapshots'));
+        $this->out->elementStart('ul', 'form_data');
+        $this->li();
+        $snapshot = array(
+            'web' => _('Randomly during Web hit'),
+            'cron'  => _('In a scheduled job'),
+            'never' => _('Never')
+        );
+        $this->out->dropdown(
+            'run',
+            _('Data snapshots'),
+            $snapshot,
+            _('When to send statistical data to status.net servers'),
+            false,
+            $this->value('run', 'snapshot')
+        );
+        $this->unli();
+
+        $this->li();
+        $this->input(
+            'frequency',
+            _('Frequency'),
+            _('Snapshots will be sent once every N web hits'),
+            'snapshot'
+        );
+        $this->unli();
+
+        $this->li();
+        $this->input(
+            'reporturl',
+            _('Report URL'),
+            _('Snapshots will be sent to this URL'),
+            'snapshot'
+        );
+        $this->unli();
+        $this->out->elementEnd('ul');
+        $this->out->elementEnd('fieldset');
+    }
+
+    /**
+     * Action elements
+     *
+     * @return void
+     */
+
+    function formActions()
+    {
+        $this->out->submit(
+            'submit',
+            _('Save'),
+            'submit',
+            null,
+            _('Save snapshot settings')
+        );
+    }
+}