4 * Description: Mail all items coming into your network feed to an email address
6 * Author: Matthew Exon <http://mat.exon.name>
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;
15 use Friendica\Model\Item;
16 use Friendica\Model\Post;
17 use Friendica\Protocol\Activity;
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');
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');
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');
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');
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');
46 if (DI::config()->get('mailstream', 'dbversion') == '0.5') {
47 DI::config()->set('mailstream', 'dbversion', '1.0');
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) {
56 DI::config()->set('mailstream', 'dbversion', '1.0');
60 function mailstream_module() {}
62 function mailstream_addon_admin(&$a,&$o) {
63 $frommail = DI::config()->get('mailstream', 'frommail');
64 $template = Renderer::getMarkupTemplate('admin.tpl', 'addon/mailstream/');
65 $config = ['frommail',
66 DI::l10n()->t('From Address'),
68 DI::l10n()->t('Email address that stream items will appear to be from.')];
69 $o .= Renderer::replaceMacros($template, [
70 '$frommail' => $config,
71 '$submit' => DI::l10n()->t('Save Settings')]);
74 function mailstream_addon_admin_post ($a) {
75 if (!empty($_POST['frommail'])) {
76 DI::config()->set('mailstream', 'frommail', $_POST['frommail']);
80 function mailstream_generate_id($a, $uri) {
81 // http://www.jwz.org/doc/mid.html
82 $host = DI::baseUrl()->getHostname();
83 $resource = hash('md5', $uri);
84 $message_id = "<" . $resource . "@" . $host . ">";
85 Logger::debug('mailstream: Generated message ID ' . $message_id . ' for URI ' . $uri);
89 function mailstream_post_hook(&$a, &$item) {
90 if (!DI::pConfig()->get($item['uid'], 'mailstream', 'enabled')) {
91 Logger::debug('mailstream: not enabled for item ' . $item['id']);
95 Logger::debug('mailstream: no uid for item ' . $item['id']);
98 if (!$item['contact-id']) {
99 Logger::debug('mailstream: no contact-id for item ' . $item['id']);
103 Logger::debug('mailstream: no uri for item ' . $item['id']);
106 if (!$item['plink']) {
107 Logger::debug('mailstream: no plink for item ' . $item['id']);
110 if (DI::pConfig()->get($item['uid'], 'mailstream', 'nolikes')) {
111 if ($item['verb'] == Activity::LIKE) {
112 Logger::debug('mailstream: like item ' . $item['id']);
117 $message_id = mailstream_generate_id($a, $item['uri']);
118 q("INSERT INTO `mailstream_item` (`uid`, `contact-id`, `uri`, `message-id`) " .
119 "VALUES (%d, '%s', '%s', '%s')", intval($item['uid']),
120 intval($item['contact-id']), DBA::escape($item['uri']), DBA::escape($message_id));
121 $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']));
122 if (count($r) != 1) {
123 Logger::info('mailstream_post_remote_hook: Unexpected number of items returned from mailstream_item');
127 Logger::debug('mailstream_post_remote_hook: created mailstream_item ' . $ms_item['id'] . ' for item ' . $item['uri'] . ' ' . $item['uid'] . ' ' . $item['contact-id']);
128 $user = mailstream_get_user($item['uid']);
130 Logger::info('mailstream_post_remote_hook: no user ' . $item['uid']);
133 mailstream_send($a, $ms_item['message-id'], $item, $user);
136 function mailstream_get_user($uid) {
137 $r = q('SELECT * FROM `user` WHERE `uid` = %d', intval($uid));
138 if (count($r) != 1) {
139 Logger::info('mailstream_post_remote_hook: Unexpected number of users returned');
145 function mailstream_do_images($a, &$item, &$attachments) {
146 if (!DI::pConfig()->get($item['uid'], 'mailstream', 'attachimg')) {
150 preg_match_all("/\[img\=([0-9]*)x([0-9]*)\](.*?)\[\/img\]/ism", $item["body"], $matches1);
151 preg_match_all("/\[img\](.*?)\[\/img\]/ism", $item["body"], $matches2);
152 preg_match_all("/\[img\=([^\]]*)\]([^[]*)\[\/img\]/ism", $item["body"], $matches3);
153 foreach (array_merge($matches1[3], $matches2[1], $matches3[1]) as $url) {
154 $components = parse_url($url);
158 $cookiejar = tempnam(get_temppath(), 'cookiejar-mailstream-');
159 $curlResult = DI::httpRequest()->fetchFull($url, 0, '', $cookiejar);
160 $attachments[$url] = [
161 'data' => $curlResult->getBody(),
162 'guid' => hash("crc32", $url),
163 'filename' => basename($components['path']),
164 'type' => $curlResult->getContentType()
167 if (strlen($attachments[$url]['data'])) {
168 $item['body'] = str_replace($url, 'cid:' . $attachments[$url]['guid'], $item['body']);
175 function mailstream_sender($item) {
176 $r = q('SELECT * FROM `contact` WHERE `id` = %d', $item['contact-id']);
177 if (DBA::isResult($r)) {
179 if ($contact['name'] != $item['author-name']) {
180 return $contact['name'] . ' - ' . $item['author-name'];
183 return $item['author-name'];
186 function mailstream_decode_subject($subject) {
187 $html = BBCode::convert($subject);
191 $notags = strip_tags($html);
195 $noentity = html_entity_decode($notags);
199 $nocodes = preg_replace_callback("/(&#[0-9]+;)/", function($m) { return mb_convert_encoding($m[1], "UTF-8", "HTML-ENTITIES"); }, $noentity);
203 $trimmed = trim($nocodes);
210 function mailstream_subject($item) {
211 if ($item['title']) {
212 return mailstream_decode_subject($item['title']);
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 = Post::selectFirst(['thr-parent', 'title'], ['uri' => $parent]);
218 if (!DBA::isResult($parent_item)) {
221 if ($parent_item['thr-parent'] === $parent) {
224 if ($parent_item['title']) {
225 return DI::l10n()->t('Re:') . ' ' . mailstream_decode_subject($parent_item['title']);
227 $parent = $parent_item['thr-parent'];
229 $r = q("SELECT * FROM `contact` WHERE `id` = %d AND `uid` = %d",
230 intval($item['contact-id']), intval($item['uid']));
231 if (!DBA::isResult($r)) {
232 Logger::error('mailstream_subject no contact for item id ' . $item['id'] . ' plink ' . $item['plink'] . ' contact id ' . $item['contact-id'] . ' uid ' . $item['uid']);
233 return DI::l10n()->t("Friendica post");
236 if ($contact['network'] === 'dfrn') {
237 return DI::l10n()->t("Friendica post");
239 if ($contact['network'] === 'dspr') {
240 return DI::l10n()->t("Diaspora post");
242 if ($contact['network'] === 'face') {
243 $text = mailstream_decode_subject($item['body']);
244 // For some reason these do show up in Facebook
245 $text = preg_replace('/\xA0$/', '', $text);
246 $subject = (strlen($text) > 150) ? (substr($text, 0, 140) . '...') : $text;
247 return preg_replace('/\\s+/', ' ', $subject);
249 if ($contact['network'] === 'feed') {
250 return DI::l10n()->t("Feed item");
252 if ($contact['network'] === 'mail') {
253 return DI::l10n()->t("Email");
255 return DI::l10n()->t("Friendica Item");
258 function mailstream_send(\Friendica\App $a, $message_id, $item, $user) {
259 if (!$item['visible']) {
265 require_once(dirname(__file__).'/phpmailer/class.phpmailer.php');
268 mailstream_do_images($a, $item, $attachments);
269 $frommail = DI::config()->get('mailstream', 'frommail');
270 if ($frommail == "") {
271 $frommail = 'friendica@localhost.local';
273 $address = DI::pConfig()->get($item['uid'], 'mailstream', 'address');
275 $address = $user['email'];
277 $mail = new PHPmailer;
279 $mail->XMailer = 'Friendica Mailstream Addon';
280 $mail->SetFrom($frommail, mailstream_sender($item));
281 $mail->AddAddress($address, $user['username']);
282 $mail->MessageID = $message_id;
283 $mail->Subject = mailstream_subject($item);
284 if ($item['thr-parent'] != $item['uri']) {
285 $mail->addCustomHeader('In-Reply-To: ' . mailstream_generate_id($a, $item['thr-parent']));
287 $mail->addCustomHeader('X-Friendica-Mailstream-URI: ' . $item['uri']);
288 $mail->addCustomHeader('X-Friendica-Mailstream-Plink: ' . $item['plink']);
289 $encoding = 'base64';
290 foreach ($attachments as $url => $image) {
291 $mail->AddStringEmbeddedImage($image['data'], $image['guid'], $image['filename'], $encoding, $image['type']);
294 $mail->CharSet = 'utf-8';
295 $template = Renderer::getMarkupTemplate('mail.tpl', 'addon/mailstream/');
296 $mail->AltBody = BBCode::toPlaintext($item['body']);
297 $item['body'] = BBCode::convert($item['body'], false, BBCode::CONNECTORS);
298 $item['url'] = DI::baseUrl()->get() . '/display/' . $item['guid'];
299 $mail->Body = Renderer::replaceMacros($template, [
300 '$upstream' => DI::l10n()->t('Upstream'),
301 '$local' => DI::l10n()->t('Local'),
303 mailstream_html_wrap($mail->Body);
304 if (!$mail->Send()) {
305 throw new Exception($mail->ErrorInfo);
307 Logger::debug('mailstream_send sent message ' . $mail->MessageID . ' ' . $mail->Subject);
308 } catch (phpmailerException $e) {
309 Logger::debug('mailstream_send PHPMailer exception sending message ' . $message_id . ': ' . $e->errorMessage());
310 } catch (Exception $e) {
311 Logger::debug('mailstream_send exception sending message ' . $message_id . ': ' . $e->getMessage());
313 // In case of failure, still set the item to completed. Otherwise
314 // we'll just try to send it over and over again and it'll fail
316 q('UPDATE `mailstream_item` SET `completed` = now() WHERE `message-id` = "%s"', DBA::escape($message_id));
320 * Email tends to break if you send excessively long lines. To make
321 * bbcode's output suitable for transmission, we try to break things
322 * up so that lines are about 200 characters.
324 function mailstream_html_wrap(&$text)
326 $lines = str_split($text, 200);
327 for ($i = 0; $i < count($lines); $i++) {
328 $lines[$i] = preg_replace('/ /', "\n", $lines[$i], 1);
330 $text = implode($lines);
333 function mailstream_cron($a, $b) {
334 // Only process items older than an hour in cron. This is because
335 // we want to give mailstream_post_remote_hook a fair chance to
336 // send the email itself before cron jumps in. Only if
337 // mailstream_post_remote_hook fails for some reason will this get
338 // used, and in that case it's worth holding off a bit anyway.
341 `mailstream_item`.`message-id`,
342 `mailstream_item`.`uri`,
343 `post-user-view`.`id`
349 `mailstream_item`.`uid` = `post-user-view`.`uid` AND
350 `mailstream_item`.`uri` = `post-user-view`.`uri` AND
351 `mailstream_item`.`contact-id` = `post-user-view`.`contact-id`
354 `mailstream_item`.`completed` IS NULL AND
355 `mailstream_item`.`created` < DATE_SUB(NOW(), INTERVAL 1 HOUR) AND
356 `post-user-view`.`visible` = 1
357 ORDER BY `mailstream_item`.`created`
361 $ms_item_ids = q($query);
362 if (DBA::isResult($ms_item_ids)) {
363 Logger::debug('mailstream_cron processing ' . count($ms_item_ids) . ' items');
364 foreach ($ms_item_ids as $ms_item_id) {
365 if (!$ms_item_id['message-id'] || !strlen($ms_item_id['message-id'])) {
366 Logger::info('mailstream_cron: Item ' . $ms_item_id['id'] . ' URI ' . $ms_item_id['uri'] . ' has no message-id');
368 $item = Post::selectFirst([], ['id' => $ms_item_id['id']]);
369 $users = q("SELECT * FROM `user` WHERE `uid` = %d", intval($item['uid']));
371 if ($user && $item) {
372 mailstream_send($a, $ms_item_id['message-id'], $item, $user);
375 Logger::info('mailstream_cron: Unable to find item ' . $ms_item_id['id']);
376 q("UPDATE `mailstream_item` SET `completed` = now() WHERE `message-id` = %d", intval($ms_item_id['message-id']));
383 function mailstream_addon_settings(&$a, &$s) {
384 $enabled = DI::pConfig()->get(local_user(), 'mailstream', 'enabled');
385 $address = DI::pConfig()->get(local_user(), 'mailstream', 'address');
386 $nolikes = DI::pConfig()->get(local_user(), 'mailstream', 'nolikes');
387 $attachimg= DI::pConfig()->get(local_user(), 'mailstream', 'attachimg');
388 $template = Renderer::getMarkupTemplate('settings.tpl', 'addon/mailstream/');
389 $s .= Renderer::replaceMacros($template, [
391 'mailstream_enabled',
392 DI::l10n()->t('Enabled'),
395 'mailstream_address',
396 DI::l10n()->t('Email Address'),
398 DI::l10n()->t("Leave blank to use your account email address")],
400 'mailstream_nolikes',
401 DI::l10n()->t('Exclude Likes'),
403 DI::l10n()->t("Check this to omit mailing \"Like\" notifications")],
405 'mailstream_attachimg',
406 DI::l10n()->t('Attach Images'),
408 DI::l10n()->t("Download images in posts and attach them to the email. Useful for reading email while offline.")],
409 '$title' => DI::l10n()->t('Mail Stream Settings'),
410 '$submit' => DI::l10n()->t('Save Settings')]);
413 function mailstream_addon_settings_post($a,$post) {
414 if ($_POST['mailstream_address'] != "") {
415 DI::pConfig()->set(local_user(), 'mailstream', 'address', $_POST['mailstream_address']);
418 DI::pConfig()->delete(local_user(), 'mailstream', 'address');
420 if ($_POST['mailstream_nolikes']) {
421 DI::pConfig()->set(local_user(), 'mailstream', 'nolikes', $_POST['mailstream_enabled']);
424 DI::pConfig()->delete(local_user(), 'mailstream', 'nolikes');
426 if ($_POST['mailstream_enabled']) {
427 DI::pConfig()->set(local_user(), 'mailstream', 'enabled', $_POST['mailstream_enabled']);
430 DI::pConfig()->delete(local_user(), 'mailstream', 'enabled');
432 if ($_POST['mailstream_attachimg']) {
433 DI::pConfig()->set(local_user(), 'mailstream', 'attachimg', $_POST['mailstream_attachimg']);
436 DI::pConfig()->delete(local_user(), 'mailstream', 'attachimg');
440 function mailstream_tidy() {
441 $r = q("SELECT id FROM mailstream_item WHERE completed IS NOT NULL AND completed < DATE_SUB(NOW(), INTERVAL 1 YEAR)");
442 foreach ($r as $rr) {
443 q('DELETE FROM mailstream_item WHERE id = %d', intval($rr['id']));
445 Logger::debug('mailstream_tidy: deleted ' . count($r) . ' old items');