plugins/Oembed/classes/File_oembed.php

   1 <?php
   2 /*
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2008, 2009, StatusNet, Inc.
   5  *
   6  * This program is free software: you can redistribute it and/or modify
   7  * it under the terms of the GNU Affero General Public License as published by
   8  * the Free Software Foundation, either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.     See the
  14  * GNU Affero General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Affero General Public License
  17  * along with this program.     If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 if (!defined('GNUSOCIAL')) { exit(1); }
  21
  22 /**
  23  * Table Definition for file_oembed
  24  */
  25
  26 class File_oembed extends Managed_DataObject
  27 {
  28     public $__table = 'file_oembed';                     // table name
  29     public $file_id;                         // int(4)  primary_key not_null
  30     public $version;                         // varchar(20)
  31     public $type;                            // varchar(20)
  32     public $mimetype;                        // varchar(50)
  33     public $provider;                        // varchar(50)
  34     public $provider_url;                    // varchar(191)   not 255 because utf8mb4 takes more space
  35     public $width;                           // int(4)
  36     public $height;                          // int(4)
  37     public $html;                            // text()
  38     public $title;                           // varchar(191)   not 255 because utf8mb4 takes more space
  39     public $author_name;                     // varchar(50)
  40     public $author_url;                      // varchar(191)   not 255 because utf8mb4 takes more space
  41     public $url;                             // varchar(191)   not 255 because utf8mb4 takes more space
  42     public $modified;                        // timestamp()   not_null default_CURRENT_TIMESTAMP
  43
  44     public static function schemaDef()
  45     {
  46         return array(
  47             'fields' => array(
  48                 'file_id' => array('type' => 'int', 'not null' => true, 'description' => 'oEmbed for that URL/file'),
  49                 'version' => array('type' => 'varchar', 'length' => 20, 'description' => 'oEmbed spec. version'),
  50                 'type' => array('type' => 'varchar', 'length' => 20, 'description' => 'oEmbed type: photo, video, link, rich'),
  51                 'mimetype' => array('type' => 'varchar', 'length' => 50, 'description' => 'mime type of resource'),
  52                 'provider' => array('type' => 'text', 'description' => 'name of this oEmbed provider'),
  53                 'provider_url' => array('type' => 'text', 'description' => 'URL of this oEmbed provider'),
  54                 'width' => array('type' => 'int', 'description' => 'width of oEmbed resource when available'),
  55                 'height' => array('type' => 'int', 'description' => 'height of oEmbed resource when available'),
  56                 'html' => array('type' => 'text', 'description' => 'html representation of this oEmbed resource when applicable'),
  57                 'title' => array('type' => 'text', 'description' => 'title of oEmbed resource when available'),
  58                 'author_name' => array('type' => 'text', 'description' => 'author name for this oEmbed resource'),
  59                 'author_url' => array('type' => 'text', 'description' => 'author URL for this oEmbed resource'),
  60                 'url' => array('type' => 'text', 'description' => 'URL for this oEmbed resource when applicable (photo, link)'),
  61                 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'),
  62             ),
  63             'primary key' => array('file_id'),
  64             'foreign keys' => array(
  65                 'file_oembed_file_id_fkey' => array('file', array('file_id' => 'id')),
  66             ),
  67         );
  68     }
  69
  70     static function _getOembed($url) {
  71         try {
  72             return oEmbedHelper::getObject($url);
  73         } catch (Exception $e) {
  74             common_log(LOG_INFO, "Error during oembed lookup for $url - " . $e->getMessage());
  75             return false;
  76         }
  77     }
  78
  79     /**
  80      * Fetch an entry by using a File's id
  81      */
  82     static function getByFile(File $file) {
  83         $fo = new File_oembed();
  84         $fo->file_id = $file->id;
  85         if (!$fo->find(true)) {
  86             throw new NoResultException($fo);
  87         }
  88         return $fo;
  89     }
  90
  91     public function getUrl()
  92     {
  93         return $this->url;
  94     }
  95
  96     /**
  97      * Save embedding info for a new file.
  98      *
  99      * @param object $data Services_oEmbed_Object_*
 100      * @param int $file_id
 101      */
 102     public static function saveNew($data, $file_id) {
 103         // @TODO Must be an object
 104         assert(is_object($data));
 105
 106         $file_oembed = new File_oembed;
 107         $file_oembed->file_id = $file_id;
 108         if (!isset($data->version)) {
 109             common_debug('DEBUGGING oEmbed: data->version undefined in variable $data: '.var_export($data, true));
 110         }
 111         $file_oembed->version = $data->version;
 112         $file_oembed->type = $data->type;
 113         if (!empty($data->provider_name)) $file_oembed->provider = $data->provider_name;
 114         if (!empty($data->provider)) $file_oembed->provider = $data->provider;
 115         if (!empty($data->provider_url)) $file_oembed->provider_url = $data->provider_url;
 116         if (!empty($data->width)) $file_oembed->width = intval($data->width);
 117         if (!empty($data->height)) $file_oembed->height = intval($data->height);
 118         if (!empty($data->html)) $file_oembed->html = $data->html;
 119         if (!empty($data->title)) $file_oembed->title = $data->title;
 120         if (!empty($data->author_name)) $file_oembed->author_name = $data->author_name;
 121         if (!empty($data->author_url)) $file_oembed->author_url = $data->author_url;
 122         if (!empty($data->url)){
 123             $file_oembed->url = $data->url;
 124             $given_url = File_redirection::_canonUrl($file_oembed->url);
 125             if (! empty($given_url)){
 126                 $file = File::getKV('url', $given_url);
 127                 if ($file instanceof File) {
 128                     $file_oembed->mimetype = $file->mimetype;
 129                 } else {
 130                     $redir = File_redirection::where($given_url);
 131                     if (empty($redir->file_id)) {
 132                         $f = $redir->getFile();
 133                         $file_oembed->mimetype = $f->mimetype;
 134                     } else {
 135                         $file_id = $redir->file_id;
 136                     }
 137                 }
 138             }
 139         }
 140         $result = $file_oembed->insert();
 141         if ($result === false) {
 142             throw new ServerException('Failed to insert File_oembed data into database!');
 143         }
 144         if (!empty($data->thumbnail_url) || ($data->type == 'photo')) {
 145             $ft = File_thumbnail::getKV('file_id', $file_id);
 146             if ($ft instanceof File_thumbnail) {
 147                 common_log(LOG_WARNING, "Strangely, a File_thumbnail object exists for new file $file_id",
 148                            __FILE__);
 149             } else {
 150                 File_thumbnail::saveNew($data, $file_id);
 151             }
 152         }
 153     }
 154 }