* Author: Matthew Exon <http://mat.exon.name>
*/
+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;
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('cron', 'addon/mailstream/mailstream.php', 'mailstream_cron');
Hook::register('mailstream_send_hook', 'addon/mailstream/mailstream.php', 'mailstream_send_hook');
Logger::info("mailstream: installed");
'addon/mailstream/mailstream.php',
'mailstream_convert_table_entries'
);
- Hook::fork(PRIORITY_LOW, 'mailstream_convert_table_entries');
+ Hook::fork(Worker::PRIORITY_LOW, 'mailstream_convert_table_entries');
}
}
/**
- * This function indicates a module that can be wrapped in the LegacyModule class
+ * 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_module() {}
/**
* 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)
+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.')];
+ 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')]);
+ '$frommail' => $config,
+ '$submit' => DI::l10n()->t('Save Settings')
+ ]);
}
/**
*
* @return string the created message ID
*/
-function mailstream_generate_id($uri)
+function mailstream_generate_id(string $uri): string
{
- $host = DI::baseUrl()->getHostname();
+ $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_send_hook(&$a, $data)
+function mailstream_send_hook(array $data)
{
$criteria = array('uid' => $data['uid'], 'contact-id' => $data['contact-id'], 'uri' => $data['uri']);
$item = Post::selectFirst([], $criteria);
* mailstream is enabled and the necessary data is available, forks a
* workerqueue item to send the email.
*
- * @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)
+ * @param array $item content of the item (may or may not already be stored in the item table)
+ * @return void
*/
-function mailstream_post_hook(&$a, &$item)
+function mailstream_post_hook(array &$item)
{
mailstream_check_version();
if (!DI::pConfig()->get($item['uid'], 'mailstream', 'enabled')) {
- Logger::debug('mailstream: not enabled for item ' . $item['id']);
+ Logger::debug('mailstream: not enabled.', ['item' => $item['id'], ' uid ' => $item['uid']]);
return;
}
if (!$item['uid']) {
Logger::debug('mailstream: no uri for item ' . $item['id']);
return;
}
- if (!$item['plink']) {
- Logger::debug('mailstream: no plink for item ' . $item['id']);
+ if ($item['verb'] == Activity::ANNOUNCE) {
+ Logger::debug('mailstream: announce item ', ['item' => $item['id']]);
return;
}
if (DI::pConfig()->get($item['uid'], 'mailstream', 'nolikes')) {
$message_id = mailstream_generate_id($item['uri']);
- $send_hook_data = array('uid' => $item['uid'],
- 'contact-id' => $item['contact-id'],
- 'uri' => $item['uri'],
- 'message_id' => $message_id,
- 'tries' => 0);
- Hook::fork(PRIORITY_LOW, 'mailstream_send_hook', $send_hook_data);
+ $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);
}
/**
*
* @return array new value of the attachments table (results are also stored in the reference parameter)
*/
-function mailstream_do_images(&$item, &$attachments)
+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(get_temppath(), 'cookiejar-mailstream-');
- $curlResult = DI::httpClient()->fetchFull($url, 0, '', $cookiejar);
+
+ $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),
+ 'guid' => hash('crc32', $url),
'filename' => basename($components['path']),
'type' => $curlResult->getContentType()
];
continue;
}
}
+
return $attachments;
}
*
* @return string sender suitable for use in the email
*/
-function mailstream_sender($item)
+function mailstream_sender(array $item): string
{
- $r = q('SELECT * FROM `contact` WHERE `id` = %d', $item['contact-id']);
- if (DBA::isResult($r)) {
- $contact = $r[0];
+ $contact = Contact::getById($item['contact-id']);
+ if (DBA::isResult($contact)) {
if ($contact['name'] != $item['author-name']) {
return $contact['name'] . ' - ' . $item['author-name'];
}
* 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($subject)
+function mailstream_decode_subject(string $subject, int $uri_id): string
{
- $html = BBCode::convert($subject);
+ $html = BBCode::convertForUriId($uri_id, $subject);
if (!$html) {
return $subject;
}
return $notags;
}
$nocodes = preg_replace_callback("/(&#[0-9]+;)/", function ($m) {
- return mb_convert_encoding($m[1], "UTF-8", "HTML-ENTITIES");
+ return mb_convert_encoding($m[1], 'UTF-8', 'HTML-ENTITIES');
}, $noentity);
if (!$nocodes) {
return $noentity;
*
* @return string subject line suitable for use in the email
*/
-function mailstream_subject($item)
+function mailstream_subject(array $item): string
{
if ($item['title']) {
- return mailstream_decode_subject($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
break;
}
if ($parent_item['title']) {
- return DI::l10n()->t('Re:') . ' ' . mailstream_decode_subject($parent_item['title']);
+ return DI::l10n()->t('Re:') . ' ' . mailstream_decode_subject($parent_item['title'], $item['uri-id']);
}
$parent = $parent_item['thr-parent'];
}
- $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',
- ['id' => $item['id'],
- 'plink' => $item['plink'],
- 'contact id' => $item['contact-id'],
- 'uid' => $item['uid']]
- );
+ $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");
}
- $contact = $r[0];
if ($contact['network'] === 'dfrn') {
return DI::l10n()->t("Friendica post");
}
return DI::l10n()->t("Diaspora post");
}
if ($contact['network'] === 'face') {
- $text = mailstream_decode_subject($item['body']);
+ $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 bool True if this message has been completed. False if it should be retried.
*/
-function mailstream_send($message_id, $item, $user)
+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;
+ return false;
}
if (!$item['visible']) {
'user email' => $user['email']]);
return true;
}
- require_once(dirname(__file__).'/phpmailer/class.phpmailer.php');
+
+ 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 == "") {
+ if ($frommail == '') {
$frommail = 'friendica@localhost.local';
}
$address = DI::pConfig()->get($item['uid'], 'mailstream', 'address');
if (!$address) {
$address = $user['email'];
}
- $mail = new PHPmailer;
+ $mail = new PHPmailer();
try {
$mail->XMailer = 'Friendica Mailstream Addon';
$mail->SetFrom($frommail, mailstream_sender($item));
$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']);
+ if ($item['plink']) {
+ $mail->addCustomHeader('X-Friendica-Mailstream-Plink: ' . $item['plink']);
+ }
$encoding = 'base64';
foreach ($attachments as $url => $image) {
$mail->AddStringEmbeddedImage(
$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()->get() . '/display/' . $item['guid'];
+ $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]);
- mailstream_html_wrap($mail->Body);
+ $mail->Body = mailstream_html_wrap($mail->Body);
if (!$mail->Send()) {
throw new Exception($mail->ErrorInfo);
}
* 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
+ * @param string $text text to word wrap
+ * @return string wrapped text
*/
-function mailstream_html_wrap(&$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_convert_table_entries()
{
- $query = <<< EOT
-SELECT
- `message-id`,
- `uri`,
- `uid`,
- `contact-id`
-FROM
- `mailstream_item`
-WHERE
- `mailstream_item`.`completed` IS NULL
-
-EOT;
- $ms_item_ids = q($query);
- if (DBA::isResult($ms_item_ids)) {
- 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_cron: Item ' .
- $ms_item_id['id'] . ' URI ' . $ms_item_id['uri'] . ' has no message-id');
- continue;
- }
- Logger::info('mailstream_convert_table_entries: convert item to workerqueue', $send_hook_data);
- Hook::fork(PRIORITY_LOW, 'mailstream_send_hook', $send_hook_data);
+ $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);
}
- q('DROP TABLE `mailstream_item`');
+ DBA::e('DROP TABLE `mailstream_item`');
}
/**
* Form for configuring mailstream features for a user
*
- * @param Friendica\App $a App object
- * @param string $o HTML form data
+ * @param array $data Hook data array
+ * @throws \Friendica\Network\HTTPException\ServiceUnavailableException
*/
-function mailstream_addon_settings(&$a, &$s)
+function mailstream_addon_settings(array &$data)
{
- $enabled = DI::pConfig()->get(local_user(), 'mailstream', 'enabled');
- $address = DI::pConfig()->get(local_user(), 'mailstream', 'address');
- $nolikes = DI::pConfig()->get(local_user(), 'mailstream', 'nolikes');
- $attachimg= DI::pConfig()->get(local_user(), 'mailstream', 'attachimg');
- $template = Renderer::getMarkupTemplate('settings.tpl', 'addon/mailstream/');
- $s .= Renderer::replaceMacros($template, [
- '$enabled' => [
+ $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' => [
+ '$address' => [
'mailstream_address',
DI::l10n()->t('Email Address'),
$address,
- DI::l10n()->t("Leave blank to use your account email address")
+ DI::l10n()->t('Leave blank to use your account email address')
],
- '$nolikes' => [
+ '$nolikes' => [
'mailstream_nolikes',
DI::l10n()->t('Exclude Likes'),
$nolikes,
- DI::l10n()->t("Check this to omit mailing \"Like\" notifications")
+ 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.")
+ 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')]);
+ ]);
+
+ $data = [
+ 'addon' => 'mailstream',
+ 'title' => DI::l10n()->t('Mail Stream Settings'),
+ 'html' => $html,
+ ];
}
/**
* Process data submitted to user's mailstream features form
- * @param \Friendica\App $a
* @param array $post POST data
+ * @return void
*/
-function mailstream_addon_settings_post(\Friendica\App $a, array $post)
+function mailstream_addon_settings_post(array $post)
{
- if (!local_user() || empty($post['mailstream-submit'])) {
+ if (!DI::userSession()->getLocalUserId() || empty($post['mailstream-submit'])) {
return;
}
if ($post['mailstream_address'] != "") {
- DI::pConfig()->set(local_user(), 'mailstream', 'address', $post['mailstream_address']);
+ DI::pConfig()->set(DI::userSession()->getLocalUserId(), 'mailstream', 'address', $post['mailstream_address']);
} else {
- DI::pConfig()->delete(local_user(), 'mailstream', 'address');
+ DI::pConfig()->delete(DI::userSession()->getLocalUserId(), 'mailstream', 'address');
}
if ($post['mailstream_nolikes']) {
- DI::pConfig()->set(local_user(), 'mailstream', 'nolikes', $post['mailstream_enabled']);
+ DI::pConfig()->set(DI::userSession()->getLocalUserId(), 'mailstream', 'nolikes', $post['mailstream_enabled']);
} else {
- DI::pConfig()->delete(local_user(), 'mailstream', 'nolikes');
+ DI::pConfig()->delete(DI::userSession()->getLocalUserId(), 'mailstream', 'nolikes');
}
if ($post['mailstream_enabled']) {
- DI::pConfig()->set(local_user(), 'mailstream', 'enabled', $post['mailstream_enabled']);
+ DI::pConfig()->set(DI::userSession()->getLocalUserId(), 'mailstream', 'enabled', $post['mailstream_enabled']);
} else {
- DI::pConfig()->delete(local_user(), 'mailstream', 'enabled');
+ DI::pConfig()->delete(DI::userSession()->getLocalUserId(), 'mailstream', 'enabled');
}
if ($post['mailstream_attachimg']) {
- DI::pConfig()->set(local_user(), 'mailstream', 'attachimg', $post['mailstream_attachimg']);
+ DI::pConfig()->set(DI::userSession()->getLocalUserId(), 'mailstream', 'attachimg', $post['mailstream_attachimg']);
} else {
- DI::pConfig()->delete(local_user(), 'mailstream', 'attachimg');
+ DI::pConfig()->delete(DI::userSession()->getLocalUserId(), 'mailstream', 'attachimg');
}
}