Merge pull request 'Bluesky: Import of remote timeline' (#1388) from heluecht/friendica-addons:bluesky-import into develop

Reviewed-on: https://git.friendi.ca/friendica/friendica-addons/pulls/1388
This commit is contained in:
Tobias Diekershoff 2023-05-24 08:00:33 +02:00
commit 421964b406
3 changed files with 489 additions and 23 deletions

View file

@ -2,23 +2,50 @@
/**
* Name: Bluesky Connector
* Description: Post to Bluesky
* Version: 1.0
* Version: 1.1
* Author: Michael Vogel <https://pirati.ca/profile/heluecht>
*
* @todo
* Piece of cake?
* - Process facets
* - create facets
*
* Possible but less important:
* - Block, unblock, mute and unmute contacts
*
* Need inspiration:
* - alternate link for contacts
* - plink for posts
*
* Need more information:
* - only fetch new posts
* - detect incoming reshares
* - detect contact relations
* - receive likes
*/
use Friendica\Content\Text\BBCode;
use Friendica\Content\Text\HTML;
use Friendica\Content\Text\Plaintext;
use Friendica\Core\Config\Util\ConfigFileManager;
use Friendica\Core\Hook;
use Friendica\Core\Logger;
use Friendica\Core\Protocol;
use Friendica\Core\Renderer;
use Friendica\Database\DBA;
use Friendica\DI;
use Friendica\Model\Contact;
use Friendica\Model\Item;
use Friendica\Model\ItemURI;
use Friendica\Model\Photo;
use Friendica\Model\Post;
use Friendica\Network\HTTPClient\Client\HttpClientAccept;
use Friendica\Network\HTTPClient\Client\HttpClientOptions;
use Friendica\Protocol\Activity;
use Friendica\Util\DateTimeFormat;
define('BLUESKY_DEFAULT_POLL_INTERVAL', 10); // given in minutes
function bluesky_install()
{
Hook::register('load_config', __FILE__, 'bluesky_load_config');
@ -28,6 +55,16 @@ function bluesky_install()
Hook::register('jot_networks', __FILE__, 'bluesky_jot_nets');
Hook::register('connector_settings', __FILE__, 'bluesky_settings');
Hook::register('connector_settings_post', __FILE__, 'bluesky_settings_post');
Hook::register('cron', __FILE__, 'bluesky_cron');
// Hook::register('support_follow', __FILE__, 'bluesky_support_follow');
// Hook::register('support_probe', __FILE__, 'bluesky_support_probe');
// Hook::register('follow', __FILE__, 'bluesky_follow');
// Hook::register('unfollow', __FILE__, 'bluesky_unfollow');
// Hook::register('block', __FILE__, 'bluesky_block');
// Hook::register('unblock', __FILE__, 'bluesky_unblock');
Hook::register('check_item_notification', __FILE__, 'bluesky_check_item_notification');
// Hook::register('probe_detect', __FILE__, 'bluesky_probe_detect');
// Hook::register('item_by_link', __FILE__, 'bluesky_item_by_link');
}
function bluesky_load_config(ConfigFileManager $loader)
@ -35,6 +72,17 @@ function bluesky_load_config(ConfigFileManager $loader)
DI::app()->getConfigCache()->load($loader->loadAddonConfig('bluesky'), \Friendica\Core\Config\ValueObject\Cache::SOURCE_STATIC);
}
function bluesky_check_item_notification(array &$notification_data)
{
$handle = DI::pConfig()->get($notification_data['uid'], 'bluesky', 'handle');
$did = DI::pConfig()->get($notification_data['uid'], 'bluesky', 'did');
if (!empty($handle) && !empty($did)) {
$notification_data['profiles'][] = $handle;
$notification_data['profiles'][] = $did;
}
}
function bluesky_settings(array &$data)
{
if (!DI::userSession()->getLocalUserId()) {
@ -47,6 +95,7 @@ function bluesky_settings(array &$data)
$handle = DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'bluesky', 'handle');
$did = DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'bluesky', 'did');
$token = DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'bluesky', 'access_token');
$import = DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'bluesky', 'import') ?? false;
$status = $token ? DI::l10n()->t("You are authenticated to Bluesky. For security reasons the password isn't stored.") : DI::l10n()->t('You are not authenticated. Please enter the app password.');
@ -54,6 +103,7 @@ function bluesky_settings(array &$data)
$html = Renderer::replaceMacros($t, [
'$enable' => ['bluesky', DI::l10n()->t('Enable Bluesky Post Addon'), $enabled],
'$bydefault' => ['bluesky_bydefault', DI::l10n()->t('Post to Bluesky by default'), $def_enabled],
'$import' => ['bluesky_import', DI::l10n()->t('Import the remote timeline'), $import],
'$host' => ['bluesky_host', DI::l10n()->t('Bluesky host'), $host, '', '', 'readonly'],
'$handle' => ['bluesky_handle', DI::l10n()->t('Bluesky handle'), $handle],
'$did' => ['bluesky_did', DI::l10n()->t('Bluesky DID'), $did, DI::l10n()->t('This is the unique identifier. It will be fetched automatically, when the handle is entered.'), '', 'readonly'],
@ -63,7 +113,7 @@ function bluesky_settings(array &$data)
$data = [
'connector' => 'bluesky',
'title' => DI::l10n()->t('Bluesky Export'),
'title' => DI::l10n()->t('Bluesky Import/Export'),
'image' => 'images/bluesky.jpg',
'enabled' => $enabled,
'html' => $html,
@ -87,6 +137,7 @@ function bluesky_settings_post(array &$b)
DI::pConfig()->set(DI::userSession()->getLocalUserId(), 'bluesky', 'post_by_default', intval($_POST['bluesky_bydefault']));
DI::pConfig()->set(DI::userSession()->getLocalUserId(), 'bluesky', 'host', $host);
DI::pConfig()->set(DI::userSession()->getLocalUserId(), 'bluesky', 'handle', $handle);
DI::pConfig()->set(DI::userSession()->getLocalUserId(), 'bluesky', 'import', intval($_POST['bluesky_import']));
if (!empty($host) && !empty($handle)) {
if (empty($old_did) || $old_host != $host || $old_handle != $handle) {
@ -120,6 +171,50 @@ function bluesky_jot_nets(array &$jotnets_fields)
}
}
function bluesky_cron()
{
$last = DI::keyValue()->get('bluesky_last_poll');
$poll_interval = intval(DI::config()->get('bluesky', 'poll_interval'));
if (!$poll_interval) {
$poll_interval = BLUESKY_DEFAULT_POLL_INTERVAL;
}
if ($last) {
$next = $last + ($poll_interval * 60);
if ($next > time()) {
Logger::notice('poll interval not reached');
return;
}
}
Logger::notice('cron_start');
$abandon_days = intval(DI::config()->get('system', 'account_abandon_days'));
if ($abandon_days < 1) {
$abandon_days = 0;
}
$abandon_limit = date(DateTimeFormat::MYSQL, time() - $abandon_days * 86400);
$pconfigs = DBA::selectToArray('pconfig', [], ['cat' => 'bluesky', 'k' => 'import', 'v' => true]);
foreach ($pconfigs as $pconfig) {
if ($abandon_days != 0) {
if (!DBA::exists('user', ["`uid` = ? AND `login_date` >= ?", $pconfig['uid'], $abandon_limit])) {
Logger::notice('abandoned account: timeline from user will not be imported', ['user' => $pconfig['uid']]);
continue;
}
}
Logger::notice('importing timeline - start', ['user' => $pconfig['uid']]);
bluesky_fetch_timeline($pconfig['uid']);
Logger::notice('importing timeline - done', ['user' => $pconfig['uid']]);
}
Logger::notice('cron_end');
DI::keyValue()->set('bluesky_last_poll', time());
}
function bluesky_hook_fork(array &$b)
{
if ($b['name'] != 'notifier_normal') {
@ -134,7 +229,15 @@ function bluesky_hook_fork(array &$b)
return;
}
if (!strstr($post['postopts'] ?? '', 'bluesky') || ($post['parent'] != $post['id']) || $post['private']) {
if (DI::pConfig()->get($post['uid'], 'bluesky', 'import')) {
// Don't post if it isn't a reply to a bluesky post
if (($post['parent'] != $post['id']) && !Post::exists(['id' => $post['parent'], 'network' => Protocol::BLUESKY])) {
Logger::notice('No bluesky parent found', ['item' => $post['id']]);
$b['execute'] = false;
return;
}
} elseif (!strstr($post['postopts'] ?? '', 'bluesky') || ($post['parent'] != $post['id']) || $post['private']) {
DI::logger()->info('Activities are never exported when we don\'t import the bluesky timeline', ['uid' => $post['uid']]);
$b['execute'] = false;
return;
}
@ -180,6 +283,33 @@ function bluesky_send(array &$b)
}
if ($b['gravity'] != Item::GRAVITY_PARENT) {
Logger::debug('Got comment', ['item' => $b]);
if ($b['deleted']) {
$uri = bluesky_get_uri_class($b['uri']);
if (empty($uri)) {
Logger::debug('Not a bluesky post', ['uri' => $b['uri']]);
return;
}
bluesky_delete_post($b['uri'], $b['uid']);
return;
}
$root = bluesky_get_uri_class($b['parent-uri']);
$parent = bluesky_get_uri_class($b['thr-parent']);
if (empty($root) || empty($parent)) {
Logger::debug('No bluesky post', ['parent' => $b['parent'], 'thr-parent' => $b['thr-parent']]);
return;
}
if ($b['gravity'] == Item::GRAVITY_COMMENT) {
Logger::debug('Posting comment', ['root' => $root, 'parent' => $parent]);
bluesky_create_post($b, $root, $parent);
return;
} elseif (in_array($b['verb'], [Activity::LIKE, Activity::ANNOUNCE])) {
bluesky_create_activity($b, $parent);
}
return;
} elseif ($b['private'] || !strstr($b['postopts'], 'bluesky')) {
return;
@ -188,7 +318,53 @@ function bluesky_send(array &$b)
bluesky_create_post($b);
}
function bluesky_create_post(array $item)
function bluesky_create_activity(array $item, stdClass $parent = null)
{
$uid = $item['uid'];
$token = bluesky_get_token($uid);
if (empty($token)) {
return;
}
$did = DI::pConfig()->get($uid, 'bluesky', 'did');
if ($item['verb'] == Activity::LIKE) {
$record = [
'subject' => $parent,
'createdAt' => DateTimeFormat::utcNow(DateTimeFormat::ATOM),
'$type' => 'app.bsky.feed.like'
];
$post = [
'collection' => 'app.bsky.feed.like',
'repo' => $did,
'record' => $record
];
} elseif ($item['verb'] == Activity::ANNOUNCE) {
$record = [
'subject' => $parent,
'createdAt' => DateTimeFormat::utcNow(DateTimeFormat::ATOM),
'$type' => 'app.bsky.feed.repost'
];
$post = [
'collection' => 'app.bsky.feed.repost',
'repo' => $did,
'record' => $record
];
}
$activity = bluesky_post($uid, '/xrpc/com.atproto.repo.createRecord', json_encode($post), ['Content-type' => 'application/json', 'Authorization' => ['Bearer ' . $token]]);
if (empty($activity)) {
return;
}
Logger::debug('Activity done', ['return' => $activity]);
$uri = bluesky_get_uri($activity);
Item::update(['extid' => $uri], ['id' => $item['id']]);
Logger::debug('Set extid', ['id' => $item['id'], 'extid' => $activity]);
}
function bluesky_create_post(array $item, stdClass $root = null, stdClass $parent = null)
{
$uid = $item['uid'];
$token = bluesky_get_token($uid);
@ -199,7 +375,6 @@ function bluesky_create_post(array $item)
$did = DI::pConfig()->get($uid, 'bluesky', 'did');
$msg = Plaintext::getPost($item, 300, false, BBCode::CONNECTORS);
$parent = $root = [];
foreach ($msg['parts'] as $key => $part) {
$record = [
'text' => $part,
@ -229,6 +404,11 @@ function bluesky_create_post(array $item)
if (empty($root)) {
$root = $parent;
}
if (($key == 0) && ($item['gravity'] != Item::GRAVITY_PARENT)) {
$uri = bluesky_get_uri($parent);
Item::update(['extid' => $uri], ['id' => $item['id']]);
Logger::debug('Set extid', ['id' => $item['id'], 'extid' => $uri]);
}
}
}
@ -279,7 +459,19 @@ function bluesky_upload_blob(int $uid, array $photo): ?stdClass
return $data->blob;
}
function bluesky_get_timeline(int $uid)
function bluesky_delete_post(string $uri, int $uid)
{
$token = bluesky_get_token($uid);
$parts = bluesky_get_uri_parts($uri);
if (empty($parts)) {
Logger::debug('No uri delected', ['uri' => $uri]);
return;
}
bluesky_post($uid, '/xrpc/com.atproto.repo.deleteRecord', json_encode($parts), ['Content-type' => 'application/json', 'Authorization' => ['Bearer ' . $token]]);
Logger::debug('Deleted', ['parts' => $parts]);
}
function bluesky_fetch_timeline(int $uid)
{
$data = bluesky_get($uid, '/xrpc/app.bsky.feed.getTimeline', HttpClientAccept::JSON, [HttpClientOptions::HEADERS => ['Authorization' => ['Bearer ' . bluesky_get_token($uid)]]]);
if (empty($data)) {
@ -290,10 +482,279 @@ function bluesky_get_timeline(int $uid)
return;
}
foreach ($data->feed as $entry) {
// TODO Add Functionality to read the timeline
print_r($entry);
foreach (array_reverse($data->feed) as $entry) {
bluesky_process_post($entry->post, $uid);
}
// @todo Support paging
// [cursor] => 1684670516000::bafyreidq3ilwslmlx72jf5vrk367xcc63s6lrhzlyup2bi3zwcvso6w2vi
}
function bluesky_process_post(stdClass $post, int $uid): int
{
$uri = bluesky_get_uri($post);
if (Post::exists(['uri' => $uri, 'uid' => $uid]) || Post::exists(['extid' => $uri, 'uid' => $uid])) {
return 0;
}
Logger::debug('Importing post', ['uid' => $uid, 'indexedAt' => $post->indexedAt, 'uri' => $post->uri, 'cid' => $post->cid]);
$item = bluesky_get_header($post, $uri, $uid);
$item = bluesky_get_content($item, $post->record, $uid);
if (!empty($post->embed)) {
$item = bluesky_add_media($post->embed, $item);
}
return item::insert($item);
}
function bluesky_get_header(stdClass $post, string $uri, int $uid): array
{
$contact = bluesky_get_contact($post->author, $uid);
$item = [
'network' => Protocol::BLUESKY,
'uid' => $uid,
'wall' => false,
'uri' => $uri,
'guid' => $post->cid,
'private' => Item::UNLISTED,
'verb' => Activity::POST,
'contact-id' => $contact['id'],
'author-name' => $contact['name'],
'author-link' => $contact['url'],
'author-avatar' => $contact['avatar'],
// 'plink' => '', @todo Path to a web representation
];
$item['uri-id'] = ItemURI::getIdByURI($uri);
$item['owner-name'] = $item['author-name'];
$item['owner-link'] = $item['author-link'];
$item['owner-avatar'] = $item['author-avatar'];
return $item;
}
function bluesky_get_content(array $item, stdClass $record, int $uid): array
{
if (!empty($record->reply)) {
$item['parent-uri'] = bluesky_get_uri($record->reply->root);
bluesky_fetch_missing_post($item['parent-uri'], $uid);
$item['thr-parent'] = bluesky_get_uri($record->reply->parent);
bluesky_fetch_missing_post($item['thr-parent'], $uid);
}
$body = $record->text;
if (!empty($record->facets)) {
// @todo add Links
}
$item['body'] = $body;
$item['created'] = DateTimeFormat::utc($record->createdAt, DateTimeFormat::MYSQL);
return $item;
}
function bluesky_add_media(stdClass $embed, array $item): array
{
if (!empty($embed->images)) {
foreach ($embed->images as $image) {
$media = [
'uri-id' => $item['uri-id'],
'type' => Post\Media::IMAGE,
'url' => $image->fullsize,
'preview' => $image->thumb,
'description' => $image->alt,
];
Post\Media::insert($media);
}
} elseif (!empty($embed->external)) {
$media = ['uri-id' => $item['uri-id'],
'type' => Post\Media::HTML,
'url' => $embed->external->uri,
'name' => $embed->external->title,
'description' => $embed->external->description,
];
Post\Media::insert($media);
} elseif (!empty($embed->record)) {
$uri = bluesky_get_uri($embed->record);
$shared = Post::selectFirst(['uri-id'], ['uri' => $uri, 'uid' => $item['uid']]);
if (empty($shared)) {
$shared = bluesky_get_header($embed->record, $uri, 0);
$shared = bluesky_get_content($shared, $embed->record->value, $item['uid']);
if (!empty($embed->record->embeds)) {
foreach ($embed->record->embeds as $single) {
$shared = bluesky_add_media($single, $shared);
}
}
$id = Item::insert($shared);
$shared = Post::selectFirst(['uri-id'], ['id' => $id]);
}
if (!empty($shared)) {
$item['quote-uri-id'] = $shared['uri-id'];
}
} else {
Logger::debug('Unsupported embed', ['embed' => $embed, 'item' => $item]);
}
return $item;
}
function bluesky_get_uri(stdClass $post): string
{
return $post->uri . ':' . $post->cid;
}
function bluesky_get_uri_class(string $uri): ?stdClass
{
if (empty($uri)) {
return null;
}
$elements = explode(':', $uri);
if (empty($elements) || ($elements[0] != 'at')) {
$post = Post::selectFirstPost(['extid'], ['uri' => $uri]);
return bluesky_get_uri_class($post['extid'] ?? '');
}
$class = new stdClass;
$class->cid = array_pop($elements);
$class->uri = implode(':', $elements);
return $class;
}
function bluesky_get_uri_parts(string $uri): ?stdClass
{
$class = bluesky_get_uri_class($uri);
if (empty($class)) {
return null;
}
$parts = explode('/', substr($class->uri, 5));
$class = new stdClass;
$class->repo = $parts[0];
$class->collection = $parts[1];
$class->rkey = $parts[2];
return $class;
}
function bluesky_fetch_missing_post(string $uri, int $uid)
{
if (Post::exists(['uri' => $uri, 'uid' => [$uid, 0]])) {
Logger::debug('Post exists', ['uri' => $uri]);
return;
}
Logger::debug('Fetch missing post', ['uri' => $uri]);
$class = bluesky_get_uri_class($uri);
$data = bluesky_get($uid, '/xrpc/app.bsky.feed.getPosts?uris=' . $class->uri, HttpClientAccept::JSON, [HttpClientOptions::HEADERS => ['Authorization' => ['Bearer ' . bluesky_get_token($uid)]]]);
if (empty($data)) {
return;
}
foreach ($data->posts as $post) {
$item = bluesky_get_header($post, $uri, $uid);
$item = bluesky_get_content($item, $post->record, $uid);
if (!empty($post->embed)) {
$item = bluesky_add_media($post->embed, $item);
}
$id = Item::insert($item);
Logger::debug('Stored item', ['id' => $id, 'uri' => $uri]);
}
}
function bluesky_get_contact(stdClass $author, int $uid): array
{
$condition = ['network' => Protocol::BLUESKY, 'uid' => $uid, 'url' => $author->did];
$fields = [
'name' => $author->displayName,
'nick' => $author->handle,
'addr' => $author->handle,
];
$contact = Contact::selectFirst([], $condition);
if (empty($contact)) {
$cid = bluesky_insert_contact($author, $uid);
} else {
$cid = $contact['id'];
if ($fields['name'] != $contact['name'] || $fields['nick'] != $contact['nick'] || $fields['addr'] != $contact['addr']) {
Contact::update($fields, ['id' => $cid]);
}
}
$condition['uid'] = 0;
$contact = Contact::selectFirst([], $condition);
if (empty($contact)) {
$pcid = bluesky_insert_contact($author, 0);
} else {
$pcid = $contact['id'];
if ($fields['name'] != $contact['name'] || $fields['nick'] != $contact['nick'] || $fields['addr'] != $contact['addr']) {
Contact::update($fields, ['id' => $pcid]);
}
}
if (!empty($author->avatar)) {
Contact::updateAvatar($cid, $author->avatar);
}
if (empty($contact) || $contact['updated'] < DateTimeFormat::utc('now -24 hours')) {
bluesky_update_contact($author, $uid, $cid, $pcid);
}
return Contact::getById($cid);
}
function bluesky_insert_contact(stdClass $author, int $uid)
{
$fields = [
'uid' => $uid,
'network' => Protocol::BLUESKY,
'priority' => 1,
'writable' => true,
'blocked' => false,
'readonly' => false,
'pending' => false,
'url' => $author->did,
'nurl' => $author->did,
// 'alias' => '', @todo Path to a web representation
'name' => $author->displayName,
'nick' => $author->handle,
'addr' => $author->handle,
];
return Contact::insert($fields);
}
function bluesky_update_contact(stdClass $author, int $uid, int $cid, int $pcid)
{
$data = bluesky_get($uid, '/xrpc/app.bsky.actor.getProfile?actor=' . $author->did, HttpClientAccept::JSON, [HttpClientOptions::HEADERS => ['Authorization' => ['Bearer ' . bluesky_get_token($uid)]]]);
if (empty($data)) {
return;
}
$fields = [
'name' => $data->displayName,
'nick' => $data->handle,
'addr' => $data->handle,
'about' => HTML::toBBCode($data->description),
'updated' => DateTimeFormat::utcNow(DateTimeFormat::MYSQL),
];
if (!empty($data->banner)) {
$fields['header'] = $data->banner;
}
Contact::update($fields, ['id' => $cid]);
Contact::update($fields, ['id' => $pcid]);
}
function bluesky_get_did(int $uid): string

View file

@ -8,7 +8,7 @@ msgid ""
msgstr ""
"Project-Id-Version: \n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2023-05-21 19:24+0000\n"
"POT-Creation-Date: 2023-05-24 05:52+0000\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
@ -17,56 +17,60 @@ msgstr ""
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
#: bluesky.php:51
#: bluesky.php:100
msgid ""
"You are authenticated to Bluesky. For security reasons the password isn't "
"stored."
msgstr ""
#: bluesky.php:51
#: bluesky.php:100
msgid "You are not authenticated. Please enter the app password."
msgstr ""
#: bluesky.php:55
#: bluesky.php:104
msgid "Enable Bluesky Post Addon"
msgstr ""
#: bluesky.php:56
#: bluesky.php:105
msgid "Post to Bluesky by default"
msgstr ""
#: bluesky.php:57
#: bluesky.php:106
msgid "Import the remote timeline"
msgstr ""
#: bluesky.php:107
msgid "Bluesky host"
msgstr ""
#: bluesky.php:58
#: bluesky.php:108
msgid "Bluesky handle"
msgstr ""
#: bluesky.php:59
#: bluesky.php:109
msgid "Bluesky DID"
msgstr ""
#: bluesky.php:59
#: bluesky.php:109
msgid ""
"This is the unique identifier. It will be fetched automatically, when the "
"handle is entered."
msgstr ""
#: bluesky.php:60
#: bluesky.php:110
msgid "Bluesky app password"
msgstr ""
#: bluesky.php:60
#: bluesky.php:110
msgid ""
"Please don't add your real password here, but instead create a specific app "
"password in the Bluesky settings."
msgstr ""
#: bluesky.php:66
msgid "Bluesky Export"
#: bluesky.php:116
msgid "Bluesky Import/Export"
msgstr ""
#: bluesky.php:116
#: bluesky.php:167
msgid "Post to Bluesky"
msgstr ""

View file

@ -1,6 +1,7 @@
<p>{{$status}}</p>
{{include file="field_checkbox.tpl" field=$enable}}
{{include file="field_checkbox.tpl" field=$bydefault}}
{{include file="field_checkbox.tpl" field=$import}}
{{include file="field_input.tpl" field=$host}}
{{include file="field_input.tpl" field=$handle}}
{{include file="field_input.tpl" field=$did}}