Merge branch '0.9.x' of git@gitorious.org:statusnet/mainline into 0.9.x

This commit is contained in:
Sarven Capadisli 2009-11-17 19:52:19 +00:00
commit 020c2b48b6
7 changed files with 1150 additions and 0 deletions

View File

@ -0,0 +1,231 @@
<?php
/**
* StatusNet, the distributed open-source microblogging tool
*
* Design 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 design 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 DesignadminpanelAction extends AdminPanelAction
{
/**
* Returns the page title
*
* @return string page title
*/
function title()
{
return _('Design');
}
/**
* Instructions for using this form.
*
* @return string instructions
*/
function getInstructions()
{
return _('Design settings for this StatusNet site.');
}
/**
* Show the site admin panel form
*
* @return void
*/
function showForm()
{
$form = new DesignAdminPanelForm($this);
$form->show();
return;
}
/**
* Save settings from the form
*
* @return void
*/
function saveSettings()
{
static $settings = array('theme');
$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)
{
if (!in_array($values['theme'], Theme::listAvailable())) {
$this->clientError(sprintf(_("Theme not available: %s"), $values['theme']));
}
}
}
class DesignAdminPanelForm extends Form
{
/**
* ID of the form
*
* @return int ID of the form
*/
function id()
{
return 'designadminpanel';
}
/**
* class of the form
*
* @return string class of the form
*/
function formClass()
{
return 'form_design_admin_panel';
}
/**
* Action of the form
*
* @return string URL of the action
*/
function action()
{
return common_local_url('designadminpanel');
}
/**
* Data elements of the form
*
* @return void
*/
function formData()
{
$themes = Theme::listAvailable();
asort($themes);
$themes = array_combine($themes, $themes);
$this->out->elementStart('ul');
$this->out->elementStart('li');
$this->out->dropdown('theme', _('Theme'),
$themes, _('Theme for the site.'),
true, $this->value('theme'));
$this->out->elementEnd('li');
$this->out->elementEnd('ul');
}
/**
* 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)
{
$this->out->input($setting, $title, $this->value($setting), $instructions);
}
/**
* Utility to simplify getting the posted-or-stored setting value
*
* @param string $setting Name of the setting
*
* @return string param value if posted, or current config value
*/
function value($setting)
{
$value = $this->out->trimmed($setting);
if (empty($value)) {
$value = common_config('site', $setting);
}
return $value;
}
/**
* Action elements
*
* @return void
*/
function formActions()
{
$this->out->submit('submit', _('Save'), 'submit', null, _('Save site settings'));
}
}

373
actions/siteadminpanel.php Normal file
View File

@ -0,0 +1,373 @@
<?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('site' => array('name', 'broughtby', 'broughtbyurl',
'email', 'timezone', 'language'),
'snapshot' => array('run', 'reporturl', 'frequency'));
static $booleans = array('site' => array('private'));
$values = array();
foreach ($settings as $section => $parts) {
foreach ($parts as $setting) {
$values[$section][$setting] = $this->trimmed($setting);
}
}
foreach ($booleans as $section => $parts) {
foreach ($parts as $setting) {
$values[$section][$setting] = ($this->boolean($setting)) ? 1 : 0;
}
}
// 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]);
}
}
foreach ($booleans as $section => $parts) {
foreach ($parts as $setting) {
Config::save($section, $setting, $values[$section][$setting]);
}
}
$config->query('COMMIT');
return;
}
function validate(&$values)
{
// Validate site name
if (empty($values['site']['name'])) {
$this->clientError(_("Site name must have non-zero length."));
}
// Validate email
$values['site']['email'] = common_canonical_email($values['site']['email']);
if (empty($values['site']['email'])) {
$this->clientError(_('You must have a valid contact email address'));
}
if (!Validate::email($values['site']['email'], common_config('email', 'check_domain'))) {
$this->clientError(_('Not a valid email address'));
}
// Validate timezone
if (is_null($values['site']['timezone']) ||
!in_array($values['site']['timezone'], DateTimeZone::listIdentifiers())) {
$this->clientError(_('Timezone not selected.'));
return;
}
// Validate language
if (!is_null($values['site']['language']) &&
!in_array($values['site']['language'], array_keys(get_nice_language_list()))) {
$this->clientError(sprintf(_('Unknown language "%s"'), $values['site']['language']));
}
// 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."));
}
// Validate snapshot run value
if (!in_array($values['snapshot']['run'], array('web', 'cron', 'never'))) {
$this->clientError(_("Invalid snapshot run value."));
}
// Validate snapshot run value
if (!Validate::number($values['snapshot']['frequency'])) {
$this->clientError(_("Snapshot frequency must be a number."));
}
}
}
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->out->elementStart('ul', 'form_data');
$this->li();
$this->input('name', _('Site name'),
_('The name of your site, like "Yourcompany Microblog"'));
$this->unli();
$this->li();
$this->input('broughtby', _('Brought by'),
_('Text used for credits link in footer of each page'));
$this->unli();
$this->li();
$this->input('broughtbyurl', _('Brought by URL'),
_('URL used for credits link in footer of each page'));
$this->unli();
$this->li();
$this->input('email', _('Email'),
_('contact email address for your site'));
$this->unli();
$timezones = array();
foreach (DateTimeZone::listIdentifiers() as $k => $v) {
$timezones[$v] = $v;
}
asort($timezones);
$this->li();
$this->out->dropdown('timezone', _('Default timezone'),
$timezones, _('Default timezone for the site; usually UTC.'),
true, $this->value('timezone'));
$this->unli();
$this->li();
$this->out->dropdown('language', _('Language'),
get_nice_language_list(), _('Default site language'),
false, $this->value('language'));
$this->unli();
$this->li();
$this->out->checkbox('private', _('Private'),
(bool) $this->value('private'),
_('Prohibit anonymous users (not logged in) from viewing site?'));
$this->unli();
$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');
}
/**
* 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
* @param string $section config section, default = 'site'
*
* @return void
*/
function input($setting, $title, $instructions, $section='site')
{
$this->out->input($setting, $title, $this->value($setting, $section), $instructions);
}
/**
* Utility to simplify getting the posted-or-stored setting value
*
* @param string $setting Name of the setting
* @param string $main configuration section, default = 'site'
*
* @return string param value if posted, or current config value
*/
function value($setting, $main='site')
{
$value = $this->out->trimmed($setting);
if (empty($value)) {
$value = common_config($main, $setting);
}
return $value;
}
function li()
{
$this->out->elementStart('li');
}
function unli()
{
$this->out->elementEnd('li');
}
/**
* Action elements
*
* @return void
*/
function formActions()
{
$this->out->submit('submit', _('Save'), 'submit', null, _('Save site settings'));
}
}

