friendica-addons/tumblr/tumblr.php

430 lines
14 KiB
PHP
Raw Normal View History

2012-12-22 20:36:35 +00:00
<?php
/**
* Name: Tumblr Post Connector
* Description: Post to Tumblr
* Version: 2.0
2012-12-22 20:36:35 +00:00
* Author: Mike Macgirvin <http://macgirvin.com/profile/mike>
* Author: Michael Vogel <https://pirati.ca/profile/heluecht>
2012-12-22 20:36:35 +00:00
*/
require_once __DIR__ . DIRECTORY_SEPARATOR . 'library' . DIRECTORY_SEPARATOR . 'tumblroauth.php';
2012-12-22 20:36:35 +00:00
use Friendica\Content\Text\BBCode;
use Friendica\Core\Hook;
use Friendica\Core\Logger;
use Friendica\Core\Renderer;
use Friendica\DI;
2023-03-05 21:17:14 +00:00
use Friendica\Model\Item;
2023-03-09 06:37:02 +00:00
use Friendica\Model\Photo;
use Friendica\Model\Post;
2020-05-05 22:47:43 +00:00
use Friendica\Model\Tag;
2023-03-09 06:37:02 +00:00
use Friendica\Util\Network;
function tumblr_install()
{
Hook::register('hook_fork', 'addon/tumblr/tumblr.php', 'tumblr_hook_fork');
Hook::register('post_local', 'addon/tumblr/tumblr.php', 'tumblr_post_local');
Hook::register('notifier_normal', 'addon/tumblr/tumblr.php', 'tumblr_send');
Hook::register('jot_networks', 'addon/tumblr/tumblr.php', 'tumblr_jot_nets');
Hook::register('connector_settings', 'addon/tumblr/tumblr.php', 'tumblr_settings');
Hook::register('connector_settings_post', 'addon/tumblr/tumblr.php', 'tumblr_settings_post');
2012-12-22 20:36:35 +00:00
}
/**
* This is a statement rather than an actual function definition. The simple
* existence of this method is checked to figure out if the addon offers a
* module.
*/
2023-03-05 21:17:14 +00:00
function tumblr_module()
{
}
2012-12-22 20:36:35 +00:00
function tumblr_content()
{
2022-10-20 21:51:49 +00:00
if (!DI::userSession()->getLocalUserId()) {
2022-10-17 21:00:03 +00:00
DI::sysmsg()->addNotice(DI::l10n()->t('Permission denied.'));
2012-12-22 20:36:35 +00:00
return '';
}
if (isset(DI::args()->getArgv()[1])) {
switch (DI::args()->getArgv()[1]) {
2023-03-05 21:17:14 +00:00
case 'connect':
$o = tumblr_connect();
2012-12-22 20:36:35 +00:00
break;
2023-03-05 21:17:14 +00:00
case 'callback':
$o = tumblr_callback();
2012-12-22 20:36:35 +00:00
break;
2012-12-22 20:36:35 +00:00
default:
$o = print_r(DI::args()->getArgv(), true);
2012-12-22 20:36:35 +00:00
break;
}
} else {
$o = tumblr_connect();
}
2012-12-22 20:36:35 +00:00
return $o;
}
function tumblr_addon_admin(string &$o)
{
2023-03-05 21:17:14 +00:00
$t = Renderer::getMarkupTemplate('admin.tpl', 'addon/tumblr/');
2014-06-15 13:05:04 +00:00
$o = Renderer::replaceMacros($t, [
'$submit' => DI::l10n()->t('Save Settings'),
// name, label, value, help, [extra values]
2023-03-05 21:17:14 +00:00
'$consumer_key' => ['consumer_key', DI::l10n()->t('Consumer Key'), DI::config()->get('tumblr', 'consumer_key'), ''],
'$consumer_secret' => ['consumer_secret', DI::l10n()->t('Consumer Secret'), DI::config()->get('tumblr', 'consumer_secret'), ''],
]);
2014-06-15 13:05:04 +00:00
}
function tumblr_addon_admin_post()
{
DI::config()->set('tumblr', 'consumer_key', trim($_POST['consumer_key'] ?? ''));
DI::config()->set('tumblr', 'consumer_secret', trim($_POST['consumer_secret'] ?? ''));
2014-06-15 13:05:04 +00:00
}
function tumblr_connect()
{
2012-12-22 20:36:35 +00:00
// Start a session. This is necessary to hold on to a few keys the callback script will also need
session_start();
// Define the needed keys
$consumer_key = DI::config()->get('tumblr', 'consumer_key');
$consumer_secret = DI::config()->get('tumblr', 'consumer_secret');
2012-12-22 20:36:35 +00:00
// The callback URL is the script that gets called after the user authenticates with tumblr
// In this example, it would be the included callback.php
$callback_url = DI::baseUrl() . '/tumblr/callback';
2012-12-22 20:36:35 +00:00
// Let's begin. First we need a Request Token. The request token is required to send the user
// to Tumblr's login page.
// Create a new instance of the TumblrOAuth library. For this step, all we need to give the library is our
// Consumer Key and Consumer Secret
$tum_oauth = new TumblrOAuth($consumer_key, $consumer_secret);
// Ask Tumblr for a Request Token. Specify the Callback URL here too (although this should be optional)
$request_token = $tum_oauth->getRequestToken($callback_url);
// Store the request token and Request Token Secret as out callback.php script will need this
$_SESSION['request_token'] = $token = $request_token['oauth_token'];
$_SESSION['request_token_secret'] = $request_token['oauth_token_secret'];
// Check the HTTP Code. It should be a 200 (OK), if it's anything else then something didn't work.
switch ($tum_oauth->http_code) {
2014-06-10 18:13:11 +00:00
case 200:
// Ask Tumblr to give us a special address to their login page
$url = $tum_oauth->getAuthorizeURL($token);
// Redirect the user to the login URL given to us by Tumblr
header('Location: ' . $url);
/*
* That's it for our side. The user is sent to a Tumblr Login page and
* asked to authroize our app. After that, Tumblr sends the user back to
* our Callback URL (callback.php) along with some information we need to get
* an access token.
*/
2014-06-10 18:13:11 +00:00
break;
2014-06-10 18:13:11 +00:00
default:
// Give an error message
$o = 'Could not connect to Tumblr. Refresh the page or try again later.';
2012-12-22 20:36:35 +00:00
}
return $o;
}
2012-12-22 20:36:35 +00:00
function tumblr_callback()
{
2012-12-22 20:36:35 +00:00
// Start a session, load the library
session_start();
// Define the needed keys
$consumer_key = DI::config()->get('tumblr', 'consumer_key');
$consumer_secret = DI::config()->get('tumblr', 'consumer_secret');
2012-12-22 20:36:35 +00:00
// Once the user approves your app at Tumblr, they are sent back to this script.
// This script is passed two parameters in the URL, oauth_token (our Request Token)
// and oauth_verifier (Key that we need to get Access Token).
// We'll also need out Request Token Secret, which we stored in a session.
// Create instance of TumblrOAuth.
// It'll need our Consumer Key and Secret as well as our Request Token and Secret
$tum_oauth = new TumblrOAuth($consumer_key, $consumer_secret, $_SESSION['request_token'], $_SESSION['request_token_secret']);
2017-06-09 01:20:27 +00:00
// Ok, let's get an Access Token. We'll need to pass along our oauth_verifier which was given to us in the URL.
2012-12-22 20:36:35 +00:00
$access_token = $tum_oauth->getAccessToken($_REQUEST['oauth_verifier']);
// We're done with the Request Token and Secret so let's remove those.
unset($_SESSION['request_token']);
unset($_SESSION['request_token_secret']);
// Make sure nothing went wrong.
if (200 == $tum_oauth->http_code) {
2014-06-10 18:13:11 +00:00
// good to go
2012-12-22 20:36:35 +00:00
} else {
return 'Unable to authenticate';
2012-12-22 20:36:35 +00:00
}
// What's next? Now that we have an Access Token and Secret, we can make an API call.
2022-10-20 21:51:49 +00:00
DI::pConfig()->set(DI::userSession()->getLocalUserId(), 'tumblr', 'oauth_token', $access_token['oauth_token']);
DI::pConfig()->set(DI::userSession()->getLocalUserId(), 'tumblr', 'oauth_token_secret', $access_token['oauth_token_secret']);
2012-12-22 20:36:35 +00:00
2023-03-05 21:17:14 +00:00
$o = DI::l10n()->t('You are now authenticated to tumblr.');
$o .= '<br /><a href="' . DI::baseUrl() . '/settings/connectors">' . DI::l10n()->t("return to the connector page") . '</a>';
return $o;
2012-12-22 20:36:35 +00:00
}
function tumblr_jot_nets(array &$jotnets_fields)
{
2022-10-20 21:51:49 +00:00
if (!DI::userSession()->getLocalUserId()) {
2014-06-10 18:13:11 +00:00
return;
}
2014-06-10 18:13:11 +00:00
2023-03-05 21:17:14 +00:00
if (DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'tumblr', 'post')) {
$jotnets_fields[] = [
'type' => 'checkbox',
'field' => [
'tumblr_enable',
DI::l10n()->t('Post to Tumblr'),
2023-03-05 21:17:14 +00:00
DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'tumblr', 'post_by_default')
]
];
2014-06-10 18:13:11 +00:00
}
2012-12-22 20:36:35 +00:00
}
function tumblr_settings(array &$data)
{
2022-10-20 21:51:49 +00:00
if (!DI::userSession()->getLocalUserId()) {
2014-06-10 18:13:11 +00:00
return;
}
2012-12-22 20:36:35 +00:00
2022-10-20 21:51:49 +00:00
$enabled = DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'tumblr', 'post', false);
$def_enabled = DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'tumblr', 'post_by_default', false);
2012-12-22 20:36:35 +00:00
2022-10-20 21:51:49 +00:00
$oauth_token = DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'tumblr', 'oauth_token');
$oauth_token_secret = DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'tumblr', 'oauth_token_secret');
2012-12-22 20:36:35 +00:00
if ($oauth_token && $oauth_token_secret) {
2022-10-20 21:51:49 +00:00
$page = DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'tumblr', 'page');
$consumer_key = DI::config()->get('tumblr', 'consumer_key');
$consumer_secret = DI::config()->get('tumblr', 'consumer_secret');
2012-12-22 20:36:35 +00:00
2014-06-10 18:13:11 +00:00
$tum_oauth = new TumblrOAuth($consumer_key, $consumer_secret, $oauth_token, $oauth_token_secret);
$userinfo = $tum_oauth->get('user/info');
2012-12-22 20:36:35 +00:00
$blogs = array_map(function ($blog) {
2023-03-05 21:17:14 +00:00
return substr(str_replace(['http://', 'https://'], ['', ''], $blog->url), 0, -1);
}, $userinfo->response->user->blogs);
2012-12-22 20:36:35 +00:00
$page_select = ['tumblr-page', DI::l10n()->t('Post to page:'), $page, '', $blogs];
}
2012-12-22 20:36:35 +00:00
$t = Renderer::getMarkupTemplate('connector_settings.tpl', 'addon/tumblr/');
$html = Renderer::replaceMacros($t, [
'$l10n' => [
'connect' => DI::l10n()->t('(Re-)Authenticate your tumblr page'),
'noconnect' => DI::l10n()->t('You are not authenticated to tumblr'),
],
'$authenticate_url' => DI::baseUrl() . '/tumblr/connect',
2012-12-22 20:36:35 +00:00
'$enable' => ['tumblr', DI::l10n()->t('Enable Tumblr Post Addon'), $enabled],
'$bydefault' => ['tumblr_bydefault', DI::l10n()->t('Post to Tumblr by default'), $def_enabled],
'$page_select' => $page_select ?? '',
]);
2012-12-22 20:36:35 +00:00
$data = [
'connector' => 'tumblr',
'title' => DI::l10n()->t('Tumblr Export'),
'image' => 'images/tumblr.png',
'enabled' => $enabled,
'html' => $html,
];
2012-12-22 20:36:35 +00:00
}
function tumblr_settings_post(array &$b)
{
if (!empty($_POST['tumblr-submit'])) {
2022-10-20 21:51:49 +00:00
DI::pConfig()->set(DI::userSession()->getLocalUserId(), 'tumblr', 'post', intval($_POST['tumblr']));
DI::pConfig()->set(DI::userSession()->getLocalUserId(), 'tumblr', 'page', $_POST['tumblr_page']);
DI::pConfig()->set(DI::userSession()->getLocalUserId(), 'tumblr', 'post_by_default', intval($_POST['tumblr_bydefault']));
2012-12-22 20:36:35 +00:00
}
}
function tumblr_hook_fork(array &$b)
{
if ($b['name'] != 'notifier_normal') {
return;
}
$post = $b['data'];
2023-03-05 21:17:14 +00:00
if (
$post['deleted'] || $post['private'] || ($post['created'] !== $post['edited']) ||
!strstr($post['postopts'] ?? '', 'tumblr') || ($post['parent'] != $post['id'])
) {
$b['execute'] = false;
return;
}
}
function tumblr_post_local(array &$b)
{
2012-12-22 20:36:35 +00:00
// This can probably be changed to allow editing by pointing to a different API endpoint
if ($b['edit']) {
2012-12-22 20:36:35 +00:00
return;
}
2012-12-22 20:36:35 +00:00
2022-10-20 21:51:49 +00:00
if (!DI::userSession()->getLocalUserId() || (DI::userSession()->getLocalUserId() != $b['uid'])) {
2012-12-22 20:36:35 +00:00
return;
}
2012-12-22 20:36:35 +00:00
if ($b['private'] || $b['parent']) {
2012-12-22 20:36:35 +00:00
return;
}
2012-12-22 20:36:35 +00:00
2022-10-20 21:51:49 +00:00
$tmbl_post = intval(DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'tumblr', 'post'));
2012-12-22 20:36:35 +00:00
$tmbl_enable = (($tmbl_post && !empty($_REQUEST['tumblr_enable'])) ? intval($_REQUEST['tumblr_enable']) : 0);
2012-12-22 20:36:35 +00:00
2022-10-20 21:51:49 +00:00
if ($b['api_source'] && intval(DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'tumblr', 'post_by_default'))) {
2012-12-22 20:36:35 +00:00
$tmbl_enable = 1;
}
2012-12-22 20:36:35 +00:00
if (!$tmbl_enable) {
2014-06-10 18:13:11 +00:00
return;
}
2012-12-22 20:36:35 +00:00
if (strlen($b['postopts'])) {
2014-06-10 18:13:11 +00:00
$b['postopts'] .= ',';
}
2014-06-10 18:13:11 +00:00
$b['postopts'] .= 'tumblr';
2012-12-22 20:36:35 +00:00
}
2023-03-05 21:17:14 +00:00
function tumblr_send(array &$b)
{
if ($b['deleted'] || $b['private'] || ($b['created'] !== $b['edited'])) {
2014-06-10 18:13:11 +00:00
return;
2018-01-10 03:27:40 +00:00
}
2012-12-22 20:36:35 +00:00
2023-03-05 21:17:14 +00:00
if (!strstr($b['postopts'], 'tumblr')) {
2014-06-10 18:13:11 +00:00
return;
2018-01-10 03:27:40 +00:00
}
2012-12-22 20:36:35 +00:00
2023-03-05 21:17:14 +00:00
if ($b['gravity'] != Item::GRAVITY_PARENT) {
return;
}
2023-03-09 06:37:02 +00:00
$b['body'] = BBCode::removeAttachment($b['body']);
2023-03-05 21:17:14 +00:00
$oauth_token = DI::pConfig()->get($b['uid'], 'tumblr', 'oauth_token');
$oauth_token_secret = DI::pConfig()->get($b['uid'], 'tumblr', 'oauth_token_secret');
$page = DI::pConfig()->get($b['uid'], 'tumblr', 'page');
$tmbl_blog = 'blog/' . $page . '/post';
2012-12-22 20:36:35 +00:00
if ($oauth_token && $oauth_token_secret && $tmbl_blog) {
2020-05-05 22:47:43 +00:00
$tags = Tag::getByURIId($b['uri-id']);
2018-01-15 13:15:33 +00:00
$tag_arr = [];
2012-12-22 20:36:35 +00:00
2023-03-05 21:17:14 +00:00
foreach ($tags as $tag) {
2020-05-05 22:47:43 +00:00
$tag_arr[] = $tag['name'];
2012-12-22 20:36:35 +00:00
}
if (count($tag_arr)) {
$tags = implode(',', $tag_arr);
}
2012-12-22 20:36:35 +00:00
$title = trim($b['title']);
2023-03-05 21:17:14 +00:00
$media = Post\Media::getByURIId($b['uri-id'], [Post\Media::HTML, Post\Media::AUDIO, Post\Media::VIDEO, Post\Media::IMAGE]);
$photo = array_search(Post\Media::IMAGE, array_column($media, 'type'));
$link = array_search(Post\Media::HTML, array_column($media, 'type'));
$audio = array_search(Post\Media::AUDIO, array_column($media, 'type'));
$video = array_search(Post\Media::VIDEO, array_column($media, 'type'));
2012-12-22 20:36:35 +00:00
2018-01-15 13:15:33 +00:00
$params = [
'state' => 'published',
'tags' => $tags,
'tweet' => 'off',
'format' => 'html',
];
2012-12-22 20:36:35 +00:00
2023-03-05 21:17:14 +00:00
$body = BBCode::removeShareInformation($b['body']);
$body = Post\Media::removeFromEndOfBody($body);
2023-03-09 06:37:02 +00:00
if ($photo !== false) {
2023-03-05 21:17:14 +00:00
$params['type'] = 'photo';
2023-03-09 06:37:02 +00:00
$params['caption'] = BBCode::convertForUriId($b['uri-id'], $body, BBCode::CONNECTORS);
$params['data'] = [];
foreach ($media as $photo) {
if ($photo['type'] == Post\Media::IMAGE) {
if (Network::isLocalLink($photo['url']) && ($data = Photo::getResourceData($photo['url']))) {
$photo = Photo::selectFirst([], ["`resource-id` = ? AND `scale` > ?", $data['guid'], 0]);
if (!empty($photo)) {
$params['data'][] = Photo::getImageDataForPhoto($photo);
}
}
}
2023-03-05 21:17:14 +00:00
}
2023-03-09 06:37:02 +00:00
} elseif ($link !== false) {
2023-03-05 21:17:14 +00:00
$params['type'] = 'link';
2023-03-06 00:49:30 +00:00
$params['title'] = $media[$link]['name'];
$params['url'] = $media[$link]['url'];
2023-03-05 21:17:14 +00:00
$params['description'] = BBCode::convertForUriId($b['uri-id'], $body, BBCode::CONNECTORS);
2023-03-06 00:49:30 +00:00
if (!empty($media[$link]['preview'])) {
$params['thumbnail'] = $media[$link]['preview'];
2023-03-05 21:17:14 +00:00
}
2023-03-06 00:49:30 +00:00
if (!empty($media[$link]['description'])) {
$params['excerpt'] = $media[$link]['description'];
2023-03-05 21:17:14 +00:00
}
2023-03-06 00:49:30 +00:00
if (!empty($media[$link]['author-name'])) {
$params['author'] = $media[$link]['author-name'];
2023-03-05 21:17:14 +00:00
}
2023-03-09 06:37:02 +00:00
} elseif ($audio !== false) {
2023-03-05 21:17:14 +00:00
$params['type'] = 'audio';
2023-03-06 00:49:30 +00:00
$params['external_url'] = $media[$audio]['url'];
2023-03-05 21:17:14 +00:00
$params['caption'] = BBCode::convertForUriId($b['uri-id'], $body, BBCode::CONNECTORS);
2023-03-09 06:37:02 +00:00
} elseif ($video !== false) {
2023-03-05 21:17:14 +00:00
$params['type'] = 'video';
2023-03-06 00:49:30 +00:00
$params['embed'] = $media[$video]['url'];
2023-03-05 21:17:14 +00:00
$params['caption'] = BBCode::convertForUriId($b['uri-id'], $body, BBCode::CONNECTORS);
} else {
$params['type'] = 'text';
$params['title'] = $title;
$params['body'] = BBCode::convertForUriId($b['uri-id'], $b['body'], BBCode::CONNECTORS);
2012-12-22 20:36:35 +00:00
}
2023-03-05 21:17:14 +00:00
if (isset($params['caption']) && (trim($title) != '')) {
$params['caption'] = '<h1>' . $title . '</h1>' .
'<p>' . $params['caption'] . '</p>';
}
2023-03-05 21:17:14 +00:00
$consumer_key = DI::config()->get('tumblr', 'consumer_key');
$consumer_secret = DI::config()->get('tumblr', 'consumer_secret');
2012-12-22 20:36:35 +00:00
$tum_oauth = new TumblrOAuth($consumer_key, $consumer_secret, $oauth_token, $oauth_token_secret);
// Make an API call with the TumblrOAuth instance.
2023-03-05 21:17:14 +00:00
$x = $tum_oauth->post($tmbl_blog, $params);
2012-12-22 20:36:35 +00:00
$ret_code = $tum_oauth->http_code;
if ($ret_code == 201) {
2023-03-09 06:37:02 +00:00
Logger::info('success', ['blog' => $tmbl_blog, 'params' => $params]);
} elseif ($ret_code == 403) {
2023-03-09 06:37:02 +00:00
Logger::notice('authentication failure', ['blog' => $tmbl_blog, 'params' => $params]);
} else {
2023-03-09 06:37:02 +00:00
Logger::notice('general error', ['blog' => $tmbl_blog, 'params' => $params, 'error' => $x]);
}
2012-12-22 20:36:35 +00:00
}
}