]> git.mxchange.org Git - friendica-addons.git/blob - mailstream/mailstream.php
[mahjongg] Remove mahjongg addon because Flash is no longer supported by the browsers
[friendica-addons.git] / mailstream / mailstream.php
1 <?php
2 /**
3  * Name: Mail Stream
4  * Description: Mail all items coming into your network feed to an email address
5  * Version: 1.1
6  * Author: Matthew Exon <http://mat.exon.name>
7  */
8
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;
14 use Friendica\DI;
15 use Friendica\Model\Item;
16 use Friendica\Model\Post;
17 use Friendica\Protocol\Activity;
18
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');
25
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');
32         }
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');
36         }
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');
41         }
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');
45         }
46         if (DI::config()->get('mailstream', 'dbversion') == '0.5') {
47                 DI::config()->set('mailstream', 'dbversion', '1.0');
48         }
49
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) {
54                         $r = q($a);
55                 }
56                 DI::config()->set('mailstream', 'dbversion', '1.0');
57         }
58 }
59
60 function mailstream_module() {}
61
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'),
67                         $frommail,
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')]);
72 }
73
74 function mailstream_addon_admin_post ($a) {
75         if (!empty($_POST['frommail'])) {
76                 DI::config()->set('mailstream', 'frommail', $_POST['frommail']);
77         }
78 }
79
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);
86         return $message_id;
87 }
88
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']);
92                 return;
93         }
94         if (!$item['uid']) {
95                 Logger::debug('mailstream: no uid for item ' . $item['id']);
96                 return;
97         }
98         if (!$item['contact-id']) {
99                 Logger::debug('mailstream: no contact-id for item ' . $item['id']);
100                 return;
101         }
102         if (!$item['uri']) {
103                 Logger::debug('mailstream: no uri for item ' . $item['id']);
104                 return;
105         }
106         if (!$item['plink']) {
107                 Logger::debug('mailstream: no plink for item ' . $item['id']);
108                 return;
109         }
110         if (DI::pConfig()->get($item['uid'], 'mailstream', 'nolikes')) {
111                 if ($item['verb'] == Activity::LIKE) {
112                         Logger::debug('mailstream: like item ' . $item['id']);
113                         return;
114                 }
115         }
116
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');
124                 return;
125         }
126         $ms_item = $r[0];
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']);
129         if (!$user) {
130                 Logger::info('mailstream_post_remote_hook: no user ' . $item['uid']);
131                 return;
132         }
133         mailstream_send($a, $ms_item['message-id'], $item, $user);
134 }
135
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');
140                 return;
141         }
142         return $r[0];
143 }
144
145 function mailstream_do_images($a, &$item, &$attachments) {
146         if (!DI::pConfig()->get($item['uid'], 'mailstream', 'attachimg')) {
147                 return;
148         }
149         $attachments = [];
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);
155                 if (!$components) {
156                         continue;
157                 }
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()
165                 ];
166
167                 if (strlen($attachments[$url]['data'])) {
168                         $item['body'] = str_replace($url, 'cid:' . $attachments[$url]['guid'], $item['body']);
169                         continue;
170                 }
171         }
172         return $attachments;
173 }
174
175 function mailstream_sender($item) {
176         $r = q('SELECT * FROM `contact` WHERE `id` = %d', $item['contact-id']);
177         if (DBA::isResult($r)) {
178                 $contact = $r[0];
179                 if ($contact['name'] != $item['author-name']) {
180                         return $contact['name'] . ' - ' . $item['author-name'];
181                 }
182         }
183         return $item['author-name'];
184 }
185
186 function mailstream_decode_subject($subject) {
187         $html = BBCode::convert($subject);
188         if (!$html) {
189                 return $subject;
190         }
191         $notags = strip_tags($html);
192         if (!$notags) {
193                 return $subject;
194         }
195         $noentity = html_entity_decode($notags);
196         if (!$noentity) {
197                 return $notags;
198         }
199         $nocodes = preg_replace_callback("/(&#[0-9]+;)/", function($m) { return mb_convert_encoding($m[1], "UTF-8", "HTML-ENTITIES"); }, $noentity);
200         if (!$nocodes) {
201                 return $noentity;
202         }
203         $trimmed = trim($nocodes);
204         if (!$trimmed) {
205                 return $nocodes;
206         }
207         return $trimmed;
208 }
209
210 function mailstream_subject($item) {
211         if ($item['title']) {
212                 return mailstream_decode_subject($item['title']);
213         }
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)) {
219                         break;
220                 }
221                 if ($parent_item['thr-parent'] === $parent) {
222                         break;
223                 }
224                 if ($parent_item['title']) {
225                         return DI::l10n()->t('Re:') . ' ' . mailstream_decode_subject($parent_item['title']);
226                 }
227                 $parent = $parent_item['thr-parent'];
228         }
229         $r = q("SELECT * FROM `contact` WHERE `id` = %d AND `uid` = %d",
230                 intval($item['contact-id']), intval($item['uid']));
231         $contact = $r[0];
232         if ($contact['network'] === 'dfrn') {
233                 return DI::l10n()->t("Friendica post");
234         }
235         if ($contact['network'] === 'dspr') {
236                 return DI::l10n()->t("Diaspora post");
237         }
238         if ($contact['network'] === 'face') {
239                 $text = mailstream_decode_subject($item['body']);
240                 // For some reason these do show up in Facebook
241                 $text = preg_replace('/\xA0$/', '', $text);
242                 $subject = (strlen($text) > 150) ? (substr($text, 0, 140) . '...') : $text;
243                 return preg_replace('/\\s+/', ' ', $subject);
244         }
245         if ($contact['network'] === 'feed') {
246                 return DI::l10n()->t("Feed item");
247         }
248         if ($contact['network'] === 'mail') {
249                 return DI::l10n()->t("Email");
250         }
251         return DI::l10n()->t("Friendica Item");
252 }
253
254 function mailstream_send(\Friendica\App $a, $message_id, $item, $user) {
255         if (!$item['visible']) {
256                 return;
257         }
258         if (!$message_id) {
259                 return;
260         }
261         require_once(dirname(__file__).'/phpmailer/class.phpmailer.php');
262
263         $attachments = [];
264         mailstream_do_images($a, $item, $attachments);
265         $frommail = DI::config()->get('mailstream', 'frommail');
266         if ($frommail == "") {
267                 $frommail = 'friendica@localhost.local';
268         }
269         $address = DI::pConfig()->get($item['uid'], 'mailstream', 'address');
270         if (!$address) {
271                 $address = $user['email'];
272         }
273         $mail = new PHPmailer;
274         try {
275                 $mail->XMailer = 'Friendica Mailstream Addon';
276                 $mail->SetFrom($frommail, mailstream_sender($item));
277                 $mail->AddAddress($address, $user['username']);
278                 $mail->MessageID = $message_id;
279                 $mail->Subject = mailstream_subject($item);
280                 if ($item['thr-parent'] != $item['uri']) {
281                         $mail->addCustomHeader('In-Reply-To: ' . mailstream_generate_id($a, $item['thr-parent']));
282                 }
283                 $mail->addCustomHeader('X-Friendica-Mailstream-URI: ' . $item['uri']);
284                 $mail->addCustomHeader('X-Friendica-Mailstream-Plink: ' . $item['plink']);
285                 $encoding = 'base64';
286                 foreach ($attachments as $url => $image) {
287                         $mail->AddStringEmbeddedImage($image['data'], $image['guid'], $image['filename'], $encoding, $image['type']);
288                 }
289                 $mail->IsHTML(true);
290                 $mail->CharSet = 'utf-8';
291                 $template = Renderer::getMarkupTemplate('mail.tpl', 'addon/mailstream/');
292                 $mail->AltBody = BBCode::toPlaintext($item['body']);
293                 $item['body'] = BBCode::convert($item['body']);
294                 $item['url'] = DI::baseUrl()->get() . '/display/' . $item['guid'];
295                 $mail->Body = Renderer::replaceMacros($template, [
296                                                  '$upstream' => DI::l10n()->t('Upstream'),
297                                                  '$local' => DI::l10n()->t('Local'),
298                                                  '$item' => $item]);
299                 mailstream_html_wrap($mail->Body);
300                 if (!$mail->Send()) {
301                         throw new Exception($mail->ErrorInfo);
302                 }
303                 Logger::debug('mailstream_send sent message ' . $mail->MessageID . ' ' . $mail->Subject);
304         } catch (phpmailerException $e) {
305                 Logger::debug('mailstream_send PHPMailer exception sending message ' . $message_id . ': ' . $e->errorMessage());
306         } catch (Exception $e) {
307                 Logger::debug('mailstream_send exception sending message ' . $message_id . ': ' . $e->getMessage());
308         }
309         // In case of failure, still set the item to completed.  Otherwise
310         // we'll just try to send it over and over again and it'll fail
311         // every time.
312         q('UPDATE `mailstream_item` SET `completed` = now() WHERE `message-id` = "%s"', DBA::escape($message_id));
313 }
314
315 /**
316  * Email tends to break if you send excessively long lines.  To make
317  * bbcode's output suitable for transmission, we try to break things
318  * up so that lines are about 200 characters.
319  */
320 function mailstream_html_wrap(&$text)
321 {
322         $lines = str_split($text, 200);
323         for ($i = 0; $i < count($lines); $i++) {
324                 $lines[$i] = preg_replace('/ /', "\n", $lines[$i], 1);
325         }
326         $text = implode($lines);
327 }
328
329 function mailstream_cron($a, $b) {
330         // Only process items older than an hour in cron.  This is because
331         // we want to give mailstream_post_remote_hook a fair chance to
332         // send the email itself before cron jumps in.  Only if
333         // mailstream_post_remote_hook fails for some reason will this get
334         // used, and in that case it's worth holding off a bit anyway.
335         $ms_item_ids = q("SELECT `mailstream_item`.`message-id`, `mailstream_item`.`uri`, `post-view`.`id` FROM `mailstream_item` JOIN `post-view` ON (`mailstream_item`.`uid` = `post-view`.`uid` AND `mailstream_item`.`uri` = `post-view`.`uri` AND `mailstream_item`.`contact-id` = `post-view`.`contact-id`) WHERE `mailstream_item`.`completed` IS NULL AND `mailstream_item`.`created` < DATE_SUB(NOW(), INTERVAL 1 HOUR) AND `post-view`.`visible` = 1 ORDER BY `mailstream_item`.`created` LIMIT 100");
336         Logger::debug('mailstream_cron processing ' . count($ms_item_ids) . ' items');
337         foreach ($ms_item_ids as $ms_item_id) {
338                 if (!$ms_item_id['message-id'] || !strlen($ms_item_id['message-id'])) {
339                         Logger::info('mailstream_cron: Item ' . $ms_item_id['id'] . ' URI ' . $ms_item_id['uri'] . ' has no message-id');
340                 }
341                 $item = Post::selectFirst([], ['id' => $ms_item_id['id']]);
342                 $users = q("SELECT * FROM `user` WHERE `uid` = %d", intval($item['uid']));
343                 $user = $users[0];
344                 if ($user && $item) {
345                         mailstream_send($a, $ms_item_id['message-id'], $item, $user);
346                 }
347                 else {
348                         Logger::info('mailstream_cron: Unable to find item ' . $ms_item_id['id']);
349                         q("UPDATE `mailstream_item` SET `completed` = now() WHERE `message-id` = %d", intval($ms_item_id['message-id']));
350                 }
351         }
352         mailstream_tidy();
353 }
354
355 function mailstream_addon_settings(&$a,&$s) {
356         $enabled = DI::pConfig()->get(local_user(), 'mailstream', 'enabled');
357         $address = DI::pConfig()->get(local_user(), 'mailstream', 'address');
358         $nolikes = DI::pConfig()->get(local_user(), 'mailstream', 'nolikes');
359         $attachimg= DI::pConfig()->get(local_user(), 'mailstream', 'attachimg');
360         $template = Renderer::getMarkupTemplate('settings.tpl', 'addon/mailstream/');
361         $s .= Renderer::replaceMacros($template, [
362                                  '$enabled' => [
363                                         'mailstream_enabled',
364                                         DI::l10n()->t('Enabled'),
365                                         $enabled],
366                                  '$address' => [
367                                         'mailstream_address',
368                                         DI::l10n()->t('Email Address'),
369                                         $address,
370                                         DI::l10n()->t("Leave blank to use your account email address")],
371                                  '$nolikes' => [
372                                         'mailstream_nolikes',
373                                         DI::l10n()->t('Exclude Likes'),
374                                         $nolikes,
375                                         DI::l10n()->t("Check this to omit mailing \"Like\" notifications")],
376                                  '$attachimg' => [
377                                         'mailstream_attachimg',
378                                         DI::l10n()->t('Attach Images'),
379                                         $attachimg,
380                                         DI::l10n()->t("Download images in posts and attach them to the email.  Useful for reading email while offline.")],
381                                  '$title' => DI::l10n()->t('Mail Stream Settings'),
382                                  '$submit' => DI::l10n()->t('Save Settings')]);
383 }
384
385 function mailstream_addon_settings_post($a,$post) {
386         if ($_POST['mailstream_address'] != "") {
387                 DI::pConfig()->set(local_user(), 'mailstream', 'address', $_POST['mailstream_address']);
388         }
389         else {
390                 DI::pConfig()->delete(local_user(), 'mailstream', 'address');
391         }
392         if ($_POST['mailstream_nolikes']) {
393                 DI::pConfig()->set(local_user(), 'mailstream', 'nolikes', $_POST['mailstream_enabled']);
394         }
395         else {
396                 DI::pConfig()->delete(local_user(), 'mailstream', 'nolikes');
397         }
398         if ($_POST['mailstream_enabled']) {
399                 DI::pConfig()->set(local_user(), 'mailstream', 'enabled', $_POST['mailstream_enabled']);
400         }
401         else {
402                 DI::pConfig()->delete(local_user(), 'mailstream', 'enabled');
403         }
404         if ($_POST['mailstream_attachimg']) {
405                 DI::pConfig()->set(local_user(), 'mailstream', 'attachimg', $_POST['mailstream_attachimg']);
406         }
407         else {
408                 DI::pConfig()->delete(local_user(), 'mailstream', 'attachimg');
409         }
410 }
411
412 function mailstream_tidy() {
413         $r = q("SELECT id FROM mailstream_item WHERE completed IS NOT NULL AND completed < DATE_SUB(NOW(), INTERVAL 1 YEAR)");
414         foreach ($r as $rr) {
415                 q('DELETE FROM mailstream_item WHERE id = %d', intval($rr['id']));
416         }
417         Logger::debug('mailstream_tidy: deleted ' . count($r) . ' old items');
418 }