X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=mailstream%2Fmailstream.php;h=c22516b3e342de0f9b1fb3461f29e5c2a9a0251a;hb=050b46139b1ee3f61d1ca6d14bd0891fef794863;hp=4eaa5704c24d8e616733981dfc1266b43c7a340d;hpb=fed6e3cde19ae2f864bb378fd484b96fac56ca05;p=friendica-addons.git diff --git a/mailstream/mailstream.php b/mailstream/mailstream.php index 4eaa5704..c22516b3 100644 --- a/mailstream/mailstream.php +++ b/mailstream/mailstream.php @@ -13,10 +13,14 @@ use Friendica\Core\Renderer; use Friendica\Database\DBA; use Friendica\DI; use Friendica\Model\Item; -use Friendica\Network\HTTPRequest; +use Friendica\Model\Post; use Friendica\Protocol\Activity; -function mailstream_install() { +/** + * 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'); @@ -57,22 +61,21 @@ function mailstream_install() { } } -function mailstream_uninstall() { - Hook::unregister('addon_settings', 'addon/mailstream/mailstream.php', 'mailstream_addon_settings'); - Hook::unregister('addon_settings_post', 'addon/mailstream/mailstream.php', 'mailstream_addon_settings_post'); - Hook::unregister('post_local', 'addon/mailstream/mailstream.php', 'mailstream_post_local_hook'); - Hook::unregister('post_remote', 'addon/mailstream/mailstream.php', 'mailstream_post_remote_hook'); - Hook::unregister('post_local_end', 'addon/mailstream/mailstream.php', 'mailstream_post_local_hook'); - Hook::unregister('post_remote_end', 'addon/mailstream/mailstream.php', 'mailstream_post_remote_hook'); - Hook::unregister('post_local_end', 'addon/mailstream/mailstream.php', 'mailstream_post_hook'); - Hook::unregister('post_remote_end', 'addon/mailstream/mailstream.php', 'mailstream_post_hook'); - Hook::unregister('cron', 'addon/mailstream/mailstream.php', 'mailstream_cron'); - Hook::unregister('incoming_mail', 'addon/mailstream/mailstream.php', 'mailstream_incoming_mail'); +/** + * This funciton indicates a module that can be wrapped in the LegacyModule class + */ +function mailstream_module() +{ } -function mailstream_module() {} - -function mailstream_addon_admin(&$a,&$o) { +/** + * Adds an item in "addon features" in the admin menu of the site + * + * @param Friendica\App $a App object (unused) + * @param string $o HTML form data + */ +function mailstream_addon_admin(&$a, &$o) +{ $frommail = DI::config()->get('mailstream', 'frommail'); $template = Renderer::getMarkupTemplate('admin.tpl', 'addon/mailstream/'); $config = ['frommail', @@ -84,14 +87,26 @@ function mailstream_addon_admin(&$a,&$o) { '$submit' => DI::l10n()->t('Save Settings')]); } -function mailstream_addon_admin_post ($a) { +/** + * 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 +/** + * 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($uri) +{ $host = DI::baseUrl()->getHostname(); $resource = hash('md5', $uri); $message_id = "<" . $resource . "@" . $host . ">"; @@ -99,7 +114,16 @@ function mailstream_generate_id($a, $uri) { return $message_id; } -function mailstream_post_hook(&$a, &$item) { +/** + * Called when either a local or remote post is created. Creates a + * record in the mailstream_item table to track this email, and then + * immediately attempts to send it + * + * @param Friendica\App $a App object (unused) + * @param array $item content of the item (may or may not already be stored in the item table) + */ +function mailstream_post_hook(&$a, &$item) +{ if (!DI::pConfig()->get($item['uid'], 'mailstream', 'enabled')) { Logger::debug('mailstream: not enabled for item ' . $item['id']); return; @@ -127,26 +151,45 @@ function mailstream_post_hook(&$a, &$item) { } } - $message_id = mailstream_generate_id($a, $item['uri']); - q("INSERT INTO `mailstream_item` (`uid`, `contact-id`, `uri`, `message-id`) " . - "VALUES (%d, '%s', '%s', '%s')", intval($item['uid']), - intval($item['contact-id']), DBA::escape($item['uri']), DBA::escape($message_id)); - $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'])); + $message_id = mailstream_generate_id($item['uri']); + q( + "INSERT INTO `mailstream_item` (`uid`, `contact-id`, `uri`, `message-id`) " . + "VALUES (%d, '%s', '%s', '%s')", + intval($item['uid']), + intval($item['contact-id']), + DBA::escape($item['uri']), + DBA::escape($message_id) + ); + $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']) + ); if (count($r) != 1) { Logger::info('mailstream_post_remote_hook: Unexpected number of items returned from mailstream_item'); return; } $ms_item = $r[0]; - Logger::debug('mailstream_post_remote_hook: created mailstream_item ' . $ms_item['id'] . ' for item ' . $item['uri'] . ' ' . $item['uid'] . ' ' . $item['contact-id']); + Logger::debug('mailstream_post_remote_hook: created mailstream_item ' . $ms_item['id'] . + ' for item ' . $item['uri'] . ' ' . $item['uid'] . ' ' . $item['contact-id']); $user = mailstream_get_user($item['uid']); if (!$user) { Logger::info('mailstream_post_remote_hook: no user ' . $item['uid']); return; } - mailstream_send($a, $ms_item['message-id'], $item, $user); + mailstream_send($ms_item['message-id'], $item, $user); } -function mailstream_get_user($uid) { +/** + * Converts a user ID into a full user record from the corresponding database table + * + * @param int $uid ID of the user to query + * + * @return array results from the user table + */ +function mailstream_get_user($uid) +{ $r = q('SELECT * FROM `user` WHERE `uid` = %d', intval($uid)); if (count($r) != 1) { Logger::info('mailstream_post_remote_hook: Unexpected number of users returned'); @@ -155,7 +198,19 @@ function mailstream_get_user($uid) { return $r[0]; } -function mailstream_do_images($a, &$item, &$attachments) { +/** + * 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(&$item, &$attachments) +{ if (!DI::pConfig()->get($item['uid'], 'mailstream', 'attachimg')) { return; } @@ -169,7 +224,7 @@ function mailstream_do_images($a, &$item, &$attachments) { continue; } $cookiejar = tempnam(get_temppath(), 'cookiejar-mailstream-'); - $curlResult = DI::httpRequest()->fetchUrlFull($url, true, 0, '', $cookiejar); + $curlResult = DI::httpRequest()->fetchFull($url, 0, '', $cookiejar); $attachments[$url] = [ 'data' => $curlResult->getBody(), 'guid' => hash("crc32", $url), @@ -185,7 +240,15 @@ function mailstream_do_images($a, &$item, &$attachments) { return $attachments; } -function mailstream_sender($item) { +/** + * 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($item) +{ $r = q('SELECT * FROM `contact` WHERE `id` = %d', $item['contact-id']); if (DBA::isResult($r)) { $contact = $r[0]; @@ -196,7 +259,15 @@ function mailstream_sender($item) { return $item['author-name']; } -function mailstream_decode_subject($subject) { +/** + * 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 + * + * @return string plaintext subject line + */ +function mailstream_decode_subject($subject) +{ $html = BBCode::convert($subject); if (!$html) { return $subject; @@ -209,7 +280,9 @@ function mailstream_decode_subject($subject) { if (!$noentity) { return $notags; } - $nocodes = preg_replace_callback("/(&#[0-9]+;)/", function($m) { return mb_convert_encoding($m[1], "UTF-8", "HTML-ENTITIES"); }, $noentity); + $nocodes = preg_replace_callback("/(&#[0-9]+;)/", function ($m) { + return mb_convert_encoding($m[1], "UTF-8", "HTML-ENTITIES"); + }, $noentity); if (!$nocodes) { return $noentity; } @@ -220,14 +293,22 @@ function mailstream_decode_subject($subject) { return $trimmed; } -function mailstream_subject($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($item) +{ if ($item['title']) { return mailstream_decode_subject($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++) { - $parent_item = Item::selectFirst(['thr-parent', 'title'], ['uri' => $parent]); + $parent_item = Post::selectFirst(['thr-parent', 'title'], ['uri' => $parent]); if (!DBA::isResult($parent_item)) { break; } @@ -239,8 +320,18 @@ function mailstream_subject($item) { } $parent = $parent_item['thr-parent']; } - $r = q("SELECT * FROM `contact` WHERE `id` = %d AND `uid` = %d", - intval($item['contact-id']), intval($item['uid'])); + $r = q( + "SELECT * FROM `contact` WHERE `id` = %d AND `uid` = %d", + intval($item['contact-id']), + intval($item['uid']) + ); + if (!DBA::isResult($r)) { + Logger::error( + 'mailstream_subject no contact for item', + ['item id' => $item['id'], 'plink' => $item['plink'], 'contact id' => $item['contact-id'], 'uid' => $item['uid']] + ); + return DI::l10n()->t("Friendica post"); + } $contact = $r[0]; if ($contact['network'] === 'dfrn') { return DI::l10n()->t("Friendica post"); @@ -264,7 +355,15 @@ function mailstream_subject($item) { return DI::l10n()->t("Friendica Item"); } -function mailstream_send(\Friendica\App $a, $message_id, $item, $user) { +/** + * 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 + */ +function mailstream_send($message_id, $item, $user) +{ if (!$item['visible']) { return; } @@ -274,7 +373,7 @@ function mailstream_send(\Friendica\App $a, $message_id, $item, $user) { require_once(dirname(__file__).'/phpmailer/class.phpmailer.php'); $attachments = []; - mailstream_do_images($a, $item, $attachments); + mailstream_do_images($item, $attachments); $frommail = DI::config()->get('mailstream', 'frommail'); if ($frommail == "") { $frommail = 'friendica@localhost.local'; @@ -291,19 +390,25 @@ function mailstream_send(\Friendica\App $a, $message_id, $item, $user) { $mail->MessageID = $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('In-Reply-To: ' . mailstream_generate_id($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->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::convert($item['body']); + $item['body'] = BBCode::convert($item['body'], false, BBCode::CONNECTORS); $item['url'] = DI::baseUrl()->get() . '/display/' . $item['guid']; $mail->Body = Renderer::replaceMacros($template, [ '$upstream' => DI::l10n()->t('Upstream'), @@ -329,6 +434,8 @@ function mailstream_send(\Friendica\App $a, $message_id, $item, $user) { * 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 - modified in-place */ function mailstream_html_wrap(&$text) { @@ -339,33 +446,71 @@ function mailstream_html_wrap(&$text) $text = implode($lines); } -function mailstream_cron($a, $b) { +/** + * Cron job for the mailstream plugin. Sends delayed messages and cleans up old successful entries from the table. + */ +function mailstream_cron() +{ // Only process items older than an hour in cron. This is because // we want to give mailstream_post_remote_hook a fair chance to // send the email itself before cron jumps in. Only if // mailstream_post_remote_hook fails for some reason will this get // used, and in that case it's worth holding off a bit anyway. - $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"); - Logger::debug('mailstream_cron processing ' . count($ms_item_ids) . ' items'); - foreach ($ms_item_ids as $ms_item_id) { - if (!$ms_item_id['message-id'] || !strlen($ms_item_id['message-id'])) { - Logger::info('mailstream_cron: Item ' . $ms_item_id['id'] . ' URI ' . $ms_item_id['uri'] . ' has no message-id'); - } - $item = Item::selectFirst([], ['id' => $ms_item_id['id']]); - $users = q("SELECT * FROM `user` WHERE `uid` = %d", intval($item['uid'])); - $user = $users[0]; - if ($user && $item) { - mailstream_send($a, $ms_item_id['message-id'], $item, $user); - } - else { - Logger::info('mailstream_cron: Unable to find item ' . $ms_item_id['id']); - q("UPDATE `mailstream_item` SET `completed` = now() WHERE `message-id` = %d", intval($ms_item['message-id'])); + $query = <<< EOT +SELECT + `mailstream_item`.`message-id`, + `mailstream_item`.`uri`, + `post-user-view`.`id` +FROM + `mailstream_item` + JOIN + `post-user-view` + ON ( + `mailstream_item`.`uid` = `post-user-view`.`uid` AND + `mailstream_item`.`uri` = `post-user-view`.`uri` AND + `mailstream_item`.`contact-id` = `post-user-view`.`contact-id` + ) +WHERE + `mailstream_item`.`completed` IS NULL AND + `mailstream_item`.`created` < DATE_SUB(NOW(), INTERVAL 1 HOUR) AND + `post-user-view`.`visible` = 1 +ORDER BY `mailstream_item`.`created` +LIMIT 100 + +EOT; + $ms_item_ids = q($query); + if (DBA::isResult($ms_item_ids)) { + Logger::debug('mailstream_cron processing ' . count($ms_item_ids) . ' items'); + foreach ($ms_item_ids as $ms_item_id) { + if (!$ms_item_id['message-id'] || !strlen($ms_item_id['message-id'])) { + Logger::info('mailstream_cron: Item ' . $ms_item_id['id'] . + ' URI ' . $ms_item_id['uri'] . ' has no message-id'); + } + $item = Post::selectFirst([], ['id' => $ms_item_id['id']]); + $users = q("SELECT * FROM `user` WHERE `uid` = %d", intval($item['uid'])); + $user = $users[0]; + if ($user && $item) { + mailstream_send($ms_item_id['message-id'], $item, $user); + } else { + Logger::info('mailstream_cron: Unable to find item ' . $ms_item_id['id']); + q( + "UPDATE `mailstream_item` SET `completed` = now() WHERE `message-id` = %d", + intval($ms_item_id['message-id']) + ); + } } } mailstream_tidy(); } -function mailstream_addon_settings(&$a,&$s) { +/** + * Form for configuring mailstream features for a user + * + * @param Friendica\App $a App object + * @param string $o HTML form data + */ +function mailstream_addon_settings(&$a, &$s) +{ $enabled = DI::pConfig()->get(local_user(), 'mailstream', 'enabled'); $address = DI::pConfig()->get(local_user(), 'mailstream', 'address'); $nolikes = DI::pConfig()->get(local_user(), 'mailstream', 'nolikes'); @@ -390,40 +535,55 @@ function mailstream_addon_settings(&$a,&$s) { '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.")], + DI::l10n()->t("Download images in posts and attach them to the email. " . + "Useful for reading email while offline.")], '$title' => DI::l10n()->t('Mail Stream Settings'), '$submit' => DI::l10n()->t('Save Settings')]); } -function mailstream_addon_settings_post($a,$post) { +/** + * Process data submitted to user's mailstream features form + */ +function mailstream_addon_settings_post() +{ if ($_POST['mailstream_address'] != "") { DI::pConfig()->set(local_user(), 'mailstream', 'address', $_POST['mailstream_address']); - } - else { + } else { DI::pConfig()->delete(local_user(), 'mailstream', 'address'); } if ($_POST['mailstream_nolikes']) { DI::pConfig()->set(local_user(), 'mailstream', 'nolikes', $_POST['mailstream_enabled']); - } - else { + } else { DI::pConfig()->delete(local_user(), 'mailstream', 'nolikes'); } if ($_POST['mailstream_enabled']) { DI::pConfig()->set(local_user(), 'mailstream', 'enabled', $_POST['mailstream_enabled']); - } - else { + } else { DI::pConfig()->delete(local_user(), 'mailstream', 'enabled'); } if ($_POST['mailstream_attachimg']) { DI::pConfig()->set(local_user(), 'mailstream', 'attachimg', $_POST['mailstream_attachimg']); - } - else { + } else { DI::pConfig()->delete(local_user(), 'mailstream', 'attachimg'); } } -function mailstream_tidy() { - $r = q("SELECT id FROM mailstream_item WHERE completed IS NOT NULL AND completed < DATE_SUB(NOW(), INTERVAL 1 YEAR)"); +/** + * Deletes records from the mailstream_item table older than one year + */ +function mailstream_tidy() +{ + $query = <<< EOT +SELECT + id +FROM + mailstream_item +WHERE + completed IS NOT NULL AND + completed < DATE_SUB(NOW(), INTERVAL 1 YEAR) + +EOT; + $r = q($query); foreach ($r as $rr) { q('DELETE FROM mailstream_item WHERE id = %d', intval($rr['id'])); }