plugins/EmailSummary/useremailsummaryhandler.php

   1 <?php
   2 /**
   3  * StatusNet - the distributed open-source microblogging tool
   4  *
   5  * Handler for queue items of type 'usersum', sends an email summaries
   6  * to a particular user.
   7  *
   8  * This program is free software: you can redistribute it and/or modify
   9  * it under the terms of the GNU Affero General Public License as published by
  10  * the Free Software Foundation, either version 3 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU Affero General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Affero General Public License
  19  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20  *
  21  * @category  Sample
  22  * @package   StatusNet
  23  * @author    Evan Prodromou <evan@status.net>
  24  * @copyright 2010 StatusNet, Inc.
  25  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  26  * @link      http://status.net/
  27  */
  28
  29 if (!defined('STATUSNET')) {
  30     exit(1);
  31 }
  32
  33 /**
  34  * Handler for queue items of type 'usersum', sends an email summaries
  35  * to a particular user.
  36  *
  37  * @category  Email
  38  * @package   StatusNet
  39  * @author    Evan Prodromou <evan@status.net>
  40  * @copyright 2010 StatusNet, Inc.
  41  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  42  * @link      http://status.net/
  43  */
  44
  45 class UserEmailSummaryHandler extends QueueHandler
  46 {
  47     // Maximum number of notices to include by default. This is probably too much.
  48
  49     const MAX_NOTICES = 200;
  50
  51     /**
  52      * Return transport keyword which identifies items this queue handler
  53      * services; must be defined for all subclasses.
  54      *
  55      * Must be 8 characters or less to fit in the queue_item database.
  56      * ex "email", "jabber", "sms", "irc", ...
  57      *
  58      * @return string
  59      */
  60
  61     function transport()
  62     {
  63         return 'sitesum';
  64     }
  65
  66     /**
  67      * Send a summary email to the user
  68      *
  69      * @param mixed $object
  70      * @return boolean true on success, false on failure
  71      */
  72
  73     function handle($user_id)
  74     {
  75         // Skip if they've asked not to get summaries
  76
  77         $ess = Email_summary_status::staticGet('user_id', $user_id);
  78
  79         if (!empty($ess) && !$ess->send_summary) {
  80             common_log(LOG_INFO, sprintf('Not sending email summary for user %s by request.', $user_id));
  81             return true;
  82         }
  83
  84         $since_id = null;
  85
  86         if (!empty($ess)) {
  87             $since_id = $ess->last_summary_id;
  88         }
  89
  90         $user = User::staticGet('id', $user_id);
  91
  92         if (empty($user)) {
  93             common_log(LOG_INFO, sprintf('Not sending email summary for user %s; no such user.', $user_id));
  94             return true;
  95         }
  96
  97         if (empty($user->email)) {
  98             common_log(LOG_INFO, sprintf('Not sending email summary for user %s; no email address.', $user_id));
  99             return true;
 100         }
 101
 102         $profile = $user->getProfile();
 103
 104         if (empty($profile)) {
 105             common_log(LOG_WARNING, sprintf('Not sending email summary for user %s; no profile.', $user_id));
 106             return true;
 107         }
 108
 109         $notice = $user->ownFriendsTimeline(0, self::MAX_NOTICES, $since_id);
 110
 111         if (empty($notice) || $notice->N == 0) {
 112             common_log(LOG_WARNING, sprintf('Not sending email summary for user %s; no notices.', $user_id));
 113             return true;
 114         }
 115
 116         // XXX: This is risky fingerpoken in der objektvars, but I didn't feel like
 117         // figuring out a better way. -ESP
 118
 119         $new_top = null;
 120
 121         if ($notice instanceof ArrayWrapper) {
 122             $new_top = $notice->_items[0]->id;
 123         }
 124
 125         $out = new XMLStringer();
 126
 127         $out->raw(sprintf(_('<p>Recent updates from %1s for %2s:</p>'),
 128                           common_config('site', 'name'),
 129                           $profile->getBestName()));
 130
 131
 132         $out->elementStart('table', array('width' => '541px', 'style' => 'border: none'));
 133
 134         while ($notice->fetch()) {
 135
 136             $profile = Profile::staticGet('id', $notice->profile_id);
 137
 138             if (empty($profile)) {
 139                 continue;
 140             }
 141
 142             $avatar = $profile->getAvatar(AVATAR_STREAM_SIZE);
 143
 144             $out->elementStart('tr');
 145             $out->elementStart('td', array('width' => AVATAR_STREAM_SIZE,
 146                                            'height' => AVATAR_STREAM_SIZE,
 147                                            'align' => 'left',
 148                                            'valign' => 'top'));
 149             $out->element('img', array('src' => ($avatar) ?
 150                                        $avatar->displayUrl() :
 151                                        Avatar::defaultImage(AVATAR_STREAM_SIZE),
 152                                        'class' => 'avatar photo',
 153                                        'width' => AVATAR_STREAM_SIZE,
 154                                        'height' => AVATAR_STREAM_SIZE,
 155                                        'alt' => $profile->getBestName()));
 156             $out->elementEnd('td');
 157             $out->elementStart('td', array('align' => 'left',
 158                                            'valign' => 'top'));
 159             $out->element('a', array('href' => $profile->profileurl),
 160                           $profile->nickname);
 161             $out->text(' ');
 162             $out->raw($notice->rendered);
 163             $out->element('br'); // yeah, you know it. I just wrote a <br> in the middle of my table layout.
 164             $noticeurl = $notice->bestUrl();
 165             // above should always return an URL
 166             assert(!empty($noticeurl));
 167             $out->elementStart('a', array('rel' => 'bookmark',
 168                                           'class' => 'timestamp',
 169                                           'href' => $noticeurl));
 170             $dt = common_date_iso8601($notice->created);
 171             $out->element('abbr', array('class' => 'published',
 172                                         'title' => $dt),
 173                           common_date_string($notice->created));
 174             $out->elementEnd('a');
 175             if ($notice->hasConversation()) {
 176                 $conv = Conversation::staticGet('id', $notice->conversation);
 177                 $convurl = $conv->uri;
 178                 if (!empty($convurl)) {
 179                     $out->text(' ');
 180                     $out->element('a',
 181                                   array('href' => $convurl.'#notice-'.$notice->id,
 182                                         'class' => 'response'),
 183                                   _('in context'));
 184                 }
 185             }
 186             $out->elementEnd('td');
 187             $out->elementEnd('tr');
 188         }
 189
 190         $out->elementEnd('table');
 191
 192         $out->raw(sprintf(_('<p><a href="%1s">change your email settings for %2s</a></p>'),
 193                           common_local_url('emailsettings'),
 194                           common_config('site', 'name')));
 195
 196         $body = $out->getString();
 197
 198         // FIXME: do something for people who don't like HTML email
 199
 200         mail_to_user($user, _('Updates from your network'), $body,
 201                      array('Content-Type' => 'text/html; charset=UTF-8'));
 202
 203         if (empty($ess)) {
 204
 205             $ess = new Email_summary_status();
 206
 207             $ess->user_id         = $user_id;
 208             $ess->created         = common_sql_now();
 209             $ess->last_summary_id = $new_top;
 210             $ess->modified        = common_sql_now();
 211
 212             $ess->insert();
 213
 214         } else {
 215
 216             $orig = clone($ess);
 217
 218             $ess->last_summary_id = $new_top;
 219             $ess->modified        = common_sql_now();
 220
 221             $ess->update($orig);
 222         }
 223
 224         return true;
 225     }
 226 }