<?php // This file is part of GNU social - https://www.gnu.org/software/social // // GNU social is free software: you can redistribute it and/or modify // it under the terms of the GNU Affero General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // // GNU social is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU Affero General Public License for more details. // // You should have received a copy of the GNU Affero General Public License // along with GNU social. If not, see <http://www.gnu.org/licenses/>. /** * Utilities for sending email * * @category Mail * @package GNUsocial * @author Evan Prodromou <evan@status.net> * @author Zach Copley <zach@status.net> * @author Robin Millette <millette@status.net> * @author Sarven Capadisli <csarven@status.net> * @copyright 2008 StatusNet, Inc. * @license https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later */ defined('GNUSOCIAL') || die(); require_once 'Mail.php'; /** * return the configured mail backend * * Uses the $config array to make a mail backend. Cached so it is safe to call * more than once. * * @return Mail backend */ function mail_backend() { static $backend = null; global $_PEAR; if (!$backend) { $mail = new Mail(); $backend = $mail->factory( common_config('mail', 'backend'), common_config('mail', 'params') ?: [] ); if ($_PEAR->isError($backend)) { throw new EmailException($backend->getMessage(), $backend->getCode()); } } return $backend; } /** * send an email to one or more recipients * * @param array $recipients array of strings with email addresses of recipients * @param array $headers array mapping strings to strings for email headers * @param string $body body of the email * * @return boolean success flag */ function mail_send($recipients, $headers, $body) { global $_PEAR; try { // XXX: use Mail_Queue... maybe $backend = mail_backend(); if (!isset($headers['Content-Type'])) { $headers['Content-Type'] = 'text/plain; charset=UTF-8'; } assert($backend); // throws an error if it's bad $sent = $backend->send($recipients, $headers, $body); if ($_PEAR->isError($sent)) { throw new EmailException($sent->getMessage(), $sent->getCode()); } return true; } catch (PEAR_Exception $e) { common_log( LOG_ERR, "Unable to send email - '{$e->getMessage()}'. " . 'Is your mail subsystem set up correctly?' ); return false; } } /** * returns the configured mail domain * * Defaults to the server name. * * @return string mail domain, suitable for making email addresses. */ function mail_domain() { $maildomain = common_config('mail', 'domain'); if (!$maildomain) { $maildomain = common_config('site', 'server'); } return $maildomain; } /** * returns a good address for sending email from this server * * Uses either the configured value or a faked-up value made * from the mail domain. * * @return string notify from address */ function mail_notify_from() { $notifyfrom = common_config('mail', 'notifyfrom'); if (!$notifyfrom) { $domain = mail_domain(); $notifyfrom = '"'. str_replace('"', '\\"', common_config('site', 'name')) .'" <noreply@'.$domain.'>'; } return $notifyfrom; } /** * sends email to a user * * @param User &$user user to send email to * @param string $subject subject of the email * @param string $body body of the email * @param array $headers optional list of email headers * @param string $address optional specification of email address * * @return boolean success flag */ function mail_to_user($user, $subject, $body, $headers=array(), $address=null) { if (!$address) { $address = $user->email; } $recipients = $address; $profile = $user->getProfile(); $headers['Date'] = date("r", time()); $headers['From'] = mail_notify_from(); $headers['To'] = $profile->getBestName() . ' <' . $address . '>'; $headers['Subject'] = $subject; return mail_send($recipients, $headers, $body); } /** * notify a user of subscription by another user * * This is just a wrapper around the profile-based version. * * @param User $listenee user who is being subscribed to * @param User $listener user who is subscribing * * @see mail_subscribe_notify_profile() * * @return void */ function mail_subscribe_notify($listenee, $listener) { $other = $listener->getProfile(); mail_subscribe_notify_profile($listenee, $other); } /** * notify a user of subscription by a profile (remote or local) * * This function checks to see if the listenee has an email * address and wants subscription notices. * * @param User $listenee user who's being subscribed to * @param Profile $other profile of person who's listening * * @return void */ function mail_subscribe_notify_profile($listenee, $other) { if ($other->hasRight(Right::EMAILONSUBSCRIBE) && $listenee->email && $listenee->emailnotifysub) { $profile = $listenee->getProfile(); $name = $profile->getBestName(); $long_name = $other->getFancyName(); $recipients = $listenee->email; // use the recipient's localization common_switch_locale($listenee->language); $headers = _mail_prepare_headers('subscribe', $listenee->nickname, $other->nickname); $headers['From'] = mail_notify_from(); $headers['To'] = $name . ' <' . $listenee->email . '>'; // TRANS: Subject of new-subscriber notification e-mail. // TRANS: %1$s is the subscribing user's nickname, %2$s is the StatusNet sitename. $headers['Subject'] = sprintf( _('%1$s is now following you on %2$s.'), $other->getBestName(), common_config('site', 'name') ); // TRANS: Main body of new-subscriber notification e-mail. // TRANS: %1$s is the subscriber's long name, %2$s is the StatusNet sitename. $body = sprintf( _('%1$s is now following you on %2$s.'), $long_name, common_config('site', 'name') ) . mail_profile_block($other) . mail_footer_block(); // reset localization common_switch_locale(); mail_send($recipients, $headers, $body); } } function mail_subscribe_pending_notify_profile($listenee, $other) { if ($other->hasRight(Right::EMAILONSUBSCRIBE) && $listenee->email && $listenee->emailnotifysub) { $profile = $listenee->getProfile(); $name = $profile->getBestName(); $long_name = ($other->fullname) ? ($other->fullname . ' (' . $other->nickname . ')') : $other->nickname; $recipients = $listenee->email; // use the recipient's localization common_switch_locale($listenee->language); $headers = _mail_prepare_headers('subscribe', $listenee->nickname, $other->nickname); $headers['From'] = mail_notify_from(); $headers['To'] = $name . ' <' . $listenee->email . '>'; // TRANS: Subject of pending new-subscriber notification e-mail. // TRANS: %1$s is the subscribing user's nickname, %2$s is the StatusNet sitename. $headers['Subject'] = sprintf( _('%1$s would like to listen to '. 'your notices on %2$s.'), $other->getBestName(), common_config('site', 'name') ); // TRANS: Main body of pending new-subscriber notification e-mail. // TRANS: %1$s is the subscriber's long name, %2$s is the StatusNet sitename. $body = sprintf( _('%1$s would like to listen to your notices on %2$s. ' . 'You may approve or reject their subscription at %3$s'), $long_name, common_config('site', 'name'), common_local_url('subqueue', ['nickname' => $listenee->nickname]) ) . mail_profile_block($other) . mail_footer_block(); // reset localization common_switch_locale(); mail_send($recipients, $headers, $body); } } function mail_footer_block() { // TRANS: Common footer block for StatusNet notification emails. // TRANS: %1$s is the StatusNet sitename, // TRANS: %2$s is a link to the addressed user's e-mail settings. return "\n\n" . sprintf( _('Faithfully yours,'. "\n".'%1$s.'."\n\n". "----\n". "Change your email address or ". "notification options at ".'%2$s'), common_config('site', 'name'), common_local_url('emailsettings') ) . "\n"; } /** * Format a block of profile info for a plaintext notification email. * * @param Profile $profile * @return string */ function mail_profile_block($profile) { // TRANS: Layout for // TRANS: %1$s is the subscriber's profile URL, %2$s is the subscriber's location (or empty) // TRANS: %3$s is the subscriber's homepage URL (or empty), %4%s is the subscriber's bio (or empty) $out = array(); $out[] = ""; $out[] = ""; // TRANS: Profile info line in notification e-mail. // TRANS: %s is a URL. $out[] = sprintf(_("Profile: %s"), $profile->profileurl); if ($profile->location) { // TRANS: Profile info line in notification e-mail. // TRANS: %s is a location. $out[] = sprintf(_("Location: %s"), $profile->location); } if ($profile->homepage) { // TRANS: Profile info line in notification e-mail. // TRANS: %s is a homepage. $out[] = sprintf(_("Homepage: %s"), $profile->homepage); } if ($profile->bio) { // TRANS: Profile info line in notification e-mail. // TRANS: %s is biographical information. $out[] = sprintf(_("Bio: %s"), $profile->bio); } $blocklink = common_local_url('block', array('profileid' => $profile->id)); // This'll let ModPlus add the remote profile info so it's possible // to block remote users directly... Event::handle('MailProfileInfoBlockLink', array($profile, &$blocklink)); // TRANS: This is a paragraph in a new-subscriber e-mail. // TRANS: %s is a URL where the subscriber can be reported as abusive. $out[] = sprintf( _('If you believe this account is being used abusively, ' . 'you can block them from your subscribers list and ' . 'report as spam to site administrators at %s.'), $blocklink ); $out[] = ""; return implode("\n", $out); } /** * notify a user of their new incoming email address * * User's email and incoming fields should already be updated. * * @param User $user user with the new address * * @return void */ function mail_new_incoming_notify($user) { $profile = $user->getProfile(); $name = $profile->getBestName(); $headers['From'] = $user->incomingemail; $headers['To'] = $name . ' <' . $user->email . '>'; // TRANS: Subject of notification mail for new posting email address. // TRANS: %s is the StatusNet sitename. $headers['Subject'] = sprintf( _('New email address for posting to %s'), common_config('site', 'name') ); // TRANS: Body of notification mail for new posting email address. // TRANS: %1$s is the StatusNet sitename, %2$s is the e-mail address to send // TRANS: to to post by e-mail, %3$s is a URL to more instructions. $body = sprintf( _("You have a new posting address on %1\$s.\n\n". "Send email to %2\$s to post new messages.\n\n". "More email instructions at %3\$s."), common_config('site', 'name'), $user->incomingemail, common_local_url('doc', ['title' => 'email']) ) . mail_footer_block(); mail_send($user->email, $headers, $body); } /** * generate a new address for incoming messages * * @todo check the database for uniqueness * * @return string new email address for incoming messages */ function mail_new_incoming_address() { $prefix = common_confirmation_code(64); $suffix = mail_domain(); return $prefix . '@' . $suffix; } /** * broadcast a notice to all subscribers with SMS notification on * * This function sends SMS messages to all users who have sms addresses; * have sms notification on; and have sms enabled for this particular * subscription. * * @param Notice $notice The notice to broadcast * * @return success flag */ function mail_broadcast_notice_sms($notice) { // Now, get users subscribed to this profile $user = new User(); $replies = $notice->getReplies(); $repliesQry = ''; if (!empty($replies)) { $repliesQry = sprintf( 'OR %s.id IN (%s)', $user->escapedTableName(), implode(',', $replies) ); } $user->query(sprintf( 'SELECT nickname, smsemail, incomingemail ' . 'FROM %1$s LEFT JOIN subscription ' . 'ON %1$s.id = subscription.subscriber ' . 'AND subscription.subscribed = %2$d ' . 'AND subscription.subscribed <> subscription.subscriber ' . // Users (other than the sender) who `want SMS notices': 'WHERE %1$s.id <> %2$d ' . 'AND %1$s.smsemail IS NOT NULL ' . 'AND %1$s.smsnotify IS TRUE ' . // ... where either the user _is_ subscribed to the sender // (any of the "subscription" fields IS NOT NULL) // and wants to get SMS for all of this scribe's notices... 'AND (subscription.sms IS TRUE ' . // ... or where the user was mentioned in // or replied-to with the notice: $repliesQry . ')', $user->escapedTableName(), $notice->profile_id )); while ($user->fetch()) { common_log( LOG_INFO, 'Sending notice ' . $notice->id . ' to ' . $user->smsemail, __FILE__ ); $success = mail_send_sms_notice_address( $notice, $user->smsemail, $user->incomingemail, $user->nickname ); if (!$success) { // XXX: Not sure, but I think that's the right thing to do common_log( LOG_WARNING, 'Sending notice ' . $notice->id . ' to ' . $user->smsemail . ' FAILED, canceling.', __FILE__ ); return false; } } $user->free(); unset($user); return true; } /** * send a notice to a user via SMS * * A convenience wrapper around mail_send_sms_notice_address() * * @param Notice $notice notice to send * @param User $user user to receive notice * * @see mail_send_sms_notice_address() * * @return boolean success flag */ function mail_send_sms_notice($notice, $user) { return mail_send_sms_notice_address( $notice, $user->smsemail, $user->incomingemail, $user->nickname ); } /** * send a notice to an SMS email address from a given address * * We use the user's incoming email address as the "From" address to make * replying to notices easier. * * @param Notice $notice notice to send * @param string $smsemail email address to send to * @param string $incomingemail email address to set as 'from' * @param string $nickname nickname to add to beginning * * @return boolean success flag */ function mail_send_sms_notice_address($notice, $smsemail, $incomingemail, $nickname) { $to = $nickname . ' <' . $smsemail . '>'; $other = $notice->getProfile(); common_log(LOG_INFO, 'Sending notice ' . $notice->id . ' to ' . $smsemail, __FILE__); $headers = array(); $headers['From'] = ($incomingemail) ? $incomingemail : mail_notify_from(); $headers['To'] = $to; // TRANS: Subject line for SMS-by-email notification messages. // TRANS: %s is the posting user's nickname. $headers['Subject'] = sprintf(_('%s status'), $other->getBestName()); $body = $notice->content; return mail_send($smsemail, $headers, $body); } /** * send a message to confirm a claim for an SMS number * * @param string $code confirmation code * @param string $nickname nickname of user claiming number * @param string $address email address to send the confirmation to * * @see common_confirmation_code() * * @return void */ function mail_confirm_sms($code, $nickname, $address) { $recipients = $address; $headers['From'] = mail_notify_from(); $headers['To'] = $nickname . ' <' . $address . '>'; // TRANS: Subject line for SMS-by-email address confirmation message. $headers['Subject'] = _('SMS confirmation'); // TRANS: Main body heading for SMS-by-email address confirmation message. // TRANS: %s is the addressed user's nickname. $body = sprintf(_('%s: confirm you own this phone number with this code:'), $nickname); $body .= "\n\n"; $body .= $code; $body .= "\n\n"; mail_send($recipients, $headers, $body); } /** * send a mail message to notify a user of a 'nudge' * * @param User $from user nudging * @param User $to user being nudged * * @return boolean success flag */ function mail_notify_nudge($from, $to) { common_switch_locale($to->language); // TRANS: Subject for 'nudge' notification email. // TRANS: %s is the nudging user. $subject = sprintf(_('You have been nudged by %s'), $from->nickname); $from_profile = $from->getProfile(); // TRANS: Body for 'nudge' notification email. // TRANS: %1$s is the nuding user's long name, $2$s is the nudging user's nickname, // TRANS: %3$s is a URL to post notices at. $body = sprintf( _('%1$s (%2$s) is wondering what you are up to ' . "these days and is inviting you to post some news.\n\n" . "So let's hear from you :)\n\n" . "%3\$s\n\n" . "Don't reply to this email; it won't get to them."), $from_profile->getBestName(), $from->nickname, common_local_url('all', ['nickname' => $to->nickname]) ) . mail_footer_block(); common_switch_locale(); $headers = _mail_prepare_headers('nudge', $to->nickname, $from->nickname); return mail_to_user($to, $subject, $body, $headers); } /** * send a message to notify a user of a direct message (DM) * * This function checks to see if the recipient wants notification * of DMs and has a configured email address. * * @param Notice $message message to notify about * @param User $from user sending message * @param array $to users receiving the message * * @return boolean success code */ function mail_notify_message(Notice $message, Profile $from = null, ?array $to = null) { if (is_null($from)) { $from = $message->getProfile(); } if (is_null($to)) { $to = []; foreach ($message->getAttentionProfiles() as $attention) { if ($attention->isLocal()) { $to[] = $attention; } } } $success = true; foreach ($to as $t) { if (is_null($t->email) || !$t->emailnotifymsg) { continue; } common_switch_locale($t->language); // TRANS: Subject for direct-message notification email. // TRANS: %s is the sending user's nickname. $subject = sprintf(_('New private message from %s'), $from->getNickname()); // TRANS: Body for direct-message notification email. // TRANS: %1$s is the sending user's long name, %2$s is the sending user's nickname, // TRANS: %3$s is the message content, %4$s a URL to the message, $body = sprintf( _("%1\$s (%2\$s) sent you a private message:\n\n". "------------------------------------------------------\n". "%3\$s\n". "------------------------------------------------------\n\n". "You can reply to their message here:\n\n". "%4\$s\n\n". "Don't reply to this email; it won't get to them."), $from->getBestName(), $from->getNickname(), $message->getContent(), common_local_url('newmessage', ['to' => $from->getID()]) ) . mail_footer_block(); $headers = _mail_prepare_headers('message', $t->getNickname(), $from->getNickname()); common_switch_locale(); if (!mail_to_user($t, $subject, $body, $headers)) { common_log(LOG_ERR, "Failed to notify user:{$t->getID()} about the new message:{$message->getID()} sent by user:{$from->getID()}"); $success = false; } } return $success; } /** * Notify a user that they have received an "attn:" message AKA "@-reply" * * @param Profile $rcpt The Profile who recevied the notice, should be a local user * @param Notice $notice The notice that was sent * * @return void */ function mail_notify_attn(Profile $rcpt, Notice $notice) { if (!$rcpt->isLocal()) { return; } $sender = $notice->getProfile(); if ($rcpt->sameAs($sender)) { return; } // See if the notice's author who mentions this user is sandboxed if (!$sender->hasRight(Right::EMAILONREPLY)) { return; } // If the author has blocked the author, don't spam them with a notification. if ($rcpt->hasBlocked($sender)) { return; } $user = $rcpt->getUser(); if (!$user->receivesEmailNotifications()) { return; } common_switch_locale($user->language); if ($notice->hasConversation()) { $conversationUrl = common_local_url( 'conversation', ['id' => $notice->conversation] ) . '#notice-'.$notice->getID(); // TRANS: Line in @-reply notification e-mail. %s is conversation URL. $conversationEmailText = sprintf(_("The full conversation can be read here:\n\n". "\t%s"), $conversationUrl) . "\n\n"; } else { $conversationEmailText = ''; } // TRANS: E-mail subject for notice notification. // TRANS: %1$s is the "fancy name" for a profile. $subject = sprintf(_('%1$s sent a notice to your attention'), $sender->getFancyName()); // TRANS: Body of @-reply notification e-mail. // TRANS: %1$s is the sending user's name, $2$s is the GNU social sitename, // TRANS: %3$s is a URL to the notice, %4$s is the notice text, // TRANS: %5$s is the text "The full conversation can be read here:" and a URL to the full conversion if it exists (otherwise empty), // TRANS: %6$s is a URL to reply to the notice, %7$s is a URL to all @-replies for the addressed user, $body = sprintf( _("%1\$s just sent a notice to your attention (an '@-reply') on %2\$s.\n\n". "The notice is here:\n\n". "\t%3\$s\n\n" . "It reads:\n\n". "\t%4\$s\n\n" . "%5\$s" . "You can reply back here:\n\n". "\t%6\$s\n\n" . "The list of all @-replies for you here:\n\n" . "%7\$s"), $sender->getFancyName(), //%1 common_config('site', 'name'), //%2 common_local_url( 'shownotice', ['notice' => $notice->getID()] ), //%3 $notice->getContent(), //%4 $conversationEmailText, //%5 common_local_url( 'newnotice', ['replyto' => $sender->getNickname(), 'inreplyto' => $notice->getID()] ), //%6 common_local_url( 'replies', ['nickname' => $rcpt->getNickname()] ) ) . //%7 mail_footer_block(); $headers = _mail_prepare_headers('mention', $rcpt->getNickname(), $sender->getNickname()); common_switch_locale(); mail_to_user($user, $subject, $body, $headers); } /** * Prepare the common mail headers used in notification emails * * @param string $msg_type type of message being sent to the user * @param string $to nickname of the receipient * @param string $from nickname of the user triggering the notification * * @return array list of mail headers to include in the message */ function _mail_prepare_headers($msg_type, $to, $from) { $headers = array( 'X-StatusNet-MessageType' => $msg_type, 'X-StatusNet-TargetUser' => $to, 'X-StatusNet-SourceUser' => $from, 'X-StatusNet-Domain' => common_config('site', 'server') ); return $headers; } /** * Send notification emails to group administrator. * * @param User_group $group * @param Profile $joiner */ function mail_notify_group_join($group, $joiner) { // This returns a Profile query... $admin = $group->getAdmins(); while ($admin->fetch()) { // We need a local user for email notifications... $adminUser = User::getKV('id', $admin->id); // @fixme check for email preference? if ($adminUser && $adminUser->email) { // use the recipient's localization common_switch_locale($adminUser->language); $headers = _mail_prepare_headers('join', $admin->nickname, $joiner->nickname); $headers['From'] = mail_notify_from(); $headers['To'] = $admin->getBestName() . ' <' . $adminUser->email . '>'; // TRANS: Subject of group join notification e-mail. // TRANS: %1$s is the joining user's nickname, %2$s is the group name, and %3$s is the StatusNet sitename. $headers['Subject'] = sprintf( _('%1$s has joined your group %2$s on %3$s'), $joiner->getBestName(), $group->getBestName(), common_config('site', 'name') ); // TRANS: Main body of group join notification e-mail. // TRANS: %1$s is the subscriber's long name, %2$s is the group name, and %3$s is the StatusNet sitename, // TRANS: %4$s is a block of profile info about the subscriber. // TRANS: %5$s is a link to the addressed user's e-mail settings. $body = sprintf( _('%1$s has joined your group %2$s on %3$s.'), $joiner->getFancyName(), $group->getFancyName(), common_config('site', 'name') ) . mail_profile_block($joiner) . mail_footer_block(); // reset localization common_switch_locale(); mail_send($adminUser->email, $headers, $body); } } } /** * Send notification emails to group administrator. * * @param User_group $group * @param Profile $joiner */ function mail_notify_group_join_pending($group, $joiner) { $admin = $group->getAdmins(); while ($admin->fetch()) { // We need a local user for email notifications... $adminUser = User::getKV('id', $admin->id); // @fixme check for email preference? if ($adminUser && $adminUser->email) { // use the recipient's localization common_switch_locale($adminUser->language); $headers = _mail_prepare_headers('join', $admin->nickname, $joiner->nickname); $headers['From'] = mail_notify_from(); $headers['To'] = $admin->getBestName() . ' <' . $adminUser->email . '>'; // TRANS: Subject of pending group join request notification e-mail. // TRANS: %1$s is the joining user's nickname, %2$s is the group name, and %3$s is the StatusNet sitename. $headers['Subject'] = sprintf( _('%1$s wants to join your group %2$s on %3$s.'), $joiner->getBestName(), $group->getBestName(), common_config('site', 'name') ); // TRANS: Main body of pending group join request notification e-mail. // TRANS: %1$s is the subscriber's long name, %2$s is the group name, and %3$s is the StatusNet sitename, // TRANS: %4$s is the URL to the moderation queue page. $body = sprintf( _('%1$s would like to join your group %2$s on %3$s. ' . 'You may approve or reject their group membership at %4$s'), $joiner->getFancyName(), $group->getFancyName(), common_config('site', 'name'), common_local_url('groupqueue', ['nickname' => $group->nickname]) ) . mail_profile_block($joiner) . mail_footer_block(); // reset localization common_switch_locale(); mail_send($adminUser->email, $headers, $body); } } }