Merge branch '0.9.x' into adminpanel

diff --git a/actions/siteadminpanel.php b/actions/siteadminpanel.php
new file mode 100644 (file)
index 0000000..460567c
--- /dev/null
+++ b/actions/siteadminpanel.php
@@ -0,0 +1,224 @@
+<?php
+/**
+ * StatusNet, the distributed open-source microblogging tool
+ *
+ * Site 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    Evan Prodromou <evan@status.net>
+ * @author    Zach Copley <zach@status.net>
+ * @author    Sarven Capadisli <csarven@status.net>
+ * @copyright 2008-2009 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);
+}
+
+/**
+ * Administer site settings
+ *
+ * @category Admin
+ * @package  StatusNet
+ * @author   Evan Prodromou <evan@status.net>
+ * @author   Zach Copley <zach@status.net>
+ * @author   Sarven Capadisli <csarven@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 SiteadminpanelAction extends AdminPanelAction
+{
+    /**
+     * Returns the page title
+     *
+     * @return string page title
+     */
+
+    function title()
+    {
+        return _('Site');
+    }
+
+    /**
+     * Instructions for using this form.
+     *
+     * @return string instructions
+     */
+
+    function getInstructions()
+    {
+        return _('Basic settings for this StatusNet site.');
+    }
+
+    /**
+     * Show the site admin panel form
+     *
+     * @return void
+     */
+
+    function showForm()
+    {
+        $form = new SiteAdminPanelForm($this);
+        $form->show();
+        return;
+    }
+
+    /**
+     * Save settings from the form
+     *
+     * @return void
+     */
+
+    function saveSettings()
+    {
+        static $settings = array('name', 'broughtby', 'broughtbyurl', 'email');
+
+        $values = array();
+
+        foreach ($settings as $setting) {
+            $values[$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 $setting) {
+            Config::save('site', $setting, $values[$setting]);
+        }
+
+        $config->query('COMMIT');
+
+        return;
+    }
+
+    function validate(&$values)
+    {
+        // Validate site name
+
+        if (empty($values['name'])) {
+            $this->clientError(_("Site name must have non-zero length."));
+        }
+
+        // Validate email
+
+        $values['email'] = common_canonical_email($values['email']);
+
+        if (empty($values['email'])) {
+            $this->clientError(_('You must have a valid contact email address'));
+        }
+        if (!Validate::email($values['email'], common_config('email', 'check_domain'))) {
+            $this->clientError(_('Not a valid email address'));
+        }
+    }
+}
+
+class SiteAdminPanelForm extends Form
+{
+    /**
+     * ID of the form
+     *
+     * @return int ID of the form
+     */
+
+    function id()
+    {
+        return 'siteadminpanel';
+    }
+
+    /**
+     * class of the form
+     *
+     * @return string class of the form
+     */
+
+    function formClass()
+    {
+        return 'form_site_admin_panel';
+    }
+
+    /**
+     * Action of the form
+     *
+     * @return string URL of the action
+     */
+
+    function action()
+    {
+        return common_local_url('siteadminpanel');
+    }
+
+    /**
+     * Data elements of the form
+     *
+     * @return void
+     */
+
+    function formData()
+    {
+        $this->input('name', _('Site name'),
+                     _('The name of your site, like "Yourcompany Microblog"'));
+        $this->input('broughtby', _('Brought by'),
+                     _('Text used for credits link in footer of each page'));
+        $this->input('broughtbyurl', _('Brought by URL'),
+                     _('URL used for credits link in footer of each page'));
+        $this->input('email', _('Email'),
+                     _('contact email address for your site'));
+    }
+
+    /**
+     * Utility to simplify some of the duplicated code around
+     * params and settings.
+     *
+     * @param string $setting      Name of the setting
+     * @param string $title        Title to use for the input
+     * @param string $instructions Instructions for this field
+     *
+     * @return void
+     */
+
+    function input($setting, $title, $instructions)
+    {
+        $value = $this->out->trimmed($setting);
+        if (empty($value)) {
+            $value = common_config('site', $setting);
+        }
+        $this->out->input($setting, $title, $value, $instructions);
+    }
+
+    /**
+     * Action elements
+     *
+     * @return void
+     */
+
+    function formActions()
+    {
+        $this->out->submit('submit', _('Save'), 'submit', null, _('Save site settings'));
+    }
+}

diff --git a/classes/Config.php b/classes/Config.php
index 92f237d7f243d240fe12866489326d165dcab5ac..390d75381ac82fb74289a91fc6a77a011d875da0 100644 (file)
--- a/classes/Config.php
+++ b/classes/Config.php
@@ -120,6 +120,35 @@ class Config extends Memcached_DataObject
         return $result;
     }
 
