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;
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 (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 (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 (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 (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 (Config::get('mailstream', 'dbversion') == '0.5') {
48 Config::set('mailstream', 'dbversion', '1.0');
51 if (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 = Config::get('mailstream', 'frommail');
78 $template = Renderer::getMarkupTemplate('admin.tpl', 'addon/mailstream/');
79 $config = ['frommail',
80 L10n::t('From Address'),
82 L10n::t('Email address that stream items will appear to be from.')];
83 $o .= Renderer::replaceMacros($template, [
84 '$frommail' => $config,
85 '$submit' => 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 = $a->getHostName();
97 $resource = hash('md5', $uri);
98 $message_id = "<" . $resource . "@" . $host . ">";
99 Logger::log('mailstream: Generated message ID ' . $message_id . ' for URI ' . $uri, Logger::DEBUG);
103 function mailstream_post_hook(&$a, &$item) {
104 if (!PConfig::get($item['uid'], 'mailstream', 'enabled')) {
110 if (!$item['contact-id']) {
116 if (PConfig::get($item['uid'], 'mailstream', 'nolikes')) {
117 if ($item['verb'] == ACTIVITY_LIKE) {
122 $message_id = mailstream_generate_id($a, $item['uri']);
123 q("INSERT INTO `mailstream_item` (`uid`, `contact-id`, `uri`, `message-id`) " .
124 "VALUES (%d, '%s', '%s', '%s')", intval($item['uid']),
125 intval($item['contact-id']), DBA::escape($item['uri']), DBA::escape($message_id));
126 $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']));
127 if (count($r) != 1) {
128 Logger::log('mailstream_post_remote_hook: Unexpected number of items returned from mailstream_item', Logger::INFO);
132 Logger::log('mailstream_post_remote_hook: created mailstream_item '
133 . $ms_item['id'] . ' for item ' . $item['uri'] . ' '
134 . $item['uid'] . ' ' . $item['contact-id'], Logger::DATA);
135 $user = mailstream_get_user($item['uid']);
137 Logger::log('mailstream_post_remote_hook: no user ' . $item['uid'], Logger::INFO);
140 mailstream_send($a, $ms_item['message-id'], $item, $user);
143 function mailstream_get_user($uid) {
144 $r = q('SELECT * FROM `user` WHERE `uid` = %d', intval($uid));
145 if (count($r) != 1) {
146 Logger::log('mailstream_post_remote_hook: Unexpected number of users returned', Logger::INFO);
152 function mailstream_do_images($a, &$item, &$attachments) {
153 if (!PConfig::get($item['uid'], 'mailstream', 'attachimg')) {
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) {
161 $cookiejar = tempnam(get_temppath(), 'cookiejar-mailstream-');
162 $curlResult = Network::fetchUrlFull($url, true, $redirects, 0, null, $cookiejar);
163 $attachments[$url] = [
164 'data' => $curlResult->getBody(),
165 'guid' => hash("crc32", $url),
166 'filename' => basename($url),
167 'type' => $curlResult->getContentType()
170 if (strlen($attachments[$url]['data'])) {
171 $item['body'] = str_replace($url, 'cid:' . $attachments[$url]['guid'], $item['body']);
178 function mailstream_sender($item) {
179 $r = q('SELECT * FROM `contact` WHERE `id` = %d', $item['contact-id']);
180 if (DBA::isResult($r)) {
182 if ($contact['name'] != $item['author-name']) {
183 return $contact['name'] . ' - ' . $item['author-name'];
186 return $item['author-name'];
189 function mailstream_decode_subject($subject) {
190 $html = BBCode::convert($subject);
194 $notags = strip_tags($html);
198 $noentity = html_entity_decode($notags);
202 $nocodes = preg_replace_callback("/(&#[0-9]+;)/", function($m) { return mb_convert_encoding($m[1], "UTF-8", "HTML-ENTITIES"); }, $noentity);
206 $trimmed = trim($nocodes);
213 function mailstream_subject($item) {
214 if ($item['title']) {
215 return mailstream_decode_subject($item['title']);
217 $parent = $item['thr-parent'];
218 // Don't look more than 100 levels deep for a subject, in case of loops
219 for ($i = 0; ($i < 100) && $parent; $i++) {
220 $parent_item = Item::selectFirst(['thr-parent', 'title'], ['uri' => $parent]);
221 if (!DBA::isResult($parent_item)) {
224 if ($parent_item['thr-parent'] === $parent) {
227 if ($parent_item['title']) {
228 return L10n::t('Re:') . ' ' . mailstream_decode_subject($parent_item['title']);
230 $parent = $parent_item['thr-parent'];
232 $r = q("SELECT * FROM `contact` WHERE `id` = %d AND `uid` = %d",
233 intval($item['contact-id']), intval($item['uid']));
235 if ($contact['network'] === 'dfrn') {
236 return L10n::t("Friendica post");
238 if ($contact['network'] === 'dspr') {
239 return L10n::t("Diaspora post");
241 if ($contact['network'] === 'face') {
242 $text = mailstream_decode_subject($item['body']);
243 // For some reason these do show up in Facebook
244 $text = preg_replace('/\xA0$/', '', $text);
245 $subject = (strlen($text) > 150) ? (substr($text, 0, 140) . '...') : $text;
246 return preg_replace('/\\s+/', ' ', $subject);
248 if ($contact['network'] === 'feed') {
249 return L10n::t("Feed item");
251 if ($contact['network'] === 'mail') {
252 return L10n::t("Email");
254 return L10n::t("Friendica Item");
257 function mailstream_send(\Friendica\App $a, $message_id, $item, $user) {
258 if (!$item['visible']) {
264 require_once(dirname(__file__).'/phpmailer/class.phpmailer.php');
267 mailstream_do_images($a, $item, $attachments);
268 $frommail = Config::get('mailstream', 'frommail');
269 if ($frommail == "") {
270 $frommail = 'friendica@localhost.local';
272 $address = PConfig::get($item['uid'], 'mailstream', 'address');
274 $address = $user['email'];
276 $mail = new PHPmailer;
278 $mail->XMailer = 'Friendica Mailstream Addon';
279 $mail->SetFrom($frommail, mailstream_sender($item));
280 $mail->AddAddress($address, $user['username']);
281 $mail->MessageID = $message_id;
282 $mail->Subject = mailstream_subject($item);
283 if ($item['thr-parent'] != $item['uri']) {
284 $mail->addCustomHeader('In-Reply-To: ' . mailstream_generate_id($a, $item['thr-parent']));
286 $mail->addCustomHeader('X-Friendica-Mailstream-URI: ' . $item['uri']);
287 $mail->addCustomHeader('X-Friendica-Mailstream-Plink: ' . $item['plink']);
288 $encoding = 'base64';
289 foreach ($attachments as $url => $image) {
290 $mail->AddStringEmbeddedImage($image['data'], $image['guid'], $image['filename'], $encoding, $image['type']);
293 $mail->CharSet = 'utf-8';
294 $template = Renderer::getMarkupTemplate('mail.tpl', 'addon/mailstream/');
295 $item['body'] = BBCode::convert($item['body']);
296 $item['url'] = $a->getBaseURL() . '/display/' . $item['guid'];
297 $mail->Body = Renderer::replaceMacros($template, [
298 '$upstream' => L10n::t('Upstream'),
299 '$local' => L10n::t('Local'),
301 mailstream_html_wrap($mail->Body);
302 if (!$mail->Send()) {
303 throw new Exception($mail->ErrorInfo);
305 Logger::log('mailstream_send sent message ' . $mail->MessageID . ' ' . $mail->Subject, Logger::DEBUG);
306 } catch (phpmailerException $e) {
307 Logger::log('mailstream_send PHPMailer exception sending message ' . $message_id . ': ' . $e->errorMessage(), Logger::INFO);
308 } catch (Exception $e) {
309 Logger::log('mailstream_send exception sending message ' . $message_id . ': ' . $e->getMessage(), Logger::INFO);
311 // In case of failure, still set the item to completed. Otherwise
312 // we'll just try to send it over and over again and it'll fail
314 q('UPDATE `mailstream_item` SET `completed` = now() WHERE `message-id` = "%s"', DBA::escape($message_id));
318 * Email tends to break if you send excessively long lines. To make
319 * bbcode's output suitable for transmission, we try to break things
320 * up so that lines are about 200 characters.
322 function mailstream_html_wrap(&$text)
324 $lines = str_split($text, 200);
325 for ($i = 0; $i < count($lines); $i++) {
326 $lines[$i] = preg_replace('/ /', "\n", $lines[$i], 1);
328 $text = implode($lines);
331 function mailstream_cron($a, $b) {
332 // Only process items older than an hour in cron. This is because
333 // we want to give mailstream_post_remote_hook a fair chance to
334 // send the email itself before cron jumps in. Only if
335 // mailstream_post_remote_hook fails for some reason will this get
336 // used, and in that case it's worth holding off a bit anyway.
337 $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");
338 Logger::log('mailstream_cron processing ' . count($ms_item_ids) . ' items', Logger::DEBUG);
339 foreach ($ms_item_ids as $ms_item_id) {
340 if (!$ms_item_id['message-id'] || !strlen($ms_item_id['message-id'])) {
341 Logger::log('mailstream_cron: Item ' . $ms_item_id['id'] . ' URI ' . $ms_item_id['uri'] . ' has no message-id', Logger::INFO);
343 $item = Item::selectFirst([], ['id' => $ms_item_id['id']]);
344 $users = q("SELECT * FROM `user` WHERE `uid` = %d", intval($item['uid']));
346 if ($user && $item) {
347 mailstream_send($a, $ms_item_id['message-id'], $item, $user);
350 Logger::log('mailstream_cron: Unable to find item ' . $ms_item_id['id'], Logger::INFO);
351 q("UPDATE `mailstream_item` SET `completed` = now() WHERE `message-id` = %d", intval($ms_item['message-id']));
357 function mailstream_addon_settings(&$a,&$s) {
358 $enabled = PConfig::get(local_user(), 'mailstream', 'enabled');
359 $address = PConfig::get(local_user(), 'mailstream', 'address');
360 $nolikes = PConfig::get(local_user(), 'mailstream', 'nolikes');
361 $attachimg= PConfig::get(local_user(), 'mailstream', 'attachimg');
362 $template = Renderer::getMarkupTemplate('settings.tpl', 'addon/mailstream/');
363 $s .= Renderer::replaceMacros($template, [
365 'mailstream_enabled',
369 'mailstream_address',
370 L10n::t('Email Address'),
372 L10n::t("Leave blank to use your account email address")],
374 'mailstream_nolikes',
375 L10n::t('Exclude Likes'),
377 L10n::t("Check this to omit mailing \"Like\" notifications")],
379 'mailstream_attachimg',
380 L10n::t('Attach Images'),
382 L10n::t("Download images in posts and attach them to the email. Useful for reading email while offline.")],
383 '$title' => L10n::t('Mail Stream Settings'),
384 '$submit' => L10n::t('Save Settings')]);
387 function mailstream_addon_settings_post($a,$post) {
388 if ($_POST['mailstream_address'] != "") {
389 PConfig::set(local_user(), 'mailstream', 'address', $_POST['mailstream_address']);
392 PConfig::delete(local_user(), 'mailstream', 'address');
394 if ($_POST['mailstream_nolikes']) {
395 PConfig::set(local_user(), 'mailstream', 'nolikes', $_POST['mailstream_enabled']);
398 PConfig::delete(local_user(), 'mailstream', 'nolikes');
400 if ($_POST['mailstream_enabled']) {
401 PConfig::set(local_user(), 'mailstream', 'enabled', $_POST['mailstream_enabled']);
404 PConfig::delete(local_user(), 'mailstream', 'enabled');
406 if ($_POST['mailstream_attachimg']) {
407 PConfig::set(local_user(), 'mailstream', 'attachimg', $_POST['mailstream_attachimg']);
410 PConfig::delete(local_user(), 'mailstream', 'attachimg');
414 function mailstream_tidy() {
415 $r = q("SELECT id FROM mailstream_item WHERE completed IS NOT NULL AND completed < DATE_SUB(NOW(), INTERVAL 1 YEAR)");
416 foreach ($r as $rr) {
417 q('DELETE FROM mailstream_item WHERE id = %d', intval($rr['id']));
419 Logger::log('mailstream_tidy: deleted ' . count($r) . ' old items', Logger::DEBUG);