We are no longer offering accounts on this server. Consider https://gitlab.freedesktop.org/ as a place to host projects.

mail.php 25.7 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('STATUSNET') && !defined('LACONICA')) {
34 35
    exit(1);
}
36

37
require_once 'Mail.php';
38

39 40 41 42 43 44 45 46
/**
 * 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
 */
47

48 49 50 51 52
function mail_backend()
{
    static $backend = null;

    if (!$backend) {
53 54 55
        $backend = Mail::factory(common_config('mail', 'backend'),
                                 (common_config('mail', 'params')) ?
                                 common_config('mail', 'params') :
56 57 58 59 60 61
                                 array());
        if (PEAR::isError($backend)) {
            common_server_error($backend->getMessage(), 500);
        }
    }
    return $backend;
62 63
}

64 65 66 67 68 69 70 71 72
/**
 * 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
 */
73

74 75 76 77
function mail_send($recipients, $headers, $body)
{
    // XXX: use Mail_Queue... maybe
    $backend = mail_backend();
78 79 80
    if (!isset($headers['Content-Type'])) {
        $headers['Content-Type'] = 'text/plain; charset=UTF-8';
    }
81 82 83 84 85 86 87
    assert($backend); // throws an error if it's bad
    $sent = $backend->send($recipients, $headers, $body);
    if (PEAR::isError($sent)) {
        common_log(LOG_ERR, 'Email error: ' . $sent->getMessage());
        return false;
    }
    return true;
88 89
}

90 91 92 93 94 95 96
/**
 * returns the configured mail domain
 *
 * Defaults to the server name.
 *
 * @return string mail domain, suitable for making email addresses.
 */
97

98 99 100 101 102 103 104
function mail_domain()
{
    $maildomain = common_config('mail', 'domain');
    if (!$maildomain) {
        $maildomain = common_config('site', 'server');
    }
    return $maildomain;
105
}
Evan Prodromou's avatar
Evan Prodromou committed
106

107 108 109 110 111 112 113 114 115 116 117 118
/**
 * 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');
119

120
    if (!$notifyfrom) {
121

122
        $domain = mail_domain();
123

124
        $notifyfrom = '"'.common_config('site', 'name') .'" <noreply@'.$domain.'>';
125 126 127
    }

    return $notifyfrom;
128 129
}

130 131 132 133 134 135
/**
 * 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
136
 * @param array  $headers optional list of email headers
137 138 139 140
 * @param string $address optional specification of email address
 *
 * @return boolean success flag
 */
Evan Prodromou's avatar
Evan Prodromou committed
141

Dave Hall's avatar
Dave Hall committed
142
function mail_to_user(&$user, $subject, $body, $headers=array(), $address=null)
143 144 145 146
{
    if (!$address) {
        $address = $user->email;
    }
147

148 149
    $recipients = $address;
    $profile    = $user->getProfile();
150

151 152 153 154 155
    $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
156
}
157

158 159 160 161 162 163 164 165 166 167 168 169 170 171 172
/**
 * Send an email to confirm a user's control of an email address
 *
 * @param User   $user     User claiming the email address
 * @param string $code     Confirmation code
 * @param string $nickname Nickname of user
 * @param string $address  email address to confirm
 *
 * @see common_confirmation_code()
 *
 * @return success flag
 */

function mail_confirm_address($user, $code, $nickname, $address)
{
173
    // TRANS: Subject for address confirmation email.
174 175
    $subject = _('Email address confirmation');

176
    // TRANS: Body for address confirmation email.
177 178 179 180
    // TRANS: %1$s is the addressed user's nickname, %2$s is the StatusNet sitename,
    // TRANS: %3$s is the URL to confirm at.
    $body = sprintf(_("Hey, %1\$s.\n\n".
                      "Someone just entered this email address on %2\$s.\n\n" .
181
                      "If it was you, and you want to confirm your entry, ".
182
                      "use the URL below:\n\n\t%3\$s\n\n" .
183
                      "If not, just ignore this message.\n\n".
184 185 186 187
                      "Thanks for your time, \n%2\$s\n"),
                    $nickname,
                    common_config('site', 'name'),
                    common_local_url('confirmaddress', array('code' => $code)));
Dave Hall's avatar
Dave Hall committed
188 189 190
    $headers = array();

    return mail_to_user($user, $subject, $body, $headers, $address);
191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209
}

