]> git.mxchange.org Git - quix0rs-gnu-social.git/blobdiff - classes/File_redirection.php
Merge remote-tracking branch 'upstream/master' into social-master
[quix0rs-gnu-social.git] / classes / File_redirection.php
index 292e6372a65374687385e2180254c57849ff4077..bc405311fef63365ff2132cc04bf271f4ef3895e 100644 (file)
@@ -29,7 +29,8 @@ class File_redirection extends Managed_DataObject
     /* the code below is auto generated do not remove the above tag */
 
     public $__table = 'file_redirection';                // table name
-    public $url;                             // varchar(255)  primary_key not_null
+    public $urlhash;                         // varchar(64) primary_key not_null
+    public $url;                             // text
     public $file_id;                         // int(4)
     public $redirections;                    // int(4)
     public $httpcode;                        // int(4)
@@ -38,23 +39,31 @@ class File_redirection extends Managed_DataObject
     /* the code above is auto generated do not remove the tag below */
     ###END_AUTOCODE
 
+    protected $file; /* Cache the associated file sometimes */
+
     public static function schemaDef()
     {
         return array(
             'fields' => array(
-                'url' => array('type' => 'varchar', 'length' => 255, 'not null' => true, 'description' => 'short URL (or any other kind of redirect) for file (id)'),
+                'urlhash' => array('type' => 'varchar', 'length' => 64, 'not null' => true, 'description' => 'sha256 hash of the URL'),
+                'url' => array('type' => 'text', 'description' => 'short URL (or any other kind of redirect) for file (id)'),
                 'file_id' => array('type' => 'int', 'description' => 'short URL for what URL/file'),
                 'redirections' => array('type' => 'int', 'description' => 'redirect count'),
                 'httpcode' => array('type' => 'int', 'description' => 'HTTP status code (20x, 30x, etc.)'),
                 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'),
             ),
-            'primary key' => array('url'),
+            'primary key' => array('urlhash'),
             'foreign keys' => array(
                 'file_redirection_file_id_fkey' => array('file' => array('file_id' => 'id')),
             ),
         );
     }
 
