mail.php 32.9 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
        $backend = Mail::factory(common_config('mail', 'backend'),
mmn's avatar
mmn committed
53
                                 common_config('mail', 'params') ?: array());
54 55 56 57 58
        if (PEAR::isError($backend)) {
            common_server_error($backend->getMessage(), 500);
        }
    }
    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)
{
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88
    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);
        return true;
    } catch (PEAR_Exception $e) {
        common_log(
            LOG_ERR,
            "Unable to send email - '{$e->getMessage()}'. "
            . 'Is your mail subsystem set up correctly?'
        );
89 90
        return false;
    }
91 92
}

93 94 95 96 97 98 99 100 101 102 103 104 105 106
/**
 * 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;
107
}
Evan Prodromou's avatar
Evan Prodromou committed
108

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

121
    if (!$notifyfrom) {
122

123
        $domain = mail_domain();
124

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

    return $notifyfrom;
129 130
}

131 132 133 134 135 136
/**
 * 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
137
 * @param array  $headers optional list of email headers
138 139 140 141
 * @param string $address optional specification of email address
 *
 * @return boolean success flag
 */
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
/**
 * 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
 */
170
function mail_confirm_address($user, $code, $nickname, $address, $url=null)
171
{
172 173 174 175
    if (empty($url)) {
        $url = common_local_url('confirmaddress', array('code' => $code));
    }

176
    // TRANS: Subject for address confirmation email.
177 178
    $subject = _('Email address confirmation');

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

Dave Hall's avatar
Dave Hall committed
192 193 194
    $headers = array();

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

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

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

        $profile = $listenee->getProfile();

        $name = $profile->getBestName();

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

        $recipients = $listenee->email;

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

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

252
        // TRANS: Main body of new-subscriber notification e-mail.
253
        // TRANS: %1$s is the subscriber's long name, %2$s is the StatusNet sitename.
254
        $body = sprintf(_('%1$s is now following you on %2$s.'),
255
                        $long_name,
256 257 258
                        common_config('site', 'name')) .
                mail_profile_block($other) .
                mail_footer_block();
259

260
        // reset localization
261
        common_switch_locale();
262
        mail_send($recipients, $headers, $body);
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
    }
}

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);
306
    }
307
}
308

309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326
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
327
 * @return string
328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362
 */
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.
363 364 365
    $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.'),
366 367 368 369 370 371
                     $blocklink);
    $out[] = "";

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

372 373 374 375 376 377 378 379 380 381 382 383
/**
 * 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();
384

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

387 388
    $headers['From']    = $user->incomingemail;
    $headers['To']      = $name . ' <' . $user->email . '>';
389 390
    // TRANS: Subject of notification mail for new posting email address.
    // TRANS: %s is the StatusNet sitename.
391 392
    $headers['Subject'] = sprintf(_('New email address for posting to %s'),
                                  common_config('site', 'name'));
Evan Prodromou's avatar
Evan Prodromou committed
393

394 395 396
    // 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.
397 398
    $body = sprintf(_("You have a new posting address on %1\$s.\n\n".
                      "Send email to %2\$s to post new messages.\n\n".
399
                      "More email instructions at %3\$s."),
400 401
                    common_config('site', 'name'),
                    $user->incomingemail,
402 403
                    common_local_url('doc', array('title' => 'email'))) .
            mail_footer_block();
Evan Prodromou's avatar
Evan Prodromou committed
404

405
    mail_send($user->email, $headers, $body);
406 407
}

408 409 410 411 412 413 414 415 416 417 418 419
/**
 * 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;
420
}
421

422 423 424 425 426 427 428 429 430 431 432 433 434 435
/**
 * 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
436

437
    $user = new User();
438

439
    $UT = common_config('db','type')=='pgsql'?'"user"':'user';
440
    $replies = $notice->getReplies();
441
    $user->query('SELECT nickname, smsemail, incomingemail ' .
442
                 "FROM $UT LEFT OUTER JOIN subscription " .
443
                 "ON $UT.id = subscription.subscriber " .
444
                 'AND subscription.subscribed = ' . $notice->profile_id . ' ' .
Evan Prodromou's avatar
Evan Prodromou committed
445
                 'AND subscription.subscribed != subscription.subscriber ' .
446 447
                 // Users (other than the sender) who `want SMS notices':
                 "WHERE $UT.id != " . $notice->profile_id . ' ' .
448 449
                 "AND $UT.smsemail IS NOT null " .
                 "AND $UT.smsnotify = 1 " .
450 451 452 453 454 455 456 457 458 459
                 // ... 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))
                           : '') .
                 ')');
460

461 462 463 464 465 466
    while ($user->fetch()) {
        common_log(LOG_INFO,
                   'Sending notice ' . $notice->id . ' to ' . $user->smsemail,
                   __FILE__);
        $success = 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 480 481 482
        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;
483 484
}

485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500
/**
 * 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,
501 502
                                        $user->incomingemail,
                                        $user->nickname);
503 504
}

505 506 507 508 509 510 511 512 513
/**
 * 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'
514
 * @param string $nickname      nickname to add to beginning
515 516 517
 *
 * @return boolean success flag
 */
