mailstream/mailstream.php

   1 <?php
   2 /**
   3  * Name: Mail Stream
   4  * Description: Mail all items coming into your network feed to an email address
   5  * Version: 1.1
   6  * Author: Matthew Exon <http://mat.exon.name>
   7  */
   8
   9 use Friendica\Content\Text\BBCode;
  10 use Friendica\Core\Hook;
  11 use Friendica\Core\Logger;
  12 use Friendica\Core\Renderer;
  13 use Friendica\Database\DBA;
  14 use Friendica\DI;
  15 use Friendica\Protocol\Activity;
  16 use Friendica\Util\Network;
  17 use Friendica\Model\Item;
  18
  19 function mailstream_install() {
  20         Hook::register('addon_settings', 'addon/mailstream/mailstream.php', 'mailstream_addon_settings');
  21         Hook::register('addon_settings_post', 'addon/mailstream/mailstream.php', 'mailstream_addon_settings_post');
  22         Hook::register('post_local_end', 'addon/mailstream/mailstream.php', 'mailstream_post_hook');
  23         Hook::register('post_remote_end', 'addon/mailstream/mailstream.php', 'mailstream_post_hook');
  24         Hook::register('cron', 'addon/mailstream/mailstream.php', 'mailstream_cron');
  25
  26         if (DI::config()->get('mailstream', 'dbversion') == '0.1') {
  27                 q('ALTER TABLE `mailstream_item` DROP INDEX `uid`');
  28                 q('ALTER TABLE `mailstream_item` DROP INDEX `contact-id`');
  29                 q('ALTER TABLE `mailstream_item` DROP INDEX `plink`');
  30                 q('ALTER TABLE `mailstream_item` CHANGE `plink` `uri` char(255) NOT NULL');
  31                 DI::config()->set('mailstream', 'dbversion', '0.2');
  32         }
  33         if (DI::config()->get('mailstream', 'dbversion') == '0.2') {
  34                 q('DELETE FROM `pconfig` WHERE `cat` = "mailstream" AND `k` = "delay"');
  35                 DI::config()->set('mailstream', 'dbversion', '0.3');
  36         }
  37         if (DI::config()->get('mailstream', 'dbversion') == '0.3') {
  38                 q('ALTER TABLE `mailstream_item` CHANGE `created` `created` timestamp NOT NULL DEFAULT now()');
  39                 q('ALTER TABLE `mailstream_item` CHANGE `completed` `completed` timestamp NULL DEFAULT NULL');
  40                 DI::config()->set('mailstream', 'dbversion', '0.4');
  41         }
  42         if (DI::config()->get('mailstream', 'dbversion') == '0.4') {
  43                 q('ALTER TABLE `mailstream_item` CONVERT TO CHARACTER SET utf8 COLLATE utf8_bin');
  44                 DI::config()->set('mailstream', 'dbversion', '0.5');
  45         }
  46         if (DI::config()->get('mailstream', 'dbversion') == '0.5') {
  47                 DI::config()->set('mailstream', 'dbversion', '1.0');
  48         }
  49
  50         if (DI::config()->get('retriever', 'dbversion') != '1.0') {
  51                 $schema = file_get_contents(dirname(__file__).'/database.sql');
  52                 $arr = explode(';', $schema);
  53                 foreach ($arr as $a) {
  54                         $r = q($a);
  55                 }
  56                 DI::config()->set('mailstream', 'dbversion', '1.0');
  57         }
  58 }
  59
  60 function mailstream_uninstall() {
  61         Hook::unregister('addon_settings', 'addon/mailstream/mailstream.php', 'mailstream_addon_settings');
  62         Hook::unregister('addon_settings_post', 'addon/mailstream/mailstream.php', 'mailstream_addon_settings_post');
  63         Hook::unregister('post_local', 'addon/mailstream/mailstream.php', 'mailstream_post_local_hook');
  64         Hook::unregister('post_remote', 'addon/mailstream/mailstream.php', 'mailstream_post_remote_hook');
  65         Hook::unregister('post_local_end', 'addon/mailstream/mailstream.php', 'mailstream_post_local_hook');
  66         Hook::unregister('post_remote_end', 'addon/mailstream/mailstream.php', 'mailstream_post_remote_hook');
  67         Hook::unregister('post_local_end', 'addon/mailstream/mailstream.php', 'mailstream_post_hook');
  68         Hook::unregister('post_remote_end', 'addon/mailstream/mailstream.php', 'mailstream_post_hook');
  69         Hook::unregister('cron', 'addon/mailstream/mailstream.php', 'mailstream_cron');
  70         Hook::unregister('incoming_mail', 'addon/mailstream/mailstream.php', 'mailstream_incoming_mail');
  71 }
  72
  73 function mailstream_module() {}
  74
  75 function mailstream_addon_admin(&$a,&$o) {
  76         $frommail = DI::config()->get('mailstream', 'frommail');
  77         $template = Renderer::getMarkupTemplate('admin.tpl', 'addon/mailstream/');
  78         $config = ['frommail',
  79                         DI::l10n()->t('From Address'),
  80                         $frommail,
  81                         DI::l10n()->t('Email address that stream items will appear to be from.')];
  82         $o .= Renderer::replaceMacros($template, [
  83                                  '$frommail' => $config,
  84                                  '$submit' => DI::l10n()->t('Save Settings')]);
  85 }
  86
  87 function mailstream_addon_admin_post ($a) {
  88         if (!empty($_POST['frommail'])) {
  89                 DI::config()->set('mailstream', 'frommail', $_POST['frommail']);
  90         }
  91 }
  92
  93 function mailstream_generate_id($a, $uri) {
  94         // http://www.jwz.org/doc/mid.html
  95         $host = DI::baseUrl()->getHostname();
  96         $resource = hash('md5', $uri);
  97         $message_id = "<" . $resource . "@" . $host . ">";
  98         Logger::debug('mailstream: Generated message ID ' . $message_id . ' for URI ' . $uri);
  99         return $message_id;
 100 }
 101
 102 function mailstream_post_hook(&$a, &$item) {
 103         if (!DI::pConfig()->get($item['uid'], 'mailstream', 'enabled')) {
 104                 Logger::debug('mailstream: not enabled for item ' . $item['id']);
 105                 return;
 106         }
 107         if (!$item['uid']) {
 108                 Logger::debug('mailstream: no uid for item ' . $item['id']);
 109                 return;
 110         }
 111         if (!$item['contact-id']) {
 112                 Logger::debug('mailstream: no contact-id for item ' . $item['id']);
 113                 return;
 114         }
 115         if (!$item['uri']) {
 116                 Logger::debug('mailstream: no uri for item ' . $item['id']);
 117                 return;
 118         }
 119         if (!$item['plink']) {
 120                 Logger::debug('mailstream: no plink for item ' . $item['id']);
 121                 return;
 122         }
 123         if (DI::pConfig()->get($item['uid'], 'mailstream', 'nolikes')) {
 124                 if ($item['verb'] == Activity::LIKE) {
 125                         Logger::debug('mailstream: like item ' . $item['id']);
 126                         return;
 127                 }
 128         }
 129
 130         $message_id = mailstream_generate_id($a, $item['uri']);
 131         q("INSERT INTO `mailstream_item` (`uid`, `contact-id`, `uri`, `message-id`) " .
 132                 "VALUES (%d, '%s', '%s', '%s')", intval($item['uid']),
 133                 intval($item['contact-id']), DBA::escape($item['uri']), DBA::escape($message_id));
 134         $r = q('SELECT * FROM `mailstream_item` WHERE `uid` = %d AND `contact-id` = %d AND `uri` = "%s"', intval($item['uid']), intval($item['contact-id']), DBA::escape($item['uri']));
 135         if (count($r) != 1) {
 136                 Logger::info('mailstream_post_remote_hook: Unexpected number of items returned from mailstream_item');
 137                 return;
 138         }
 139         $ms_item = $r[0];
 140         Logger::debug('mailstream_post_remote_hook: created mailstream_item ' . $ms_item['id'] . ' for item ' . $item['uri'] . ' ' . $item['uid'] . ' ' . $item['contact-id']);
 141         $user = mailstream_get_user($item['uid']);
 142         if (!$user) {
 143                 Logger::info('mailstream_post_remote_hook: no user ' . $item['uid']);
 144                 return;
 145         }
 146         mailstream_send($a, $ms_item['message-id'], $item, $user);
 147 }
 148
 149 function mailstream_get_user($uid) {
 150         $r = q('SELECT * FROM `user` WHERE `uid` = %d', intval($uid));
 151         if (count($r) != 1) {
 152                 Logger::info('mailstream_post_remote_hook: Unexpected number of users returned');
 153                 return;
 154         }
 155         return $r[0];
 156 }
 157
 158 function mailstream_do_images($a, &$item, &$attachments) {
 159         if (!DI::pConfig()->get($item['uid'], 'mailstream', 'attachimg')) {
 160                 return;
 161         }
 162         $attachments = [];
 163         preg_match_all("/\[img\=([0-9]*)x([0-9]*)\](.*?)\[\/img\]/ism", $item["body"], $matches1);
 164         preg_match_all("/\[img\](.*?)\[\/img\]/ism", $item["body"], $matches2);
 165         preg_match_all("/\[img\=([^\]]*)\]([^[]*)\[\/img\]/ism", $item["body"], $matches3);
 166         foreach (array_merge($matches1[3], $matches2[1], $matches3[1]) as $url) {
 167                 $components = parse_url($url);
 168                 if (!$components) {
 169                         continue;
 170                 }
 171                 $cookiejar = tempnam(get_temppath(), 'cookiejar-mailstream-');
 172                 $curlResult = Network::fetchUrlFull($url, true, 0, '', $cookiejar);
 173                 $attachments[$url] = [
 174                         'data' => $curlResult->getBody(),
 175                         'guid' => hash("crc32", $url),
 176                         'filename' => basename($components['path']),
 177                         'type' => $curlResult->getContentType()
 178                 ];
 179
 180                 if (strlen($attachments[$url]['data'])) {
 181                         $item['body'] = str_replace($url, 'cid:' . $attachments[$url]['guid'], $item['body']);
 182                         continue;
 183                 }
 184         }
 185         return $attachments;
 186 }
 187
 188 function mailstream_sender($item) {
 189         $r = q('SELECT * FROM `contact` WHERE `id` = %d', $item['contact-id']);
 190         if (DBA::isResult($r)) {
 191                 $contact = $r[0];
 192                 if ($contact['name'] != $item['author-name']) {
 193                         return $contact['name'] . ' - ' . $item['author-name'];
 194                 }
 195         }
 196         return $item['author-name'];
 197 }
 198
 199 function mailstream_decode_subject($subject) {
 200         $html = BBCode::convert($subject);
 201         if (!$html) {
 202                 return $subject;
 203         }
 204         $notags = strip_tags($html);
 205         if (!$notags) {
 206                 return $subject;
 207         }
 208         $noentity = html_entity_decode($notags);
 209         if (!$noentity) {
 210                 return $notags;
 211         }
 212         $nocodes = preg_replace_callback("/(&#[0-9]+;)/", function($m) { return mb_convert_encoding($m[1], "UTF-8", "HTML-ENTITIES"); }, $noentity);
 213         if (!$nocodes) {
 214                 return $noentity;
 215         }
 216         $trimmed = trim($nocodes);
 217         if (!$trimmed) {
 218                 return $nocodes;
 219         }
 220         return $trimmed;
 221 }
 222
 223 function mailstream_subject($item) {
 224         if ($item['title']) {
 225                 return mailstream_decode_subject($item['title']);
 226         }
 227         $parent = $item['thr-parent'];
 228         // Don't look more than 100 levels deep for a subject, in case of loops
 229         for ($i = 0; ($i < 100) && $parent; $i++) {
 230                 $parent_item = Item::selectFirst(['thr-parent', 'title'], ['uri' => $parent]);
 231                 if (!DBA::isResult($parent_item)) {
 232                         break;
 233                 }
 234                 if ($parent_item['thr-parent'] === $parent) {
 235                         break;
 236                 }
 237                 if ($parent_item['title']) {
 238                         return DI::l10n()->t('Re:') . ' ' . mailstream_decode_subject($parent_item['title']);
 239                 }
 240                 $parent = $parent_item['thr-parent'];
 241         }
 242         $r = q("SELECT * FROM `contact` WHERE `id` = %d AND `uid` = %d",
 243                 intval($item['contact-id']), intval($item['uid']));
 244         $contact = $r[0];
 245         if ($contact['network'] === 'dfrn') {
 246                 return DI::l10n()->t("Friendica post");
 247         }
 248         if ($contact['network'] === 'dspr') {
 249                 return DI::l10n()->t("Diaspora post");
 250         }
 251         if ($contact['network'] === 'face') {
 252                 $text = mailstream_decode_subject($item['body']);
 253                 // For some reason these do show up in Facebook
 254                 $text = preg_replace('/\xA0$/', '', $text);
 255                 $subject = (strlen($text) > 150) ? (substr($text, 0, 140) . '...') : $text;
 256                 return preg_replace('/\\s+/', ' ', $subject);
 257         }
 258         if ($contact['network'] === 'feed') {
 259                 return DI::l10n()->t("Feed item");
 260         }
 261         if ($contact['network'] === 'mail') {
 262                 return DI::l10n()->t("Email");
 263         }
 264         return DI::l10n()->t("Friendica Item");
 265 }
 266
 267 function mailstream_send(\Friendica\App $a, $message_id, $item, $user) {
 268         if (!$item['visible']) {
 269                 return;
 270         }
 271         if (!$message_id) {
 272                 return;
 273         }
 274         require_once(dirname(__file__).'/phpmailer/class.phpmailer.php');
 275
 276         $attachments = [];
 277         mailstream_do_images($a, $item, $attachments);
 278         $frommail = DI::config()->get('mailstream', 'frommail');
 279         if ($frommail == "") {
 280                 $frommail = 'friendica@localhost.local';
 281         }
 282         $address = DI::pConfig()->get($item['uid'], 'mailstream', 'address');
 283         if (!$address) {
 284                 $address = $user['email'];
 285         }
 286         $mail = new PHPmailer;
 287         try {
 288                 $mail->XMailer = 'Friendica Mailstream Addon';
 289                 $mail->SetFrom($frommail, mailstream_sender($item));
 290                 $mail->AddAddress($address, $user['username']);
 291                 $mail->MessageID = $message_id;
 292                 $mail->Subject = mailstream_subject($item);
 293                 if ($item['thr-parent'] != $item['uri']) {
 294                         $mail->addCustomHeader('In-Reply-To: ' . mailstream_generate_id($a, $item['thr-parent']));
 295                 }
 296                 $mail->addCustomHeader('X-Friendica-Mailstream-URI: ' . $item['uri']);
 297                 $mail->addCustomHeader('X-Friendica-Mailstream-Plink: ' . $item['plink']);
 298                 $encoding = 'base64';
 299                 foreach ($attachments as $url => $image) {
 300                         $mail->AddStringEmbeddedImage($image['data'], $image['guid'], $image['filename'], $encoding, $image['type']);
 301                 }
 302                 $mail->IsHTML(true);
 303                 $mail->CharSet = 'utf-8';
 304                 $template = Renderer::getMarkupTemplate('mail.tpl', 'addon/mailstream/');
 305                 $mail->AltBody = BBCode::toPlaintext($item['body']);
 306                 $item['body'] = BBCode::convert($item['body']);
 307                 $item['url'] = DI::baseUrl()->get() . '/display/' . $item['guid'];
 308                 $mail->Body = Renderer::replaceMacros($template, [
 309                                                  '$upstream' => DI::l10n()->t('Upstream'),
 310                                                  '$local' => DI::l10n()->t('Local'),
 311                                                  '$item' => $item]);
 312                 mailstream_html_wrap($mail->Body);
 313                 if (!$mail->Send()) {
 314                         throw new Exception($mail->ErrorInfo);
 315                 }
 316                 Logger::debug('mailstream_send sent message ' . $mail->MessageID . ' ' . $mail->Subject);
 317         } catch (phpmailerException $e) {
 318                 Logger::debug('mailstream_send PHPMailer exception sending message ' . $message_id . ': ' . $e->errorMessage());
 319         } catch (Exception $e) {
 320                 Logger::debug('mailstream_send exception sending message ' . $message_id . ': ' . $e->getMessage());
 321         }
 322         // In case of failure, still set the item to completed.  Otherwise
 323         // we'll just try to send it over and over again and it'll fail
 324         // every time.
 325         q('UPDATE `mailstream_item` SET `completed` = now() WHERE `message-id` = "%s"', DBA::escape($message_id));
 326 }
 327
 328 /**
 329  * Email tends to break if you send excessively long lines.  To make
 330  * bbcode's output suitable for transmission, we try to break things
 331  * up so that lines are about 200 characters.
 332  */
 333 function mailstream_html_wrap(&$text)
 334 {
 335         $lines = str_split($text, 200);
 336         for ($i = 0; $i < count($lines); $i++) {
 337                 $lines[$i] = preg_replace('/ /', "\n", $lines[$i], 1);
 338         }
 339         $text = implode($lines);
 340 }
 341
 342 function mailstream_cron($a, $b) {
 343         // Only process items older than an hour in cron.  This is because
 344         // we want to give mailstream_post_remote_hook a fair chance to
 345         // send the email itself before cron jumps in.  Only if
 346         // mailstream_post_remote_hook fails for some reason will this get
 347         // used, and in that case it's worth holding off a bit anyway.
 348         $ms_item_ids = q("SELECT `mailstream_item`.`message-id`, `mailstream_item`.`uri`, `item`.`id` FROM `mailstream_item` JOIN `item` ON (`mailstream_item`.`uid` = `item`.`uid` AND `mailstream_item`.`uri` = `item`.`uri` AND `mailstream_item`.`contact-id` = `item`.`contact-id`) WHERE `mailstream_item`.`completed` IS NULL AND `mailstream_item`.`created` < DATE_SUB(NOW(), INTERVAL 1 HOUR) AND `item`.`visible` = 1 ORDER BY `mailstream_item`.`created` LIMIT 100");
 349         Logger::debug('mailstream_cron processing ' . count($ms_item_ids) . ' items');
 350         foreach ($ms_item_ids as $ms_item_id) {
 351                 if (!$ms_item_id['message-id'] || !strlen($ms_item_id['message-id'])) {
 352                         Logger::info('mailstream_cron: Item ' . $ms_item_id['id'] . ' URI ' . $ms_item_id['uri'] . ' has no message-id');
 353                 }
 354                 $item = Item::selectFirst([], ['id' => $ms_item_id['id']]);
 355                 $users = q("SELECT * FROM `user` WHERE `uid` = %d", intval($item['uid']));
 356                 $user = $users[0];
 357                 if ($user && $item) {
 358                         mailstream_send($a, $ms_item_id['message-id'], $item, $user);
 359                 }
 360                 else {
 361                         Logger::info('mailstream_cron: Unable to find item ' . $ms_item_id['id']);
 362                         q("UPDATE `mailstream_item` SET `completed` = now() WHERE `message-id` = %d", intval($ms_item['message-id']));
 363                 }
 364         }
 365         mailstream_tidy();
 366 }
 367
 368 function mailstream_addon_settings(&$a,&$s) {
 369         $enabled = DI::pConfig()->get(local_user(), 'mailstream', 'enabled');
 370         $address = DI::pConfig()->get(local_user(), 'mailstream', 'address');
 371         $nolikes = DI::pConfig()->get(local_user(), 'mailstream', 'nolikes');
 372         $attachimg= DI::pConfig()->get(local_user(), 'mailstream', 'attachimg');
 373         $template = Renderer::getMarkupTemplate('settings.tpl', 'addon/mailstream/');
 374         $s .= Renderer::replaceMacros($template, [
 375                                  '$enabled' => [
 376                                         'mailstream_enabled',
 377                                         DI::l10n()->t('Enabled'),
 378                                         $enabled],
 379                                  '$address' => [
 380                                         'mailstream_address',
 381                                         DI::l10n()->t('Email Address'),
 382                                         $address,
 383                                         DI::l10n()->t("Leave blank to use your account email address")],
 384                                  '$nolikes' => [
 385                                         'mailstream_nolikes',
 386                                         DI::l10n()->t('Exclude Likes'),
 387                                         $nolikes,
 388                                         DI::l10n()->t("Check this to omit mailing \"Like\" notifications")],
 389                                  '$attachimg' => [
 390                                         'mailstream_attachimg',
 391                                         DI::l10n()->t('Attach Images'),
 392                                         $attachimg,
 393                                         DI::l10n()->t("Download images in posts and attach them to the email.  Useful for reading email while offline.")],
 394                                  '$title' => DI::l10n()->t('Mail Stream Settings'),
 395                                  '$submit' => DI::l10n()->t('Save Settings')]);
 396 }
 397
 398 function mailstream_addon_settings_post($a,$post) {
 399         if ($_POST['mailstream_address'] != "") {
 400                 DI::pConfig()->set(local_user(), 'mailstream', 'address', $_POST['mailstream_address']);
 401         }
 402         else {
 403                 DI::pConfig()->delete(local_user(), 'mailstream', 'address');
 404         }
 405         if ($_POST['mailstream_nolikes']) {
 406                 DI::pConfig()->set(local_user(), 'mailstream', 'nolikes', $_POST['mailstream_enabled']);
 407         }
 408         else {
 409                 DI::pConfig()->delete(local_user(), 'mailstream', 'nolikes');
 410         }
 411         if ($_POST['mailstream_enabled']) {
 412                 DI::pConfig()->set(local_user(), 'mailstream', 'enabled', $_POST['mailstream_enabled']);
 413         }
 414         else {
 415                 DI::pConfig()->delete(local_user(), 'mailstream', 'enabled');
 416         }
 417         if ($_POST['mailstream_attachimg']) {
 418                 DI::pConfig()->set(local_user(), 'mailstream', 'attachimg', $_POST['mailstream_attachimg']);
 419         }
 420         else {
 421                 DI::pConfig()->delete(local_user(), 'mailstream', 'attachimg');
 422         }
 423 }
 424
 425 function mailstream_tidy() {
 426         $r = q("SELECT id FROM mailstream_item WHERE completed IS NOT NULL AND completed < DATE_SUB(NOW(), INTERVAL 1 YEAR)");
 427         foreach ($r as $rr) {
 428                 q('DELETE FROM mailstream_item WHERE id = %d', intval($rr['id']));
 429         }
 430         Logger::debug('mailstream_tidy: deleted ' . count($r) . ' old items');
 431 }