forked from GNUsocial/gnu-social
		
	Conflicts: actions/hostmeta.php actions/imsettings.php classes/User.php lib/adminpanelaction.php lib/channel.php lib/default.php lib/router.php lib/util.php
		
			
				
	
	
		
			420 lines
		
	
	
		
			13 KiB
		
	
	
	
		
			PHP
		
	
	
	
	
	
			
		
		
	
	
			420 lines
		
	
	
		
			13 KiB
		
	
	
	
		
			PHP
		
	
	
	
	
	
| <?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()) {
 | |
|             // TRANS: Client error message thrown when trying to access the admin panel while not logged in.
 | |
|             $this->clientError(_('Not logged in.'));
 | |
|             return false;
 | |
|         }
 | |
| 
 | |
|         $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)) {
 | |
|             // TRANS: Client error message thrown when a user tries to change admin settings but has no access rights.
 | |
|             $this->clientError(_('You cannot make changes to this site.'));
 | |
|             return false;
 | |
|         }
 | |
| 
 | |
|         // This panel must be enabled
 | |
| 
 | |
|         $name = $this->trimmed('action');
 | |
| 
 | |
|         $name = mb_substr($name, 0, -10);
 | |
| 
 | |
|         if (!self::canAdmin($name)) {
 | |
|             // TRANS: Client error message throw when a certain panel's settings cannot be changed.
 | |
|             $this->clientError(_('Changes to that panel are not allowed.'), 403);
 | |
|             return false;
 | |
|         }
 | |
| 
 | |
|         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;
 | |
|                 // TRANS: Message after successful saving of administrative settings.
 | |
|                 $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 content block. Overrided just to add a special class
 | |
|      * to the content div to allow styling.
 | |
|      *
 | |
|      * @return nothing
 | |
|      */
 | |
|     function showContentBlock()
 | |
|     {
 | |
|         $this->elementStart('div', array('id' => 'content', 'class' => 'admin'));
 | |
|         $this->showPageTitle();
 | |
|         $this->showPageNoticeBlock();
 | |
|         $this->elementStart('div', array('id' => 'content_inner'));
 | |
|         // show the actual content (forms, lists, whatever)
 | |
|         $this->showContent();
 | |
|         $this->elementEnd('div');
 | |
|         $this->elementEnd('div');
 | |
|     }
 | |
| 
 | |
|     /**
 | |
|      * 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()
 | |
|     {
 | |
|         // TRANS: Client error message.
 | |
|         $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()
 | |
|     {
 | |
|         // TRANS: Client error message
 | |
|         $this->clientError(_('saveSettings() not implemented.'));
 | |
|         return;
 | |
|     }
 | |
| 
 | |
|     /**
 | |
|      * Delete a design setting
 | |
|      *
 | |
|      * // XXX: Maybe this should go in Design? --Z
 | |
|      *
 | |
|      * @return mixed $result false if something didn't work
 | |
|      */
 | |
|     function deleteSetting($section, $setting)
 | |
|     {
 | |
|         $config = new Config();
 | |
| 
 | |
|         $config->section = $section;
 | |
|         $config->setting = $setting;
 | |
| 
 | |
|         if ($config->find(true)) {
 | |
|             $result = $config->delete();
 | |
|             if (!$result) {
 | |
|                 common_log_db_error($config, 'DELETE', __FILE__);
 | |
|                 // TRANS: Client error message thrown if design settings could not be deleted in
 | |
|                 // TRANS: the admin panel Design.
 | |
|                 $this->clientError(_("Unable to delete design setting."));
 | |
|                 return null;
 | |
|             }
 | |
|             return $result;
 | |
|         }
 | |
| 
 | |
|         return null;
 | |
|     }
 | |
| 
 | |
|     function canAdmin($name)
 | |
|     {
 | |
|         $isOK = false;
 | |
| 
 | |
|         if (Event::handle('AdminPanelCheck', array($name, &$isOK))) {
 | |
|             $isOK = in_array($name, common_config('admin', 'panels'));
 | |
|         }
 | |
| 
 | |
|         return $isOK;
 | |
|     }
 | |
| }
 | |
| 
 | |
