mail.php 30 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 47 48 49 50 51
/**
 * 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;

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

63 64 65 66 67 68 69 70 71 72 73 74 75
/**
 * 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)
{
    // XXX: use Mail_Queue... maybe
    $backend = mail_backend();
76 77 78
    if (!isset($headers['Content-Type'])) {
        $headers['Content-Type'] = 'text/plain; charset=UTF-8';
    }
79 80 81 82 83 84 85
    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;
86 87
}

88 89 90 91 92 93 94 95 96 97 98 99 100 101
/**
 * 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;
102
}
Evan Prodromou's avatar
Evan Prodromou committed
103

104 105 106 107 108 109 110 111 112 113 114
/**
 * 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');
115

116
    if (!$notifyfrom) {
117

118
        $domain = mail_domain();
119

120
        $notifyfrom = '"'. str_replace('"', '\\"', common_config('site', 'name')) .'" <noreply@'.$domain.'>';
121 122 123
    }

    return $notifyfrom;
124 125
}

126 127 128 129 130 131
/**
 * 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
132
 * @param array  $headers optional list of email headers
133 134 135 136
 * @param string $address optional specification of email address
 *
 * @return boolean success flag
 */
Dave Hall's avatar
Dave Hall committed
137
function mail_to_user(&$user, $subject, $body, $headers=array(), $address=null)
138 139 140 141
{
    if (!$address) {
        $address = $user->email;
    }
142

143 144
    $recipients = $address;
    $profile    = $user->getProfile();
145

146 147 148 149 150
    $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
151
}
152

153 154 155 156 157 158 159 160 161 162 163 164
/**
 * 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
 */
165
function mail_confirm_address($user, $code, $nickname, $address, $url=null)
166
{
167 168 169 170
    if (empty($url)) {
        $url = common_local_url('confirmaddress', array('code' => $code));
    }

171
    // TRANS: Subject for address confirmation email.
172 173
    $subject = _('Email address confirmation');

174
    // TRANS: Body for address confirmation email.
175 176 177 178
    // 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" .
179
                      "If it was you, and you want to confirm your entry, ".
180
                      "use the URL below:\n\n\t%3\$s\n\n" .
181
                      "If not, just ignore this message.\n\n".
182 183 184
                      "Thanks for your time, \n%2\$s\n"),
                    $nickname,
                    common_config('site', 'name'),
185 186
                    $url);

Dave Hall's avatar
Dave Hall committed
187 188 189
    $headers = array();

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

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

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

        $profile = $listenee->getProfile();

        $name = $profile->getBestName();

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

        $recipients = $listenee->email;

235 236 237
        // use the recipient's localization
        common_switch_locale($listenee->language);

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

248
        // TRANS: Main body of new-subscriber notification e-mail.
249 250
        // TRANS: %1$s is the subscriber's long name, %2$s is the StatusNet sitename.
        $body = sprintf(_('%1$s is now listening to your notices on %2$s.'),
251
                        $long_name,
252 253 254
                        common_config('site', 'name')) .
                mail_profile_block($other) .
                mail_footer_block();
255

256
        // reset localization
257
        common_switch_locale();
258 259
        mail_send($recipients, $headers, $body);
    }
260
}
261

262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 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
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);
}