/**
 * 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);
210 211
}

212 213 214 215 216 217 218 219 220 221 222 223 224 225
/**
 * 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)
{
226 227
    if ($other->hasRight(Right::EMAILONSUBSCRIBE) &&
        $listenee->email && $listenee->emailnotifysub) {
228 229 230 231 232 233 234 235 236 237

        $profile = $listenee->getProfile();

        $name = $profile->getBestName();

        $long_name = ($other->fullname) ?
          ($other->fullname . ' (' . $other->nickname . ')') : $other->nickname;

        $recipients = $listenee->email;

238 239 240
        // use the recipient's localization
        common_switch_locale($listenee->language);

Dave Hall's avatar
Dave Hall committed
241
        $headers = _mail_prepare_headers('subscribe', $listenee->nickname, $other->nickname);
242 243
        $headers['From']    = mail_notify_from();
        $headers['To']      = $name . ' <' . $listenee->email . '>';
244 245
        // TRANS: Subject of new-subscriber notification e-mail.
        // TRANS: %1$s is the subscribing user's nickname, %2$s is the StatusNet sitename.
246 247
        $headers['Subject'] = sprintf(_('%1$s is now listening to '.
                                        'your notices on %2$s.'),
248
                                      $other->getBestName(),
249 250
                                      common_config('site', 'name'));

251 252
        // TRANS: This is a paragraph in a new-subscriber e-mail.
        // TRANS: %s is a URL where the subscriber can be reported as abusive.
253 254 255 256 257
        $blocklink = 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"),
                             common_local_url('block', array('profileid' => $other->id)));

258 259 260 261 262
        // TRANS: Main body of new-subscriber notification e-mail.
        // TRANS: %1$s is the subscriber's long name, %2$s is the StatusNet sitename,
        // TRANS: %3$s is the subscriber's profile URL, %4$s is the subscriber's location (or empty)
        // TRANS: %5$s is the subscriber's homepage URL (or empty), %6%s is the subscriber's bio (or empty)
        // TRANS: %7$s is a link to the addressed user's e-mail settings.
263
        $body = sprintf(_('%1$s is now listening to your notices on %2$s.'."\n\n".
264
                          "\t".'%3$s'."\n\n".
265 266 267
                          '%4$s'.
                          '%5$s'.
                          '%6$s'.
268
                          "\n".'Faithfully yours,'."\n".'%2$s.'."\n\n".
269 270
                          "----\n".
                          "Change your email address or ".
271
                          "notification options at ".'%7$s' ."\n"),
272 273 274 275
                        $long_name,
                        common_config('site', 'name'),
                        $other->profileurl,
                        ($other->location) ?
276 277
                        // TRANS: Profile info line in new-subscriber notification e-mail.
                        // TRANS: %s is a location.
278
                        sprintf(_("Location: %s"), $other->location) . "\n" : '',
279
                        ($other->homepage) ?
280 281
                        // TRANS: Profile info line in new-subscriber notification e-mail.
                        // TRANS: %s is a homepage.
282
                        sprintf(_("Homepage: %s"), $other->homepage) . "\n" : '',
283
                        (($other->bio) ?
284 285
                            // TRANS: Profile info line in new-subscriber notification e-mail.
                            // TRANS: %s is biographical information.
286 287
                            sprintf(_("Bio: %s"), $other->bio) . "\n" : '') .
                            "\n\n" . $blocklink . "\n",
288 289
                        common_local_url('emailsettings'));

290
        // reset localization
291
        common_switch_locale();
292 293
        mail_send($recipients, $headers, $body);
    }
294
}
295

296 297 298 299 300 301 302 303 304 305 306 307
/**
 * 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();
308

309
    $name = $profile->getBestName();
Evan Prodromou's avatar
Evan Prodromou committed
310

311 312
    $headers['From']    = $user->incomingemail;
    $headers['To']      = $name . ' <' . $user->email . '>';
313 314
    // TRANS: Subject of notification mail for new posting email address.
    // TRANS: %s is the StatusNet sitename.
315 316
    $headers['Subject'] = sprintf(_('New email address for posting to %s'),
                                  common_config('site', 'name'));
Evan Prodromou's avatar
Evan Prodromou committed
317

318 319 320
    // 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.
321 322 323
    $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.\n\n".
324
                      "Faithfully yours,\n%1\$s"),
325 326
                    common_config('site', 'name'),
                    $user->incomingemail,
327
                    common_local_url('doc', array('title' => 'email')));
Evan Prodromou's avatar
Evan Prodromou committed
328

329
    mail_send($user->email, $headers, $body);
330 331
}

332 333 334 335 336 337 338 339 340 341 342 343
/**
 * 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;
344
}
345

346 347 348 349 350 351 352 353 354 355 356 357 358 359
/**
 * 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
360

361
    $user = new User();
362

363
    $UT = common_config('db','type')=='pgsql'?'"user"':'user';
364
    $user->query('SELECT nickname, smsemail, incomingemail ' .
365 366
                 "FROM $UT JOIN subscription " .
                 "ON $UT.id = subscription.subscriber " .
367
                 'WHERE subscription.subscribed = ' . $notice->profile_id . ' ' .
Evan Prodromou's avatar
Evan Prodromou committed
368
                 'AND subscription.subscribed != subscription.subscriber ' .
369 370
                 "AND $UT.smsemail IS NOT null " .
                 "AND $UT.smsnotify = 1 " .
371
                 'AND subscription.sms = 1 ');
372

373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393
    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);
        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;
394 395
}

396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412
/**
 * 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);
413 414
}

415 416 417 418 419 420 421 422 423 424 425 426 427 428 429
/**
 * 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'
 *
 * @return boolean success flag
 */
