3 * StatusNet, the distributed open-source microblogging tool
5 * Register a new 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 * @copyright 2013 Free Software Foundation, Inc.
27 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
28 * @link http://status.net/
31 if (!defined('GNUSOCIAL')) { exit(1); }
34 * Add a new application
36 * This is the form for adding a new application
38 * @category Application
40 * @author Zach Copley <zach@status.net>
41 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
42 * @link http://status.net/
44 class NewApplicationAction extends FormAction
48 // TRANS: This is the title of the form for adding a new application.
49 return _('New application');
52 protected function doPost()
54 if ($this->arg('cancel')) {
55 common_redirect(common_local_url('oauthappssettings'), 303);
56 } elseif ($this->arg('save')) {
60 // TRANS: Client error displayed when encountering an unexpected action on form submission.
61 $this->clientError(_('Unexpected form submission.'));
64 protected function getForm()
66 return new ApplicationEditForm($this);
69 protected function getInstructions()
71 // TRANS: Form instructions for registering a new application.
72 return _('Use this form to register a new application.');
75 private function trySave()
77 $name = $this->trimmed('name');
78 $description = $this->trimmed('description');
79 $source_url = $this->trimmed('source_url');
80 $organization = $this->trimmed('organization');
81 $homepage = $this->trimmed('homepage');
82 $callback_url = $this->trimmed('callback_url');
83 $type = $this->arg('app_type');
84 $access_type = $this->arg('default_access_type');
87 // TRANS: Validation error shown when not providing a name in the "New application" form.
88 $this->clientError(_('Name is required.'));
89 } else if ($this->nameExists($name)) {
90 // TRANS: Validation error shown when providing a name for an application that already exists in the "New application" form.
91 $this->clientError(_('Name already in use. Try another one.'));
92 } elseif (mb_strlen($name) > 255) {
93 // TRANS: Validation error shown when providing too long a name in the "New application" form.
94 $this->clientError(_('Name is too long (maximum 255 characters).'));
95 } elseif (empty($description)) {
96 // TRANS: Validation error shown when not providing a description in the "New application" form.
97 $this->clientError(_('Description is required.'));
98 } elseif (Oauth_application::descriptionTooLong($description)) {
99 $this->clientError(sprintf(
100 // TRANS: Form validation error in New application form.
101 // TRANS: %d is the maximum number of characters for the description.
102 _m('Description is too long (maximum %d character).',
103 'Description is too long (maximum %d characters).',
104 Oauth_application::maxDesc()),
105 Oauth_application::maxDesc()));
106 } elseif (empty($source_url)) {
107 // TRANS: Validation error shown when not providing a source URL in the "New application" form.
108 $this->clientError(_('Source URL is required.'));
109 } elseif ((strlen($source_url) > 0) && !common_valid_http_url($source_url)) {
110 // TRANS: Validation error shown when providing an invalid source URL in the "New application" form.
111 $this->clientError(_('Source URL is not valid.'));
112 } elseif (empty($organization)) {
113 // TRANS: Validation error shown when not providing an organisation in the "New application" form.
114 $this->clientError(_('Organization is required.'));
115 } elseif (mb_strlen($organization) > 255) {
116 // TRANS: Validation error shown when providing too long an arganisation name in the "Edit application" form.
117 $this->clientError(_('Organization is too long (maximum 255 characters).'));
118 } elseif (empty($homepage)) {
119 // TRANS: Form validation error show when an organisation name has not been provided in the new application form.
120 $this->clientError(_('Organization homepage is required.'));
121 } elseif ((strlen($homepage) > 0) && !common_valid_http_url($homepage)) {
122 // TRANS: Validation error shown when providing an invalid homepage URL in the "New application" form.
123 $this->clientError(_('Homepage is not a valid URL.'));
124 } elseif (mb_strlen($callback_url) > 255) {
125 // TRANS: Validation error shown when providing too long a callback URL in the "New application" form.
126 $this->clientError(_('Callback is too long.'));
127 } elseif (strlen($callback_url) > 0 && !common_valid_http_url($callback_url)) {
128 // TRANS: Validation error shown when providing an invalid callback URL in the "New application" form.
129 $this->clientError(_('Callback URL is not valid.'));
132 // Login is checked in parent::prepare()
133 assert(!is_null($this->scoped));
135 $app = new Oauth_application();
137 $app->query('BEGIN');
140 $app->owner = $this->scoped->id;
141 $app->description = $description;
142 $app->source_url = $source_url;
143 $app->organization = $organization;
144 $app->homepage = $homepage;
145 $app->callback_url = $callback_url;
148 // Yeah, I dunno why I chose bit flags. I guess so I could
149 // copy this value directly to Oauth_application_user
150 // access_type which I think does need bit flags -- Z
152 if ($access_type == 'r') {
153 $app->setAccessFlags(true, false);
155 $app->setAccessFlags(true, true);
158 $app->created = common_sql_now();
160 // generate consumer key and secret
162 $consumer = Consumer::generateNew();
164 $result = $consumer->insert();
167 common_log_db_error($consumer, 'INSERT', __FILE__);
168 $app->query('ROLLBACK');
169 // TRANS: Server error displayed when an application could not be registered in the database through the "New application" form.
170 $this->serverError(_('Could not create application.'));
173 $app->consumer_key = $consumer->consumer_key;
175 $this->app_id = $app->insert();
177 if (!$this->app_id) {
178 common_log_db_error($app, 'INSERT', __FILE__);
179 $app->query('ROLLBACK');
180 // TRANS: Server error displayed when an application could not be registered in the database through the "New application" form.
181 $this->serverError(_('Could not create application.'));
186 } catch (Exception $e) {
187 $app->query('ROLLBACK');
188 // TRANS: Form validation error messages displayed when uploading an invalid application logo.
189 $this->clientError(_('Invalid image.'));
192 $app->query('COMMIT');
194 common_redirect(common_local_url('oauthappssettings'), 303);
198 * Does the app name already exist?
200 * Checks the DB to see someone has already registered an app
201 * with the same name.
203 * @param string $name app name to check
205 * @return boolean true if the name already exists
207 function nameExists($name)
209 $app = Oauth_application::getKV('name', $name);