228
actions/useradminpanel.php Normal file
View File

@ -0,0 +1,228 @@
<?php
/**
* StatusNet, the distributed open-source microblogging tool
*
* User 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 user 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 UseradminpanelAction extends AdminPanelAction
{
/**
* Returns the page title
*
* @return string page title
*/
function title()
{
return _('User');
}
/**
* Instructions for using this form.
*
* @return string instructions
*/
function getInstructions()
{
return _('User settings for this StatusNet site.');
}
/**
* Show the site admin panel form
*
* @return void
*/
function showForm()
{
$form = new UserAdminPanelForm($this);
$form->show();
return;
}
/**
* Save settings from the form
*
* @return void
*/
function saveSettings()
{
static $settings = array('theme');
static $booleans = array('closed', 'inviteonly', 'private');
$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)
{
}
}
class UserAdminPanelForm extends Form
{
/**
* ID of the form
*
* @return int ID of the form
*/
function id()
{
return 'useradminpanel';
}
/**
* class of the form
*
* @return string class of the form
*/
function formClass()
{
return 'form_user_admin_panel';
}
/**
* Action of the form
*
* @return string URL of the action
*/
function action()
{
return common_local_url('useradminpanel');
}
/**
* Data elements of the form
*
* @return void
*/
function formData()
{
$this->li();
$this->out->checkbox('closed', _('Closed'),
(bool) $this->value('closed'),
_('Is registration on this site prohibited?'));
$this->unli();
$this->li();
$this->out->checkbox('inviteonly', _('Invite-only'),
(bool) $this->value('inviteonly'),
_('Is registration on this site only open to invited users?'));
$this->unli();
}
/**
* 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)
{
$this->out->input($setting, $title, $this->value($setting), $instructions);
}
/**
* Utility to simplify getting the posted-or-stored setting value
*
* @param string $setting Name of the setting
*
* @return string param value if posted, or current config value
*/
function value($cat, $setting)
{
$value = $this->out->trimmed($setting);
if (empty($value)) {
$value = common_config($cat, $setting);
}
return $value;
}
/**
* Action elements
*
* @return void
*/
function formActions()
{
$this->out->submit('submit', _('Save'), 'submit', null, _('Save site settings'));
}
}

View File

@ -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();

View File

@ -434,6 +434,10 @@ class Action extends HTMLOutputter // lawsuit
$this->menuItem(common_local_url($connect),
_('Connect'), _('Connect to services'), false, 'nav_connect');
}
if ($user->hasRight(Right::CONFIGURESITE)) {
$this->menuItem(common_local_url('siteadminpanel'),
_('Admin'), _('Change site configuration'), false, 'nav_admin');
}
if (common_config('invite', 'enabled')) {
$this->menuItem(common_local_url('invite'),
_('Invite'),

282
lib/adminpanelaction.php Normal file
View File

@ -0,0 +1,282 @@
<?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 tabset for this page
*
* Uses the AdminPanelNav widget
*
* @return void
* @see AdminPanelNav
*/
function showLocalNav()
{
$nav = new AdminPanelNav($this);
$nav->show();
}
/**
* 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;
}
}
/**
* Menu for public group of actions
*
* @category Output
* @package StatusNet
* @author Evan Prodromou <evan@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/
*
* @see Widget
*/
class AdminPanelNav extends Widget
{
var $action = null;
/**
* Construction
*
* @param Action $action current action, used for output
*/
function __construct($action=null)
{
parent::__construct($action);
$this->action = $action;
}
/**
* Show the menu
*
* @return void
*/
function show()
{
$action_name = $this->action->trimmed('action');
$this->action->elementStart('ul', array('class' => 'nav'));
if (Event::handle('StartAdminPanelNav', array($this))) {
$this->out->menuItem(common_local_url('siteadminpanel'), _('Site'),
_('Basic site configuration'), $action_name == 'siteadminpanel', 'nav_site_admin_panel');
$this->out->menuItem(common_local_url('designadminpanel'), _('Design'),
_('Design configuration'), $action_name == 'designadminpanel', 'nav_design_admin_panel');
Event::handle('EndAdminPanelNav', array($this));
}
$this->action->elementEnd('ul');
}
}

View File

@ -588,6 +588,9 @@ 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('admin/design', array('action' => 'designadminpanel'));
$m->connect('getfile/:filename',
array('action' => 'getfile'),
array('filename' => '[A-Za-z0-9._-]+'));