hashover/scripts/locale.php

<?php namespace HashOver;

// Copyright (C) 2010-2017 Jacob Barkdull
// This file is part of HashOver.
//
// HashOver is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as
// published by the Free Software Foundation, either version 3 of the
// License, or (at your option) any later version.
//
// HashOver is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with HashOver.  If not, see <http://www.gnu.org/licenses/>.


// Display source code
if (basename ($_SERVER['PHP_SELF']) === basename (__FILE__)) {
	if (isset ($_GET['source'])) {
		header ('Content-type: text/plain; charset=UTF-8');
		exit (file_get_contents (basename (__FILE__)));
	} else {
		exit ('<b>HashOver</b>: This is a class file.');
	}
}

class Locale
{
	public $setup;
	public $mode;
	public $text;

	public function __construct (Setup $setup)
	{
		$this->setup = $setup;
		$this->mode = $setup->usage['mode'];

		// Get appropriate locale file
		$locale_file_path = $this->getLocaleFile ();

		// Include the locale file
		$this->includeLocaleFile ($locale_file_path);

		// Prepare locale
		$this->prepareLocale ();
	}

	// Check for PHP locale file
	protected function getLocaleFile ()
	{
		// Locales checklist
		$locales = array ();

		// Lowercase language code
		$language = mb_strtolower ($this->setup->language);

		// Check if we are automatically selecting the locale
		if ($language === 'auto') {
			// If so, get system locale
			$system_locale = mb_strtolower (setlocale (LC_CTYPE, 0));

			// Split the locale into specific parts
			$locale_parts = explode ('.', $system_locale);
			$language_parts = explode ('_', $locale_parts[0]);

			// Add locale in 'en-us' format to checklist
			$full_locale = str_replace ('_', '-', $locale_parts[0]);
			$locales[] = $full_locale;

			// Add front part of locale ('en') to checklist
			$locales[] = $language_parts[0];

			// Add end part of locale ('us') to checklist
			if (!empty ($language_parts[1])) {
				$locales[] = $language_parts[1];
			}
		} else {
			// If not, add configured locale to checklist
			$locales[] = $language;
		}

		foreach ($locales as $locale) {
			// Locale file path
			$locale_file = __DIR__ . '/locales/' . $locale . '.php';

			// Check if a locale file exists for current locale
			if (file_exists ($locale_file)) {
				// If so, return PHP locale file path
				return $locale_file;
			}
		}

		// Otherwise, default to English
		return __DIR__ . '/locales/en.php';
	}

	protected function includeLocaleFile ($file)
	{
		// Check if the locale file can be included
		if (@include ($file)) {
			// If so, set locale to array stored in the file
			$this->text = $locale;
		} else {
			// If not, throw exception
			$language = strtoupper ($language);
			$exception = $language . ' locale file could not be included!';

			throw new \Exception ($exception);
		}
	}

	// Prepares locale by modifing them in various ways
	public function prepareLocale ()
	{
		foreach ($this->text as $key => $value) {
			switch ($key) {
				// Add optionality to form field title locales
				case 'name-tip':
				case 'password-tip':
				case 'email-tip':
				case 'website-tip': {
					$field = str_replace ('-tip', '', $key);
					$option = $this->setup->fieldOptions[$field];
					$option = ($option === 'required') ? 'required' : 'optional';
					$option_locale = mb_strtolower ($this->text[$option]);

					$field_tip = sprintf ($this->text[$key], $option_locale);
					$this->set ($key, $field_tip);
					break;
				}

				// Inject date and time formats into date-time locale
				case 'date-time': {
					$date_format = $this->setup->dateFormat;
					$time_format = $this->setup->timeFormat;

					$date_time = sprintf ($value, $date_format, $time_format);
					$this->set ($key, $date_time);
					break;
				}
			}
		}
	}

	// Sets a locale string
	public function set ($name, $value)
	{
		$this->text[$name] = $value;
	}

	// Returns a locale string, optionally adding C-style escaping
	public function get ($name, $add_slashes = true, $charlist = "\\'")
	{
		// Don't escape given string in PHP mode or if told not to
		if ($this->mode === 'php' or $add_slashes === false) {
			return $this->text[$name];
		}

		// Check if locale is an array
		if (is_array ($this->text[$name])) {
			$escaped_array = array ();

			// If so, escape each item in the array
			foreach ($this->text[$name] as $key => $value) {
				$escaped_array[$key] = addcslashes ($value, $charlist);
			}

			// And return the new array
			return $escaped_array;
		}

		// Otherwise escape the single string
		return addcslashes ($this->text[$name], $charlist);
	}
}