From: Evan Prodromou Date: Wed, 11 Nov 2009 05:22:42 +0000 (-0500) Subject: Merge branch '0.9.x' into adminpanel X-Git-Url: https://git.mxchange.org/?a=commitdiff_plain;h=935410e8dc4c2d4d286a942cc27bbf8bc452fbdd;hp=093857c582a68b39e0d65523d27f25ede7b7fed6;p=quix0rs-gnu-social.git Merge branch '0.9.x' into adminpanel --- diff --git a/actions/siteadminpanel.php b/actions/siteadminpanel.php new file mode 100644 index 0000000000..358c0b15fa --- /dev/null +++ b/actions/siteadminpanel.php @@ -0,0 +1,281 @@ +. + * + * @category Settings + * @package StatusNet + * @author Evan Prodromou + * @author Zach Copley + * @author Sarven Capadisli + * @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 + * @author Zach Copley + * @author Sarven Capadisli + * @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', 'timezone', 'language', + '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) + { + // 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')); + } + + // Validate timezone + + if (is_null($values['timezone']) || + !in_array($values['timezone'], DateTimeZone::listIdentifiers())) { + $this->clientError(_('Timezone not selected.')); + return; + } + + // Validate language + + if (!is_null($language) && !in_array($language, array_keys(get_nice_language_list()))) { + $this->clientError(sprintf(_('Unknown language "%s"'), $language)); + } + } +} + +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')); + + $timezones = array(); + + foreach (DateTimeZone::listIdentifiers() as $k => $v) { + $timezones[$v] = $v; + } + + asort($timezones); + + $this->out->dropdown('timezone', _('Default timezone'), + $timezones, _('Default timezone for the site; usually UTC.'), + true, $this->value('timezone')); + + $this->out->dropdown('language', _('Language'), + get_nice_language_list(), _('Default site language'), + false, $this->value('language')); + + $this->out->checkbox('closed', _('Closed'), + (bool) $this->value('closed'), + _('Is registration on this site prohibited?')); + + $this->out->checkbox('inviteonly', _('Invite-only'), + (bool) $this->value('inviteonly'), + _('Is registration on this site only open to invited users?')); + + $this->out->checkbox('private', _('Private'), + (bool) $this->value('private'), + _('Prohibit anonymous users (not logged in) from viewing 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) + { + $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')); + } +} diff --git a/classes/Config.php b/classes/Config.php index 92f237d7f2..390d75381a 100644 --- 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 9b90ce61bf..447a34141b 100644 --- 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/action.php b/lib/action.php index 80f398fbd7..edb70c3d9d 100644 --- a/lib/action.php +++ b/lib/action.php @@ -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'), diff --git a/lib/adminpanelaction.php b/lib/adminpanelaction.php new file mode 100644 index 0000000000..6d4b974c37 --- /dev/null +++ b/lib/adminpanelaction.php @@ -0,0 +1,344 @@ +. + * + * @category UI + * @package StatusNet + * @author Evan Prodromou + * @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 + * @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 + * @author Sarven Capadisli + * @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'); + + Event::handle('EndAdminPanelNav', array($this)); + } + $this->action->elementEnd('ul'); + } +} + +/** + * Menu for admin group of actions + * + * @category Output + * @package StatusNet + * @author Evan Prodromou + * @author Sarven Capadisli + * @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 PublicGroupNav 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('StartPublicGroupNav', array($this))) { + $this->out->menuItem(common_local_url('public'), _('Public'), + _('Public timeline'), $action_name == 'public', 'nav_timeline_public'); + + $this->out->menuItem(common_local_url('groups'), _('Groups'), + _('User groups'), $action_name == 'groups', 'nav_groups'); + + $this->out->menuItem(common_local_url('publictagcloud'), _('Recent tags'), + _('Recent tags'), $action_name == 'publictagcloud', 'nav_recent-tags'); + + if (count(common_config('nickname', 'featured')) > 0) { + $this->out->menuItem(common_local_url('featured'), _('Featured'), + _('Featured users'), $action_name == 'featured', 'nav_featured'); + } + + $this->out->menuItem(common_local_url('favorited'), _('Popular'), + _("Popular notices"), $action_name == 'favorited', 'nav_timeline_favorited'); + + Event::handle('EndPublicGroupNav', array($this)); + } + $this->action->elementEnd('ul'); + } +} diff --git a/lib/router.php b/lib/router.php index bad3decad5..321b4273e7 100644 --- a/lib/router.php +++ b/lib/router.php @@ -585,6 +585,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._-]+'));