+    function &pkeyGet($kv)
+    {
+        return Memcached_DataObject::pkeyGet('Config', $kv);
+    }
+
+    static function save($section, $setting, $value)
+    {
+        $result = null;
+
+        $config = Config::pkeyGet(array('section' => $section,
+                                        'setting' => $setting));
+
+        if (!empty($config)) {
+            $orig = clone($config);
+            $config->value = $value;
+            $result = $config->update($orig);
+        } else {
+            $config = new Config();
+
+            $config->section = $section;
+            $config->setting = $setting;
+            $config->value   = $value;
+
+            $result = $config->insert();
+        }
+
+        return $result;
+    }
+
     function _blowSettingsCache()
     {
         $c = self::memcache();

diff --git a/classes/User.php b/classes/User.php
index c529b82e0bb6457e1955c6c241374f6fb60da567..7267ec2d793a3788b8ab8c1ea68ca64cf9032af3 100644 (file)
--- a/classes/User.php
+++ b/classes/User.php
@@ -710,6 +710,7 @@ class User extends Memcached_DataObject
                 break;
             case Right::CONFIGURESITE:
                 $result = $this->hasRole(User_role::ADMINISTRATOR);
+                break;
             default:
                 $result = false;
                 break;

diff --git a/lib/adminpanelaction.php b/lib/adminpanelaction.php
new file mode 100644 (file)
index 0000000..fa3272f
--- /dev/null
+++ b/lib/adminpanelaction.php
@@ -0,0 +1,212 @@
+<?php
+/**
+ * StatusNet, the distributed open-source microblogging tool
+ *
+ * Superclass for admin panel actions
+ *
+ * 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  UI
+ * @package   StatusNet
+ * @author    Evan Prodromou <evan@status.net>
+ * @copyright 2009 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);
+}
+
+/**
+ * superclass for admin panel actions
+ *
+ * Common code for all admin panel actions.
+ *
+ * @category UI
+ * @package  StatusNet
+ * @author   Evan Prodromou <evan@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/
+ *
+ * @todo Find some commonalities with SettingsAction and combine
+ */
+
+class AdminPanelAction extends Action
+{
+    var $success = true;
+    var $msg     = null;
+
+    /**
+     * Prepare for the action
+     *
+     * We check to see that the user is logged in, has
+     * authenticated in this session, and has the right
+     * to configure the site.
+     *
+     * @param array $args Array of arguments from Web driver
+     *
+     * @return boolean success flag
+     */
+
+    function prepare($args)
+    {
+        parent::prepare($args);
+
+        // User must be logged in.
+
+        if (!common_logged_in()) {
+            $this->clientError(_('Not logged in.'));
+            return;
+        }
+
+        $user = common_current_user();
+
+        // ...because they're logged in
+
+        assert(!empty($user));
+
+        // It must be a "real" login, not saved cookie login
+
+        if (!common_is_real_login()) {
+            // Cookie theft is too easy; we require automatic
+            // logins to re-authenticate before admining the site
+            common_set_returnto($this->selfUrl());
+            if (Event::handle('RedirectToLogin', array($this, $user))) {
+                common_redirect(common_local_url('login'), 303);
+            }
+        }
+
+        // User must have the right to change admin settings
+
+        if (!$user->hasRight(Right::CONFIGURESITE)) {
+            $this->clientError(_('You cannot make changes to this site.'));
+            return;
+        }
+
+        return true;
+    }
+
+    /**
+     * handle the action
+     *
+     * Check session token and try to save the settings if this is a
+     * POST. Otherwise, show the form.
+     *
+     * @param array $args unused.
+     *
+     * @return void
+     */
+
+    function handle($args)
+    {
+        if ($_SERVER['REQUEST_METHOD'] == 'POST') {
+            $this->checkSessionToken();
+            try {
+                $this->saveSettings();
+
+                // Reload settings
+
+                Config::loadSettings();
+
+                $this->success = true;
+                $this->msg     = _('Settings saved.');
+            } catch (Exception $e) {
+                $this->success = false;
+                $this->msg     = $e->getMessage();
+            }
+        }
+        $this->showPage();
+    }
+
+    /**
+     * Show the content section of the page
+     *
+     * Here, we show the admin panel's form.
+     *
+     * @return void.
+     */
+
+    function showContent()
+    {
+        $this->showForm();
+    }
+
+    /**
+     * show human-readable instructions for the page, or
+     * a success/failure on save.
+     *
+     * @return void
+     */
+
+    function showPageNotice()
+    {
+        if ($this->msg) {
+            $this->element('div', ($this->success) ? 'success' : 'error',
+                           $this->msg);
+        } else {
+            $inst   = $this->getInstructions();
+            $output = common_markup_to_html($inst);
+
+            $this->elementStart('div', 'instructions');
+            $this->raw($output);
+            $this->elementEnd('div');
+        }
+    }
+
+    /**
+     * Show the admin panel form
+     *
+     * Sub-classes should overload this.
+     *
+     * @return void
+     */
+
+    function showForm()
+    {
+        $this->clientError(_('showForm() not implemented.'));
+        return;
+    }
+
+    /**
+     * Instructions for using this form.
+     *
+     * String with instructions for using the form.
+     *
+     * Subclasses should overload this.
+     *
+     * @return void
+     */
+
+    function getInstructions()
+    {
+        return '';
+    }
+
+    /**
+     * Save settings from the form
+     *
+     * Validate and save the settings from the user.
+     *
+     * @return void
+     */
+
+    function saveSettings()
+    {
+        $this->clientError(_('saveSettings() not implemented.'));
+        return;
+    }
+}

diff --git a/lib/router.php b/lib/router.php
index db9fdb4704084a2aa941e835d68225d4321c59c8..27ad54c1982f4aa8ddec6a9319df79d7a1b9a200 100644 (file)
--- a/lib/router.php
+++ b/lib/router.php
@@ -573,6 +573,8 @@ class Router
             $m->connect('api/search.json', array('action' => 'twitapisearchjson'));
             $m->connect('api/trends.json', array('action' => 'twitapitrends'));
 
+            $m->connect('admin/site', array('action' => 'siteadminpanel'));
+
             $m->connect('getfile/:filename',
                         array('action' => 'getfile'),
                         array('filename' => '[A-Za-z0-9._-]+'));