function mail_send_sms_notice_address($notice, $smsemail, $incomingemail)
{
    $to = $nickname . ' <' . $smsemail . '>';
430

431
    $other = $notice->getProfile();
432

433 434
    common_log(LOG_INFO, 'Sending notice ' . $notice->id .
               ' to ' . $smsemail, __FILE__);
435

436 437 438 439
    $headers = array();

    $headers['From']    = ($incomingemail) ? $incomingemail : mail_notify_from();
    $headers['To']      = $to;
440 441
    // TRANS: Subject line for SMS-by-email notification messages.
    // TRANS: %s is the posting user's nickname.
442 443 444 445 446 447
    $headers['Subject'] = sprintf(_('%s status'),
                                  $other->getBestName());

    $body = $notice->content;

    return mail_send($smsemail, $headers, $body);
448
}
449

450 451 452 453 454 455 456 457 458 459 460 461 462 463
/**
 * 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;
Evan Prodromou's avatar
Evan Prodromou committed
464

465 466
    $headers['From']    = mail_notify_from();
    $headers['To']      = $nickname . ' <' . $address . '>';
467
    // TRANS: Subject line for SMS-by-email address confirmation message.
468
    $headers['Subject'] = _('SMS confirmation');
469

470 471
    // TRANS: Main body heading for SMS-by-email address confirmation message.
    // TRANS: %s is the addressed user's nickname.
472
    $body  = sprintf(_("%s: confirm you own this phone number with this code:"), $nickname);
473 474 475 476 477
    $body .= "\n\n";
    $body .= $code;
    $body .= "\n\n";

    mail_send($recipients, $headers, $body);
478
}
Evan Prodromou's avatar
Evan Prodromou committed
479

480 481 482 483 484 485 486 487 488 489
/**
 * 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)
{
490
    common_switch_locale($to->language);
491 492
    // TRANS: Subject for 'nudge' notification email.
    // TRANS: %s is the nudging user.
493 494 495 496
    $subject = sprintf(_('You\'ve been nudged by %s'), $from->nickname);

    $from_profile = $from->getProfile();

497 498 499
    // 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, %4$s is the StatusNet sitename.
500 501 502 503
    $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".
504
                      "Don't reply to this email; it won't get to them.\n\n".
505 506 507 508 509 510
                      "With kind regards,\n".
                      "%4\$s\n"),
                    $from_profile->getBestName(),
                    $from->nickname,
                    common_local_url('all', array('nickname' => $to->nickname)),
                    common_config('site', 'name'));
511
    common_switch_locale();
Dave Hall's avatar
Dave Hall committed
512 513 514 515

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

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

518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534
/**
 * 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)) {
        $from = User::staticGet('id', $message->from_profile);
    }
535

536 537 538
    if (is_null($to)) {
        $to = User::staticGet('id', $message->to_profile);
    }
Evan Prodromou's avatar
Evan Prodromou committed
539

540 541 542
    if (is_null($to->email) || !$to->emailnotifymsg) {
        return true;
    }
543

544
    common_switch_locale($to->language);
545 546
    // TRANS: Subject for direct-message notification email.
    // TRANS: %s is the sending user's nickname.
547 548 549 550
    $subject = sprintf(_('New private message from %s'), $from->nickname);

    $from_profile = $from->getProfile();

551 552 553 554
    // 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,
    // TRANS: %5$s is the StatusNet sitename.
555 556 557 558 559 560
    $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".
561
                      "Don't reply to this email; it won't get to them.\n\n".
562 563 564 565 566 567 568
                      "With kind regards,\n".
                      "%5\$s\n"),
                    $from_profile->getBestName(),
                    $from->nickname,
                    $message->content,
                    common_local_url('newmessage', array('to' => $from->id)),
                    common_config('site', 'name'));
569

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

572
    common_switch_locale();
Dave Hall's avatar
Dave Hall committed
573
    return mail_to_user($to, $subject, $body, $headers);
Evan Prodromou's avatar
Evan Prodromou committed
574
}
575

576 577 578
/**
 * notify a user that one of their notices has been chosen as a 'fave'
 *
579
 * Doesn't check that the user has an email address nor if they
580 581 582 583 584 585 586 587 588 589 590
 * want to receive notification of faves. Maybe this happens higher
 * up the stack...?
 *
 * @param User   $other  The user whose notice was faved
 * @param User   $user   The user who faved the notice
 * @param Notice $notice The notice that was faved
 *
 * @return void
 */