| /**
 | |
|  * 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))) {
 | |
| 
 | |
|             if (AdminPanelAction::canAdmin('site')) {
 | |
|                 // TRANS: Menu item title/tooltip
 | |
|                 $menu_title = _('Basic site configuration');
 | |
|                 // TRANS: Menu item for site administration
 | |
|                 $this->out->menuItem(common_local_url('siteadminpanel'), _m('MENU', 'Site'),
 | |
|                                      $menu_title, $action_name == 'siteadminpanel', 'nav_site_admin_panel');
 | |
|             }
 | |
| 
 | |
|             if (AdminPanelAction::canAdmin('design')) {
 | |
|                 // TRANS: Menu item title/tooltip
 | |
|                 $menu_title = _('Design configuration');
 | |
|                 // TRANS: Menu item for site administration
 | |
|                 $this->out->menuItem(common_local_url('designadminpanel'), _m('MENU', 'Design'),
 | |
|                                      $menu_title, $action_name == 'designadminpanel', 'nav_design_admin_panel');
 | |
|             }
 | |
| 
 | |
|             if (AdminPanelAction::canAdmin('user')) {
 | |
|                 // TRANS: Menu item title/tooltip
 | |
|                 $menu_title = _('User configuration');
 | |
|                 // TRANS: Menu item for site administration
 | |
|                 $this->out->menuItem(common_local_url('useradminpanel'), _('User'),
 | |
|                                      $menu_title, $action_name == 'useradminpanel', 'nav_user_admin_panel');
 | |
|             }
 | |
| 
 | |
|             if (AdminPanelAction::canAdmin('access')) {
 | |
|                 // TRANS: Menu item title/tooltip
 | |
|                 $menu_title = _('Access configuration');
 | |
|                 // TRANS: Menu item for site administration
 | |
|                 $this->out->menuItem(common_local_url('accessadminpanel'), _('Access'),
 | |
|                                      $menu_title, $action_name == 'accessadminpanel', 'nav_access_admin_panel');
 | |
|             }
 | |
| 
 | |
|             if (AdminPanelAction::canAdmin('paths')) {
 | |
|                 // TRANS: Menu item title/tooltip
 | |
|                 $menu_title = _('Paths configuration');
 | |
|                 // TRANS: Menu item for site administration
 | |
|                 $this->out->menuItem(common_local_url('pathsadminpanel'), _('Paths'),
 | |
|                                     $menu_title, $action_name == 'pathsadminpanel', 'nav_paths_admin_panel');
 | |
|             }
 | |
| 
 | |
|             if (AdminPanelAction::canAdmin('sessions')) {
 | |
|                 // TRANS: Menu item title/tooltip
 | |
|                 $menu_title = _('Sessions configuration');
 | |
|                 // TRANS: Menu item for site administration
 | |
|                 $this->out->menuItem(common_local_url('sessionsadminpanel'), _('Sessions'),
 | |
|                                      $menu_title, $action_name == 'sessionsadminpanel', 'nav_sessions_admin_panel');
 | |
|             }
 | |
| 
 | |
|             if (AdminPanelAction::canAdmin('sitenotice')) {
 | |
|                 // TRANS: Menu item title/tooltip
 | |
|                 $menu_title = _('Edit site notice');
 | |
|                 // TRANS: Menu item for site administration
 | |
|                 $this->out->menuItem(common_local_url('sitenoticeadminpanel'), _('Site notice'),
 | |
|                                      $menu_title, $action_name == 'sitenoticeadminpanel', 'nav_sitenotice_admin_panel');
 | |
|             }
 | |
| 
 | |
|             if (AdminPanelAction::canAdmin('snapshot')) {
 | |
|                 // TRANS: Menu item title/tooltip
 | |
|                 $menu_title = _('Snapshots configuration');
 | |
|                 // TRANS: Menu item for site administration
 | |
|                 $this->out->menuItem(common_local_url('snapshotadminpanel'), _('Snapshots'),
 | |
|                                      $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');
 | |
|             }
 | |
| 
 | |
|             if (AdminPanelAction::canAdmin('plugins')) {
 | |
|                 // TRANS: Menu item title/tooltip
 | |
|                 $menu_title = _('Plugins configuration');
 | |
|                 // TRANS: Menu item for site administration
 | |
|                 $this->out->menuItem(common_local_url('pluginsadminpanel'), _('Plugins'),
 | |
|                                      $menu_title, $action_name == 'pluginsadminpanel', 'nav_design_admin_panel');
 | |
|             }
 | |
| 
 | |
|             Event::handle('EndAdminPanelNav', array($this));
 | |
|         }
 | |
|         $this->action->elementEnd('ul');
 | |
|     }
 | |
| }
 |