Accessibility ♿

Signed-off-by: John Molakvoæ (skjnldsv) <skjnldsv@protonmail.com>

5 files changed, 497 insertions, 0 deletions

diff --git a/apps/accessibility/lib/AccessibilityProvider.php b/apps/accessibility/lib/AccessibilityProvider.php
new file mode 100644
index 00000000000..036ddf97660
--- /dev/null
+++ b/apps/accessibility/lib/AccessibilityProvider.php
@@ -0,0 +1,83 @@
+<?php
+
+/**
+ * @copyright Copyright (c) 2018 John Molakvoæ <skjnldsv@protonmail.com>
+ *
+ * @author John Molakvoæ <skjnldsv@protonmail.com>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program 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.
+ *
+ * This program 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 this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace OCA\Accessibility;
+
+use OCP\IL10N;
+use OCP\IURLGenerator;
+
+class AccessibilityProvider {
+
+	/** @var string */
+	protected $appName;
+
+	/** @var IURLGenerator */
+	private $urlGenerator;
+
+	/** @var IL10N */
+	private $l;
+
+	/**
+	 * Account constructor.
+	 *
+	 * @param string $appName
+	 * @param IURLGenerator $urlGenerator
+	 * @param IL10N $l
+	 */
+	public function __construct(string $appName,
+								IURLGenerator $urlGenerator,
+								IL10N $l) {
+		$this->appName      = $appName;
+		$this->urlGenerator = $urlGenerator;
+		$this->l            = $l;
+	}
+
+	public function getThemes() {
+		return array(
+			[
+				'id'    => 'highcontrast',
+				'img'   => $this->urlGenerator->imagePath($this->appName, 'theme-highcontrast.jpg'),
+				'title' => $this->l->t('High Contrast theme'),
+				'text'  => $this->l->t('A high contrast theme to ease your navigation. Visual quality will be reduced but clarity will be increased.')
+			], [
+				'id'    => 'dark',
+				'img'   => $this->urlGenerator->imagePath($this->appName, 'theme-dark.jpg'),
+				'title' => $this->l->t('Dark theme'),
+				'text'  => $this->l->t('A dark theme to ease your eyes by reducing the overall luminosity and brightness of your navigation. This is suitable for people who use computes a lot or in low luminosity spaces.')
+			]
+		);
+	}
+
+	public function getFonts() {
+		return array(
+			[
+				'id'    => 'dyslexic',
+				'img'   => $this->urlGenerator->imagePath($this->appName, 'font-opendyslexic.jpg'),
+				'title' => $this->l->t('Dyslexia font'),
+				'text'  => $this->l->t('OpenDyslexic is a free typeface/font designed to mitigate some of the common reading errors caused by dyslexia. The typeface was created by Abelardo Gonzalez, who released it through an open-source license.')
+			]
+		);
+	}
+
+}
\ No newline at end of file
diff --git a/apps/accessibility/lib/AppInfo/Application.php b/apps/accessibility/lib/AppInfo/Application.php
new file mode 100644
index 00000000000..1c5e4b5cec1
--- /dev/null
+++ b/apps/accessibility/lib/AppInfo/Application.php
@@ -0,0 +1,39 @@
+<?php
+/**
+ * @copyright Copyright (c) 2018 John Molakvoæ <skjnldsv@protonmail.com>
+ *
+ * @author John Molakvoæ <skjnldsv@protonmail.com>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program 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.
+ *
+ * This program 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 this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace OCA\Accessibility\AppInfo;
+
+use OCP\AppFramework\App;
+
+class Application extends App {
+
+	/** @var string */
+	protected $appName = 'accessibility';
+
+	public function __construct() {
+		parent::__construct($this->appName);
+        
+        // Inject the fake css on all pages
+        \OCP\Util::addStyle('accessibility', 'user', true);
+	}
+}
diff --git a/apps/accessibility/lib/Controller/AccessibilityController.php b/apps/accessibility/lib/Controller/AccessibilityController.php
new file mode 100644
index 00000000000..ee1f42dfebb
--- /dev/null
+++ b/apps/accessibility/lib/Controller/AccessibilityController.php
@@ -0,0 +1,168 @@
+<?php
+declare (strict_types = 1);
+/**
+ * @copyright Copyright (c) 2018 John Molakvoæ (skjnldsv) <skjnldsv@protonmail.com>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program 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.
+ *
+ * This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace OCA\Accessibility\Controller;
+
+use Leafo\ScssPhp\Compiler;
+use Leafo\ScssPhp\Exception\ParserException;
+use Leafo\ScssPhp\Formatter\Crunched;
+use OCP\AppFramework\Controller;
+use OCP\AppFramework\Http;
+use OCP\AppFramework\Http\DataDisplayResponse;
+use OCP\AppFramework\Utility\ITimeFactory;
+use OCP\IConfig;
+use OCP\ILogger;
+use OCP\IRequest;
+use OCP\IURLGenerator;
+use OCP\IUserManager;
+use OCP\IUserSession;
+
+class AccessibilityController extends Controller {
+
+	/** @var string */
+	protected $appName;
+
+	/** @var string */
+	protected $serverRoot;
+
+	/** @var IConfig */
+	private $config;
+
+	/** @var IUserManager */
+	private $userManager;
+
+	/** @var ILogger */
+	private $logger;
+
+	/** @var IURLGenerator */
+	private $urlGenerator;
+
+	/** @var ITimeFactory */
+	protected $timeFactory;
+
+	/** @var IUserSession */
+	private $userSession;
+
+	/**
+	 * Account constructor.
+	 *
+	 * @param string $appName
+	 * @param IRequest $request
+	 * @param IConfig $config
+	 * @param IUserManager $userManager
+	 * @param ILogger $logger
+	 * @param IURLGenerator $urlGenerator
+	 * @param ITimeFactory $timeFactory
+	 * @param IUserSession $userSession
+	 */
+	public function __construct(string $appName,
+		IRequest $request,
+		IConfig $config,
+		IUserManager $userManager,
+		ILogger $logger,
+		IURLGenerator $urlGenerator,
+		ITimeFactory $timeFactory,
+		IUserSession $userSession) {
+		parent::__construct($appName, $request);
+		$this->config       = $config;
+		$this->userManager  = $userManager;
+		$this->logger       = $logger;
+		$this->urlGenerator = $urlGenerator;
+		$this->timeFactory  = $timeFactory;
+		$this->userSession  = $userSession;
+
+		$this->serverRoot = \OC::$SERVERROOT;
+		$this->appRoot    = \OC_App::getAppPath($this->appName);
+	}
+
+	/**
+	 * @NoAdminRequired
+	 * @NoCSRFRequired
+	 *
+	 * @return DataResponse
+	 */
+	public function getCss(): DataDisplayResponse {
+
+		$css     = '';
+		$imports = '';
+
+		foreach ($this->getUserValues() as $scssFile) {
+			if ($scssFile !== false) {
+				$imports .= '@import "' . $scssFile . '";';
+			}
+		}
+
+		if ($imports !== '') {
+			$scss = new Compiler();
+			$scss->setImportPaths([
+				$this->appRoot . '/css/',
+				$this->serverRoot . '/core/css/'
+			]);
+
+			// Continue after throw
+			$scss->setIgnoreErrors(true);
+			$scss->setFormatter(Crunched::class);
+
+			// Compile
+			try {
+				$css .= $scss->compile(
+					$imports .
+					'@import "variables.scss";' .
+					'@import "css-variables.scss";'
+				);
+			} catch (ParserException $e) {
+				$this->logger->error($e->getMessage(), ['app' => 'core']);
+			}
+		}
+
+		// We don't want to override vars with url since path is different
+		$css = $this->filterOutRule('/--[a-z-:]+url\([^;]+\)/mi', $css);
+
+		$response = new DataDisplayResponse($css, Http::STATUS_OK, ['Content-Type' => 'text/css']);
+
+		$ttl = 31536000;
+		$response->addHeader('Cache-Control', 'max-age=' . $ttl . ', immutable');
+
+		$expires = new \DateTime();
+		$expires->setTimestamp($this->timeFactory->getTime());
+		$expires->add(new \DateInterval('PT' . $ttl . 'S'));
+		$response->addHeader('Expires', $expires->format(\DateTime::RFC1123));
+		$response->addHeader('Pragma', 'cache');
+
+		return $response;
+	}
+
+	private function getUserValues() {
+		$userTheme = $this->config->getUserValue($this->userSession->getUser()->getUID(), 'accessibility', 'theme', false);
+		$userFont  = $this->config->getUserValue($this->userSession->getUser()->getUID(), 'accessibility', 'font', false);
+
+		return [
+			'theme' => $userTheme,
+			'font'  => $userFont
+		];
+	}
+
+	private function filterOutRule(string $rule, string $css) {
+		return preg_replace($rule, '', $css);
+	}
+
+}
diff --git a/apps/accessibility/lib/Settings/Personal.php b/apps/accessibility/lib/Settings/Personal.php
new file mode 100644
index 00000000000..d28625449a7
--- /dev/null
+++ b/apps/accessibility/lib/Settings/Personal.php
@@ -0,0 +1,113 @@
+<?php
+/**
+ * @copyright Copyright (c) 2018 John Molakvoæ <skjnldsv@protonmail.com>
+ *
+ * @author John Molakvoæ <skjnldsv@protonmail.com>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program 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.
+ *
+ * This program 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 this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace OCA\Accessibility\Settings;
+
+use OCA\Accessibility\AccessibilityProvider;
+use OCP\AppFramework\Http\TemplateResponse;
+use OCP\IConfig;
+use OCP\IL10N;
+use OCP\IURLGenerator;
+use OCP\IUserSession;
+use OCP\Settings\ISettings;
+
+class Personal implements ISettings {
+
+	/** @var string */
+	protected $appName;
+
+	/** @var IConfig */
+	private $config;
+
+	/** @var IUserSession */
+	private $userSession;
+
+	/** @var IL10N */
+	private $l;
+
+	/** @var IURLGenerator */
+	private $urlGenerator;
+
+	/** @var AccessibilityProvider */
+	private $accessibilityProvider;
+
+	/**
+	 * Settings constructor.
+	 *
+	 * @param string $appName
+	 * @param IConfig $config
+	 * @param IUserSession $userSession
+	 * @param IL10N $l
+	 * @param IURLGenerator $urlGenerator
+	 * @param AccessibilityProvider $accessibilityProvider
+	 */
+	public function __construct(string $appName,
+								IConfig $config,
+								IUserSession $userSession,
+								IL10N $l,
+								IURLGenerator $urlGenerator,
+								AccessibilityProvider $accessibilityProvider) {
+		$this->appName               = $appName;
+		$this->config                = $config;
+		$this->userSession           = $userSession;
+		$this->l                     = $l;
+		$this->urlGenerator          = $urlGenerator;
+		$this->accessibilityProvider = $accessibilityProvider;
+	}
+
+	/**
+	 * @return TemplateResponse returns the instance with all parameters set, ready to be rendered
+	 * @since 9.1
+	 */
+	public function getForm() {
+
+		$serverData = [
+			'themes' => $this->accessibilityProvider->getThemes(),
+			'fonts' => $this->accessibilityProvider->getFonts(),
+			'theme' => $this->config->getUserValue($this->userSession->getUser()->getUID(), 'accessibility', 'theme', 'dark'),
+			'font' => $this->config->getUserValue($this->userSession->getUser()->getUID(), 'accessibility', 'font', false)
+		];
+
+		return new TemplateResponse('accessibility', 'settings-personal', ['serverData' => $serverData]);
+	}
+
+	/**
+	 * @return string the section ID, e.g. 'sharing'
+	 * @since 9.1
+	 */
+	public function getSection() {
+		return 'accessibility';
+	}
+
+	/**
+	 * @return int whether the form should be rather on the top or bottom of
+	 * the admin section. The forms are arranged in ascending order of the
+	 * priority values. It is required to return a value between 0 and 100.
+	 *
+	 * E.g.: 70
+	 * @since 9.1
+	 */
+	public function getPriority() {
+		return 40;
+	}
+}
diff --git a/apps/accessibility/lib/Settings/PersonalSection.php b/apps/accessibility/lib/Settings/PersonalSection.php
new file mode 100644
index 00000000000..bd3afa79355
--- /dev/null
+++ b/apps/accessibility/lib/Settings/PersonalSection.php
@@ -0,0 +1,94 @@
+<?php
+/**
+ * @copyright Copyright (c) 2018 John Molakvoæ <skjnldsv@protonmail.com>
+ *
+ * @author John Molakvoæ <skjnldsv@protonmail.com>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program 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.
+ *
+ * This program 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 this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace OCA\Accessibility\Settings;
+
+use OCP\IL10N;
+use OCP\IURLGenerator;
+use OCP\Settings\IIconSection;
+
+class PersonalSection implements IIconSection {
+
+	/** @var IURLGenerator */
+	private $urlGenerator;
+
+	/** @var IL10N */
+	private $l;
+
+	/**
+	 * Personal Section constructor.
+	 *
+	 * @param IURLGenerator $urlGenerator
+	 * @param IL10N $l
+	 */
+	public function __construct(IURLGenerator $urlGenerator,
+								IL10N $l) {
+		$this->urlGenerator = $urlGenerator;
+		$this->l            = $l;
+	}
+
+	/**
+	 * returns the relative path to an 16*16 icon describing the section.
+	 * e.g. '/core/img/places/files.svg'
+	 *
+	 * @returns string
+	 * @since 13.0.0
+	 */
+	public function getIcon() {
+		return $this->urlGenerator->imagePath('accessibility', 'app-dark.svg');
+	}
+
+	/**
+	 * returns the ID of the section. It is supposed to be a lower case string,
+	 * e.g. 'ldap'
+	 *
+	 * @returns string
+	 * @since 9.1
+	 */
+	public function getID() {
+		return 'accessibility';
+	}
+
+	/**
+	 * returns the translated name as it should be displayed, e.g. 'LDAP / AD
+	 * integration'. Use the L10N service to translate it.
+	 *
+	 * @return string
+	 * @since 9.1
+	 */
+	public function getName() {
+		return $this->l->t('Accessibility');
+	}
+
+	/**
+	 * @return int whether the form should be rather on the top or bottom of
+	 * the settings navigation. The sections are arranged in ascending order of
+	 * the priority values. It is required to return a value between 0 and 99.
+	 *
+	 * E.g.: 70
+	 * @since 9.1
+	 */
+	public function getPriority() {
+		return 15;
+	}
+}