<?php

/**
 * Filter to add attributes.
 *
 * This filter allows you to add attributes to the attribute set being processed.
 *
 * Example - add attribute, single value:
 * <code>
 * 'authproc' => array(
 *   array('core:AttributeAdd', 'source' => 'myidp'),
 *   ),
 * </code>
 *
 * Examle - add attribute, multiple values:
 * <code>
 * 'authproc' => array(
 *   array('core:AttributeAdd', 'groups' => array('users', 'members')),
 *   ),
 * </code>
 *
 * Examle - replace attribute, single value:
 * <code>
 * 'authproc' => array(
 *   array('core:AttributeAdd', '%replace', 'uid' => array('guest')),
 *   ),
 * </code>
 *
 * @author Olav Morken, UNINETT AS.
 * @package simpleSAMLphp
 * @version $Id$
 */
class sspmod_core_Auth_Process_AttributeAdd extends SimpleSAML_Auth_ProcessingFilter {

	/**
	 * Flag which indicates wheter this filter should append new values or replace old values.
	 */
	private $replace = FALSE;


	/**
	 * Attributes which should be added/appended.
	 *
	 * Assiciative array of arrays.
	 */
	private $attributes = array();


	/**
	 * Initialize this filter.
	 *
	 * @param array $config  Configuration information about this filter.
	 * @param mixed $reserved  For future use.
	 */
	public function __construct($config, $reserved) {
		parent::__construct($config, $reserved);

		assert('is_array($config)');

		foreach($config as $name => $values) {
			if(is_int($name)) {
				if($values === '%replace') {
					$this->replace = TRUE;
				} else {
					throw new Exception('Unknown flag: ' . var_export($values, TRUE));
				}
				continue;
			}

			if(!is_string($name)) {
				throw new Exception('Invalid attribute name: ' . var_export($name, TRUE));
			}

			if(!is_array($values)) {
				$values = array($values);
			}
			foreach($values as $value) {
				if(!is_string($value)) {
					throw new Exception('Invalid value for attribute ' . $name . ': ' .
						var_export($values, TRUE));
				}
			}

			$this->attributes[$name] = $values;
		}
	}


	/**
	 * Apply filter to add or replace attributes.
	 *
	 * Add or replace existing attributes with the configured values.
	 *
	 * @param array &$request  The current request
	 */
	public function process(&$request) {
		assert('is_array($request)');
		assert('array_key_exists("Attributes", $request)');

		$attributes =& $request['Attributes'];

		foreach($this->attributes as $name => $values) {
			if($this->replace === TRUE || !array_key_exists($name, $attributes)) {
				$attributes[$name] = $values;
			} else {
				$attributes[$name] = array_merge($attributes[$name], $values);
			}
		}
	}

}

?>