From f8025428854546b0528fd714f6af93a220de0bcc Mon Sep 17 00:00:00 2001
From: Zach Copley <zach@status.net>
Date: Fri, 13 Nov 2009 19:02:18 -0800
Subject: [PATCH] Reorganized the OAuth app URLs and more work on the register
app workflow
---
actions/{oauthclients.php => apps.php} | 4 +-
actions/newapplication.php | 202 ++++++++++++++++
...tings.php => oauthconnectionssettings.php} | 4 +-
lib/applicationeditform.php | 215 ++++++++++++++++++
lib/connectsettingsaction.php | 8 +-
lib/router.php | 15 +-
6 files changed, 436 insertions(+), 12 deletions(-)
rename actions/{oauthclients.php => apps.php} (96%)
create mode 100644 actions/newapplication.php
rename actions/{applicationsettings.php => oauthconnectionssettings.php} (96%)
create mode 100644 lib/applicationeditform.php
diff --git a/actions/oauthclients.php b/actions/apps.php
similarity index 96%
rename from actions/oauthclients.php
rename to actions/apps.php
index 9a29e158e1..d4cea1e3e9 100644
--- a/actions/oauthclients.php
+++ b/actions/apps.php
@@ -45,7 +45,7 @@ require_once INSTALLDIR . '/lib/connectsettingsaction.php';
* @see SettingsAction
*/
-class OauthClientsAction extends ConnectSettingsAction
+class AppsAction extends ConnectSettingsAction
{
/**
* Title of the page
@@ -55,7 +55,7 @@ class OauthClientsAction extends ConnectSettingsAction
function title()
{
- return _('Applications using %%site_name%%');
+ return _('OAuth applications');
}
/**
diff --git a/actions/newapplication.php b/actions/newapplication.php
new file mode 100644
index 0000000000..a78a856b18
--- /dev/null
+++ b/actions/newapplication.php
@@ -0,0 +1,202 @@
+<?php
+/**
+ * StatusNet, the distributed open-source microblogging tool
+ *
+ * Register a new OAuth Application
+ *
+ * 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 Applications
+ * @package StatusNet
+ * @author Zach Copley <zach@status.net>
+ * @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') && !defined('LACONICA')) {
+ exit(1);
+}
+
+/**
+ * Add a new application
+ *
+ * This is the form for adding a new application
+ *
+ * @category Application
+ * @package StatusNet
+ * @author Zach Copley <zach@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/
+ */
+
+class NewApplicationAction extends Action
+{
+ var $msg;
+
+ function title()
+ {
+ return _('New Application');
+ }
+
+ /**
+ * Prepare to run
+ */
+
+ function prepare($args)
+ {
+ parent::prepare($args);
+
+ if (!common_logged_in()) {
+ $this->clientError(_('You must be logged in to create a group.'));
+ return false;
+ }
+
+ return true;
+ }
+
+ /**
+ * Handle the request
+ *
+ * On GET, show the form. On POST, try to save the group.
+ *
+ * @param array $args unused
+ *
+ * @return void
+ */
+
+ function handle($args)
+ {
+ parent::handle($args);
+ if ($_SERVER['REQUEST_METHOD'] == 'POST') {
+ $this->trySave();
+ } else {
+ $this->showForm();
+ }
+ }
+
+ function showForm($msg=null)
+ {
+ $this->msg = $msg;
+ $this->showPage();
+ }
+
+ function showContent()
+ {
+ $form = new ApplicationEditForm($this);
+ $form->show();
+ }
+
+ function showPageNotice()
+ {
+ if ($this->msg) {
+ $this->element('p', 'error', $this->msg);
+ } else {
+ $this->element('p', 'instructions',
+ _('Use this form to register a new application.'));
+ }
+ }
+
+ function trySave()
+ {
+ $name = $this->trimmed('name');
+ $description = $this->trimmed('description');
+ $source_url = $this->trimmed('source_url');
+ $organization = $this->trimmed('organization');
+ $homepage = $this->trimmed('application');
+ $callback_url = $this->trimmed('callback_url');
+ $this->type = $this->trimmed('type');
+ $this->access_type = $this->trimmed('access_type');
+
+ if (!is_null($name) && mb_strlen($name) > 255) {
+ $this->showForm(_('Name is too long (max 255 chars).'));
+ return;
+ } else if (User_group::descriptionTooLong($description)) {
+ $this->showForm(sprintf(
+ _('description is too long (max %d chars).'),
+ Oauth_application::maxDescription()));
+ return;
+ } elseif (!is_null($source_url)
+ && (strlen($source_url) > 0)
+ && !Validate::uri(
+ $source_url,
+ array('allowed_schemes' => array('http', 'https'))
+ )
+ )
+ {
+ $this->showForm(_('Source URL is not valid.'));
+ return;
+ } elseif (!is_null($homepage)
+ && (strlen($homepage) > 0)
+ && !Validate::uri(
+ $homepage,
+ array('allowed_schemes' => array('http', 'https'))
+ )
+ )
+ {
+ $this->showForm(_('Homepage is not a valid URL.'));
+ return;
+ } elseif (!is_null($callback_url)
+ && (strlen($callback_url) > 0)
+ && !Validate::uri(
+ $source_url,
+ array('allowed_schemes' => array('http', 'https'))
+ )
+ )
+ {
+ $this->showForm(_('Callback URL is not valid.'));
+ return;
+ }
+
+ $cur = common_current_user();
+
+ // Checked in prepare() above
+
+ assert(!is_null($cur));
+
+ $app = new Oauth_application();
+
+ $app->query('BEGIN');
+
+ $app->name = $name;
+ $app->owner = $cur->id;
+ $app->description = $description;
+ $app->source_url = $souce_url;
+ $app->organization = $organization;
+ $app->homepage = $homepage;
+ $app->callback_url = $callback_url;
+ $app->type = $type;
+ $app->access_type = $access_type;
+
+ // generate consumer key and secret
+
+ $app->created = common_sql_now();
+
+ $result = $app->insert();
+
+ if (!$result) {
+ common_log_db_error($group, 'INSERT', __FILE__);
+ $this->serverError(_('Could not create application.'));
+ }
+
+ $group->query('COMMIT');
+
+ common_redirect($group->homeUrl(), 303);
+
+ }
+
+}
+
diff --git a/actions/applicationsettings.php b/actions/oauthconnectionssettings.php
similarity index 96%
rename from actions/applicationsettings.php
rename to actions/oauthconnectionssettings.php
index 16c571feee..6ec9f70273 100644
--- a/actions/applicationsettings.php
+++ b/actions/oauthconnectionssettings.php
@@ -46,7 +46,7 @@ require_once INSTALLDIR . '/lib/applicationlist.php';
* @see SettingsAction
*/
-class ApplicationSettingsAction extends ConnectSettingsAction
+class OauthconnectionssettingsAction extends ConnectSettingsAction
{
/**
* Title of the page
@@ -95,7 +95,7 @@ class ApplicationSettingsAction extends ConnectSettingsAction
}
$this->pagination($this->page > 1, $cnt > APPS_PER_PAGE,
- $this->page, 'applicationsettings',
+ $this->page, 'connectionssettings',
array('nickname' => $this->user->nickname));
}
diff --git a/lib/applicationeditform.php b/lib/applicationeditform.php
new file mode 100644
index 0000000000..3fd45876a7
--- /dev/null
+++ b/lib/applicationeditform.php
@@ -0,0 +1,215 @@
+<?php
+/**
+ * StatusNet, the distributed open-source microblogging tool
+ *
+ * Form for editing an application
+ *
+ * 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 Form
+ * @package StatusNet
+ * @author Zach Copley <zach@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') && !defined('LACONICA')) {
+ exit(1);
+}
+
+require_once INSTALLDIR . '/lib/form.php';
+
+/**
+ * Form for editing an application
+ *
+ * @category Form
+ * @package StatusNet
+ * @author Zach Copley <zach@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/
+ *
+ */
+
+class ApplicationEditForm extends Form
+{
+ /**
+ * group for user to join
+ */
+
+ var $application = null;
+
+ /**
+ * Constructor
+ *
+ * @param Action $out output channel
+ * @param User_group $group group to join
+ */
+
+ function __construct($out=null, $application=null)
+ {
+ parent::__construct($out);
+
+ $this->application = $application;
+ }
+
+ /**
+ * ID of the form
+ *
+ * @return string ID of the form
+ */
+
+ function id()
+ {
+ if ($this->application) {
+ return 'form_application_edit-' . $this->application->id;
+ } else {
+ return 'form_application_add';
+ }
+ }
+
+ /**
+ * class of the form
+ *
+ * @return string of the form class
+ */
+
+ function formClass()
+ {
+ return 'form_settings';
+ }
+
+ /**
+ * Action of the form
+ *
+ * @return string URL of the action
+ */
+
+ function action()
+ {
+ if ($this->application) {
+ return common_local_url('editapplication',
+ array('id' => $this->application->id));
+ } else {
+ return common_local_url('newapplication');
+ }
+ }
+
+ /**
+ * Name of the form
+ *
+ * @return void
+ */
+
+ function formLegend()
+ {
+ $this->out->element('legend', null, _('Register a new application'));
+ }
+
+ /**
+ * Data elements of the form
+ *
+ * @return void
+ */
+
+ function formData()
+ {
+ if ($this->application) {
+ $id = $this->application->id;
+ $name = $this->application->name;
+ $description = $this->application->description;
+ $source_url = $this->application->source_url;
+ $organization = $this->application->organization;
+ $homepage = $this->application->homepage;
+ $callback_url = $this->application->callback_url;
+ $this->type = $this->application->type;
+ $this->access_type = $this->application->access_type;
+ } else {
+ $id = '';
+ $name = '';
+ $description = '';
+ $source_url = '';
+ $organization = '';
+ $homepage = '';
+ $callback_url = '';
+ $this->type = '';
+ $this->access_type = '';
+ }
+
+ $this->out->elementStart('ul', 'form_data');
+ $this->out->elementStart('li');
+
+ $this->out->hidden('application_id', $id);
+ $this->out->input('name', _('Name'),
+ ($this->out->arg('name')) ? $this->out->arg('name') : $name);
+
+ $this->out->elementEnd('li');
+
+ $this->out->elementStart('li');
+ $this->out->input('description', _('Description'),
+ ($this->out->arg('Description')) ? $this->out->arg('discription') : $description);
+ $this->out->elementEnd('li');
+
+ $this->out->elementStart('li');
+ $this->out->input('source_url', _('Source URL'),
+ ($this->out->arg('source_url')) ? $this->out->arg('source_url') : $source_url,
+ _('URL of the homepage of this application'));
+ $this->out->elementEnd('li');
+
+ $this->out->elementStart('li');
+ $this->out->input('Organization', _('Organization'),
+ ($this->out->arg('organization')) ? $this->out->arg('organization') : $orgranization,
+ _('Organization responsible for this application'));
+ $this->out->elementEnd('li');
+
+ $this->out->elementStart('li');
+ $this->out->input('homepage', _('Homepage'),
+ ($this->out->arg('homepage')) ? $this->out->arg('homepage') : $homepage,
+ _('URL of the homepage of the organization'));
+ $this->out->elementEnd('li');
+
+ $this->out->elementStart('li');
+ $this->out->input('callback_url', ('Callback URL'),
+ ($this->out->arg('callback_url')) ? $this->out->arg('callback_url') : $callback_url,
+ _('URL to redirect to after authentication'));
+ $this->out->elementEnd('li');
+
+ $this->out->elementStart('li');
+ $this->out->input('type', _('Application type'),
+ ($this->out->arg('type')) ? $this->out->arg('type') : $type,
+ _('Type of application, browser or desktop'));
+ $this->out->elementEnd('li');
+
+ $this->out->elementStart('li');
+ $this->out->input('access_type', _('Default access'),
+ ($this->out->arg('access_type')) ? $this->out->arg('access_type') : $access_type,
+ _('Default access for this application: read-write, or read-only'));
+ $this->out->elementEnd('li');
+
+ $this->out->elementEnd('ul');
+ }
+
+ /**
+ * Action elements
+ *
+ * @return void
+ */
+
+ function formActions()
+ {
+ $this->out->submit('submit', _('Save'));
+ }
+}
diff --git a/lib/connectsettingsaction.php b/lib/connectsettingsaction.php
index 4b5059540d..b9c14799e0 100644
--- a/lib/connectsettingsaction.php
+++ b/lib/connectsettingsaction.php
@@ -115,9 +115,11 @@ class ConnectSettingsNav extends Widget
array(_('SMS'),
_('Updates by SMS'));
}
-
- $menu['applicationsettings'] = array(_('Applications'),
- _('OAuth connected applications'));
+
+ $menu['oauthconnectionssettings'] = array(
+ _('Connections'),
+ _('Authorized connected applications')
+ );
foreach ($menu as $menuaction => $menudesc) {
$this->action->menuItem(common_local_url($menuaction),
diff --git a/lib/router.php b/lib/router.php
index 9b2aa025ef..7b65ae215c 100644
--- a/lib/router.php
+++ b/lib/router.php
@@ -140,13 +140,11 @@ class Router
// settings
- foreach (array('profile', 'avatar', 'password', 'im', 'application',
+ foreach (array('profile', 'avatar', 'password', 'im', 'oauthconnections',
'email', 'sms', 'userdesign', 'other') as $s) {
$m->connect('settings/'.$s, array('action' => $s.'settings'));
}
-
- $m->connect('settings/oauthclients', array('action' => 'oauthclients'));
-
+
// search
foreach (array('group', 'people', 'notice') as $s) {
@@ -636,12 +634,19 @@ class Router
// user stuff
foreach (array('subscriptions', 'subscribers',
- 'nudge', 'all', 'foaf', 'xrds',
+ 'nudge', 'all', 'foaf', 'xrds', 'apps',
'replies', 'inbox', 'outbox', 'microsummary') as $a) {
$m->connect(':nickname/'.$a,
array('action' => $a),
array('nickname' => '[a-zA-Z0-9]{1,64}'));
}
+
+ $m->connect('apps/new', array('action' => 'newapplication'));
+
+ $m->connect(':nickname/apps/edit',
+ array('action' => 'editapplication'),
+ array('nickname' => '['.NICKNAME_FMT.']{1,64}')
+ );
foreach (array('subscriptions', 'subscribers') as $a) {
$m->connect(':nickname/'.$a.'/:tag',
--
2.39.5