includes/paths.php

   1 <?php
   2 /*=====================================================================*\
   3 || ###################################################################
   4 || # ViewSVN [#]version[#]
   5 || # Copyright ©2002-[#]year[#] Iris Studios, Inc.
   6 || #
   7 || # This program is free software; you can redistribute it and/or modify
   8 || # it under the terms of the GNU General Public License as published by
   9 || # the Free Software Foundation; version [#]gpl[#] of the License.
  10 || #
  11 || # This program is distributed in the hope that it will be useful, but
  12 || # WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  13 || # or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
  14 || # more details.
  15 || #
  16 || # You should have received a copy of the GNU General Public License along
  17 || # with this program; if not, write to the Free Software Foundation, Inc.,
  18 || # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
  19 || ###################################################################
  20 \*=====================================================================*/
  21
  22 /**
  23 * Handles the various methods that are used to navigate
  24 * browser paths
  25 *
  26 * @package      ViewSVN
  27 */
  28
  29 /*
  30
  31 the majority of this stuff should go into the controller.
  32 the string creators may need to go into a static class or something. or not. we'll see.
  33
  34 */
  35
  36 /**
  37 * Path managing class that constructs and parses input
  38 * and output for paths. This is essentially a controller
  39 * of all current information.
  40 *
  41 * @package      ViewSVN
  42 * @version      $Id$
  43 */
  44 class Paths
  45 {
  46         /**
  47         * Path manager type
  48         * @var  integer
  49         */
  50         var $type;
  51
  52         /**
  53         * The universal path that is currently being browsed
  54         * @var  string
  55         */
  56         var $path;
  57
  58         /**
  59         * Current repository that we're in
  60         * @var  string
  61         */
  62         var $repos;
  63
  64         /**
  65         * Current internal path inside the repository
  66         * @var  string
  67         */
  68         var $relpath;
  69
  70         /**
  71         * The current revision number
  72         * @var  integer
  73         */
  74         var $revnum;
  75
  76         /**
  77         * The current revision as a string argument
  78         * @var  string
  79         */
  80         var $revstr;
  81
  82         /**
  83         * Constructor: determine the type of linking to use
  84         *
  85         * @param        integer Path management type
  86         */
  87         function Paths($type)
  88         {
  89                 global $viewsvn;
  90
  91                 if ($type < 1 OR $type > 2)
  92                 {
  93                         $viewsvn->trigger->error($viewsvn->lang->string('Invalid path management type specified in [includes/config.php]'));
  94                 }
  95
  96                 $this->type = (int)$type;
  97
  98                 $this->path = $this->parse();
  99                 $this->revnum = $this->revnum;
 100                 $this->revstr = $this->revstr;
 101         }
 102
 103         /**
 104         * Constructs a repository browser link
 105         *
 106         * @access       public
 107         *
 108         * @param        string  Base path
 109         * @param        string  Browser path, separated using '/'
 110         *
 111         * @return       string  Link path
 112         */
 113         function out($base, $addpath)
 114         {
 115                 global $viewsvn;
 116
 117                 $url = $this->fetch_arguments($base);
 118                 $addpath = $this->sanitize($addpath);
 119
 120                 // standard URL type
 121                 if ($this->type == 1)
 122                 {
 123                         return $url[0] . '?path=' . $addpath . ($url[1] ? '&amp;' . $url[1] : '');
 124                 }
 125                 // advanced path system
 126                 else if ($this->type == 2)
 127                 {
 128                         return $url[0] . ($addpath{0} != '/' ? '/' : '') . $addpath . ($url[1] ? '?' . $url[1] : '');
 129                 }
 130         }
 131
 132         /**
 133         * Parses an incoming path with the various methods
 134         * and returns a universal form
 135         *
 136         * @access       public
 137         *
 138         * @return       string  Universal path, separated using '/'
 139         */
 140         function parse()
 141         {
 142                 global $viewsvn;
 143
 144                 if (defined('PATH_OVERRIDE') AND PATH_OVERRIDE == 1)
 145                 {
 146                         return;
 147                 }
 148
 149                 // standard URL type
 150                 if ($this->type == 1)
 151                 {
 152                         $path = $viewsvn->in['path'];
 153                 }
 154                 // advanced path system
 155                 else if ($this->type == 2)
 156                 {
 157                         if (@$_SERVER['PATH_INFO'])
 158                         {
 159                                 $path = $viewsvn->sanitize($_SERVER['PATH_INFO']);
 160                         }
 161                         else
 162                         {
 163                                 $viewsvn->trigger->error($viewsvn->lang->string('Your server does not support type-2 path management'));
 164                         }
 165                 }
 166
 167                 if (!$path)
 168                 {
 169                         $viewsvn->trigger->error($viewsvn->lang->string('Invalid path sent'));
 170                 }
 171
 172                 if (!$viewsvn->repos->verify($this->repos = $this->fetch_repos($path), $this->relpath = $this->fetch_path($path)))
 173                 {
 174                         $viewsvn->trigger->error($viewsvn->lang->string('The path specified could not be verified'));
 175                 }
 176
 177                 return $path;
 178         }
 179
 180         /**
 181         * Returns the name of the repository from a upath
 182         *
 183         * @access       public
 184         *
 185         * @param        string  Universal path
 186         *
 187         * @return       string  Repository name
 188         */
 189         function fetch_repos($path)
 190         {
 191                 $temp = preg_split('#/#', $path, -1, PREG_SPLIT_NO_EMPTY);
 192                 return $temp[0];
 193         }
 194
 195         /**
 196         * Returns the path without the repository from a upath
 197         *
 198         * @access       public
 199         *
 200         * @param        string  Universal path
 201         * @param        bool    Preceding slash
 202         *
 203         * @return       string  Relative path
 204         */
 205         function fetch_path($path, $doslash = false)
 206         {
 207                 $temp = preg_split('#/#', $path, -1, PREG_SPLIT_NO_EMPTY);
 208                 unset($temp[0]);
 209                 return ($doslash ? '/' : '') . implode('/', $temp);
 210         }
 211
 212         /**
 213         * Fetches any URL parameters a link has
 214         *
 215         * @access       public
 216         *
 217         * @param        string  Original URL
 218         *
 219         * @return       array   Two-element array: base path (no trailing '?'), arguments
 220         */
 221         function fetch_arguments($url)
 222         {
 223                 $return = array();
 224
 225                 $bits = parse_url($url);
 226
 227                 if (isset($bits['query']))
 228                 {
 229                         $return[0] = $bits['path'];
 230                         $return[1] = $bits['query'];
 231                 }
 232                 else
 233                 {
 234                         $return[0] = $bits['path'];
 235                         $return[1] = '';
 236                 }
 237
 238                 return $return;
 239         }
 240
 241         /**
 242         * Determines if the root path has been reached
 243         *
 244         * @access       public
 245         *
 246         * @param        string  Universal path
 247         *
 248         * @return       bool    Root of path?
 249         */
 250         function is_root_path($path)
 251         {
 252                 $path = $this->fetch_path($path);
 253                 $temp = preg_split('#/#', $path, -1, PREG_SPLIT_NO_EMPTY);
 254                 if (count($temp) > 0)
 255                 {
 256                         return false;
 257                 }
 258                 else
 259                 {
 260                         return true;
 261                 }
 262         }
 263
 264         /**
 265         * Returns the current sanitized revision
 266         *
 267         * @access       public
 268         *
 269         * @param        bool    High-low or not
 270         * @param        mixed   High revision (or regular)
 271         * @param        mixed   Low revision
 272         *
 273         * @return       mixed   Revision number or HEAD
 274         */
 275         function fetch_rev_num($highlow = false, $high = null, $low = null)
 276         {
 277                 global $viewsvn;
 278
 279                 if ($highlow)
 280                 {
 281                         if (isset($viewsvn->in['high']) AND is_null($high))
 282                         {
 283                                 $high = $viewsvn->svn->rev($viewsvn->in['high']);
 284                         }
 285                         else if (is_null($high))
 286                         {
 287                                 $high = 'HEAD';
 288                         }
 289
 290                         if (isset($viewsvn->in['low']) AND is_null($low))
 291                         {
 292                                 $low = $viewsvn->svn->rev($viewsvn->in['low']);
 293                         }
 294                         else if (is_null($low))
 295                         {
 296                                 $low = 0;
 297                         }
 298
 299                         if ($low == 'HEAD')
 300                         {
 301                                 $low = 0;
 302                         }
 303
 304                         if (is_int($high) AND is_int($low) AND $low > $high)
 305                         {
 306                                 $temp = $high;
 307                                 $high = $low;
 308                                 $low = $temp;
 309                         }
 310
 311                         return array('high' => $high, 'low' => $low);
 312                 }
 313                 else
 314                 {
 315                         if (isset($viewsvn->in['rev']) AND is_null($high))
 316                         {
 317                                 $rev = $viewsvn->svn->rev($viewsvn->in['rev']);
 318                         }
 319                         else if (is_null($high))
 320                         {
 321                                 $rev = 'HEAD';
 322                         }
 323                         else
 324                         {
 325                                 $rev = $high;
 326                         }
 327
 328                         return $rev;
 329                 }
 330         }
 331
 332         /**
 333         * Returns a GET string with sanitized revision data
 334         *
 335         * @access       public
 336         *
 337         * @param        bool    High-low or not
 338         * @param        mixed   High revision (or regular)
 339         * @param        mixed   Low revision
 340         *
 341         * @return       string  Revision GET data
 342         */
 343         function fetch_rev_str($highlow = false, $high = null, $low = null)
 344         {
 345                 $rev = $this->fetch_rev_num($highlow, $high, $low);
 346
 347                 if ($highlow)
 348                 {
 349                         return '?low=' . $rev['low'] . '&amp;high=' . $rev['high'];
 350                 }
 351                 else
 352                 {
 353                         return '?rev=' . $rev;
 354                 }
 355         }
 356
 357         /**
 358         * Sanitizes a path for passing
 359         *
 360         * @access       private
 361         *
 362         * @param        string  Path
 363         *
 364         * @return       string  Cleaned string
 365         */
 366         function sanitize($path)
 367         {
 368                 return preg_replace('#[^a-z0-9\./\-_]*#i', '', $path);
 369         }
 370 }
 371
 372 /*=====================================================================*\
 373 || ###################################################################
 374 || # $HeadURL$
 375 || # $Id$
 376 || ###################################################################
 377 \*=====================================================================*/
 378 ?>