classes/File.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
  24  */
  25 class File extends Managed_DataObject
  26 {
  27     public $__table = 'file';                            // table name
  28     public $id;                              // int(4)  primary_key not_null
  29     public $urlhash;                         // varchar(64)  unique_key
  30     public $url;                             // text
  31     public $filehash;                        // varchar(64)     indexed
  32     public $mimetype;                        // varchar(50)
  33     public $size;                            // int(4)
  34     public $title;                           // text()
  35     public $date;                            // int(4)
  36     public $protected;                       // int(4)
  37     public $filename;                        // text()
  38     public $width;                           // int(4)
  39     public $height;                          // int(4)
  40     public $modified;                        // timestamp()   not_null default_CURRENT_TIMESTAMP
  41
  42     const URLHASH_ALG = 'sha256';
  43     const FILEHASH_ALG = 'sha256';
  44
  45     public static function schemaDef()
  46     {
  47         return array(
  48             'fields' => array(
  49                 'id' => array('type' => 'serial', 'not null' => true),
  50                 'urlhash' => array('type' => 'varchar', 'length' => 64, 'not null' => true, 'description' => 'sha256 of destination URL (url field)'),
  51                 'url' => array('type' => 'text', 'description' => 'destination URL after following possible redirections'),
  52                 'filehash' => array('type' => 'varchar', 'length' => 64, 'not null' => false, 'description' => 'sha256 of the file contents, only for locally stored files of course'),
  53                 'mimetype' => array('type' => 'varchar', 'length' => 50, 'description' => 'mime type of resource'),
  54                 'size' => array('type' => 'int', 'description' => 'size of resource when available'),
  55                 'title' => array('type' => 'text', 'description' => 'title of resource when available'),
  56                 'date' => array('type' => 'int', 'description' => 'date of resource according to http query'),
  57                 'protected' => array('type' => 'int', 'description' => 'true when URL is private (needs login)'),
  58                 'filename' => array('type' => 'text', 'description' => 'if file is stored locally (too) this is the filename'),
  59                 'width' => array('type' => 'int', 'description' => 'width in pixels, if it can be described as such and data is available'),
  60                 'height' => array('type' => 'int', 'description' => 'height in pixels, if it can be described as such and data is available'),
  61
  62                 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'),
  63             ),
  64             'primary key' => array('id'),
  65             'unique keys' => array(
  66                 'file_urlhash_key' => array('urlhash'),
  67             ),
  68             'indexes' => array(
  69                 'file_filehash_idx' => array('filehash'),
  70             ),
  71         );
  72     }
  73
  74     public static function isProtected($url) {
  75
  76                 $protected_urls_exps = array(
  77                         'https://www.facebook.com/login.php',
  78                 common_path('main/login')
  79                 );
  80
  81                 foreach ($protected_urls_exps as $protected_url_exp) {
  82                         if (preg_match('!^'.preg_quote($protected_url_exp).'(.*)$!i', $url) === 1) {
  83                                 return true;
  84                         }
  85                 }
  86
  87                 return false;
  88     }
  89
  90     /**
  91      * Save a new file record.
  92      *
  93      * @param array $redir_data lookup data eg from File_redirection::where()
  94      * @param string $given_url
  95      * @return File
  96      */
  97     public static function saveNew(array $redir_data, $given_url)
  98     {
  99         $file = null;
 100         try {
 101             // I don't know why we have to keep doing this but we run a last check to avoid
 102             // uniqueness bugs.
 103             $file = File::getByUrl($given_url);
 104             return $file;
 105         } catch (NoResultException $e) {
 106             // We don't have the file's URL since before, so let's continue.
 107         }
 108
 109         $file = new File;
 110         $file->url = $given_url;
 111         if (!empty($redir_data['protected'])) $file->protected = $redir_data['protected'];
 112         if (!empty($redir_data['title'])) $file->title = $redir_data['title'];
 113         if (!empty($redir_data['type'])) $file->mimetype = $redir_data['type'];
 114         if (!empty($redir_data['size'])) $file->size = intval($redir_data['size']);
 115         if (isset($redir_data['time']) && $redir_data['time'] > 0) $file->date = intval($redir_data['time']);
 116         $file->saveFile();
 117         return $file;
 118     }
 119
 120     public function saveFile() {
 121         $this->urlhash = self::hashurl($this->url);
 122
 123         if (!Event::handle('StartFileSaveNew', array(&$this))) {
 124             throw new ServerException('File not saved due to an aborted StartFileSaveNew event.');
 125         }
 126
 127         $this->id = $this->insert();
 128
 129         if ($this->id === false) {
 130             throw new ServerException('File/URL metadata could not be saved to the database.');
 131         }
 132
 133         Event::handle('EndFileSaveNew', array($this));
 134     }
 135
 136     /**
 137      * Go look at a URL and possibly save data about it if it's new:
 138      * - follow redirect chains and store them in file_redirection
 139      * - if a thumbnail is available, save it in file_thumbnail
 140      * - save file record with basic info
 141      * - optionally save a file_to_post record
 142      * - return the File object with the full reference
 143      *
 144      * @param string $given_url the URL we're looking at
 145      * @param Notice $notice (optional)
 146      * @param bool $followRedirects defaults to true
 147      *
 148      * @return mixed File on success, -1 on some errors
 149      *
 150      * @throws ServerException on failure
 151      */
 152     public static function processNew($given_url, Notice $notice=null, $followRedirects=true) {
 153         if (empty($given_url)) {
 154             throw new ServerException('No given URL to process');
 155         }
 156
 157         $given_url = File_redirection::_canonUrl($given_url);
 158         if (empty($given_url)) {
 159             throw new ServerException('No canonical URL from given URL to process');
 160         }
 161
 162         $redir = File_redirection::where($given_url);
 163         $file = $redir->getFile();
 164
 165         if (!$file instanceof File || empty($file->id)) {
 166             // This should not happen
 167             throw new ServerException('URL processing failed without new File object');
 168         }
 169
 170         if ($notice instanceof Notice) {
 171             File_to_post::processNew($file, $notice);
 172         }
 173
 174         return $file;
 175     }
 176
 177     public static function respectsQuota(Profile $scoped, $fileSize) {
 178         if ($fileSize > common_config('attachments', 'file_quota')) {
 179             // TRANS: Message used to be inserted as %2$s in  the text "No file may
 180             // TRANS: be larger than %1$d byte and the file you sent was %2$s.".
 181             // TRANS: %1$d is the number of bytes of an uploaded file.
 182             $fileSizeText = sprintf(_m('%1$d byte','%1$d bytes',$fileSize),$fileSize);
 183
 184             $fileQuota = common_config('attachments', 'file_quota');
 185             // TRANS: Message given if an upload is larger than the configured maximum.
 186             // TRANS: %1$d (used for plural) is the byte limit for uploads,
 187             // TRANS: %2$s is the proper form of "n bytes". This is the only ways to have
 188             // TRANS: gettext support multiple plurals in the same message, unfortunately...
 189             throw new ClientException(
 190                     sprintf(_m('No file may be larger than %1$d byte and the file you sent was %2$s. Try to upload a smaller version.',
 191                               'No file may be larger than %1$d bytes and the file you sent was %2$s. Try to upload a smaller version.',
 192                               $fileQuota),
 193                     $fileQuota, $fileSizeText));
 194         }
 195
 196         $file = new File;
 197
 198         $query = "select sum(size) as total from file join file_to_post on file_to_post.file_id = file.id join notice on file_to_post.post_id = notice.id where profile_id = {$scoped->id} and file.url like '%/notice/%/file'";
 199         $file->query($query);
 200         $file->fetch();
 201         $total = $file->total + $fileSize;
 202         if ($total > common_config('attachments', 'user_quota')) {
 203             // TRANS: Message given if an upload would exceed user quota.
 204             // TRANS: %d (number) is the user quota in bytes and is used for plural.
 205             throw new ClientException(
 206                     sprintf(_m('A file this large would exceed your user quota of %d byte.',
 207                               'A file this large would exceed your user quota of %d bytes.',
 208                               common_config('attachments', 'user_quota')),
 209                     common_config('attachments', 'user_quota')));
 210         }
 211         $query .= ' AND EXTRACT(month FROM file.modified) = EXTRACT(month FROM now()) and EXTRACT(year FROM file.modified) = EXTRACT(year FROM now())';
 212         $file->query($query);
 213         $file->fetch();
 214         $total = $file->total + $fileSize;
 215         if ($total > common_config('attachments', 'monthly_quota')) {
 216             // TRANS: Message given id an upload would exceed a user's monthly quota.
 217             // TRANS: $d (number) is the monthly user quota in bytes and is used for plural.
 218             throw new ClientException(
 219                     sprintf(_m('A file this large would exceed your monthly quota of %d byte.',
 220                               'A file this large would exceed your monthly quota of %d bytes.',
 221                               common_config('attachments', 'monthly_quota')),
 222                     common_config('attachments', 'monthly_quota')));
 223         }
 224         return true;
 225     }
 226
 227     public function getFilename()
 228     {
 229         if (!self::validFilename($this->filename)) {
 230             // TRANS: Client exception thrown if a file upload does not have a valid name.
 231             throw new ClientException(_("Invalid filename."));
 232         }
 233         return $this->filename;
 234     }
 235
 236     // where should the file go?
 237
 238     static function filename(Profile $profile, $origname, $mimetype)
 239     {
 240         $ext = self::guessMimeExtension($mimetype, $origname);
 241
 242         // Normalize and make the original filename more URL friendly.
 243         $origname = basename($origname, ".$ext");
 244         if (class_exists('Normalizer')) {
 245             // http://php.net/manual/en/class.normalizer.php
 246             // http://www.unicode.org/reports/tr15/
 247             $origname = Normalizer::normalize($origname, Normalizer::FORM_KC);
 248         }
 249         $origname = preg_replace('/[^A-Za-z0-9\.\_]/', '_', $origname);
 250
 251         $nickname = $profile->getNickname();
 252         $datestamp = strftime('%Y%m%d', time());
 253         do {
 254             // generate new random strings until we don't run into a filename collision.
 255             $random = strtolower(common_confirmation_code(16));
 256             $filename = "$nickname-$datestamp-$origname-$random.$ext";
 257         } while (file_exists(self::path($filename)));
 258         return $filename;
 259     }
 260
 261     /**
 262      * @param $mimetype The mimetype we've discovered for this file.
 263      * @param $filename An optional filename which we can use on failure.
 264      */
 265     static function guessMimeExtension($mimetype, $filename=null)
 266     {
 267         try {
 268             // first see if we know the extension for our mimetype
 269             $ext = common_supported_mime_to_ext($mimetype);
 270             // we do, so use it!
 271             return $ext;
 272         } catch (Exception $e) {    // FIXME: Make this exception more specific to "unknown mime=>ext relation"
 273             // We don't know the extension for this mimetype, but let's guess.
 274
 275             // If we are very liberal with uploads ($config['attachments']['supported'] === true)
 276             // then we try to do some guessing based on the filename, if it was supplied.
 277             if (!is_null($filename) && common_config('attachments', 'supported')===true
 278                     && preg_match('/^.+\.([A-Za-z0-9]+)$/', $filename, $matches)) {
 279                 // we matched on a file extension, so let's see if it means something.
 280                 $ext = mb_strtolower($matches[1]);
 281
 282                 $blacklist = common_config('attachments', 'extblacklist');
 283                 // If we got an extension from $filename we want to check if it's in a blacklist
 284                 // so we avoid people uploading .php files etc.
 285                 if (array_key_exists($ext, $blacklist)) {
 286                     if (!is_string($blacklist[$ext])) {
 287                         // we don't have a safe replacement extension
 288                         throw new ClientException(_('Blacklisted file extension.'));
 289                     }
 290                     common_debug('Found replaced extension for filename '._ve($filename).': '._ve($ext));
 291
 292                     // return a safe replacement extension ('php' => 'phps' for example)
 293                     return $blacklist[$ext];
 294                 }
 295                 // the attachment extension based on its filename was not blacklisted so it's ok to use it
 296                 return $ext;
 297             }
 298         }
 299
 300         // If nothing else has given us a result, try to extract it from
 301         // the mimetype value (this turns .jpg to .jpeg for example...)
 302         $matches = array();
 303         // FIXME: try to build a regexp that will get jpeg from image/jpeg as well as json from application/jrd+json
 304         if (!preg_match('/\/([a-z0-9]+)/', mb_strtolower($mimetype), $matches)) {
 305             throw new Exception('Malformed mimetype: '.$mimetype);
 306         }
 307         return mb_strtolower($matches[1]);
 308     }
 309
 310     /**
 311      * Validation for as-saved base filenames
 312      */
 313     static function validFilename($filename)
 314     {
 315         return preg_match('/^[A-Za-z0-9._-]+$/', $filename);
 316     }
 317
 318     /**
 319      * @throws ClientException on invalid filename
 320      */
 321     static function path($filename)
 322     {
 323         if (!self::validFilename($filename)) {
 324             // TRANS: Client exception thrown if a file upload does not have a valid name.
 325             throw new ClientException(_("Invalid filename."));
 326         }
 327         $dir = common_config('attachments', 'dir');
 328
 329         if ($dir[strlen($dir)-1] != '/') {
 330             $dir .= '/';
 331         }
 332
 333         return $dir . $filename;
 334     }
 335
 336     static function url($filename)
 337     {
 338         if (!self::validFilename($filename)) {
 339             // TRANS: Client exception thrown if a file upload does not have a valid name.
 340             throw new ClientException(_("Invalid filename."));
 341         }
 342
 343         if (common_config('site','private')) {
 344
 345             return common_local_url('getfile',
 346                                 array('filename' => $filename));
 347
 348         }
 349
 350         if (GNUsocial::useHTTPS()) {
 351
 352             $sslserver = common_config('attachments', 'sslserver');
 353
 354             if (empty($sslserver)) {
 355                 // XXX: this assumes that background dir == site dir + /file/
 356                 // not true if there's another server
 357                 if (is_string(common_config('site', 'sslserver')) &&
 358                     mb_strlen(common_config('site', 'sslserver')) > 0) {
 359                     $server = common_config('site', 'sslserver');
 360                 } else if (common_config('site', 'server')) {
 361                     $server = common_config('site', 'server');
 362                 }
 363                 $path = common_config('site', 'path') . '/file/';
 364             } else {
 365                 $server = $sslserver;
 366                 $path   = common_config('attachments', 'sslpath');
 367                 if (empty($path)) {
 368                     $path = common_config('attachments', 'path');
 369                 }
 370             }
 371
 372             $protocol = 'https';
 373         } else {
 374             $path = common_config('attachments', 'path');
 375             $server = common_config('attachments', 'server');
 376
 377             if (empty($server)) {
 378                 $server = common_config('site', 'server');
 379             }
 380
 381             $ssl = common_config('attachments', 'ssl');
 382
 383             $protocol = ($ssl) ? 'https' : 'http';
 384         }
 385
 386         if ($path[strlen($path)-1] != '/') {
 387             $path .= '/';
 388         }
 389
 390         if ($path[0] != '/') {
 391             $path = '/'.$path;
 392         }
 393
 394         return $protocol.'://'.$server.$path.$filename;
 395     }
 396
 397     static $_enclosures = array();
 398
 399     function getEnclosure(){
 400         if (isset(self::$_enclosures[$this->getID()])) {
 401             return self::$_enclosures[$this->getID()];
 402         }
 403
 404         $enclosure = (object) array();
 405         foreach (array('title', 'url', 'date', 'modified', 'size', 'mimetype', 'width', 'height') as $key) {
 406             if ($this->$key !== '') {
 407                 $enclosure->$key = $this->$key;
 408             }
 409         }
 410
 411         $needMoreMetadataMimetypes = array(null, 'application/xhtml+xml', 'text/html');
 412
 413         if (!isset($this->filename) && in_array(common_bare_mime($enclosure->mimetype), $needMoreMetadataMimetypes)) {
 414             // This fetches enclosure metadata for non-local links with unset/HTML mimetypes,
 415             // which may be enriched through oEmbed or similar (implemented as plugins)
 416             Event::handle('FileEnclosureMetadata', array($this, &$enclosure));
 417         }
 418         if (empty($enclosure->mimetype)) {
 419             // This means we either don't know what it is, so it can't
 420             // be shown as an enclosure, or it is an HTML link which
 421             // does not link to a resource with further metadata.
 422             throw new ServerException('Unknown enclosure mimetype, not enough metadata');
 423         }
 424
 425         self::$_enclosures[$this->getID()] = $enclosure;
 426         return $enclosure;
 427     }
 428
 429     public function hasThumbnail()
 430     {
 431         try {
 432             $this->getThumbnail();
 433         } catch (Exception $e) {
 434             return false;
 435         }
 436         return true;
 437     }
 438
 439     /**
 440      * Get the attachment's thumbnail record, if any.
 441      * Make sure you supply proper 'int' typed variables (or null).
 442      *
 443      * @param $width  int   Max width of thumbnail in pixels. (if null, use common_config values)
 444      * @param $height int   Max height of thumbnail in pixels. (if null, square-crop to $width)
 445      * @param $crop   bool  Crop to the max-values' aspect ratio
 446      *
 447      * @return File_thumbnail
 448      *
 449      * @throws UseFileAsThumbnailException  if the file is considered an image itself and should be itself as thumbnail
 450      * @throws UnsupportedMediaException    if, despite trying, we can't understand how to make a thumbnail for this format
 451      * @throws ServerException              on various other errors
 452      */
 453     public function getThumbnail($width=null, $height=null, $crop=false, $force_still=true, $upscale=null)
 454     {
 455         // Get some more information about this file through our ImageFile class
 456         $image = ImageFile::fromFileObject($this);
 457         if ($image->animated && !common_config('thumbnail', 'animated')) {
 458             // null  means "always use file as thumbnail"
 459             // false means you get choice between frozen frame or original when calling getThumbnail
 460             if (is_null(common_config('thumbnail', 'animated')) || !$force_still) {
 461                 throw new UseFileAsThumbnailException($this->id);
 462             }
 463         }
 464
 465         return $image->getFileThumbnail($width, $height, $crop,
 466                                         !is_null($upscale) ? $upscale : common_config('thumbnail', 'upscale'));
 467     }
 468
 469     public function getPath()
 470     {
 471         $filepath = self::path($this->filename);
 472         if (!file_exists($filepath)) {
 473             throw new FileNotFoundException($filepath);
 474         }
 475         return $filepath;
 476     }
 477
 478     public function getUrl($prefer_local=true)
 479     {
 480         if ($prefer_local && !empty($this->filename)) {
 481             // A locally stored file, so let's generate a URL for our instance.
 482             return self::url($this->filename);
 483         }
 484
 485         // No local filename available, return the URL we have stored
 486         return $this->url;
 487     }
 488
 489     static public function getByUrl($url)
 490     {
 491         $file = new File();
 492         $file->urlhash = self::hashurl($url);
 493         if (!$file->find(true)) {
 494             throw new NoResultException($file);
 495         }
 496         return $file;
 497     }
 498
 499     /**
 500      * @param   string  $hashstr    String of (preferrably lower case) hexadecimal characters, same as result of 'hash_file(...)'
 501      */
 502     static public function getByHash($hashstr)
 503     {
 504         $file = new File();
 505         $file->filehash = strtolower($hashstr);
 506         if (!$file->find(true)) {
 507             throw new NoResultException($file);
 508         }
 509         return $file;
 510     }
 511
 512     public function updateUrl($url)
 513     {
 514         $file = File::getKV('urlhash', self::hashurl($url));
 515         if ($file instanceof File) {
 516             throw new ServerException('URL already exists in DB');
 517         }
 518         $sql = 'UPDATE %1$s SET urlhash=%2$s, url=%3$s WHERE urlhash=%4$s;';
 519         $result = $this->query(sprintf($sql, $this->tableName(),
 520                                              $this->_quote((string)self::hashurl($url)),
 521                                              $this->_quote((string)$url),
 522                                              $this->_quote((string)$this->urlhash)));
 523         if ($result === false) {
 524             common_log_db_error($this, 'UPDATE', __FILE__);
 525             throw new ServerException("Could not UPDATE {$this->tableName()}.url");
 526         }
 527
 528         return $result;
 529     }
 530
 531     /**
 532      * Blow the cache of notices that link to this URL
 533      *
 534      * @param boolean $last Whether to blow the "last" cache too
 535      *
 536      * @return void
 537      */
 538
 539     function blowCache($last=false)
 540     {
 541         self::blow('file:notice-ids:%s', $this->id);
 542         if ($last) {
 543             self::blow('file:notice-ids:%s;last', $this->id);
 544         }
 545         self::blow('file:notice-count:%d', $this->id);
 546     }
 547
 548     /**
 549      * Stream of notices linking to this URL
 550      *
 551      * @param integer $offset   Offset to show; default is 0
 552      * @param integer $limit    Limit of notices to show
 553      * @param integer $since_id Since this notice
 554      * @param integer $max_id   Before this notice
 555      *
 556      * @return array ids of notices that link to this file
 557      */
 558
 559     function stream($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $max_id=0)
 560     {
 561         $stream = new FileNoticeStream($this);
 562         return $stream->getNotices($offset, $limit, $since_id, $max_id);
 563     }
 564
 565     function noticeCount()
 566     {
 567         $cacheKey = sprintf('file:notice-count:%d', $this->id);
 568
 569         $count = self::cacheGet($cacheKey);
 570
 571         if ($count === false) {
 572
 573             $f2p = new File_to_post();
 574
 575             $f2p->file_id = $this->id;
 576
 577             $count = $f2p->count();
 578
 579             self::cacheSet($cacheKey, $count);
 580         }
 581
 582         return $count;
 583     }
 584
 585     public function isLocal()
 586     {
 587         return !empty($this->filename);
 588     }
 589
 590     public function delete($useWhere=false)
 591     {
 592         // Delete the file, if it exists locally
 593         if (!empty($this->filename) && file_exists(self::path($this->filename))) {
 594             $deleted = @unlink(self::path($this->filename));
 595             if (!$deleted) {
 596                 common_log(LOG_ERR, sprintf('Could not unlink existing file: "%s"', self::path($this->filename)));
 597             }
 598         }
 599
 600         // Clear out related things in the database and filesystem, such as thumbnails
 601         if (Event::handle('FileDeleteRelated', array($this))) {
 602             $thumbs = new File_thumbnail();
 603             $thumbs->file_id = $this->id;
 604             if ($thumbs->find()) {
 605                 while ($thumbs->fetch()) {
 606                     $thumbs->delete();
 607                 }
 608             }
 609
 610             $f2p = new File_to_post();
 611             $f2p->file_id = $this->id;
 612             if ($f2p->find()) {
 613                 while ($f2p->fetch()) {
 614                     $f2p->delete();
 615                 }
 616             }
 617         }
 618
 619         // And finally remove the entry from the database
 620         return parent::delete($useWhere);
 621     }
 622
 623     public function getTitle()
 624     {
 625         $title = $this->title ?: $this->filename;
 626
 627         return $title ?: null;
 628     }
 629
 630     static public function hashurl($url)
 631     {
 632         if (empty($url)) {
 633             throw new Exception('No URL provided to hash algorithm.');
 634         }
 635         return hash(self::URLHASH_ALG, $url);
 636     }
 637
 638     static public function beforeSchemaUpdate()
 639     {
 640         $table = strtolower(get_called_class());
 641         $schema = Schema::get();
 642         $schemadef = $schema->getTableDef($table);
 643
 644         // 2015-02-19 We have to upgrade our table definitions to have the urlhash field populated
 645         if (isset($schemadef['fields']['urlhash']) && isset($schemadef['unique keys']['file_urlhash_key'])) {
 646             // We already have the urlhash field, so no need to migrate it.
 647             return;
 648         }
 649         echo "\nFound old $table table, upgrading it to contain 'urlhash' field...";
 650
 651         $file = new File();
 652         $file->query(sprintf('SELECT id, LEFT(url, 191) AS shortenedurl, COUNT(*) AS c FROM %1$s WHERE LENGTH(url)>191 GROUP BY shortenedurl HAVING c > 1', $schema->quoteIdentifier($table)));
 653         print "\nFound {$file->N} URLs with too long entries in file table\n";
 654         while ($file->fetch()) {
 655             // We've got a URL that is too long for our future file table
 656             // so we'll cut it. We could save the original URL, but there is
 657             // no guarantee it is complete anyway since the previous max was 255 chars.
 658             $dupfile = new File();
 659             // First we find file entries that would be duplicates of this when shortened
 660             // ... and we'll just throw the dupes out the window for now! It's already so borken.
 661             $dupfile->query(sprintf('SELECT * FROM file WHERE LEFT(url, 191) = "%1$s"', $file->shortenedurl));
 662             // Leave one of the URLs in the database by using ->find(true) (fetches first entry)
 663             if ($dupfile->find(true)) {
 664                 print "\nShortening url entry for $table id: {$file->id} [";
 665                 $orig = clone($dupfile);
 666                 $dupfile->url = $file->shortenedurl;    // make sure it's only 191 chars from now on
 667                 $dupfile->update($orig);
 668                 print "\nDeleting duplicate entries of too long URL on $table id: {$file->id} [";
 669                 // only start deleting with this fetch.
 670                 while($dupfile->fetch()) {
 671                     print ".";
 672                     $dupfile->delete();
 673                 }
 674                 print "]\n";
 675             } else {
 676                 print "\nWarning! URL suddenly disappeared from database: {$file->url}\n";
 677             }
 678         }
 679         echo "...and now all the non-duplicates which are longer than 191 characters...\n";
 680         $file->query('UPDATE file SET url=LEFT(url, 191) WHERE LENGTH(url)>191');
 681
 682         echo "\n...now running hacky pre-schemaupdate change for $table:";
 683         // We have to create a urlhash that is _not_ the primary key,
 684         // transfer data and THEN run checkSchema
 685         $schemadef['fields']['urlhash'] = array (
 686                                               'type' => 'varchar',
 687                                               'length' => 64,
 688                                               'not null' => false,  // this is because when adding column, all entries will _be_ NULL!
 689                                               'description' => 'sha256 of destination URL (url field)',
 690                                             );
 691         $schemadef['fields']['url'] = array (
 692                                               'type' => 'text',
 693                                               'description' => 'destination URL after following possible redirections',
 694                                             );
 695         unset($schemadef['unique keys']);
 696         $schema->ensureTable($table, $schemadef);
 697         echo "DONE.\n";
 698
 699         $classname = ucfirst($table);
 700         $tablefix = new $classname;
 701         // urlhash is hash('sha256', $url) in the File table
 702         echo "Updating urlhash fields in $table table...";
 703         // Maybe very MySQL specific :(
 704         $tablefix->query(sprintf('UPDATE %1$s SET %2$s=%3$s;',
 705                             $schema->quoteIdentifier($table),
 706                             'urlhash',
 707                             // The line below is "result of sha256 on column `url`"
 708                             'SHA2(url, 256)'));
 709         echo "DONE.\n";
 710         echo "Resuming core schema upgrade...";
 711     }
 712 }