interface/modules/zend_modules/library/Zend/Filter/UriNormalize.php

   1 <?php
   2 /**
   3  * Zend Framework (http://framework.zend.com/)
   4  *
   5  * @link      http://github.com/zendframework/zf2 for the canonical source repository
   6  * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
   7  * @license   http://framework.zend.com/license/new-bsd New BSD License
   8  */
   9
  10 namespace Zend\Filter;
  11
  12 use Zend\Filter\AbstractFilter;
  13 use Zend\Filter\Exception\InvalidArgumentException;
  14 use Zend\Uri\Exception\ExceptionInterface as UriException;
  15 use Zend\Uri\UriFactory;
  16 use Zend\Uri\Uri;
  17
  18 class UriNormalize extends AbstractFilter
  19 {
  20     /**
  21      * The default scheme to use when parsing scheme-less URIs
  22      *
  23      * @var string
  24      */
  25     protected $defaultScheme = null;
  26
  27     /**
  28      * Enforced scheme for scheme-less URIs. See setEnforcedScheme docs for info
  29      *
  30      * @var string
  31      */
  32     protected $enforcedScheme = null;
  33
  34     /**
  35      * Sets filter options
  36      *
  37      * @param array|\Traversable|null $options
  38      */
  39     public function __construct($options = null)
  40     {
  41         if ($options) {
  42             $this->setOptions($options);
  43         }
  44     }
  45
  46     /**
  47      * Set the default scheme to use when parsing scheme-less URIs
  48      *
  49      * The scheme used when parsing URIs may affect the specific object used to
  50      * normalize the URI and thus may affect the resulting normalize URI.
  51      *
  52      * @param  string $defaultScheme
  53      * @return self
  54      */
  55     public function setDefaultScheme($defaultScheme)
  56     {
  57         $this->defaultScheme = $defaultScheme;
  58         return $this;
  59     }
  60
  61     /**
  62      * Set a URI scheme to enforce on schemeless URIs
  63      *
  64      * This allows forcing input values such as 'www.example.com/foo' into
  65      * 'http://www.example.com/foo'.
  66      *
  67      * This should be used with caution, as a standard-compliant URI parser
  68      * would regard 'www.example.com' in the above input URI to be the path and
  69      * not host part of the URI. While this option can assist in solving
  70      * real-world user mishaps, it may yield unexpected results at times.
  71      *
  72      * @param  string $enforcedScheme
  73      * @return self
  74      */
  75     public function setEnforcedScheme($enforcedScheme)
  76     {
  77         $this->enforcedScheme = $enforcedScheme;
  78         return $this;
  79     }
  80
  81     /**
  82      * Filter the URL by normalizing it and applying a default scheme if set
  83      *
  84      * @param  string $value
  85      * @return string
  86      */
  87     public function filter($value)
  88     {
  89         $defaultScheme = $this->defaultScheme ?: $this->enforcedScheme;
  90
  91         // Reset default scheme if it is not a known scheme
  92         if (!UriFactory::getRegisteredSchemeClass($defaultScheme)) {
  93             $defaultScheme = null;
  94         }
  95
  96         try {
  97             $uri = UriFactory::factory($value, $defaultScheme);
  98             if ($this->enforcedScheme && (!$uri->getScheme())) {
  99                 $this->enforceScheme($uri);
 100             }
 101
 102         } catch (UriException $ex) {
 103             // We are unable to parse / enfore scheme with the given config and input
 104             return $value;
 105         }
 106
 107         $uri->normalize();
 108
 109         if (!$uri->isValid()) {
 110             return $value;
 111         }
 112
 113         return $uri->toString();
 114     }
 115
 116     /**
 117      * Enforce the defined scheme on the URI
 118      *
 119      * This will also adjust the host and path parts of the URI as expected in
 120      * the case of scheme-less network URIs
 121      *
 122      * @param Uri $uri
 123      */
 124     protected function enforceScheme(Uri $uri)
 125     {
 126         $path = $uri->getPath();
 127         if (strpos($path, '/') !== false) {
 128             list($host, $path) = explode('/', $path, 2);
 129             $path = '/' . $path;
 130         } else {
 131             $host = $path;
 132             $path = '';
 133         }
 134
 135         // We have nothing to do if we have no host
 136         if (!$host) {
 137             return;
 138         }
 139
 140         $uri->setScheme($this->enforcedScheme)
 141             ->setHost($host)
 142             ->setPath($path);
 143     }
 144 }