We are no longer offering accounts on this server. Consider https://gitlab.freedesktop.org/ as a place to host projects.

oembed.php 10.6 KB
Newer Older
1 2
<?php
/**
3
 * StatusNet, the distributed open-source microblogging tool
4
 *
5
 * StatusNet-only extensions to the Twitter-like API
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
 *
 * PHP version 5
 *
 * LICENCE: This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * @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 33 34 35 36 37 38 39 40
    exit(1);
}

/**
 * Oembed provider implementation
 *
 * This class handles all /main/oembed(.xml|.json)/ requests.
 *
 * @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 54 55 56 57 58 59 60 61 62 63
    {
        common_debug("in oembed api action");

        $url = $args['url'];
        if( substr(strtolower($url),0,strlen(common_root_url())) == strtolower(common_root_url()) ){
            $path = substr($url,strlen(common_root_url()));

            $r = Router::get();

            $proxy_args = $r->map($path);

            if (!$proxy_args) {
64 65
                // TRANS: Server error displayed in oEmbed action when path not found.
                // TRANS: %s is a path.
66
                $this->serverError(sprintf(_('"%s" not found.'),$path), 404);
67 68 69 70 71 72 73 74 75 76 77
            }
            $oembed=array();
            $oembed['version']='1.0';
            $oembed['provider_name']=common_config('site', 'name');
            $oembed['provider_url']=common_root_url();
            switch($proxy_args['action']){
                case 'shownotice':
                    $oembed['type']='link';
                    $id = $proxy_args['notice'];
                    $notice = Notice::staticGet($id);
                    if(empty($notice)){
78 79
                        // TRANS: Server error displayed in oEmbed action when notice not found.
                        // TRANS: %s is a notice.
80
                        $this->serverError(sprintf(_("Notice %s not found."),$id), 404);
81 82 83
                    }
                    $profile = $notice->getProfile();
                    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 90 91 92 93 94 95 96 97 98 99 100
                    $oembed['title'] = sprintf(_('%1$s\'s status on %2$s'),
                        $authorname,
                        common_exact_date($notice->created));
                    $oembed['author_name']=$authorname;
                    $oembed['author_url']=$profile->profileurl;
                    $oembed['url']=($notice->url?$notice->url:$notice->uri);
                    $oembed['html']=$notice->rendered;
                    break;
                case 'attachment':
                    $id = $proxy_args['attachment'];
                    $attachment = File::staticGet($id);
                    if(empty($attachment)){
101 102
                        // TRANS: Server error displayed in oEmbed action when attachment not found.
                        // TRANS: %d is an attachment ID.
103
                        $this->serverError(sprintf(_('Attachment %s not found.'),$id), 404);
104 105 106 107 108 109 110 111 112 113 114 115 116 117 118
                    }
                    if(empty($attachment->filename) && $file_oembed = File_oembed::staticGet('file_id', $attachment->id)){
                        // Proxy the existing oembed information
                        $oembed['type']=$file_oembed->type;
                        $oembed['provider']=$file_oembed->provider;
                        $oembed['provider_url']=$file_oembed->provider_url;
                        $oembed['width']=$file_oembed->width;
                        $oembed['height']=$file_oembed->height;
                        $oembed['html']=$file_oembed->html;
                        $oembed['title']=$file_oembed->title;
                        $oembed['author_name']=$file_oembed->author_name;
                        $oembed['author_url']=$file_oembed->author_url;
                        $oembed['url']=$file_oembed->url;
                    }else if(substr($attachment->mimetype,0,strlen('image/'))=='image/'){
                        $oembed['type']='photo';
119 120 121 122 123 124 125 126 127 128
                        if ($attachment->filename) {
                            $filepath = File::path($attachment->filename);
                            $gis = @getimagesize($filepath);
                            if ($gis) {
                                $oembed['width'] = $gis[0];
                                $oembed['height'] = $gis[1];
                            } else {
                                // TODO Either throw an error or find a fallback?
                            }
                        }
129
                        $oembed['url']=$attachment->url;
130 131 132 133 134 135
                        $thumb = $attachment->getThumbnail();
                        if ($thumb) {
                            $oembed['thumbnail_url'] = $thumb->url;
                            $oembed['thumbnail_width'] = $thumb->width;
                            $oembed['thumbnail_height'] = $thumb->height;
                        }
136 137 138 139 140 141 142 143
                    }else{
                        $oembed['type']='link';
                        $oembed['url']=common_local_url('attachment',
                            array('attachment' => $attachment->id));
                    }
                    if($attachment->title) $oembed['title']=$attachment->title;
                    break;
                default:
144 145
                    // TRANS: Server error displayed in oEmbed request when a path is not supported.
                    // TRANS: %s is a path.
146
                    $this->serverError(sprintf(_('"%s" not supported for oembed requests.'),$path), 501);
147
            }
148
            switch($args['format']){
149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170
                case 'xml':
                    $this->init_document('xml');
                    $this->elementStart('oembed');
                    $this->element('version',null,$oembed['version']);
                    $this->element('type',null,$oembed['type']);
                    if($oembed['provider_name']) $this->element('provider_name',null,$oembed['provider_name']);
                    if($oembed['provider_url']) $this->element('provider_url',null,$oembed['provider_url']);
                    if($oembed['title']) $this->element('title',null,$oembed['title']);
                    if($oembed['author_name']) $this->element('author_name',null,$oembed['author_name']);
                    if($oembed['author_url']) $this->element('author_url',null,$oembed['author_url']);
                    if($oembed['url']) $this->element('url',null,$oembed['url']);
                    if($oembed['html']) $this->element('html',null,$oembed['html']);
                    if($oembed['width']) $this->element('width',null,$oembed['width']);
                    if($oembed['height']) $this->element('height',null,$oembed['height']);
                    if($oembed['cache_age']) $this->element('cache_age',null,$oembed['cache_age']);
                    if($oembed['thumbnail_url']) $this->element('thumbnail_url',null,$oembed['thumbnail_url']);
                    if($oembed['thumbnail_width']) $this->element('thumbnail_width',null,$oembed['thumbnail_width']);
                    if($oembed['thumbnail_height']) $this->element('thumbnail_height',null,$oembed['thumbnail_height']);

                    $this->elementEnd('oembed');
                    $this->end_document('xml');
                    break;
171
                case 'json': case '':
172 173 174 175 176
                    $this->init_document('json');
                    print(json_encode($oembed));
                    $this->end_document('json');
                    break;
                default:
177
                    // TRANS: Error message displaying attachments. %s is a raw MIME type (eg 'image/png')
178
                    $this->serverError(sprintf(_('Content type %s not supported.'), $apidata['content-type']), 501);
179 180
            }
        }else{
181
            // TRANS: Error message displaying attachments. %s is the site's base URL.
182
            $this->serverError(sprintf(_('Only %s URLs over plain HTTP please.'), common_root_url()), 404);
183 184 185
        }
    }

186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202
    function init_document($type)
    {
        switch ($type) {
        case 'xml':
            header('Content-Type: application/xml; charset=utf-8');
            $this->startXML();
            break;
        case 'json':
            header('Content-Type: application/json; charset=utf-8');

            // Check for JSONP callback
            $callback = $this->arg('callback');
            if ($callback) {
                print $callback . '(';
            }
            break;
        default:
203
            // TRANS: Server error displayed in oEmbed action when request specifies an unsupported data format.
204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222
            $this->serverError(_('Not a supported data format.'), 501);
            break;
        }
    }

    function end_document($type='xml')
    {
        switch ($type) {
        case 'xml':
            $this->endXML();
            break;
        case 'json':
            // Check for JSONP callback
            $callback = $this->arg('callback');
            if ($callback) {
                print ')';
            }
            break;
        default:
223
            // TRANS: Server error displayed in oEmbed action when request specifies an unsupported data format.
224 225 226 227 228 229
            $this->serverError(_('Not a supported data format.'), 501);
            break;
        }
        return;
    }

230 231 232 233 234 235 236 237 238 239 240
    /**
     * Is this action read-only?
     *
     * @param array $args other arguments
     *
     * @return boolean is read only action?
     */
    function isReadOnly($args)
    {
        return true;
    }
241
}