enwikipedia-acc / waca

includes/WebRequest.php

Indentation +517 added lines, -517 removed lines

@@ -22,521 +22,521 @@
  */
 class WebRequest
 {
-    /**
-     * @var \Waca\Providers\GlobalState\IGlobalStateProvider Provides access to the global state.
-     */
-    private static $globalStateProvider;
-
-    /**
-     * Returns a boolean value if the request was submitted with the HTTP POST method.
-     * @return bool
-     */
-    public static function wasPosted()
-    {
-        return self::method() === 'POST';
-    }
-
-    /**
-     * Gets the HTTP Method used
-     * @return string|null
-     */
-    public static function method()
-    {
-        $server = &self::$globalStateProvider->getServerSuperGlobal();
-
-        if (isset($server['REQUEST_METHOD'])) {
-            return $server['REQUEST_METHOD'];
-        }
-
-        return null;
-    }
-
-    /**
-     * Gets a boolean value stating whether the request was served over HTTPS or not.
-     * @return bool
-     */
-    public static function isHttps()
-    {
-        $server = &self::$globalStateProvider->getServerSuperGlobal();
-
-        if (isset($server['HTTP_X_FORWARDED_PROTO'])) {
-            if ($server['HTTP_X_FORWARDED_PROTO'] === 'https') {
-                // Client <=> Proxy is encrypted
-                return true;
-            }
-            else {
-                // Proxy <=> Server link unknown, Client <=> Proxy is not encrypted.
-                return false;
-            }
-        }
-
-        if (isset($server['HTTPS'])) {
-            if ($server['HTTPS'] === 'off') {
-                // ISAPI on IIS breaks the spec. :(
-                return false;
-            }
-
-            if ($server['HTTPS'] !== '') {
-                // Set to a non-empty value
-                return true;
-            }
-        }
-
-        return false;
-    }
-
-    /**
-     * Gets the path info
-     *
-     * @return array Array of path info segments
-     */
-    public static function pathInfo()
-    {
-        $server = &self::$globalStateProvider->getServerSuperGlobal();
-        if (!isset($server['PATH_INFO'])) {
-            return array();
-        }
-
-        $exploded = explode('/', $server['PATH_INFO']);
-
-        // filter out empty values, and reindex from zero. Notably, the first element is always zero, since it starts
-        // with a /
-        return array_values(array_filter($exploded));
-    }
-
-    /**
-     * Gets the remote address of the web request
-     * @return null|string
-     */
-    public static function remoteAddress()
-    {
-        $server = &self::$globalStateProvider->getServerSuperGlobal();
-
-        if (isset($server['REMOTE_ADDR'])) {
-            return $server['REMOTE_ADDR'];
-        }
-
-        return null;
-    }
-
-    /**
-     * Gets the XFF header contents for the web request
-     * @return null|string
-     */
-    public static function forwardedAddress()
-    {
-        $server = &self::$globalStateProvider->getServerSuperGlobal();
-
-        if (isset($server['HTTP_X_FORWARDED_FOR'])) {
-            return $server['HTTP_X_FORWARDED_FOR'];
-        }
-
-        return null;
-    }
-
-    /**
-     * Sets the global state provider.
-     *
-     * Almost guaranteed this is not the method you want in production code.
-     *
-     * @param \Waca\Providers\GlobalState\IGlobalStateProvider $globalState
-     */
-    public static function setGlobalStateProvider($globalState)
-    {
-        self::$globalStateProvider = $globalState;
-    }
-
-    #region POST variables
-
-    /**
-     * @param string $key
-     *
-     * @return null|string
-     */
-    public static function postString($key)
-    {
-        $post = &self::$globalStateProvider->getPostSuperGlobal();
-        if (!array_key_exists($key, $post)) {
-            return null;
-        }
-
-        if ($post[$key] === "") {
-            return null;
-        }
-
-        return (string)$post[$key];
-    }
-
-    /**
-     * @param string $key
-     *
-     * @return null|string
-     */
-    public static function postEmail($key)
-    {
-        $post = &self::$globalStateProvider->getPostSuperGlobal();
-        if (!array_key_exists($key, $post)) {
-            return null;
-        }
-
-        $filteredValue = filter_var($post[$key], FILTER_SANITIZE_EMAIL);
-
-        if ($filteredValue === false) {
-            return null;
-        }
-
-        return (string)$filteredValue;
-    }
-
-    /**
-     * @param string $key
-     *
-     * @return int|null
-     */
-    public static function postInt($key)
-    {
-        $post = &self::$globalStateProvider->getPostSuperGlobal();
-        if (!array_key_exists($key, $post)) {
-            return null;
-        }
-
-        $filteredValue = filter_var($post[$key], FILTER_VALIDATE_INT, FILTER_NULL_ON_FAILURE);
-
-        if ($filteredValue === null) {
-            return null;
-        }
-
-        return (int)$filteredValue;
-    }
-
-    /**
-     * @param string $key
-     *
-     * @return bool
-     */
-    public static function postBoolean($key)
-    {
-        $get = &self::$globalStateProvider->getPostSuperGlobal();
-        if (!array_key_exists($key, $get)) {
-            return false;
-        }
-
-        // presence of parameter only
-        if ($get[$key] === "") {
-            return true;
-        }
-
-        if (in_array($get[$key], array(false, 'no', 'off', 0, 'false'), true)) {
-            return false;
-        }
-
-        return true;
-    }
-
-    #endregion
-
-    #region GET variables
-
-    /**
-     * @param string $key
-     *
-     * @return bool
-     */
-    public static function getBoolean($key)
-    {
-        $get = &self::$globalStateProvider->getGetSuperGlobal();
-        if (!array_key_exists($key, $get)) {
-            return false;
-        }
-
-        // presence of parameter only
-        if ($get[$key] === "") {
-            return true;
-        }
-
-        if (in_array($get[$key], array(false, 'no', 'off', 0, 'false'), true)) {
-            return false;
-        }
-
-        return true;
-    }
-
-    /**
-     * @param string $key
-     *
-     * @return int|null
-     */
-    public static function getInt($key)
-    {
-        $get = &self::$globalStateProvider->getGetSuperGlobal();
-        if (!array_key_exists($key, $get)) {
-            return null;
-        }
-
-        $filteredValue = filter_var($get[$key], FILTER_VALIDATE_INT, FILTER_NULL_ON_FAILURE);
-
-        if ($filteredValue === null) {
-            return null;
-        }
-
-        return (int)$filteredValue;
-    }
-
-    /**
-     * @param string $key
-     *
-     * @return null|string
-     */
-    public static function getString($key)
-    {
-        $get = &self::$globalStateProvider->getGetSuperGlobal();
-        if (!array_key_exists($key, $get)) {
-            return null;
-        }
-
-        if ($get[$key] === "") {
-            return null;
-        }
-
-        return (string)$get[$key];
-    }
-
-    #endregion
-
-    /**
-     * Sets the logged-in user to the specified user.
-     *
-     * @param User $user
-     */
-    public static function setLoggedInUser(User $user)
-    {
-        $session = &self::$globalStateProvider->getSessionSuperGlobal();
-
-        $session['userID'] = $user->getId();
-        unset($session['partialLogin']);
-    }
-
-    /**
-     * Sets the post-login redirect
-     */
-    public static function setPostLoginRedirect()
-    {
-        $session = &self::$globalStateProvider->getSessionSuperGlobal();
-        $session['returnTo'] = self::requestUri();
-    }
-
-    /**
-     * @return string|null
-     */
-    public static function requestUri()
-    {
-        $server = &self::$globalStateProvider->getServerSuperGlobal();
-
-        if (isset($server['REQUEST_URI'])) {
-            return $server['REQUEST_URI'];
-        }
-
-        return null;
-    }
-
-    /**
-     * Clears the post-login redirect
-     * @return string
-     */
-    public static function clearPostLoginRedirect()
-    {
-        $session = &self::$globalStateProvider->getSessionSuperGlobal();
-        if (array_key_exists('returnTo', $session)) {
-            $path = $session['returnTo'];
-            unset($session['returnTo']);
-
-            return $path;
-        }
-
-        return null;
-    }
-
-    /**
-     * @return string|null
-     */
-    public static function serverName()
-    {
-        $server = &self::$globalStateProvider->getServerSuperGlobal();
-
-        if (isset($server['SERVER_NAME'])) {
-            return $server['SERVER_NAME'];
-        }
-
-        return null;
-    }
-
-    /**
-     * You probably only want to deal with this through SessionAlert.
-     * @return void
-     */
-    public static function clearSessionAlertData()
-    {
-        $session = &self::$globalStateProvider->getSessionSuperGlobal();
-        if (array_key_exists('alerts', $session)) {
-            unset($session['alerts']);
-        }
-    }
-
-    /**
-     * You probably only want to deal with this through SessionAlert.
-     *
-     * @return string[]
-     */
-    public static function getSessionAlertData()
-    {
-        $session = &self::$globalStateProvider->getSessionSuperGlobal();
-        if (array_key_exists('alerts', $session)) {
-            return $session['alerts'];
-        }
-
-        return array();
-    }
-
-    /**
-     * You probably only want to deal with this through SessionAlert.
-     *
-     * @param string[] $data
-     */
-    public static function setSessionAlertData($data)
-    {
-        $session = &self::$globalStateProvider->getSessionSuperGlobal();
-        $session['alerts'] = $data;
-    }
-
-    /**
-     * You probably only want to deal with this through TokenManager.
-     *
-     * @return string[]
-     */
-    public static function getSessionTokenData()
-    {
-        $session = &self::$globalStateProvider->getSessionSuperGlobal();
-        if (array_key_exists('tokens', $session)) {
-            return $session['tokens'];
-        }
-
-        return array();
-    }
-
-    /**
-     * You probably only want to deal with this through TokenManager.
-     *
-     * @param string[] $data
-     */
-    public static function setSessionTokenData($data)
-    {
-        $session = &self::$globalStateProvider->getSessionSuperGlobal();
-        $session['tokens'] = $data;
-    }
-
-    /**
-     * @param string $key
-     *
-     * @return mixed
-     */
-    public static function getSessionContext($key)
-    {
-        $session = &self::$globalStateProvider->getSessionSuperGlobal();
-
-        if (!isset($session['context'])) {
-            $session['context'] = array();
-        }
-
-        if (!isset($session['context'][$key])) {
-            return null;
-        }
-
-        return $session['context'][$key];
-    }
-
-    /**
-     * @param string $key
-     * @param mixed  $data
-     */
-    public static function setSessionContext($key, $data)
-    {
-        $session = &self::$globalStateProvider->getSessionSuperGlobal();
-
-        if (!isset($session['context'])) {
-            $session['context'] = array();
-        }
-
-        $session['context'][$key] = $data;
-    }
-
-    /**
-     * @return int|null
-     */
-    public static function getSessionUserId()
-    {
-        $session = &self::$globalStateProvider->getSessionSuperGlobal();
-
-        return isset($session['userID']) ? (int)$session['userID'] : null;
-    }
-
-    /**
-     * @param User $user
-     */
-    public static function setPartialLogin(User $user)
-    {
-        $session = &self::$globalStateProvider->getSessionSuperGlobal();
-        $session['partialLogin'] = $user->getId();
-    }
-
-    /**
-     * @return int|null
-     */
-    public static function getPartialLogin()
-    {
-        $session = &self::$globalStateProvider->getSessionSuperGlobal();
-
-        return isset($session['partialLogin']) ? (int)$session['partialLogin'] : null;
-    }
-
-    /**
-     * @return null|string
-     */
-    public static function userAgent()
-    {
-        $server = &self::$globalStateProvider->getServerSuperGlobal();
-
-        if (isset($server['HTTP_USER_AGENT'])) {
-            return $server['HTTP_USER_AGENT'];
-        }
-
-        return null;
-    }
-
-    /**
-     * @return null|string
-     */
-    public static function scriptName()
-    {
-        $server = &self::$globalStateProvider->getServerSuperGlobal();
-
-        if (isset($server['SCRIPT_NAME'])) {
-            return $server['SCRIPT_NAME'];
-        }
-
-        return null;
-    }
-
-    /**
-     * @return null|string
-     */
-    public static function origin()
-    {
-        $server = &self::$globalStateProvider->getServerSuperGlobal();
-
-        if (isset($server['HTTP_ORIGIN'])) {
-            return $server['HTTP_ORIGIN'];
-        }
-
-        return null;
-    }
+	/**
+	 * @var \Waca\Providers\GlobalState\IGlobalStateProvider Provides access to the global state.
+	 */
+	private static $globalStateProvider;
+
+	/**
+	 * Returns a boolean value if the request was submitted with the HTTP POST method.
+	 * @return bool
+	 */
+	public static function wasPosted()
+	{
+		return self::method() === 'POST';
+	}
+
+	/**
+	 * Gets the HTTP Method used
+	 * @return string|null
+	 */
+	public static function method()
+	{
+		$server = &self::$globalStateProvider->getServerSuperGlobal();
+
+		if (isset($server['REQUEST_METHOD'])) {
+			return $server['REQUEST_METHOD'];
+		}
+
+		return null;
+	}
+
+	/**
+	 * Gets a boolean value stating whether the request was served over HTTPS or not.
+	 * @return bool
+	 */
+	public static function isHttps()
+	{
+		$server = &self::$globalStateProvider->getServerSuperGlobal();
+
+		if (isset($server['HTTP_X_FORWARDED_PROTO'])) {
+			if ($server['HTTP_X_FORWARDED_PROTO'] === 'https') {
+				// Client <=> Proxy is encrypted
+				return true;
+			}
+			else {
+				// Proxy <=> Server link unknown, Client <=> Proxy is not encrypted.
+				return false;
+			}
+		}
+
+		if (isset($server['HTTPS'])) {
+			if ($server['HTTPS'] === 'off') {
+				// ISAPI on IIS breaks the spec. :(
+				return false;
+			}
+
+			if ($server['HTTPS'] !== '') {
+				// Set to a non-empty value
+				return true;
+			}
+		}
+
+		return false;
+	}
+
+	/**
+	 * Gets the path info
+	 *
+	 * @return array Array of path info segments
+	 */
+	public static function pathInfo()
+	{
+		$server = &self::$globalStateProvider->getServerSuperGlobal();
+		if (!isset($server['PATH_INFO'])) {
+			return array();
+		}
+
+		$exploded = explode('/', $server['PATH_INFO']);
+
+		// filter out empty values, and reindex from zero. Notably, the first element is always zero, since it starts
+		// with a /
+		return array_values(array_filter($exploded));
+	}
+
+	/**
+	 * Gets the remote address of the web request
+	 * @return null|string
+	 */
+	public static function remoteAddress()
+	{
+		$server = &self::$globalStateProvider->getServerSuperGlobal();
+
+		if (isset($server['REMOTE_ADDR'])) {
+			return $server['REMOTE_ADDR'];
+		}
+
+		return null;
+	}
+
+	/**
+	 * Gets the XFF header contents for the web request
+	 * @return null|string
+	 */
+	public static function forwardedAddress()
+	{
+		$server = &self::$globalStateProvider->getServerSuperGlobal();
+
+		if (isset($server['HTTP_X_FORWARDED_FOR'])) {
+			return $server['HTTP_X_FORWARDED_FOR'];
+		}
+
+		return null;
+	}
+
+	/**
+	 * Sets the global state provider.
+	 *
+	 * Almost guaranteed this is not the method you want in production code.
+	 *
+	 * @param \Waca\Providers\GlobalState\IGlobalStateProvider $globalState
+	 */
+	public static function setGlobalStateProvider($globalState)
+	{
+		self::$globalStateProvider = $globalState;
+	}
+
+	#region POST variables
+
+	/**
+	 * @param string $key
+	 *
+	 * @return null|string
+	 */
+	public static function postString($key)
+	{
+		$post = &self::$globalStateProvider->getPostSuperGlobal();
+		if (!array_key_exists($key, $post)) {
+			return null;
+		}
+
+		if ($post[$key] === "") {
+			return null;
+		}
+
+		return (string)$post[$key];
+	}
+
+	/**
+	 * @param string $key
+	 *
+	 * @return null|string
+	 */
+	public static function postEmail($key)
+	{
+		$post = &self::$globalStateProvider->getPostSuperGlobal();
+		if (!array_key_exists($key, $post)) {
+			return null;
+		}
+
+		$filteredValue = filter_var($post[$key], FILTER_SANITIZE_EMAIL);
+
+		if ($filteredValue === false) {
+			return null;
+		}
+
+		return (string)$filteredValue;
+	}
+
+	/**
+	 * @param string $key
+	 *
+	 * @return int|null
+	 */
+	public static function postInt($key)
+	{
+		$post = &self::$globalStateProvider->getPostSuperGlobal();
+		if (!array_key_exists($key, $post)) {
+			return null;
+		}
+
+		$filteredValue = filter_var($post[$key], FILTER_VALIDATE_INT, FILTER_NULL_ON_FAILURE);
+
+		if ($filteredValue === null) {
+			return null;
+		}
+
+		return (int)$filteredValue;
+	}
+
+	/**
+	 * @param string $key
+	 *
+	 * @return bool
+	 */
+	public static function postBoolean($key)
+	{
+		$get = &self::$globalStateProvider->getPostSuperGlobal();
+		if (!array_key_exists($key, $get)) {
+			return false;
+		}
+
+		// presence of parameter only
+		if ($get[$key] === "") {
+			return true;
+		}
+
+		if (in_array($get[$key], array(false, 'no', 'off', 0, 'false'), true)) {
+			return false;
+		}
+
+		return true;
+	}
+
+	#endregion
+
+	#region GET variables
+
+	/**
+	 * @param string $key
+	 *
+	 * @return bool
+	 */
+	public static function getBoolean($key)
+	{
+		$get = &self::$globalStateProvider->getGetSuperGlobal();
+		if (!array_key_exists($key, $get)) {
+			return false;
+		}
+
+		// presence of parameter only
+		if ($get[$key] === "") {
+			return true;
+		}
+
+		if (in_array($get[$key], array(false, 'no', 'off', 0, 'false'), true)) {
+			return false;
+		}
+
+		return true;
+	}
+
+	/**
+	 * @param string $key
+	 *
+	 * @return int|null
+	 */
+	public static function getInt($key)
+	{
+		$get = &self::$globalStateProvider->getGetSuperGlobal();
+		if (!array_key_exists($key, $get)) {
+			return null;
+		}
+
+		$filteredValue = filter_var($get[$key], FILTER_VALIDATE_INT, FILTER_NULL_ON_FAILURE);
+
+		if ($filteredValue === null) {
+			return null;
+		}
+
+		return (int)$filteredValue;
+	}
+
+	/**
+	 * @param string $key
+	 *
+	 * @return null|string
+	 */
+	public static function getString($key)
+	{
+		$get = &self::$globalStateProvider->getGetSuperGlobal();
+		if (!array_key_exists($key, $get)) {
+			return null;
+		}
+
+		if ($get[$key] === "") {
+			return null;
+		}
+
+		return (string)$get[$key];
+	}
+
+	#endregion
+
+	/**
+	 * Sets the logged-in user to the specified user.
+	 *
+	 * @param User $user
+	 */
+	public static function setLoggedInUser(User $user)
+	{
+		$session = &self::$globalStateProvider->getSessionSuperGlobal();
+
+		$session['userID'] = $user->getId();
+		unset($session['partialLogin']);
+	}
+
+	/**
+	 * Sets the post-login redirect
+	 */
+	public static function setPostLoginRedirect()
+	{
+		$session = &self::$globalStateProvider->getSessionSuperGlobal();
+		$session['returnTo'] = self::requestUri();
+	}
+
+	/**
+	 * @return string|null
+	 */
+	public static function requestUri()
+	{
+		$server = &self::$globalStateProvider->getServerSuperGlobal();
+
+		if (isset($server['REQUEST_URI'])) {
+			return $server['REQUEST_URI'];
+		}
+
+		return null;
+	}
+
+	/**
+	 * Clears the post-login redirect
+	 * @return string
+	 */
+	public static function clearPostLoginRedirect()
+	{
+		$session = &self::$globalStateProvider->getSessionSuperGlobal();
+		if (array_key_exists('returnTo', $session)) {
+			$path = $session['returnTo'];
+			unset($session['returnTo']);
+
+			return $path;
+		}
+
+		return null;
+	}
+
+	/**
+	 * @return string|null
+	 */
+	public static function serverName()
+	{
+		$server = &self::$globalStateProvider->getServerSuperGlobal();
+
+		if (isset($server['SERVER_NAME'])) {
+			return $server['SERVER_NAME'];
+		}
+
+		return null;
+	}
+
+	/**
+	 * You probably only want to deal with this through SessionAlert.
+	 * @return void
+	 */
+	public static function clearSessionAlertData()
+	{
+		$session = &self::$globalStateProvider->getSessionSuperGlobal();
+		if (array_key_exists('alerts', $session)) {
+			unset($session['alerts']);
+		}
+	}
+
+	/**
+	 * You probably only want to deal with this through SessionAlert.
+	 *
+	 * @return string[]
+	 */
+	public static function getSessionAlertData()
+	{
+		$session = &self::$globalStateProvider->getSessionSuperGlobal();
+		if (array_key_exists('alerts', $session)) {
+			return $session['alerts'];
+		}
+
+		return array();
+	}
+
+	/**
+	 * You probably only want to deal with this through SessionAlert.
+	 *
+	 * @param string[] $data
+	 */
+	public static function setSessionAlertData($data)
+	{
+		$session = &self::$globalStateProvider->getSessionSuperGlobal();
+		$session['alerts'] = $data;
+	}
+
+	/**
+	 * You probably only want to deal with this through TokenManager.
+	 *
+	 * @return string[]
+	 */
+	public static function getSessionTokenData()
+	{
+		$session = &self::$globalStateProvider->getSessionSuperGlobal();
+		if (array_key_exists('tokens', $session)) {
+			return $session['tokens'];
+		}
+
+		return array();
+	}
+
+	/**
+	 * You probably only want to deal with this through TokenManager.
+	 *
+	 * @param string[] $data
+	 */
+	public static function setSessionTokenData($data)
+	{
+		$session = &self::$globalStateProvider->getSessionSuperGlobal();
+		$session['tokens'] = $data;
+	}
+
+	/**
+	 * @param string $key
+	 *
+	 * @return mixed
+	 */
+	public static function getSessionContext($key)
+	{
+		$session = &self::$globalStateProvider->getSessionSuperGlobal();
+
+		if (!isset($session['context'])) {
+			$session['context'] = array();
+		}
+
+		if (!isset($session['context'][$key])) {
+			return null;
+		}
+
+		return $session['context'][$key];
+	}
+
+	/**
+	 * @param string $key
+	 * @param mixed  $data
+	 */
+	public static function setSessionContext($key, $data)
+	{
+		$session = &self::$globalStateProvider->getSessionSuperGlobal();
+
+		if (!isset($session['context'])) {
+			$session['context'] = array();
+		}
+
+		$session['context'][$key] = $data;
+	}
+
+	/**
+	 * @return int|null
+	 */
+	public static function getSessionUserId()
+	{
+		$session = &self::$globalStateProvider->getSessionSuperGlobal();
+
+		return isset($session['userID']) ? (int)$session['userID'] : null;
+	}
+
+	/**
+	 * @param User $user
+	 */
+	public static function setPartialLogin(User $user)
+	{
+		$session = &self::$globalStateProvider->getSessionSuperGlobal();
+		$session['partialLogin'] = $user->getId();
+	}
+
+	/**
+	 * @return int|null
+	 */
+	public static function getPartialLogin()
+	{
+		$session = &self::$globalStateProvider->getSessionSuperGlobal();
+
+		return isset($session['partialLogin']) ? (int)$session['partialLogin'] : null;
+	}
+
+	/**
+	 * @return null|string
+	 */
+	public static function userAgent()
+	{
+		$server = &self::$globalStateProvider->getServerSuperGlobal();
+
+		if (isset($server['HTTP_USER_AGENT'])) {
+			return $server['HTTP_USER_AGENT'];
+		}
+
+		return null;
+	}
+
+	/**
+	 * @return null|string
+	 */
+	public static function scriptName()
+	{
+		$server = &self::$globalStateProvider->getServerSuperGlobal();
+
+		if (isset($server['SCRIPT_NAME'])) {
+			return $server['SCRIPT_NAME'];
+		}
+
+		return null;
+	}
+
+	/**
+	 * @return null|string
+	 */
+	public static function origin()
+	{
+		$server = &self::$globalStateProvider->getServerSuperGlobal();
+
+		if (isset($server['HTTP_ORIGIN'])) {
+			return $server['HTTP_ORIGIN'];
+		}
+
+		return null;
+	}
 }
