3 * Name: Tumblr Post Connector
4 * Description: Post to Tumblr
6 * Author: Mike Macgirvin <http://macgirvin.com/profile/mike>
7 * Author: Michael Vogel <https://pirati.ca/profile/heluecht>
10 require_once __DIR__ . DIRECTORY_SEPARATOR . 'library' . DIRECTORY_SEPARATOR . 'tumblroauth.php';
13 use Friendica\Content\Text\BBCode;
14 use Friendica\Core\Config;
15 use Friendica\Core\Hook;
16 use Friendica\Core\L10n;
17 use Friendica\Core\Logger;
18 use Friendica\Core\PConfig;
19 use Friendica\Core\Renderer;
20 use Friendica\Database\DBA;
21 use Friendica\Util\Strings;
23 function tumblr_install()
25 Hook::register('hook_fork', 'addon/tumblr/tumblr.php', 'tumblr_hook_fork');
26 Hook::register('post_local', 'addon/tumblr/tumblr.php', 'tumblr_post_local');
27 Hook::register('notifier_normal', 'addon/tumblr/tumblr.php', 'tumblr_send');
28 Hook::register('jot_networks', 'addon/tumblr/tumblr.php', 'tumblr_jot_nets');
29 Hook::register('connector_settings', 'addon/tumblr/tumblr.php', 'tumblr_settings');
30 Hook::register('connector_settings_post', 'addon/tumblr/tumblr.php', 'tumblr_settings_post');
33 function tumblr_uninstall()
35 Hook::unregister('hook_fork', 'addon/tumblr/tumblr.php', 'tumblr_hook_fork');
36 Hook::unregister('post_local', 'addon/tumblr/tumblr.php', 'tumblr_post_local');
37 Hook::unregister('notifier_normal', 'addon/tumblr/tumblr.php', 'tumblr_send');
38 Hook::unregister('jot_networks', 'addon/tumblr/tumblr.php', 'tumblr_jot_nets');
39 Hook::unregister('connector_settings', 'addon/tumblr/tumblr.php', 'tumblr_settings');
40 Hook::unregister('connector_settings_post', 'addon/tumblr/tumblr.php', 'tumblr_settings_post');
43 function tumblr_module()
47 function tumblr_content(App $a)
50 notice(L10n::t('Permission denied.') . EOL);
54 if (isset($a->argv[1])) {
55 switch ($a->argv[1]) {
57 $o = tumblr_connect($a);
61 $o = tumblr_callback($a);
65 $o = print_r($a->argv, true);
69 $o = tumblr_connect($a);
75 function tumblr_addon_admin(App $a, &$o)
77 $t = Renderer::getMarkupTemplate( "admin.tpl", "addon/tumblr/" );
79 $o = Renderer::replaceMacros($t, [
80 '$submit' => L10n::t('Save Settings'),
81 // name, label, value, help, [extra values]
82 '$consumer_key' => ['consumer_key', L10n::t('Consumer Key'), Config::get('tumblr', 'consumer_key' ), ''],
83 '$consumer_secret' => ['consumer_secret', L10n::t('Consumer Secret'), Config::get('tumblr', 'consumer_secret' ), ''],
87 function tumblr_addon_admin_post(App $a)
89 $consumer_key = (!empty($_POST['consumer_key']) ? Strings::escapeTags(trim($_POST['consumer_key'])) : '');
90 $consumer_secret = (!empty($_POST['consumer_secret']) ? Strings::escapeTags(trim($_POST['consumer_secret'])): '');
92 Config::set('tumblr', 'consumer_key',$consumer_key);
93 Config::set('tumblr', 'consumer_secret',$consumer_secret);
95 info(L10n::t('Settings updated.'). EOL);
98 function tumblr_connect(App $a)
100 // Start a session. This is necessary to hold on to a few keys the callback script will also need
103 // Include the TumblrOAuth library
104 //require_once('addon/tumblr/tumblroauth/tumblroauth.php');
106 // Define the needed keys
107 $consumer_key = Config::get('tumblr', 'consumer_key');
108 $consumer_secret = Config::get('tumblr', 'consumer_secret');
110 // The callback URL is the script that gets called after the user authenticates with tumblr
111 // In this example, it would be the included callback.php
112 $callback_url = $a->getBaseURL()."/tumblr/callback";
114 // Let's begin. First we need a Request Token. The request token is required to send the user
115 // to Tumblr's login page.
117 // Create a new instance of the TumblrOAuth library. For this step, all we need to give the library is our
118 // Consumer Key and Consumer Secret
119 $tum_oauth = new TumblrOAuth($consumer_key, $consumer_secret);
121 // Ask Tumblr for a Request Token. Specify the Callback URL here too (although this should be optional)
122 $request_token = $tum_oauth->getRequestToken($callback_url);
124 // Store the request token and Request Token Secret as out callback.php script will need this
125 $_SESSION['request_token'] = $token = $request_token['oauth_token'];
126 $_SESSION['request_token_secret'] = $request_token['oauth_token_secret'];
128 // Check the HTTP Code. It should be a 200 (OK), if it's anything else then something didn't work.
129 switch ($tum_oauth->http_code) {
131 // Ask Tumblr to give us a special address to their login page
132 $url = $tum_oauth->getAuthorizeURL($token);
134 // Redirect the user to the login URL given to us by Tumblr
135 header('Location: ' . $url);
138 * That's it for our side. The user is sent to a Tumblr Login page and
139 * asked to authroize our app. After that, Tumblr sends the user back to
140 * our Callback URL (callback.php) along with some information we need to get
146 // Give an error message
147 $o = 'Could not connect to Tumblr. Refresh the page or try again later.';
153 function tumblr_callback(App $a)
155 // Start a session, load the library
157 //require_once('addon/tumblr/tumblroauth/tumblroauth.php');
159 // Define the needed keys
160 $consumer_key = Config::get('tumblr', 'consumer_key');
161 $consumer_secret = Config::get('tumblr', 'consumer_secret');
163 // Once the user approves your app at Tumblr, they are sent back to this script.
164 // This script is passed two parameters in the URL, oauth_token (our Request Token)
165 // and oauth_verifier (Key that we need to get Access Token).
166 // We'll also need out Request Token Secret, which we stored in a session.
168 // Create instance of TumblrOAuth.
169 // It'll need our Consumer Key and Secret as well as our Request Token and Secret
170 $tum_oauth = new TumblrOAuth($consumer_key, $consumer_secret, $_SESSION['request_token'], $_SESSION['request_token_secret']);
172 // Ok, let's get an Access Token. We'll need to pass along our oauth_verifier which was given to us in the URL.
173 $access_token = $tum_oauth->getAccessToken($_REQUEST['oauth_verifier']);
175 // We're done with the Request Token and Secret so let's remove those.
176 unset($_SESSION['request_token']);
177 unset($_SESSION['request_token_secret']);
179 // Make sure nothing went wrong.
180 if (200 == $tum_oauth->http_code) {
183 return 'Unable to authenticate';
186 // What's next? Now that we have an Access Token and Secret, we can make an API call.
187 PConfig::set(local_user(), "tumblr", "oauth_token", $access_token['oauth_token']);
188 PConfig::set(local_user(), "tumblr", "oauth_token_secret", $access_token['oauth_token_secret']);
190 $o = L10n::t("You are now authenticated to tumblr.");
191 $o .= '<br /><a href="'.$a->getBaseURL().'/settings/connectors">'.L10n::t("return to the connector page").'</a>';
196 function tumblr_jot_nets(App $a, &$b)
198 if (! local_user()) {
202 $tmbl_post = PConfig::get(local_user(), 'tumblr', 'post');
204 if (intval($tmbl_post) == 1) {
205 $tmbl_defpost = PConfig::get(local_user(), 'tumblr', 'post_by_default');
206 $selected = ((intval($tmbl_defpost) == 1) ? ' checked="checked" ' : '');
207 $b .= '<div class="profile-jot-net"><input type="checkbox" name="tumblr_enable"' . $selected . ' value="1" /> '
208 . L10n::t('Post to Tumblr') . '</div>';
212 function tumblr_settings(App $a, &$s)
214 if (! local_user()) {
218 /* Add our stylesheet to the page so we can make our settings look nice */
220 $a->page['htmlhead'] .= '<link rel="stylesheet" type="text/css" href="' . $a->getBaseURL() . '/addon/tumblr/tumblr.css' . '" media="all" />' . "\r\n";
222 /* Get the current state of our config variables */
224 $enabled = PConfig::get(local_user(), 'tumblr', 'post');
225 $checked = (($enabled) ? ' checked="checked" ' : '');
226 $css = (($enabled) ? '' : '-disabled');
228 $def_enabled = PConfig::get(local_user(), 'tumblr', 'post_by_default');
230 $def_checked = (($def_enabled) ? ' checked="checked" ' : '');
232 /* Add some HTML to the existing form */
234 $s .= '<span id="settings_tumblr_inflated" class="settings-block fakelink" style="display: block;" onclick="openClose(\'settings_tumblr_expanded\'); openClose(\'settings_tumblr_inflated\');">';
235 $s .= '<img class="connector'.$css.'" src="images/tumblr.png" /><h3 class="connector">'. L10n::t('Tumblr Export').'</h3>';
237 $s .= '<div id="settings_tumblr_expanded" class="settings-block" style="display: none;">';
238 $s .= '<span class="fakelink" onclick="openClose(\'settings_tumblr_expanded\'); openClose(\'settings_tumblr_inflated\');">';
239 $s .= '<img class="connector'.$css.'" src="images/tumblr.png" /><h3 class="connector">'. L10n::t('Tumblr Export').'</h3>';
242 $s .= '<div id="tumblr-username-wrapper">';
243 $s .= '<a href="'.$a->getBaseURL().'/tumblr/connect">'.L10n::t("(Re-)Authenticate your tumblr page").'</a>';
244 $s .= '</div><div class="clear"></div>';
246 $s .= '<div id="tumblr-enable-wrapper">';
247 $s .= '<label id="tumblr-enable-label" for="tumblr-checkbox">' . L10n::t('Enable Tumblr Post Addon') . '</label>';
248 $s .= '<input id="tumblr-checkbox" type="checkbox" name="tumblr" value="1" ' . $checked . '/>';
249 $s .= '</div><div class="clear"></div>';
251 $s .= '<div id="tumblr-bydefault-wrapper">';
252 $s .= '<label id="tumblr-bydefault-label" for="tumblr-bydefault">' . L10n::t('Post to Tumblr by default') . '</label>';
253 $s .= '<input id="tumblr-bydefault" type="checkbox" name="tumblr_bydefault" value="1" ' . $def_checked . '/>';
254 $s .= '</div><div class="clear"></div>';
256 $oauth_token = PConfig::get(local_user(), "tumblr", "oauth_token");
257 $oauth_token_secret = PConfig::get(local_user(), "tumblr", "oauth_token_secret");
259 $s .= '<div id="tumblr-page-wrapper">';
261 if (($oauth_token != "") && ($oauth_token_secret != "")) {
262 $page = PConfig::get(local_user(), 'tumblr', 'page');
263 $consumer_key = Config::get('tumblr', 'consumer_key');
264 $consumer_secret = Config::get('tumblr', 'consumer_secret');
266 $tum_oauth = new TumblrOAuth($consumer_key, $consumer_secret, $oauth_token, $oauth_token_secret);
268 $userinfo = $tum_oauth->get('user/info');
272 $s .= '<label id="tumblr-page-label" for="tumblr-page">' . L10n::t('Post to page:') . '</label>';
273 $s .= '<select name="tumblr_page" id="tumblr-page">';
274 foreach($userinfo->response->user->blogs as $blog) {
275 $blogurl = substr(str_replace(["http://", "https://"], ["", ""], $blog->url), 0, -1);
277 if ($page == $blogurl) {
278 $s .= "<option value='".$blogurl."' selected>".$blogurl."</option>";
280 $s .= "<option value='".$blogurl."'>".$blogurl."</option>";
286 $s .= L10n::t("You are not authenticated to tumblr");
289 $s .= '</div><div class="clear"></div>';
291 /* provide a submit button */
292 $s .= '<div class="settings-submit-wrapper" ><input type="submit" id="tumblr-submit" name="tumblr-submit" class="settings-submit" value="' . L10n::t('Save Settings') . '" /></div></div>';
295 function tumblr_settings_post(App $a, array &$b)
297 if (!empty($_POST['tumblr-submit'])) {
298 PConfig::set(local_user(), 'tumblr', 'post', intval($_POST['tumblr']));
299 PConfig::set(local_user(), 'tumblr', 'page', $_POST['tumblr_page']);
300 PConfig::set(local_user(), 'tumblr', 'post_by_default', intval($_POST['tumblr_bydefault']));
304 function tumblr_hook_fork(&$a, &$b)
306 if ($b['name'] != 'notifier_normal') {
312 if ($post['deleted'] || $post['private'] || ($post['created'] !== $post['edited']) ||
313 !strstr($post['postopts'], 'tumblr') || ($post['parent'] != $post['id'])) {
314 $b['execute'] = false;
319 function tumblr_post_local(App $a, array &$b)
321 // This can probably be changed to allow editing by pointing to a different API endpoint
327 if (!local_user() || (local_user() != $b['uid'])) {
331 if ($b['private'] || $b['parent']) {
335 $tmbl_post = intval(PConfig::get(local_user(), 'tumblr', 'post'));
337 $tmbl_enable = (($tmbl_post && !empty($_REQUEST['tumblr_enable'])) ? intval($_REQUEST['tumblr_enable']) : 0);
339 if ($b['api_source'] && intval(PConfig::get(local_user(), 'tumblr', 'post_by_default'))) {
347 if (strlen($b['postopts'])) {
348 $b['postopts'] .= ',';
351 $b['postopts'] .= 'tumblr';
357 function tumblr_send(App $a, array &$b) {
359 if ($b['deleted'] || $b['private'] || ($b['created'] !== $b['edited'])) {
363 if (! strstr($b['postopts'],'tumblr')) {
367 if ($b['parent'] != $b['id']) {
371 // Dont't post if the post doesn't belong to us.
372 // This is a check for forum postings
373 $self = DBA::selectFirst('contact', ['id'], ['uid' => $b['uid'], 'self' => true]);
374 if ($b['contact-id'] != $self['id']) {
378 $oauth_token = PConfig::get($b['uid'], "tumblr", "oauth_token");
379 $oauth_token_secret = PConfig::get($b['uid'], "tumblr", "oauth_token_secret");
380 $page = PConfig::get($b['uid'], "tumblr", "page");
381 $tmbl_blog = 'blog/' . $page . '/post';
383 if ($oauth_token && $oauth_token_secret && $tmbl_blog) {
386 preg_match_all('/\#\[(.*?)\](.*?)\[/', $b['tag'], $matches, PREG_SET_ORDER);
388 if (!empty($matches)) {
389 foreach($matches as $mtch) {
390 $tag_arr[] = $mtch[2];
394 if (count($tag_arr)) {
395 $tags = implode(',', $tag_arr);
398 $title = trim($b['title']);
400 $siteinfo = BBCode::getAttachedData($b["body"]);
403 'state' => 'published',
409 if (!isset($siteinfo["type"])) {
410 $siteinfo["type"] = "";
413 if (($title == "") && isset($siteinfo["title"])) {
414 $title = $siteinfo["title"];
417 if (isset($siteinfo["text"])) {
418 $body = $siteinfo["text"];
420 $body = BBCode::removeShareInformation($b["body"]);
423 switch ($siteinfo["type"]) {
425 $params['type'] = "photo";
426 $params['caption'] = BBCode::convert($body, false, 4);
428 if (isset($siteinfo["url"])) {
429 $params['link'] = $siteinfo["url"];
432 $params['source'] = $siteinfo["image"];
436 $params['type'] = "link";
437 $params['title'] = $title;
438 $params['url'] = $siteinfo["url"];
439 $params['description'] = BBCode::convert($body, false, 4);
443 $params['type'] = "audio";
444 $params['external_url'] = $siteinfo["url"];
445 $params['caption'] = BBCode::convert($body, false, 4);
449 $params['type'] = "video";
450 $params['embed'] = $siteinfo["url"];
451 $params['caption'] = BBCode::convert($body, false, 4);
455 $params['type'] = "text";
456 $params['title'] = $title;
457 $params['body'] = BBCode::convert($b['body'], false, 4);
461 if (isset($params['caption']) && (trim($title) != "")) {
462 $params['caption'] = '<h1>'.$title."</h1>".
463 "<p>".$params['caption']."</p>";
466 if (empty($params['caption']) && !empty($siteinfo["description"])) {
467 $params['caption'] = BBCode::convert("[quote]" . $siteinfo["description"] . "[/quote]", false, 4);
470 $consumer_key = Config::get('tumblr','consumer_key');
471 $consumer_secret = Config::get('tumblr','consumer_secret');
473 $tum_oauth = new TumblrOAuth($consumer_key, $consumer_secret, $oauth_token, $oauth_token_secret);
475 // Make an API call with the TumblrOAuth instance.
476 $x = $tum_oauth->post($tmbl_blog,$params);
477 $ret_code = $tum_oauth->http_code;
480 if ($ret_code == 201) {
481 Logger::log('tumblr_send: success');
482 } elseif ($ret_code == 403) {
483 Logger::log('tumblr_send: authentication failure');
485 Logger::log('tumblr_send: general error: ' . print_r($x,true));