classes/File_thumbnail.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('STATUSNET') && !defined('LACONICA')) { exit(1); }
  21
  22 require_once INSTALLDIR.'/classes/Memcached_DataObject.php';
  23
  24 /**
  25  * Table Definition for file_thumbnail
  26  */
  27
  28 class File_thumbnail extends Managed_DataObject
  29 {
  30     public $__table = 'file_thumbnail';                  // table name
  31     public $file_id;                         // int(4)  primary_key not_null
  32     public $url;                             // varchar(255)  unique_key
  33     public $filename;                        // varchar(255)
  34     public $width;                           // int(4)  primary_key
  35     public $height;                          // int(4)  primary_key
  36     public $modified;                        // timestamp()   not_null default_CURRENT_TIMESTAMP
  37
  38     public static function schemaDef()
  39     {
  40         return array(
  41             'fields' => array(
  42                 'file_id' => array('type' => 'int', 'not null' => true, 'description' => 'thumbnail for what URL/file'),
  43                 'url' => array('type' => 'varchar', 'length' => 255, 'description' => 'URL of thumbnail'),
  44                 'filename' => array('type' => 'varchar', 'length' => 255, 'description' => 'if stored locally, filename is put here'),
  45                 'width' => array('type' => 'int', 'description' => 'width of thumbnail'),
  46                 'height' => array('type' => 'int', 'description' => 'height of thumbnail'),
  47                 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'),
  48             ),
  49             'primary key' => array('file_id', 'width', 'height'),
  50             'indexes' => array(
  51                 'file_thumbnail_file_id_idx' => array('file_id'),
  52             ),
  53             'foreign keys' => array(
  54                 'file_thumbnail_file_id_fkey' => array('file', array('file_id' => 'id')),
  55             )
  56         );
  57     }
  58
  59     /**
  60      * Save oEmbed-provided thumbnail data
  61      *
  62      * @param object $data
  63      * @param int $file_id
  64      */
  65     public static function saveNew($data, $file_id) {
  66         // @TODO Must be an object (see below code)
  67         assert(is_object($data));
  68
  69         if (!empty($data->thumbnail_url)) {
  70             // Non-photo types such as video will usually
  71             // show us a thumbnail, though it's not required.
  72             self::saveThumbnail($file_id,
  73                                 $data->thumbnail_url,
  74                                 $data->thumbnail_width,
  75                                 $data->thumbnail_height);
  76         } else if ($data->type == 'photo') {
  77             // The inline photo URL given should also fit within
  78             // our requested thumbnail size, per oEmbed spec.
  79             self::saveThumbnail($file_id,
  80                                 $data->url,
  81                                 $data->width,
  82                                 $data->height);
  83         }
  84     }
  85
  86     /**
  87      * Save a thumbnail record for the referenced file record.
  88      *
  89      * FIXME: Add error handling
  90      *
  91      * @param int $file_id
  92      * @param string $url
  93      * @param int $width
  94      * @param int $height
  95      */
  96     static function saveThumbnail($file_id, $url, $width, $height, $filename=null)
  97     {
  98         $tn = new File_thumbnail;
  99         $tn->file_id = $file_id;
 100         $tn->url = $url;
 101         $tn->filename = $filename;
 102         $tn->width = intval($width);
 103         $tn->height = intval($height);
 104         $tn->insert();
 105         return $tn;
 106     }
 107
 108     static function path($filename)
 109     {
 110         // TODO: Store thumbnails in their own directory and don't use File::path here
 111         return File::path($filename);
 112     }
 113
 114     public function getUrl()
 115     {
 116         if (!empty($this->filename)) {
 117             // A locally stored file, so let's generate a URL for our instance.
 118             $url = File::url($this->filename);
 119             if ($url != $this->url) {
 120                 // For indexing purposes, in case we do a lookup on the 'url' field.
 121                 // also we're fixing possible changes from http to https, or paths
 122                 $this->updateUrl($url);
 123             }
 124             return $url;
 125         }
 126
 127         // No local filename available, return the URL we have stored
 128         return $this->url;
 129     }
 130
 131     public function updateUrl($url)
 132     {
 133         $file = File_thumbnail::getKV('url', $url);
 134         if ($file instanceof File_thumbnail) {
 135             throw new ServerException('URL already exists in DB');
 136         }
 137         $sql = 'UPDATE %1$s SET url=%2$s WHERE url=%3$s;';
 138         $result = $this->query(sprintf($sql, $this->__table,
 139                                              $this->_quote((string)$url),
 140                                              $this->_quote((string)$this->url)));
 141         if ($result === false) {
 142             common_log_db_error($this, 'UPDATE', __FILE__);
 143             throw new ServerException("Could not UPDATE {$this->__table}.url");
 144         }
 145
 146         return $result;
 147     }
 148
 149     public function delete($useWhere=false)
 150     {
 151         if (!empty($this->filename) && file_exists(File_thumbnail::path($this->filename))) {
 152             $deleted = @unlink(self::path($this->filename));
 153             if (!$deleted) {
 154                 common_log(LOG_ERR, sprintf('Could not unlink existing file: "%s"', self::path($this->filename)));
 155             }
 156         }
 157
 158         return parent::delete($useWhere);
 159     }
 160
 161     public function getFile()
 162     {
 163         $file = new File();
 164         $file->id = $this->file_id;
 165         if (!$file->find(true)) {
 166             throw new NoResultException($file);
 167         }
 168         return $file;
 169     }
 170 }