\ No newline at end of file

includes/Tasks/IRoutedTask.php

Indentation +16 added lines, -16 removed lines

@@ -12,21 +12,21 @@
 
 interface IRoutedTask extends ITask
 {
-    /**
-     * Sets the route the request will take. Only should be called from the request router.
-     *
-     * @param $routeName string
-     *
-     * @return void
-     *
-     * @throws Exception
-     * @category Security-Critical
-     */
-    public function setRoute($routeName);
+	/**
+	 * Sets the route the request will take. Only should be called from the request router.
+	 *
+	 * @param $routeName string
+	 *
+	 * @return void
+	 *
+	 * @throws Exception
+	 * @category Security-Critical
+	 */
+	public function setRoute($routeName);
 
-    /**
-     * Gets the name of the route that has been passed from the request router.
-     * @return string
-     */
-    public function getRouteName();
+	/**
+	 * Gets the name of the route that has been passed from the request router.
+	 * @return string
+	 */
+	public function getRouteName();
 }
\ No newline at end of file

includes/Tasks/ApiPageBase.php

Indentation +93 added lines, -93 removed lines

@@ -16,97 +16,97 @@
 
 abstract class ApiPageBase extends TaskBase implements IRoutedTask, IApiAction
 {
-    /**
-     * API result document
-     * @var DOMDocument
-     */
-    protected $document;
-
-    public function __construct()
-    {
-        $this->document = new DOMDocument('1.0');
-    }
-
-    final public function execute()
-    {
-        $this->main();
-    }
-
-    /**
-     * @param string $routeName
-     */
-    public function setRoute($routeName)
-    {
-        // no-op
-    }
-
-    /**
-     * @return string
-     */
-    public function getRouteName()
-    {
-        return 'main';
-    }
-
-    /**
-     * Main function for this page, when no specific actions are called.
-     *
-     * @throws ApiException
-     * @return void
-     */
-    final protected function main()
-    {
-        if (headers_sent()) {
-            throw new ApiException('Headers have already been sent - this indicates a bug in the application!');
-        }
-
-        header("Content-Type: text/xml");
-
-        // javascript access control
-        $httpOrigin = WebRequest::origin();
-
-        if ($httpOrigin !== null) {
-            $CORSallowed = $this->getSiteConfiguration()->getCrossOriginResourceSharingHosts();
-
-            if (in_array($httpOrigin, $CORSallowed)) {
-                header("Access-Control-Allow-Origin: " . $httpOrigin);
-            }
-        }
-
-        $responseData = $this->runApiPage();
-
-        ob_end_clean();
-        print($responseData);
-        ob_start();
-    }
-
-    /**
-     * Method that runs API action
-     *
-     * @param DOMElement $apiDocument
-     *
-     * @return DOMElement
-     */
-    abstract public function executeApiAction(DOMElement $apiDocument);
-
-    /**
-     * @return string
-     */
-    final public function runApiPage()
-    {
-        $apiDocument = $this->document->createElement("api");
-
-        try {
-            $apiDocument = $this->executeApiAction($apiDocument);
-        }
-        catch (ApiException $ex) {
-            $exception = $this->document->createElement("error");
-            $exception->setAttribute("message", $ex->getMessage());
-            $apiDocument->appendChild($exception);
-        }
-
-        $this->document->appendChild($apiDocument);
-
-        return $this->document->saveXML();
-    }
+	/**
+	 * API result document
+	 * @var DOMDocument
+	 */
+	protected $document;
+
+	public function __construct()
+	{
+		$this->document = new DOMDocument('1.0');
+	}
+
+	final public function execute()
+	{
+		$this->main();
+	}
+
+	/**
+	 * @param string $routeName
+	 */
+	public function setRoute($routeName)
+	{
+		// no-op
+	}
+
+	/**
+	 * @return string
+	 */
+	public function getRouteName()
+	{
+		return 'main';
+	}
+
+	/**
+	 * Main function for this page, when no specific actions are called.
+	 *
+	 * @throws ApiException
+	 * @return void
+	 */
+	final protected function main()
+	{
+		if (headers_sent()) {
+			throw new ApiException('Headers have already been sent - this indicates a bug in the application!');
+		}
+
+		header("Content-Type: text/xml");
+
+		// javascript access control
+		$httpOrigin = WebRequest::origin();
+
+		if ($httpOrigin !== null) {
+			$CORSallowed = $this->getSiteConfiguration()->getCrossOriginResourceSharingHosts();
+
+			if (in_array($httpOrigin, $CORSallowed)) {
+				header("Access-Control-Allow-Origin: " . $httpOrigin);
+			}
+		}
+
+		$responseData = $this->runApiPage();
+
+		ob_end_clean();
+		print($responseData);
+		ob_start();
+	}
+
+	/**
+	 * Method that runs API action
+	 *
+	 * @param DOMElement $apiDocument
+	 *
+	 * @return DOMElement
+	 */
+	abstract public function executeApiAction(DOMElement $apiDocument);
+
+	/**
+	 * @return string
+	 */
+	final public function runApiPage()
+	{
+		$apiDocument = $this->document->createElement("api");
+
+		try {
+			$apiDocument = $this->executeApiAction($apiDocument);
+		}
+		catch (ApiException $ex) {
+			$exception = $this->document->createElement("error");
+			$exception->setAttribute("message", $ex->getMessage());
+			$apiDocument->appendChild($exception);
+		}
+
+		$this->document->appendChild($apiDocument);
+
+		return $this->document->saveXML();
+	}
 }
