3 * StatusNet - the distributed open-source microblogging tool
4 * Copyright (C) 2010, StatusNet, Inc.
6 * Plugin enable action.
8 * This program is free software: you can redistribute it and/or modify
9 * it under the terms of the GNU Affero General Public License as published by
10 * the Free Software Foundation, either version 3 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU Affero General Public License for more details.
18 * You should have received a copy of the GNU Affero General Public License
19 * along with this program. If not, see <http://www.gnu.org/licenses/>.
25 * @author Brion Vibber <brion@status.net>
26 * @copyright 2010 StatusNet, Inc.
27 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPLv3
28 * @link http://status.net/
31 if (!defined('STATUSNET')) {
36 * Plugin enable action.
38 * (Re)-enables a plugin from the default plugins list.
42 * - plugin: plugin name
43 * - token: session token to prevent CSRF attacks
44 * - ajax: boolean; whether to return Ajax or full-browser results
46 * Only works if the current user is logged in.
50 * @author Brion Vibber <brion@status.net>
51 * @copyright 2010 StatusNet, Inc.
52 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPLv3
53 * @link http://status.net/
55 class PluginEnableAction extends Action
61 * Check pre-requisites and instantiate attributes
63 * @param Array $args array of arguments (URL, GET, POST)
65 * @return boolean success flag
67 function prepare($args)
69 parent::prepare($args);
71 // @fixme these are pretty common, should a parent class factor these out?
73 // Only allow POST requests
75 if ($_SERVER['REQUEST_METHOD'] != 'POST') {
76 // TRANS: Client error displayed when trying to use another method than POST.
77 // TRANS: Do not translate POST.
78 $this->clientError(_('This action only accepts POST requests.'));
83 $token = $this->trimmed('token');
85 if (!$token || $token != common_session_token()) {
86 // TRANS: Client error displayed when the session token does not match or is not given.
87 $this->clientError(_('There was a problem with your session token.'.
88 ' Try again, please.'));
91 // Only for logged-in users
93 $this->user = common_current_user();
95 if (empty($this->user)) {
96 // TRANS: Error message displayed when trying to perform an action that requires a logged in user.
97 $this->clientError(_('Not logged in.'));
100 if (!AdminPanelAction::canAdmin('plugins')) {
101 // TRANS: Client error displayed when trying to enable or disable a plugin without access rights.
102 $this->clientError(_('You cannot administer plugins.'));
105 $this->plugin = $this->arg('plugin');
106 $defaultPlugins = common_config('plugins', 'default');
107 if (!array_key_exists($this->plugin, $defaultPlugins)) {
108 // TRANS: Client error displayed when trying to enable or disable a non-existing plugin.
109 $this->clientError(_('No such plugin.'));
118 * Does the subscription and returns results.
120 * @param Array $args unused.
126 $key = 'disable-' . $this->plugin;
127 Config::save('plugins', $key, $this->overrideValue());
129 // @fixme this is a pretty common pattern and should be refactored down
130 if ($this->boolean('ajax')) {
131 $this->startHTML('text/xml;charset=utf-8');
132 $this->elementStart('head');
133 $this->element('title', null, $this->successShortTitle());
134 $this->elementEnd('head');
135 $this->elementStart('body');
136 $form = $this->successNextForm();
138 $this->elementEnd('body');
141 $url = common_local_url('pluginsadminpanel');
142 common_redirect($url, 303);
147 * Value to save into $config['plugins']['disable-<name>']
149 protected function overrideValue()
154 protected function successShortTitle()
156 // TRANS: Page title for AJAX form return when enabling a plugin.
157 return _m('plugin', 'Enabled');
160 protected function successNextForm()
162 return new DisablePluginForm($this, $this->plugin);