silverstripe / multi-domain

code/MultiDomainRequestFilter.php

Indentation +50 added lines, -50 removed lines

@@ -9,60 +9,60 @@
 class MultiDomainRequestFilter implements RequestFilter
 {
 
-    /**
-     * Gets the active domain, and sets its URL to the native one, with a vanity
-     * URL in the request
-     *
-     * @param  SS_HTTPRequest $request
-     * @param  Session        $session
-     * @param  DataModel      $model
-     */
-    public function preRequest(SS_HTTPRequest $request, Session $session, DataModel $model)
-    {
+	/**
+	 * Gets the active domain, and sets its URL to the native one, with a vanity
+	 * URL in the request
+	 *
+	 * @param  SS_HTTPRequest $request
+	 * @param  Session        $session
+	 * @param  DataModel      $model
+	 */
+	public function preRequest(SS_HTTPRequest $request, Session $session, DataModel $model)
+	{
 
-        if (Director::is_cli()) {
-            return;
-        }
+		if (Director::is_cli()) {
+			return;
+		}
         
-        // Not the best place for validation, but _config.php is too early.
-        if (!MultiDomain::get_primary_domain()) {
-            throw new Exception('MultiDomain must define a "'.MultiDomain::KEY_PRIMARY.'" domain in the config, under "domains"');
-        }
+		// Not the best place for validation, but _config.php is too early.
+		if (!MultiDomain::get_primary_domain()) {
+			throw new Exception('MultiDomain must define a "'.MultiDomain::KEY_PRIMARY.'" domain in the config, under "domains"');
+		}
                     
-        foreach (MultiDomain::get_all_domains() as $domain) {
-            if (!$domain->isActive()) {
-                continue;
-            }
+		foreach (MultiDomain::get_all_domains() as $domain) {
+			if (!$domain->isActive()) {
+				continue;
+			}
             
-            $url = $this->createNativeURLForDomain($domain);
-            $parts = explode('?', $url);
-            $request->setURL($parts[0]);
-        }
-    }
+			$url = $this->createNativeURLForDomain($domain);
+			$parts = explode('?', $url);
+			$request->setURL($parts[0]);
+		}
+	}
 
-    /**
-     * Post request noop
-     * @param  SS_HTTPRequest  $request
-     * @param  SS_HTTPResponse $response
-     * @param  DataModel       $model
-     */
-    public function postRequest(SS_HTTPRequest $request, SS_HTTPResponse $response, DataModel $model)
-    {
-    }
+	/**
+	 * Post request noop
+	 * @param  SS_HTTPRequest  $request
+	 * @param  SS_HTTPResponse $response
+	 * @param  DataModel       $model
+	 */
+	public function postRequest(SS_HTTPRequest $request, SS_HTTPResponse $response, DataModel $model)
+	{
+	}
 
-    /**
-     * Creates a native URL for a domain. This functionality is abstracted so
-     * that other modules can overload it, e.g. translatable modules that
-     * have their own custom URLs.
-     *
-     * @param  MultiDomainDomain $domain
-     * @return string
-     */
-    protected function createNativeURLForDomain(MultiDomainDomain $domain)
-    {
-        return Controller::join_links(
-            Director::baseURL(),
-            $domain->getNativeURL($_SERVER['REQUEST_URI'])
-        );
-    }
+	/**
+	 * Creates a native URL for a domain. This functionality is abstracted so
+	 * that other modules can overload it, e.g. translatable modules that
+	 * have their own custom URLs.
+	 *
+	 * @param  MultiDomainDomain $domain
+	 * @return string
+	 */
+	protected function createNativeURLForDomain(MultiDomainDomain $domain)
+	{
+		return Controller::join_links(
+			Director::baseURL(),
+			$domain->getNativeURL($_SERVER['REQUEST_URI'])
+		);
+	}
 }

code/MultiDomain.php

Indentation +63 added lines, -63 removed lines

