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