git.gnu.io has moved to IP address 209.51.188.249 -- please double check where you are logging in.

mail.php 29.3 KB
Newer Older
1
<?php
2
/**
3
 * StatusNet, the distributed open-source microblogging tool
4
 *
5 6 7 8 9
 * utilities for sending email
 *
 * PHP version 5
 *
 * LICENCE: This program is free software: you can redistribute it and/or modify
10 11 12 13 14 15 16 17 18 19 20
 * 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.
 *
 * This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
21 22
 *
 * @category  Mail
23
 * @package   StatusNet
24 25 26 27
 * @author    Evan Prodromou <evan@status.net>
 * @author    Zach Copley <zach@status.net>
 * @author    Robin Millette <millette@status.net>
 * @author    Sarven Capadisli <csarven@status.net>
28
 * @copyright 2008 StatusNet, Inc.
29
 * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
30
 * @link      http://status.net/
31 32
 */

33
if (!defined('GNUSOCIAL')) { exit(1); }
34

35
require_once 'Mail.php';
36

37 38 39 40 41 42 43 44 45 46 47
/**
 * 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;
mmn's avatar
mmn committed
48
    global $_PEAR;
49 50

    if (!$backend) {
mmn's avatar
mmn committed
51 52
        $mail = new Mail();
        $backend = $mail->factory(common_config('mail', 'backend'),
mmn's avatar
mmn committed
53
                                 common_config('mail', 'params') ?: array());
mmn's avatar
mmn committed
54
        if ($_PEAR->isError($backend)) {
55
            throw new EmailException($backend->getMessage(), $backend->getCode());
56 57 58
        }
    }
    return $backend;
59 60
}

61 62 63 64 65 66 67 68 69 70 71
/**
 * 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)
{
mmn's avatar
mmn committed
72 73
    global $_PEAR;

74 75 76 77 78 79 80 81 82 83
    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);
mmn's avatar
mmn committed
84
        if ($_PEAR->isError($sent)) {
85
            throw new EmailException($sent->getMessage(), $sent->getCode());
mmn's avatar
mmn committed
86
        }
87 88 89 90 91 92 93
        return true;
    } catch (PEAR_Exception $e) {
        common_log(
            LOG_ERR,
            "Unable to send email - '{$e->getMessage()}'. "
            . 'Is your mail subsystem set up correctly?'
        );
94 95
        return false;
    }
96 97
}

98 99 100 101 102 103 104 105 106 107 108 109 110 111
/**
 * 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;
112
}
Evan Prodromou's avatar
Evan Prodromou committed
113

114 115 116 117 118 119 120 121 122 123 124
/**
 * 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');
125

126
    if (!$notifyfrom) {
127

128
        $domain = mail_domain();
129

130
        $notifyfrom = '"'. str_replace('"', '\\"', common_config('site', 'name')) .'" <noreply@'.$domain.'>';
131 132 133
    }

    return $notifyfrom;
134 135
}

136 137 138 139 140 141
/**
 * 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
Dave Hall's avatar
Dave Hall committed
142
 * @param array  $headers optional list of email headers
143 144 145 146
 * @param string $address optional specification of email address
 *
 * @return boolean success flag
 */
147
function mail_to_user($user, $subject, $body, $headers=array(), $address=null)
148 149 150 151
{
    if (!$address) {
        $address = $user->email;
    }
152

153 154
    $recipients = $address;
    $profile    = $user->getProfile();
155

156
    $headers['Date']    = date("r", time());
157 158 159 160 161
    $headers['From']    = mail_notify_from();
    $headers['To']      = $profile->getBestName() . ' <' . $address . '>';
    $headers['Subject'] = $subject;

    return mail_send($recipients, $headers, $body);
Evan Prodromou's avatar
Evan Prodromou committed
162
}
163

