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('GNUSOCIAL')) { exit(1); }
  21
  22 /**
  23  * Table Definition for file_thumbnail
  24  */
  25
  26 class File_thumbnail extends Managed_DataObject
  27 {
  28     public $__table = 'file_thumbnail';                  // table name
  29     public $file_id;                         // int(4)  primary_key not_null
  30     public $url;                             // text
  31     public $filename;                        // text
  32     public $width;                           // int(4)  primary_key
  33     public $height;                          // int(4)  primary_key
  34     public $modified;                        // timestamp()   not_null default_CURRENT_TIMESTAMP
  35
  36     public static function schemaDef()
  37     {
  38         return array(
  39             'fields' => array(
  40                 'file_id' => array('type' => 'int', 'not null' => true, 'description' => 'thumbnail for what URL/file'),
  41                 'url' => array('type' => 'text', 'not null' => false, 'description' => 'URL of thumbnail'),
  42                 'filename' => array('type' => 'text', 'description' => 'if stored locally, filename is put here'),
  43                 'width' => array('type' => 'int', 'description' => 'width of thumbnail'),
  44                 'height' => array('type' => 'int', 'description' => 'height of thumbnail'),
  45                 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'),
  46             ),
  47             'primary key' => array('file_id', 'width', 'height'),
  48             'indexes' => array(
  49                 'file_thumbnail_file_id_idx' => array('file_id'),
  50             ),
  51             'foreign keys' => array(
  52                 'file_thumbnail_file_id_fkey' => array('file', array('file_id' => 'id')),
  53             )
  54         );
  55     }
  56
  57     /**
  58      * Save oEmbed-provided thumbnail data
  59      *
  60      * @param object $data
  61      * @param int $file_id
  62      */
  63     public static function saveNew($data, $file_id) {
  64         if (!empty($data->thumbnail_url)) {
  65             // Non-photo types such as video will usually
  66             // show us a thumbnail, though it's not required.
  67             self::saveThumbnail($file_id,
  68                                 $data->thumbnail_url,
  69                                 $data->thumbnail_width,
  70                                 $data->thumbnail_height);
  71         } else if ($data->type == 'photo') {
  72             // The inline photo URL given should also fit within
  73             // our requested thumbnail size, per oEmbed spec.
  74             self::saveThumbnail($file_id,
  75                                 $data->url,
  76                                 $data->width,
  77                                 $data->height);
  78         }
  79     }
  80
  81     /**
  82      * Fetch an entry by using a File's id
  83      */
  84     static function byFile(File $file) {
  85         $file_thumbnail = self::getKV('file_id', $file->getID());
  86         if (!$file_thumbnail instanceof File_thumbnail) {
  87             throw new ServerException(sprintf('No File_thumbnail entry for File id==%u', $file->getID()));
  88         }
  89         return $file_thumbnail;
  90     }
  91
  92     /**
  93      * Save a thumbnail record for the referenced file record.
  94      *
  95      * FIXME: Add error handling
  96      *
  97      * @param int $file_id
  98      * @param string $url
  99      * @param int $width
 100      * @param int $height
 101      */
 102     static function saveThumbnail($file_id, $url, $width, $height, $filename=null)
 103     {
 104         $tn = new File_thumbnail;
 105         $tn->file_id = $file_id;
 106         $tn->url = $url;
 107         $tn->filename = $filename;
 108         $tn->width = intval($width);
 109         $tn->height = intval($height);
 110         $tn->insert();
 111         return $tn;
 112     }
 113
 114     static function path($filename)
 115     {
 116         // TODO: Store thumbnails in their own directory and don't use File::path here
 117         return File::path($filename);
 118     }
 119
 120     static function url($filename)
 121     {
 122         // TODO: Store thumbnails in their own directory and don't use File::url here
 123         return File::url($filename);
 124     }
 125
 126     public function getPath()
 127     {
 128         $filepath = self::path($this->filename);
 129         if (!file_exists($filepath)) {
 130             throw new FileNotFoundException($filepath);
 131         }
 132         return $filepath;
 133     }
 134
 135     public function getUrl()
 136     {
 137         if (!empty($this->getFile()->filename)) {
 138             // A locally stored File, so we can dynamically generate a URL.
 139             if (!empty($this->url)) {
 140                 // Let's just clear this field as there is no point in having it for local files.
 141                 $orig = clone($this);
 142                 $this->url = null;
 143                 $this->update($orig);
 144             }
 145             $url = common_local_url('attachment_thumbnail', array('attachment'=>$this->file_id));
 146             if (strpos($url, '?') === false) {
 147                 $url .= '?';
 148             }
 149             return $url . http_build_query(array('w'=>$this->width, 'h'=>$this->height));
 150         }
 151
 152         // No local filename available, return the URL we have stored
 153         return $this->url;
 154     }
 155
 156     public function getHeight()
 157     {
 158         return $this->height;
 159     }
 160
 161     public function getWidth()
 162     {
 163         return $this->width;
 164     }
 165
 166     public function getHtmlAttrs(array $orig=array(), $overwrite=true)
 167     {
 168         $attrs = [
 169                 'height' => $this->getHeight(),
 170                 'width'  => $this->getWidth(),
 171                 'src'    => $this->getUrl(),
 172             ];
 173         return $overwrite ? array_merge($orig, $attrs) : array_merge($attrs, $orig);
 174     }
 175
 176     public function delete($useWhere=false)
 177     {
 178         if (!empty($this->filename) && file_exists(File_thumbnail::path($this->filename))) {
 179             $deleted = @unlink(self::path($this->filename));
 180             if (!$deleted) {
 181                 common_log(LOG_ERR, sprintf('Could not unlink existing file: "%s"', self::path($this->filename)));
 182             }
 183         }
 184
 185         return parent::delete($useWhere);
 186     }
 187
 188     public function getFile()
 189     {
 190         return File::getByID($this->file_id);
 191     }
 192 }