lib/noticelist.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * widget for displaying a list of notices
   6  *
   7  * PHP version 5
   8  *
   9  * LICENCE: This program is free software: you can redistribute it and/or modify
  10  * it under the terms of the GNU Affero General Public License as published by
  11  * the Free Software Foundation, either version 3 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU Affero General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Affero General Public License
  20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  21  *
  22  * @category  UI
  23  * @package   StatusNet
  24  * @author    Evan Prodromou <evan@status.net>
  25  * @author    Sarven Capadisli <csarven@status.net>
  26  * @copyright 2008 StatusNet, Inc.
  27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  28  * @link      http://status.net/
  29  */
  30
  31 if (!defined('STATUSNET') && !defined('LACONICA')) {
  32     exit(1);
  33 }
  34
  35 require_once INSTALLDIR.'/lib/favorform.php';
  36 require_once INSTALLDIR.'/lib/disfavorform.php';
  37 require_once INSTALLDIR.'/lib/attachmentlist.php';
  38
  39 /**
  40  * widget for displaying a list of notices
  41  *
  42  * There are a number of actions that display a list of notices, in
  43  * reverse chronological order. This widget abstracts out most of the
  44  * code for UI for notice lists. It's overridden to hide some
  45  * data for e.g. the profile page.
  46  *
  47  * @category UI
  48  * @package  StatusNet
  49  * @author   Evan Prodromou <evan@status.net>
  50  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  51  * @link     http://status.net/
  52  * @see      Notice
  53  * @see      NoticeListItem
  54  * @see      ProfileNoticeList
  55  */
  56
  57 class NoticeList extends Widget
  58 {
  59     /** the current stream of notices being displayed. */
  60
  61     var $notice = null;
  62
  63     /**
  64      * constructor
  65      *
  66      * @param Notice $notice stream of notices from DB_DataObject
  67      */
  68
  69     function __construct($notice, $out=null)
  70     {
  71         parent::__construct($out);
  72         $this->notice = $notice;
  73     }
  74
  75     /**
  76      * show the list of notices
  77      *
  78      * "Uses up" the stream by looping through it. So, probably can't
  79      * be called twice on the same list.
  80      *
  81      * @return int count of notices listed.
  82      */
  83
  84     function show()
  85     {
  86         $this->out->elementStart('div', array('id' =>'notices_primary'));
  87         $this->out->element('h2', null, _('Notices'));
  88         $this->out->elementStart('ol', array('class' => 'notices xoxo'));
  89
  90         $cnt = 0;
  91
  92         while ($this->notice->fetch() && $cnt <= NOTICES_PER_PAGE) {
  93             $cnt++;
  94
  95             if ($cnt > NOTICES_PER_PAGE) {
  96                 break;
  97             }
  98
  99             $item = $this->newListItem($this->notice);
 100             $item->show();
 101         }
 102
 103         $this->out->elementEnd('ol');
 104         $this->out->elementEnd('div');
 105
 106         return $cnt;
 107     }
 108
 109     /**
 110      * returns a new list item for the current notice
 111      *
 112      * Recipe (factory?) method; overridden by sub-classes to give
 113      * a different list item class.
 114      *
 115      * @param Notice $notice the current notice
 116      *
 117      * @return NoticeListItem a list item for displaying the notice
 118      */
 119
 120     function newListItem($notice)
 121     {
 122         return new NoticeListItem($notice, $this->out);
 123     }
 124 }
 125
 126 /**
 127  * widget for displaying a single notice
 128  *
 129  * This widget has the core smarts for showing a single notice: what to display,
 130  * where, and under which circumstances. Its key method is show(); this is a recipe
 131  * that calls all the other show*() methods to build up a single notice. The
 132  * ProfileNoticeListItem subclass, for example, overrides showAuthor() to skip
 133  * author info (since that's implicit by the data in the page).
 134  *
 135  * @category UI
 136  * @package  StatusNet
 137  * @author   Evan Prodromou <evan@status.net>
 138  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
 139  * @link     http://status.net/
 140  * @see      NoticeList
 141  * @see      ProfileNoticeListItem
 142  */
 143
 144 class NoticeListItem extends Widget
 145 {
 146     /** The notice this item will show. */
 147
 148     var $notice = null;
 149
 150     /** The profile of the author of the notice, extracted once for convenience. */
 151
 152     var $profile = null;
 153
 154     /**
 155      * constructor
 156      *
 157      * Also initializes the profile attribute.
 158      *
 159      * @param Notice $notice The notice we'll display
 160      */
 161
 162     function __construct($notice, $out=null)
 163     {
 164         parent::__construct($out);
 165         $this->notice  = $notice;
 166         $this->profile = $notice->getProfile();
 167     }
 168
 169     /**
 170      * recipe function for displaying a single notice.
 171      *
 172      * This uses all the other methods to correctly display a notice. Override
 173      * it or one of the others to fine-tune the output.
 174      *
 175      * @return void
 176      */
 177
 178     function show()
 179     {
 180         $this->showStart();
 181         if (Event::handle('StartShowNoticeItem', array($this))) {
 182             $this->showNotice();
 183             $this->showNoticeInfo();
 184             $this->showNoticeOptions();
 185             Event::handle('EndShowNoticeItem', array($this));
 186         }
 187         $this->showEnd();
 188     }
 189
 190     function showNotice()
 191     {
 192         $this->out->elementStart('div', 'entry-title');
 193         $this->showAuthor();
 194         $this->showContent();
 195         $this->out->elementEnd('div');
 196     }
 197
 198     function showNoticeInfo()
 199     {
 200         $this->out->elementStart('div', 'entry-content');
 201         $this->showNoticeLink();
 202         $this->showNoticeSource();
 203         $this->showNoticeLocation();
 204         $this->showContext();
 205         $this->out->elementEnd('div');
 206     }
 207
 208     function showNoticeOptions()
 209     {
 210         $user = common_current_user();
 211         if ($user) {
 212             $this->out->elementStart('div', 'notice-options');
 213             $this->showFaveForm();
 214             $this->showReplyLink();
 215             $this->showForwardForm();
 216             $this->showDeleteLink();
 217             $this->out->elementEnd('div');
 218         }
 219     }
 220
 221     /**
 222      * start a single notice.
 223      *
 224      * @return void
 225      */
 226
 227     function showStart()
 228     {
 229         // XXX: RDFa
 230         // TODO: add notice_type class e.g., notice_video, notice_image
 231         $this->out->elementStart('li', array('class' => 'hentry notice',
 232                                              'id' => 'notice-' . $this->notice->id));
 233     }
 234
 235     /**
 236      * show the "favorite" form
 237      *
 238      * @return void
 239      */
 240
 241     function showFaveForm()
 242     {
 243         $user = common_current_user();
 244         if ($user) {
 245             if ($user->hasFave($this->notice)) {
 246                 $disfavor = new DisfavorForm($this->out, $this->notice);
 247                 $disfavor->show();
 248             } else {
 249                 $favor = new FavorForm($this->out, $this->notice);
 250                 $favor->show();
 251             }
 252         }
 253     }
 254
 255     /**
 256      * show the author of a notice
 257      *
 258      * By default, this shows the avatar and (linked) nickname of the author.
 259      *
 260      * @return void
 261      */
 262
 263     function showAuthor()
 264     {
 265         $this->out->elementStart('span', 'vcard author');
 266         $attrs = array('href' => $this->profile->profileurl,
 267                        'class' => 'url');
 268         if (!empty($this->profile->fullname)) {
 269             $attrs['title'] = $this->profile->fullname . ' (' . $this->profile->nickname . ')';
 270         }
 271         $this->out->elementStart('a', $attrs);
 272         $this->showAvatar();
 273         $this->showNickname();
 274         $this->out->elementEnd('a');
 275         $this->out->elementEnd('span');
 276     }
 277
 278     /**
 279      * show the avatar of the notice's author
 280      *
 281      * This will use the default avatar if no avatar is assigned for the author.
 282      * It makes a link to the author's profile.
 283      *
 284      * @return void
 285      */
 286
 287     function showAvatar()
 288     {
 289         if ('shownotice' === $this->out->trimmed('action')) {
 290             $avatar_size = AVATAR_PROFILE_SIZE;
 291         } else {
 292             $avatar_size = AVATAR_STREAM_SIZE;
 293         }
 294         $avatar = $this->profile->getAvatar($avatar_size);
 295
 296         $this->out->element('img', array('src' => ($avatar) ?
 297                                          $avatar->displayUrl() :
 298                                          Avatar::defaultImage($avatar_size),
 299                                          'class' => 'avatar photo',
 300                                          'width' => $avatar_size,
 301                                          'height' => $avatar_size,
 302                                          'alt' =>
 303                                          ($this->profile->fullname) ?
 304                                          $this->profile->fullname :
 305                                          $this->profile->nickname));
 306     }
 307
 308     /**
 309      * show the nickname of the author
 310      *
 311      * Links to the author's profile page
 312      *
 313      * @return void
 314      */
 315
 316     function showNickname()
 317     {
 318         $this->out->element('span', array('class' => 'nickname fn'),
 319                             $this->profile->nickname);
 320     }
 321
 322     /**
 323      * show the content of the notice
 324      *
 325      * Shows the content of the notice. This is pre-rendered for efficiency
 326      * at save time. Some very old notices might not be pre-rendered, so
 327      * they're rendered on the spot.
 328      *
 329      * @return void
 330      */
 331
 332     function showContent()
 333     {
 334         // FIXME: URL, image, video, audio
 335         $this->out->elementStart('p', array('class' => 'entry-content'));
 336         if ($this->notice->rendered) {
 337             $this->out->raw($this->notice->rendered);
 338         } else {
 339             // XXX: may be some uncooked notices in the DB,
 340             // we cook them right now. This should probably disappear in future
 341             // versions (>> 0.4.x)
 342             $this->out->raw(common_render_content($this->notice->content, $this->notice));
 343         }
 344         $this->out->elementEnd('p');
 345     }
 346
 347     /**
 348      * show the link to the main page for the notice
 349      *
 350      * Displays a link to the page for a notice, with "relative" time. Tries to
 351      * get remote notice URLs correct, but doesn't always succeed.
 352      *
 353      * @return void
 354      */
 355
 356     function showNoticeLink()
 357     {
 358         if($this->notice->is_local){
 359             $noticeurl = common_local_url('shownotice',
 360                                       array('notice' => $this->notice->id));
 361         }else{
 362             $noticeurl = $this->notice->uri;
 363         }
 364         $this->out->elementStart('a', array('rel' => 'bookmark',
 365                                             'class' => 'timestamp',
 366                                             'href' => $noticeurl));
 367         $dt = common_date_iso8601($this->notice->created);
 368         $this->out->element('abbr', array('class' => 'published',
 369                                           'title' => $dt),
 370                             common_date_string($this->notice->created));
 371         $this->out->elementEnd('a');
 372     }
 373
 374     /**
 375      * show the notice location
 376      *
 377      * shows the notice location in the correct language.
 378      *
 379      * If an URL is available, makes a link. Otherwise, just a span.
 380      *
 381      * @return void
 382      */
 383
 384     function showNoticeLocation()
 385     {
 386         $id = $this->notice->id;
 387
 388         $location = $this->notice->getLocation();
 389
 390         if (empty($location)) {
 391             return;
 392         }
 393
 394         $name = $location->getName();
 395
 396         $lat = $this->notice->lat;
 397         $lon = $this->notice->lon;
 398         $latlon = (!empty($lat) && !empty($lon)) ? $lat.';'.$lon : '';
 399
 400         if (empty($name)) {
 401             $latdms = $this->decimalDegreesToDMS(abs($lat));
 402             $londms = $this->decimalDegreesToDMS(abs($lon));
 403             $name = sprintf(
 404                 _('%1$u°%2$u\'%3$u"%4$s %5$u°%6$u\'%7$u"%8$s'),
 405                 $latdms['deg'],$latdms['min'], $latdms['sec'],($lat>0?_('N'):_('S')),
 406                 $londms['deg'],$londms['min'], $londms['sec'],($lon>0?_('E'):_('W')));
 407         }
 408
 409         $url  = $location->getUrl();
 410
 411         $this->out->elementStart('span', array('class' => 'location'));
 412         $this->out->text(_('at'));
 413         if (empty($url)) {
 414             $this->out->element('span', array('class' => 'geo',
 415                                               'title' => $latlon),
 416                                 $name);
 417         } else {
 418             $this->out->element('a', array('class' => 'geo',
 419                                            'title' => $latlon,
 420                                            'href' => $url),
 421                                 $name);
 422         }
 423         $this->out->elementEnd('span');
 424     }
 425
 426     function decimalDegreesToDMS($dec)
 427     {
 428
 429         $vars = explode(".",$dec);
 430         $deg = $vars[0];
 431         $tempma = "0.".$vars[1];
 432
 433         $tempma = $tempma * 3600;
 434         $min = floor($tempma / 60);
 435         $sec = $tempma - ($min*60);
 436
 437         return array("deg"=>$deg,"min"=>$min,"sec"=>$sec);
 438     }
 439
 440     /**
 441      * Show the source of the notice
 442      *
 443      * Either the name (and link) of the API client that posted the notice,
 444      * or one of other other channels.
 445      *
 446      * @return void
 447      */
 448
 449     function showNoticeSource()
 450     {
 451         if ($this->notice->source) {
 452             $this->out->elementStart('span', 'source');
 453             $this->out->text(_('from'));
 454             $source_name = _($this->notice->source);
 455             switch ($this->notice->source) {
 456              case 'web':
 457              case 'xmpp':
 458              case 'mail':
 459              case 'omb':
 460              case 'system':
 461              case 'api':
 462                 $this->out->element('span', 'device', $source_name);
 463                 break;
 464              default:
 465                 $ns = Notice_source::staticGet($this->notice->source);
 466                 if ($ns) {
 467                     $this->out->elementStart('span', 'device');
 468                     $this->out->element('a', array('href' => $ns->url,
 469                                                    'rel' => 'external'),
 470                                         $ns->name);
 471                     $this->out->elementEnd('span');
 472                 } else {
 473                     $this->out->element('span', 'device', $source_name);
 474                 }
 475                 break;
 476             }
 477             $this->out->elementEnd('span');
 478         }
 479     }
 480
 481     /**
 482      * show link to notice this notice is a reply to
 483      *
 484      * If this notice is a reply, show a link to the notice it is replying to. The
 485      * heavy lifting for figuring out replies happens at save time.
 486      *
 487      * @return void
 488      */
 489
 490     function showContext()
 491     {
 492         $hasConversation = false;
 493         if( !empty($this->notice->conversation)
 494             && $this->notice->conversation != $this->notice->id){
 495             $hasConversation = true;
 496         }else{
 497             $conversation = Notice::conversationStream($this->notice->id, 1, 1);
 498             if($conversation->N > 0){
 499                 $hasConversation = true;
 500             }
 501         }
 502         if ($hasConversation){
 503             $convurl = common_local_url('conversation',
 504                                          array('id' => $this->notice->conversation));
 505             $this->out->element('a', array('href' => $convurl.'#notice-'.$this->notice->id,
 506                                            'class' => 'response'),
 507                                 _('in context'));
 508         }
 509     }
 510
 511     /**
 512      * show a link to reply to the current notice
 513      *
 514      * Should either do the reply in the current notice form (if available), or
 515      * link out to the notice-posting form. A little flakey, doesn't always work.
 516      *
 517      * @return void
 518      */
 519
 520     function showReplyLink()
 521     {
 522         if (common_logged_in()) {
 523             $reply_url = common_local_url('newnotice',
 524                                           array('replyto' => $this->profile->nickname, 'inreplyto' => $this->notice->id));
 525             $this->out->elementStart('a', array('href' => $reply_url,
 526                                                 'class' => 'notice_reply',
 527                                                 'title' => _('Reply to this notice')));
 528             $this->out->text(_('Reply'));
 529             $this->out->element('span', 'notice_id', $this->notice->id);
 530             $this->out->elementEnd('a');
 531         }
 532     }
 533
 534     /**
 535      * show the form to forward a notice
 536      *
 537      * @return void
 538      */
 539
 540     function showForwardForm()
 541     {
 542         $user = common_current_user();
 543         if ($user && $user->id != $this->notice->profile_id) {
 544             $profile = $user->getProfile();
 545             if ($profile->hasForwarded($this->notice->id)) {
 546                 $this->out->text(_('Forwarded'));
 547             } else {
 548                 $ff = new ForwardForm($this->out, $this->notice);
 549                 $ff->show();
 550             }
 551         }
 552     }
 553
 554     /**
 555      * if the user is the author, let them delete the notice
 556      *
 557      * @return void
 558      */
 559
 560     function showDeleteLink()
 561     {
 562         $user = common_current_user();
 563
 564         if (!empty($user) &&
 565             ($this->notice->profile_id == $user->id || $user->hasRight(Right::DELETEOTHERSNOTICE))) {
 566
 567             $deleteurl = common_local_url('deletenotice',
 568                                           array('notice' => $this->notice->id));
 569             $this->out->element('a', array('href' => $deleteurl,
 570                                            'class' => 'notice_delete',
 571                                            'title' => _('Delete this notice')), _('Delete'));
 572         }
 573     }
 574
 575     /**
 576      * finish the notice
 577      *
 578      * Close the last elements in the notice list item
 579      *
 580      * @return void
 581      */
 582
 583     function showEnd()
 584     {
 585         $this->out->elementEnd('li');
 586     }
 587 }