518
function mail_send_sms_notice_address($notice, $smsemail, $incomingemail, $nickname)
519 520
{
    $to = $nickname . ' <' . $smsemail . '>';
521

522
    $other = $notice->getProfile();
523

524 525
    common_log(LOG_INFO, 'Sending notice ' . $notice->id .
               ' to ' . $smsemail, __FILE__);
526

527 528 529 530
    $headers = array();

    $headers['From']    = ($incomingemail) ? $incomingemail : mail_notify_from();
    $headers['To']      = $to;
531 532
    // TRANS: Subject line for SMS-by-email notification messages.
    // TRANS: %s is the posting user's nickname.
533 534 535 536 537 538
    $headers['Subject'] = sprintf(_('%s status'),
                                  $other->getBestName());

    $body = $notice->content;

    return mail_send($smsemail, $headers, $body);
539
}
540

541 542 543 544 545 546 547 548 549 550 551 552 553 554
/**
 * 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
555

556 557
    $headers['From']    = mail_notify_from();
    $headers['To']      = $nickname . ' <' . $address . '>';
558
    // TRANS: Subject line for SMS-by-email address confirmation message.
559
    $headers['Subject'] = _('SMS confirmation');
560

561 562
    // TRANS: Main body heading for SMS-by-email address confirmation message.
    // TRANS: %s is the addressed user's nickname.
563
    $body  = sprintf(_('%s: confirm you own this phone number with this code:'), $nickname);
564 565 566 567 568
    $body .= "\n\n";
    $body .= $code;
    $body .= "\n\n";

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

571 572 573 574 575 576 577 578 579 580
/**
 * 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)
{
581
    common_switch_locale($to->language);
582 583
    // TRANS: Subject for 'nudge' notification email.
    // TRANS: %s is the nudging user.
584
    $subject = sprintf(_('You have been nudged by %s'), $from->nickname);
585 586 587

    $from_profile = $from->getProfile();

588 589
    // TRANS: Body for 'nudge' notification email.
    // TRANS: %1$s is the nuding user's long name, $2$s is the nudging user's nickname,
590
    // TRANS: %3$s is a URL to post notices at.
591 592 593 594
    $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".
595
                      "Don't reply to this email; it won't get to them."),
596 597
                    $from_profile->getBestName(),
                    $from->nickname,
598 599
                    common_local_url('all', array('nickname' => $to->nickname))) .
            mail_footer_block();
600
    common_switch_locale();
Dave Hall's avatar
Dave Hall committed
601 602 603 604

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

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

607 608 609 610 611 612 613 614 615 616 617 618 619 620 621
/**
 * 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)) {
622
        $from = User::getKV('id', $message->from_profile);
623
    }
624

625
    if (is_null($to)) {
626
        $to = User::getKV('id', $message->to_profile);
627
    }
Evan Prodromou's avatar
Evan Prodromou committed
628

629 630 631
    if (is_null($to->email) || !$to->emailnotifymsg) {
        return true;
    }
632

633
    common_switch_locale($to->language);
634 635
    // TRANS: Subject for direct-message notification email.
    // TRANS: %s is the sending user's nickname.
636 637 638 639
    $subject = sprintf(_('New private message from %s'), $from->nickname);

    $from_profile = $from->getProfile();

640 641 642
    // 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,
643 644 645 646 647 648
    $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".
649
                      "Don't reply to this email; it won't get to them."),
650 651 652
                    $from_profile->getBestName(),
                    $from->nickname,
                    $message->content,
653 654
                    common_local_url('newmessage', array('to' => $from->id))) .
            mail_footer_block();
655

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

658
    common_switch_locale();
Dave Hall's avatar
Dave Hall committed
659
    return mail_to_user($to, $subject, $body, $headers);
Evan Prodromou's avatar
Evan Prodromou committed
660
}
661

662
/**
Siebrand Mazeland's avatar
Siebrand Mazeland committed
663
 * Notify a user that one of their notices has been chosen as a 'fave'
664
 *
665
 * Doesn't check that the user has an email address nor if they
666 667 668
 * want to receive notification of faves. Maybe this happens higher
 * up the stack...?
 *
mmn's avatar
mmn committed
669 670 671
 * @param User    $rcpt   The user whose notice was faved
 * @param Profile $sender The user who faved the notice
 * @param Notice  $notice The notice that was faved
672 673 674
 *
 * @return void
 */
