classes/File_redirection.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 require_once INSTALLDIR.'/classes/File.php';
  24 require_once INSTALLDIR.'/classes/File_oembed.php';
  25
  26 define('USER_AGENT', 'StatusNet user agent / file probe');
  27
  28 /**
  29  * Table Definition for file_redirection
  30  */
  31
  32 class File_redirection extends Memcached_DataObject
  33 {
  34     ###START_AUTOCODE
  35     /* the code below is auto generated do not remove the above tag */
  36
  37     public $__table = 'file_redirection';                // table name
  38     public $url;                             // varchar(255)  primary_key not_null
  39     public $file_id;                         // int(4)
  40     public $redirections;                    // int(4)
  41     public $httpcode;                        // int(4)
  42     public $modified;                        // timestamp()   not_null default_CURRENT_TIMESTAMP
  43
  44     /* Static get */
  45     function staticGet($k,$v=NULL) { return Memcached_DataObject::staticGet('File_redirection',$k,$v); }
  46
  47     /* the code above is auto generated do not remove the tag below */
  48     ###END_AUTOCODE
  49
  50     static function _commonHttp($url, $redirs) {
  51         $request = new HTTPClient($url);
  52         $request->setConfig(array(
  53             'connect_timeout' => 10, // # seconds to wait
  54             'max_redirs' => $redirs, // # max number of http redirections to follow
  55             'follow_redirects' => true, // Follow redirects
  56             'store_body' => false, // We won't need body content here.
  57         ));
  58         return $request;
  59     }
  60
  61     /**
  62      * Check if this URL is a redirect and return redir info.
  63      *
  64      * Most code should call File_redirection::where instead, to check if we
  65      * already know that redirection and avoid extra hits to the web.
  66      *
  67      * The URL is hit and any redirects are followed, up to 10 levels or until
  68      * a protected URL is reached.
  69      *
  70      * @param string $in_url
  71      * @return mixed one of:
  72      *         string - target URL, if this is a direct link or can't be followed
  73      *         array - redirect info if this is an *unknown* redirect:
  74      *              associative array with the following elements:
  75      *                code: HTTP status code
  76      *                redirects: count of redirects followed
  77      *                url: URL string of final target
  78      *                type (optional): MIME type from Content-Type header
  79      *                size (optional): byte size from Content-Length header
  80      *                time (optional): timestamp from Last-Modified header
  81      */
  82     public function lookupWhere($short_url, $redirs = 10, $protected = false) {
  83         if ($redirs < 0) return false;
  84
  85         if(strpos($short_url,'://') === false){
  86             return $short_url;
  87         }
  88         try {
  89             $request = self::_commonHttp($short_url, $redirs);
  90             // Don't include body in output
  91             $request->setMethod(HTTP_Request2::METHOD_HEAD);
  92             $response = $request->send();
  93
  94             if (405 == $response->getStatus() || 204 == $response->getStatus()) {
  95                 // HTTP 405 Unsupported Method
  96                 // Server doesn't support HEAD method? Can this really happen?
  97                 // We'll try again as a GET and ignore the response data.
  98                 //
  99                 // HTTP 204 No Content
 100                 // YFrog sends 204 responses back for our HEAD checks, which
 101                 // seems like it may be a logic error in their servers. If
 102                 // we get a 204 back, re-run it as a GET... if there's really
 103                 // no content it'll be cheap. :)
 104                 $request = self::_commonHttp($short_url, $redirs);
 105                 $response = $request->send();
 106             }
 107         } catch (Exception $e) {
 108             // Invalid URL or failure to reach server
 109             common_log(LOG_ERR, "Error while following redirects for $short_url: " . $e->getMessage());
 110             return $short_url;
 111         }
 112
 113         if ($response->getRedirectCount() && File::isProtected($response->getUrl())) {
 114             // Bump back up the redirect chain until we find a non-protected URL
 115             return self::lookupWhere($short_url, $response->getRedirectCount() - 1, true);
 116         }
 117
 118         $ret = array('code' => $response->getStatus()
 119                 , 'redirects' => $response->getRedirectCount()
 120                 , 'url' => $response->getUrl());
 121
 122         $type = $response->getHeader('Content-Type');
 123         if ($type) $ret['type'] = $type;
 124         if ($protected) $ret['protected'] = true;
 125         $size = $response->getHeader('Content-Length'); // @fixme bytes?
 126         if ($size) $ret['size'] = $size;
 127         $time = $response->getHeader('Last-Modified');
 128         if ($time) $ret['time'] = strtotime($time);
 129         return $ret;
 130     }
 131
 132     /**
 133      * Check if this URL is a redirect and return redir info.
 134      * If a File record is present for this URL, it is not considered a redirect.
 135      * If a File_redirection record is present for this URL, the recorded target is returned.
 136      *
 137      * If no File or File_redirect record is present, the URL is hit and any
 138      * redirects are followed, up to 10 levels or until a protected URL is
 139      * reached.
 140      *
 141      * @param string $in_url
 142      * @param boolean $discover true to attempt dereferencing the redirect if we don't know it already
 143      * @return mixed one of:
 144      *         string - target URL, if this is a direct link or a known redirect
 145      *         array - redirect info if this is an *unknown* redirect:
 146      *              associative array with the following elements:
 147      *                code: HTTP status code
 148      *                redirects: count of redirects followed
 149      *                url: URL string of final target
 150      *                type (optional): MIME type from Content-Type header
 151      *                size (optional): byte size from Content-Length header
 152      *                time (optional): timestamp from Last-Modified header
 153      */
 154     public function where($in_url, $discover=true) {
 155         // let's see if we know this...
 156         $a = File::staticGet('url', $in_url);
 157
 158         if (!empty($a)) {
 159             // this is a direct link to $a->url
 160             return $a->url;
 161         } else {
 162             $b = File_redirection::staticGet('url', $in_url);
 163             if (!empty($b)) {
 164                 // this is a redirect to $b->file_id
 165                 $a = File::staticGet('id', $b->file_id);
 166                 return $a->url;
 167             }
 168         }
 169
 170         if ($discover) {
 171             $ret = File_redirection::lookupWhere($in_url);
 172             return $ret;
 173         } else {
 174             // No manual dereferencing; leave the unknown URL as is.
 175             return $in_url;
 176         }
 177     }
 178
 179     /**
 180      * Shorten a URL with the current user's configured shortening
 181      * options, if applicable.
 182      *
 183      * If it cannot be shortened or the "short" URL is longer than the
 184      * original, the original is returned.
 185      *
 186      * If the referenced item has not been seen before, embedding data
 187      * may be saved.
 188      *
 189      * @param string $long_url
 190      * @param User $user whose shortening options to use; defaults to the current web session user
 191      * @return string
 192      */
 193     function makeShort($long_url, $user=null) {
 194
 195         $canon = File_redirection::_canonUrl($long_url);
 196
 197         $short_url = File_redirection::_userMakeShort($canon, $user);
 198
 199         // Did we get one? Is it shorter?
 200         if (!empty($short_url) && mb_strlen($short_url) < mb_strlen($long_url)) {
 201             return $short_url;
 202         } else {
 203             return $long_url;
 204         }
 205     }
 206
 207     function _userMakeShort($long_url, User $user=null) {
 208         $short_url = common_shorten_url($long_url, $user);
 209         if (!empty($short_url) && $short_url != $long_url) {
 210             $short_url = (string)$short_url;
 211             // store it
 212             $file = File::staticGet('url', $long_url);
 213             if (empty($file)) {
 214                 // Check if the target URL is itself a redirect...
 215                 $redir_data = File_redirection::where($long_url);
 216                 if (is_array($redir_data)) {
 217                     // We haven't seen the target URL before.
 218                     // Save file and embedding data about it!
 219                     $file = File::saveNew($redir_data, $long_url);
 220                     $file_id = $file->id;
 221                     if (!empty($redir_data['oembed']['json'])) {
 222                         File_oembed::saveNew($redir_data['oembed']['json'], $file_id);
 223                     }
 224                 } else if (is_string($redir_data)) {
 225                     // The file is a known redirect target.
 226                     $file = File::staticGet('url', $redir_data);
 227                     if (empty($file)) {
 228                         // @fixme should we save a new one?
 229                         // this case was triggering sometimes for redirects
 230                         // with unresolvable targets; found while fixing
 231                         // "can't linkify" bugs with shortened links to
 232                         // SSL sites with cert issues.
 233                         return null;
 234                     }
 235                     $file_id = $file->id;
 236                 }
 237             } else {
 238                 $file_id = $file->id;
 239             }
 240             $file_redir = File_redirection::staticGet('url', $short_url);
 241             if (empty($file_redir)) {
 242                 $file_redir = new File_redirection;
 243                 $file_redir->url = $short_url;
 244                 $file_redir->file_id = $file_id;
 245                 $file_redir->insert();
 246             }
 247             return $short_url;
 248         }
 249         return null;
 250     }
 251
 252     /**
 253      * Basic attempt to canonicalize a URL, cleaning up some standard variants
 254      * such as funny syntax or a missing path. Used internally when cleaning
 255      * up URLs for storage and following redirect chains.
 256      *
 257      * Note that despite being on File_redirect, this function DOES NOT perform
 258      * any dereferencing of redirects.
 259      *
 260      * @param string $in_url input URL
 261      * @param string $default_scheme if given a bare link; defaults to 'http://'
 262      * @return string
 263      */
 264     function _canonUrl($in_url, $default_scheme = 'http://') {
 265         if (empty($in_url)) return false;
 266         $out_url = $in_url;
 267         $p = parse_url($out_url);
 268         if (empty($p['host']) || empty($p['scheme'])) {
 269             list($scheme) = explode(':', $in_url, 2);
 270             switch ($scheme) {
 271             case 'fax':
 272             case 'tel':
 273                 $out_url = str_replace('.-()', '', $out_url);
 274                 break;
 275
 276             case 'mailto':
 277             case 'aim':
 278             case 'jabber':
 279             case 'xmpp':
 280                 // don't touch anything
 281                 break;
 282
 283             default:
 284                 $out_url = $default_scheme . ltrim($out_url, '/');
 285                 $p = parse_url($out_url);
 286                 if (empty($p['scheme'])) return false;
 287                 break;
 288             }
 289         }
 290
 291         if (('ftp' == $p['scheme']) || ('ftps' == $p['scheme']) || ('http' == $p['scheme']) || ('https' == $p['scheme'])) {
 292             if (empty($p['host'])) return false;
 293             if (empty($p['path'])) {
 294                 $out_url .= '/';
 295             }
 296         }
 297
 298         return $out_url;
 299     }
 300
 301     function saveNew($data, $file_id, $url) {
 302         $file_redir = new File_redirection;
 303         $file_redir->url = $url;
 304         $file_redir->file_id = $file_id;
 305         $file_redir->redirections = intval($data['redirects']);
 306         $file_redir->httpcode = intval($data['code']);
 307         $file_redir->insert();
 308     }
 309 }