+    static public function getByUrl($url)
+    {
+        return self::getByPK(array('urlhash' => File::hashurl($url)));
+    }
+
     static function _commonHttp($url, $redirs) {
         $request = new HTTPClient($url);
         $request->setConfig(array(
@@ -87,7 +96,7 @@ class File_redirection extends Managed_DataObject
      *                size (optional): byte size from Content-Length header
      *                time (optional): timestamp from Last-Modified header
      */
-    public function lookupWhere($short_url, $redirs = 10, $protected = false) {
+    static function lookupWhere($short_url, $redirs = 10, $protected = false) {
         if ($redirs < 0) return false;
 
         if(strpos($short_url,'://') === false){
@@ -148,40 +157,55 @@ class File_redirection extends Managed_DataObject
      *
      * @param string $in_url
      * @param boolean $discover true to attempt dereferencing the redirect if we don't know it already
-     * @return mixed one of:
-     *         string - target URL, if this is a direct link or a known redirect
-     *         array - redirect info if this is an *unknown* redirect:
-     *              associative array with the following elements:
-     *                code: HTTP status code
-     *                redirects: count of redirects followed
-     *                url: URL string of final target
-     *                type (optional): MIME type from Content-Type header
-     *                size (optional): byte size from Content-Length header
-     *                time (optional): timestamp from Last-Modified header
+     * @return File_redirection
      */
-    public function where($in_url, $discover=true) {
-        // let's see if we know this...
-        $a = File::getKV('url', $in_url);
-
-        if (!empty($a)) {
-            // this is a direct link to $a->url
-            return $a->url;
-        } else {
-            $b = File_redirection::getKV('url', $in_url);
-            if (!empty($b)) {
-                // this is a redirect to $b->file_id
-                $a = File::getKV('id', $b->file_id);
-                return $a->url;
+    static function where($in_url, $discover=true) {
+        $redir = new File_redirection();
+        $redir->url = $in_url;
+        $redir->urlhash = File::hashurl($redir->url);
+        $redir->redirections = 0;
+
+        try {
+            $r = File_redirection::getByUrl($in_url);
+            if($r instanceof File_redirection) {
+                return $r;
+            }
+        } catch (NoResultException $e) {
+            try {
+                $f = File::getByUrl($in_url);
+                $redir->file_id = $f->id;
+                $redir->file = $f;
+                return $redir;
+            } catch (NoResultException $e) {
+                // Oh well, let's keep going
             }
         }
 
         if ($discover) {
-            $ret = File_redirection::lookupWhere($in_url);
-            return $ret;
-        } else {
-            // No manual dereferencing; leave the unknown URL as is.
-            return $in_url;
+            $redir_info = File_redirection::lookupWhere($in_url);
+            if(is_string($redir_info)) {
+                $redir_info = array('url' => $redir_info);
+            }
+
+            // Double check that we don't already have the resolved URL
+            $r = self::where($redir_info['url'], false);
+            if (!empty($r->file_id)) {
+                return $r;
+            }
+
+            $redir->httpcode = $redir_info['code'];
+            $redir->redirections = intval($redir_info['redirects']);
+            $redir->file = new File();
+            $redir->file->url = $redir_info['url'];
+            $redir->file->mimetype = $redir_info['type'];
+            $redir->file->size = isset($redir_info['size']) ? $redir_info['size'] : null;
+            $redir->file->date = isset($redir_info['time']) ? $redir_info['time'] : null;
+            if (isset($redir_info['protected']) && !empty($redir_info['protected'])) {
+                $redir->file->protected = true;
+            }
         }
+
+        return $redir;
     }
 
     /**
@@ -198,7 +222,7 @@ class File_redirection extends Managed_DataObject
      * @param User $user whose shortening options to use; defaults to the current web session user
      * @return string
      */
-    function makeShort($long_url, $user=null)
+    static function makeShort($long_url, $user=null)
     {
         $canon = File_redirection::_canonUrl($long_url);
 
@@ -206,11 +230,7 @@ class File_redirection extends Managed_DataObject
 
         // Did we get one? Is it shorter?
 
-        if (!empty($short_url)) {
-            return $short_url;
-        } else {
-            return $long_url;
-        }
+        return !empty($short_url) ? $short_url : $long_url;
     }
 
     /**
@@ -227,55 +247,39 @@ class File_redirection extends Managed_DataObject
      * @return string
      */
 
-    function forceShort($long_url, $user)
+    static function forceShort($long_url, $user)
     {
         $canon = File_redirection::_canonUrl($long_url);
 
         $short_url = File_redirection::_userMakeShort($canon, $user, true);
 
         // Did we get one? Is it shorter?
-        if (!empty($short_url)) {
-            return $short_url;
-        } else {
-            return $long_url;
-        }
+        return !empty($short_url) ? $short_url : $long_url;
     }
 
-    function _userMakeShort($long_url, User $user=null, $force = false) {
+    static function _userMakeShort($long_url, User $user=null, $force = false) {
         $short_url = common_shorten_url($long_url, $user, $force);
         if (!empty($short_url) && $short_url != $long_url) {
             $short_url = (string)$short_url;
             // store it
-            $file = File::getKV('url', $long_url);
-            if ($file instanceof File) {
-                $file_id = $file->id;
-            } else {
+            try {
+                $file = File::getByUrl($long_url);
+            } catch (NoResultException $e) {
                 // Check if the target URL is itself a redirect...
-                $redir_data = File_redirection::where($long_url);
-                if (is_array($redir_data)) {
-                    // We haven't seen the target URL before.
-                    // Save file and embedding data about it!
-                    $file = File::saveNew($redir_data, $long_url);
-                    $file_id = $file->id;
-                } else if (is_string($redir_data)) {
-                    // The file is a known redirect target.
-                    $file = File::getKV('url', $redir_data);
-                    if (empty($file)) {
-                        // @fixme should we save a new one?
-                        // this case was triggering sometimes for redirects
-                        // with unresolvable targets; found while fixing
-                        // "can't linkify" bugs with shortened links to
-                        // SSL sites with cert issues.
-                        return null;
-                    }
-                    $file_id = $file->id;
+                $redir = File_redirection::where($long_url);
+                $file = $redir->getFile();
+                if (empty($file->id)) {
+                    $file->saveFile();
                 }
             }
-            $file_redir = File_redirection::getKV('url', $short_url);
-            if (!$file_redir instanceof File_redirection) {
-                $file_redir = new File_redirection;
+            // Now we definitely have a File object in $file
+            try {
+                $file_redir = File_redirection::getByUrl($short_url);
+            } catch (NoResultException $e) {
+                $file_redir = new File_redirection();
+                $file_redir->urlhash = File::hashurl($short_url);
                 $file_redir->url = $short_url;
-                $file_redir->file_id = $file_id;
+                $file_redir->file_id = $file->getID();
                 $file_redir->insert();
             }
             return $short_url;
@@ -295,7 +299,7 @@ class File_redirection extends Managed_DataObject
      * @param string $default_scheme if given a bare link; defaults to 'http://'
      * @return string
      */
-    function _canonUrl($in_url, $default_scheme = 'http://') {
+    static function _canonUrl($in_url, $default_scheme = 'http://') {
         if (empty($in_url)) return false;
         $out_url = $in_url;
         $p = parse_url($out_url);
@@ -308,6 +312,7 @@ class File_redirection extends Managed_DataObject
                 break;
 
             case 'mailto':
+            case 'magnet':
             case 'aim':
             case 'jabber':
             case 'xmpp':
@@ -332,12 +337,63 @@ class File_redirection extends Managed_DataObject
         return $out_url;
     }
 
-    function saveNew(array $data, $file_id, $url) {
+    static function saveNew(array $data, $file_id, $url) {
         $file_redir = new File_redirection;
+        $file_redir->urlhash = File::hashurl($url);
         $file_redir->url = $url;
         $file_redir->file_id = $file_id;
         $file_redir->redirections = intval($data['redirects']);
         $file_redir->httpcode = intval($data['code']);
         $file_redir->insert();
     }
+
+    static public function beforeSchemaUpdate()
+    {
+        $table = strtolower(get_called_class());
+        $schema = Schema::get();
+        $schemadef = $schema->getTableDef($table);
+
+        // 2015-02-19 We have to upgrade our table definitions to have the urlhash field populated
+        if (isset($schemadef['fields']['urlhash']) && in_array('urlhash', $schemadef['primary key'])) {
+            // We already have the urlhash field, so no need to migrate it.
+            return;
+        }
+        echo "\nFound old $table table, upgrading it to contain 'urlhash' field...";
+        // We have to create a urlhash that is _not_ the primary key,
+        // transfer data and THEN run checkSchema
+        $schemadef['fields']['urlhash'] = array (
+                                              'type' => 'varchar',
+                                              'length' => 64,
+                                              'not null' => true,
+                                              'description' => 'sha256 hash of the URL',
+                                            );
+        $schemadef['fields']['url'] = array (
+                                              'type' => 'text',
+                                              'description' => 'short URL (or any other kind of redirect) for file (id)',
+                                            );
+        unset($schemadef['primary key']);
+        $schema->ensureTable($table, $schemadef);
+        echo "DONE.\n";
+
+        $classname = ucfirst($table);
+        $tablefix = new $classname;
+        // urlhash is hash('sha256', $url) in the File table
+        echo "Updating urlhash fields in $table table...";
+        // Maybe very MySQL specific :(
+        $tablefix->query(sprintf('UPDATE %1$s SET %2$s=%3$s;',
+                            $schema->quoteIdentifier($table),
+                            'urlhash',
+                            // The line below is "result of sha256 on column `url`"
+                            'SHA2(url, 256)'));
+        echo "DONE.\n";
+        echo "Resuming core schema upgrade...";
+    }
+
+    public function getFile() {
+        if(empty($this->file) && $this->file_id) {
+            $this->file = File::getKV('id', $this->file_id);
+        }
+
+        return $this->file;
+    }
 }