mmn's avatar
mmn committed
675
function mail_notify_fave(User $rcpt, Profile $sender, Notice $notice)
676
{
mmn's avatar
mmn committed
677
    if (!$sender->hasRight(Right::EMAILONFAVE)) {
678 679 680
        return;
    }

mmn's avatar
mmn committed
681
    if ($rcpt->hasBlocked($sender)) {
682 683 684
        // If the author has blocked us, don't spam them with a notification.
        return;
    }
685

686 687 688 689
    if (!$rcpt->getPref('notify', 'email_fave', 1)) {
        return;
    }

mmn's avatar
mmn committed
690
    $bestname = $sender->getBestName();
691

mmn's avatar
mmn committed
692
    common_switch_locale($rcpt->language);
693

694 695
    // 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.
mmn's avatar
mmn committed
696
    $subject = sprintf(_('%1$s (@%2$s) added your notice as a favorite'), $bestname, $sender->getNickname());
697

698 699 700 701 702
    // 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.
703
    $body = sprintf(_("%1\$s (@%7\$s) just added your notice from %2\$s".
704
                      " as one of their favorites.\n\n" .
705
                      "The URL of your notice is:\n\n" .
706
                      "%3\$s\n\n" .
707
                      "The text of your notice is:\n\n" .
708
                      "%4\$s\n\n" .
709
                      "You can see the list of %1\$s's favorites here:\n\n" .
710
                      "%5\$s"),
711 712 713 714
                    $bestname,
                    common_exact_date($notice->created),
                    common_local_url('shownotice',
                                     array('notice' => $notice->id)),
715
                    $notice->content,
716
                    common_local_url('showfavorites',
mmn's avatar
mmn committed
717
                                     array('nickname' => $sender->getNickname())),
718
                    common_config('site', 'name'),
mmn's avatar
mmn committed
719
                    $sender->getNickname()) .
720
            mail_footer_block();
721

mmn's avatar
mmn committed
722
    $headers = _mail_prepare_headers('fave', $rcpt->getNickname(), $sender->getNickname());
Dave Hall's avatar
Dave Hall committed
723

724
    common_switch_locale();
mmn's avatar
mmn committed
725
    mail_to_user($rcpt, $subject, $body, $headers);
726
}
727 728

/**
Siebrand Mazeland's avatar
Siebrand Mazeland committed
729
 * Notify a user that they have received an "attn:" message AKA "@-reply"
730 731 732 733 734 735 736 737 738 739 740 741 742 743
 *
 * @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();

744 745 746 747
    if ($sender->id == $user->id) {
        return;
    }

748 749 750 751
    if (!$sender->hasRight(Right::EMAILONREPLY)) {
        return;
    }

752 753 754 755 756
    if ($user->hasBlocked($sender)) {
        // If the author has blocked us, don't spam them with a notification.
        return;
    }

757 758
    $bestname = $sender->getBestName();

759
    common_switch_locale($user->language);
760

761 762 763 764 765 766 767 768 769
    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 = '';
    }
770

771 772 773
    // 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);
774

775
        // TRANS: Body of @-reply notification e-mail.
776
        // TRANS: %1$s is the sending user's name, $2$s is the StatusNet sitename,
777
        // TRANS: %3$s is a URL to the notice, %4$s is the notice text,
778
        // 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),
779 780
        // 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".
781 782 783 784
                      "The notice is here:\n\n".
                      "\t%3\$s\n\n" .
                      "It reads:\n\n".
                      "\t%4\$s\n\n" .
785
                      "%5\$s" .
786
                      "You can reply back here:\n\n".
787
                      "\t%6\$s\n\n" .
788
                      "The list of all @-replies for you here:\n\n" .
789 790
                      "%7\$s"),
                    $sender->getFancyName(),//%1
791
                    common_config('site', 'name'),//%2
792
                    common_local_url('shownotice',
793 794
                                     array('notice' => $notice->id)),//%3
                    $notice->content,//%4
795
                    $conversationEmailText,//%5
796
                    common_local_url('newnotice',
797
                                     array('replyto' => $sender->nickname, 'inreplyto' => $notice->id)),//%6
798
                    common_local_url('replies',
799 800
                                     array('nickname' => $user->nickname))) . //%7
                mail_footer_block();
Dave Hall's avatar
Dave Hall committed
801 802
    $headers = _mail_prepare_headers('mention', $user->nickname, $sender->nickname);

803
    common_switch_locale();
Dave Hall's avatar
Dave Hall committed
804
    mail_to_user($user, $subject, $body, $headers);
805
}
Dave Hall's avatar
Dave Hall committed
806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826

/**
 * 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;
}
827 828 829 830 831 832 833 834 835 836 837 838 839

/**
 * 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...
840
        $adminUser = User::getKV('id', $admin->id);
841 842 843 844 845 846 847 848 849 850 851
        // @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 '.
852
                                            'your group %2$s on %3$s'),
853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886
                                          $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...
887
        $adminUser = User::getKV('id', $admin->id);
888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904
        // @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,
905
            // TRANS: %4$s is the URL to the moderation queue page.
906 907 908 909 910 911 912 913 914 915 916 917 918 919 920
            $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);
        }
    }
}