164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179
/**
 * 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);
180 181
}

182 183 184 185 186 187 188 189 190 191 192 193 194
/**
 * 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)
{
195 196
    if ($other->hasRight(Right::EMAILONSUBSCRIBE) &&
        $listenee->email && $listenee->emailnotifysub) {
197 198 199 200 201

        $profile = $listenee->getProfile();

        $name = $profile->getBestName();

202
        $long_name = $other->getFancyName();
203 204 205

        $recipients = $listenee->email;

206 207 208
        // use the recipient's localization
        common_switch_locale($listenee->language);

Dave Hall's avatar
Dave Hall committed
209
        $headers = _mail_prepare_headers('subscribe', $listenee->nickname, $other->nickname);
210 211
        $headers['From']    = mail_notify_from();
        $headers['To']      = $name . ' <' . $listenee->email . '>';
212 213
        // TRANS: Subject of new-subscriber notification e-mail.
        // TRANS: %1$s is the subscribing user's nickname, %2$s is the StatusNet sitename.
214
        $headers['Subject'] = sprintf(_('%1$s is now following you on %2$s.'),
215
                                      $other->getBestName(),
216 217
                                      common_config('site', 'name'));

218
        // TRANS: Main body of new-subscriber notification e-mail.
219
        // TRANS: %1$s is the subscriber's long name, %2$s is the StatusNet sitename.
220
        $body = sprintf(_('%1$s is now following you on %2$s.'),
221
                        $long_name,
222 223 224
                        common_config('site', 'name')) .
                mail_profile_block($other) .
                mail_footer_block();
225

226
        // reset localization
227
        common_switch_locale();
228
        mail_send($recipients, $headers, $body);
229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271
    }
}

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', array('nickname' => $listenee->nickname))) .
                mail_profile_block($other) .
                mail_footer_block();

        // reset localization
        common_switch_locale();
        mail_send($recipients, $headers, $body);
272
    }
273
}
274

275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292
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
293
 * @return string
294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328
 */
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.
329 330 331
    $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.'),
332 333 334 335 336 337
                     $blocklink);
    $out[] = "";

    return implode("\n", $out);
}

338 339 340 341 342 343 344 345 346 347 348 349
/**
 * 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();
350

351
    $name = $profile->getBestName();
352

353 354
    $headers['From']    = $user->incomingemail;
    $headers['To']      = $name . ' <' . $user->email . '>';
355 356
    // TRANS: Subject of notification mail for new posting email address.
    // TRANS: %s is the StatusNet sitename.
357 358
    $headers['Subject'] = sprintf(_('New email address for posting to %s'),
                                  common_config('site', 'name'));
359

360 361 362
    // 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.
363 364
    $body = sprintf(_("You have a new posting address on %1\$s.\n\n".
                      "Send email to %2\$s to post new messages.\n\n".
365
                      "More email instructions at %3\$s."),
366 367
                    common_config('site', 'name'),
                    $user->incomingemail,
368 369
                    common_local_url('doc', array('title' => 'email'))) .
            mail_footer_block();
370

371
    mail_send($user->email, $headers, $body);
372 373
}

374 375 376 377 378 379 380 381 382 383 384 385
/**
 * 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;
386
}
387

388 389 390 391 392 393 394 395 396 397 398 399 400 401
/**
 * 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
402

403
    $user = new User();
404

405
    $UT = common_config('db','type')=='pgsql'?'"user"':'user';
406
    $replies = $notice->getReplies();
407
    $user->query('SELECT nickname, smsemail, incomingemail ' .
408
                 "FROM $UT LEFT OUTER JOIN subscription " .
409
                 "ON $UT.id = subscription.subscriber " .
410
                 'AND subscription.subscribed = ' . $notice->profile_id . ' ' .
411
                 'AND subscription.subscribed != subscription.subscriber ' .
412 413
                 // Users (other than the sender) who `want SMS notices':
                 "WHERE $UT.id != " . $notice->profile_id . ' ' .
414 415
                 "AND $UT.smsemail IS NOT null " .
                 "AND $UT.smsnotify = 1 " .
416 417 418 419 420 421 422 423 424 425
                 // ... 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 = 1 ' .
                 // ... or where the user was mentioned in
                 // or replied-to with the notice:
                 ($replies ? sprintf("OR $UT.id in (%s)",
                                     implode(',', $replies))
                           : '') .
                 ')');
426

427 428 429 430 431 432
    while ($user->fetch()) {
        common_log(LOG_INFO,
                   'Sending notice ' . $notice->id . ' to ' . $user->smsemail,
                   __FILE__);
        $success = mail_send_sms_notice_address($notice,
                                                $user->smsemail,
433 434
                                                $user->incomingemail,
                                                $user->nickname);
435 436 437 438 439 440 441 442 443 444 445 446 447 448
        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, cancelling.',
                       __FILE__);
            return false;
        }
    }

    $user->free();
    unset($user);

    return true;
449 450
}

451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466
/**
 * 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,
467 468
                                        $user->incomingemail,
                                        $user->nickname);
469 470
}

471 472 473 474 475 476 477 478 479
/**
 * 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'
480
 * @param string $nickname      nickname to add to beginning
481 482 483
 *
 * @return boolean success flag
 */
