<?php
-/*
- * Laconica - a distributed open-source microblogging tool
- * Copyright (C) 2008, Controlez-Vous, Inc.
+/**
+ * StatusNet, the distributed open-source microblogging tool
*
- * This program is free software: you can redistribute it and/or modify
+ * Settings for Twitter integration
+ *
+ * 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.
*
* 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 Settings
+ * @package StatusNet
+ * @author Evan Prodromou <evan@controlyourself.ca>
+ * @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://laconi.ca/
*/
-if (!defined('LACONICA')) { exit(1); }
+if (!defined('LACONICA')) {
+ exit(1);
+}
-require_once(INSTALLDIR.'/lib/settingsaction.php');
+require_once INSTALLDIR.'/lib/connectsettingsaction.php';
+require_once INSTALLDIR.'/lib/twitter.php';
-define('SUBSCRIPTIONS', 80);
+/**
+ * Settings for Twitter integration
+ *
+ * @category Settings
+ * @package StatusNet
+ * @author Evan Prodromou <evan@controlyourself.ca>
+ * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
+ * @link http://laconi.ca/
+ *
+ * @see SettingsAction
+ */
-class TwittersettingsAction extends SettingsAction
+class TwittersettingsAction extends ConnectSettingsAction
{
+ /**
+ * Title of the page
+ *
+ * @return string Title of the page
+ */
- function get_instructions()
+ function title()
{
- return _('Add your Twitter account to automatically send your notices to Twitter, ' .
- 'and subscribe to Twitter friends already here.');
+ return _('Twitter settings');
}
- function show_form($msg=null, $success=false)
- {
- $user = common_current_user();
- $profile = $user->getProfile();
- $fuser = null;
- $flink = Foreign_link::getByUserID($user->id, 1); // 1 == Twitter
-
- if ($flink) {
- $fuser = $flink->getForeignUser();
- }
-
- $this->form_header(_('Twitter settings'), $msg, $success);
- $this->elementStart('form', array('method' => 'post',
- 'id' => 'twittersettings',
- 'action' =>
- common_local_url('twittersettings')));
- $this->hidden('token', common_session_token());
-
- $this->element('h2', null, _('Twitter Account'));
-
- if ($fuser) {
- $this->elementStart('p');
-
- $this->element('span', 'twitter_user', $fuser->nickname);
- $this->element('a', array('href' => $fuser->uri), $fuser->uri);
- $this->element('span', 'input_instructions',
- _('Current verified Twitter account.'));
- $this->hidden('flink_foreign_id', $flink->foreign_id);
- $this->elementEnd('p');
- $this->submit('remove', _('Remove'));
- } else {
- $this->input('twitter_username', _('Twitter user name'),
- ($this->arg('twitter_username')) ? $this->arg('twitter_username') : $profile->nickname,
- _('No spaces, please.')); // hey, it's what Twitter says
-
- $this->password('twitter_password', _('Twitter password'));
- }
-
- $this->element('h2', null, _('Preferences'));
-
- $this->checkbox('noticesync', _('Automatically send my notices to Twitter.'),
- ($flink) ? ($flink->noticesync & FOREIGN_NOTICE_SEND) : true);
-
- $this->checkbox('replysync', _('Send local "@" replies to Twitter.'),
- ($flink) ? ($flink->noticesync & FOREIGN_NOTICE_SEND_REPLY) : true);
-
- $this->checkbox('friendsync', _('Subscribe to my Twitter friends here.'),
- ($flink) ? ($flink->friendsync & FOREIGN_FRIEND_RECV) : false);
-
- if ($flink) {
- $this->submit('save', _('Save'));
- } else {
- $this->submit('add', _('Add'));
- }
+ /**
+ * Instructions for use
+ *
+ * @return instructions for use
+ */
- $this->show_twitter_subscriptions();
-
- $this->elementEnd('form');
-
- common_show_footer();
- }
-
- function subscribed_twitter_users()
+ function getInstructions()
{
+ return _('Connect your Twitter account to share your updates ' .
+ 'with your Twitter friends and vice-versa.');
+ }
- $current_user = common_current_user();
+ /**
+ * Content area of the page
+ *
+ * Shows a form for associating a Twitter account with this
+ * StatusNet account. Also lets the user set preferences.
+ *
+ * @return void
+ */
- $qry = 'SELECT user.* ' .
- 'FROM subscription ' .
- 'JOIN user ON subscription.subscribed = user.id ' .
- 'JOIN foreign_link ON foreign_link.user_id = user.id ' .
- 'WHERE subscriber = %d ' .
- 'ORDER BY user.nickname';
+ function showContent()
+ {
+ if (!common_config('twitter', 'enabled')) {
+ $this->element('div', array('class' => 'error'),
+ _('Twitter is not available.'));
+ return;
+ }
- $user = new User();
+ $user = common_current_user();
- $user->query(sprintf($qry, $current_user->id));
+ $profile = $user->getProfile();
- $users = array();
+ $fuser = null;
- while ($user->fetch()) {
+ $flink = Foreign_link::getByUserID($user->id, TWITTER_SERVICE);
- // Don't include the user's own self-subscription
- if ($user->id != $current_user->id) {
- $users[] = clone($user);
- }
+ if (!empty($flink)) {
+ $fuser = $flink->getForeignUser();
}
- return $users;
- }
-
- function show_twitter_subscriptions()
- {
-
- $friends = $this->subscribed_twitter_users();
- $friends_count = count($friends);
+ $this->elementStart('form', array('method' => 'post',
+ 'id' => 'form_settings_twitter',
+ 'class' => 'form_settings',
+ 'action' =>
+ common_local_url('twittersettings')));
- if ($friends_count > 0) {
+ $this->hidden('token', common_session_token());
- $this->element('h3', null, _('Twitter Friends'));
- $this->elementStart('div', array('id' => 'subscriptions'));
- $this->elementStart('ul', array('id' => 'subscriptions_avatars'));
+ $this->elementStart('fieldset', array('id' => 'settings_twitter_account'));
- for ($i = 0; $i < min($friends_count, SUBSCRIPTIONS); $i++) {
+ if (empty($fuser)) {
+ $this->elementStart('ul', 'form_data');
+ $this->elementStart('li', array('id' => 'settings_twitter_login_button'));
+ $this->element('a', array('href' => common_local_url('twitterauthorization')),
+ 'Connect my Twitter account');
+ $this->elementEnd('li');
+ $this->elementEnd('ul');
- $other = Profile::staticGet($friends[$i]->id);
+ $this->elementEnd('fieldset');
+ } else {
+ $this->element('legend', null, _('Twitter account'));
+ $this->elementStart('p', array('id' => 'form_confirmed'));
+ $this->element('a', array('href' => $fuser->uri), $fuser->nickname);
+ $this->elementEnd('p');
+ $this->element('p', 'form_note',
+ _('Connected Twitter account'));
- if (!$other) {
- common_log_db_error($subs, 'SELECT', __FILE__);
- continue;
- }
+ $this->submit('remove', _('Remove'));
+ $this->elementEnd('fieldset');
+
+ $this->elementStart('fieldset', array('id' => 'settings_twitter_preferences'));
+
+ $this->element('legend', null, _('Preferences'));
+ $this->elementStart('ul', 'form_data');
+ $this->elementStart('li');
+ $this->checkbox('noticesend',
+ _('Automatically send my notices to Twitter.'),
+ ($flink) ?
+ ($flink->noticesync & FOREIGN_NOTICE_SEND) :
+ true);
+ $this->elementEnd('li');
+ $this->elementStart('li');
+ $this->checkbox('replysync',
+ _('Send local "@" replies to Twitter.'),
+ ($flink) ?
+ ($flink->noticesync & FOREIGN_NOTICE_SEND_REPLY) :
+ true);
+ $this->elementEnd('li');
+ $this->elementStart('li');
+ $this->checkbox('friendsync',
+ _('Subscribe to my Twitter friends here.'),
+ ($flink) ?
+ ($flink->friendsync & FOREIGN_FRIEND_RECV) :
+ false);
+ $this->elementEnd('li');
+
+ if (common_config('twitterbridge','enabled')) {
$this->elementStart('li');
- $this->elementStart('a', array('title' => ($other->fullname) ?
- $other->fullname :
- $other->nickname,
- 'href' => $other->profileurl,
- 'rel' => 'contact',
- 'class' => 'subscription'));
- $avatar = $other->getAvatar(AVATAR_MINI_SIZE);
- $this->element('img', array('src' => (($avatar) ? common_avatar_display_url($avatar) : common_default_avatar(AVATAR_MINI_SIZE)),
- 'width' => AVATAR_MINI_SIZE,
- 'height' => AVATAR_MINI_SIZE,
- 'class' => 'avatar mini',
- 'alt' => ($other->fullname) ?
- $other->fullname :
- $other->nickname));
- $this->elementEnd('a');
+ $this->checkbox('noticerecv',
+ _('Import my Friends Timeline.'),
+ ($flink) ?
+ ($flink->noticesync & FOREIGN_NOTICE_RECV) :
+ false);
$this->elementEnd('li');
+ // preserve setting even if bidrection bridge toggled off
+
+ if ($flink && ($flink->noticesync & FOREIGN_NOTICE_RECV)) {
+ $this->hidden('noticerecv', true, 'noticerecv');
+ }
}
$this->elementEnd('ul');
- $this->elementEnd('div');
-
- }
-
- // XXX Figure out a way to show all Twitter friends... ?
- /*
- if ($subs_count > SUBSCRIPTIONS) {
- $this->elementStart('p', array('id' => 'subscriptions_viewall'));
+ if ($flink) {
+ $this->submit('save', _('Save'));
+ } else {
+ $this->submit('add', _('Add'));
+ }
- $this->element('a', array('href' => common_local_url('subscriptions',
- array('nickname' => $profile->nickname)),
- 'class' => 'moresubscriptions'),
- _('All subscriptions'));
- $this->elementEnd('p');
+ $this->elementEnd('fieldset');
}
- */
+ $this->elementEnd('form');
}
- function handle_post()
+ /**
+ * Handle posts to this form
+ *
+ * Based on the button that was pressed, muxes out to other functions
+ * to do the actual task requested.
+ *
+ * All sub-functions reload the form with a message -- success or failure.
+ *
+ * @return void
+ */
+
+ function handlePost()
{
-
- # CSRF protection
+ // CSRF protection
$token = $this->trimmed('token');
if (!$token || $token != common_session_token()) {
- $this->show_form(_('There was a problem with your session token. Try again, please.'));
+ $this->showForm(_('There was a problem with your session token. '.
+ 'Try again, please.'));
return;
}
if ($this->arg('save')) {
- $this->save_preferences();
- } else if ($this->arg('add')) {
- $this->add_twitter_acct();
+ $this->savePreferences();
} else if ($this->arg('remove')) {
- $this->remove_twitter_acct();
+ $this->removeTwitterAccount();
} else {
- $this->show_form(_('Unexpected form submission.'));
+ $this->showForm(_('Unexpected form submission.'));
}
}
- function add_twitter_acct()
- {
-
- $screen_name = $this->trimmed('twitter_username');
- $password = $this->trimmed('twitter_password');
- $noticesync = $this->boolean('noticesync');
- $replysync = $this->boolean('replysync');
- $friendsync = $this->boolean('friendsync');
-
- if (!Validate::string($screen_name,
- array( 'min_length' => 1,
- 'max_length' => 15,
- 'format' => VALIDATE_NUM . VALIDATE_ALPHA . '_'))) {
- $this->show_form(
- _('Username must have only numbers, upper- and lowercase letters, and underscore (_). 15 chars max.'));
- return;
- }
-
- if (!$this->verify_credentials($screen_name, $password)) {
- $this->show_form(_('Could not verify your Twitter credentials!'));
- return;
- }
-
- $twit_user = twitter_user_info($screen_name, $password);
-
- if (!$twit_user) {
- $this->show_form(sprintf(_('Unable to retrieve account information for "%s" from Twitter.'),
- $screen_name));
- return;
- }
-
- if (!save_twitter_user($twit_user->id, $screen_name)) {
- $this->show_form(_('Unable to save your Twitter settings!'));
- return;
- }
-
- $user = common_current_user();
-
- $flink = DB_DataObject::factory('foreign_link');
- $flink->user_id = $user->id;
- $flink->foreign_id = $twit_user->id;
- $flink->service = 1; // Twitter
- $flink->credentials = $password;
- $flink->created = common_sql_now();
-
- $flink->set_flags($noticesync, $replysync, $friendsync);
-
- $flink_id = $flink->insert();
-
- if (!$flink_id) {
- common_log_db_error($flink, 'INSERT', __FILE__);
- $this->show_form(_('Unable to save your Twitter settings!'));
- return;
- }
-
- if ($friendsync) {
- save_twitter_friends($user, $twit_user->id, $screen_name, $password);
- }
-
- $this->show_form(_('Twitter settings saved.'), true);
- }
+ /**
+ * Disassociate an existing Twitter account from this account
+ *
+ * @return void
+ */
- function remove_twitter_acct()
+ function removeTwitterAccount()
{
-
$user = common_current_user();
- $flink = Foreign_link::getByUserID($user->id, 1);
- $flink_foreign_id = $this->arg('flink_foreign_id');
-
- # Maybe an old tab open...?
- if ($flink->foreign_id != $flink_foreign_id) {
- $this->show_form(_('That is not your Twitter account.'));
- return;
- }
+ $flink = Foreign_link::getByUserID($user->id, TWITTER_SERVICE);
$result = $flink->delete();
- if (!$result) {
+ if (empty($result)) {
common_log_db_error($flink, 'DELETE', __FILE__);
- common_server_error(_('Couldn\'t remove Twitter user.'));
+ $this->serverError(_('Couldn\'t remove Twitter user.'));
return;
}
- $this->show_form(_('Twitter account removed.'), true);
+ $this->showForm(_('Twitter account removed.'), true);
}
- function save_preferences()
- {
+ /**
+ * Save user's Twitter-bridging preferences
+ *
+ * @return void
+ */
- $noticesync = $this->boolean('noticesync');
+ function savePreferences()
+ {
+ $noticesend = $this->boolean('noticesend');
+ $noticerecv = $this->boolean('noticerecv');
$friendsync = $this->boolean('friendsync');
- $replysync = $this->boolean('replysync');
+ $replysync = $this->boolean('replysync');
$user = common_current_user();
+ $flink = Foreign_link::getByUserID($user->id, TWITTER_SERVICE);
- $flink = Foreign_link::getByUserID($user->id, 1);
-
- if (!$flink) {
+ if (empty($flink)) {
common_log_db_error($flink, 'SELECT', __FILE__);
- $this->show_form(_('Couldn\'t save Twitter preferences.'));
+ $this->showForm(_('Couldn\'t save Twitter preferences.'));
return;
}
- $twitter_id = $flink->foreign_id;
- $password = $flink->credentials;
-
- $fuser = $flink->getForeignUser();
-
- if (!$fuser) {
- common_log_db_error($fuser, 'SELECT', __FILE__);
- $this->show_form(_('Couldn\'t save Twitter preferences.'));
- return;
- }
-
- $screen_name = $fuser->nickname;
-
$original = clone($flink);
- $flink->set_flags($noticesync, $replysync, $friendsync);
+ $flink->set_flags($noticesend, $noticerecv, $replysync, $friendsync);
$result = $flink->update($original);
if ($result === false) {
common_log_db_error($flink, 'UPDATE', __FILE__);
- $this->show_form(_('Couldn\'t save Twitter preferences.'));
+ $this->showForm(_('Couldn\'t save Twitter preferences.'));
return;
}
- if ($friendsync) {
- save_twitter_friends($user, $flink->foreign_id, $screen_name, $password);
- }
-
- $this->show_form(_('Twitter preferences saved.'), true);
+ $this->showForm(_('Twitter preferences saved.'), true);
}
- function verify_credentials($screen_name, $password)
- {
- $uri = 'http://twitter.com/account/verify_credentials.json';
- $data = get_twitter_data($uri, $screen_name, $password);
-
- if (!$data) {
- return false;
- }
-
- $user = json_decode($data);
-
- if (!$user) {
- return false;
- }
-
- $twitter_id = $user->status->id;
-
- if ($twitter_id) {
- return $twitter_id;
- }
-
- return false;
- }
-
-
-}
\ No newline at end of file
+}