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\Config;
11 use Friendica\Core\Hook;
12 use Friendica\Core\Logger;
13 use Friendica\Core\Renderer;
14 use Friendica\Database\DBA;
16 use Friendica\Protocol\Activity;
17 use Friendica\Util\Network;
18 use Friendica\Model\Item;
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');
27 if (DI::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');
34 if (DI::config()->get('mailstream', 'dbversion') == '0.2') {
35 q('DELETE FROM `pconfig` WHERE `cat` = "mailstream" AND `k` = "delay"');
36 Config::set('mailstream', 'dbversion', '0.3');
38 if (DI::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');
43 if (DI::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');
47 if (DI::config()->get('mailstream', 'dbversion') == '0.5') {
48 Config::set('mailstream', 'dbversion', '1.0');
51 if (DI::config()->get('retriever', 'dbversion') != '1.0') {
52 $schema = file_get_contents(dirname(__file__).'/database.sql');
53 $arr = explode(';', $schema);
54 foreach ($arr as $a) {
57 Config::set('mailstream', 'dbversion', '1.0');
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');
74 function mailstream_module() {}
76 function mailstream_addon_admin(&$a,&$o) {
77 $frommail = DI::config()->get('mailstream', 'frommail');
78 $template = Renderer::getMarkupTemplate('admin.tpl', 'addon/mailstream/');
79 $config = ['frommail',
80 DI::l10n()->t('From Address'),
82 DI::l10n()->t('Email address that stream items will appear to be from.')];
83 $o .= Renderer::replaceMacros($template, [
84 '$frommail' => $config,
85 '$submit' => DI::l10n()->t('Save Settings')]);
88 function mailstream_addon_admin_post ($a) {
89 if (!empty($_POST['frommail'])) {
90 Config::set('mailstream', 'frommail', $_POST['frommail']);
94 function mailstream_generate_id($a, $uri) {
95 // http://www.jwz.org/doc/mid.html
96 $host = DI::baseUrl()->getHostname();
97 $resource = hash('md5', $uri);
98 $message_id = "<" . $resource . "@" . $host . ">";
99 Logger::debug('mailstream: Generated message ID ' . $message_id . ' for URI ' . $uri);
103 function mailstream_post_hook(&$a, &$item) {
104 if (!DI::pConfig()->get($item['uid'], 'mailstream', 'enabled')) {
105 Logger::debug('mailstream: not enabled for item ' . $item['id']);
109 Logger::debug('mailstream: no uid for item ' . $item['id']);
112 if (!$item['contact-id']) {
113 Logger::debug('mailstream: no contact-id for item ' . $item['id']);
117 Logger::debug('mailstream: no uri for item ' . $item['id']);
120 if (!$item['plink']) {
121 Logger::debug('mailstream: no plink for item ' . $item['id']);
124 if (DI::pConfig()->get($item['uid'], 'mailstream', 'nolikes')) {
125 if ($item['verb'] == Activity::LIKE) {
126 Logger::debug('mailstream: like item ' . $item['id']);
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');
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']);
144 Logger::info('mailstream_post_remote_hook: no user ' . $item['uid']);
147 mailstream_send($a, $ms_item['message-id'], $item, $user);
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');
159 function mailstream_do_images($a, &$item, &$attachments) {
160 if (!DI::pConfig()->get($item['uid'], 'mailstream', 'attachimg')) {
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);
172 $cookiejar = tempnam(get_temppath(), 'cookiejar-mailstream-');
173 $curlResult = Network::fetchUrlFull($url, true, 0, '', $cookiejar);
174 $attachments[$url] = [
175 'data' => $curlResult->getBody(),
176 'guid' => hash("crc32", $url),
177 'filename' => basename($components['path']),
178 'type' => $curlResult->getContentType()
181 if (strlen($attachments[$url]['data'])) {
182 $item['body'] = str_replace($url, 'cid:' . $attachments[$url]['guid'], $item['body']);
189 function mailstream_sender($item) {
190 $r = q('SELECT * FROM `contact` WHERE `id` = %d', $item['contact-id']);
191 if (DBA::isResult($r)) {
193 if ($contact['name'] != $item['author-name']) {
194 return $contact['name'] . ' - ' . $item['author-name'];
197 return $item['author-name'];
200 function mailstream_decode_subject($subject) {
201 $html = BBCode::convert($subject);
205 $notags = strip_tags($html);
209 $noentity = html_entity_decode($notags);
213 $nocodes = preg_replace_callback("/(&#[0-9]+;)/", function($m) { return mb_convert_encoding($m[1], "UTF-8", "HTML-ENTITIES"); }, $noentity);
217 $trimmed = trim($nocodes);
224 function mailstream_subject($item) {
225 if ($item['title']) {
226 return mailstream_decode_subject($item['title']);
228 $parent = $item['thr-parent'];
229 // Don't look more than 100 levels deep for a subject, in case of loops
230 for ($i = 0; ($i < 100) && $parent; $i++) {
231 $parent_item = Item::selectFirst(['thr-parent', 'title'], ['uri' => $parent]);
232 if (!DBA::isResult($parent_item)) {
235 if ($parent_item['thr-parent'] === $parent) {
238 if ($parent_item['title']) {
239 return DI::l10n()->t('Re:') . ' ' . mailstream_decode_subject($parent_item['title']);
241 $parent = $parent_item['thr-parent'];
243 $r = q("SELECT * FROM `contact` WHERE `id` = %d AND `uid` = %d",
244 intval($item['contact-id']), intval($item['uid']));
246 if ($contact['network'] === 'dfrn') {
247 return DI::l10n()->t("Friendica post");
249 if ($contact['network'] === 'dspr') {
250 return DI::l10n()->t("Diaspora post");
252 if ($contact['network'] === 'face') {
253 $text = mailstream_decode_subject($item['body']);
254 // For some reason these do show up in Facebook
255 $text = preg_replace('/\xA0$/', '', $text);
256 $subject = (strlen($text) > 150) ? (substr($text, 0, 140) . '...') : $text;
257 return preg_replace('/\\s+/', ' ', $subject);
259 if ($contact['network'] === 'feed') {
260 return DI::l10n()->t("Feed item");
262 if ($contact['network'] === 'mail') {
263 return DI::l10n()->t("Email");
265 return DI::l10n()->t("Friendica Item");
268 function mailstream_send(\Friendica\App $a, $message_id, $item, $user) {
269 if (!$item['visible']) {
275 require_once(dirname(__file__).'/phpmailer/class.phpmailer.php');
278 mailstream_do_images($a, $item, $attachments);
279 $frommail = DI::config()->get('mailstream', 'frommail');
280 if ($frommail == "") {
281 $frommail = 'friendica@localhost.local';
283 $address = DI::pConfig()->get($item['uid'], 'mailstream', 'address');
285 $address = $user['email'];
287 $mail = new PHPmailer;
289 $mail->XMailer = 'Friendica Mailstream Addon';
290 $mail->SetFrom($frommail, mailstream_sender($item));
291 $mail->AddAddress($address, $user['username']);
292 $mail->MessageID = $message_id;
293 $mail->Subject = mailstream_subject($item);
294 if ($item['thr-parent'] != $item['uri']) {
295 $mail->addCustomHeader('In-Reply-To: ' . mailstream_generate_id($a, $item['thr-parent']));
297 $mail->addCustomHeader('X-Friendica-Mailstream-URI: ' . $item['uri']);
298 $mail->addCustomHeader('X-Friendica-Mailstream-Plink: ' . $item['plink']);
299 $encoding = 'base64';
300 foreach ($attachments as $url => $image) {
301 $mail->AddStringEmbeddedImage($image['data'], $image['guid'], $image['filename'], $encoding, $image['type']);
304 $mail->CharSet = 'utf-8';
305 $template = Renderer::getMarkupTemplate('mail.tpl', 'addon/mailstream/');
306 $mail->AltBody = BBCode::toPlaintext($item['body']);
307 $item['body'] = BBCode::convert($item['body']);
308 $item['url'] = DI::baseUrl()->get() . '/display/' . $item['guid'];
309 $mail->Body = Renderer::replaceMacros($template, [
310 '$upstream' => DI::l10n()->t('Upstream'),
311 '$local' => DI::l10n()->t('Local'),
313 mailstream_html_wrap($mail->Body);
314 if (!$mail->Send()) {
315 throw new Exception($mail->ErrorInfo);
317 Logger::debug('mailstream_send sent message ' . $mail->MessageID . ' ' . $mail->Subject);
318 } catch (phpmailerException $e) {
319 Logger::debug('mailstream_send PHPMailer exception sending message ' . $message_id . ': ' . $e->errorMessage());
320 } catch (Exception $e) {
321 Logger::debug('mailstream_send exception sending message ' . $message_id . ': ' . $e->getMessage());
323 // In case of failure, still set the item to completed. Otherwise
324 // we'll just try to send it over and over again and it'll fail
326 q('UPDATE `mailstream_item` SET `completed` = now() WHERE `message-id` = "%s"', DBA::escape($message_id));
330 * Email tends to break if you send excessively long lines. To make
331 * bbcode's output suitable for transmission, we try to break things
332 * up so that lines are about 200 characters.
334 function mailstream_html_wrap(&$text)
336 $lines = str_split($text, 200);
337 for ($i = 0; $i < count($lines); $i++) {
338 $lines[$i] = preg_replace('/ /', "\n", $lines[$i], 1);
340 $text = implode($lines);
343 function mailstream_cron($a, $b) {
344 // Only process items older than an hour in cron. This is because
345 // we want to give mailstream_post_remote_hook a fair chance to
346 // send the email itself before cron jumps in. Only if
347 // mailstream_post_remote_hook fails for some reason will this get
348 // used, and in that case it's worth holding off a bit anyway.
349 $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");
350 Logger::debug('mailstream_cron processing ' . count($ms_item_ids) . ' items');
351 foreach ($ms_item_ids as $ms_item_id) {
352 if (!$ms_item_id['message-id'] || !strlen($ms_item_id['message-id'])) {
353 Logger::info('mailstream_cron: Item ' . $ms_item_id['id'] . ' URI ' . $ms_item_id['uri'] . ' has no message-id');
355 $item = Item::selectFirst([], ['id' => $ms_item_id['id']]);
356 $users = q("SELECT * FROM `user` WHERE `uid` = %d", intval($item['uid']));
358 if ($user && $item) {
359 mailstream_send($a, $ms_item_id['message-id'], $item, $user);
362 Logger::info('mailstream_cron: Unable to find item ' . $ms_item_id['id']);
363 q("UPDATE `mailstream_item` SET `completed` = now() WHERE `message-id` = %d", intval($ms_item['message-id']));
369 function mailstream_addon_settings(&$a,&$s) {
370 $enabled = DI::pConfig()->get(local_user(), 'mailstream', 'enabled');
371 $address = DI::pConfig()->get(local_user(), 'mailstream', 'address');
372 $nolikes = DI::pConfig()->get(local_user(), 'mailstream', 'nolikes');
373 $attachimg= DI::pConfig()->get(local_user(), 'mailstream', 'attachimg');
374 $template = Renderer::getMarkupTemplate('settings.tpl', 'addon/mailstream/');
375 $s .= Renderer::replaceMacros($template, [
377 'mailstream_enabled',
378 DI::l10n()->t('Enabled'),
381 'mailstream_address',
382 DI::l10n()->t('Email Address'),
384 DI::l10n()->t("Leave blank to use your account email address")],
386 'mailstream_nolikes',
387 DI::l10n()->t('Exclude Likes'),
389 DI::l10n()->t("Check this to omit mailing \"Like\" notifications")],
391 'mailstream_attachimg',
392 DI::l10n()->t('Attach Images'),
394 DI::l10n()->t("Download images in posts and attach them to the email. Useful for reading email while offline.")],
395 '$title' => DI::l10n()->t('Mail Stream Settings'),
396 '$submit' => DI::l10n()->t('Save Settings')]);
399 function mailstream_addon_settings_post($a,$post) {
400 if ($_POST['mailstream_address'] != "") {
401 DI::pConfig()->set(local_user(), 'mailstream', 'address', $_POST['mailstream_address']);
404 DI::pConfig()->delete(local_user(), 'mailstream', 'address');
406 if ($_POST['mailstream_nolikes']) {
407 DI::pConfig()->set(local_user(), 'mailstream', 'nolikes', $_POST['mailstream_enabled']);
410 DI::pConfig()->delete(local_user(), 'mailstream', 'nolikes');
412 if ($_POST['mailstream_enabled']) {
413 DI::pConfig()->set(local_user(), 'mailstream', 'enabled', $_POST['mailstream_enabled']);
416 DI::pConfig()->delete(local_user(), 'mailstream', 'enabled');
418 if ($_POST['mailstream_attachimg']) {
419 DI::pConfig()->set(local_user(), 'mailstream', 'attachimg', $_POST['mailstream_attachimg']);
422 DI::pConfig()->delete(local_user(), 'mailstream', 'attachimg');
426 function mailstream_tidy() {
427 $r = q("SELECT id FROM mailstream_item WHERE completed IS NOT NULL AND completed < DATE_SUB(NOW(), INTERVAL 1 YEAR)");
428 foreach ($r as $rr) {
429 q('DELETE FROM mailstream_item WHERE id = %d', intval($rr['id']));
431 Logger::debug('mailstream_tidy: deleted ' . count($r) . ' old items');