3 * StatusNet, the distributed open-source microblogging tool
5 * Edit an OAuth Application
9 * LICENCE: This program is free software: you can redistribute it and/or modify
10 * it under the terms of the GNU Affero General Public License as published by
11 * the Free Software Foundation, either version 3 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU Affero General Public License for more details.
19 * You should have received a copy of the GNU Affero General Public License
20 * along with this program. If not, see <http://www.gnu.org/licenses/>.
22 * @category Applications
24 * @author Zach Copley <zach@status.net>
25 * @copyright 2008-2011 StatusNet, Inc.
26 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
27 * @link http://status.net/
30 if (!defined('STATUSNET') && !defined('LACONICA')) {
35 * Edit the details of an OAuth application
37 * This is the form for editing an application
39 * @category Application
41 * @author Zach Copley <zach@status.net>
42 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
43 * @link http://status.net/
45 class EditApplicationAction extends Action
53 // TRANS: Title for "Edit application" form.
54 return _('Edit application');
60 function prepare($args)
62 parent::prepare($args);
64 if (!common_logged_in()) {
65 // TRANS: Client error displayed trying to edit an application while not logged in.
66 $this->clientError(_('You must be logged in to edit an application.'));
69 $id = (int)$this->arg('id');
71 $this->app = Oauth_application::getKV($id);
72 $this->owner = User::getKV($this->app->owner);
73 $cur = common_current_user();
75 if ($cur->id != $this->owner->id) {
76 // TRANS: Client error displayed trying to edit an application while not being its owner.
77 $this->clientError(_('You are not the owner of this application.'), 401);
81 // TRANS: Client error displayed trying to edit an application that does not exist.
82 $this->clientError(_('No such application.'));
91 * On GET, show the form. On POST, try to save the app.
93 * @param array $args unused
97 function handle($args)
99 parent::handle($args);
101 if ($_SERVER['REQUEST_METHOD'] == 'POST') {
102 $this->handlePost($args);
108 function handlePost($args)
110 // Workaround for PHP returning empty $_POST and $_FILES when POST
111 // length > post_max_size in php.ini
115 && ($_SERVER['CONTENT_LENGTH'] > 0)
117 // TRANS: Client error displayed when the number of bytes in a POST request exceeds a limit.
118 // TRANS: %s is the number of bytes of the CONTENT_LENGTH.
119 $msg = _m('The server was unable to handle that much POST data (%s byte) due to its current configuration.',
120 'The server was unable to handle that much POST data (%s bytes) due to its current configuration.',
121 intval($_SERVER['CONTENT_LENGTH']));
122 $this->clientException(sprintf($msg, $_SERVER['CONTENT_LENGTH']));
127 $token = $this->trimmed('token');
128 if (!$token || $token != common_session_token()) {
129 // TRANS: Client error displayed when the session token does not match or is not given.
130 $this->clientError(_('There was a problem with your session token.'));
133 $cur = common_current_user();
135 if ($this->arg('cancel')) {
136 common_redirect(common_local_url('showapplication',
137 array('id' => $this->app->id)), 303);
138 } elseif ($this->arg('save')) {
141 // TRANS: Client error displayed submitting invalid form data for edit application.
142 $this->clientError(_('Unexpected form submission.'));
146 function showForm($msg=null)
152 function showContent()
154 $form = new ApplicationEditForm($this, $this->app);
158 function showPageNotice()
160 if (!empty($this->msg)) {
161 $this->element('p', 'error', $this->msg);
163 $this->element('p', 'instructions',
164 // TRANS: Instructions for "Edit application" form.
165 _('Use this form to edit your application.'));
171 $name = $this->trimmed('name');
172 $description = $this->trimmed('description');
173 $source_url = $this->trimmed('source_url');
174 $organization = $this->trimmed('organization');
175 $homepage = $this->trimmed('homepage');
176 $callback_url = $this->trimmed('callback_url');
177 $type = $this->arg('app_type');
178 $access_type = $this->arg('default_access_type');
181 // TRANS: Validation error shown when not providing a name in the "Edit application" form.
182 $this->showForm(_('Name is required.'));
184 } elseif (mb_strlen($name) > 255) {
185 // TRANS: Validation error shown when providing too long a name in the "Edit application" form.
186 $this->showForm(_('Name is too long (maximum 255 characters).'));
188 } else if ($this->nameExists($name)) {
189 // TRANS: Validation error shown when providing a name for an application that already exists in the "Edit application" form.
190 $this->showForm(_('Name already in use. Try another one.'));
192 } elseif (empty($description)) {
193 // TRANS: Validation error shown when not providing a description in the "Edit application" form.
194 $this->showForm(_('Description is required.'));
196 } elseif (Oauth_application::descriptionTooLong($description)) {
197 $this->showForm(sprintf(
198 // TRANS: Validation error shown when providing too long a description in the "Edit application" form.
199 // TRANS: %d is the maximum number of allowed characters.
200 _m('Description is too long (maximum %d character).',
201 'Description is too long (maximum %d characters).',
202 Oauth_application::maxDesc()),
203 Oauth_application::maxDesc()));
205 } elseif (mb_strlen($source_url) > 255) {
206 // TRANS: Validation error shown when providing too long a source URL in the "Edit application" form.
207 $this->showForm(_('Source URL is too long.'));
209 } elseif ((mb_strlen($source_url) > 0)
210 && !common_valid_http_url($source_url)) {
211 // TRANS: Validation error shown when providing an invalid source URL in the "Edit application" form.
212 $this->showForm(_('Source URL is not valid.'));
214 } elseif (empty($organization)) {
215 // TRANS: Validation error shown when not providing an organisation in the "Edit application" form.
216 $this->showForm(_('Organization is required.'));
218 } elseif (mb_strlen($organization) > 255) {
219 // TRANS: Validation error shown when providing too long an arganisation name in the "Edit application" form.
220 $this->showForm(_('Organization is too long (maximum 255 characters).'));
222 } elseif (empty($homepage)) {
223 // TRANS: Form validation error show when an organisation name has not been provided in the edit application form.
224 $this->showForm(_('Organization homepage is required.'));
226 } elseif ((mb_strlen($homepage) > 0)
227 && !common_valid_http_url($homepage)) {
228 // TRANS: Validation error shown when providing an invalid homepage URL in the "Edit application" form.
229 $this->showForm(_('Homepage is not a valid URL.'));
231 } elseif (mb_strlen($callback_url) > 255) {
232 // TRANS: Validation error shown when providing too long a callback URL in the "Edit application" form.
233 $this->showForm(_('Callback is too long.'));
235 } elseif (mb_strlen($callback_url) > 0
236 && !common_valid_http_url($callback_url)) {
237 // TRANS: Validation error shown when providing an invalid callback URL in the "Edit application" form.
238 $this->showForm(_('Callback URL is not valid.'));
242 $cur = common_current_user();
244 // Checked in prepare() above
246 assert(!is_null($cur));
247 assert(!is_null($this->app));
249 $orig = clone($this->app);
251 $this->app->name = $name;
252 $this->app->description = $description;
253 $this->app->source_url = $source_url;
254 $this->app->organization = $organization;
255 $this->app->homepage = $homepage;
256 $this->app->callback_url = $callback_url;
257 $this->app->type = $type;
259 common_debug("access_type = $access_type");
261 if ($access_type == 'r') {
262 $this->app->access_type = 1;
264 $this->app->access_type = 3;
267 $result = $this->app->update($orig);
269 // Note: 0 means no rows changed, which can happen if the only
270 // thing we changed was the icon, since it's not altered until
272 if ($result === false) {
273 common_log_db_error($this->app, 'UPDATE', __FILE__);
274 // TRANS: Server error occuring when an application could not be updated from the "Edit application" form.
275 $this->serverError(_('Could not update application.'));
278 $this->app->uploadLogo();
280 common_redirect(common_local_url('oauthappssettings'), 303);
284 * Does the app name already exist?
286 * Checks the DB to see someone has already registered an app
287 * with the same name.
289 * @param string $name app name to check
291 * @return boolean true if the name already exists
293 function nameExists($name)
295 $newapp = Oauth_application::getKV('name', $name);
296 if (empty($newapp)) {
299 return $newapp->id != $this->app->id;