\ No newline at end of file

includes/Tasks/PublicInterfacePageBase.php

Indentation +15 added lines, -15 removed lines

@@ -10,21 +10,21 @@
 
 abstract class PublicInterfacePageBase extends PageBase
 {
-    /**
-     * PublicInterfaceInternalPageBase constructor.
-     */
-    public function __construct()
-    {
-        $this->template = 'publicbase.tpl';
-    }
+	/**
+	 * PublicInterfaceInternalPageBase constructor.
+	 */
+	public function __construct()
+	{
+		$this->template = 'publicbase.tpl';
+	}
 
-    final public function execute()
-    {
-        parent::execute();
-    }
+	final public function execute()
+	{
+		parent::execute();
+	}
 
-    final public function finalisePage()
-    {
-        parent::finalisePage();
-    }
+	final public function finalisePage()
+	{
+		parent::finalisePage();
+	}
 }
\ No newline at end of file

includes/DataObject.php

Indentation +120 added lines, -120 removed lines

@@ -23,124 +23,124 @@
  */
 abstract class DataObject
 {
-    /** @var int ID of the object */
-    protected $id = null;
-    /** @var int update version for optimistic locking */
-    protected $updateversion = 0;
-    /**
-     * @var PdoDatabase
-     */
-    protected $dbObject;
-
-    /**
-     * Retrieves a data object by it's row ID.
-     *
-     * @param int         $id
-     * @param PdoDatabase $database
-     *
-     * @return DataObject|false
-     */
-    public static function getById($id, PdoDatabase $database)
-    {
-        $array = explode('\\', get_called_class());
-        $realClassName = strtolower(end($array));
-
-        $statement = $database->prepare("SELECT * FROM {$realClassName} WHERE id = :id LIMIT 1;");
-        $statement->bindValue(":id", $id);
-
-        $statement->execute();
-
-        $resultObject = $statement->fetchObject(get_called_class());
-
-        if ($resultObject != false) {
-            $resultObject->setDatabase($database);
-        }
-
-        return $resultObject;
-    }
-
-    public function setDatabase(PdoDatabase $db)
-    {
-        $this->dbObject = $db;
-    }
-
-    /**
-     * Gets the database associated with this data object.
-     * @return PdoDatabase
-     */
-    public function getDatabase()
-    {
-        return $this->dbObject;
-    }
-
-    /**
-     * Saves a data object to the database, either updating or inserting a record.
-     *
-     * @return void
-     */
-    abstract public function save();
-
-    /**
-     * Retrieves the ID attribute
-     */
-    public function getId()
-    {
-        return (int)$this->id;
-    }
-
-    /**
-     * Deletes the object from the database
-     */
-    public function delete()
-    {
-        if ($this->id === null) {
-            // wtf?
-            return;
-        }
-
-        $array = explode('\\', get_called_class());
-        $realClassName = strtolower(end($array));
-
-        $deleteQuery = "DELETE FROM {$realClassName} WHERE id = :id AND updateversion = :updateversion LIMIT 1;";
-        $statement = $this->dbObject->prepare($deleteQuery);
-
-        $statement->bindValue(":id", $this->id);
-        $statement->bindValue(":updateversion", $this->updateversion);
-        $statement->execute();
-
-        if ($statement->rowCount() !== 1) {
-            throw new OptimisticLockFailedException();
-        }
-
-        $this->id = null;
-    }
-
-    /**
-     * @return int
-     */
-    public function getUpdateVersion()
-    {
-        return $this->updateversion;
-    }
-
-    /**
-     * Sets the update version.
-     *
-     * You should never call this to change the value of the update version. You should only call it when passing user
-     * input through.
-     *
-     * @param int $updateVersion
-     */
-    public function setUpdateVersion($updateVersion)
-    {
-        $this->updateversion = $updateVersion;
-    }
-
-    /**
-     * @return bool
-     */
-    public function isNew()
-    {
-        return $this->id === null;
-    }
+	/** @var int ID of the object */
+	protected $id = null;
+	/** @var int update version for optimistic locking */
+	protected $updateversion = 0;
+	/**
+	 * @var PdoDatabase
+	 */
+	protected $dbObject;
+
+	/**
+	 * Retrieves a data object by it's row ID.
+	 *
+	 * @param int         $id
+	 * @param PdoDatabase $database
+	 *
+	 * @return DataObject|false
+	 */
+	public static function getById($id, PdoDatabase $database)
+	{
+		$array = explode('\\', get_called_class());
+		$realClassName = strtolower(end($array));
+
+		$statement = $database->prepare("SELECT * FROM {$realClassName} WHERE id = :id LIMIT 1;");
+		$statement->bindValue(":id", $id);
+
+		$statement->execute();
+
+		$resultObject = $statement->fetchObject(get_called_class());
+
+		if ($resultObject != false) {
+			$resultObject->setDatabase($database);
+		}
+
+		return $resultObject;
+	}
+
+	public function setDatabase(PdoDatabase $db)
+	{
+		$this->dbObject = $db;
+	}
+
+	/**
+	 * Gets the database associated with this data object.
+	 * @return PdoDatabase
+	 */
+	public function getDatabase()
+	{
+		return $this->dbObject;
+	}
+
+	/**
+	 * Saves a data object to the database, either updating or inserting a record.
+	 *
+	 * @return void
+	 */
+	abstract public function save();
+
+	/**
+	 * Retrieves the ID attribute
+	 */
+	public function getId()
+	{
+		return (int)$this->id;
+	}
+
+	/**
+	 * Deletes the object from the database
+	 */
+	public function delete()
+	{
+		if ($this->id === null) {
+			// wtf?
+			return;
+		}
+
+		$array = explode('\\', get_called_class());
+		$realClassName = strtolower(end($array));
+
+		$deleteQuery = "DELETE FROM {$realClassName} WHERE id = :id AND updateversion = :updateversion LIMIT 1;";
+		$statement = $this->dbObject->prepare($deleteQuery);
+
+		$statement->bindValue(":id", $this->id);
+		$statement->bindValue(":updateversion", $this->updateversion);
+		$statement->execute();
+
+		if ($statement->rowCount() !== 1) {
+			throw new OptimisticLockFailedException();
+		}
+
+		$this->id = null;
+	}
+
+	/**
+	 * @return int
+	 */
+	public function getUpdateVersion()
+	{
+		return $this->updateversion;
+	}
+
+	/**
+	 * Sets the update version.
+	 *
+	 * You should never call this to change the value of the update version. You should only call it when passing user
+	 * input through.
+	 *
+	 * @param int $updateVersion
+	 */
+	public function setUpdateVersion($updateVersion)
+	{
+		$this->updateversion = $updateVersion;
+	}
+
+	/**
+	 * @return bool
+	 */
+	public function isNew()
+	{
+		return $this->id === null;
+	}
 }

