Basic license admin panel (maybe we can make it fancier later)

diff --git a/actions/licenseadminpanel.php b/actions/licenseadminpanel.php
new file mode 100644 (file)
index 0000000..c9aad5c
--- /dev/null
+++ b/actions/licenseadminpanel.php
@@ -0,0 +1,303 @@
+<?php
+/**
+ * StatusNet, the distributed open-source microblogging tool
+ *
+ * License 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);
+}
+
+/**
+ * License settings
+ *
+ * @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 LicenseadminpanelAction extends AdminPanelAction
+{
+
+    /**
+     * Returns the page title
+     *
+     * @return string page title
+     */
+
+    function title()
+    {
+        // TRANS: User admin panel title
+        return _m('TITLE', 'License');
+    }
+
+    /**
+     * Instructions for using this form.
+     *
+     * @return string instructions
+     */
+
+    function getInstructions()
+    {
+        return _('License for this StatusNet site');
+    }
+
+    /**
+     * Show the site admin panel form
+     *
+     * @return void
+     */
+
+    function showForm()
+    {
+        $form = new LicenseAdminPanelForm($this);
+        $form->show();
+        return;
+    }
+
+    /**
+     * Save settings from the form
+     *
+     * @return void
+     */
+
+    function saveSettings()
+    {
+        static $settings = array(
+            'license' => array('type', 'owner', 'url', 'title', 'image')
+        );
+
+        $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;
+    }
+
+    /**
+     * Validate License admin form values
+     *
+     * @param array &$values from the form
+     *
+     * @return nothing
+     */
+
+    function validate(&$values)
+    {
+        // Validate license type (shouldn't have to do it, but just in case)
+
+        $types = array('private', 'allrightsreserved', 'cc');
+
+        if (!in_array($values['license']['type'], $types)) {
+            $this->clientError(_("Invalid license selection."));
+        }
+
+        // Make sure the user has set an owner if the site has a private
+        // license
+
+        if ($values['license']['type'] == 'allrightsreserved'
+            && empty($values['license']['owner'])
+        ) {
+            $this->clientError(
+                _("You must specify the owner of the content when using the All Rights Reserved license.")
+            );
+        }
+
+        // Make sure the license title is not too long
+        if (mb_strlen($values['license']['type']) > 255) {
+            $this->clientError(
+                _("Invalid license title. Max length is 255 characters.")
+            );
+        }
+
+        // make sure the license URL and license image URL are valid URLs
+
+        $options = array('allowed_schemes' => array('http', 'https'));
+
+        if (!Validate::uri($values['license']['url'], $options)) {
+            $this->clientError(_("Invalid license URL."));
+        }
+
+        if (!Validate::uri($values['license']['image'], $options)) {
+            $this->clientError(_("Invalid license image URL."));
+        }
+    }
+}
+
+class LicenseAdminPanelForm extends AdminForm
+{
+    /**
+     * ID of the form
+     *
+     * @return int ID of the form
+     */
+
+    function id()
+    {
+        return 'licenseadminpanel';
+    }
+
+    /**
+     * 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('licenseadminpanel');
+    }
+
+    /**
+     * Data elements of the form
+     *
+     * @return void
+     */
+
+    function formData()
+    {
+        $this->out->elementStart(
+            'fieldset', array('id' => 'settings_license-selection')
+        );
+        $this->out->element('legend', null, _('License selection'));
+        $this->out->elementStart('ul', 'form_data');
+
+        $this->li();
+
+        $types = array(
+            'private' => _('Private'),
+            'allrightsreserved' => _('All Rights Reserved'),
+            'cc' => _('Creative Commons')
+        );
+
+        $this->out->dropdown(
+            'type',
+            _('Type'),
+            $types,
+            _('Select license'),
+            false,
+            $this->value('type', 'license')
+        );
+
+        $this->unli();
+
+        $this->out->elementEnd('ul');
+        $this->out->elementEnd('fieldset');
+
+        $this->out->elementStart(
+            'fieldset',
+            array('id' => 'settings_license-details')
+        );
+        $this->out->element('legend', null, _('License details'));
+        $this->out->elementStart('ul', 'form_data');
+
+        $this->li();
+        $this->input(
+            'owner',
+            _('Owner'),
+            _('Name of the owner of the site\'s content (if applicable).'),
+            'license'
+        );
+        $this->unli();
+
+        $this->li();
+        $this->input(
+            'title',
+            _('License Title'),
+            _('The title of the license.'),
+            'license'
+        );
+        $this->unli();
+
+        $this->li();
+        $this->input(
+            'url',
+            _('License URL'),
+            _('URL for more information about the license.'),
+            'license'
+        );
+        $this->unli();
+
+        $this->li();
+        $this->input(
+            'image', _('License Image URL'),
+            _('URL for an image to display with the license.'),
+            'license'
+        );
+        $this->unli();
+
+        $this->out->elementEnd('ul');
+        $this->out->elementEnd('fieldset');
+    }
+
+    /**
+     * Action elements
+     *
+     * @return void
+     */
+
+    function formActions()
+    {
+        $this->out->submit(
+            'submit', _('Save'), 'submit', null, _('Save license settings')
+        );
+    }
+}

diff --git a/lib/adminpanelaction.php b/lib/adminpanelaction.php
index 41cfe5851bc34a3c9187d1f7b958d386a7379a61..043219a1fe40c0948907c4ed92208530d376f2e3 100644 (file)
--- a/lib/adminpanelaction.php
+++ b/lib/adminpanelaction.php
@@ -409,6 +409,14 @@ class AdminPanelNav extends Widget
                                      $menu_title, $action_name == 'snapshotadminpanel', 'nav_snapshot_admin_panel');
             }
 
+            if (AdminPanelAction::canAdmin('license')) {
+                // TRANS: Menu item title/tooltip
+                $menu_title = _('Set site license');
+                // TRANS: Menu item for site administration
+                $this->out->menuItem(common_local_url('licenseadminpanel'), _('License'),
+                                     $menu_title, $action_name == 'licenseadminpanel', 'nav_license_admin_panel');
+            }
+
             Event::handle('EndAdminPanelNav', array($this));
         }
         $this->action->elementEnd('ul');

diff --git a/lib/default.php b/lib/default.php
index 45a4560ff36100ccda3890267d51615ac1a3a9cd..6200abada1ea85bdfea4bb1d2f3c6505292d9379 100644 (file)
--- a/lib/default.php
+++ b/lib/default.php
@@ -300,7 +300,7 @@ $default =
                                  'OpenID' => null),
               ),
         'admin' =>
-        array('panels' => array('design', 'site', 'user', 'paths', 'access', 'sessions', 'sitenotice')),
+        array('panels' => array('design', 'site', 'user', 'paths', 'access', 'sessions', 'sitenotice', 'license')),
         'singleuser' =>
         array('enabled' => false,
               'nickname' => null),

diff --git a/lib/router.php b/lib/router.php
index 7e1e6a2a47a1887781c3154cb1684e6d39d7b6e1..fb5a3c7c364c6c16a3d6873cb791ff7c7a9e8550 100644 (file)
--- a/lib/router.php
+++ b/lib/router.php
@@ -690,6 +690,8 @@ class Router
             $m->connect('admin/sessions', array('action' => 'sessionsadminpanel'));
             $m->connect('admin/sitenotice', array('action' => 'sitenoticeadminpanel'));
             $m->connect('admin/snapshot', array('action' => 'snapshotadminpanel'));
+            $m->connect('admin/license', array('action' => 'licenseadminpanel'));
+
 
             $m->connect('getfile/:filename',
                         array('action' => 'getfile'),