twitter/twitter.php

   1 <?php
   2 /**
   3  * Name: Twitter Post Connector
   4  * Description: Post to Twitter
   5  * Version: 2.0
   6  * Author: Tobias Diekershoff <https://f.diekershoff.de/profile/tobias>
   7  * Author: Michael Vogel <https://pirati.ca/profile/heluecht>
   8  * Maintainer: Hypolite Petovan <https://friendica.mrpetovan.com/profile/hypolite>
   9  * Maintainer: Michael Vogel <https://pirati.ca/profile/heluecht>
  10  *
  11  * Copyright (c) 2011-2023 Tobias Diekershoff, Michael Vogel, Hypolite Petovan
  12  * All rights reserved.
  13  *
  14  * Redistribution and use in source and binary forms, with or without
  15  * modification, are permitted provided that the following conditions are met:
  16  *    * Redistributions of source code must retain the above copyright notice,
  17  *     this list of conditions and the following disclaimer.
  18  *    * Redistributions in binary form must reproduce the above
  19  *    * copyright notice, this list of conditions and the following disclaimer in
  20  *      the documentation and/or other materials provided with the distribution.
  21  *    * Neither the name of the <organization> nor the names of its contributors
  22  *      may be used to endorse or promote products derived from this software
  23  *      without specific prior written permission.
  24  *
  25  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
  26  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  27  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  28  * DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY DIRECT,
  29  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  30  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  31  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  32  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
  33  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  34  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  35  *
  36  */
  37
  38 use Friendica\Content\Text\BBCode;
  39 use Friendica\Content\Text\Plaintext;
  40 use Friendica\Core\Hook;
  41 use Friendica\Core\Logger;
  42 use Friendica\Core\Renderer;
  43 use Friendica\Core\Worker;
  44 use Friendica\DI;
  45 use Friendica\Model\Item;
  46 use Friendica\Model\Post;
  47 use Friendica\Core\Config\Util\ConfigFileManager;
  48 use Friendica\Model\Photo;
  49 use GuzzleHttp\Client;
  50 use GuzzleHttp\HandlerStack;
  51 use GuzzleHttp\Subscriber\Oauth\Oauth1;
  52
  53 function twitter_install()
  54 {
  55         Hook::register('load_config'            , __FILE__, 'twitter_load_config');
  56         Hook::register('connector_settings'     , __FILE__, 'twitter_settings');
  57         Hook::register('connector_settings_post', __FILE__, 'twitter_settings_post');
  58         Hook::register('hook_fork'              , __FILE__, 'twitter_hook_fork');
  59         Hook::register('post_local'             , __FILE__, 'twitter_post_local');
  60         Hook::register('notifier_normal'        , __FILE__, 'twitter_post_hook');
  61         Hook::register('jot_networks'           , __FILE__, 'twitter_jot_nets');
  62 }
  63
  64 function twitter_load_config(ConfigFileManager $loader)
  65 {
  66         DI::app()->getConfigCache()->load($loader->loadAddonConfig('twitter'), \Friendica\Core\Config\ValueObject\Cache::SOURCE_STATIC);
  67 }
  68
  69 function twitter_jot_nets(array &$jotnets_fields)
  70 {
  71         if (!DI::userSession()->getLocalUserId()) {
  72                 return;
  73         }
  74
  75         if (DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'twitter', 'post')) {
  76                 $jotnets_fields[] = [
  77                         'type' => 'checkbox',
  78                         'field' => [
  79                                 'twitter_enable',
  80                                 DI::l10n()->t('Post to Twitter'),
  81                                 DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'twitter', 'post_by_default')
  82                         ]
  83                 ];
  84         }
  85 }
  86
  87 function twitter_settings_post()
  88 {
  89         if (!DI::userSession()->getLocalUserId() || empty($_POST['twitter-submit'])) {
  90                 return;
  91         }
  92
  93         DI::pConfig()->set(DI::userSession()->getLocalUserId(), 'twitter', 'post',            (bool)$_POST['twitter-enable']);
  94         DI::pConfig()->set(DI::userSession()->getLocalUserId(), 'twitter', 'post_by_default', (bool)$_POST['twitter-default']);
  95         DI::pConfig()->set(DI::userSession()->getLocalUserId(), 'twitter', 'api_key',         $_POST['twitter-api-key']);
  96         DI::pConfig()->set(DI::userSession()->getLocalUserId(), 'twitter', 'api_secret',      $_POST['twitter-api-secret']);
  97         DI::pConfig()->set(DI::userSession()->getLocalUserId(), 'twitter', 'access_token',    $_POST['twitter-access-token']);
  98         DI::pConfig()->set(DI::userSession()->getLocalUserId(), 'twitter', 'access_secret',   $_POST['twitter-access-secret']);
  99 }
 100
 101 function twitter_settings(array &$data)
 102 {
 103         if (!DI::userSession()->getLocalUserId()) {
 104                 return;
 105         }
 106
 107         $enabled      = DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'twitter', 'post') ?? false;
 108         $def_enabled  = DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'twitter', 'post_by_default') ?? false;
 109
 110         $api_key       = DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'twitter', 'api_key');
 111         $api_secret    = DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'twitter', 'api_secret');
 112         $access_token  = DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'twitter', 'access_token');
 113         $access_secret = DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'twitter', 'access_secret');
 114
 115         $t    = Renderer::getMarkupTemplate('connector_settings.tpl', 'addon/twitter/');
 116         $html = Renderer::replaceMacros($t, [
 117                 '$enable'        => ['twitter-enable', DI::l10n()->t('Allow posting to Twitter'), $enabled, DI::l10n()->t('If enabled all your <strong>public</strong> postings can be posted to the associated Twitter account. You can choose to do so by default (here) or for every posting separately in the posting options when writing the entry.')],
 118                 '$default'       => ['twitter-default', DI::l10n()->t('Send public postings to Twitter by default'), $def_enabled],
 119                 '$api_key'       => ['twitter-api-key', DI::l10n()->t('API Key'), $api_key],
 120                 '$api_secret'    => ['twitter-api-secret', DI::l10n()->t('API Secret'), $api_secret],
 121                 '$access_token'  => ['twitter-access-token', DI::l10n()->t('Access Token'), $access_token],
 122                 '$access_secret' => ['twitter-access-secret', DI::l10n()->t('Access Secret'), $access_secret],
 123         '$help'          => DI::l10n()->t('Each user needs to register their own app to be able to post to Twitter. Please visit https://developer.twitter.com/en/portal/projects-and-apps to register a project. Inside the project you then have to register an app. You will find the needed data for the connector on the page "Keys and token" in the app settings.'),
 124         ]);
 125
 126         $data = [
 127                 'connector' => 'twitter',
 128                 'title'     => DI::l10n()->t('Twitter Export'),
 129                 'enabled'   => $enabled,
 130                 'image'     => 'images/twitter.png',
 131                 'html'      => $html,
 132         ];
 133 }
 134
 135 function twitter_hook_fork(array &$b)
 136 {
 137         DI::logger()->debug('twitter_hook_fork', $b);
 138
 139         if ($b['name'] != 'notifier_normal') {
 140                 return;
 141         }
 142
 143         $post = $b['data'];
 144
 145         if ($post['deleted'] || $post['private'] || ($post['created'] !== $post['edited']) ||
 146                 !strstr($post['postopts'], 'twitter') || ($post['gravity'] != Item::GRAVITY_PARENT)) {
 147                 $b['execute'] = false;
 148                 return;
 149         }
 150 }
 151
 152 function twitter_post_local(array &$b)
 153 {
 154         if (!DI::userSession()->getLocalUserId() || (DI::userSession()->getLocalUserId() != $b['uid'])) {
 155                 return;
 156         }
 157
 158         if ($b['edit'] || $b['private'] || $b['parent']) {
 159                 return;
 160         }
 161
 162         $twitter_post   = (bool)DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'twitter', 'post');
 163         $twitter_enable = (($twitter_post && !empty($_REQUEST['twitter_enable'])) ? (bool)$_REQUEST['twitter_enable'] : false);
 164
 165         // if API is used, default to the chosen settings
 166         if ($b['api_source'] && intval(DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'twitter', 'post_by_default'))) {
 167                 $twitter_enable = true;
 168         }
 169
 170         if (!$twitter_enable) {
 171                 return;
 172         }
 173
 174         if (strlen($b['postopts'])) {
 175                 $b['postopts'] .= ',';
 176         }
 177
 178         $b['postopts'] .= 'twitter';
 179 }
 180
 181 function twitter_post_hook(array &$b)
 182 {
 183         DI::logger()->debug('Invoke post hook', $b);
 184
 185         if (($b['gravity'] != Item::GRAVITY_PARENT) || !strstr($b['postopts'], 'twitter') || $b['private'] || $b['deleted'] || ($b['created'] !== $b['edited'])) {
 186                 return;
 187         }
 188
 189         $b['body'] = Post\Media::addAttachmentsToBody($b['uri-id'], DI::contentItem()->addSharedPost($b));
 190
 191         Logger::notice('twitter post invoked', ['id' => $b['id'], 'guid' => $b['guid']]);
 192
 193         DI::pConfig()->load($b['uid'], 'twitter');
 194
 195         $api_key       = DI::pConfig()->get($b['uid'], 'twitter', 'api_key');
 196         $api_secret    = DI::pConfig()->get($b['uid'], 'twitter', 'api_secret');
 197         $access_token  = DI::pConfig()->get($b['uid'], 'twitter', 'access_token');
 198         $access_secret = DI::pConfig()->get($b['uid'], 'twitter', 'access_secret');
 199
 200         if (empty($api_key) || empty($api_secret) || empty($access_token) || empty($access_secret)) {
 201                 Logger::info('Missing keys, secrets or tokens.');
 202                 return;
 203         }
 204
 205         $msgarr = Plaintext::getPost($b, 280, true, BBCode::TWITTER);
 206         Logger::debug('Got plaintext', ['id' => $b['id'], 'message' => $msgarr]);
 207
 208         $media_ids = [];
 209
 210         if (!empty($msgarr['images']) || !empty($msgarr['remote_images'])) {
 211                 Logger::info('Got images', ['id' => $b['id'], 'images' => $msgarr['images'] ?? []]);
 212
 213                 foreach ($msgarr['images'] ?? [] as $image) {
 214                         if (count($media_ids) == 4) {
 215                                 continue;
 216                         }
 217                         try {
 218                                 $media_ids[] = twitter_upload_image($b['uid'], $image, $b);
 219                         } catch (\Throwable $th) {
 220                                 Logger::warning('Error while uploading image', ['image' => $image, 'code' => $th->getCode(), 'message' => $th->getMessage()]);
 221                 Worker::defer();
 222                 break;
 223             }
 224                 }
 225         }
 226
 227         $in_reply_to_tweet_id = 0;
 228
 229         Logger::debug('Post message', ['id' => $b['id'], 'parts' => count($msgarr['parts'])]);
 230         foreach ($msgarr['parts'] as $key => $part) {
 231                 try {
 232                         $id = twitter_post_status($b['uid'], $part, $media_ids, $in_reply_to_tweet_id);
 233                         Logger::info('twitter_post send', ['part' => $key, 'id' => $b['id'], 'result' => $id]);
 234                 } catch (\Throwable $th) {
 235                         Logger::warning('Error while posting message', ['part' => $key, 'id' => $b['id'], 'code' => $th->getCode(), 'message' => $th->getMessage()]);
 236                         Worker::defer();
 237                         break;
 238                 }
 239
 240                 $in_reply_to_tweet_id = $id;
 241                 $media_ids = [];
 242         }
 243 }
 244
 245 function twitter_post_status(int $uid, string $status, array $media_ids = [], string $in_reply_to_tweet_id = ''): string
 246 {
 247         $parameters = ['text' => $status];
 248         if (!empty($media_ids)) {
 249                 $parameters['media'] = ['media_ids' => $media_ids];
 250         }
 251         if (!empty($in_reply_to_tweet_id)) {
 252                 $parameters['reply'] = ['in_reply_to_tweet_id' => $in_reply_to_tweet_id];
 253         }
 254
 255         $response = twitter_post($uid, 'https://api.twitter.com/2/tweets', 'json', $parameters);
 256
 257         return $response->data->id;
 258 }
 259
 260 function twitter_upload_image(int $uid, array $image)
 261 {
 262         if (!empty($image['id'])) {
 263                 $photo = Photo::selectFirst([], ['id' => $image['id']]);
 264         } else {
 265                 $photo = Photo::createPhotoForExternalResource($image['url']);
 266         }
 267
 268         $parameters = [
 269                 'name' => 'media_data',
 270                 'contents' => base64_encode(Photo::getImageForPhoto($photo))
 271         ];
 272
 273     Logger::info('Uploading', ['uid' => $uid, 'image' => $image]);
 274         $media = twitter_post($uid, 'https://upload.twitter.com/1.1/media/upload.json', 'multipart', [$parameters]);
 275
 276         if (isset($media->media_id_string)) {
 277                 $media_id = $media->media_id_string;
 278
 279                 if (!empty($image['description'])) {
 280                         $data = [
 281                                 'media_id' => $media->media_id_string,
 282                                 'alt_text' => [
 283                                         'text' => substr($image['description'], 0, 1000)
 284                                 ]
 285                         ];
 286                         $ret = twitter_post($uid, 'https://upload.twitter.com/1.1/media/metadata/create.json', 'json', $data);
 287                         Logger::info('Metadata create', ['uid' => $uid, 'data' => $data, 'return' => $ret]);
 288                 }
 289         } else {
 290                 Logger::error('Failed upload', ['uid' => $uid, 'image' => $image['url'], 'return' => $media]);
 291                 throw new Exception('Failed upload of ' . $image['url']);
 292         }
 293
 294         return $media_id;
 295 }
 296
 297 function twitter_post(int $uid, string $url, string $type, array $data): stdClass
 298 {
 299         $stack = HandlerStack::create();
 300
 301         $middleware = new Oauth1([
 302                 'consumer_key'    => DI::pConfig()->get($uid, 'twitter', 'api_key'),
 303                 'consumer_secret' => DI::pConfig()->get($uid, 'twitter', 'api_secret'),
 304                 'token'           => DI::pConfig()->get($uid, 'twitter', 'access_token'),
 305                 'token_secret'    => DI::pConfig()->get($uid, 'twitter', 'access_secret'),
 306         ]);
 307
 308         $stack->push($middleware);
 309
 310         $client = new Client([
 311                 'handler' => $stack
 312         ]);
 313
 314         $response = $client->post($url, ['auth' => 'oauth', $type => $data]);
 315
 316         $content = json_decode($response->getBody()->getContents()) ?? new stdClass;
 317         Logger::debug('Success', ['content' => $content]);
 318         return $content;
 319 }