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\Protocol\Activity;
18 function mailstream_install() {
19 Hook::register('addon_settings', 'addon/mailstream/mailstream.php', 'mailstream_addon_settings');
20 Hook::register('addon_settings_post', 'addon/mailstream/mailstream.php', 'mailstream_addon_settings_post');
21 Hook::register('post_local_end', 'addon/mailstream/mailstream.php', 'mailstream_post_hook');
22 Hook::register('post_remote_end', 'addon/mailstream/mailstream.php', 'mailstream_post_hook');
23 Hook::register('cron', 'addon/mailstream/mailstream.php', 'mailstream_cron');
25 if (DI::config()->get('mailstream', 'dbversion') == '0.1') {
26 q('ALTER TABLE `mailstream_item` DROP INDEX `uid`');
27 q('ALTER TABLE `mailstream_item` DROP INDEX `contact-id`');
28 q('ALTER TABLE `mailstream_item` DROP INDEX `plink`');
29 q('ALTER TABLE `mailstream_item` CHANGE `plink` `uri` char(255) NOT NULL');
30 DI::config()->set('mailstream', 'dbversion', '0.2');
32 if (DI::config()->get('mailstream', 'dbversion') == '0.2') {
33 q('DELETE FROM `pconfig` WHERE `cat` = "mailstream" AND `k` = "delay"');
34 DI::config()->set('mailstream', 'dbversion', '0.3');
36 if (DI::config()->get('mailstream', 'dbversion') == '0.3') {
37 q('ALTER TABLE `mailstream_item` CHANGE `created` `created` timestamp NOT NULL DEFAULT now()');
38 q('ALTER TABLE `mailstream_item` CHANGE `completed` `completed` timestamp NULL DEFAULT NULL');
39 DI::config()->set('mailstream', 'dbversion', '0.4');
41 if (DI::config()->get('mailstream', 'dbversion') == '0.4') {
42 q('ALTER TABLE `mailstream_item` CONVERT TO CHARACTER SET utf8 COLLATE utf8_bin');
43 DI::config()->set('mailstream', 'dbversion', '0.5');
45 if (DI::config()->get('mailstream', 'dbversion') == '0.5') {
46 DI::config()->set('mailstream', 'dbversion', '1.0');
49 if (DI::config()->get('retriever', 'dbversion') != '1.0') {
50 $schema = file_get_contents(dirname(__file__).'/database.sql');
51 $arr = explode(';', $schema);
52 foreach ($arr as $a) {
55 DI::config()->set('mailstream', 'dbversion', '1.0');
59 function mailstream_module() {}
61 function mailstream_addon_admin(&$a,&$o) {
62 $frommail = DI::config()->get('mailstream', 'frommail');
63 $template = Renderer::getMarkupTemplate('admin.tpl', 'addon/mailstream/');
64 $config = ['frommail',
65 DI::l10n()->t('From Address'),
67 DI::l10n()->t('Email address that stream items will appear to be from.')];
68 $o .= Renderer::replaceMacros($template, [
69 '$frommail' => $config,
70 '$submit' => DI::l10n()->t('Save Settings')]);
73 function mailstream_addon_admin_post ($a) {
74 if (!empty($_POST['frommail'])) {
75 DI::config()->set('mailstream', 'frommail', $_POST['frommail']);
79 function mailstream_generate_id($a, $uri) {
80 // http://www.jwz.org/doc/mid.html
81 $host = DI::baseUrl()->getHostname();
82 $resource = hash('md5', $uri);
83 $message_id = "<" . $resource . "@" . $host . ">";
84 Logger::debug('mailstream: Generated message ID ' . $message_id . ' for URI ' . $uri);
88 function mailstream_post_hook(&$a, &$item) {
89 if (!DI::pConfig()->get($item['uid'], 'mailstream', 'enabled')) {
90 Logger::debug('mailstream: not enabled for item ' . $item['id']);
94 Logger::debug('mailstream: no uid for item ' . $item['id']);
97 if (!$item['contact-id']) {
98 Logger::debug('mailstream: no contact-id for item ' . $item['id']);
102 Logger::debug('mailstream: no uri for item ' . $item['id']);
105 if (!$item['plink']) {
106 Logger::debug('mailstream: no plink for item ' . $item['id']);
109 if (DI::pConfig()->get($item['uid'], 'mailstream', 'nolikes')) {
110 if ($item['verb'] == Activity::LIKE) {
111 Logger::debug('mailstream: like item ' . $item['id']);
116 $message_id = mailstream_generate_id($a, $item['uri']);
117 q("INSERT INTO `mailstream_item` (`uid`, `contact-id`, `uri`, `message-id`) " .
118 "VALUES (%d, '%s', '%s', '%s')", intval($item['uid']),
119 intval($item['contact-id']), DBA::escape($item['uri']), DBA::escape($message_id));
120 $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']));
121 if (count($r) != 1) {
122 Logger::info('mailstream_post_remote_hook: Unexpected number of items returned from mailstream_item');
126 Logger::debug('mailstream_post_remote_hook: created mailstream_item ' . $ms_item['id'] . ' for item ' . $item['uri'] . ' ' . $item['uid'] . ' ' . $item['contact-id']);
127 $user = mailstream_get_user($item['uid']);
129 Logger::info('mailstream_post_remote_hook: no user ' . $item['uid']);
132 mailstream_send($a, $ms_item['message-id'], $item, $user);
135 function mailstream_get_user($uid) {
136 $r = q('SELECT * FROM `user` WHERE `uid` = %d', intval($uid));
137 if (count($r) != 1) {
138 Logger::info('mailstream_post_remote_hook: Unexpected number of users returned');
144 function mailstream_do_images($a, &$item, &$attachments) {
145 if (!DI::pConfig()->get($item['uid'], 'mailstream', 'attachimg')) {
149 preg_match_all("/\[img\=([0-9]*)x([0-9]*)\](.*?)\[\/img\]/ism", $item["body"], $matches1);
150 preg_match_all("/\[img\](.*?)\[\/img\]/ism", $item["body"], $matches2);
151 preg_match_all("/\[img\=([^\]]*)\]([^[]*)\[\/img\]/ism", $item["body"], $matches3);
152 foreach (array_merge($matches1[3], $matches2[1], $matches3[1]) as $url) {
153 $components = parse_url($url);
157 $cookiejar = tempnam(get_temppath(), 'cookiejar-mailstream-');
158 $curlResult = DI::httpRequest()->fetchFull($url, 0, '', $cookiejar);
159 $attachments[$url] = [
160 'data' => $curlResult->getBody(),
161 'guid' => hash("crc32", $url),
162 'filename' => basename($components['path']),
163 'type' => $curlResult->getContentType()
166 if (strlen($attachments[$url]['data'])) {
167 $item['body'] = str_replace($url, 'cid:' . $attachments[$url]['guid'], $item['body']);
174 function mailstream_sender($item) {
175 $r = q('SELECT * FROM `contact` WHERE `id` = %d', $item['contact-id']);
176 if (DBA::isResult($r)) {
178 if ($contact['name'] != $item['author-name']) {
179 return $contact['name'] . ' - ' . $item['author-name'];
182 return $item['author-name'];
185 function mailstream_decode_subject($subject) {
186 $html = BBCode::convert($subject);
190 $notags = strip_tags($html);
194 $noentity = html_entity_decode($notags);
198 $nocodes = preg_replace_callback("/(&#[0-9]+;)/", function($m) { return mb_convert_encoding($m[1], "UTF-8", "HTML-ENTITIES"); }, $noentity);
202 $trimmed = trim($nocodes);
209 function mailstream_subject($item) {
210 if ($item['title']) {
211 return mailstream_decode_subject($item['title']);
213 $parent = $item['thr-parent'];
214 // Don't look more than 100 levels deep for a subject, in case of loops
215 for ($i = 0; ($i < 100) && $parent; $i++) {
216 $parent_item = Item::selectFirst(['thr-parent', 'title'], ['uri' => $parent]);
217 if (!DBA::isResult($parent_item)) {
220 if ($parent_item['thr-parent'] === $parent) {
223 if ($parent_item['title']) {
224 return DI::l10n()->t('Re:') . ' ' . mailstream_decode_subject($parent_item['title']);
226 $parent = $parent_item['thr-parent'];
228 $r = q("SELECT * FROM `contact` WHERE `id` = %d AND `uid` = %d",
229 intval($item['contact-id']), intval($item['uid']));
231 if ($contact['network'] === 'dfrn') {
232 return DI::l10n()->t("Friendica post");
234 if ($contact['network'] === 'dspr') {
235 return DI::l10n()->t("Diaspora post");
237 if ($contact['network'] === 'face') {
238 $text = mailstream_decode_subject($item['body']);
239 // For some reason these do show up in Facebook
240 $text = preg_replace('/\xA0$/', '', $text);
241 $subject = (strlen($text) > 150) ? (substr($text, 0, 140) . '...') : $text;
242 return preg_replace('/\\s+/', ' ', $subject);
244 if ($contact['network'] === 'feed') {
245 return DI::l10n()->t("Feed item");
247 if ($contact['network'] === 'mail') {
248 return DI::l10n()->t("Email");
250 return DI::l10n()->t("Friendica Item");
253 function mailstream_send(\Friendica\App $a, $message_id, $item, $user) {
254 if (!$item['visible']) {
260 require_once(dirname(__file__).'/phpmailer/class.phpmailer.php');
263 mailstream_do_images($a, $item, $attachments);
264 $frommail = DI::config()->get('mailstream', 'frommail');
265 if ($frommail == "") {
266 $frommail = 'friendica@localhost.local';
268 $address = DI::pConfig()->get($item['uid'], 'mailstream', 'address');
270 $address = $user['email'];
272 $mail = new PHPmailer;
274 $mail->XMailer = 'Friendica Mailstream Addon';
275 $mail->SetFrom($frommail, mailstream_sender($item));
276 $mail->AddAddress($address, $user['username']);
277 $mail->MessageID = $message_id;
278 $mail->Subject = mailstream_subject($item);
279 if ($item['thr-parent'] != $item['uri']) {
280 $mail->addCustomHeader('In-Reply-To: ' . mailstream_generate_id($a, $item['thr-parent']));
282 $mail->addCustomHeader('X-Friendica-Mailstream-URI: ' . $item['uri']);
283 $mail->addCustomHeader('X-Friendica-Mailstream-Plink: ' . $item['plink']);
284 $encoding = 'base64';
285 foreach ($attachments as $url => $image) {
286 $mail->AddStringEmbeddedImage($image['data'], $image['guid'], $image['filename'], $encoding, $image['type']);
289 $mail->CharSet = 'utf-8';
290 $template = Renderer::getMarkupTemplate('mail.tpl', 'addon/mailstream/');
291 $mail->AltBody = BBCode::toPlaintext($item['body']);
292 $item['body'] = BBCode::convert($item['body']);
293 $item['url'] = DI::baseUrl()->get() . '/display/' . $item['guid'];
294 $mail->Body = Renderer::replaceMacros($template, [
295 '$upstream' => DI::l10n()->t('Upstream'),
296 '$local' => DI::l10n()->t('Local'),
298 mailstream_html_wrap($mail->Body);
299 if (!$mail->Send()) {
300 throw new Exception($mail->ErrorInfo);
302 Logger::debug('mailstream_send sent message ' . $mail->MessageID . ' ' . $mail->Subject);
303 } catch (phpmailerException $e) {
304 Logger::debug('mailstream_send PHPMailer exception sending message ' . $message_id . ': ' . $e->errorMessage());
305 } catch (Exception $e) {
306 Logger::debug('mailstream_send exception sending message ' . $message_id . ': ' . $e->getMessage());
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
311 q('UPDATE `mailstream_item` SET `completed` = now() WHERE `message-id` = "%s"', DBA::escape($message_id));
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.
319 function mailstream_html_wrap(&$text)
321 $lines = str_split($text, 200);
322 for ($i = 0; $i < count($lines); $i++) {
323 $lines[$i] = preg_replace('/ /', "\n", $lines[$i], 1);
325 $text = implode($lines);
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::debug('mailstream_cron processing ' . count($ms_item_ids) . ' items');
336 foreach ($ms_item_ids as $ms_item_id) {
337 if (!$ms_item_id['message-id'] || !strlen($ms_item_id['message-id'])) {
338 Logger::info('mailstream_cron: Item ' . $ms_item_id['id'] . ' URI ' . $ms_item_id['uri'] . ' has no message-id');
340 $item = Item::selectFirst([], ['id' => $ms_item_id['id']]);
341 $users = q("SELECT * FROM `user` WHERE `uid` = %d", intval($item['uid']));
343 if ($user && $item) {
344 mailstream_send($a, $ms_item_id['message-id'], $item, $user);
347 Logger::info('mailstream_cron: Unable to find item ' . $ms_item_id['id']);
348 q("UPDATE `mailstream_item` SET `completed` = now() WHERE `message-id` = %d", intval($ms_item['message-id']));
354 function mailstream_addon_settings(&$a,&$s) {
355 $enabled = DI::pConfig()->get(local_user(), 'mailstream', 'enabled');
356 $address = DI::pConfig()->get(local_user(), 'mailstream', 'address');
357 $nolikes = DI::pConfig()->get(local_user(), 'mailstream', 'nolikes');
358 $attachimg= DI::pConfig()->get(local_user(), 'mailstream', 'attachimg');
359 $template = Renderer::getMarkupTemplate('settings.tpl', 'addon/mailstream/');
360 $s .= Renderer::replaceMacros($template, [
362 'mailstream_enabled',
363 DI::l10n()->t('Enabled'),
366 'mailstream_address',
367 DI::l10n()->t('Email Address'),
369 DI::l10n()->t("Leave blank to use your account email address")],
371 'mailstream_nolikes',
372 DI::l10n()->t('Exclude Likes'),
374 DI::l10n()->t("Check this to omit mailing \"Like\" notifications")],
376 'mailstream_attachimg',
377 DI::l10n()->t('Attach Images'),
379 DI::l10n()->t("Download images in posts and attach them to the email. Useful for reading email while offline.")],
380 '$title' => DI::l10n()->t('Mail Stream Settings'),
381 '$submit' => DI::l10n()->t('Save Settings')]);
384 function mailstream_addon_settings_post($a,$post) {
385 if ($_POST['mailstream_address'] != "") {
386 DI::pConfig()->set(local_user(), 'mailstream', 'address', $_POST['mailstream_address']);
389 DI::pConfig()->delete(local_user(), 'mailstream', 'address');
391 if ($_POST['mailstream_nolikes']) {
392 DI::pConfig()->set(local_user(), 'mailstream', 'nolikes', $_POST['mailstream_enabled']);
395 DI::pConfig()->delete(local_user(), 'mailstream', 'nolikes');
397 if ($_POST['mailstream_enabled']) {
398 DI::pConfig()->set(local_user(), 'mailstream', 'enabled', $_POST['mailstream_enabled']);
401 DI::pConfig()->delete(local_user(), 'mailstream', 'enabled');
403 if ($_POST['mailstream_attachimg']) {
404 DI::pConfig()->set(local_user(), 'mailstream', 'attachimg', $_POST['mailstream_attachimg']);
407 DI::pConfig()->delete(local_user(), 'mailstream', 'attachimg');
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']));
416 Logger::debug('mailstream_tidy: deleted ' . count($r) . ' old items');