function mail_notify_fave($other, $user, $notice)
{
591 592 593 594
    if (!$user->hasRight(Right::EMAILONFAVE)) {
        return;
    }

595 596 597
    $profile = $user->getProfile();

    $bestname = $profile->getBestName();
598

599
    common_switch_locale($other->language);
600

601 602 603
    // TRANS: Subject for favorite notification e-mail.
    // TRANS: %1$s is the adding user's long name, %2$s is the adding user's nickname.
    $subject = sprintf(_('%1s$ (@%2$s) added your notice as a favorite'), $bestname, $user->nickname);
604

605 606 607 608 609
    // TRANS: Body for favorite notification e-mail.
    // TRANS: %1$s is the adding user's long name, $2$s is the date the notice was created,
    // TRANS: %3$s is a URL to the faved notice, %4$s is the faved notice text,
    // TRANS: %5$s is a URL to all faves of the adding user, %6$s is the StatusNet sitename,
    // TRANS: %7$s is the adding user's nickname.
610
    $body = sprintf(_("%1\$s (@%7\$s) just added your notice from %2\$s".
611
                      " as one of their favorites.\n\n" .
612
                      "The URL of your notice is:\n\n" .
613
                      "%3\$s\n\n" .
614
                      "The text of your notice is:\n\n" .
615
                      "%4\$s\n\n" .
616 617
                      "You can see the list of %1\$s's favorites here:\n\n" .
                      "%5\$s\n\n" .
618
                      "Faithfully yours,\n" .
619
                      "%6\$s\n"),
620 621 622 623
                    $bestname,
                    common_exact_date($notice->created),
                    common_local_url('shownotice',
                                     array('notice' => $notice->id)),
624
                    $notice->content,
625 626
                    common_local_url('showfavorites',
                                     array('nickname' => $user->nickname)),
627 628
                    common_config('site', 'name'),
                    $user->nickname);
629

Dave Hall's avatar
Dave Hall committed
630 631
    $headers = _mail_prepare_headers('fave', $other->nickname, $user->nickname);

632
    common_switch_locale();
Dave Hall's avatar
Dave Hall committed
633
    mail_to_user($other, $subject, $body, $headers);
634
}
635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651

