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     function isProtected($url) {
  75         return 'http://www.facebook.com/login.php' === $url;
  76     }
  77
  78     /**
  79      * Save a new file record.
  80      *
  81      * @param array $redir_data lookup data eg from File_redirection::where()
  82      * @param string $given_url
  83      * @return File
  84      */
  85     public static function saveNew(array $redir_data, $given_url)
  86     {
  87         $file = null;
  88         try {
  89             // I don't know why we have to keep doing this but we run a last check to avoid
  90             // uniqueness bugs.
  91             $file = File::getByUrl($given_url);
  92             return $file;
  93         } catch (NoResultException $e) {
  94             // We don't have the file's URL since before, so let's continue.
  95         }
  96
  97         $file = new File;
  98         $file->url = $given_url;
  99         if (!empty($redir_data['protected'])) $file->protected = $redir_data['protected'];
 100         if (!empty($redir_data['title'])) $file->title = $redir_data['title'];
 101         if (!empty($redir_data['type'])) $file->mimetype = $redir_data['type'];
 102         if (!empty($redir_data['size'])) $file->size = intval($redir_data['size']);
 103         if (isset($redir_data['time']) && $redir_data['time'] > 0) $file->date = intval($redir_data['time']);
 104         $file->saveFile();
 105         return $file;
 106     }
 107
 108     public function saveFile() {
 109         $this->urlhash = self::hashurl($this->url);
 110
 111         if (!Event::handle('StartFileSaveNew', array(&$this))) {
 112             throw new ServerException('File not saved due to an aborted StartFileSaveNew event.');
 113         }
 114
 115         $this->id = $this->insert();
 116
 117         if ($this->id === false) {
 118             throw new ServerException('File/URL metadata could not be saved to the database.');
 119         }
 120
 121         Event::handle('EndFileSaveNew', array($this));
 122     }
 123
 124     /**
 125      * Go look at a URL and possibly save data about it if it's new:
 126      * - follow redirect chains and store them in file_redirection
 127      * - if a thumbnail is available, save it in file_thumbnail
 128      * - save file record with basic info
 129      * - optionally save a file_to_post record
 130      * - return the File object with the full reference
 131      *
 132      * @param string $given_url the URL we're looking at
 133      * @param Notice $notice (optional)
 134      * @param bool $followRedirects defaults to true
 135      *
 136      * @return mixed File on success, -1 on some errors
 137      *
 138      * @throws ServerException on failure
 139      */
 140     public static function processNew($given_url, Notice $notice=null, $followRedirects=true) {
 141         if (empty($given_url)) {
 142             throw new ServerException('No given URL to process');
 143         }
 144
 145         $given_url = File_redirection::_canonUrl($given_url);
 146         if (empty($given_url)) {
 147             throw new ServerException('No canonical URL from given URL to process');
 148         }
 149
 150         $redir = File_redirection::where($given_url);
 151         $file = $redir->getFile();
 152
 153         // If we still don't have a File object, let's create one now!
 154         if (empty($file->id)) {
 155             if ($redir->url === $given_url || !$followRedirects) {
 156                 // Save the File object based on our lookup trace
 157                 $file->saveFile();
 158             } else {
 159                 $file->saveFile();
 160                 $redir->file_id = $file->id;
 161                 $redir->insert();
 162             }
 163         }
 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);
 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     static function guessMimeExtension($mimetype)
 262     {
 263         try {
 264             $ext = common_supported_mime_to_ext($mimetype);
 265         } catch (Exception $e) {
 266             // We don't support this mimetype, but let's guess the extension
 267             $matches = array();
 268             if (!preg_match('/\/([a-z0-9]+)/', mb_strtolower($mimetype), $matches)) {
 269                 throw new Exception('Malformed mimetype: '.$mimetype);
 270             }
 271             $ext = $matches[1];
 272         }
 273         return mb_strtolower($ext);
 274     }
 275
 276     /**
 277      * Validation for as-saved base filenames
 278      */
 279     static function validFilename($filename)
 280     {
 281         return preg_match('/^[A-Za-z0-9._-]+$/', $filename);
 282     }
 283
 284     /**
 285      * @throws ClientException on invalid filename
 286      */
 287     static function path($filename)
 288     {
 289         if (!self::validFilename($filename)) {
 290             // TRANS: Client exception thrown if a file upload does not have a valid name.
 291             throw new ClientException(_("Invalid filename."));
 292         }
 293         $dir = common_config('attachments', 'dir');
 294
 295         if ($dir[strlen($dir)-1] != '/') {
 296             $dir .= '/';
 297         }
 298
 299         return $dir . $filename;
 300     }
 301
 302     static function url($filename)
 303     {
 304         if (!self::validFilename($filename)) {
 305             // TRANS: Client exception thrown if a file upload does not have a valid name.
 306             throw new ClientException(_("Invalid filename."));
 307         }
 308
 309         if (common_config('site','private')) {
 310
 311             return common_local_url('getfile',
 312                                 array('filename' => $filename));
 313
 314         }
 315
 316         if (GNUsocial::useHTTPS()) {
 317
 318             $sslserver = common_config('attachments', 'sslserver');
 319
 320             if (empty($sslserver)) {
 321                 // XXX: this assumes that background dir == site dir + /file/
 322                 // not true if there's another server
 323                 if (is_string(common_config('site', 'sslserver')) &&
 324                     mb_strlen(common_config('site', 'sslserver')) > 0) {
 325                     $server = common_config('site', 'sslserver');
 326                 } else if (common_config('site', 'server')) {
 327                     $server = common_config('site', 'server');
 328                 }
 329                 $path = common_config('site', 'path') . '/file/';
 330             } else {
 331                 $server = $sslserver;
 332                 $path   = common_config('attachments', 'sslpath');
 333                 if (empty($path)) {
 334                     $path = common_config('attachments', 'path');
 335                 }
 336             }
 337
 338             $protocol = 'https';
 339         } else {
 340             $path = common_config('attachments', 'path');
 341             $server = common_config('attachments', 'server');
 342
 343             if (empty($server)) {
 344                 $server = common_config('site', 'server');
 345             }
 346
 347             $ssl = common_config('attachments', 'ssl');
 348
 349             $protocol = ($ssl) ? 'https' : 'http';
 350         }
 351
 352         if ($path[strlen($path)-1] != '/') {
 353             $path .= '/';
 354         }
 355
 356         if ($path[0] != '/') {
 357             $path = '/'.$path;
 358         }
 359
 360         return $protocol.'://'.$server.$path.$filename;
 361     }
 362
 363     static $_enclosures = array();
 364
 365     function getEnclosure(){
 366         if (isset(self::$_enclosures[$this->getID()])) {
 367             common_debug('Found cached enclosure for file id=='.$this->getID());
 368             return self::$_enclosures[$this->getID()];
 369         }
 370
 371         $enclosure = (object) array();
 372         foreach (array('title', 'url', 'date', 'modified', 'size', 'mimetype') as $key) {
 373             $enclosure->$key = $this->$key;
 374         }
 375
 376         $needMoreMetadataMimetypes = array(null, 'application/xhtml+xml', 'text/html');
 377
 378         if (!isset($this->filename) && in_array(common_bare_mime($enclosure->mimetype), $needMoreMetadataMimetypes)) {
 379             // This fetches enclosure metadata for non-local links with unset/HTML mimetypes,
 380             // which may be enriched through oEmbed or similar (implemented as plugins)
 381             Event::handle('FileEnclosureMetadata', array($this, &$enclosure));
 382         }
 383         if (empty($enclosure->mimetype)) {
 384             // This means we either don't know what it is, so it can't
 385             // be shown as an enclosure, or it is an HTML link which
 386             // does not link to a resource with further metadata.
 387             throw new ServerException('Unknown enclosure mimetype, not enough metadata');
 388         }
 389
 390         self::$_enclosures[$this->getID()] = $enclosure;
 391         return $enclosure;
 392     }
 393
 394     public function hasThumbnail()
 395     {
 396         try {
 397             $this->getThumbnail();
 398         } catch (Exception $e) {
 399             return false;
 400         }
 401         return true;
 402     }
 403
 404     /**
 405      * Get the attachment's thumbnail record, if any.
 406      * Make sure you supply proper 'int' typed variables (or null).
 407      *
 408      * @param $width  int   Max width of thumbnail in pixels. (if null, use common_config values)
 409      * @param $height int   Max height of thumbnail in pixels. (if null, square-crop to $width)
 410      * @param $crop   bool  Crop to the max-values' aspect ratio
 411      *
 412      * @return File_thumbnail
 413      *
 414      * @throws UseFileAsThumbnailException  if the file is considered an image itself and should be itself as thumbnail
 415      * @throws UnsupportedMediaException    if, despite trying, we can't understand how to make a thumbnail for this format
 416      * @throws ServerException              on various other errors
 417      */
 418     public function getThumbnail($width=null, $height=null, $crop=false, $force_still=true)
 419     {
 420         // Get some more information about this file through our ImageFile class
 421         $image = ImageFile::fromFileObject($this);
 422         if ($image->animated && !common_config('thumbnail', 'animated')) {
 423             // null  means "always use file as thumbnail"
 424             // false means you get choice between frozen frame or original when calling getThumbnail
 425             if (is_null(common_config('thumbnail', 'animated')) || !$force_still) {
 426                 throw new UseFileAsThumbnailException($this->id);
 427             }
 428         }
 429
 430         return $image->getFileThumbnail($width, $height, $crop);
 431     }
 432
 433     public function getPath()
 434     {
 435         $filepath = self::path($this->filename);
 436         if (!file_exists($filepath)) {
 437             throw new FileNotFoundException($filepath);
 438         }
 439         return $filepath;
 440     }
 441
 442     public function getUrl($prefer_local=true)
 443     {
 444         if ($prefer_local && !empty($this->filename)) {
 445             // A locally stored file, so let's generate a URL for our instance.
 446             return self::url($this->filename);
 447         }
 448
 449         // No local filename available, return the URL we have stored
 450         return $this->url;
 451     }
 452
 453     static public function getByUrl($url)
 454     {
 455         $file = new File();
 456         $file->urlhash = self::hashurl($url);
 457         if (!$file->find(true)) {
 458             throw new NoResultException($file);
 459         }
 460         return $file;
 461     }
 462
 463     /**
 464      * @param   string  $hashstr    String of (preferrably lower case) hexadecimal characters, same as result of 'hash_file(...)'
 465      */
 466     static public function getByHash($hashstr)
 467     {
 468         $file = new File();
 469         $file->filehash = strtolower($hashstr);
 470         if (!$file->find(true)) {
 471             throw new NoResultException($file);
 472         }
 473         return $file;
 474     }
 475
 476     public function updateUrl($url)
 477     {
 478         $file = File::getKV('urlhash', self::hashurl($url));
 479         if ($file instanceof File) {
 480             throw new ServerException('URL already exists in DB');
 481         }
 482         $sql = 'UPDATE %1$s SET urlhash=%2$s, url=%3$s WHERE urlhash=%4$s;';
 483         $result = $this->query(sprintf($sql, $this->tableName(),
 484                                              $this->_quote((string)self::hashurl($url)),
 485                                              $this->_quote((string)$url),
 486                                              $this->_quote((string)$this->urlhash)));
 487         if ($result === false) {
 488             common_log_db_error($this, 'UPDATE', __FILE__);
 489             throw new ServerException("Could not UPDATE {$this->tableName()}.url");
 490         }
 491
 492         return $result;
 493     }
 494
 495     /**
 496      * Blow the cache of notices that link to this URL
 497      *
 498      * @param boolean $last Whether to blow the "last" cache too
 499      *
 500      * @return void
 501      */
 502
 503     function blowCache($last=false)
 504     {
 505         self::blow('file:notice-ids:%s', $this->id);
 506         if ($last) {
 507             self::blow('file:notice-ids:%s;last', $this->id);
 508         }
 509         self::blow('file:notice-count:%d', $this->id);
 510     }
 511
 512     /**
 513      * Stream of notices linking to this URL
 514      *
 515      * @param integer $offset   Offset to show; default is 0
 516      * @param integer $limit    Limit of notices to show
 517      * @param integer $since_id Since this notice
 518      * @param integer $max_id   Before this notice
 519      *
 520      * @return array ids of notices that link to this file
 521      */
 522
 523     function stream($offset=0, $limit=NOTICES_PER_PAGE, $since_id=0, $max_id=0)
 524     {
 525         $stream = new FileNoticeStream($this);
 526         return $stream->getNotices($offset, $limit, $since_id, $max_id);
 527     }
 528
 529     function noticeCount()
 530     {
 531         $cacheKey = sprintf('file:notice-count:%d', $this->id);
 532
 533         $count = self::cacheGet($cacheKey);
 534
 535         if ($count === false) {
 536
 537             $f2p = new File_to_post();
 538
 539             $f2p->file_id = $this->id;
 540
 541             $count = $f2p->count();
 542
 543             self::cacheSet($cacheKey, $count);
 544         }
 545
 546         return $count;
 547     }
 548
 549     public function isLocal()
 550     {
 551         return !empty($this->filename);
 552     }
 553
 554     public function delete($useWhere=false)
 555     {
 556         // Delete the file, if it exists locally
 557         if (!empty($this->filename) && file_exists(self::path($this->filename))) {
 558             $deleted = @unlink(self::path($this->filename));
 559             if (!$deleted) {
 560                 common_log(LOG_ERR, sprintf('Could not unlink existing file: "%s"', self::path($this->filename)));
 561             }
 562         }
 563
 564         // Clear out related things in the database and filesystem, such as thumbnails
 565         if (Event::handle('FileDeleteRelated', array($this))) {
 566             $thumbs = new File_thumbnail();
 567             $thumbs->file_id = $this->id;
 568             if ($thumbs->find()) {
 569                 while ($thumbs->fetch()) {
 570                     $thumbs->delete();
 571                 }
 572             }
 573
 574             $f2p = new File_to_post();
 575             $f2p->file_id = $this->id;
 576             if ($f2p->find()) {
 577                 while ($f2p->fetch()) {
 578                     $f2p->delete();
 579                 }
 580             }
 581         }
 582
 583         // And finally remove the entry from the database
 584         return parent::delete($useWhere);
 585     }
 586
 587     public function getTitle()
 588     {
 589         $title = $this->title ?: $this->filename;
 590
 591         return $title ?: null;
 592     }
 593
 594     static public function hashurl($url)
 595     {
 596         if (empty($url)) {
 597             throw new Exception('No URL provided to hash algorithm.');
 598         }
 599         return hash(self::URLHASH_ALG, $url);
 600     }
 601
 602     static public function beforeSchemaUpdate()
 603     {
 604         $table = strtolower(get_called_class());
 605         $schema = Schema::get();
 606         $schemadef = $schema->getTableDef($table);
 607
 608         // 2015-02-19 We have to upgrade our table definitions to have the urlhash field populated
 609         if (isset($schemadef['fields']['urlhash']) && isset($schemadef['unique keys']['file_urlhash_key'])) {
 610             // We already have the urlhash field, so no need to migrate it.
 611             return;
 612         }
 613         echo "\nFound old $table table, upgrading it to contain 'urlhash' field...";
 614
 615         $file = new File();
 616         $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)));
 617         print "\nFound {$file->N} URLs with too long entries in file table\n";
 618         while ($file->fetch()) {
 619             // We've got a URL that is too long for our future file table
 620             // so we'll cut it. We could save the original URL, but there is
 621             // no guarantee it is complete anyway since the previous max was 255 chars.
 622             $dupfile = new File();
 623             // First we find file entries that would be duplicates of this when shortened
 624             // ... and we'll just throw the dupes out the window for now! It's already so borken.
 625             $dupfile->query(sprintf('SELECT * FROM file WHERE LEFT(url, 191) = "%1$s"', $file->shortenedurl));
 626             // Leave one of the URLs in the database by using ->find(true) (fetches first entry)
 627             if ($dupfile->find(true)) {
 628                 print "\nShortening url entry for $table id: {$file->id} [";
 629                 $orig = clone($dupfile);
 630                 $dupfile->url = $file->shortenedurl;    // make sure it's only 191 chars from now on
 631                 $dupfile->update($orig);
 632                 print "\nDeleting duplicate entries of too long URL on $table id: {$file->id} [";
 633                 // only start deleting with this fetch.
 634                 while($dupfile->fetch()) {
 635                     print ".";
 636                     $dupfile->delete();
 637                 }
 638                 print "]\n";
 639             } else {
 640                 print "\nWarning! URL suddenly disappeared from database: {$file->url}\n";
 641             }
 642         }
 643         echo "...and now all the non-duplicates which are longer than 191 characters...\n";
 644         $file->query('UPDATE file SET url=LEFT(url, 191) WHERE LENGTH(url)>191');
 645
 646         echo "\n...now running hacky pre-schemaupdate change for $table:";
 647         // We have to create a urlhash that is _not_ the primary key,
 648         // transfer data and THEN run checkSchema
 649         $schemadef['fields']['urlhash'] = array (
 650                                               'type' => 'varchar',
 651                                               'length' => 64,
 652                                               'not null' => false,  // this is because when adding column, all entries will _be_ NULL!
 653                                               'description' => 'sha256 of destination URL (url field)',
 654                                             );
 655         $schemadef['fields']['url'] = array (
 656                                               'type' => 'text',
 657                                               'description' => 'destination URL after following possible redirections',
 658                                             );
 659         unset($schemadef['unique keys']);
 660         $schema->ensureTable($table, $schemadef);
 661         echo "DONE.\n";
 662
 663         $classname = ucfirst($table);
 664         $tablefix = new $classname;
 665         // urlhash is hash('sha256', $url) in the File table
 666         echo "Updating urlhash fields in $table table...";
 667         // Maybe very MySQL specific :(
 668         $tablefix->query(sprintf('UPDATE %1$s SET %2$s=%3$s;',
 669                             $schema->quoteIdentifier($table),
 670                             'urlhash',
 671                             // The line below is "result of sha256 on column `url`"
 672                             'SHA2(url, 256)'));
 673         echo "DONE.\n";
 674         echo "Resuming core schema upgrade...";
 675     }
 676 }