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 notice that was repeated. */
 151
 152     var $repeat = null;
 153
 154     /** The profile of the author of the notice, extracted once for convenience. */
 155
 156     var $profile = null;
 157
 158     /**
 159      * constructor
 160      *
 161      * Also initializes the profile attribute.
 162      *
 163      * @param Notice $notice The notice we'll display
 164      */
 165
 166     function __construct($notice, $out=null)
 167     {
 168         parent::__construct($out);
 169         if (!empty($notice->repeat_of)) {
 170             $original = Notice::staticGet('id', $notice->repeat_of);
 171             if (empty($original)) { // could have been deleted
 172                 $this->notice = $notice;
 173             } else {
 174                 $this->notice = $original;
 175                 $this->repeat = $notice;
 176             }
 177         } else {
 178             $this->notice  = $notice;
 179         }
 180         $this->profile = $this->notice->getProfile();
 181     }
 182
 183     /**
 184      * recipe function for displaying a single notice.
 185      *
 186      * This uses all the other methods to correctly display a notice. Override
 187      * it or one of the others to fine-tune the output.
 188      *
 189      * @return void
 190      */
 191
 192     function show()
 193     {
 194         $this->showStart();
 195         if (Event::handle('StartShowNoticeItem', array($this))) {
 196             $this->showNotice();
 197             $this->showNoticeInfo();
 198             $this->showNoticeOptions();
 199             Event::handle('EndShowNoticeItem', array($this));
 200         }
 201         $this->showEnd();
 202     }
 203
 204     function showNotice()
 205     {
 206         $this->out->elementStart('div', 'entry-title');
 207         $this->showAuthor();
 208         $this->showContent();
 209         $this->out->elementEnd('div');
 210     }
 211
 212     function showNoticeInfo()
 213     {
 214         $this->out->elementStart('div', 'entry-content');
 215         $this->showNoticeLink();
 216         $this->showNoticeSource();
 217         $this->showNoticeLocation();
 218         $this->showContext();
 219         $this->showRepeat();
 220         $this->out->elementEnd('div');
 221     }
 222
 223     function showNoticeOptions()
 224     {
 225         $user = common_current_user();
 226         if ($user) {
 227             $this->out->elementStart('div', 'notice-options');
 228             $this->showFaveForm();
 229             $this->showReplyLink();
 230             $this->showRepeatForm();
 231             $this->showDeleteLink();
 232             $this->out->elementEnd('div');
 233         }
 234     }
 235
 236     /**
 237      * start a single notice.
 238      *
 239      * @return void
 240      */
 241
 242     function showStart()
 243     {
 244         // XXX: RDFa
 245         // TODO: add notice_type class e.g., notice_video, notice_image
 246         $this->out->elementStart('li', array('class' => 'hentry notice',
 247                                              'id' => 'notice-' . $this->notice->id));
 248     }
 249
 250     /**
 251      * show the "favorite" form
 252      *
 253      * @return void
 254      */
 255
 256     function showFaveForm()
 257     {
 258         $user = common_current_user();
 259         if ($user) {
 260             if ($user->hasFave($this->notice)) {
 261                 $disfavor = new DisfavorForm($this->out, $this->notice);
 262                 $disfavor->show();
 263             } else {
 264                 $favor = new FavorForm($this->out, $this->notice);
 265                 $favor->show();
 266             }
 267         }
 268     }
 269
 270     /**
 271      * show the author of a notice
 272      *
 273      * By default, this shows the avatar and (linked) nickname of the author.
 274      *
 275      * @return void
 276      */
 277
 278     function showAuthor()
 279     {
 280         $this->out->elementStart('span', 'vcard author');
 281         $attrs = array('href' => $this->profile->profileurl,
 282                        'class' => 'url');
 283         if (!empty($this->profile->fullname)) {
 284             $attrs['title'] = $this->profile->fullname . ' (' . $this->profile->nickname . ')';
 285         }
 286         $this->out->elementStart('a', $attrs);
 287         $this->showAvatar();
 288         $this->showNickname();
 289         $this->out->elementEnd('a');
 290         $this->out->elementEnd('span');
 291     }
 292
 293     /**
 294      * show the avatar of the notice's author
 295      *
 296      * This will use the default avatar if no avatar is assigned for the author.
 297      * It makes a link to the author's profile.
 298      *
 299      * @return void
 300      */
 301
 302     function showAvatar()
 303     {
 304         if ('shownotice' === $this->out->trimmed('action')) {
 305             $avatar_size = AVATAR_PROFILE_SIZE;
 306         } else {
 307             $avatar_size = AVATAR_STREAM_SIZE;
 308         }
 309         $avatar = $this->profile->getAvatar($avatar_size);
 310
 311         $this->out->element('img', array('src' => ($avatar) ?
 312                                          $avatar->displayUrl() :
 313                                          Avatar::defaultImage($avatar_size),
 314                                          'class' => 'avatar photo',
 315                                          'width' => $avatar_size,
 316                                          'height' => $avatar_size,
 317                                          'alt' =>
 318                                          ($this->profile->fullname) ?
 319                                          $this->profile->fullname :
 320                                          $this->profile->nickname));
 321     }
 322
 323     /**
 324      * show the nickname of the author
 325      *
 326      * Links to the author's profile page
 327      *
 328      * @return void
 329      */
 330
 331     function showNickname()
 332     {
 333         $this->out->element('span', array('class' => 'nickname fn'),
 334                             $this->profile->nickname);
 335     }
 336
 337     /**
 338      * show the content of the notice
 339      *
 340      * Shows the content of the notice. This is pre-rendered for efficiency
 341      * at save time. Some very old notices might not be pre-rendered, so
 342      * they're rendered on the spot.
 343      *
 344      * @return void
 345      */
 346
 347     function showContent()
 348     {
 349         // FIXME: URL, image, video, audio
 350         $this->out->elementStart('p', array('class' => 'entry-content'));
 351         if ($this->notice->rendered) {
 352             $this->out->raw($this->notice->rendered);
 353         } else {
 354             // XXX: may be some uncooked notices in the DB,
 355             // we cook them right now. This should probably disappear in future
 356             // versions (>> 0.4.x)
 357             $this->out->raw(common_render_content($this->notice->content, $this->notice));
 358         }
 359         $this->out->elementEnd('p');
 360     }
 361
 362     /**
 363      * show the link to the main page for the notice
 364      *
 365      * Displays a link to the page for a notice, with "relative" time. Tries to
 366      * get remote notice URLs correct, but doesn't always succeed.
 367      *
 368      * @return void
 369      */
 370
 371     function showNoticeLink()
 372     {
 373         if($this->notice->is_local){
 374             $noticeurl = common_local_url('shownotice',
 375                                       array('notice' => $this->notice->id));
 376         }else{
 377             $noticeurl = $this->notice->uri;
 378         }
 379         $this->out->elementStart('a', array('rel' => 'bookmark',
 380                                             'class' => 'timestamp',
 381                                             'href' => $noticeurl));
 382         $dt = common_date_iso8601($this->notice->created);
 383         $this->out->element('abbr', array('class' => 'published',
 384                                           'title' => $dt),
 385                             common_date_string($this->notice->created));
 386         $this->out->elementEnd('a');
 387     }
 388
 389     /**
 390      * show the notice location
 391      *
 392      * shows the notice location in the correct language.
 393      *
 394      * If an URL is available, makes a link. Otherwise, just a span.
 395      *
 396      * @return void
 397      */
 398
 399     function showNoticeLocation()
 400     {
 401         $id = $this->notice->id;
 402
 403         $location = $this->notice->getLocation();
 404
 405         if (empty($location)) {
 406             return;
 407         }
 408
 409         $name = $location->getName();
 410
 411         $lat = $this->notice->lat;
 412         $lon = $this->notice->lon;
 413         $latlon = (!empty($lat) && !empty($lon)) ? $lat.';'.$lon : '';
 414
 415         if (empty($name)) {
 416             $latdms = $this->decimalDegreesToDMS(abs($lat));
 417             $londms = $this->decimalDegreesToDMS(abs($lon));
 418             $name = sprintf(
 419                 _('%1$u°%2$u\'%3$u"%4$s %5$u°%6$u\'%7$u"%8$s'),
 420                 $latdms['deg'],$latdms['min'], $latdms['sec'],($lat>0?_('N'):_('S')),
 421                 $londms['deg'],$londms['min'], $londms['sec'],($lon>0?_('E'):_('W')));
 422         }
 423
 424         $url  = $location->getUrl();
 425
 426         $this->out->elementStart('span', array('class' => 'location'));
 427         $this->out->text(_('at'));
 428         if (empty($url)) {
 429             $this->out->element('span', array('class' => 'geo',
 430                                               'title' => $latlon),
 431                                 $name);
 432         } else {
 433             $this->out->element('a', array('class' => 'geo',
 434                                            'title' => $latlon,
 435                                            'href' => $url),
 436                                 $name);
 437         }
 438         $this->out->elementEnd('span');
 439     }
 440
 441     function decimalDegreesToDMS($dec)
 442     {
 443
 444         $vars = explode(".",$dec);
 445         $deg = $vars[0];
 446         $tempma = "0.".$vars[1];
 447
 448         $tempma = $tempma * 3600;
 449         $min = floor($tempma / 60);
 450         $sec = $tempma - ($min*60);
 451
 452         return array("deg"=>$deg,"min"=>$min,"sec"=>$sec);
 453     }
 454
 455     /**
 456      * Show the source of the notice
 457      *
 458      * Either the name (and link) of the API client that posted the notice,
 459      * or one of other other channels.
 460      *
 461      * @return void
 462      */
 463
 464     function showNoticeSource()
 465     {
 466         if ($this->notice->source) {
 467             $this->out->elementStart('span', 'source');
 468             $this->out->text(_('from'));
 469             $source_name = _($this->notice->source);
 470             switch ($this->notice->source) {
 471              case 'web':
 472              case 'xmpp':
 473              case 'mail':
 474              case 'omb':
 475              case 'system':
 476              case 'api':
 477                 $this->out->element('span', 'device', $source_name);
 478                 break;
 479              default:
 480                 $ns = Notice_source::staticGet($this->notice->source);
 481                 if ($ns) {
 482                     $this->out->elementStart('span', 'device');
 483                     $this->out->element('a', array('href' => $ns->url,
 484                                                    'rel' => 'external'),
 485                                         $ns->name);
 486                     $this->out->elementEnd('span');
 487                 } else {
 488                     $this->out->element('span', 'device', $source_name);
 489                 }
 490                 break;
 491             }
 492             $this->out->elementEnd('span');
 493         }
 494     }
 495
 496     /**
 497      * show link to notice this notice is a reply to
 498      *
 499      * If this notice is a reply, show a link to the notice it is replying to. The
 500      * heavy lifting for figuring out replies happens at save time.
 501      *
 502      * @return void
 503      */
 504
 505     function showContext()
 506     {
 507         $hasConversation = false;
 508         if( !empty($this->notice->conversation)
 509             && $this->notice->conversation != $this->notice->id){
 510             $hasConversation = true;
 511         }else{
 512             $conversation = Notice::conversationStream($this->notice->id, 1, 1);
 513             if($conversation->N > 0){
 514                 $hasConversation = true;
 515             }
 516         }
 517         if ($hasConversation){
 518             $convurl = common_local_url('conversation',
 519                                          array('id' => $this->notice->conversation));
 520             $this->out->element('a', array('href' => $convurl.'#notice-'.$this->notice->id,
 521                                            'class' => 'response'),
 522                                 _('in context'));
 523         }
 524     }
 525
 526     /**
 527      * show a link to the author of repeat
 528      *
 529      * @return void
 530      */
 531
 532     function showRepeat()
 533     {
 534         if (!empty($this->repeat)) {
 535
 536             $repeater = Profile::staticGet('id', $this->repeat->profile_id);
 537
 538             $attrs = array('href' => $repeater->profileurl,
 539                            'class' => 'url');
 540
 541             if (!empty($repeater->fullname)) {
 542                 $attrs['title'] = $repeater->fullname . ' (' . $repeater->nickname . ')';
 543             }
 544
 545             $this->out->elementStart('span', 'repeat vcard');
 546
 547             $this->out->raw(_('Repeated by'));
 548
 549             $avatar = $repeater->getAvatar(AVATAR_MINI_SIZE);
 550
 551             $this->out->elementStart('a', $attrs);
 552
 553             $this->out->element('img', array('src' => ($avatar) ?
 554                                              $avatar->displayUrl() :
 555                                              Avatar::defaultImage(AVATAR_MINI_SIZE),
 556                                              'class' => 'avatar photo',
 557                                              'width' => AVATAR_MINI_SIZE,
 558                                              'height' => AVATAR_MINI_SIZE,
 559                                              'alt' =>
 560                                              ($repeater->fullname) ?
 561                                              $repeater->fullname :
 562                                              $repeater->nickname));
 563
 564             $this->out->element('span', 'nickname', $repeater->nickname);
 565             $this->out->elementEnd('a');
 566
 567             $this->out->elementEnd('span');
 568         }
 569     }
 570
 571     /**
 572      * show a link to reply to the current notice
 573      *
 574      * Should either do the reply in the current notice form (if available), or
 575      * link out to the notice-posting form. A little flakey, doesn't always work.
 576      *
 577      * @return void
 578      */
 579
 580     function showReplyLink()
 581     {
 582         if (common_logged_in()) {
 583             $reply_url = common_local_url('newnotice',
 584                                           array('replyto' => $this->profile->nickname, 'inreplyto' => $this->notice->id));
 585             $this->out->elementStart('a', array('href' => $reply_url,
 586                                                 'class' => 'notice_reply',
 587                                                 'title' => _('Reply to this notice')));
 588             $this->out->text(_('Reply'));
 589             $this->out->element('span', 'notice_id', $this->notice->id);
 590             $this->out->elementEnd('a');
 591         }
 592     }
 593
 594     /**
 595      * if the user is the author, let them delete the notice
 596      *
 597      * @return void
 598      */
 599
 600     function showDeleteLink()
 601     {
 602         $user = common_current_user();
 603
 604         $todel = (empty($this->repeat)) ? $this->notice : $this->repeat;
 605
 606         if (!empty($user) &&
 607             ($todel->profile_id == $user->id || $user->hasRight(Right::DELETEOTHERSNOTICE))) {
 608
 609             $deleteurl = common_local_url('deletenotice',
 610                                           array('notice' => $todel->id));
 611             $this->out->element('a', array('href' => $deleteurl,
 612                                            'class' => 'notice_delete',
 613                                            'title' => _('Delete this notice')), _('Delete'));
 614         }
 615     }
 616
 617     /**
 618      * show the form to repeat a notice
 619      *
 620      * @return void
 621      */
 622
 623     function showRepeatForm()
 624     {
 625         $user = common_current_user();
 626         if ($user && $user->id != $this->notice->profile_id) {
 627             $profile = $user->getProfile();
 628             if ($profile->hasRepeated($this->notice->id)) {
 629                 $this->out->text(_('Repeated'));
 630             } else {
 631                 $rf = new RepeatForm($this->out, $this->notice);
 632                 $rf->show();
 633             }
 634         }
 635     }
 636
 637     /**
 638      * finish the notice
 639      *
 640      * Close the last elements in the notice list item
 641      *
 642      * @return void
 643      */
 644
 645     function showEnd()
 646     {
 647         $this->out->elementEnd('li');
 648     }
 649 }