3 * StatusNet - the distributed open-source microblogging tool
4 * Copyright (C) 2008, 2009, StatusNet, Inc.
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.
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.
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/>.
20 if (!defined('GNUSOCIAL')) { exit(1); }
23 * Table Definition for file_redirection
26 class File_redirection extends Managed_DataObject
29 /* the code below is auto generated do not remove the above tag */
31 public $__table = 'file_redirection'; // table name
32 public $urlhash; // varchar(64) primary_key not_null
34 public $file_id; // int(4)
35 public $redirections; // int(4)
36 public $httpcode; // int(4)
37 public $modified; // timestamp() not_null default_CURRENT_TIMESTAMP
39 /* the code above is auto generated do not remove the tag below */
42 protected $file; /* Cache the associated file sometimes */
44 public static function schemaDef()
48 'urlhash' => array('type' => 'varchar', 'length' => 64, 'not null' => true, 'description' => 'sha256 hash of the URL'),
49 'url' => array('type' => 'text', 'description' => 'short URL (or any other kind of redirect) for file (id)'),
50 'file_id' => array('type' => 'int', 'description' => 'short URL for what URL/file'),
51 'redirections' => array('type' => 'int', 'description' => 'redirect count'),
52 'httpcode' => array('type' => 'int', 'description' => 'HTTP status code (20x, 30x, etc.)'),
53 'modified' => array('type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'),
55 'primary key' => array('urlhash'),
56 'foreign keys' => array(
57 'file_redirection_file_id_fkey' => array('file' => array('file_id' => 'id')),
62 static public function getByUrl($url)
64 return self::getByPK(array('urlhash' => File::hashurl($url)));
67 static function _commonHttp($url, $redirs) {
68 $request = new HTTPClient($url);
69 $request->setConfig(array(
70 'connect_timeout' => 10, // # seconds to wait
71 'max_redirs' => $redirs, // # max number of http redirections to follow
72 'follow_redirects' => true, // Follow redirects
73 'store_body' => false, // We won't need body content here.
79 * Check if this URL is a redirect and return redir info.
81 * Most code should call File_redirection::where instead, to check if we
82 * already know that redirection and avoid extra hits to the web.
84 * The URL is hit and any redirects are followed, up to 10 levels or until
85 * a protected URL is reached.
87 * @param string $in_url
88 * @return mixed one of:
89 * string - target URL, if this is a direct link or can't be followed
90 * array - redirect info if this is an *unknown* redirect:
91 * associative array with the following elements:
92 * code: HTTP status code
93 * redirects: count of redirects followed
94 * url: URL string of final target
95 * type (optional): MIME type from Content-Type header
96 * size (optional): byte size from Content-Length header
97 * time (optional): timestamp from Last-Modified header
99 static function lookupWhere($short_url, $redirs = 10, $protected = false) {
100 if ($redirs < 0) return false;
102 if(strpos($short_url,'://') === false){
106 $request = self::_commonHttp($short_url, $redirs);
107 // Don't include body in output
108 $request->setMethod(HTTP_Request2::METHOD_HEAD);
109 $response = $request->send();
111 if (405 == $response->getStatus() || 204 == $response->getStatus()) {
112 // HTTP 405 Unsupported Method
113 // Server doesn't support HEAD method? Can this really happen?
114 // We'll try again as a GET and ignore the response data.
116 // HTTP 204 No Content
117 // YFrog sends 204 responses back for our HEAD checks, which
118 // seems like it may be a logic error in their servers. If
119 // we get a 204 back, re-run it as a GET... if there's really
120 // no content it'll be cheap. :)
121 $request = self::_commonHttp($short_url, $redirs);
122 $response = $request->send();
124 } catch (Exception $e) {
125 // Invalid URL or failure to reach server
126 common_log(LOG_ERR, "Error while following redirects for $short_url: " . $e->getMessage());
130 if ($response->getRedirectCount() && File::isProtected($response->getUrl())) {
131 // Bump back up the redirect chain until we find a non-protected URL
132 return self::lookupWhere($short_url, $response->getRedirectCount() - 1, true);
135 $ret = array('code' => $response->getStatus()
136 , 'redirects' => $response->getRedirectCount()
137 , 'url' => $response->getUrl());
139 $type = $response->getHeader('Content-Type');
140 if ($type) $ret['type'] = $type;
141 if ($protected) $ret['protected'] = true;
142 $size = $response->getHeader('Content-Length'); // @fixme bytes?
143 if ($size) $ret['size'] = $size;
144 $time = $response->getHeader('Last-Modified');
145 if ($time) $ret['time'] = strtotime($time);
150 * Check if this URL is a redirect and return redir info.
151 * If a File record is present for this URL, it is not considered a redirect.
152 * If a File_redirection record is present for this URL, the recorded target is returned.
154 * If no File or File_redirect record is present, the URL is hit and any
155 * redirects are followed, up to 10 levels or until a protected URL is
158 * @param string $in_url
159 * @param boolean $discover true to attempt dereferencing the redirect if we don't know it already
160 * @return File_redirection
162 static function where($in_url, $discover=true) {
163 $redir = new File_redirection();
164 $redir->url = $in_url;
165 $redir->urlhash = File::hashurl($redir->url);
166 $redir->redirections = 0;
169 $r = File_redirection::getByUrl($in_url);
170 if($r instanceof File_redirection) {
173 } catch (NoResultException $e) {
175 $f = File::getByUrl($in_url);
176 $redir->file_id = $f->id;
179 } catch (NoResultException $e) {
180 // Oh well, let's keep going
185 $redir_info = File_redirection::lookupWhere($in_url);
186 if(is_string($redir_info)) {
187 $redir_info = array('url' => $redir_info);
190 // Double check that we don't already have the resolved URL
191 $r = self::where($redir_info['url'], false);
192 if (!empty($r->file_id)) {
196 $redir->httpcode = $redir_info['code'];
197 $redir->redirections = intval($redir_info['redirects']);
198 $redir->redir_url = $redir_info['url'];
199 $redir->file = new File();
200 $redir->file->url = $redir_info['url'];
201 $redir->file->mimetype = $redir_info['type'];
202 $redir->file->size = isset($redir_info['size']) ? $redir_info['size'] : null;
203 $redir->file->date = isset($redir_info['time']) ? $redir_info['time'] : null;
204 if (isset($redir_info['protected']) && !empty($redir_info['protected'])) {
205 $redir->file->protected = true;
213 * Shorten a URL with the current user's configured shortening
214 * options, if applicable.
216 * If it cannot be shortened or the "short" URL is longer than the
217 * original, the original is returned.
219 * If the referenced item has not been seen before, embedding data
222 * @param string $long_url
223 * @param User $user whose shortening options to use; defaults to the current web session user
226 static function makeShort($long_url, $user=null)
228 $canon = File_redirection::_canonUrl($long_url);
230 $short_url = File_redirection::_userMakeShort($canon, $user);
232 // Did we get one? Is it shorter?
234 return !empty($short_url) ? $short_url : $long_url;
238 * Shorten a URL with the current user's configured shortening
239 * options, if applicable.
241 * If it cannot be shortened or the "short" URL is longer than the
242 * original, the original is returned.
244 * If the referenced item has not been seen before, embedding data
247 * @param string $long_url
251 static function forceShort($long_url, $user)
253 $canon = File_redirection::_canonUrl($long_url);
255 $short_url = File_redirection::_userMakeShort($canon, $user, true);
257 // Did we get one? Is it shorter?
258 return !empty($short_url) ? $short_url : $long_url;
261 static function _userMakeShort($long_url, User $user=null, $force = false) {
262 $short_url = common_shorten_url($long_url, $user, $force);
263 if (!empty($short_url) && $short_url != $long_url) {
264 $short_url = (string)$short_url;
267 $file = File::getByUrl($long_url);
268 } catch (NoResultException $e) {
269 // Check if the target URL is itself a redirect...
270 $redir = File_redirection::where($long_url);
271 $file = $redir->getFile();
272 if (empty($file->id)) {
276 // Now we definitely have a File object in $file
278 $file_redir = File_redirection::getByUrl($short_url);
279 } catch (NoResultException $e) {
280 $file_redir = new File_redirection();
281 $file_redir->urlhash = File::hashurl($short_url);
282 $file_redir->url = $short_url;
283 $file_redir->file_id = $file->getID();
284 $file_redir->insert();
292 * Basic attempt to canonicalize a URL, cleaning up some standard variants
293 * such as funny syntax or a missing path. Used internally when cleaning
294 * up URLs for storage and following redirect chains.
296 * Note that despite being on File_redirect, this function DOES NOT perform
297 * any dereferencing of redirects.
299 * @param string $in_url input URL
300 * @param string $default_scheme if given a bare link; defaults to 'http://'
303 static function _canonUrl($in_url, $default_scheme = 'http://') {
304 if (empty($in_url)) return false;
306 $p = parse_url($out_url);
307 if (empty($p['host']) || empty($p['scheme'])) {
308 list($scheme) = explode(':', $in_url, 2);
309 switch (strtolower($scheme)) {
312 $out_url = str_replace('.-()', '', $out_url);
320 // don't touch anything
324 $out_url = $default_scheme . ltrim($out_url, '/');
325 $p = parse_url($out_url);
326 if (empty($p['scheme'])) return false;
331 if (('ftp' == $p['scheme']) || ('ftps' == $p['scheme']) || ('http' == $p['scheme']) || ('https' == $p['scheme'])) {
332 if (empty($p['host'])) return false;
333 if (empty($p['path'])) {
341 static function saveNew(array $data, $file_id, $url) {
342 $file_redir = new File_redirection;
343 $file_redir->urlhash = File::hashurl($url);
344 $file_redir->url = $url;
345 $file_redir->file_id = $file_id;
346 $file_redir->redirections = intval($data['redirects']);
347 $file_redir->httpcode = intval($data['code']);
348 $file_redir->insert();
351 static public function beforeSchemaUpdate()
353 $table = strtolower(get_called_class());
354 $schema = Schema::get();
355 $schemadef = $schema->getTableDef($table);
357 // 2015-02-19 We have to upgrade our table definitions to have the urlhash field populated
358 if (isset($schemadef['fields']['urlhash']) && in_array('urlhash', $schemadef['primary key'])) {
359 // We already have the urlhash field, so no need to migrate it.
362 echo "\nFound old $table table, upgrading it to contain 'urlhash' field...";
363 // We have to create a urlhash that is _not_ the primary key,
364 // transfer data and THEN run checkSchema
365 $schemadef['fields']['urlhash'] = array (
369 'description' => 'sha256 hash of the URL',
371 $schemadef['fields']['url'] = array (
373 'description' => 'short URL (or any other kind of redirect) for file (id)',
375 unset($schemadef['primary key']);
376 $schema->ensureTable($table, $schemadef);
379 $classname = ucfirst($table);
380 $tablefix = new $classname;
381 // urlhash is hash('sha256', $url) in the File table
382 echo "Updating urlhash fields in $table table...";
383 // Maybe very MySQL specific :(
384 $tablefix->query(sprintf('UPDATE %1$s SET %2$s=%3$s;',
385 $schema->quoteIdentifier($table),
387 // The line below is "result of sha256 on column `url`"
390 echo "Resuming core schema upgrade...";
393 public function getFile() {
394 if(empty($this->file) && $this->file_id) {
395 $this->file = File::getKV('id', $this->file_id);