/**
 * notify a user that they have received an "attn:" message AKA "@-reply"
 *
 * @param User   $user   The user who recevied the notice
 * @param Notice $notice The notice that was sent
 *
 * @return void
 */
function mail_notify_attn($user, $notice)
{
    if (!$user->email || !$user->emailnotifyattn) {
        return;
    }

    $sender = $notice->getProfile();

652 653 654 655
    if ($sender->id == $user->id) {
        return;
    }

656 657 658 659
    if (!$sender->hasRight(Right::EMAILONREPLY)) {
        return;
    }

660 661
    $bestname = $sender->getBestName();

662
    common_switch_locale($user->language);
663

664 665 666 667 668 669 670 671 672
    if ($notice->hasConversation()) {
        $conversationUrl = common_local_url('conversation',
                         array('id' => $notice->conversation)).'#notice-'.$notice->id;
        // 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 675 676
    // TRANS: E-mail subject for notice notification.
    // TRANS: %1$s is the sending user's long name, %2$s is the adding user's nickname.
    $subject = sprintf(_('%1$s (@%2$s) sent a notice to your attention'), $bestname, $sender->nickname);
677

678
        // TRANS: Body of @-reply notification e-mail.
679 680 681 682 683
        // TRANS: %1$s is the sending user's long name, $2$s is the StatusNet sitename,
        // TRANS: %3$s is a URL to the notice, %4$s is the notice text,
        // TRANS: %5$s is 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 @-replied for the addressed user,
        // TRANS: %8$s is a URL to the addressed user's e-mail settings, %9$s is the sender's nickname.
Dave Hall's avatar
Dave Hall committed
684
        $body = sprintf(_("%1\$s (@%9\$s) just sent a notice to your attention (an '@-reply') on %2\$s.\n\n".
685 686 687 688
                      "The notice is here:\n\n".
                      "\t%3\$s\n\n" .
                      "It reads:\n\n".
                      "\t%4\$s\n\n" .
689
                      "%5\$s" .
690
                      "You can reply back here:\n\n".
691
                      "\t%6\$s\n\n" .
692
                      "The list of all @-replies for you here:\n\n" .
693
                      "%7\$s\n\n" .
694 695
                      "Faithfully yours,\n" .
                      "%2\$s\n\n" .
696 697 698
                      "P.S. You can turn off these email notifications here: %8\$s\n"),
                    $bestname,//%1
                    common_config('site', 'name'),//%2
699
                    common_local_url('shownotice',
700 701
                                     array('notice' => $notice->id)),//%3
                    $notice->content,//%4
702
                    $conversationEmailText,//%5
703
                    common_local_url('newnotice',
704
                                     array('replyto' => $sender->nickname, 'inreplyto' => $notice->id)),//%6
705
                    common_local_url('replies',
706
                                     array('nickname' => $user->nickname)),//%7
707 708
                    common_local_url('emailsettings'), //%8
                    $sender->nickname); //%9
709

Dave Hall's avatar
Dave Hall committed
710 711
    $headers = _mail_prepare_headers('mention', $user->nickname, $sender->nickname);

712
    common_switch_locale();
Dave Hall's avatar
Dave Hall committed
713
    mail_to_user($user, $subject, $body, $headers);
714
}
Dave Hall's avatar
Dave Hall committed
715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735

/**
 * 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;
}