484
function mail_send_sms_notice_address($notice, $smsemail, $incomingemail, $nickname)
485 486
{
    $to = $nickname . ' <' . $smsemail . '>';
487

488
    $other = $notice->getProfile();
489

490 491
    common_log(LOG_INFO, 'Sending notice ' . $notice->id .
               ' to ' . $smsemail, __FILE__);
492

493 494 495 496
    $headers = array();

    $headers['From']    = ($incomingemail) ? $incomingemail : mail_notify_from();
    $headers['To']      = $to;
497 498
    // TRANS: Subject line for SMS-by-email notification messages.
    // TRANS: %s is the posting user's nickname.
499 500 501 502 503 504
    $headers['Subject'] = sprintf(_('%s status'),
                                  $other->getBestName());

    $body = $notice->content;

    return mail_send($smsemail, $headers, $body);
505
}
506

507 508 509 510 511 512 513 514 515 516 517 518 519 520
/**
 * 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;
521

522 523
    $headers['From']    = mail_notify_from();
    $headers['To']      = $nickname . ' <' . $address . '>';
524
    // TRANS: Subject line for SMS-by-email address confirmation message.
525
    $headers['Subject'] = _('SMS confirmation');
526

527 528
    // TRANS: Main body heading for SMS-by-email address confirmation message.
    // TRANS: %s is the addressed user's nickname.
529
    $body  = sprintf(_('%s: confirm you own this phone number with this code:'), $nickname);
530 531 532 533 534
    $body .= "\n\n";
    $body .= $code;
    $body .= "\n\n";

    mail_send($recipients, $headers, $body);
535
}
536

537 538 539 540 541 542 543 544 545 546
/**
 * 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)
{
547
    common_switch_locale($to->language);
548 549
    // TRANS: Subject for 'nudge' notification email.
    // TRANS: %s is the nudging user.
550
    $subject = sprintf(_('You have been nudged by %s'), $from->nickname);
551 552 553

    $from_profile = $from->getProfile();

554 555
    // TRANS: Body for 'nudge' notification email.
    // TRANS: %1$s is the nuding user's long name, $2$s is the nudging user's nickname,
556
    // TRANS: %3$s is a URL to post notices at.
557 558 559 560
    $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".
561
                      "Don't reply to this email; it won't get to them."),
562 563
                    $from_profile->getBestName(),
                    $from->nickname,
564 565
                    common_local_url('all', array('nickname' => $to->nickname))) .
            mail_footer_block();
566
    common_switch_locale();
Dave Hall's avatar
Dave Hall committed
567 568 569 570

    $headers = _mail_prepare_headers('nudge', $to->nickname, $from->nickname);

    return mail_to_user($to, $subject, $body, $headers);
csarven's avatar
csarven committed
571 572
}

573 574 575 576 577 578 579 580 581 582 583 584 585 586 587
/**
 * 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 Message $message message to notify about
 * @param User    $from    user sending message; default to sender
 * @param User    $to      user receiving message; default to recipient
 *
 * @return boolean success code
 */
function mail_notify_message($message, $from=null, $to=null)
{
    if (is_null($from)) {
588
        $from = User::getKV('id', $message->from_profile);
589
    }
590

591
    if (is_null($to)) {
592
        $to = User::getKV('id', $message->to_profile);
593
    }
594

595 596 597
    if (is_null($to->email) || !$to->emailnotifymsg) {
        return true;
    }
598

599
    common_switch_locale($to->language);
600 601
    // TRANS: Subject for direct-message notification email.
    // TRANS: %s is the sending user's nickname.
602 603 604 605
    $subject = sprintf(_('New private message from %s'), $from->nickname);

    $from_profile = $from->getProfile();

606 607 608
    // 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,
609 610 611 612 613 614
    $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".
615
                      "Don't reply to this email; it won't get to them."),
616 617 618
                    $from_profile->getBestName(),
                    $from->nickname,
                    $message->content,
619 620
                    common_local_url('newmessage', array('to' => $from->id))) .
            mail_footer_block();
621

Dave Hall's avatar
Dave Hall committed
622 623
    $headers = _mail_prepare_headers('message', $to->nickname, $from->nickname);

624
    common_switch_locale();
Dave Hall's avatar
Dave Hall committed
625
    return mail_to_user($to, $subject, $body, $headers);