includes/Offline.php

Indentation +43 added lines, -43 removed lines

@@ -15,55 +15,55 @@
  */
 class Offline
 {
-    /**
-     * Determines if the tool is offline
-     * @return bool
-     */
-    public static function isOffline()
-    {
-        global $dontUseDb;
+	/**
+	 * Determines if the tool is offline
+	 * @return bool
+	 */
+	public static function isOffline()
+	{
+		global $dontUseDb;
 
-        return (bool)$dontUseDb;
-    }
+		return (bool)$dontUseDb;
+	}
 
-    /**
-     * Gets the offline message
-     *
-     * @param bool $external
-     * @param null $message
-     *
-     * @return string
-     */
-    public static function getOfflineMessage($external, $message = null)
-    {
-        global $dontUseDbCulprit, $dontUseDbReason, $baseurl;
+	/**
+	 * Gets the offline message
+	 *
+	 * @param bool $external
+	 * @param null $message
+	 *
+	 * @return string
+	 */
+	public static function getOfflineMessage($external, $message = null)
+	{
+		global $dontUseDbCulprit, $dontUseDbReason, $baseurl;
 
-        $smarty = new Smarty();
-        $smarty->assign("baseurl", $baseurl);
-        $smarty->assign("toolversion", Environment::getToolVersion());
+		$smarty = new Smarty();
+		$smarty->assign("baseurl", $baseurl);
+		$smarty->assign("toolversion", Environment::getToolVersion());
 
-        if (!headers_sent()) {
-            header("HTTP/1.1 503 Service Unavailable");
-        }
+		if (!headers_sent()) {
+			header("HTTP/1.1 503 Service Unavailable");
+		}
 
-        if ($external) {
-            return $smarty->fetch("offline/external.tpl");
-        }
-        else {
-            $hideCulprit = true;
+		if ($external) {
+			return $smarty->fetch("offline/external.tpl");
+		}
+		else {
+			$hideCulprit = true;
 
-            // Use the provided message if possible
-            if ($message === null) {
-                $hideCulprit = false;
-                $message = $dontUseDbReason;
-            }
+			// Use the provided message if possible
+			if ($message === null) {
+				$hideCulprit = false;
+				$message = $dontUseDbReason;
+			}
 
-            $smarty->assign("hideCulprit", $hideCulprit);
-            $smarty->assign("dontUseDbCulprit", $dontUseDbCulprit);
-            $smarty->assign("dontUseDbReason", $message);
-            $smarty->assign("alerts", array());
+			$smarty->assign("hideCulprit", $hideCulprit);
+			$smarty->assign("dontUseDbCulprit", $dontUseDbCulprit);
+			$smarty->assign("dontUseDbReason", $message);
+			$smarty->assign("alerts", array());
 
-            return $smarty->fetch("offline/internal.tpl");
-        }
-    }
+			return $smarty->fetch("offline/internal.tpl");
+		}
+	}
 }

