* @link http://status.net/
*/
-if (!defined('STATUSNET')) {
- exit(1);
-}
+if (!defined('GNUSOCIAL')) { exit(1); }
-require_once INSTALLDIR . '/plugins/TwitterBridge/twitter.php';
+require_once __DIR__ . '/twitter.php';
/**
* Plugin for sending and importing Twitter statuses
*
* This class allows users to link their Twitter accounts
*
+ * Depends on Favorite plugin.
+ *
* @category Plugin
* @package StatusNet
* @author Zach Copley <zach@status.net>
* @link http://status.net/
* @link http://twitter.com/
*/
-
class TwitterBridgePlugin extends Plugin
{
-
- const VERSION = STATUSNET_VERSION;
+ const VERSION = GNUSOCIAL_VERSION;
public $adminImportControl = false; // Should the 'import' checkbox be exposed in the admin panel?
/**
* Initializer for the plugin.
*/
-
function initialize()
{
// Allow the key and secret to be passed in
*
* @return boolean result
*/
-
static function hasKeys()
{
$ckey = common_config('twitter', 'consumer_key');
*
* Hook for RouterInitialized event.
*
- * @param Net_URL_Mapper $m path-to-action mapper
+ * @param URLMapper $m path-to-action mapper
*
* @return boolean hook return
*/
-
- function onRouterInitialized($m)
+ public function onRouterInitialized(URLMapper $m)
{
- $m->connect('admin/twitter', array('action' => 'twitteradminpanel'));
+ $m->connect('panel/twitter', array('action' => 'twitteradminpanel'));
if (self::hasKeys()) {
$m->connect(
/*
* Add a login tab for 'Sign in with Twitter'
*
- * @param Action &action the current action
+ * @param Action $action the current action
*
* @return void
*/
- function onEndLoginGroupNav(&$action)
+ function onEndLoginGroupNav($action)
{
$action_name = $action->trimmed('action');
if (self::hasKeys() && common_config('twitter', 'signin')) {
$action->menuItem(
common_local_url('twitterlogin'),
- _m('Twitter'),
- _m('Login or register using Twitter'),
+ // TRANS: Menu item in login navigation.
+ _m('MENU','Twitter'),
+ // TRANS: Title for menu item in login navigation.
+ _m('Login or register using Twitter.'),
'twitterlogin' === $action_name
);
}
/**
* Add the Twitter Settings page to the Connect Settings menu
*
- * @param Action &$action The calling page
+ * @param Action $action The calling page
*
* @return boolean hook return
*/
- function onEndConnectSettingsNav(&$action)
+ function onEndConnectSettingsNav($action)
{
if (self::hasKeys()) {
$action_name = $action->trimmed('action');
$action->menuItem(
common_local_url('twittersettings'),
- _m('Twitter'),
+ // TRANS: Menu item in connection settings navigation.
+ _m('MENU','Twitter'),
+ // TRANS: Title for menu item in connection settings navigation.
_m('Twitter integration options'),
$action_name === 'twittersettings'
);
return true;
}
- /**
- * Automatically load the actions and libraries used by the Twitter bridge
- *
- * @param Class $cls the class
- *
- * @return boolean hook return
- *
- */
- function onAutoload($cls)
- {
- $dir = dirname(__FILE__);
-
- switch ($cls) {
- case 'TwittersettingsAction':
- case 'TwitterauthorizationAction':
- case 'TwitterloginAction':
- case 'TwitteradminpanelAction':
- include_once $dir . '/' . strtolower(mb_substr($cls, 0, -6)) . '.php';
- return false;
- case 'TwitterOAuthClient':
- case 'TwitterQueueHandler':
- include_once $dir . '/' . strtolower($cls) . '.php';
- return false;
- case 'Notice_to_status':
- include_once $dir . '/' . $cls . '.php';
- return false;
- default:
- return true;
- }
- }
-
/**
* Add a Twitter queue item for each notice
*
*/
function onStartEnqueueNotice($notice, &$transports)
{
- if (self::hasKeys() && $notice->isLocal()) {
+ if (self::hasKeys() && $notice->isLocal() && $notice->inScope(null)) {
// Avoid a possible loop
if ($notice->source != 'twitter') {
array_push($transports, 'twitter');
*
* @return boolean hook return
*/
- function onGetValidDaemons($daemons)
+ function onGetValidDaemons(&$daemons)
{
if (self::hasKeys()) {
array_push(
function onEndInitializeQueueManager($manager)
{
if (self::hasKeys()) {
+ // Outgoing notices -> twitter
$manager->connect('twitter', 'TwitterQueueHandler');
+
+ // Incoming statuses <- twitter
+ $manager->connect('tweetin', 'TweetInQueueHandler');
+ }
+ return true;
+ }
+
+ /**
+ * If the plugin's installed, this should be accessible to admins
+ */
+ function onAdminPanelCheck($name, &$isOK)
+ {
+ if ($name == 'twitter') {
+ $isOK = true;
+ return false;
}
return true;
}
$nav->out->menuItem(
common_local_url('twitteradminpanel'),
+ // TRANS: Menu item in administrative panel that leads to the Twitter bridge configuration.
_m('Twitter'),
- _m('Twitter bridge configuration'),
+ // TRANS: Menu item title in administrative panel that leads to the Twitter bridge configuration.
+ _m('Twitter bridge configuration page.'),
$action_name == 'twitteradminpanel',
'nav_twitter_admin_panel'
);
*
* @return boolean hook value
*/
-
- function onPluginVersion(&$versions)
+ function onPluginVersion(array &$versions)
{
$versions[] = array(
'name' => 'TwitterBridge',
'version' => self::VERSION,
- 'author' => 'Zach Copley, Julien C',
+ 'author' => 'Zach Copley, Julien C, Jean Baptiste Favre',
'homepage' => 'http://status.net/wiki/Plugin:TwitterBridge',
- 'rawdescription' => _m(
- 'The Twitter "bridge" plugin allows you to integrate ' .
- 'your StatusNet instance with ' .
+ // TRANS: Plugin description.
+ 'rawdescription' => _m('The Twitter "bridge" plugin allows integration ' .
+ 'of a StatusNet instance with ' .
'<a href="http://twitter.com/">Twitter</a>.'
)
);
*
* @return boolean hook value; true means continue processing, false means stop.
*/
-
function onCheckSchema()
{
$schema = Schema::get();
+ // For saving the last-synched status of various timelines
+ // home_timeline, messages (in), messages (out), ...
+ $schema->ensureTable('twitter_synch_status', Twitter_synch_status::schemaDef());
+
// For storing user-submitted flags on profiles
+ $schema->ensureTable('notice_to_status', Notice_to_status::schemaDef());
- $schema->ensureTable('notice_to_status',
- array(new ColumnDef('notice_id', 'integer', null,
- false, 'PRI'),
- new ColumnDef('status_id', 'integer', null,
- false, 'UNI'),
- new ColumnDef('created', 'datetime', null,
- false)));
+ return true;
+ }
- // We update any notices that may have come in from
- // Twitter that we don't have a status_id for. Note that
- // this won't catch notices that originated at this StatusNet site.
+ /**
+ * If a notice gets deleted, remove the Notice_to_status mapping and
+ * delete the status on Twitter.
+ *
+ * @param User $user The user doing the deleting
+ * @param Notice $notice The notice getting deleted
+ *
+ * @return boolean hook value
+ */
+ function onStartDeleteOwnNotice(User $user, Notice $notice)
+ {
+ $n2s = Notice_to_status::getKV('notice_id', $notice->id);
- $n = new Notice();
+ if ($n2s instanceof Notice_to_status) {
- $n->query('SELECT notice.id, notice.uri ' .
- 'FROM notice LEFT JOIN notice_to_status ' .
- 'ON notice.id = notice_to_status.notice_id ' .
- 'WHERE notice.source = "twitter"' .
- 'AND notice_to_status.status_id = NULL');
+ try {
+ $flink = Foreign_link::getByUserID($notice->profile_id, TWITTER_SERVICE); // twitter service
+ } catch (NoResultException $e) {
+ return true;
+ }
- while ($n->fetch()) {
- if (preg_match('#^http://twitter.com/[\w_.]+/status/(\d+)$#', $n->uri, $match)) {
+ if (!TwitterOAuthClient::isPackedToken($flink->credentials)) {
+ $this->log(LOG_INFO, "Skipping deleting notice for {$notice->id} since link is not OAuth.");
+ return true;
+ }
- $status_id = $match[1];
+ try {
+ $token = TwitterOAuthClient::unpackToken($flink->credentials);
+ $client = new TwitterOAuthClient($token->key, $token->secret);
- Notice_to_status::saveNew($n->id, $status_id);
+ $client->statusesDestroy($n2s->status_id);
+ } catch (Exception $e) {
+ common_log(LOG_ERR, "Error attempting to delete bridged notice from Twitter: " . $e->getMessage());
}
+
+ $n2s->delete();
+ }
+ return true;
+ }
+
+ /**
+ * Notify remote users when their notices get favorited.
+ *
+ * @param Profile or User $profile of local user doing the faving
+ * @param Notice $notice being favored
+ * @return hook return value
+ */
+ function onEndFavorNotice(Profile $profile, Notice $notice)
+ {
+ try {
+ $flink = Foreign_link::getByUserID($profile->getID(), TWITTER_SERVICE); // twitter service
+ } catch (NoResultException $e) {
+ return true;
+ }
+
+ if (!TwitterOAuthClient::isPackedToken($flink->credentials)) {
+ $this->log(LOG_INFO, "Skipping fave processing for {$profile->getID()} since link is not OAuth.");
+ return true;
+ }
+
+ $status_id = twitter_status_id($notice);
+
+ if (empty($status_id)) {
+ return true;
+ }
+
+ try {
+ $token = TwitterOAuthClient::unpackToken($flink->credentials);
+ $client = new TwitterOAuthClient($token->key, $token->secret);
+
+ $client->favoritesCreate($status_id);
+ } catch (Exception $e) {
+ common_log(LOG_ERR, "Error attempting to favorite bridged notice on Twitter: " . $e->getMessage());
+ }
+
+ return true;
+ }
+
+ /**
+ * Notify remote users when their notices get de-favorited.
+ *
+ * @param Profile $profile Profile person doing the de-faving
+ * @param Notice $notice Notice being favored
+ *
+ * @return hook return value
+ */
+ function onEndDisfavorNotice(Profile $profile, Notice $notice)
+ {
+ try {
+ $flink = Foreign_link::getByUserID($profile->getID(), TWITTER_SERVICE); // twitter service
+ } catch (NoResultException $e) {
+ return true;
+ }
+
+ if (!TwitterOAuthClient::isPackedToken($flink->credentials)) {
+ $this->log(LOG_INFO, "Skipping fave processing for {$profile->id} since link is not OAuth.");
+ return true;
+ }
+
+ $status_id = twitter_status_id($notice);
+
+ if (empty($status_id)) {
+ return true;
+ }
+
+ try {
+ $token = TwitterOAuthClient::unpackToken($flink->credentials);
+ $client = new TwitterOAuthClient($token->key, $token->secret);
+
+ $client->favoritesDestroy($status_id);
+ } catch (Exception $e) {
+ common_log(LOG_ERR, "Error attempting to unfavorite bridged notice on Twitter: " . $e->getMessage());
+ }
+
+ return true;
+ }
+
+ function onStartGetProfileUri($profile, &$uri)
+ {
+ if (preg_match('!^https?://twitter.com/!', $profile->profileurl)) {
+ $uri = $profile->profileurl;
+ return false;
+ }
+ return true;
+ }
+
+ /**
+ * Add links in the user's profile block to their Twitter profile URL.
+ *
+ * @param Profile $profile The profile being shown
+ * @param Array &$links Writeable array of arrays (href, text, image).
+ *
+ * @return boolean hook value (true)
+ */
+
+ function onOtherAccountProfiles($profile, &$links)
+ {
+ $fuser = null;
+
+ try {
+ $flink = Foreign_link::getByUserID($profile->id, TWITTER_SERVICE);
+ $fuser = $flink->getForeignUser();
+
+ $links[] = array("href" => $fuser->uri,
+ "text" => sprintf(_("@%s on Twitter"), $fuser->nickname),
+ "image" => $this->path("icons/twitter-bird-white-on-blue.png"));
+ } catch (NoResultException $e) {
+ // no foreign link and/or user for Twitter on this profile ID
+ }
+
+ return true;
+ }
+
+ public function onEndShowHeadElements(Action $action)
+ {
+ if (!($action instanceof AttachmentAction)) {
+ return true;
+ }
+
+ /* Twitter card support. See https://dev.twitter.com/docs/cards */
+ /* @fixme: should we display twitter cards only for attachments posted
+ * by local users ? Seems mandatory to display twitter:creator
+ *
+ * Author: jbfavre
+ */
+ switch ($action->attachment->mimetype) {
+ case 'image/pjpeg':
+ case 'image/jpeg':
+ case 'image/jpg':
+ case 'image/png':
+ case 'image/gif':
+ $action->element('meta', array('name' => 'twitter:card',
+ 'content' => 'photo'),
+ null);
+ $action->element('meta', array('name' => 'twitter:url',
+ 'content' => common_local_url('attachment',
+ array('attachment' => $action->attachment->id))),
+ null );
+ $action->element('meta', array('name' => 'twitter:image',
+ 'content' => $action->attachment->url));
+ $action->element('meta', array('name' => 'twitter:title',
+ 'content' => $action->attachment->title));
+
+ $ns = new AttachmentNoticeSection($action);
+ $notices = $ns->getNotices();
+ $noticeArray = $notices->fetchAll();
+
+ // Should not have more than 1 notice for this attachment.
+ if( count($noticeArray) != 1 ) { break; }
+ $post = $noticeArray[0];
+
+ try {
+ $flink = Foreign_link::getByUserID($post->profile_id, TWITTER_SERVICE);
+ $fuser = Foreign_user::getForeignUser($flink->foreign_id, TWITTER_SERVICE);
+ $action->element('meta', array('name' => 'twitter:creator',
+ 'content' => '@'.$fuser->nickname));
+ } catch (NoResultException $e) {
+ // no foreign link and/or user for Twitter on this profile ID
+ }
+ break;
+ default:
+ break;
}
return true;