626
}
627

628
/**
Siebrand Mazeland's avatar
Siebrand Mazeland committed
629
 * Notify a user that they have received an "attn:" message AKA "@-reply"
630
 *
mmn's avatar
mmn committed
631
 * @param Profile $rcpt  The Profile who recevied the notice, should be a local user
632 633 634 635
 * @param Notice $notice The notice that was sent
 *
 * @return void
 */
mmn's avatar
mmn committed
636
function mail_notify_attn(Profile $rcpt, Notice $notice)
637
{
mmn's avatar
mmn committed
638
    if (!$rcpt->isLocal()) {
639 640 641 642
        return;
    }

    $sender = $notice->getProfile();
mmn's avatar
mmn committed
643
    if ($rcpt->sameAs($sender)) {
644 645 646
        return;
    }

647
    // See if the notice's author who mentions this user is sandboxed
648 649 650 651
    if (!$sender->hasRight(Right::EMAILONREPLY)) {
        return;
    }

652
    // If the author has blocked the author, don't spam them with a notification.
mmn's avatar
mmn committed
653
    if ($rcpt->hasBlocked($sender)) {
654 655 656
        return;
    }

mmn's avatar
mmn committed
657 658 659 660
    $user = $rcpt->getUser();
    if (!$user->receivesEmailNotifications()) {
        return;
    }
661

662
    common_switch_locale($user->language);
663

664 665
    if ($notice->hasConversation()) {
        $conversationUrl = common_local_url('conversation',
mmn's avatar
mmn committed
666
                         array('id' => $notice->conversation)).'#notice-'.$notice->getID();
667 668 669 670 671 672
        // 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 = '';
    }
673

674
    // TRANS: E-mail subject for notice notification.
675 676
    // TRANS: %1$s is the "fancy name" for a profile.
    $subject = sprintf(_('%1$s sent a notice to your attention'), $sender->getFancyName());
677

678
        // TRANS: Body of @-reply notification e-mail.
679
        // TRANS: %1$s is the sending user's name, $2$s is the StatusNet sitename,
680
        // TRANS: %3$s is a URL to the notice, %4$s is the notice text,
681
        // 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),
682 683
        // 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".
684 685 686 687
                      "The notice is here:\n\n".
                      "\t%3\$s\n\n" .
                      "It reads:\n\n".
                      "\t%4\$s\n\n" .
688
                      "%5\$s" .
689
                      "You can reply back here:\n\n".
690
                      "\t%6\$s\n\n" .
691
                      "The list of all @-replies for you here:\n\n" .
692 693
                      "%7\$s"),
                    $sender->getFancyName(),//%1
694
                    common_config('site', 'name'),//%2
695
                    common_local_url('shownotice',
mmn's avatar
mmn committed
696 697
                                     array('notice' => $notice->getID())),//%3
                    $notice->getContent(),//%4
698
                    $conversationEmailText,//%5
699
                    common_local_url('newnotice',
mmn's avatar
mmn committed
700
                                     array('replyto' => $sender->getNickname(), 'inreplyto' => $notice->getID())),//%6
701
                    common_local_url('replies',
mmn's avatar
mmn committed
702
                                     array('nickname' => $rcpt->getNickname()))) . //%7
703
                mail_footer_block();
mmn's avatar
mmn committed
704
    $headers = _mail_prepare_headers('mention', $rcpt->getNickname(), $sender->getNickname());
Dave Hall's avatar
Dave Hall committed
705

706
    common_switch_locale();
Dave Hall's avatar
Dave Hall committed
707
    mail_to_user($user, $subject, $body, $headers);
708
}
Dave Hall's avatar
Dave Hall committed
709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729

/**
 * 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;
}
730 731 732 733 734 735 736 737 738 739 740 741 742

/**
 * 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...
743
        $adminUser = User::getKV('id', $admin->id);
744 745 746 747 748 749 750 751 752 753 754
        // @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 '.
755
                                            'your group %2$s on %3$s'),
756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789
                                          $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...
790
        $adminUser = User::getKV('id', $admin->id);
791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807
        // @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,
808
            // TRANS: %4$s is the URL to the moderation queue page.
809 810 811 812 813 814 815 816 817 818 819 820 821 822 823
            $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', array('nickname' => $group->nickname))) .
                    mail_profile_block($joiner) .
                    mail_footer_block();

            // reset localization
            common_switch_locale();
            mail_send($adminUser->email, $headers, $body);
        }
    }
}