includes/Pages/Request/PageEmailConfirmationRequired.php

Indentation +8 added lines, -8 removed lines

@@ -12,12 +12,12 @@
 
 class PageEmailConfirmationRequired extends PublicInterfacePageBase
 {
-    /**
-     * Main function for this page, when no specific actions are called.
-     * @return void
-     */
-    protected function main()
-    {
-        $this->setTemplate('request/email-confirmation.tpl');
-    }
+	/**
+	 * Main function for this page, when no specific actions are called.
+	 * @return void
+	 */
+	protected function main()
+	{
+		$this->setTemplate('request/email-confirmation.tpl');
+	}
 }
\ No newline at end of file

includes/Pages/Request/PageRequestAccount.php

Indentation +146 added lines, -146 removed lines

@@ -19,150 +19,150 @@
 
 class PageRequestAccount extends PublicInterfacePageBase
 {
-    /**
-     * Main function for this page, when no specific actions are called.
-     * @return void
-     */
-    protected function main()
-    {
-        // dual mode page
-        if (WebRequest::wasPosted()) {
-            $request = $this->createNewRequest();
-
-            $validationErrors = $this->validateRequest($request);
-
-            if (count($validationErrors) > 0) {
-                foreach ($validationErrors as $validationError) {
-                    SessionAlert::error($validationError->getErrorMessage());
-                }
-
-                // Preserve the data after an error
-                WebRequest::setSessionContext('accountReq',
-                    array(
-                        'username' => WebRequest::postString('name'),
-                        'email'    => WebRequest::postEmail('email'),
-                        'comments' => WebRequest::postString('comments'),
-                    )
-                );
-
-                // Validation error, bomb out early.
-                $this->redirect();
-
-                return;
-            }
-
-            // actually save the request to the database
-            if ($this->getSiteConfiguration()->getEmailConfirmationEnabled()) {
-                $this->saveAsEmailConfirmation($request);
-            }
-            else {
-                $this->saveWithoutEmailConfirmation($request);
-            }
-        }
-        else {
-            // set the form values from the session context
-            $context = WebRequest::getSessionContext('accountReq');
-            if ($context !== null && is_array($context)) {
-                $this->assign('username', $context['username']);
-                $this->assign('email', $context['email']);
-                $this->assign('comments', $context['comments']);
-            }
-
-            // Clear it for a refresh
-            WebRequest::setSessionContext('accountReq', null);
-
-            $this->setTemplate('request/request-form.tpl');
-        }
-    }
-
-    /**
-     * @return Request
-     */
-    protected function createNewRequest()
-    {
-        $request = new Request();
-        $request->setDatabase($this->getDatabase());
-
-        $request->setName(WebRequest::postString('name'));
-        $request->setEmail(WebRequest::postEmail('email'));
-        $request->setComment(WebRequest::postString('comments'));
-
-        $request->setIp(WebRequest::remoteAddress());
-        $request->setForwardedIp(WebRequest::forwardedAddress());
-
-        $request->setUserAgent(WebRequest::userAgent());
-
-        return $request;
-    }
-
-    /**
-     * @param Request $request
-     *
-     * @return ValidationError[]
-     */
-    protected function validateRequest($request)
-    {
-        $validationHelper = new RequestValidationHelper(
-            new BanHelper($this->getDatabase()),
-            $request,
-            WebRequest::postEmail('emailconfirm'),
-            $this->getDatabase(),
-            $this->getAntiSpoofProvider(),
-            $this->getXffTrustProvider(),
-            $this->getHttpHelper(),
-            $this->getSiteConfiguration()->getMediawikiWebServiceEndpoint(),
-            $this->getSiteConfiguration()->getTitleBlacklistEnabled(),
-            $this->getTorExitProvider());
-
-        // These are arrays of ValidationError.
-        $nameValidation = $validationHelper->validateName();
-        $emailValidation = $validationHelper->validateEmail();
-        $otherValidation = $validationHelper->validateOther();
-
-        $validationErrors = array_merge($nameValidation, $emailValidation, $otherValidation);
-
-        return $validationErrors;
-    }
-
-    /**
-     * @param Request $request
-     *
-     * @throws Exception
-     */
-    protected function saveAsEmailConfirmation(Request $request)
-    {
-        $request->generateEmailConfirmationHash();
-        $request->save();
-
-        $trustedIp = $this->getXffTrustProvider()->getTrustedClientIp(
-            $request->getIp(),
-            $request->getForwardedIp());
-
-        $this->assign("ip", $trustedIp);
-        $this->assign("id", $request->getId());
-        $this->assign("hash", $request->getEmailConfirm());
-
-        // Sends the confirmation email to the user.
-        $this->getEmailHelper()->sendMail(
-            $request->getEmail(),
-            "[ACC #{$request->getId()}] English Wikipedia Account Request",
-            $this->fetchTemplate('request/confirmation-mail.tpl'));
-
-        $this->redirect('emailConfirmationRequired');
-    }
-
-    /**
-     * @param Request $request
-     *
-     * @throws Exception
-     */
-    protected function saveWithoutEmailConfirmation(Request $request)
-    {
-        $request->setEmailConfirm(0); // fixme Since it can't be null
-        $request->save();
-
-        $this->getNotificationHelper()->requestReceived($request);
-
-        $this->redirect('requestSubmitted');
-    }
+	/**
+	 * Main function for this page, when no specific actions are called.
+	 * @return void
+	 */
+	protected function main()
+	{
+		// dual mode page
+		if (WebRequest::wasPosted()) {
+			$request = $this->createNewRequest();
+
+			$validationErrors = $this->validateRequest($request);
+
+			if (count($validationErrors) > 0) {
+				foreach ($validationErrors as $validationError) {
+					SessionAlert::error($validationError->getErrorMessage());
+				}
+
+				// Preserve the data after an error
+				WebRequest::setSessionContext('accountReq',
+					array(
+						'username' => WebRequest::postString('name'),
+						'email'    => WebRequest::postEmail('email'),
+						'comments' => WebRequest::postString('comments'),
+					)
+				);
+
+				// Validation error, bomb out early.
+				$this->redirect();
+
+				return;
+			}
+
+			// actually save the request to the database
+			if ($this->getSiteConfiguration()->getEmailConfirmationEnabled()) {
+				$this->saveAsEmailConfirmation($request);
+			}
+			else {
+				$this->saveWithoutEmailConfirmation($request);
+			}
+		}
+		else {
+			// set the form values from the session context
+			$context = WebRequest::getSessionContext('accountReq');
+			if ($context !== null && is_array($context)) {
+				$this->assign('username', $context['username']);
+				$this->assign('email', $context['email']);
+				$this->assign('comments', $context['comments']);
+			}
+
+			// Clear it for a refresh
+			WebRequest::setSessionContext('accountReq', null);
+
+			$this->setTemplate('request/request-form.tpl');
+		}
+	}
+
+	/**
+	 * @return Request
+	 */
+	protected function createNewRequest()
+	{
+		$request = new Request();
+		$request->setDatabase($this->getDatabase());
+
+		$request->setName(WebRequest::postString('name'));
+		$request->setEmail(WebRequest::postEmail('email'));
+		$request->setComment(WebRequest::postString('comments'));
+
+		$request->setIp(WebRequest::remoteAddress());
+		$request->setForwardedIp(WebRequest::forwardedAddress());
+
+		$request->setUserAgent(WebRequest::userAgent());
+
+		return $request;
+	}
+
+	/**
+	 * @param Request $request
+	 *
+	 * @return ValidationError[]
+	 */
+	protected function validateRequest($request)
+	{
+		$validationHelper = new RequestValidationHelper(
+			new BanHelper($this->getDatabase()),
+			$request,
+			WebRequest::postEmail('emailconfirm'),
+			$this->getDatabase(),
+			$this->getAntiSpoofProvider(),
+			$this->getXffTrustProvider(),
+			$this->getHttpHelper(),
+			$this->getSiteConfiguration()->getMediawikiWebServiceEndpoint(),
+			$this->getSiteConfiguration()->getTitleBlacklistEnabled(),
+			$this->getTorExitProvider());
+
+		// These are arrays of ValidationError.
+		$nameValidation = $validationHelper->validateName();
+		$emailValidation = $validationHelper->validateEmail();
+		$otherValidation = $validationHelper->validateOther();
+
+		$validationErrors = array_merge($nameValidation, $emailValidation, $otherValidation);
+
+		return $validationErrors;
+	}
+
+	/**
+	 * @param Request $request
+	 *
+	 * @throws Exception
+	 */
+	protected function saveAsEmailConfirmation(Request $request)
+	{
+		$request->generateEmailConfirmationHash();
+		$request->save();
+
+		$trustedIp = $this->getXffTrustProvider()->getTrustedClientIp(
+			$request->getIp(),
+			$request->getForwardedIp());
+
+		$this->assign("ip", $trustedIp);
+		$this->assign("id", $request->getId());
+		$this->assign("hash", $request->getEmailConfirm());
+
+		// Sends the confirmation email to the user.
+		$this->getEmailHelper()->sendMail(
+			$request->getEmail(),
+			"[ACC #{$request->getId()}] English Wikipedia Account Request",
+			$this->fetchTemplate('request/confirmation-mail.tpl'));
+
+		$this->redirect('emailConfirmationRequired');
+	}
+
+	/**
+	 * @param Request $request
+	 *
+	 * @throws Exception
+	 */
+	protected function saveWithoutEmailConfirmation(Request $request)
+	{
+		$request->setEmailConfirm(0); // fixme Since it can't be null
+		$request->save();
+
+		$this->getNotificationHelper()->requestReceived($request);
+
+		$this->redirect('requestSubmitted');
+	}
 }
\ No newline at end of file

includes/Pages/Request/PageRequestSubmitted.php

Indentation +8 added lines, -8 removed lines

@@ -12,12 +12,12 @@
 
 class PageRequestSubmitted extends PublicInterfacePageBase
 {
-    /**
-     * Main function for this page, when no specific actions are called.
-     * @return void
-     */
-    protected function main()
-    {
-        $this->setTemplate('request/email-confirmed.tpl');
-    }
+	/**
+	 * Main function for this page, when no specific actions are called.
+	 * @return void
+	 */
+	protected function main()
+	{
+		$this->setTemplate('request/email-confirmed.tpl');
+	}
 }
\ No newline at end of file