DMURI.php

<?php
#
# dmBridge: a data access framework for CONTENTdm(R)
#
# Copyright © 2009, 2010, 2011 Board of Regents of the Nevada System of Higher
# Education, on behalf of the University of Nevada, Las Vegas
#

class DMURI {

   private $fragment;

   private $host;

   private $password;

   private $path = "/";

   private $port = 80;

   protected $query = array();

   private $scheme = "http";

   private $user;

   public static function getLocalURIWithPath($path) {
      $uri = new DMURI(DMHTTPRequest::getCurrent()->getURI());
      $uri->setPath($path);
      return $uri;
   }

   public function __construct($uri = null) {
      if ($uri) {
         $this->setString($uri);
      }
   }

   public function __toString() {
      return (string) $this->getAbsoluteURIAsString();
   }

   public function equals($obj) {
      if (!$obj instanceof DMURI) {
         return false;
      }
      return ($obj->__toString() == $this->__toString());
   }

   public function getAbsoluteURIAsString() {
      if (!$this->getScheme() || !$this->getHost()) {
         return null;
      }

      $uri = $this->getScheme() . "://";
      if ($this->getUser()) {
         $uri .= $this->getUser();
      }
      if ($this->getPassword()) {
         $uri .= ":" . $this->getPassword();
      }
      if ($this->getUser() || $this->getPassword()) {
         $uri .= "@";
      }
      $uri .= $this->getHost();
      if ($this->getPort() != 80) {
         $uri .= ":" . $this->getPort();
      }
      $uri .= $this->getPath();
      if (count($this->getQuery())) {
         $uri .= "?" . $this->getQueryString();
      }
      if ($this->getFragment()) {
         $uri .= "#" . $this->getFragment();
      }
      return $uri;
   }

   public function getAbsoluteHostURI() {
      $uri = $this->getScheme() . "://";
      $uri .= $this->getHost();
      if ($this->getPort() != 80) {
         $uri .= ":" . $this->getPort();
      }
      return new DMURI($uri);
   }

   public function getFragment() {
      return $this->fragment;
   }

   public function setFragment($fragment) {
      $this->fragment = $fragment;
   }

   public function getHost() {
      return $this->host;
   }

   public function setHost($host) {
      $this->host = $host;
   }

   public function getPassword() {
      return $this->password;
   }

   public function setPassword($password) {
      $this->password = $password;
   }

   public function getPath() {
      return $this->path;
   }

   public function setPath($path) {
      $this->path = $path;
   }

   public function getPathComponents() {
      return explode("/", trim($this->path, "/"));
   }

   public function getPort() {
      return $this->port;
   }

   public function setPort($port) {
      $this->port = (int) $port;
   }

   public function addQueryValue($key, $value) {
      if (!is_null($value)) {
         $this->query[] = array(
            'key' => (string) $key,
            'value' => (string) $value
         );
      }
   }

   public function getQuery() {
      return $this->query;
   }

   public function getQueryString() {
      $query = array();
      foreach ($this->query as $var) {
         $query[] = urlencode($var['key']) . "=" . urlencode($var['value']);
      }
      return implode("&", $query);
   }

   public function setQueryString($str) {
      $pairs = explode("&", $str);
      foreach ($pairs as $pair) {
         $kv = explode("=", $pair);
         if (count($kv) == 2) {
            $this->addQueryValue($kv[0], $kv[1]);
         }
      }
   }

   public function setQueryValue($key, $value) {
      $this->unsetQueryKey($key);
      $this->addQueryValue($key, $value);
   }

   public function getScheme() {
      return $this->scheme;
   }

   public function setScheme($scheme) {
      $this->scheme = $scheme;
   }

   public function setString($str) {
      $tmp = parse_url($str);

      if (!is_array($tmp)) {
         throw new DMIllegalArgumentException(
               DMLocalizedString::getString("INVALID_URL"));
      }

      if (array_key_exists("scheme", $tmp)) {
         $this->setScheme($tmp['scheme']);
      }
      if (array_key_exists("host", $tmp)) {
         $this->setHost($tmp['host']);
      }
      if (array_key_exists("port", $tmp)) {
         $this->setPort($tmp['port']);
      }
      if (array_key_exists("user", $tmp)) {
         $this->setUser($tmp['user']);
      }
      if (array_key_exists("pass", $tmp)) {
         $this->setPassword($tmp['pass']);
      }
      if (array_key_exists("path", $tmp)) {
         $this->setPath($tmp['path']);
      }
      $this->unsetQuery();
      if (array_key_exists("query", $tmp)) {
         $q = explode("&", $tmp['query']);
         foreach ($q as $kv) {
            $parts = explode("=", $kv);
            if (count($parts) == 2) {
               $this->addQueryValue(
                     urldecode($parts[0]), urldecode($parts[1]));
            }
         }
      }
      if (array_key_exists("fragment", $tmp)) {
         $this->setFragment($tmp['fragment']);
      }
   }

   public function getUser() {
      return $this->user;
   }

   public function setUser($user) {
      $this->user = $user;
   }

   public function isValid() {
      $valid = true;
      if (!filter_var($this->__toString(), FILTER_VALIDATE_URL,
            FILTER_FLAG_SCHEME_REQUIRED)) {
         $valid = false;
      }
      if (!$this->getScheme()) {
         $valid = false;
      }
      if ($this->getPassword() && !$this->getUser()) {
         $valid = false;
      }
      return $valid;
   }

   public function getQueryValue($key) {
      foreach ($this->query as $q) {
         if ($q['key'] == $key) {
            return $q['value'];
         }
      }
      return null;
   }

   public function getQueryValues($key) {
      $values = array();
      foreach ($this->query as $q) {
         if ($q['key'] == $key) {
            $values[] = $q['value'];
         }
      }
      return $values;
   }

   public function unsetQuery() {
      $this->query = array();
   }

   public function unsetQueryKey($key) {
      $count = count($this->query);
      for ($i = 0; $i < $count; $i++) {
         if (array_key_exists($i, $this->query)
               && $this->query[$i]['key'] == $key) {
            unset($this->query[$i]);
         }
      }
   }

}