lib/messagelistitem.php

   1 <?php
   2 /**
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2011, StatusNet, Inc.
   5  *
   6  * A single list item for showing in a message list
   7  *
   8  * PHP version 5
   9  *
  10  * This program is free software: you can redistribute it and/or modify
  11  * it under the terms of the GNU Affero General Public License as published by
  12  * the Free Software Foundation, either version 3 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Affero General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Affero General Public License
  21  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  22  *
  23  * @category  Widget
  24  * @package   StatusNet
  25  * @author    Evan Prodromou <evan@status.net>
  26  * @copyright 2011 StatusNet, Inc.
  27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  28  * @link      http://status.net/
  29  */
  30
  31 if (!defined('STATUSNET')) {
  32     // This check helps protect against security problems;
  33     // your code file can't be executed directly from the web.
  34     exit(1);
  35 }
  36
  37 /**
  38  * A single item in a message list
  39  *
  40  * @category  Widget
  41  * @package   StatusNet
  42  * @author    Evan Prodromou <evan@status.net>
  43  * @copyright 2011 StatusNet, Inc.
  44  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  45  * @link      http://status.net/
  46  */
  47 abstract class MessageListItem extends Widget
  48 {
  49     var $message;
  50
  51     /**
  52      * Constructor
  53      *
  54      * @param HTMLOutputter $out     Output context
  55      * @param Message       $message Message to show
  56      */
  57     function __construct($out, $message)
  58     {
  59         parent::__construct($out);
  60         $this->message = $message;
  61     }
  62
  63     /**
  64      * Show the widget
  65      *
  66      * @return void
  67      */
  68     function show()
  69     {
  70         $this->out->elementStart('li', array('class' => 'h-entry notice',
  71                                              'id' => 'message-' . $this->message->id));
  72
  73         $profile = $this->getMessageProfile();
  74
  75         $this->out->elementStart('a', array('href' => $profile->profileurl,
  76                                             'class' => 'p-author'));
  77         $avatarUrl = $profile->avatarUrl(AVATAR_STREAM_SIZE);
  78         $this->out->element('img', array('src' => $avatarUrl,
  79                                          'class' => 'avatar u-photo',
  80                                          'width' => AVATAR_STREAM_SIZE,
  81                                          'height' => AVATAR_STREAM_SIZE,
  82                                          'alt' => $profile->getBestName()));
  83         $this->out->element('span', array('class' => 'nickname fn'), $profile->getNickname());
  84         $this->out->elementEnd('a');
  85
  86         // FIXME: URL, image, video, audio
  87         $this->out->elementStart('div', array('class' => 'e-content'));
  88         $this->out->raw($this->message->rendered);
  89         $this->out->elementEnd('div');
  90
  91         $messageurl = common_local_url('showmessage',
  92                                        array('message' => $this->message->id));
  93
  94         // XXX: we need to figure this out better. Is this right?
  95         if (strcmp($this->message->uri, $messageurl) != 0 &&
  96             preg_match('/^http/', $this->message->uri)) {
  97             $messageurl = $this->message->uri;
  98         }
  99
 100         $this->out->elementStart('div', 'entry-metadata');
 101         $this->out->elementStart('a', array('rel' => 'bookmark',
 102                                             'class' => 'timestamp',
 103                                             'href' => $messageurl));
 104         $dt = common_date_iso8601($this->message->created);
 105         $this->out->element('time', array('class' => 'dt-published',
 106                                           'datetime' => common_date_iso8601($this->message->created),
 107                                           // TRANS: Timestamp title (tooltip text) for NoticeListItem
 108                                           'title' => common_exact_date($this->message->created)),
 109                             common_date_string($this->message->created));
 110         $this->out->elementEnd('a');
 111
 112         if ($this->message->source) {
 113             $this->out->elementStart('span', 'source');
 114             // FIXME: bad i18n. Device should be a parameter (from %s).
 115             // TRANS: Followed by notice source (usually the client used to send the notice).
 116             $this->out->text(_('from'));
 117             $this->showSource($this->message->source);
 118             $this->out->elementEnd('span');
 119         }
 120         $this->out->elementEnd('div');
 121
 122         $this->out->elementEnd('li');
 123     }
 124
 125     /**
 126      * Dummy method. Serves no other purpose than to make strings available used
 127      * in self::showSource() through xgettext.
 128      *
 129      * @return void
 130      */
 131     function messageListItemDummyMessages()
 132     {
 133         // A dummy array with messages. These will get extracted by xgettext and
 134         // are used in self::showSource().
 135         $dummy_messages = array(
 136             // TRANS: A possible notice source (web interface).
 137             _m('SOURCE','web'),
 138             // TRANS: A possible notice source (XMPP).
 139             _m('SOURCE','xmpp'),
 140             // TRANS: A possible notice source (e-mail).
 141             _m('SOURCE','mail'),
 142             // TRANS: A possible notice source (OpenMicroBlogging).
 143             _m('SOURCE','omb'),
 144             // TRANS: A possible notice source (Application Programming Interface).
 145             _m('SOURCE','api'),
 146         );
 147     }
 148
 149     /**
 150      * Show the source of the message
 151      *
 152      * Returns either the name (and link) of the API client that posted the notice,
 153      * or one of other other channels.
 154      *
 155      * @param string $source the source of the message
 156      *
 157      * @return void
 158      */
 159     function showSource($source)
 160     {
 161         $source_name = _m('SOURCE',$source);
 162         switch ($source) {
 163         case 'web':
 164         case 'xmpp':
 165         case 'mail':
 166         case 'omb':
 167         case 'api':
 168             $this->out->element('span', 'device', $source_name);
 169             break;
 170         default:
 171             $ns = Notice_source::getKV($source);
 172             if ($ns) {
 173                 $this->out->elementStart('span', 'device');
 174                 $this->out->element('a', array('href' => $ns->url,
 175                                                'rel' => 'external'),
 176                                     $ns->name);
 177                 $this->out->elementEnd('span');
 178             } else {
 179                 $this->out->element('span', 'device', $source_name);
 180             }
 181             break;
 182         }
 183         return;
 184     }
 185
 186     /**
 187      * Return the profile to show in the message item
 188      *
 189      * Overridden in sub-classes to show sender, receiver, or whatever
 190      *
 191      * @return Profile profile to show avatar and name of
 192      */
 193     abstract function getMessageProfile();
 194 }