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\L10n;
13 use Friendica\Core\Logger;
14 use Friendica\Core\PConfig;
15 use Friendica\Core\Renderer;
16 use Friendica\Database\DBA;
18 use Friendica\Protocol\Activity;
19 use Friendica\Util\Network;
20 use Friendica\Model\Item;
22 function mailstream_install() {
23 Hook::register('addon_settings', 'addon/mailstream/mailstream.php', 'mailstream_addon_settings');
24 Hook::register('addon_settings_post', 'addon/mailstream/mailstream.php', 'mailstream_addon_settings_post');
25 Hook::register('post_local_end', 'addon/mailstream/mailstream.php', 'mailstream_post_hook');
26 Hook::register('post_remote_end', 'addon/mailstream/mailstream.php', 'mailstream_post_hook');
27 Hook::register('cron', 'addon/mailstream/mailstream.php', 'mailstream_cron');
29 if (Config::get('mailstream', 'dbversion') == '0.1') {
30 q('ALTER TABLE `mailstream_item` DROP INDEX `uid`');
31 q('ALTER TABLE `mailstream_item` DROP INDEX `contact-id`');
32 q('ALTER TABLE `mailstream_item` DROP INDEX `plink`');
33 q('ALTER TABLE `mailstream_item` CHANGE `plink` `uri` char(255) NOT NULL');
34 Config::set('mailstream', 'dbversion', '0.2');
36 if (Config::get('mailstream', 'dbversion') == '0.2') {
37 q('DELETE FROM `pconfig` WHERE `cat` = "mailstream" AND `k` = "delay"');
38 Config::set('mailstream', 'dbversion', '0.3');
40 if (Config::get('mailstream', 'dbversion') == '0.3') {
41 q('ALTER TABLE `mailstream_item` CHANGE `created` `created` timestamp NOT NULL DEFAULT now()');
42 q('ALTER TABLE `mailstream_item` CHANGE `completed` `completed` timestamp NULL DEFAULT NULL');
43 Config::set('mailstream', 'dbversion', '0.4');
45 if (Config::get('mailstream', 'dbversion') == '0.4') {
46 q('ALTER TABLE `mailstream_item` CONVERT TO CHARACTER SET utf8 COLLATE utf8_bin');
47 Config::set('mailstream', 'dbversion', '0.5');
49 if (Config::get('mailstream', 'dbversion') == '0.5') {
50 Config::set('mailstream', 'dbversion', '1.0');
53 if (Config::get('retriever', 'dbversion') != '1.0') {
54 $schema = file_get_contents(dirname(__file__).'/database.sql');
55 $arr = explode(';', $schema);
56 foreach ($arr as $a) {
59 Config::set('mailstream', 'dbversion', '1.0');
63 function mailstream_uninstall() {
64 Hook::unregister('addon_settings', 'addon/mailstream/mailstream.php', 'mailstream_addon_settings');
65 Hook::unregister('addon_settings_post', 'addon/mailstream/mailstream.php', 'mailstream_addon_settings_post');
66 Hook::unregister('post_local', 'addon/mailstream/mailstream.php', 'mailstream_post_local_hook');
67 Hook::unregister('post_remote', 'addon/mailstream/mailstream.php', 'mailstream_post_remote_hook');
68 Hook::unregister('post_local_end', 'addon/mailstream/mailstream.php', 'mailstream_post_local_hook');
69 Hook::unregister('post_remote_end', 'addon/mailstream/mailstream.php', 'mailstream_post_remote_hook');
70 Hook::unregister('post_local_end', 'addon/mailstream/mailstream.php', 'mailstream_post_hook');
71 Hook::unregister('post_remote_end', 'addon/mailstream/mailstream.php', 'mailstream_post_hook');
72 Hook::unregister('cron', 'addon/mailstream/mailstream.php', 'mailstream_cron');
73 Hook::unregister('incoming_mail', 'addon/mailstream/mailstream.php', 'mailstream_incoming_mail');
76 function mailstream_module() {}
78 function mailstream_addon_admin(&$a,&$o) {
79 $frommail = Config::get('mailstream', 'frommail');
80 $template = Renderer::getMarkupTemplate('admin.tpl', 'addon/mailstream/');
81 $config = ['frommail',
82 L10n::t('From Address'),
84 L10n::t('Email address that stream items will appear to be from.')];
85 $o .= Renderer::replaceMacros($template, [
86 '$frommail' => $config,
87 '$submit' => L10n::t('Save Settings')]);
90 function mailstream_addon_admin_post ($a) {
91 if (!empty($_POST['frommail'])) {
92 Config::set('mailstream', 'frommail', $_POST['frommail']);
96 function mailstream_generate_id($a, $uri) {
97 // http://www.jwz.org/doc/mid.html
98 $host = DI::baseUrl()->getHostname();
99 $resource = hash('md5', $uri);
100 $message_id = "<" . $resource . "@" . $host . ">";
101 Logger::debug('mailstream: Generated message ID ' . $message_id . ' for URI ' . $uri);
105 function mailstream_post_hook(&$a, &$item) {
106 if (!PConfig::get($item['uid'], 'mailstream', 'enabled')) {
107 Logger::debug('mailstream: not enabled for item ' . $item['id']);
111 Logger::debug('mailstream: no uid for item ' . $item['id']);
114 if (!$item['contact-id']) {
115 Logger::debug('mailstream: no contact-id for item ' . $item['id']);
119 Logger::debug('mailstream: no uri for item ' . $item['id']);
122 if (!$item['plink']) {
123 Logger::debug('mailstream: no plink for item ' . $item['id']);
126 if (PConfig::get($item['uid'], 'mailstream', 'nolikes')) {
127 if ($item['verb'] == Activity::LIKE) {
128 Logger::debug('mailstream: like item ' . $item['id']);
133 $message_id = mailstream_generate_id($a, $item['uri']);
134 q("INSERT INTO `mailstream_item` (`uid`, `contact-id`, `uri`, `message-id`) " .
135 "VALUES (%d, '%s', '%s', '%s')", intval($item['uid']),
136 intval($item['contact-id']), DBA::escape($item['uri']), DBA::escape($message_id));
137 $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']));
138 if (count($r) != 1) {
139 Logger::info('mailstream_post_remote_hook: Unexpected number of items returned from mailstream_item');
143 Logger::debug('mailstream_post_remote_hook: created mailstream_item ' . $ms_item['id'] . ' for item ' . $item['uri'] . ' ' . $item['uid'] . ' ' . $item['contact-id']);
144 $user = mailstream_get_user($item['uid']);
146 Logger::info('mailstream_post_remote_hook: no user ' . $item['uid']);
149 mailstream_send($a, $ms_item['message-id'], $item, $user);
152 function mailstream_get_user($uid) {
153 $r = q('SELECT * FROM `user` WHERE `uid` = %d', intval($uid));
154 if (count($r) != 1) {
155 Logger::info('mailstream_post_remote_hook: Unexpected number of users returned');
161 function mailstream_do_images($a, &$item, &$attachments) {
162 if (!PConfig::get($item['uid'], 'mailstream', 'attachimg')) {
166 preg_match_all("/\[img\=([0-9]*)x([0-9]*)\](.*?)\[\/img\]/ism", $item["body"], $matches1);
167 preg_match_all("/\[img\](.*?)\[\/img\]/ism", $item["body"], $matches2);
168 preg_match_all("/\[img\=([^\]]*)\]([^[]*)\[\/img\]/ism", $item["body"], $matches3);
169 foreach (array_merge($matches1[3], $matches2[1], $matches3[1]) as $url) {
170 $components = parse_url($url);
174 $cookiejar = tempnam(get_temppath(), 'cookiejar-mailstream-');
175 $curlResult = Network::fetchUrlFull($url, true, 0, '', $cookiejar);
176 $attachments[$url] = [
177 'data' => $curlResult->getBody(),
178 'guid' => hash("crc32", $url),
179 'filename' => basename($components['path']),
180 'type' => $curlResult->getContentType()
183 if (strlen($attachments[$url]['data'])) {
184 $item['body'] = str_replace($url, 'cid:' . $attachments[$url]['guid'], $item['body']);
191 function mailstream_sender($item) {
192 $r = q('SELECT * FROM `contact` WHERE `id` = %d', $item['contact-id']);
193 if (DBA::isResult($r)) {
195 if ($contact['name'] != $item['author-name']) {
196 return $contact['name'] . ' - ' . $item['author-name'];
199 return $item['author-name'];
202 function mailstream_decode_subject($subject) {
203 $html = BBCode::convert($subject);
207 $notags = strip_tags($html);
211 $noentity = html_entity_decode($notags);
215 $nocodes = preg_replace_callback("/(&#[0-9]+;)/", function($m) { return mb_convert_encoding($m[1], "UTF-8", "HTML-ENTITIES"); }, $noentity);
219 $trimmed = trim($nocodes);
226 function mailstream_subject($item) {
227 if ($item['title']) {
228 return mailstream_decode_subject($item['title']);
230 $parent = $item['thr-parent'];
231 // Don't look more than 100 levels deep for a subject, in case of loops
232 for ($i = 0; ($i < 100) && $parent; $i++) {
233 $parent_item = Item::selectFirst(['thr-parent', 'title'], ['uri' => $parent]);
234 if (!DBA::isResult($parent_item)) {
237 if ($parent_item['thr-parent'] === $parent) {
240 if ($parent_item['title']) {
241 return L10n::t('Re:') . ' ' . mailstream_decode_subject($parent_item['title']);
243 $parent = $parent_item['thr-parent'];
245 $r = q("SELECT * FROM `contact` WHERE `id` = %d AND `uid` = %d",
246 intval($item['contact-id']), intval($item['uid']));
248 if ($contact['network'] === 'dfrn') {
249 return L10n::t("Friendica post");
251 if ($contact['network'] === 'dspr') {
252 return L10n::t("Diaspora post");
254 if ($contact['network'] === 'face') {
255 $text = mailstream_decode_subject($item['body']);
256 // For some reason these do show up in Facebook
257 $text = preg_replace('/\xA0$/', '', $text);
258 $subject = (strlen($text) > 150) ? (substr($text, 0, 140) . '...') : $text;
259 return preg_replace('/\\s+/', ' ', $subject);
261 if ($contact['network'] === 'feed') {
262 return L10n::t("Feed item");
264 if ($contact['network'] === 'mail') {
265 return L10n::t("Email");
267 return L10n::t("Friendica Item");
270 function mailstream_send(\Friendica\App $a, $message_id, $item, $user) {
271 if (!$item['visible']) {
277 require_once(dirname(__file__).'/phpmailer/class.phpmailer.php');
280 mailstream_do_images($a, $item, $attachments);
281 $frommail = Config::get('mailstream', 'frommail');
282 if ($frommail == "") {
283 $frommail = 'friendica@localhost.local';
285 $address = PConfig::get($item['uid'], 'mailstream', 'address');
287 $address = $user['email'];
289 $mail = new PHPmailer;
291 $mail->XMailer = 'Friendica Mailstream Addon';
292 $mail->SetFrom($frommail, mailstream_sender($item));
293 $mail->AddAddress($address, $user['username']);
294 $mail->MessageID = $message_id;
295 $mail->Subject = mailstream_subject($item);
296 if ($item['thr-parent'] != $item['uri']) {
297 $mail->addCustomHeader('In-Reply-To: ' . mailstream_generate_id($a, $item['thr-parent']));
299 $mail->addCustomHeader('X-Friendica-Mailstream-URI: ' . $item['uri']);
300 $mail->addCustomHeader('X-Friendica-Mailstream-Plink: ' . $item['plink']);
301 $encoding = 'base64';
302 foreach ($attachments as $url => $image) {
303 $mail->AddStringEmbeddedImage($image['data'], $image['guid'], $image['filename'], $encoding, $image['type']);
306 $mail->CharSet = 'utf-8';
307 $template = Renderer::getMarkupTemplate('mail.tpl', 'addon/mailstream/');
308 $mail->AltBody = BBCode::toPlaintext($item['body']);
309 $item['body'] = BBCode::convert($item['body']);
310 $item['url'] = DI::baseUrl()->get() . '/display/' . $item['guid'];
311 $mail->Body = Renderer::replaceMacros($template, [
312 '$upstream' => L10n::t('Upstream'),
313 '$local' => L10n::t('Local'),
315 mailstream_html_wrap($mail->Body);
316 if (!$mail->Send()) {
317 throw new Exception($mail->ErrorInfo);
319 Logger::debug('mailstream_send sent message ' . $mail->MessageID . ' ' . $mail->Subject);
320 } catch (phpmailerException $e) {
321 Logger::debug('mailstream_send PHPMailer exception sending message ' . $message_id . ': ' . $e->errorMessage());
322 } catch (Exception $e) {
323 Logger::debug('mailstream_send exception sending message ' . $message_id . ': ' . $e->getMessage());
325 // In case of failure, still set the item to completed. Otherwise
326 // we'll just try to send it over and over again and it'll fail
328 q('UPDATE `mailstream_item` SET `completed` = now() WHERE `message-id` = "%s"', DBA::escape($message_id));
332 * Email tends to break if you send excessively long lines. To make
333 * bbcode's output suitable for transmission, we try to break things
334 * up so that lines are about 200 characters.
336 function mailstream_html_wrap(&$text)
338 $lines = str_split($text, 200);
339 for ($i = 0; $i < count($lines); $i++) {
340 $lines[$i] = preg_replace('/ /', "\n", $lines[$i], 1);
342 $text = implode($lines);
345 function mailstream_cron($a, $b) {
346 // Only process items older than an hour in cron. This is because
347 // we want to give mailstream_post_remote_hook a fair chance to
348 // send the email itself before cron jumps in. Only if
349 // mailstream_post_remote_hook fails for some reason will this get
350 // used, and in that case it's worth holding off a bit anyway.
351 $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");
352 Logger::debug('mailstream_cron processing ' . count($ms_item_ids) . ' items');
353 foreach ($ms_item_ids as $ms_item_id) {
354 if (!$ms_item_id['message-id'] || !strlen($ms_item_id['message-id'])) {
355 Logger::info('mailstream_cron: Item ' . $ms_item_id['id'] . ' URI ' . $ms_item_id['uri'] . ' has no message-id');
357 $item = Item::selectFirst([], ['id' => $ms_item_id['id']]);
358 $users = q("SELECT * FROM `user` WHERE `uid` = %d", intval($item['uid']));
360 if ($user && $item) {
361 mailstream_send($a, $ms_item_id['message-id'], $item, $user);
364 Logger::info('mailstream_cron: Unable to find item ' . $ms_item_id['id']);
365 q("UPDATE `mailstream_item` SET `completed` = now() WHERE `message-id` = %d", intval($ms_item['message-id']));
371 function mailstream_addon_settings(&$a,&$s) {
372 $enabled = PConfig::get(local_user(), 'mailstream', 'enabled');
373 $address = PConfig::get(local_user(), 'mailstream', 'address');
374 $nolikes = PConfig::get(local_user(), 'mailstream', 'nolikes');
375 $attachimg= PConfig::get(local_user(), 'mailstream', 'attachimg');
376 $template = Renderer::getMarkupTemplate('settings.tpl', 'addon/mailstream/');
377 $s .= Renderer::replaceMacros($template, [
379 'mailstream_enabled',
383 'mailstream_address',
384 L10n::t('Email Address'),
386 L10n::t("Leave blank to use your account email address")],
388 'mailstream_nolikes',
389 L10n::t('Exclude Likes'),
391 L10n::t("Check this to omit mailing \"Like\" notifications")],
393 'mailstream_attachimg',
394 L10n::t('Attach Images'),
396 L10n::t("Download images in posts and attach them to the email. Useful for reading email while offline.")],
397 '$title' => L10n::t('Mail Stream Settings'),
398 '$submit' => L10n::t('Save Settings')]);
401 function mailstream_addon_settings_post($a,$post) {
402 if ($_POST['mailstream_address'] != "") {
403 PConfig::set(local_user(), 'mailstream', 'address', $_POST['mailstream_address']);
406 PConfig::delete(local_user(), 'mailstream', 'address');
408 if ($_POST['mailstream_nolikes']) {
409 PConfig::set(local_user(), 'mailstream', 'nolikes', $_POST['mailstream_enabled']);
412 PConfig::delete(local_user(), 'mailstream', 'nolikes');
414 if ($_POST['mailstream_enabled']) {
415 PConfig::set(local_user(), 'mailstream', 'enabled', $_POST['mailstream_enabled']);
418 PConfig::delete(local_user(), 'mailstream', 'enabled');
420 if ($_POST['mailstream_attachimg']) {
421 PConfig::set(local_user(), 'mailstream', 'attachimg', $_POST['mailstream_attachimg']);
424 PConfig::delete(local_user(), 'mailstream', 'attachimg');
428 function mailstream_tidy() {
429 $r = q("SELECT id FROM mailstream_item WHERE completed IS NOT NULL AND completed < DATE_SUB(NOW(), INTERVAL 1 YEAR)");
430 foreach ($r as $rr) {
431 q('DELETE FROM mailstream_item WHERE id = %d', intval($rr['id']));
433 Logger::debug('mailstream_tidy: deleted ' . count($r) . ' old items');