OCA\Mail\Controller\ProxyController

Complexity

Total Complexity

8

Size/Duplication

Total Lines	108
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	1

Test Coverage

Coverage

68.97%

Importance

Changes	1
Bugs	1	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	8	1
B	redirect()	0	23	4
A	proxy()	0	7	1
A	getUrlContent()	0	8	2

<?php

/**
 * @author Christoph Wurst <christoph@winzerhof-wurst.at>
 * @author Lukas Reschke <lukas@owncloud.com>
 * @author Lukas Reschke <lukas@statuscode.ch>
 * @author Thomas Müller <thomas.mueller@tmit.eu>
 *
 * ownCloud - Mail
 *
 * This code is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License, version 3,
 * as published by the Free Software Foundation.
 *
 * 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, version 3,
 * along with this program.  If not, see <http://www.gnu.org/licenses/>
 *
 */

namespace OCA\Mail\Controller;

use Exception;
use OCP\IRequest;
use OCP\ISession;
use OCP\IURLGenerator;
use OCP\AppFramework\Controller;
use OCP\AppFramework\Http\TemplateResponse;
use OCA\Mail\Http\ProxyDownloadResponse;

class ProxyController extends Controller {

	/**
	 * @var \OCP\IURLGenerator
	 */
	private $urlGenerator;

	/**
	 * @var \OCP\ISession
	 */
	private $session;

	/**
	 * @var string
	 */
	private $referrer;

	/**
	 * @var string
	 */
	private $hostname;

	/**
	 * @param string $appName
	 * @param \OCP\IRequest $request
	 * @param IURLGenerator $urlGenerator
	 * @param \OCP\ISession $session
	 */
	public function __construct($appName, IRequest $request,
		IURLGenerator $urlGenerator, ISession $session, $referrer, $hostname) {
		parent::__construct($appName, $request);
		$this->urlGenerator = $urlGenerator;
		$this->session = $session;
		$this->referrer = $referrer;
		$this->hostname = $hostname;
	}

	/**
	 * @NoAdminRequired
	 * @NoCSRFRequired
	 *
	 * @param string $src
	 *
	 * @throws \Exception If the URL is not valid.
	 * @return TemplateResponse
	 */
	public function redirect($src) {
		$authorizedRedirect = false;

		if (strpos($src, 'http://') !== 0 && strpos($src, 'https://') !== 0) {
			throw new Exception('URL is not valid.', 1);
		}

		// If the request has a referrer from this domain redirect the user without interaction
		// this is there to prevent an open redirector.
		// Since we can't prevent the referrer from being added with a HTTP only header we rely on an
		// additional JS file here.
		if (parse_url($this->referrer, PHP_URL_HOST) === $this->hostname) {
			$authorizedRedirect = true;
		}

		$params = [
			'authorizedRedirect' => $authorizedRedirect,
			'url' => $src,
			'urlHost' => parse_url($src, PHP_URL_HOST),
			'mailURL' => $this->urlGenerator->linkToRoute('mail.page.index'),
		];
		return new TemplateResponse($this->appName, 'redirect', $params, 'guest');
	}

	/**
	 * @NoAdminRequired
	 * @NoCSRFRequired
	 *
	 * @param string $src
	 *
	 * TODO: Cache the proxied content to prevent unnecessary requests from the oC server
	 *       The caching should also already happen in a cronjob so that the sender of the
	 *       mail does not know whether the mail has been opened.
	 *
	 * @return ProxyDownloadResponse
	 */
	public function proxy($src) {
		// close the session to allow parallel downloads
		$this->session->close();

		$content = $this->getUrlContent($src);
		return new ProxyDownloadResponse($content, $src, 'application/octet-stream');
	}

	/**
	 * Version hack for \OCP\IHelper
	 *
	 * @todo remove version-hack once core 8.1+ is supported
	 *
	 * @param type $src
	 * @return type
	 */
	private function getUrlContent($src) {
		$ocVersion = \OC::$server->getConfig()->getSystemValue('version', '0.0.0');
		if (version_compare($ocVersion, '8.2.0', '<')) {
			return \OC::$server->getHTTPClientService()->newClient()->get($src);
		} else {
			return \OC::$server->getHelper()->getUrlContent($src);
		}
	}

}