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  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  27  * @link      http://status.net/
  28  */
  29
  30 if (!defined('STATUSNET') && !defined('LACONICA')) {
  31     exit(1);
  32 }
  33
  34 /**
  35  * Oembed provider implementation
  36  *
  37  * This class handles all /main/oembed(.xml|.json)/ requests.
  38  *
  39  * @category  oEmbed
  40  * @package   StatusNet
  41  * @author    Craig Andrews <candrews@integralblue.com>
  42  * @copyright 2008 StatusNet, Inc.
  43  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  44  * @link      http://status.net/
  45  */
  46
  47 class OembedAction extends Action
  48 {
  49
  50     function handle($args)
  51     {
  52         common_debug("in oembed api action");
  53
  54         $url = $args['url'];
  55         if( substr(strtolower($url),0,strlen(common_root_url())) == strtolower(common_root_url()) ){
  56             $path = substr($url,strlen(common_root_url()));
  57
  58             $r = Router::get();
  59
  60             $proxy_args = $r->map($path);
  61
  62             if (!$proxy_args) {
  63                 $this->serverError(_("$path not found."), 404);
  64             }
  65             $oembed=array();
  66             $oembed['version']='1.0';
  67             $oembed['provider_name']=common_config('site', 'name');
  68             $oembed['provider_url']=common_root_url();
  69             switch($proxy_args['action']){
  70                 case 'shownotice':
  71                     $oembed['type']='link';
  72                     $id = $proxy_args['notice'];
  73                     $notice = Notice::staticGet($id);
  74                     if(empty($notice)){
  75                         $this->serverError(_("Notice $id not found."), 404);
  76                     }
  77                     $profile = $notice->getProfile();
  78                     if (empty($profile)) {
  79                         $this->serverError(_('Notice has no profile.'), 500);
  80                     }
  81                     if (!empty($profile->fullname)) {
  82                         $authorname = $profile->fullname . ' (' . $profile->nickname . ')';
  83                     } else {
  84                         $authorname = $profile->nickname;
  85                     }
  86                     $oembed['title'] = sprintf(_('%1$s\'s status on %2$s'),
  87                         $authorname,
  88                         common_exact_date($notice->created));
  89                     $oembed['author_name']=$authorname;
  90                     $oembed['author_url']=$profile->profileurl;
  91                     $oembed['url']=($notice->url?$notice->url:$notice->uri);
  92                     $oembed['html']=$notice->rendered;
  93                     break;
  94                 case 'attachment':
  95                     $id = $proxy_args['attachment'];
  96                     $attachment = File::staticGet($id);
  97                     if(empty($attachment)){
  98                         $this->serverError(_("Attachment $id not found."), 404);
  99                     }
 100                     if(empty($attachment->filename) && $file_oembed = File_oembed::staticGet('file_id', $attachment->id)){
 101                         // Proxy the existing oembed information
 102                         $oembed['type']=$file_oembed->type;
 103                         $oembed['provider']=$file_oembed->provider;
 104                         $oembed['provider_url']=$file_oembed->provider_url;
 105                         $oembed['width']=$file_oembed->width;
 106                         $oembed['height']=$file_oembed->height;
 107                         $oembed['html']=$file_oembed->html;
 108                         $oembed['title']=$file_oembed->title;
 109                         $oembed['author_name']=$file_oembed->author_name;
 110                         $oembed['author_url']=$file_oembed->author_url;
 111                         $oembed['url']=$file_oembed->url;
 112                     }else if(substr($attachment->mimetype,0,strlen('image/'))=='image/'){
 113                         $oembed['type']='photo';
 114                         //TODO set width and height
 115                         //$oembed['width']=
 116                         //$oembed['height']=
 117                         $oembed['url']=$attachment->url;
 118                     }else{
 119                         $oembed['type']='link';
 120                         $oembed['url']=common_local_url('attachment',
 121                             array('attachment' => $attachment->id));
 122                     }
 123                     if($attachment->title) $oembed['title']=$attachment->title;
 124                     break;
 125                 default:
 126                     $this->serverError(_("$path not supported for oembed requests."), 501);
 127             }
 128             switch($args['format']){
 129                 case 'xml':
 130                     $this->init_document('xml');
 131                     $this->elementStart('oembed');
 132                     $this->element('version',null,$oembed['version']);
 133                     $this->element('type',null,$oembed['type']);
 134                     if($oembed['provider_name']) $this->element('provider_name',null,$oembed['provider_name']);
 135                     if($oembed['provider_url']) $this->element('provider_url',null,$oembed['provider_url']);
 136                     if($oembed['title']) $this->element('title',null,$oembed['title']);
 137                     if($oembed['author_name']) $this->element('author_name',null,$oembed['author_name']);
 138                     if($oembed['author_url']) $this->element('author_url',null,$oembed['author_url']);
 139                     if($oembed['url']) $this->element('url',null,$oembed['url']);
 140                     if($oembed['html']) $this->element('html',null,$oembed['html']);
 141                     if($oembed['width']) $this->element('width',null,$oembed['width']);
 142                     if($oembed['height']) $this->element('height',null,$oembed['height']);
 143                     if($oembed['cache_age']) $this->element('cache_age',null,$oembed['cache_age']);
 144                     if($oembed['thumbnail_url']) $this->element('thumbnail_url',null,$oembed['thumbnail_url']);
 145                     if($oembed['thumbnail_width']) $this->element('thumbnail_width',null,$oembed['thumbnail_width']);
 146                     if($oembed['thumbnail_height']) $this->element('thumbnail_height',null,$oembed['thumbnail_height']);
 147
 148                     $this->elementEnd('oembed');
 149                     $this->end_document('xml');
 150                     break;
 151                 case 'json': case '':
 152                     $this->init_document('json');
 153                     print(json_encode($oembed));
 154                     $this->end_document('json');
 155                     break;
 156                 default:
 157                     // TRANS: Error message displaying attachments. %s is a raw MIME type (eg 'image/png')
 158                     $this->serverError(sprintf(_('Content type %s not supported.'), $apidata['content-type']), 501);
 159             }
 160         }else{
 161             // TRANS: Error message displaying attachments. %s is the site's base URL.
 162             $this->serverError(sprintf(_('Only %s URLs over plain HTTP please.'), common_root_url()), 404);
 163         }
 164     }
 165
 166     function init_document($type)
 167     {
 168         switch ($type) {
 169         case 'xml':
 170             header('Content-Type: application/xml; charset=utf-8');
 171             $this->startXML();
 172             break;
 173         case 'json':
 174             header('Content-Type: application/json; charset=utf-8');
 175
 176             // Check for JSONP callback
 177             $callback = $this->arg('callback');
 178             if ($callback) {
 179                 print $callback . '(';
 180             }
 181             break;
 182         default:
 183             $this->serverError(_('Not a supported data format.'), 501);
 184             break;
 185         }
 186     }
 187
 188     function end_document($type='xml')
 189     {
 190         switch ($type) {
 191         case 'xml':
 192             $this->endXML();
 193             break;
 194         case 'json':
 195             // Check for JSONP callback
 196             $callback = $this->arg('callback');
 197             if ($callback) {
 198                 print ')';
 199             }
 200             break;
 201         default:
 202             $this->serverError(_('Not a supported data format.'), 501);
 203             break;
 204         }
 205         return;
 206     }
 207
 208 }