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