actions/redirecturl.php

   1 <?php
   2 /**
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2010, StatusNet, Inc.
   5  *
   6  * Redirect to the given URL
   7  *
   8  * PHP version 5
   9  *
  10  * This program is free software: you can redistribute it and/or modify
  11  * it under the terms of the GNU Affero General Public License as published by
  12  * the Free Software Foundation, either version 3 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Affero General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Affero General Public License
  21  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  22  *
  23  * @category  URL
  24  * @package   StatusNet
  25  * @author    Evan Prodromou <evan@status.net>
  26  * @copyright 2010 StatusNet, Inc.
  27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  28  * @link      http://status.net/
  29  */
  30
  31 if (!defined('STATUSNET')) {
  32     // This check helps protect against security problems;
  33     // your code file can't be executed directly from the web.
  34     exit(1);
  35 }
  36
  37 /**
  38  * Redirect to a given URL
  39  *
  40  * This is our internal low-budget URL-shortener
  41  *
  42  * @category  Action
  43  * @package   StatusNet
  44  * @author    Evan Prodromou <evan@status.net>
  45  * @copyright 2010 StatusNet, Inc.
  46  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  47  * @link      http://status.net/
  48  */
  49
  50 class RedirecturlAction extends Action
  51 {
  52     protected $id   = null;
  53     protected $file = null;
  54
  55     /**
  56      * For initializing members of the class.
  57      *
  58      * @param array $argarray misc. arguments
  59      *
  60      * @return boolean true
  61      */
  62     function prepare($argarray)
  63     {
  64         parent::prepare($argarray);
  65
  66         $this->id = $this->trimmed('id');
  67
  68         if (empty($this->id)) {
  69             // TRANS: Client exception thrown when no ID parameter was provided.
  70             throw new ClientException(_('No id parameter.'));
  71         }
  72
  73         $this->file = File::getKV('id', $this->id);
  74
  75         if (empty($this->file)) {
  76             // TRANS: Client exception thrown when an invalid ID parameter was provided for a file.
  77             // TRANS: %d is the provided ID for which the file is not present (number).
  78             throw new ClientException(sprintf(_('No such file "%d".'),
  79                                               $this->id),
  80                                       404);
  81         }
  82
  83         return true;
  84     }
  85
  86     /**
  87      * Handler method
  88      *
  89      * @param array $argarray is ignored since it's now passed in in prepare()
  90      *
  91      * @return void
  92      */
  93     function handle($argarray=null)
  94     {
  95         common_redirect($this->file->url, 307);
  96     }
  97
  98     /**
  99      * Return true if read only.
 100      *
 101      * MAY override
 102      *
 103      * @param array $args other arguments
 104      *
 105      * @return boolean is read only action?
 106      */
 107     function isReadOnly(array $args=array())
 108     {
 109         return true;
 110     }
 111
 112     /**
 113      * Return last modified, if applicable.
 114      *
 115      * MAY override
 116      *
 117      * @return string last modified http header
 118      */
 119     function lastModified()
 120     {
 121         // For comparison with If-Last-Modified
 122         // If not applicable, return null
 123
 124         return strtotime($this->file->modified);
 125     }
 126
 127     /**
 128      * Return etag, if applicable.
 129      *
 130      * MAY override
 131      *
 132      * @return string etag http header
 133      */
 134     function etag()
 135     {
 136         return 'W/"' . implode(':', array($this->arg('action'),
 137                                           common_user_cache_hash(),
 138                                           common_language(),
 139                                           $this->file->id)) . '"';
 140     }
 141 }