X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=mailstream%2Fmailstream.php;h=d76ccf86e61cdc8428c52f3fb7beb810a48247f3;hb=d9c54193518678408093f21101b1bcc1c5796d57;hp=047603852df9b7142ed26a641683cafccb0375ba;hpb=84744911c63ee20198d2df7de163ffb381521824;p=friendica-addons.git diff --git a/mailstream/mailstream.php b/mailstream/mailstream.php index 04760385..d76ccf86 100644 --- a/mailstream/mailstream.php +++ b/mailstream/mailstream.php @@ -2,305 +2,562 @@ /** * Name: Mail Stream * Description: Mail all items coming into your network feed to an email address - * Version: 0.2 + * Version: 2.0 * Author: Matthew Exon */ -function mailstream_install() { - register_hook('plugin_settings', 'addon/mailstream/mailstream.php', 'mailstream_plugin_settings'); - register_hook('plugin_settings_post', 'addon/mailstream/mailstream.php', 'mailstream_plugin_settings_post'); - register_hook('post_remote_end', 'addon/mailstream/mailstream.php', 'mailstream_post_remote_hook'); - register_hook('cron', 'addon/mailstream/mailstream.php', 'mailstream_cron'); - - $schema = file_get_contents(dirname(__file__).'/database.sql'); - $arr = explode(';', $schema); - foreach ($arr as $a) { - $r = q($a); - } - - if (get_config('mailstream', 'dbversion') == '0.1') { - q('ALTER TABLE `mailstream_item` DROP INDEX `uid`'); - q('ALTER TABLE `mailstream_item` DROP INDEX `contact-id`'); - q('ALTER TABLE `mailstream_item` DROP INDEX `plink`'); - q('ALTER TABLE `mailstream_item` CHANGE `plink` `uri` char(255) NOT NULL'); - } - if (get_config('mailstream', 'dbversion') == '0.2') { - q('DELETE FROM `pconfig` WHERE `cat` = "mailstream" AND `k` = "delay"'); - } - if (get_config('mailstream', 'dbversion') == '0.3') { - q('ALTER TABLE `mailstream_item` CHANGE `created` `created` timestamp NOT NULL DEFAULT now()'); - q('ALTER TABLE `mailstream_item` CHANGE `completed` `completed` timestamp NULL DEFAULT NULL'); - } - if (get_config('mailstream', 'dbversion') == '0.4') { - q('ALTER TABLE `mailstream_item` CONVERT TO CHARACTER SET utf8 COLLATE utf8_bin'); - } - set_config('mailstream', 'dbversion', '0.5'); +use Friendica\App; +use Friendica\Content\Text\BBCode; +use Friendica\Core\Hook; +use Friendica\Core\Logger; +use Friendica\Core\Renderer; +use Friendica\Core\System; +use Friendica\Core\Worker; +use Friendica\Database\DBA; +use Friendica\DI; +use Friendica\Model\Contact; +use Friendica\Model\Item; +use Friendica\Model\Post; +use Friendica\Model\User; +use Friendica\Network\HTTPClient\Client\HttpClientAccept; +use Friendica\Protocol\Activity; +use Friendica\Util\DateTimeFormat; + +/** + * Sets up the addon hooks and the database table + */ +function mailstream_install() +{ + Hook::register('addon_settings', 'addon/mailstream/mailstream.php', 'mailstream_addon_settings'); + Hook::register('addon_settings_post', 'addon/mailstream/mailstream.php', 'mailstream_addon_settings_post'); + Hook::register('post_local_end', 'addon/mailstream/mailstream.php', 'mailstream_post_hook'); + Hook::register('post_remote_end', 'addon/mailstream/mailstream.php', 'mailstream_post_hook'); + Hook::register('mailstream_send_hook', 'addon/mailstream/mailstream.php', 'mailstream_send_hook'); + + Logger::info("mailstream: installed"); } -function mailstream_uninstall() { - unregister_hook('plugin_settings', 'addon/mailstream/mailstream.php', 'mailstream_plugin_settings'); - unregister_hook('plugin_settings_post', 'addon/mailstream/mailstream.php', 'mailstream_plugin_settings_post'); - unregister_hook('post_remote', 'addon/mailstream/mailstream.php', 'mailstream_post_remote_hook'); - unregister_hook('post_remote_end', 'addon/mailstream/mailstream.php', 'mailstream_post_remote_hook'); - unregister_hook('cron', 'addon/mailstream/mailstream.php', 'mailstream_cron'); - unregister_hook('incoming_mail', 'addon/mailstream/mailstream.php', 'mailstream_incoming_mail'); +/** + * Enforces that mailstream_install has set up the current version + */ +function mailstream_check_version() +{ + if (!is_null(DI::config()->get('mailstream', 'dbversion'))) { + DI::config()->delete('mailstream', 'dbversion'); + Logger::info("mailstream_check_version: old version detected, reinstalling"); + mailstream_install(); + Hook::loadHooks(); + Hook::add( + 'mailstream_convert_table_entries', + 'addon/mailstream/mailstream.php', + 'mailstream_convert_table_entries' + ); + Hook::fork(Worker::PRIORITY_LOW, 'mailstream_convert_table_entries'); + } } +/** + * This is a statement rather than an actual function definition. The simple + * existence of this method is checked to figure out if the addon offers a + * module. + */ function mailstream_module() {} -function mailstream_plugin_admin(&$a,&$o) { - $frommail = get_config('mailstream', 'frommail'); - $template = get_markup_template('admin.tpl', 'addon/mailstream/'); - $config = array('frommail', - t('From Address'), - $frommail, - t('Email address that stream items will appear to be from.')); - $o .= replace_macros($template, array( - '$frommail' => $config, - '$submit' => t('Submit'))); +/** + * Adds an item in "addon features" in the admin menu of the site + * + * @param string $o HTML form data + */ +function mailstream_addon_admin(string &$o) +{ + $frommail = DI::config()->get('mailstream', 'frommail'); + $template = Renderer::getMarkupTemplate('admin.tpl', 'addon/mailstream/'); + $config = ['frommail', + DI::l10n()->t('From Address'), + $frommail, + DI::l10n()->t('Email address that stream items will appear to be from.')]; + $o .= Renderer::replaceMacros($template, [ + '$frommail' => $config, + '$submit' => DI::l10n()->t('Save Settings') + ]); } -function mailstream_plugin_admin_post ($a) { - if (x($_POST, 'frommail')) { - set_config('mailstream', 'frommail', $_POST['frommail']); - } +/** + * Process input from the "addon features" part of the admin menu + */ +function mailstream_addon_admin_post() +{ + if (!empty($_POST['frommail'])) { + DI::config()->set('mailstream', 'frommail', $_POST['frommail']); + } } -function mailstream_generate_id($a, $uri) { - // http://www.jwz.org/doc/mid.html - $host = $a->get_hostname(); - $resource = hash('md5', $uri); - return "<" . $resource . "@" . $host . ">"; +/** + * Creates a message ID for a post URI in accordance with RFC 1036 + * See also http://www.jwz.org/doc/mid.html + * + * @param string $uri the URI to be converted to a message ID + * + * @return string the created message ID + */ +function mailstream_generate_id(string $uri): string +{ + $host = DI::baseUrl()->getHost(); + $resource = hash('md5', $uri); + $message_id = "<" . $resource . "@" . $host . ">"; + Logger::debug('mailstream: Generated message ID ' . $message_id . ' for URI ' . $uri); + return $message_id; } -function mailstream_post_remote_hook(&$a, &$item) { - if (!get_pconfig($item['uid'], 'mailstream', 'enabled')) { - return; - } - if (!$item['uid']) { - return; - } - if (!$item['contact-id']) { - return; - } - if (!$item['uri']) { - return; - } - - q("INSERT INTO `mailstream_item` (`uid`, `contact-id`, `uri`, `message-id`) " . - "VALUES (%d, '%s', '%s', '%s')", intval($item['uid']), - intval($item['contact-id']), dbesc($item['uri']), dbesc(mailstream_generate_id($a, $item['uri']))); - $r = q('SELECT * FROM `mailstream_item` WHERE `uid` = %d AND `contact-id` = %d AND `uri` = "%s"', intval($item['uid']), intval($item['contact-id']), dbesc($item['uri'])); - if (count($r) != 1) { - logger('mailstream_post_remote_hook: Unexpected number of items returned from mailstream_item', LOGGER_NORMAL); - return; - } - $ms_item = $r[0]; - logger('mailstream_post_remote_hook: created mailstream_item ' - . $ms_item['id'] . ' for item ' . $item['uri'] . ' ' - . $item['uid'] . ' ' . $item['contact-id'], LOGGER_DATA); - $user = mailstream_get_user($item['uid']); - if (!$user) { - logger('mailstream_post_remote_hook: no user ' . $item['uid'], LOGGER_NORMAL); - return; - } - mailstream_send($a, $ms_item, $item, $user); +function mailstream_send_hook(array $data) +{ + $criteria = array('uid' => $data['uid'], 'contact-id' => $data['contact-id'], 'uri' => $data['uri']); + $item = Post::selectFirst([], $criteria); + if (empty($item)) { + Logger::error('mailstream_send_hook could not find item'); + return; + } + + $user = User::getById($item['uid']); + if (empty($user)) { + Logger::error('mailstream_send_hook could not fund user', ['uid' => $item['uid']]); + return; + } + + if (!mailstream_send($data['message_id'], $item, $user)) { + Logger::debug('mailstream_send_hook send failed, will retry', $data); + if (!Worker::defer()) { + Logger::error('mailstream_send_hook failed and could not defer', $data); + } + } +} + +/** + * Called when either a local or remote post is created. If + * mailstream is enabled and the necessary data is available, forks a + * workerqueue item to send the email. + * + * @param array $item content of the item (may or may not already be stored in the item table) + * @return void + */ +function mailstream_post_hook(array &$item) +{ + mailstream_check_version(); + + if (!DI::pConfig()->get($item['uid'], 'mailstream', 'enabled')) { + Logger::debug('mailstream: not enabled.', ['item' => $item['id'], ' uid ' => $item['uid']]); + return; + } + if (!$item['uid']) { + Logger::debug('mailstream: no uid for item ' . $item['id']); + return; + } + if (!$item['contact-id']) { + Logger::debug('mailstream: no contact-id for item ' . $item['id']); + return; + } + if (!$item['uri']) { + Logger::debug('mailstream: no uri for item ' . $item['id']); + return; + } + if ($item['verb'] == Activity::ANNOUNCE) { + Logger::debug('mailstream: announce item ', ['item' => $item['id']]); + return; + } + if (DI::pConfig()->get($item['uid'], 'mailstream', 'nolikes')) { + if ($item['verb'] == Activity::LIKE) { + Logger::debug('mailstream: like item ' . $item['id']); + return; + } + } + + $message_id = mailstream_generate_id($item['uri']); + + $send_hook_data = [ + 'uid' => $item['uid'], + 'contact-id' => $item['contact-id'], + 'uri' => $item['uri'], + 'message_id' => $message_id, + 'tries' => 0, + ]; + Hook::fork(Worker::PRIORITY_LOW, 'mailstream_send_hook', $send_hook_data); +} + +/** + * If the user has configured attaching images to emails as + * attachments, this function searches the post for such images, + * retrieves the image, and inserts the data and metadata into the + * supplied array + * + * @param array $item content of the item + * @param array $attachments contains an array element for each attachment to add to the email + * + * @return array new value of the attachments table (results are also stored in the reference parameter) + */ +function mailstream_do_images(array &$item, array &$attachments) +{ + if (!DI::pConfig()->get($item['uid'], 'mailstream', 'attachimg')) { + return; + } + + $attachments = []; + + preg_match_all("/\[img\=([0-9]*)x([0-9]*)\](.*?)\[\/img\]/ism", $item["body"], $matches1); + preg_match_all("/\[img\](.*?)\[\/img\]/ism", $item["body"], $matches2); + preg_match_all("/\[img\=([^\]]*)\]([^[]*)\[\/img\]/ism", $item["body"], $matches3); + + foreach (array_merge($matches1[3], $matches2[1], $matches3[1]) as $url) { + $components = parse_url($url); + + if (!$components) { + continue; + } + + $cookiejar = tempnam(System::getTempPath(), 'cookiejar-mailstream-'); + try { + $curlResult = DI::httpClient()->fetchFull($url, HttpClientAccept::DEFAULT, 0, $cookiejar); + } catch (InvalidArgumentException $e) { + Logger::error('mailstream_do_images exception fetching url', ['url' => $url, 'item_id' => $item['id']]); + continue; + } + $attachments[$url] = [ + 'data' => $curlResult->getBody(), + 'guid' => hash('crc32', $url), + 'filename' => basename($components['path']), + 'type' => $curlResult->getContentType() + ]; + + if (strlen($attachments[$url]['data'])) { + $item['body'] = str_replace($url, 'cid:' . $attachments[$url]['guid'], $item['body']); + continue; + } + } + + return $attachments; } -function mailstream_get_user($uid) { - $r = q('SELECT * FROM `user` WHERE `uid` = %d', intval($uid)); - if (count($r) != 1) { - logger('mailstream_post_remote_hook: Unexpected number of users returned', LOGGER_NORMAL); - return; - } - return $r[0]; +/** + * Creates a sender to use in the email, either from the contact or the author of the item, or both + * + * @param array $item content of the item + * + * @return string sender suitable for use in the email + */ +function mailstream_sender(array $item): string +{ + $contact = Contact::getById($item['contact-id']); + if (DBA::isResult($contact)) { + if ($contact['name'] != $item['author-name']) { + return $contact['name'] . ' - ' . $item['author-name']; + } + } + return $item['author-name']; } -function mailstream_do_images($a, &$item, &$attachments) { - $baseurl = $a->get_baseurl(); - $id = 1; - $matches = array(); - preg_match_all("/\[img\=([0-9]*)x([0-9]*)\](.*?)\[\/img\]/ism", $item["body"], $matches); - if (count($matches)) { - foreach ($matches[3] as $url) { - $attachments[$url] = array(); - } - } - preg_match_all("/\[img\](.*?)\[\/img\]/ism", $item["body"], $matches); - if (count($matches)) { - foreach ($matches[1] as $url) { - $attachments[$url] = array(); - } - } - foreach ($attachments as $url=>$cid) { - if (strncmp($url, $baseurl, strlen($baseurl))) { - unset($attachments[$url]); // Not a local image, don't replace - } - else { - $attachments[$url]['guid'] = substr($url, strlen($baseurl) + strlen('/photo/')); - $r = q("SELECT `data`, `filename`, `type` FROM `photo` WHERE `resource-id` = '%s'", dbesc($attachments[$url]['guid'])); - $attachments[$url]['data'] = $r[0]['data']; - $attachments[$url]['filename'] = $r[0]['filename']; - $attachments[$url]['type'] = $r[0]['type']; - $item['body'] = str_replace($url, 'cid:' . $attachments[$url]['guid'], $item['body']); - } - } +/** + * Converts a bbcode-encoded subject line into a plaintext version suitable for the subject line of an email + * + * @param string $subject bbcode-encoded subject line + * @param int $uri_id + * + * @return string plaintext subject line + */ +function mailstream_decode_subject(string $subject, int $uri_id): string +{ + $html = BBCode::convertForUriId($uri_id, $subject); + if (!$html) { + return $subject; + } + $notags = strip_tags($html); + if (!$notags) { + return $subject; + } + $noentity = html_entity_decode($notags); + if (!$noentity) { + return $notags; + } + $nocodes = preg_replace_callback("/(&#[0-9]+;)/", function ($m) { + return mb_convert_encoding($m[1], 'UTF-8', 'HTML-ENTITIES'); + }, $noentity); + if (!$nocodes) { + return $noentity; + } + $trimmed = trim($nocodes); + if (!$trimmed) { + return $nocodes; + } + return $trimmed; } -function mailstream_subject($item) { - if ($item['title']) { - return $item['title']; - } - $parent = $item['thr-parent']; - // Don't look more than 100 levels deep for a subject, in case of loops - for ($i = 0; ($i < 100) && $parent; $i++) { - $r = q("SELECT `thr-parent`, `title` FROM `item` WHERE `uri` = '%s'", dbesc($parent)); - if (!count($r)) { - break; - } - if ($r[0]['thr-parent'] === $parent) { - break; - } - if ($r[0]['title']) { - return t('Re:') . ' ' . $r[0]['title']; - } - $parent = $r[0]['thr-parent']; - } - $r = q("SELECT * FROM `contact` WHERE `id` = %d AND `uid` = %d", - intval($item['contact-id']), intval($item['uid'])); - $contact = $r[0]; - if ($contact['network'] === 'dfrn') { - return t("Friendica post"); - } - if ($contact['network'] === 'dspr') { - return t("Diaspora post"); - } - if ($contact['network'] === 'face') { - $subject = (strlen($item['body']) > 150) ? (substr($item['body'], 0, 140) . '...') : $item['body']; - return preg_replace('/\\s+/', ' ', $subject); - } - if ($contact['network'] === 'feed') { - return t("Feed item"); - } - if ($contact['network'] === 'mail') { - return t("Email"); - } - return t("Friendica Item"); +/** + * Creates a subject line to use in the email + * + * @param array $item content of the item + * + * @return string subject line suitable for use in the email + */ +function mailstream_subject(array $item): string +{ + if ($item['title']) { + return mailstream_decode_subject($item['title'], $item['uri-id']); + } + $parent = $item['thr-parent']; + // Don't look more than 100 levels deep for a subject, in case of loops + for ($i = 0; ($i < 100) && $parent; $i++) { + $parent_item = Post::selectFirst(['thr-parent', 'title'], ['uri' => $parent]); + if (!DBA::isResult($parent_item)) { + break; + } + if ($parent_item['thr-parent'] === $parent) { + break; + } + if ($parent_item['title']) { + return DI::l10n()->t('Re:') . ' ' . mailstream_decode_subject($parent_item['title'], $item['uri-id']); + } + $parent = $parent_item['thr-parent']; + } + $contact = Contact::selectFirst([], ['id' => $item['contact-id'], 'uid' => $item['uid']]); + if (!DBA::isResult($contact)) { + Logger::error( + 'mailstream_subject no contact for item', + ['id' => $item['id'], + 'plink' => $item['plink'], + 'contact id' => $item['contact-id'], + 'uid' => $item['uid']] + ); + return DI::l10n()->t("Friendica post"); + } + if ($contact['network'] === 'dfrn') { + return DI::l10n()->t("Friendica post"); + } + if ($contact['network'] === 'dspr') { + return DI::l10n()->t("Diaspora post"); + } + if ($contact['network'] === 'face') { + $text = mailstream_decode_subject($item['body'], $item['uri-id']); + // For some reason these do show up in Facebook + $text = preg_replace('/\xA0$/', '', $text); + $subject = (strlen($text) > 150) ? (substr($text, 0, 140) . '...') : $text; + return preg_replace('/\\s+/', ' ', $subject); + } + if ($contact['network'] === 'feed') { + return DI::l10n()->t("Feed item"); + } + if ($contact['network'] === 'mail') { + return DI::l10n()->t("Email"); + } + return DI::l10n()->t("Friendica Item"); } -function mailstream_send($a, $ms_item, $item, $user) { - if (!$item['visible']) { - return; - } - require_once(dirname(__file__).'/class.phpmailer.php'); - require_once('include/bbcode.php'); - $attachments = array(); - mailstream_do_images($a, $item, $attachments); - $frommail = get_config('mailstream', 'frommail'); - if ($frommail == "") { - $frommail = 'friendica@localhost.local'; - } - $address = get_pconfig($item['uid'], 'mailstream', 'address'); - if (!$address) { - $address = $user['email']; - } - $mail = new PHPmailer; - try { - $mail->XMailer = 'Friendica Mailstream Plugin'; - $mail->SetFrom($frommail, $item['author-name']); - $mail->AddAddress($address, $user['username']); - $mail->MessageID = $ms_item['message-id']; - $mail->Subject = mailstream_subject($item); - if ($item['thr-parent'] != $item['uri']) { - $mail->addCustomHeader('In-Reply-To: ' . mailstream_generate_id($a, $item['thr-parent'])); - } - $mail->addCustomHeader('X-Friendica-Mailstream-URI: ' . $item['uri']); - $mail->addCustomHeader('X-Friendica-Mailstream-Plink: ' . $item['plink']); - $encoding = 'base64'; - foreach ($attachments as $url=>$image) { - $mail->AddStringEmbeddedImage($image['data'], $image['guid'], $image['filename'], $encoding, $image['type']); - } - $mail->IsHTML(true); - $mail->CharSet = 'utf-8'; - $template = get_markup_template('mail.tpl', 'addon/mailstream/'); - $item['body'] = bbcode($item['body']); - $item['url'] = $a->get_baseurl() . '/display/' . $user['nickname'] . '/' . $item['id']; - $mail->Body = replace_macros($template, array( - '$upstream' => t('Upstream'), - '$local' => t('Local'), - '$item' => $item)); - if (!$mail->Send()) { - throw new Exception($mail->ErrorInfo); - } - logger('mailstream_send sent message ' . $mail->MessageID . ' ' . $mail->Subject, LOGGER_DEBUG); - } catch (phpmailerException $e) { - logger('mailstream_send PHPMailer exception sending message ' . $ms_item['message-id'] . ': ' . $e->errorMessage(), LOGGER_NORMAL); - } catch (Exception $e) { - logger('mailstream_send exception sending message ' . $ms_item['message-id'] . ': ' . $e->getMessage(), LOGGER_NORMAL); - } - // In case of failure, still set the item to completed. Otherwise - // we'll just try to send it over and over again and it'll fail - // every time. - q("UPDATE `mailstream_item` SET `completed` = now() WHERE `id` = %d", intval($ms_item['id'])); +/** + * Sends a message using PHPMailer + * + * @param string $message_id ID of the message (RFC 1036) + * @param array $item content of the item + * @param array $user results from the user table + * + * @return bool True if this message has been completed. False if it should be retried. + */ +function mailstream_send(string $message_id, array $item, array $user): bool +{ + if (!is_array($item)) { + Logger::error('mailstream_send item is empty', ['message_id' => $message_id]); + return false; + } + + if (!$item['visible']) { + Logger::debug('mailstream_send item not yet visible', ['item uri' => $item['uri']]); + return false; + } + if (!$message_id) { + Logger::error('mailstream_send no message ID supplied', ['item uri' => $item['uri'], + 'user email' => $user['email']]); + return true; + } + + require_once (dirname(__file__) . '/phpmailer/class.phpmailer.php'); + + $item['body'] = Post\Media::addAttachmentsToBody($item['uri-id'], $item['body']); + + $attachments = []; + mailstream_do_images($item, $attachments); + $frommail = DI::config()->get('mailstream', 'frommail'); + if ($frommail == '') { + $frommail = 'friendica@localhost.local'; + } + $address = DI::pConfig()->get($item['uid'], 'mailstream', 'address'); + if (!$address) { + $address = $user['email']; + } + $mail = new PHPmailer(); + try { + $mail->XMailer = 'Friendica Mailstream Addon'; + $mail->SetFrom($frommail, mailstream_sender($item)); + $mail->AddAddress($address, $user['username']); + $mail->MessageID = $message_id; + $mail->Subject = mailstream_subject($item); + if ($item['thr-parent'] != $item['uri']) { + $mail->addCustomHeader('In-Reply-To: ' . mailstream_generate_id($item['thr-parent'])); + } + $mail->addCustomHeader('X-Friendica-Mailstream-URI: ' . $item['uri']); + if ($item['plink']) { + $mail->addCustomHeader('X-Friendica-Mailstream-Plink: ' . $item['plink']); + } + $encoding = 'base64'; + foreach ($attachments as $url => $image) { + $mail->AddStringEmbeddedImage( + $image['data'], + $image['guid'], + $image['filename'], + $encoding, + $image['type'] + ); + } + $mail->IsHTML(true); + $mail->CharSet = 'utf-8'; + $template = Renderer::getMarkupTemplate('mail.tpl', 'addon/mailstream/'); + $mail->AltBody = BBCode::toPlaintext($item['body']); + $item['body'] = BBCode::convertForUriId($item['uri-id'], $item['body'], BBCode::CONNECTORS); + $item['url'] = DI::baseUrl() . '/display/' . $item['guid']; + $mail->Body = Renderer::replaceMacros($template, [ + '$upstream' => DI::l10n()->t('Upstream'), + '$uri' => DI::l10n()->t('URI'), + '$local' => DI::l10n()->t('Local'), + '$item' => $item]); + $mail->Body = mailstream_html_wrap($mail->Body); + if (!$mail->Send()) { + throw new Exception($mail->ErrorInfo); + } + Logger::debug('mailstream_send sent message', ['message ID' => $mail->MessageID, + 'subject' => $mail->Subject, + 'address' => $address]); + } catch (phpmailerException $e) { + Logger::debug('mailstream_send PHPMailer exception sending message ' . $message_id . ': ' . $e->errorMessage()); + } catch (Exception $e) { + Logger::debug('mailstream_send exception sending message ' . $message_id . ': ' . $e->getMessage()); + } + + return true; } -function mailstream_cron($a, $b) { - $ms_items = q("SELECT * FROM `mailstream_item` WHERE `completed` IS NULL LIMIT 100"); - logger('mailstream_cron processing ' . count($ms_items) . ' items', LOGGER_DEBUG); - foreach ($ms_items as $ms_item) { - $items = q("SELECT * FROM `item` WHERE `uid` = %d AND `uri` = '%s' AND `contact-id` = %d", - intval($ms_item['uid']), dbesc($ms_item['uri']), intval($ms_item['contact-id'])); - $item = $items[0]; - $users = q("SELECT * FROM `user` WHERE `uid` = %d", intval($ms_item['uid'])); - $user = $users[0]; - if ($user && $item) { - mailstream_send($a, $ms_item, $item, $user); - } - else { - logger('mailstream_cron: Unable to find item ' . $ms_item['uri'], LOGGER_NORMAL); - q("UPDATE `mailstream_item` SET `completed` = now() WHERE `id` = %d", intval($ms_item['id'])); - } - } - mailstream_tidy(); +/** + * Email tends to break if you send excessively long lines. To make + * bbcode's output suitable for transmission, we try to break things + * up so that lines are about 200 characters. + * + * @param string $text text to word wrap + * @return string wrapped text + */ +function mailstream_html_wrap(string &$text) +{ + $lines = str_split($text, 200); + for ($i = 0; $i < count($lines); $i++) { + $lines[$i] = preg_replace('/ /', "\n", $lines[$i], 1); + } + $text = implode($lines); + return $text; } -function mailstream_plugin_settings(&$a,&$s) { - $enabled = get_pconfig(local_user(), 'mailstream', 'enabled'); - $address = get_pconfig(local_user(), 'mailstream', 'address'); - $template = get_markup_template('settings.tpl', 'addon/mailstream/'); - $s .= replace_macros($template, array( - '$address' => array( - 'mailstream_address', - t('Email Address'), - $address, - t("Leave blank to use your account email address")), - '$enabled' => array( - 'mailstream_enabled', - t('Enabled'), - $enabled), - '$title' => t('Mail Stream Settings'), - '$submit' => t('Submit'))); +/** + * Convert v1 mailstream table entries to v2 workerqueue items + */ +function mailstream_convert_table_entries() +{ + $ms_item_ids = DBA::selectToArray('mailstream_item', [], ['message-id', 'uri', 'uid', 'contact-id'], ["`mailstream_item`.`completed` IS NULL"]); + Logger::debug('mailstream_convert_table_entries processing ' . count($ms_item_ids) . ' items'); + foreach ($ms_item_ids as $ms_item_id) { + $send_hook_data = array('uid' => $ms_item_id['uid'], + 'contact-id' => $ms_item_id['contact-id'], + 'uri' => $ms_item_id['uri'], + 'message_id' => $ms_item_id['message-id'], + 'tries' => 0); + if (!$ms_item_id['message-id'] || !strlen($ms_item_id['message-id'])) { + Logger::info('mailstream_convert_table_entries: item has no message-id.', ['item' => $ms_item_id['id'], 'uri' => $ms_item_id['uri']]); + continue; + } + Logger::info('mailstream_convert_table_entries: convert item to workerqueue', $send_hook_data); + Hook::fork(Worker::PRIORITY_LOW, 'mailstream_send_hook', $send_hook_data); + } + DBA::e('DROP TABLE `mailstream_item`'); } -function mailstream_plugin_settings_post($a,$post) { - if ($_POST['mailstream_address'] != "") { - set_pconfig(local_user(), 'mailstream', 'address', $_POST['mailstream_address']); - } - else { - del_pconfig(local_user(), 'mailstream', 'address'); - } - if ($_POST['mailstream_enabled']) { - set_pconfig(local_user(), 'mailstream', 'enabled', $_POST['mailstream_enabled']); - } - else { - del_pconfig(local_user(), 'mailstream', 'enabled'); - } +/** + * Form for configuring mailstream features for a user + * + * @param array $data Hook data array + * @throws \Friendica\Network\HTTPException\ServiceUnavailableException + */ +function mailstream_addon_settings(array &$data) +{ + $enabled = DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'mailstream', 'enabled'); + $address = DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'mailstream', 'address'); + $nolikes = DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'mailstream', 'nolikes'); + $attachimg = DI::pConfig()->get(DI::userSession()->getLocalUserId(), 'mailstream', 'attachimg'); + + $template = Renderer::getMarkupTemplate('settings.tpl', 'addon/mailstream/'); + $html = Renderer::replaceMacros($template, [ + '$enabled' => [ + 'mailstream_enabled', + DI::l10n()->t('Enabled'), + $enabled + ], + '$address' => [ + 'mailstream_address', + DI::l10n()->t('Email Address'), + $address, + DI::l10n()->t('Leave blank to use your account email address') + ], + '$nolikes' => [ + 'mailstream_nolikes', + DI::l10n()->t('Exclude Likes'), + $nolikes, + DI::l10n()->t('Check this to omit mailing "Like" notifications') + ], + '$attachimg' => [ + 'mailstream_attachimg', + DI::l10n()->t('Attach Images'), + $attachimg, + DI::l10n()->t('Download images in posts and attach them to the email. ' . + 'Useful for reading email while offline.') + ], + ]); + + $data = [ + 'addon' => 'mailstream', + 'title' => DI::l10n()->t('Mail Stream Settings'), + 'html' => $html, + ]; } -function mailstream_tidy() { - $r = q("SELECT id FROM mailstream_item WHERE completed IS NOT NULL AND completed < DATE_SUB(NOW(), INTERVAL 1 YEAR)"); - foreach ($r as $rr) { - q('DELETE FROM mailstream_item WHERE id = %d', intval($rr['id'])); - } - logger('mailstream_tidy: deleted ' . count($r) . ' old items', LOGGER_DEBUG); +/** + * Process data submitted to user's mailstream features form + * @param array $post POST data + * @return void + */ +function mailstream_addon_settings_post(array $post) +{ + if (!DI::userSession()->getLocalUserId() || empty($post['mailstream-submit'])) { + return; + } + + if ($post['mailstream_address'] != "") { + DI::pConfig()->set(DI::userSession()->getLocalUserId(), 'mailstream', 'address', $post['mailstream_address']); + } else { + DI::pConfig()->delete(DI::userSession()->getLocalUserId(), 'mailstream', 'address'); + } + if ($post['mailstream_nolikes']) { + DI::pConfig()->set(DI::userSession()->getLocalUserId(), 'mailstream', 'nolikes', $post['mailstream_enabled']); + } else { + DI::pConfig()->delete(DI::userSession()->getLocalUserId(), 'mailstream', 'nolikes'); + } + if ($post['mailstream_enabled']) { + DI::pConfig()->set(DI::userSession()->getLocalUserId(), 'mailstream', 'enabled', $post['mailstream_enabled']); + } else { + DI::pConfig()->delete(DI::userSession()->getLocalUserId(), 'mailstream', 'enabled'); + } + if ($post['mailstream_attachimg']) { + DI::pConfig()->set(DI::userSession()->getLocalUserId(), 'mailstream', 'attachimg', $post['mailstream_attachimg']); + } else { + DI::pConfig()->delete(DI::userSession()->getLocalUserId(), 'mailstream', 'attachimg'); + } }