lib/attachmentlist.php

   1 <?php
   2 /**
   3  * Laconica, the distributed open-source microblogging tool
   4  *
   5  * widget for displaying a list of notice attachments
   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   Laconica
  24  * @author    Evan Prodromou <evan@controlyourself.ca>
  25  * @author    Sarven Capadisli <csarven@controlyourself.ca>
  26  * @copyright 2008 Control Yourself, Inc.
  27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  28  * @link      http://laconi.ca/
  29  */
  30
  31 if (!defined('LACONICA')) {
  32     exit(1);
  33 }
  34
  35 /**
  36  * widget for displaying a list of notice attachments
  37  *
  38  * There are a number of actions that display a list of notices, in
  39  * reverse chronological order. This widget abstracts out most of the
  40  * code for UI for notice lists. It's overridden to hide some
  41  * data for e.g. the profile page.
  42  *
  43  * @category UI
  44  * @package  Laconica
  45  * @author   Evan Prodromou <evan@controlyourself.ca>
  46  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  47  * @link     http://laconi.ca/
  48  * @see      Notice
  49  * @see      StreamAction
  50  * @see      NoticeListItem
  51  * @see      ProfileNoticeList
  52  */
  53
  54 class AttachmentList extends Widget
  55 {
  56     /** the current stream of notices being displayed. */
  57
  58     var $notice = null;
  59
  60     /**
  61      * constructor
  62      *
  63      * @param Notice $notice stream of notices from DB_DataObject
  64      */
  65
  66     function __construct($notice, $out=null)
  67     {
  68         parent::__construct($out);
  69         $this->notice = $notice;
  70     }
  71
  72     /**
  73      * show the list of notices
  74      *
  75      * "Uses up" the stream by looping through it. So, probably can't
  76      * be called twice on the same list.
  77      *
  78      * @return int count of notices listed.
  79      */
  80
  81     function show()
  82     {
  83         $atts = new File;
  84         $att = $atts->getAttachments($this->notice->id);
  85         if (empty($att)) return 0;
  86         $this->out->elementStart('dl', array('id' =>'attachments'));
  87         $this->out->element('dt', null, _('Attachments'));
  88         $this->out->elementStart('dd');
  89         $this->out->elementStart('ol', array('class' => 'attachments'));
  90
  91         foreach ($att as $n=>$attachment) {
  92             $item = $this->newListItem($attachment);
  93             $item->show();
  94         }
  95
  96         $this->out->elementEnd('dd');
  97         $this->out->elementEnd('ol');
  98         $this->out->elementEnd('dl');
  99
 100         return count($att);
 101     }
 102
 103     /**
 104      * returns a new list item for the current notice
 105      *
 106      * Recipe (factory?) method; overridden by sub-classes to give
 107      * a different list item class.
 108      *
 109      * @param Notice $notice the current notice
 110      *
 111      * @return NoticeListItem a list item for displaying the notice
 112      */
 113
 114     function newListItem($attachment)
 115     {
 116         return new AttachmentListItem($attachment, $this->out);
 117     }
 118 }
 119
 120 /**
 121  * widget for displaying a single notice
 122  *
 123  * This widget has the core smarts for showing a single notice: what to display,
 124  * where, and under which circumstances. Its key method is show(); this is a recipe
 125  * that calls all the other show*() methods to build up a single notice. The
 126  * ProfileNoticeListItem subclass, for example, overrides showAuthor() to skip
 127  * author info (since that's implicit by the data in the page).
 128  *
 129  * @category UI
 130  * @package  Laconica
 131  * @author   Evan Prodromou <evan@controlyourself.ca>
 132  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
 133  * @link     http://laconi.ca/
 134  * @see      NoticeList
 135  * @see      ProfileNoticeListItem
 136  */
 137
 138 class AttachmentListItem extends Widget
 139 {
 140     /** The attachment this item will show. */
 141
 142     var $attachment = null;
 143
 144     var $oembed = null;
 145
 146     /**
 147      * constructor
 148      *
 149      * Also initializes the profile attribute.
 150      *
 151      * @param Notice $notice The notice we'll display
 152      */
 153
 154     function __construct($attachment, $out=null)
 155     {
 156         parent::__construct($out);
 157         $this->attachment  = $attachment;
 158         $this->oembed = File_oembed::staticGet('file_id', $this->attachment->id);
 159     }
 160
 161     function title() {
 162         if (empty($this->attachment->title)) {
 163             if (empty($this->oembed->title)) {
 164                 $title = $this->attachment->url;
 165             } else {
 166                 $title = $this->oembed->title;
 167             }
 168         } else {
 169             $title = $this->attachment->title;
 170         }
 171
 172         return $title;
 173     }
 174
 175     function linkTitle() {
 176         return $this->title();
 177     }
 178
 179     /**
 180      * recipe function for displaying a single notice.
 181      *
 182      * This uses all the other methods to correctly display a notice. Override
 183      * it or one of the others to fine-tune the output.
 184      *
 185      * @return void
 186      */
 187
 188     function show()
 189     {
 190         $this->showStart();
 191         $this->showNoticeAttachment();
 192         $this->showEnd();
 193     }
 194
 195     function linkAttr() {
 196         return array('class' => 'attachment', 'href' => $this->attachment->url, 'id' => 'attachment-' . $this->attachment->id);
 197     }
 198
 199     function showLink() {
 200         $this->out->elementStart('a', $this->linkAttr());
 201         $this->out->element('span', null, $this->linkTitle());
 202         $this->showRepresentation();
 203         $this->out->elementEnd('a');
 204     }
 205
 206     function showNoticeAttachment()
 207     {
 208         $this->showLink();
 209     }
 210
 211     function showRepresentation() {
 212         $thumbnail = File_thumbnail::staticGet('file_id', $this->attachment->id);
 213         if (!empty($thumbnail)) {
 214             $this->out->element('img', array('alt' => 'nothing to say', 'src' => $thumbnail->url, 'width' => $thumbnail->width, 'height' => $thumbnail->height));
 215         }
 216     }
 217
 218     /**
 219      * start a single notice.
 220      *
 221      * @return void
 222      */
 223
 224     function showStart()
 225     {
 226         // XXX: RDFa
 227         // TODO: add notice_type class e.g., notice_video, notice_image
 228         $this->out->elementStart('li');
 229     }
 230
 231     /**
 232      * finish the notice
 233      *
 234      * Close the last elements in the notice list item
 235      *
 236      * @return void
 237      */
 238
 239     function showEnd()
 240     {
 241         $this->out->elementEnd('li');
 242     }
 243 }
 244
 245 class Attachment extends AttachmentListItem
 246 {
 247     function show() {
 248         $this->showNoticeAttachment();
 249     }
 250
 251     function linkAttr() {
 252         return array('class' => 'external', 'href' => $this->attachment->url);
 253     }
 254
 255     function linkTitle() {
 256         return $this->attachment->url;
 257     }
 258
 259     function showRepresentation() {
 260         if (empty($this->oembed->type)) {
 261             if (empty($this->attachment->mimetype)) {
 262                 $this->out->element('pre', null, 'oh well... not sure how to handle the following: ' . print_r($this->attachment, true));
 263             } else {
 264                 switch ($this->attachment->mimetype) {
 265                 case 'image/gif':
 266                 case 'image/png':
 267                 case 'image/jpg':
 268                 case 'image/jpeg':
 269                     $this->out->element('img', array('src' => $this->attachment->url, 'alt' => 'alt'));
 270                     break;
 271                 }
 272             }
 273         } else {
 274             switch ($this->oembed->type) {
 275             case 'rich':
 276             case 'video':
 277             case 'link':
 278                 if (!empty($this->oembed->html)) {
 279                     $this->out->raw($this->oembed->html);
 280                 }
 281                 break;
 282
 283             case 'photo':
 284                 $this->out->element('img', array('src' => $this->oembed->url, 'width' => $this->oembed->width, 'height' => $this->oembed->height, 'alt' => 'alt'));
 285                 break;
 286
 287             default:
 288                 $this->out->element('pre', null, 'oh well... not sure how to handle the following oembed: ' . print_r($this->oembed, true));
 289             }
 290         }
 291     }
 292 }
 293