3 * StatusNet, the distributed open-source microblogging tool
5 * StatusNet-only extensions to the Twitter-like API
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.
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.
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/>.
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/
31 if (!defined('STATUSNET') && !defined('LACONICA')) {
36 * Oembed provider implementation
38 * This class handles all /main/oembed(.xml|.json)/ requests.
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/
48 class OembedAction extends Action
51 function handle($args)
53 common_debug("in oembed api action");
56 if( substr(strtolower($url),0,strlen(common_root_url())) == strtolower(common_root_url()) ){
57 $path = substr($url,strlen(common_root_url()));
61 $proxy_args = $r->map($path);
64 $this->serverError(sprintf(_('"%s" not found.'),$path), 404);
67 $oembed['version']='1.0';
68 $oembed['provider_name']=common_config('site', 'name');
69 $oembed['provider_url']=common_root_url();
70 switch($proxy_args['action']){
72 $oembed['type']='link';
73 $id = $proxy_args['notice'];
74 $notice = Notice::staticGet($id);
76 $this->serverError(sprintf(_("Notice %s not found."),$id), 404);
78 $profile = $notice->getProfile();
79 if (empty($profile)) {
80 $this->serverError(_('Notice has no profile.'), 500);
82 $authorname = $profile->getFancyName();
83 $oembed['title'] = sprintf(_('%1$s\'s status on %2$s'),
85 common_exact_date($notice->created));
86 $oembed['author_name']=$authorname;
87 $oembed['author_url']=$profile->profileurl;
88 $oembed['url']=($notice->url?$notice->url:$notice->uri);
89 $oembed['html']=$notice->rendered;
92 $id = $proxy_args['attachment'];
93 $attachment = File::staticGet($id);
94 if(empty($attachment)){
95 $this->serverError(sprintf(_('Attachment %s not found.'),$id), 404);
97 if(empty($attachment->filename) && $file_oembed = File_oembed::staticGet('file_id', $attachment->id)){
98 // Proxy the existing oembed information
99 $oembed['type']=$file_oembed->type;
100 $oembed['provider']=$file_oembed->provider;
101 $oembed['provider_url']=$file_oembed->provider_url;
102 $oembed['width']=$file_oembed->width;
103 $oembed['height']=$file_oembed->height;
104 $oembed['html']=$file_oembed->html;
105 $oembed['title']=$file_oembed->title;
106 $oembed['author_name']=$file_oembed->author_name;
107 $oembed['author_url']=$file_oembed->author_url;
108 $oembed['url']=$file_oembed->url;
109 }else if(substr($attachment->mimetype,0,strlen('image/'))=='image/'){
110 $oembed['type']='photo';
111 if ($attachment->filename) {
112 $filepath = File::path($attachment->filename);
113 $gis = @getimagesize($filepath);
115 $oembed['width'] = $gis[0];
116 $oembed['height'] = $gis[1];
118 // TODO Either throw an error or find a fallback?
121 $oembed['url']=$attachment->url;
122 $thumb = $attachment->getThumbnail();
124 $oembed['thumbnail_url'] = $thumb->url;
125 $oembed['thumbnail_width'] = $thumb->width;
126 $oembed['thumbnail_height'] = $thumb->height;
129 $oembed['type']='link';
130 $oembed['url']=common_local_url('attachment',
131 array('attachment' => $attachment->id));
133 if($attachment->title) $oembed['title']=$attachment->title;
136 $this->serverError(sprintf(_('"%s" not supported for oembed requests.'),$path), 501);
138 switch($args['format']){
140 $this->init_document('xml');
141 $this->elementStart('oembed');
142 $this->element('version',null,$oembed['version']);
143 $this->element('type',null,$oembed['type']);
144 if($oembed['provider_name']) $this->element('provider_name',null,$oembed['provider_name']);
145 if($oembed['provider_url']) $this->element('provider_url',null,$oembed['provider_url']);
146 if($oembed['title']) $this->element('title',null,$oembed['title']);
147 if($oembed['author_name']) $this->element('author_name',null,$oembed['author_name']);
148 if($oembed['author_url']) $this->element('author_url',null,$oembed['author_url']);
149 if($oembed['url']) $this->element('url',null,$oembed['url']);
150 if($oembed['html']) $this->element('html',null,$oembed['html']);
151 if($oembed['width']) $this->element('width',null,$oembed['width']);
152 if($oembed['height']) $this->element('height',null,$oembed['height']);
153 if($oembed['cache_age']) $this->element('cache_age',null,$oembed['cache_age']);
154 if($oembed['thumbnail_url']) $this->element('thumbnail_url',null,$oembed['thumbnail_url']);
155 if($oembed['thumbnail_width']) $this->element('thumbnail_width',null,$oembed['thumbnail_width']);
156 if($oembed['thumbnail_height']) $this->element('thumbnail_height',null,$oembed['thumbnail_height']);
158 $this->elementEnd('oembed');
159 $this->end_document('xml');
161 case 'json': case '':
162 $this->init_document('json');
163 print(json_encode($oembed));
164 $this->end_document('json');
167 // TRANS: Error message displaying attachments. %s is a raw MIME type (eg 'image/png')
168 $this->serverError(sprintf(_('Content type %s not supported.'), $apidata['content-type']), 501);
171 // TRANS: Error message displaying attachments. %s is the site's base URL.
172 $this->serverError(sprintf(_('Only %s URLs over plain HTTP please.'), common_root_url()), 404);
176 function init_document($type)
180 header('Content-Type: application/xml; charset=utf-8');
184 header('Content-Type: application/json; charset=utf-8');
186 // Check for JSONP callback
187 $callback = $this->arg('callback');
189 print $callback . '(';
193 $this->serverError(_('Not a supported data format.'), 501);
198 function end_document($type='xml')
205 // Check for JSONP callback
206 $callback = $this->arg('callback');
212 $this->serverError(_('Not a supported data format.'), 501);
219 * Is this action read-only?
221 * @param array $args other arguments
223 * @return boolean is read only action?
225 function isReadOnly($args)