actions/oembed.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * StatusNet-only extensions to the Twitter-like API
   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  Twitter
  23  * @package   StatusNet
  24  * @author    Evan Prodromou <evan@status.net>
  25  * @copyright 2008 StatusNet, Inc.
  26  * @copyright 2009 Free Software Foundation, Inc http://www.fsf.org
  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 /**
  36  * Oembed provider implementation
  37  *
  38  * This class handles all /main/oembed(.xml|.json)/ requests.
  39  *
  40  * @category  oEmbed
  41  * @package   StatusNet
  42  * @author    Craig Andrews <candrews@integralblue.com>
  43  * @copyright 2008 StatusNet, Inc.
  44  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  45  * @link      http://status.net/
  46  */
  47
  48 class OembedAction extends Action
  49 {
  50
  51     function handle($args)
  52     {
  53         common_debug("in oembed api action");
  54
  55         $url = $args['url'];
  56         if( substr(strtolower($url),0,strlen(common_root_url())) == strtolower(common_root_url()) ){
  57             $path = substr($url,strlen(common_root_url()));
  58
  59             $r = Router::get();
  60
  61             $proxy_args = $r->map($path);
  62
  63             if (!$proxy_args) {
  64                 // TRANS: Server error displayed in oEmbed action when path not found.
  65                 // TRANS: %s is a path.
  66                 $this->serverError(sprintf(_('"%s" not found.'),$path), 404);
  67             }
  68             $oembed=array();
  69             $oembed['version']='1.0';
  70             $oembed['provider_name']=common_config('site', 'name');
  71             $oembed['provider_url']=common_root_url();
  72             switch($proxy_args['action']){
  73                 case 'shownotice':
  74                     $oembed['type']='link';
  75                     $id = $proxy_args['notice'];
  76                     $notice = Notice::getKV($id);
  77                     if(empty($notice)){
  78                         // TRANS: Server error displayed in oEmbed action when notice not found.
  79                         // TRANS: %s is a notice.
  80                         $this->serverError(sprintf(_("Notice %s not found."),$id), 404);
  81                     }
  82                     $profile = $notice->getProfile();
  83                     if (empty($profile)) {
  84                         // TRANS: Server error displayed in oEmbed action when notice has not profile.
  85                         $this->serverError(_('Notice has no profile.'), 500);
  86                     }
  87                     $authorname = $profile->getFancyName();
  88                     // TRANS: oEmbed title. %1$s is the author name, %2$s is the creation date.
  89                     $oembed['title'] = sprintf(_('%1$s\'s status on %2$s'),
  90                         $authorname,
  91                         common_exact_date($notice->created));
  92                     $oembed['author_name']=$authorname;
  93                     $oembed['author_url']=$profile->profileurl;
  94                     $oembed['url']=$notice->getUrl();
  95                     $oembed['html']=$notice->rendered;
  96                     break;
  97                 case 'attachment':
  98                     $id = $proxy_args['attachment'];
  99                     $attachment = File::getKV($id);
 100                     if(empty($attachment)){
 101                         // TRANS: Server error displayed in oEmbed action when attachment not found.
 102                         // TRANS: %d is an attachment ID.
 103                         $this->serverError(sprintf(_('Attachment %s not found.'),$id), 404);
 104                     }
 105                     if(empty($attachment->filename) && $file_oembed = File_oembed::getKV('file_id', $attachment->id)){
 106                         // Proxy the existing oembed information
 107                         $oembed['type']=$file_oembed->type;
 108                         $oembed['provider']=$file_oembed->provider;
 109                         $oembed['provider_url']=$file_oembed->provider_url;
 110                         $oembed['width']=$file_oembed->width;
 111                         $oembed['height']=$file_oembed->height;
 112                         $oembed['html']=$file_oembed->html;
 113                         $oembed['title']=$file_oembed->title;
 114                         $oembed['author_name']=$file_oembed->author_name;
 115                         $oembed['author_url']=$file_oembed->author_url;
 116                         $oembed['url']=$file_oembed->getUrl();
 117                     }else if(substr($attachment->mimetype,0,strlen('image/'))=='image/'){
 118                         $oembed['type']='photo';
 119                         if ($attachment->filename) {
 120                             $filepath = File::path($attachment->filename);
 121                             $gis = @getimagesize($filepath);
 122                             if ($gis) {
 123                                 $oembed['width'] = $gis[0];
 124                                 $oembed['height'] = $gis[1];
 125                             } else {
 126                                 // TODO Either throw an error or find a fallback?
 127                             }
 128                         }
 129                         $oembed['url']=$attachment->getUrl();
 130                         try {
 131                             $thumb = $attachment->getThumbnail();
 132                             $oembed['thumbnail_url'] = $thumb->getUrl();
 133                             $oembed['thumbnail_width'] = $thumb->width;
 134                             $oembed['thumbnail_height'] = $thumb->height;
 135                             unset($thumb);
 136                         } catch (UnsupportedMediaException $e) {
 137                             // No thumbnail data available
 138                         }
 139                     }else{
 140                         $oembed['type']='link';
 141                         $oembed['url']=common_local_url('attachment',
 142                             array('attachment' => $attachment->id));
 143                     }
 144                     if($attachment->title) $oembed['title']=$attachment->title;
 145                     break;
 146                 default:
 147                     // TRANS: Server error displayed in oEmbed request when a path is not supported.
 148                     // TRANS: %s is a path.
 149                     $this->serverError(sprintf(_('"%s" not supported for oembed requests.'),$path), 501);
 150             }
 151             switch($args['format']){
 152                 case 'xml':
 153                     $this->init_document('xml');
 154                     $this->elementStart('oembed');
 155                     $this->element('version',null,$oembed['version']);
 156                     $this->element('type',null,$oembed['type']);
 157                     if($oembed['provider_name']) $this->element('provider_name',null,$oembed['provider_name']);
 158                     if($oembed['provider_url']) $this->element('provider_url',null,$oembed['provider_url']);
 159                     if($oembed['title']) $this->element('title',null,$oembed['title']);
 160                     if($oembed['author_name']) $this->element('author_name',null,$oembed['author_name']);
 161                     if($oembed['author_url']) $this->element('author_url',null,$oembed['author_url']);
 162                     if($oembed['url']) $this->element('url',null,$oembed['url']);
 163                     if($oembed['html']) $this->element('html',null,$oembed['html']);
 164                     if($oembed['width']) $this->element('width',null,$oembed['width']);
 165                     if($oembed['height']) $this->element('height',null,$oembed['height']);
 166                     if($oembed['cache_age']) $this->element('cache_age',null,$oembed['cache_age']);
 167                     if($oembed['thumbnail_url']) $this->element('thumbnail_url',null,$oembed['thumbnail_url']);
 168                     if($oembed['thumbnail_width']) $this->element('thumbnail_width',null,$oembed['thumbnail_width']);
 169                     if($oembed['thumbnail_height']) $this->element('thumbnail_height',null,$oembed['thumbnail_height']);
 170
 171                     $this->elementEnd('oembed');
 172                     $this->end_document('xml');
 173                     break;
 174                 case 'json': case '':
 175                     $this->init_document('json');
 176                     print(json_encode($oembed));
 177                     $this->end_document('json');
 178                     break;
 179                 default:
 180                     // TRANS: Error message displaying attachments. %s is a raw MIME type (eg 'image/png')
 181                     $this->serverError(sprintf(_('Content type %s not supported.'), $apidata['content-type']), 501);
 182             }
 183         }else{
 184             // TRANS: Error message displaying attachments. %s is the site's base URL.
 185             $this->serverError(sprintf(_('Only %s URLs over plain HTTP please.'), common_root_url()), 404);
 186         }
 187     }
 188
 189     function init_document($type)
 190     {
 191         switch ($type) {
 192         case 'xml':
 193             header('Content-Type: application/xml; charset=utf-8');
 194             $this->startXML();
 195             break;
 196         case 'json':
 197             header('Content-Type: application/json; charset=utf-8');
 198
 199             // Check for JSONP callback
 200             $callback = $this->arg('callback');
 201             if ($callback) {
 202                 print $callback . '(';
 203             }
 204             break;
 205         default:
 206             // TRANS: Server error displayed in oEmbed action when request specifies an unsupported data format.
 207             $this->serverError(_('Not a supported data format.'), 501);
 208             break;
 209         }
 210     }
 211
 212     function end_document($type='xml')
 213     {
 214         switch ($type) {
 215         case 'xml':
 216             $this->endXML();
 217             break;
 218         case 'json':
 219             // Check for JSONP callback
 220             $callback = $this->arg('callback');
 221             if ($callback) {
 222                 print ')';
 223             }
 224             break;
 225         default:
 226             // TRANS: Server error displayed in oEmbed action when request specifies an unsupported data format.
 227             $this->serverError(_('Not a supported data format.'), 501);
 228             break;
 229         }
 230         return;
 231     }
 232
 233     /**
 234      * Is this action read-only?
 235      *
 236      * @param array $args other arguments
 237      *
 238      * @return boolean is read only action?
 239      */
 240     function isReadOnly($args)
 241     {
 242         return true;
 243     }
 244 }