@@ -10,75 +10,75 @@
 class MultiDomain extends Object
 {
 
-    /**
-     * The key for the "primary" domain
-     */
-    const KEY_PRIMARY = 'primary';
+	/**
+	 * The key for the "primary" domain
+	 */
+	const KEY_PRIMARY = 'primary';
 
-    /**
-     * Given a url, get the domain that maps to it, e.g.
-     *
-     * /company/ -> silverstripe.com
-     * /company/partners -> silverstripe.com
-     * /community/forum -> silverstripe.org
-     *
-     * @param  string $url
-     * @return MultiDomainDomain
-     */
-    public static function domain_for_url($url)
-    {
-        $url = trim($url, '/');
+	/**
+	 * Given a url, get the domain that maps to it, e.g.
+	 *
+	 * /company/ -> silverstripe.com
+	 * /company/partners -> silverstripe.com
+	 * /community/forum -> silverstripe.org
+	 *
+	 * @param  string $url
+	 * @return MultiDomainDomain
+	 */
+	public static function domain_for_url($url)
+	{
+		$url = trim($url, '/');
 
-        foreach (self::get_all_domains() as $domain) {
-            if ($domain->hasURL($url)) {
-                return $domain;
-            }
-        }
+		foreach (self::get_all_domains() as $domain) {
+			if ($domain->hasURL($url)) {
+				return $domain;
+			}
+		}
 
-        return self::get_primary_domain();
-    }
+		return self::get_primary_domain();
+	}
 
-    /**
-     * Gets all the domains that have been configured
-     *
-     * @param  boolean $includePrimary If true, include the primary domain
-     * @return array
-     */
-    public static function get_all_domains($includePrimary = false)
-    {
-        $domains = array ();
+	/**
+	 * Gets all the domains that have been configured
+	 *
+	 * @param  boolean $includePrimary If true, include the primary domain
+	 * @return array
+	 */
+	public static function get_all_domains($includePrimary = false)
+	{
+		$domains = array ();
 
-        foreach (self::config()->domains as $key => $config) {
-            if (!$includePrimary && $key === self::KEY_PRIMARY) {
-                continue;
-            }
-            $domains[] = MultiDomainDomain::create($key, $config);
-        }
+		foreach (self::config()->domains as $key => $config) {
+			if (!$includePrimary && $key === self::KEY_PRIMARY) {
+				continue;
+			}
+			$domains[] = MultiDomainDomain::create($key, $config);
+		}
 
-        return $domains;
-    }
+		return $domains;
+	}
 
-    /**
-     * Gets the domain marked as "primary"
-     * @return MultiDomainDomain
-     */
-    public static function get_primary_domain()
-    {
-        return self::get_domain(self::KEY_PRIMARY);
-    }
+	/**
+	 * Gets the domain marked as "primary"
+	 * @return MultiDomainDomain
+	 */
+	public static function get_primary_domain()
+	{
+		return self::get_domain(self::KEY_PRIMARY);
+	}
 
-    /**
-     * Gets a domain by its key, e.g. 'org','com'
-     * @param  string $domain
-     * @return MultiDomainDomain
-     */
-    public static function get_domain($domain)
-    {
-        if (isset(self::config()->domains[$domain])) {
-            return MultiDomainDomain::create(
-                $domain,
-                self::config()->domains[$domain]
-            );
-        }
-    }
+	/**
+	 * Gets a domain by its key, e.g. 'org','com'
+	 * @param  string $domain
+	 * @return MultiDomainDomain
+	 */
+	public static function get_domain($domain)
+	{
+		if (isset(self::config()->domains[$domain])) {
+			return MultiDomainDomain::create(
+				$domain,
+				self::config()->domains[$domain]
+			);
+		}
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -46,7 +46,7 @@
      */
     public static function get_all_domains($includePrimary = false)
     {
-        $domains = array ();
+        $domains = array();
 
         foreach (self::config()->domains as $key => $config) {
             if (!$includePrimary && $key === self::KEY_PRIMARY) {

code/MultiDomainDomain.php

Indentation +271 added lines, -271 removed lines

@@ -9,275 +9,275 @@
 class MultiDomainDomain extends Object
 {
 
-    /**
-     * The hostname of the domain, e.g. silverstripe.org
-     * @var string
-     */
-    protected $hostname;
-
-    /**
-     * The path that the hostname resolves to
-     * @var string
-     */
-    protected $url;
-
-    /**
-     * The identifier of the domain, e.g. 'org','com'
-     * @var string
-     */
-    protected $key;
-
-    /**
-     * Paths that are allowed to be accessed on the primary domain
-     * @var array
-     */
-    protected $allowedPaths;
-
-    /**
-     * Paths that are forced from the primary domain into a vanity one,
-     * outside the resolves_to path
-     *
-     * @var array
-     */
-    protected $forcedPaths;
-
-    /**
-     * The request URI
-     *
-     * @var string
-     */
-    protected $requestUri;
-
-    /**
-     * The request HTTP HOST
-     *
-     * @var string
-     */
-    protected $httpHost;
-
-    /**
-     * Constructor. Takes a key for the domain and its array of settings from the config
-     * @param string $key
-     * @param array $config
-     */
-    public function __construct($key, $config)
-    {
-        $this->key = $key;
-        $this->hostname = $config['hostname'];
-        $this->url = isset($config['resolves_to']) ? $config['resolves_to'] : null;
-
-        $globalAllowed = (array) Config::inst()->get('MultiDomain', 'allow');
-        $globalForced = (array) Config::inst()->get('MultiDomain', 'force');
-        $myAllowed = isset($config['allow']) ? $config['allow'] : array ();
-        $myForced = isset($config['force']) ? $config['force'] : array ();
-        $this->allowedPaths = array_merge($globalAllowed, $myAllowed);
-        $this->forcedPaths = array_merge($globalForced, $myForced);
-
-        parent::__construct();
-    }
-
-    /**
-     * Gets the hostname for the domain
-     * @return string
-     */
-    public function getHostname()
-    {
-        return defined($this->hostname) ? constant($this->hostname) : $this->hostname;
-    }
-
-    /**
-     * Gets the path that the hostname resolves to
-     * @return string
-     */
-    public function getURL()
-    {
-        return $this->url;
-    }
-
-    /**
-     * Returns true if the domain is currently in the HTTP_HOST
-     * @return boolean
-     */
-    public function isActive()
-    {
-        if ($this->isAllowedPath($this->getRequestUri())) {
-            return false;
-        }
-
-        $currentHost = $this->getHttpHost();
-        if (strpos(':', $currentHost) !== false) {
-            list($currentHost, $currentPort) = explode(':', $currentHost, 2);
-        }
-
-        $allow_subdomains = MultiDomain::config()->allow_subdomains;
-        $hostname = $this->getHostname();
-
-        return $allow_subdomains ?
-                    (bool) preg_match('/(\.|^)'.$hostname.'$/', $currentHost) :
-                    ($currentHost == $hostname);
-    }
-
-    /**
-     * Returns true if this domain is the primary domain
-     * @return boolean
-     */
-    public function isPrimary()
-    {
-        return $this->key === MultiDomain::KEY_PRIMARY;
-    }
-
-    /**
-     * Gets the native URL for a vanity domain, e.g. /partners/ for .com
-     * returns /company/partners when .com is mapped to /company/.
-     *
-     * @param  string $url
-     * @return string
-     */
-    public function getNativeURL($url)
-    {
-        if ($this->isPrimary()) {
-            throw new Exception("Cannot convert a native URL on the primary domain");
-        }
-
-        if ($this->isAllowedPath($url) || $this->isForcedPath($url)) {
-            return $url;
-        }
-
-        return Controller::join_links($this->getURL(), $url);
-    }
-
-    /**
-     * Gets the vanity URL given a native URL. /company/partners returns /partners/
-     * when .com is mapped to /company/.
-     *
-     * @param  string $url
-     * @return string
-     */
-    public function getVanityURL($url)
-    {
-        if ($this->isPrimary() || $this->isAllowedPath($url)) {
-            return $url;
-        }
-
-        $domainUrl = str_replace('/', '\/', $this->getURL());
-        return preg_replace('/^\/?' . $domainUrl . '\//', '', $url);
-    }
-
-    /**
-     * Return true if this domain contains the given URL
-     * @param  string  $url
-     * @return boolean
-     */
-    public function hasURL($url)
-    {
-        if ($this->isForcedPath($url)) {
-            return true;
-        }
-        $domainBaseURL = trim($this->getURL(), '/');
-        if (preg_match('/^'.$domainBaseURL.'/', $url)) {
-            return true;
-        }
-
-        return false;
-    }
-
-    /**
-     * Returns the key/identifier for this domain
-     *
-     * @return string
-     */
-    public function getKey()
-    {
-        return $this->key;
-    }
-
-    /**
-     * Set the request URI
-     *
-     * @param  string $requestUri
-     * @return $this
-     */
-    public function setRequestUri($requestUri)
-    {
-        $this->requestUri = (string) $requestUri;
-        return $this;
-    }
-
-    /**
-     * Return the current request URI, defaulting to retrieving it from the $_SERVER superglobal
-     *
-     * @return string
-     */
-    public function getRequestUri()
-    {
-        return $this->requestUri ?: $_SERVER['REQUEST_URI'];
-    }
-
-    /**
-     * Set the HTTP host in the request
-     *
-     * @param  string $httpHost
-     * @return $this
-     */
-    public function setHttpHost($httpHost)
-    {
-        $this->httpHost = (string) $httpHost;
-        return $this;
-    }
-
-    /**
-     * Return the current HTTP host, defaulting to retrieving it from the $_SERVER superglobal
-     *
-     * @return string
-     */
-    public function getHttpHost()
-    {
-        return $this->httpHost ?: $_SERVER['HTTP_HOST'];
-    }
-
-    /**
-     * Checks a given list of wildcard patterns to see if a path is allowed
-     * @param  string  $url
-     * @return boolean
-     */
-    protected function isAllowedPath($url)
-    {
-        return self::match_url($url, $this->allowedPaths);
-    }
-
-    /**
-     * Checks a given list of wildcard patterns to see if a path is allowed
-     * @param  string  $url
-     * @return boolean
-     */
-    protected function isForcedPath($url)
-    {
-        return self::match_url($url, $this->forcedPaths);
-    }
-
-    /**
-     * Matches a URL against a list of wildcard patterns
-     * @param  string $url
-     * @param  array $patterns
-     * @return boolean
-     */
-    protected static function match_url($url, $patterns)
-    {
-        if (!is_array($patterns)) {
-            return false;
-        }
-
-        $url = ltrim($url, '/');
-        if (substr($url, -1) !== '/') {
-            $url .= '/';
-        }
-
-        foreach ($patterns as $pattern) {
-            if (fnmatch($pattern, $url)) {
-                return true;
-            }
-        }
-
-        return false;
-    }
+	/**
+	 * The hostname of the domain, e.g. silverstripe.org
+	 * @var string
+	 */
+	protected $hostname;
+
+	/**
+	 * The path that the hostname resolves to
+	 * @var string
+	 */
+	protected $url;
+
+	/**
+	 * The identifier of the domain, e.g. 'org','com'
+	 * @var string
+	 */
+	protected $key;
+
+	/**
+	 * Paths that are allowed to be accessed on the primary domain
+	 * @var array
+	 */
+	protected $allowedPaths;
+
+	/**
+	 * Paths that are forced from the primary domain into a vanity one,
+	 * outside the resolves_to path
+	 *
+	 * @var array
+	 */
+	protected $forcedPaths;
+
+	/**
+	 * The request URI
+	 *
+	 * @var string
+	 */
+	protected $requestUri;
+
+	/**
+	 * The request HTTP HOST
+	 *
+	 * @var string
+	 */
+	protected $httpHost;
+
+	/**
+	 * Constructor. Takes a key for the domain and its array of settings from the config
+	 * @param string $key
+	 * @param array $config
+	 */
+	public function __construct($key, $config)
+	{
+		$this->key = $key;
+		$this->hostname = $config['hostname'];
+		$this->url = isset($config['resolves_to']) ? $config['resolves_to'] : null;
+
+		$globalAllowed = (array) Config::inst()->get('MultiDomain', 'allow');
+		$globalForced = (array) Config::inst()->get('MultiDomain', 'force');
+		$myAllowed = isset($config['allow']) ? $config['allow'] : array ();
+		$myForced = isset($config['force']) ? $config['force'] : array ();
+		$this->allowedPaths = array_merge($globalAllowed, $myAllowed);
+		$this->forcedPaths = array_merge($globalForced, $myForced);
+
+		parent::__construct();
+	}
+
+	/**
+	 * Gets the hostname for the domain
+	 * @return string
+	 */
+	public function getHostname()
+	{
+		return defined($this->hostname) ? constant($this->hostname) : $this->hostname;
+	}
+
+	/**
+	 * Gets the path that the hostname resolves to
+	 * @return string
+	 */
+	public function getURL()
+	{
+		return $this->url;
+	}
+
+	/**
+	 * Returns true if the domain is currently in the HTTP_HOST
+	 * @return boolean
+	 */
+	public function isActive()
+	{
+		if ($this->isAllowedPath($this->getRequestUri())) {
+			return false;
+		}
+
+		$currentHost = $this->getHttpHost();
+		if (strpos(':', $currentHost) !== false) {
+			list($currentHost, $currentPort) = explode(':', $currentHost, 2);
+		}
+
+		$allow_subdomains = MultiDomain::config()->allow_subdomains;
+		$hostname = $this->getHostname();
+
+		return $allow_subdomains ?
+					(bool) preg_match('/(\.|^)'.$hostname.'$/', $currentHost) :
+					($currentHost == $hostname);
+	}
+
+	/**
+	 * Returns true if this domain is the primary domain
+	 * @return boolean
+	 */
+	public function isPrimary()
+	{
+		return $this->key === MultiDomain::KEY_PRIMARY;
+	}
+
+	/**
+	 * Gets the native URL for a vanity domain, e.g. /partners/ for .com
+	 * returns /company/partners when .com is mapped to /company/.
+	 *
+	 * @param  string $url
+	 * @return string
+	 */
+	public function getNativeURL($url)
+	{
+		if ($this->isPrimary()) {
+			throw new Exception("Cannot convert a native URL on the primary domain");
+		}
+
+		if ($this->isAllowedPath($url) || $this->isForcedPath($url)) {
+			return $url;
+		}
+
+		return Controller::join_links($this->getURL(), $url);
+	}
+
+	/**
+	 * Gets the vanity URL given a native URL. /company/partners returns /partners/
+	 * when .com is mapped to /company/.
+	 *
+	 * @param  string $url
+	 * @return string
+	 */
+	public function getVanityURL($url)
+	{
+		if ($this->isPrimary() || $this->isAllowedPath($url)) {
+			return $url;
+		}
+
+		$domainUrl = str_replace('/', '\/', $this->getURL());
+		return preg_replace('/^\/?' . $domainUrl . '\//', '', $url);
+	}
+
+	/**
+	 * Return true if this domain contains the given URL
+	 * @param  string  $url
+	 * @return boolean
+	 */
+	public function hasURL($url)
+	{
+		if ($this->isForcedPath($url)) {
+			return true;
+		}
+		$domainBaseURL = trim($this->getURL(), '/');
+		if (preg_match('/^'.$domainBaseURL.'/', $url)) {
+			return true;
+		}
+
+		return false;
+	}
+
+	/**
+	 * Returns the key/identifier for this domain
+	 *
+	 * @return string
+	 */
+	public function getKey()
+	{
+		return $this->key;
+	}
+
+	/**
+	 * Set the request URI
+	 *
+	 * @param  string $requestUri
+	 * @return $this
+	 */
+	public function setRequestUri($requestUri)
+	{
+		$this->requestUri = (string) $requestUri;
+		return $this;
+	}
+
+	/**
+	 * Return the current request URI, defaulting to retrieving it from the $_SERVER superglobal
+	 *
+	 * @return string
+	 */
+	public function getRequestUri()
+	{
+		return $this->requestUri ?: $_SERVER['REQUEST_URI'];
+	}
+
+	/**
+	 * Set the HTTP host in the request
+	 *
+	 * @param  string $httpHost
+	 * @return $this
+	 */
+	public function setHttpHost($httpHost)
+	{
+		$this->httpHost = (string) $httpHost;
+		return $this;
+	}
+
+	/**
+	 * Return the current HTTP host, defaulting to retrieving it from the $_SERVER superglobal
+	 *
+	 * @return string
+	 */
+	public function getHttpHost()
+	{
+		return $this->httpHost ?: $_SERVER['HTTP_HOST'];
+	}
+
+	/**
+	 * Checks a given list of wildcard patterns to see if a path is allowed
+	 * @param  string  $url
+	 * @return boolean
+	 */
+	protected function isAllowedPath($url)
+	{
+		return self::match_url($url, $this->allowedPaths);
+	}
+
+	/**
+	 * Checks a given list of wildcard patterns to see if a path is allowed
+	 * @param  string  $url
+	 * @return boolean
+	 */
+	protected function isForcedPath($url)
+	{
+		return self::match_url($url, $this->forcedPaths);
+	}
+
+	/**
+	 * Matches a URL against a list of wildcard patterns
+	 * @param  string $url
+	 * @param  array $patterns
+	 * @return boolean
+	 */
+	protected static function match_url($url, $patterns)
+	{
+		if (!is_array($patterns)) {
+			return false;
+		}
+
+		$url = ltrim($url, '/');
+		if (substr($url, -1) !== '/') {
+			$url .= '/';
+		}
+
+		foreach ($patterns as $pattern) {
+			if (fnmatch($pattern, $url)) {
+				return true;
+			}
+		}
+
+		return false;
+	}
 }

Spacing +4 added lines, -5 removed lines

@@ -68,8 +68,8 @@ 
 
         $globalAllowed = (array) Config::inst()->get('MultiDomain', 'allow');
         $globalForced = (array) Config::inst()->get('MultiDomain', 'force');
-        $myAllowed = isset($config['allow']) ? $config['allow'] : array ();
-        $myForced = isset($config['force']) ? $config['force'] : array ();
+        $myAllowed = isset($config['allow']) ? $config['allow'] : array();
+        $myForced = isset($config['force']) ? $config['force'] : array();
         $this->allowedPaths = array_merge($globalAllowed, $myAllowed);
         $this->forcedPaths = array_merge($globalForced, $myForced);
 
@@ -113,8 +113,7 @@ 
         $hostname = $this->getHostname();
 
         return $allow_subdomains ?
-                    (bool) preg_match('/(\.|^)'.$hostname.'$/', $currentHost) :
-                    ($currentHost == $hostname);
+                    (bool) preg_match('/(\.|^)'.$hostname.'$/', $currentHost) : ($currentHost == $hostname);
     }
 
     /**
@@ -160,7 +159,7 @@ 
         }
 
         $domainUrl = str_replace('/', '\/', $this->getURL());
-        return preg_replace('/^\/?' . $domainUrl . '\//', '', $url);
+        return preg_replace('/^\/?'.$domainUrl.'\//', '', $url);
     }
 
     /**