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             try {
 100                 $item = $this->newListItem($this->notice);
 101                 $item->show();
 102             } catch (Exception $e) {
 103                 // we log exceptions and continue
 104                 common_log(LOG_ERR, $e->getMessage());
 105                 continue;
 106             }
 107         }
 108
 109         $this->out->elementEnd('ol');
 110         $this->out->elementEnd('div');
 111
 112         return $cnt;
 113     }
 114
 115     /**
 116      * returns a new list item for the current notice
 117      *
 118      * Recipe (factory?) method; overridden by sub-classes to give
 119      * a different list item class.
 120      *
 121      * @param Notice $notice the current notice
 122      *
 123      * @return NoticeListItem a list item for displaying the notice
 124      */
 125
 126     function newListItem($notice)
 127     {
 128         return new NoticeListItem($notice, $this->out);
 129     }
 130 }
 131
 132 /**
 133  * widget for displaying a single notice
 134  *
 135  * This widget has the core smarts for showing a single notice: what to display,
 136  * where, and under which circumstances. Its key method is show(); this is a recipe
 137  * that calls all the other show*() methods to build up a single notice. The
 138  * ProfileNoticeListItem subclass, for example, overrides showAuthor() to skip
 139  * author info (since that's implicit by the data in the page).
 140  *
 141  * @category UI
 142  * @package  StatusNet
 143  * @author   Evan Prodromou <evan@status.net>
 144  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
 145  * @link     http://status.net/
 146  * @see      NoticeList
 147  * @see      ProfileNoticeListItem
 148  */
 149
 150 class NoticeListItem extends Widget
 151 {
 152     /** The notice this item will show. */
 153
 154     var $notice = null;
 155
 156     /** The notice that was repeated. */
 157
 158     var $repeat = null;
 159
 160     /** The profile of the author of the notice, extracted once for convenience. */
 161
 162     var $profile = null;
 163
 164     /**
 165      * constructor
 166      *
 167      * Also initializes the profile attribute.
 168      *
 169      * @param Notice $notice The notice we'll display
 170      */
 171
 172     function __construct($notice, $out=null)
 173     {
 174         parent::__construct($out);
 175         if (!empty($notice->repeat_of)) {
 176             $original = Notice::staticGet('id', $notice->repeat_of);
 177             if (empty($original)) { // could have been deleted
 178                 $this->notice = $notice;
 179             } else {
 180                 $this->notice = $original;
 181                 $this->repeat = $notice;
 182             }
 183         } else {
 184             $this->notice  = $notice;
 185         }
 186         $this->profile = $this->notice->getProfile();
 187     }
 188
 189     /**
 190      * recipe function for displaying a single notice.
 191      *
 192      * This uses all the other methods to correctly display a notice. Override
 193      * it or one of the others to fine-tune the output.
 194      *
 195      * @return void
 196      */
 197
 198     function show()
 199     {
 200         if (empty($this->notice)) {
 201             common_log(LOG_WARNING, "Trying to show missing notice; skipping.");
 202             return;
 203         } else if (empty($this->profile)) {
 204             common_log(LOG_WARNING, "Trying to show missing profile (" . $this->notice->profile_id . "); skipping.");
 205             return;
 206         }
 207
 208         $this->showStart();
 209         if (Event::handle('StartShowNoticeItem', array($this))) {
 210             $this->showNotice();
 211             $this->showNoticeInfo();
 212             $this->showNoticeOptions();
 213             Event::handle('EndShowNoticeItem', array($this));
 214         }
 215         $this->showEnd();
 216     }
 217
 218     function showNotice()
 219     {
 220         $this->out->elementStart('div', 'entry-title');
 221         $this->showAuthor();
 222         $this->showContent();
 223         $this->out->elementEnd('div');
 224     }
 225
 226     function showNoticeInfo()
 227     {
 228         $this->out->elementStart('div', 'entry-content');
 229         $this->showNoticeLink();
 230         $this->showNoticeSource();
 231         $this->showNoticeLocation();
 232         $this->showContext();
 233         $this->showRepeat();
 234         $this->out->elementEnd('div');
 235     }
 236
 237     function showNoticeOptions()
 238     {
 239         $user = common_current_user();
 240         if ($user) {
 241             $this->out->elementStart('div', 'notice-options');
 242             $this->showFaveForm();
 243             $this->showReplyLink();
 244             $this->showRepeatForm();
 245             $this->showDeleteLink();
 246             $this->out->elementEnd('div');
 247         }
 248     }
 249
 250     /**
 251      * start a single notice.
 252      *
 253      * @return void
 254      */
 255
 256     function showStart()
 257     {
 258         // XXX: RDFa
 259         // TODO: add notice_type class e.g., notice_video, notice_image
 260         $id = (empty($this->repeat)) ? $this->notice->id : $this->repeat->id;
 261         $this->out->elementStart('li', array('class' => 'hentry notice',
 262                                              'id' => 'notice-' . $id));
 263     }
 264
 265     /**
 266      * show the "favorite" form
 267      *
 268      * @return void
 269      */
 270
 271     function showFaveForm()
 272     {
 273         $user = common_current_user();
 274         if ($user) {
 275             if ($user->hasFave($this->notice)) {
 276                 $disfavor = new DisfavorForm($this->out, $this->notice);
 277                 $disfavor->show();
 278             } else {
 279                 $favor = new FavorForm($this->out, $this->notice);
 280                 $favor->show();
 281             }
 282         }
 283     }
 284
 285     /**
 286      * show the author of a notice
 287      *
 288      * By default, this shows the avatar and (linked) nickname of the author.
 289      *
 290      * @return void
 291      */
 292
 293     function showAuthor()
 294     {
 295         $this->out->elementStart('span', 'vcard author');
 296         $attrs = array('href' => $this->profile->profileurl,
 297                        'class' => 'url');
 298         if (!empty($this->profile->fullname)) {
 299             $attrs['title'] = $this->profile->fullname . ' (' . $this->profile->nickname . ')';
 300         }
 301         $this->out->elementStart('a', $attrs);
 302         $this->showAvatar();
 303         $this->out->text(' ');
 304         $this->showNickname();
 305         $this->out->elementEnd('a');
 306         $this->out->elementEnd('span');
 307     }
 308
 309     /**
 310      * show the avatar of the notice's author
 311      *
 312      * This will use the default avatar if no avatar is assigned for the author.
 313      * It makes a link to the author's profile.
 314      *
 315      * @return void
 316      */
 317
 318     function showAvatar()
 319     {
 320         if ('shownotice' === $this->out->trimmed('action')) {
 321             $avatar_size = AVATAR_PROFILE_SIZE;
 322         } else {
 323             $avatar_size = AVATAR_STREAM_SIZE;
 324         }
 325         $avatar = $this->profile->getAvatar($avatar_size);
 326
 327         $this->out->element('img', array('src' => ($avatar) ?
 328                                          $avatar->displayUrl() :
 329                                          Avatar::defaultImage($avatar_size),
 330                                          'class' => 'avatar photo',
 331                                          'width' => $avatar_size,
 332                                          'height' => $avatar_size,
 333                                          'alt' =>
 334                                          ($this->profile->fullname) ?
 335                                          $this->profile->fullname :
 336                                          $this->profile->nickname));
 337     }
 338
 339     /**
 340      * show the nickname of the author
 341      *
 342      * Links to the author's profile page
 343      *
 344      * @return void
 345      */
 346
 347     function showNickname()
 348     {
 349         $this->out->raw('<span class="nickname fn">' .
 350                         htmlspecialchars($this->profile->nickname) .
 351                         '</span>');
 352     }
 353
 354     /**
 355      * show the content of the notice
 356      *
 357      * Shows the content of the notice. This is pre-rendered for efficiency
 358      * at save time. Some very old notices might not be pre-rendered, so
 359      * they're rendered on the spot.
 360      *
 361      * @return void
 362      */
 363
 364     function showContent()
 365     {
 366         // FIXME: URL, image, video, audio
 367         $this->out->elementStart('p', array('class' => 'entry-content'));
 368         if ($this->notice->rendered) {
 369             $this->out->raw($this->notice->rendered);
 370         } else {
 371             // XXX: may be some uncooked notices in the DB,
 372             // we cook them right now. This should probably disappear in future
 373             // versions (>> 0.4.x)
 374             $this->out->raw(common_render_content($this->notice->content, $this->notice));
 375         }
 376         $this->out->elementEnd('p');
 377     }
 378
 379     /**
 380      * show the link to the main page for the notice
 381      *
 382      * Displays a link to the page for a notice, with "relative" time. Tries to
 383      * get remote notice URLs correct, but doesn't always succeed.
 384      *
 385      * @return void
 386      */
 387
 388     function showNoticeLink()
 389     {
 390         $noticeurl = $this->notice->bestUrl();
 391
 392         // above should always return an URL
 393
 394         assert(!empty($noticeurl));
 395
 396         $this->out->elementStart('a', array('rel' => 'bookmark',
 397                                             'class' => 'timestamp',
 398                                             'href' => $noticeurl));
 399         $dt = common_date_iso8601($this->notice->created);
 400         $this->out->element('abbr', array('class' => 'published',
 401                                           'title' => $dt),
 402                             common_date_string($this->notice->created));
 403         $this->out->elementEnd('a');
 404     }
 405
 406     /**
 407      * show the notice location
 408      *
 409      * shows the notice location in the correct language.
 410      *
 411      * If an URL is available, makes a link. Otherwise, just a span.
 412      *
 413      * @return void
 414      */
 415
 416     function showNoticeLocation()
 417     {
 418         $id = $this->notice->id;
 419
 420         $location = $this->notice->getLocation();
 421
 422         if (empty($location)) {
 423             return;
 424         }
 425
 426         $name = $location->getName();
 427
 428         $lat = $this->notice->lat;
 429         $lon = $this->notice->lon;
 430         $latlon = (!empty($lat) && !empty($lon)) ? $lat.';'.$lon : '';
 431
 432         if (empty($name)) {
 433             $latdms = $this->decimalDegreesToDMS(abs($lat));
 434             $londms = $this->decimalDegreesToDMS(abs($lon));
 435             // TRANS: Used in coordinates as abbreviation of north
 436             $north = _('N');
 437             // TRANS: Used in coordinates as abbreviation of south
 438             $south = _('S');
 439             // TRANS: Used in coordinates as abbreviation of east
 440             $east = _('E');
 441             // TRANS: Used in coordinates as abbreviation of west
 442             $west = _('W');
 443             $name = sprintf(
 444                 _('%1$u°%2$u\'%3$u"%4$s %5$u°%6$u\'%7$u"%8$s'),
 445                 $latdms['deg'],$latdms['min'], $latdms['sec'],($lat>0? $north:$south),
 446                 $londms['deg'],$londms['min'], $londms['sec'],($lon>0? $east:$west));
 447         }
 448
 449         $url  = $location->getUrl();
 450
 451         $this->out->text(' ');
 452         $this->out->elementStart('span', array('class' => 'location'));
 453         $this->out->text(_('at'));
 454         $this->out->text(' ');
 455         if (empty($url)) {
 456             $this->out->element('abbr', array('class' => 'geo',
 457                                               'title' => $latlon),
 458                                 $name);
 459         } else {
 460             $xstr = new XMLStringer(false);
 461             $xstr->elementStart('a', array('href' => $url,
 462                                            'rel' => 'external'));
 463             $xstr->element('abbr', array('class' => 'geo',
 464                                          'title' => $latlon),
 465                            $name);
 466             $xstr->elementEnd('a');
 467             $this->out->raw($xstr->getString());
 468         }
 469         $this->out->elementEnd('span');
 470     }
 471
 472     /**
 473      * @param number $dec decimal degrees
 474      * @return array split into 'deg', 'min', and 'sec'
 475      */
 476     function decimalDegreesToDMS($dec)
 477     {
 478         $deg = intval($dec);
 479         $tempma = abs($dec) - abs($deg);
 480
 481         $tempma = $tempma * 3600;
 482         $min = floor($tempma / 60);
 483         $sec = $tempma - ($min*60);
 484
 485         return array("deg"=>$deg,"min"=>$min,"sec"=>$sec);
 486     }
 487
 488     /**
 489      * Show the source of the notice
 490      *
 491      * Either the name (and link) of the API client that posted the notice,
 492      * or one of other other channels.
 493      *
 494      * @return void
 495      */
 496
 497     function showNoticeSource()
 498     {
 499         $ns = $this->notice->getSource();
 500
 501         if ($ns) {
 502             $source_name = (empty($ns->name)) ? ($ns->code ? _($ns->code) : _('web')) : _($ns->name);
 503             $this->out->text(' ');
 504             $this->out->elementStart('span', 'source');
 505             // FIXME: probably i18n issue. If "from" is followed by text, that should be a parameter to "from" (from %s).
 506             $this->out->text(_('from'));
 507             $this->out->text(' ');
 508
 509             $name  = $source_name;
 510             $url   = $ns->url;
 511             $title = null;
 512
 513             if (Event::handle('StartNoticeSourceLink', array($this->notice, &$name, &$url, &$title))) {
 514                 $name = $source_name;
 515                 $url  = $ns->url;
 516             }
 517             Event::handle('EndNoticeSourceLink', array($this->notice, &$name, &$url, &$title));
 518
 519             // if $ns->name and $ns->url are populated we have
 520             // configured a source attr somewhere
 521             if (!empty($name) && !empty($url)) {
 522
 523                 $this->out->elementStart('span', 'device');
 524
 525                 $attrs = array(
 526                     'href' => $url,
 527                     'rel' => 'external'
 528                 );
 529
 530                 if (!empty($title)) {
 531                     $attrs['title'] = $title;
 532                 }
 533
 534                 $this->out->element('a', $attrs, $name);
 535                 $this->out->elementEnd('span');
 536             } else {
 537                 $this->out->element('span', 'device', $name);
 538             }
 539
 540             $this->out->elementEnd('span');
 541         }
 542     }
 543
 544     /**
 545      * show link to notice this notice is a reply to
 546      *
 547      * If this notice is a reply, show a link to the notice it is replying to. The
 548      * heavy lifting for figuring out replies happens at save time.
 549      *
 550      * @return void
 551      */
 552
 553     function showContext()
 554     {
 555         if ($this->notice->hasConversation()) {
 556             $conv = Conversation::staticGet(
 557                 'id',
 558                 $this->notice->conversation
 559             );
 560             $convurl = $conv->uri;
 561             if (!empty($convurl)) {
 562                 $this->out->text(' ');
 563                 $this->out->element(
 564                     'a',
 565                     array(
 566                     'href' => $convurl.'#notice-'.$this->notice->id,
 567                     'class' => 'response'),
 568                     _('in context')
 569                 );
 570             } else {
 571                 $msg = sprintf(
 572                     "Couldn't find Conversation ID %d to make 'in context'"
 573                     . "link for Notice ID %d",
 574                     $this->notice->conversation,
 575                     $this->notice->id
 576                 );
 577                 common_log(LOG_WARNING, $msg);
 578             }
 579         }
 580     }
 581
 582     /**
 583      * show a link to the author of repeat
 584      *
 585      * @return void
 586      */
 587
 588     function showRepeat()
 589     {
 590         if (!empty($this->repeat)) {
 591
 592             $repeater = Profile::staticGet('id', $this->repeat->profile_id);
 593
 594             $attrs = array('href' => $repeater->profileurl,
 595                            'class' => 'url');
 596
 597             if (!empty($repeater->fullname)) {
 598                 $attrs['title'] = $repeater->fullname . ' (' . $repeater->nickname . ')';
 599             }
 600
 601             $this->out->elementStart('span', 'repeat vcard');
 602
 603             $this->out->raw(_('Repeated by'));
 604
 605             $this->out->elementStart('a', $attrs);
 606             $this->out->element('span', 'fn nickname', $repeater->nickname);
 607             $this->out->elementEnd('a');
 608
 609             $this->out->elementEnd('span');
 610         }
 611     }
 612
 613     /**
 614      * show a link to reply to the current notice
 615      *
 616      * Should either do the reply in the current notice form (if available), or
 617      * link out to the notice-posting form. A little flakey, doesn't always work.
 618      *
 619      * @return void
 620      */
 621
 622     function showReplyLink()
 623     {
 624         if (common_logged_in()) {
 625             $this->out->text(' ');
 626             $reply_url = common_local_url('newnotice',
 627                                           array('replyto' => $this->profile->nickname, 'inreplyto' => $this->notice->id));
 628             $this->out->elementStart('a', array('href' => $reply_url,
 629                                                 'class' => 'notice_reply',
 630                                                 'title' => _('Reply to this notice')));
 631             $this->out->text(_('Reply'));
 632             $this->out->text(' ');
 633             $this->out->element('span', 'notice_id', $this->notice->id);
 634             $this->out->elementEnd('a');
 635         }
 636     }
 637
 638     /**
 639      * if the user is the author, let them delete the notice
 640      *
 641      * @return void
 642      */
 643
 644     function showDeleteLink()
 645     {
 646         $user = common_current_user();
 647
 648         $todel = (empty($this->repeat)) ? $this->notice : $this->repeat;
 649
 650         if (!empty($user) &&
 651             ($todel->profile_id == $user->id || $user->hasRight(Right::DELETEOTHERSNOTICE))) {
 652             $this->out->text(' ');
 653             $deleteurl = common_local_url('deletenotice',
 654                                           array('notice' => $todel->id));
 655             $this->out->element('a', array('href' => $deleteurl,
 656                                            'class' => 'notice_delete',
 657                                            'title' => _('Delete this notice')), _('Delete'));
 658         }
 659     }
 660
 661     /**
 662      * show the form to repeat a notice
 663      *
 664      * @return void
 665      */
 666
 667     function showRepeatForm()
 668     {
 669         $user = common_current_user();
 670         if ($user && $user->id != $this->notice->profile_id) {
 671             $this->out->text(' ');
 672             $profile = $user->getProfile();
 673             if ($profile->hasRepeated($this->notice->id)) {
 674                 $this->out->element('span', array('class' => 'repeated',
 675                                                   'title' => _('Notice repeated')),
 676                                             _('Repeated'));
 677             } else {
 678                 $rf = new RepeatForm($this->out, $this->notice);
 679                 $rf->show();
 680             }
 681         }
 682     }
 683
 684     /**
 685      * finish the notice
 686      *
 687      * Close the last elements in the notice list item
 688      *
 689      * @return void
 690      */
 691
 692     function showEnd()
 693     {
 694         $this->out->elementEnd('li');
 695     }
 696 }