325 326 327 328 329 330 331 332 333 334 335 336
/**
 * 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();
337

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

340 341
    $headers['From']    = $user->incomingemail;
    $headers['To']      = $name . ' <' . $user->email . '>';
342 343
    // TRANS: Subject of notification mail for new posting email address.
    // TRANS: %s is the StatusNet sitename.
344 345
    $headers['Subject'] = sprintf(_('New email address for posting to %s'),
                                  common_config('site', 'name'));
Evan Prodromou's avatar
Evan Prodromou committed
346

347 348 349
    // 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.
350 351
    $body = sprintf(_("You have a new posting address on %1\$s.\n\n".
                      "Send email to %2\$s to post new messages.\n\n".
352
                      "More email instructions at %3\$s."),
353 354
                    common_config('site', 'name'),
                    $user->incomingemail,
355 356
                    common_local_url('doc', array('title' => 'email'))) .
            mail_footer_block();
Evan Prodromou's avatar
Evan Prodromou committed
357

358
    mail_send($user->email, $headers, $body);
359 360
}

361 362 363 364 365 366 367 368 369 370 371 372
/**
 * 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;
373
}
374

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

390
    $user = new User();
391

392
    $UT = common_config('db','type')=='pgsql'?'"user"':'user';
393
    $user->query('SELECT nickname, smsemail, incomingemail ' .
394 395
                 "FROM $UT JOIN subscription " .
                 "ON $UT.id = subscription.subscriber " .
396
                 'WHERE subscription.subscribed = ' . $notice->profile_id . ' ' .
Evan Prodromou's avatar
Evan Prodromou committed
397
                 'AND subscription.subscribed != subscription.subscriber ' .
398 399
                 "AND $UT.smsemail IS NOT null " .
                 "AND $UT.smsnotify = 1 " .
400
                 'AND subscription.sms = 1 ');
401

402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422
    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;
423 424
}

425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441
/**
 * 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);
442 443
}

444 445 446 447 448 449 450 451 452 453 454 455 456 457 458
/**
 * 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 . '>';
459

460
    $other = $notice->getProfile();
461

462 463
    common_log(LOG_INFO, 'Sending notice ' . $notice->id .
               ' to ' . $smsemail, __FILE__);
464

465 466 467 468
    $headers = array();

    $headers['From']    = ($incomingemail) ? $incomingemail : mail_notify_from();
    $headers['To']      = $to;
469 470
    // TRANS: Subject line for SMS-by-email notification messages.
    // TRANS: %s is the posting user's nickname.
471 472 473 474 475 476
    $headers['Subject'] = sprintf(_('%s status'),
                                  $other->getBestName());

    $body = $notice->content;

    return mail_send($smsemail, $headers, $body);
477
}
478

479 480 481 482 483 484 485 486 487 488 489 490 491 492
/**
 * 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
493

494 495
    $headers['From']    = mail_notify_from();
    $headers['To']      = $nickname . ' <' . $address . '>';
496
    // TRANS: Subject line for SMS-by-email address confirmation message.
497
    $headers['Subject'] = _('SMS confirmation');
498

499 500
    // TRANS: Main body heading for SMS-by-email address confirmation message.
    // TRANS: %s is the addressed user's nickname.
501
    $body  = sprintf(_("%s: confirm you own this phone number with this code:"), $nickname);
502 503 504 505 506
    $body .= "\n\n";
    $body .= $code;
    $body .= "\n\n";

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

509 510 511 512 513 514 515 516 517 518
/**
 * 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)
{
519
    common_switch_locale($to->language);
520 521
    // TRANS: Subject for 'nudge' notification email.
    // TRANS: %s is the nudging user.
522
    $subject = sprintf(_('You have been nudged by %s'), $from->nickname);
523 524 525

    $from_profile = $from->getProfile();

526 527
    // TRANS: Body for 'nudge' notification email.
    // TRANS: %1$s is the nuding user's long name, $2$s is the nudging user's nickname,
528
    // TRANS: %3$s is a URL to post notices at.
529 530 531 532
    $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".
533
                      "Don't reply to this email; it won't get to them."),
534 535
                    $from_profile->getBestName(),
                    $from->nickname,
536 537
                    common_local_url('all', array('nickname' => $to->nickname))) .
            mail_footer_block();
538
    common_switch_locale();
Dave Hall's avatar
Dave Hall committed
539 540 541 542

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

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

545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561
/**
 * 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);
    }
562

563 564 565
    if (is_null($to)) {
        $to = User::staticGet('id', $message->to_profile);
    }
Evan Prodromou's avatar
Evan Prodromou committed
566

567 568 569
    if (is_null($to->email) || !$to->emailnotifymsg) {
        return true;
    }
570

571
    common_switch_locale($to->language);
572 573
    // TRANS: Subject for direct-message notification email.
    // TRANS: %s is the sending user's nickname.
574 575 576 577
    $subject = sprintf(_('New private message from %s'), $from->nickname);

    $from_profile = $from->getProfile();

578 579 580
    // 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,
581 582 583 584 585 586
    $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".
587
                      "Don't reply to this email; it won't get to them."),
588 589 590
                    $from_profile->getBestName(),
                    $from->nickname,
                    $message->content,
591 592
                    common_local_url('newmessage', array('to' => $from->id))) .
            mail_footer_block();
593

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

596
    common_switch_locale();
Dave Hall's avatar
Dave Hall committed
597
    return mail_to_user($to, $subject, $body, $headers);
Evan Prodromou's avatar
Evan Prodromou committed
598
}
599

600 601 602
/**
 * notify a user that one of their notices has been chosen as a 'fave'
 *
603
 * Doesn't check that the user has an email address nor if they
604 605 606 607 608 609 610 611 612 613 614
 * 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)
{
615 616 617 618
    if (!$user->hasRight(Right::EMAILONFAVE)) {
        return;
    }

619
    $profile = $user->getProfile();
620 621 622 623
    if ($other->hasBlocked($profile)) {
        // If the author has blocked us, don't spam them with a notification.
        return;
    }
624 625

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

627
    common_switch_locale($other->language);
628

629 630
    // 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.
631
    $subject = sprintf(_('%1$s (@%2$s) added your notice as a favorite'), $bestname, $user->nickname);
632

633 634 635 636 637
    // 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.
638
    $body = sprintf(_("%1\$s (@%7\$s) just added your notice from %2\$s".
639
                      " as one of their favorites.\n\n" .
640
                      "The URL of your notice is:\n\n" .
641
                      "%3\$s\n\n" .
642
                      "The text of your notice is:\n\n" .
643
                      "%4\$s\n\n" .
644
                      "You can see the list of %1\$s's favorites here:\n\n" .
645
                      "%5\$s"),
646 647 648 649
                    $bestname,
                    common_exact_date($notice->created),
                    common_local_url('shownotice',
                                     array('notice' => $notice->id)),
650
                    $notice->content,
651 652
                    common_local_url('showfavorites',
                                     array('nickname' => $user->nickname)),
653
                    common_config('site', 'name'),
654 655
                    $user->nickname) .
            mail_footer_block();
656

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

659
    common_switch_locale();
Dave Hall's avatar
Dave Hall committed
660
    mail_to_user($other, $subject, $body, $headers);
661
}
662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678

/**
 * 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();

679 680 681 682
    if ($sender->id == $user->id) {
        return;
    }

683 684 685 686
    if (!$sender->hasRight(Right::EMAILONREPLY)) {
        return;
    }

687 688
    $bestname = $sender->getBestName();

689
    common_switch_locale($user->language);
690

691 692 693 694 695 696 697 698 699
    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 = '';
    }
700

701 702 703
    // 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);
704

705
        // TRANS: Body of @-reply notification e-mail.
706
        // TRANS: %1$s is the sending user's name, $2$s is the StatusNet sitename,
707 708
        // 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),
709 710
        // 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".
711 712 713 714
                      "The notice is here:\n\n".
                      "\t%3\$s\n\n" .
                      "It reads:\n\n".
                      "\t%4\$s\n\n" .
715
                      "%5\$s" .
716
                      "You can reply back here:\n\n".
717
                      "\t%6\$s\n\n" .
718
                      "The list of all @-replies for you here:\n\n" .
719 720
                      "%7\$s"),
                    $sender->getFancyName(),//%1
721
                    common_config('site', 'name'),//%2
722
                    common_local_url('shownotice',
723 724
                                     array('notice' => $notice->id)),//%3
                    $notice->content,//%4
725
                    $conversationEmailText,//%5
726
                    common_local_url('newnotice',
727
                                     array('replyto' => $sender->nickname, 'inreplyto' => $notice->id)),//%6
728
                    common_local_url('replies',
729 730
                                     array('nickname' => $user->nickname))) . //%7
                mail_footer_block();
Dave Hall's avatar
Dave Hall committed
731 732
    $headers = _mail_prepare_headers('mention', $user->nickname, $sender->nickname);

733
    common_switch_locale();
Dave Hall's avatar
Dave Hall committed
734
    mail_to_user($user, $subject, $body, $headers);
735
}
Dave Hall's avatar
Dave Hall committed
736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756

/**
 * 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;
}
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 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850

/**
 * 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::staticGet('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::staticGet('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: %3$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', array('nickname' => $group->nickname))) .
                    mail_profile_block($joiner) .
                    mail_footer_block();

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