<?php
/**
 *  Copyright (C) 2010  Kai Dorschner
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU 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 General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * @author Kai Dorschner <the-hide@address.com>
 * @copyright Copyright 2010, Kai Dorschner
 * @license http://www.gnu.org/licenses/gpl.html GPLv3
 * @package mocovi
 * @subpackage controls
 */

/**
 * Protected Control
 *
 * Protects content from unauthorized persons. For a complete protection
 * you'll have to deny every access to the mocovi/filesystems/ and
 * mocovi/translations folders by placing a .htaccess inside them with content:
 *  Order Deny,Allow
 *  Deny From All
 *
 * @package mocovi
 * @subpackage controls
 */
class protected_control extends Control
{
	protected $defaultOptions = array
		( 'requireUser'		=> ''
		, 'requireGroup'	=> ''
		);

	/**
	 * @override
	 */
	public function _beforeRun(DomNode $parent)
	{
		if(!$this->loggedIn())
			$this->error('This content is not available because you are not logged in.');
		return true;
	}

	protected function loggedIn()
	{
		/* Here comes the authentication routine */

		return true;
	}

	/**
	 * @override
	 */
	protected function program()
	{
		/* debug */ if(count($users = $this->explodeOption('requireUser')) > 0) echo 'Required Users: ' . implode(', ', $users);
		/* debug */ if(count($groups = $this->explodeOption('requireGroup')) > 0) echo 'Required Groups: ' . implode(', ', $groups);
	}

	protected function /*array*/ explodeOption($option)
	{
		return array_map
		(
			'trim',
			array_filter
			(
				explode
				(
					',',
					$this->getOption($option)
				)
			)
		);
	}
}