New SysConfig module for adding a logo

1 files changed, 213 insertions, 0 deletions

diff --git a/modules/sysconfig/addmodule_branding.inc.php b/modules/sysconfig/addmodule_branding.inc.php
new file mode 100644
index 00000000..6515a850
--- /dev/null
+++ b/modules/sysconfig/addmodule_branding.inc.php
@@ -0,0 +1,213 @@
+<?php
+
+/*
+ * Wizard for including a branding logo.
+ */
+
+Page_SysConfig::addModule('BRANDING', 'Branding_Start', 'Logo der Einrichtung', 'Dieses Modul dient dem Hinzufügen eines Logos der Hochschule/Universität, welches'
+	. ' dann z.B. auf dem Anmeldebildschirm angezeigt wird.', 'Branding', false
+);
+
+class Branding_Start extends AddModule_Base
+{
+
+	protected function renderInternal()
+	{
+		Render::addDialog('Einrichtungsspezifisches Logo', false, 'sysconfig/branding-start', array(
+			'step' => 'Branding_ProcessFile',
+		));
+	}
+
+}
+
+class Branding_ProcessFile extends AddModule_Base
+{
+
+	private $task;
+	private $svgFile;
+	private $tarFile;
+
+	protected function preprocessInternal()
+	{
+		$url = Request::post('url');
+		if ((!isset($_FILES['file']['error']) || $_FILES['file']['error'] === UPLOAD_ERR_NO_FILE) && empty($url)) {
+			Message::addError('empty-field');
+			Util::redirect('?do=SysConfig&action=addmodule&step=Branding_Start');
+		}
+		
+		$this->svgFile = tempnam(sys_get_temp_dir(), 'bwlp-');
+		if (isset($_FILES['file']['error']) && $_FILES['file']['error'] !== UPLOAD_ERR_NO_FILE) {
+			// Prefer uploaded image over URL (in case both are given)
+			if ($_FILES['file']['error'] !== UPLOAD_ERR_OK) {
+				Message::addError('upload-failed', Util::uploadErrorString($_FILES['file']['error']));
+				Util::redirect('?do=SysConfig&action=addmodule&step=Branding_Start');
+			}
+			if (!move_uploaded_file($_FILES["file"]["tmp_name"], $this->svgFile)) {
+				Message::addError('upload-failed', 'Moving temp file failed');
+				Util::redirect('?do=SysConfig&action=addmodule&step=Branding_Start');
+			}
+		} else {
+			// URL - launch task that fetches the SVG file from it
+			if (strpos($url, '://') === false)
+				$url = "http://$url";
+			if (!$this->downloadSvg($this->svgFile, $url))
+				Util::redirect('?do=SysConfig&action=addmodule&step=Branding_Start');
+		}
+		chmod($this->svgFile, 0644);
+		$this->tarFile = '/tmp/bwlp-' . time() . '-' . mt_rand() . '.tgz';
+		$this->task = Taskmanager::submit('BrandingGenerator', array(
+				'tarFile' => $this->tarFile,
+				'svgFile' => $this->svgFile
+		));
+		$this->task = Taskmanager::waitComplete($this->task);
+		if (Taskmanager::isFailed($this->task)) {
+			@unlink($this->svgFile);
+			Taskmanager::addErrorMessage($this->task);
+			Util::redirect('?do=SysConfig&action=addmodule&step=Branding_Start');
+		}
+		Session::set('logo_tgz', $this->tarFile);
+		Session::save();
+	}
+
+	protected function renderInternal()
+	{
+		$svg = $png = false;
+		if (isset($this->task['data']['pngFile']))
+			$png = base64_encode(file_get_contents($this->task['data']['pngFile']));
+		if (filesize($this->svgFile) < 1000000)
+			$svg = base64_encode(file_get_contents($this->svgFile));
+		Render::addDialog('Einrichtungsspezifisches Logo', false, 'sysconfig/branding-check', array(
+			'png' => $png,
+			'svg' => $svg,
+			'error' => $this->task['data']['error'],
+			'step' => 'Branding_Finish',
+			)
+		);
+		@unlink($this->svgFile);
+	}
+
+	/**
+	 * Downlaod an svg file from the given url. This function has "wikipedia support", it tries to detect
+	 * URLs in wikipedia articles or thumbnails and then find the actual svg file.
+	 *
+	 * @param string $svgName file to download to
+	 * @param string $url url to download from
+	 * @return boolean true of download succeded, false on download error (also returns true if downloaded file doesn't
+	 * 		seem to be svg!)
+	 */
+	private function downloadSvg($svgName, $url)
+	{
+		// [wikipedia] Did someone paste a link to a thumbnail of the svg? Let's fix that...
+		if (preg_match('#^(.*)/thumb/(.*\.svg)/.*\.svg#', $url, $out)) {
+			$url = $out[1] . '/' . $out[2];
+		}
+		for ($i = 0; $i < 5; ++$i) {
+			$code = 400;
+			if (!Download::toFile($svgName, $url, 3, $code) || $code < 200 || $code > 299) {
+				Message::addError('remote-timeout', $url, $code);
+				return false;
+			}
+			$content = Util::readFile($svgName, 25000);
+			// Is svg file?
+			if (strpos($content, '<svg') !== false)
+				return true; // Found an svg tag - don't try to find links to the actual image
+				
+			// [wikipedia] Try to be nice and detect links that might give a hint where the svg can be found
+			if (preg_match_all('#href="([^"]*upload.wikimedia.org/[^"]*/[^"]*/[^"]*\.svg|[^"]+/[^"]+:[^"]+\.svg[^"]*)"#', $content, $out, PREG_PATTERN_ORDER)) {
+				foreach ($out[1] as $res) {
+					if (!strpos($res, 'action=edit')) {
+						$new = $this->internetCombineUrl($url, html_entity_decode($res, ENT_COMPAT, 'UTF-8'));
+						if ($new !== $url)
+							break;
+					}
+				}
+				if ($new === $url)
+					break;
+				$url = $new;
+				continue;
+			}
+			break;
+		}
+		return true;
+	}
+
+	/**
+	 * Make relative url absolute.
+	 *
+	 * @param string $absolute absolute url to use as base
+	 * @param string $relative relative url that will be converted to an absolute url
+	 * @return string combined absolute url
+	 */
+	private function internetCombineUrl($absolute, $relative)
+	{
+		$p = parse_url($relative);
+		if (!empty($p["scheme"]))
+			return $relative;
+
+		extract(parse_url($absolute));
+
+		$path = dirname($path);
+
+		if ($relative{0} === '/') {
+			if ($relative{1} === '/')
+				return "$scheme:$relative";
+			$cparts = array_filter(explode("/", $relative));
+		} else {
+			$aparts = array_filter(explode("/", $path));
+			$rparts = array_filter(explode("/", $relative));
+			$cparts = array_merge($aparts, $rparts);
+			foreach ($cparts as $i => $part) {
+				if ($part == '.') {
+					$cparts[$i] = null;
+				}
+				if ($part == '..') {
+					$cparts[$i - 1] = null;
+					$cparts[$i] = null;
+				}
+			}
+			$cparts = array_filter($cparts);
+		}
+		$path = implode("/", $cparts);
+		$url = "";
+		if ($scheme)
+			$url = "$scheme://";
+		if (!empty($user)) {
+			$url .= "$user";
+			if (!empty($pass)) {
+				$url .= ":$pass";
+			}
+			$url .= "@";
+		}
+		if ($host)
+			$url .= "$host/";
+		$url .= $path;
+		return $url;
+	}
+
+}
+
+class Branding_Finish extends AddModule_Base
+{
+	
+	protected function preprocessInternal()
+	{
+		$title = Request::post('title');
+		if ($title === false || empty($title)) {
+			Message::addError('missing-file'); // TODO: Ask for title again instead of starting over
+			Util::redirect('?do=SysConfig&action=addmodule&step=Branding_Start');
+		}
+		$tgz = Session::get('logo_tgz');
+		if ($tgz === false || !file_exists($tgz)) {
+			Message::addError('missing-file');
+			Util::redirect('?do=SysConfig&action=addmodule&step=Branding_Start');
+		}
+		if (!ConfigModule::insertBrandingModule($title, $tgz))
+			Util::redirect('?do=SysConfig&action=addmodule&step=Branding_Start');
+		Session::set('logo_tgz', false);
+		Session::save();
+		// Yay
+		Message::addSuccess('module-added');
+		Util::redirect('?do=SysConfig');
+	}
+
+}