trigger_action_set_cookie.inc

<?php
require_once SQ_SYSTEM_ROOT.'/core/attributes/parameter_map/parameter_map.inc';

class Trigger_Action_Set_Cookie extends Trigger_Action
{


    public static function execute($settings, &$state)
    {
        // check required settings
        $name = array_get_index($settings, 'name', '');
        if ($name == '') return FALSE;

        //replace keywords for $value
        if (empty($state['asset'])) {
            // grab the asset if assetid is given, but not the asset.
            if (empty($state['assetid'])) {
                return FALSE;
            } else {
                $state['asset'] = $GLOBALS['SQ_SYSTEM']->am->getAsset($state['assetid']);
            }
        }

        if (is_null($state['asset'])) return FALSE;

        $old_current_asset = $GLOBALS['SQ_SYSTEM']->getGlobalDefine('CURRENT_ASSET', NULL);
        $GLOBALS['SQ_SYSTEM']->setGlobalDefine('CURRENT_ASSET', $state['asset']);

        $parameter_map_value = array_get_index($settings, 'value_map', serialize(Array()));
        $atr_parameter_map = new Asset_Attribute_Parameter_Map(0, $parameter_map_value);
        $param_map_value = $atr_parameter_map->getParameterValue('value');

        // value in parameter map has higher priority than the value in the input textbox
        if (!empty($param_map_value)) {
            $value = $param_map_value;
        } else {
            $value = $settings['value'];
        }

        if (is_null($old_current_asset)) {
            $GLOBALS['SQ_SYSTEM']->unsetGlobalDefine('CURRENT_ASSET');
        } else {
            $GLOBALS['SQ_SYSTEM']->setGlobalDefine('CURRENT_ASSET', $old_current_asset);
        }

        //replace keywords for $value
        if (empty($state['asset'])) {
            // grab the asset if assetid is given, but not the asset.
            if (empty($state['assetid'])) {
                return FALSE;
            } else {
                $state['asset'] = $GLOBALS['SQ_SYSTEM']->am->getAsset($state['assetid']);
            }
        }

        if (is_null($state['asset'])) return FALSE;

        $value = self::replaceKeywords($value, $state['asset']);

        $expire_time = array_get_index($settings, 'expire_time', 0);
        $path = array_get_index($settings, 'path', '');
        $domain = array_get_index($settings, 'domain', '');
        $secure = array_get_index($settings, 'secure', FALSE);
        $http_only = array_get_index($settings, 'http_only', FALSE);

        if ($expire_time != 0) {
            $expire_time = time() + $expire_time;
        }

        if (empty($path) || empty($domain)) {
            // Calculate the domain and path like the session cookie (look at session_handler_default.inc)
            $temp_domain = strip_url(sq_web_path('root_url'), TRUE);
            $pos = strpos($temp_domain, '/');
            $temp_path = '/';
            if ($pos !== FALSE) {
                $temp_path = substr($temp_domain, $pos);
                $temp_domain = substr($temp_domain, 0, $pos);
            }

            // Remove the port number from the host part, if any.
            // Session cookies cannot have a port in the domain.
            $temp_domain = preg_replace('|:\d+$|', '', $temp_domain);

            if (empty($path)) {
                $path = $temp_path;
            }

            if (empty($domain)) {
                $domain = $temp_domain;
            }
        }

        if(headers_sent()) return FALSE;

        header('Set-Cookie: ' . rawurlencode($name) . '=' . rawurlencode($value)
                          . (empty($expire_time) ? '' : '; expires=' . gmdate('D, d-M-Y H:i:s', $expire_time) . ' GMT')
                          . (empty($path) ? '' : '; path=' . $path)
                          . (empty($domain) ? '' : '; domain=' . $domain)
                          . (!$secure ? '' : '; secure')
                          . (!$http_only ? '' : '; HttpOnly'), false);

        return Array(
                    'name'          => $name,
                    'value'         => $value,
                    'expire_time'   => $expire_time,
                    'path'          => $path,
                    'domain'        => $domain,
                    'secure'        => $secure,
                    'http_only'     => $http_only
                   );

    }//end execute()


    public static function getInterface($settings, $prefix, $write_access=FALSE)
    {
        //name textbox
        ob_start();
        $name = array_get_index($settings, 'name');
        if ($write_access) {
            text_box($prefix.'[name]', $name);
        } else {
            echo '<b>'.$name.'</b>';
        }
        $name_input = ob_get_clean();

        //value textbox
        ob_start();
        $value = array_get_index($settings, 'value');
        if ($write_access) {
            text_box($prefix.'[value]', $value);
        } else {
            echo '<b>'.$value.'</b>';
        }
        $value_input = ob_get_clean();

        //expire time textbox
        ob_start();
        $expire_time = array_get_index($settings, 'expire_time', 0);
        if ($write_access) {
            text_box($prefix.'[expire_time]', $expire_time, 10);
        } else {
            echo '<b>'.$expire_time.'</b>';
        }
        $expire_time_input = ob_get_clean();

        //path textbox
        ob_start();
        $path = array_get_index($settings, 'path');
        if ($write_access) {
            text_box($prefix.'[path]', $path, 40);
        } else {
            echo '<b>'.$path.'</b>';
        }
        $path_input = ob_get_clean();

        //domain textbox
        ob_start();
        $domain = array_get_index($settings, 'domain');
        if ($write_access) {
            text_box($prefix.'[domain]', $domain, 40);
        } else {
            echo '<b>'.$domain.'</b>';
        }
        $domain_input = ob_get_clean();

        //secure combobox
        ob_start();
        $secure = array_get_index($settings, 'secure', FALSE);
        if ($write_access) {
            combo_box($prefix.'[secure]', Array('0' => translate('no'), '1' => translate('yes')), FALSE , ($secure ? '1' : '0'));
        } else {
            echo '<b>'.($secure ? translate('yes') : translate('no')).'</b>';
        }
        $secure_input = ob_get_clean();

        //http only combobox
        ob_start();
        $http_only = array_get_index($settings, 'http_only', FALSE);
        if ($write_access) {
            combo_box($prefix.'[http_only]', Array('0' => translate('no'), '1' => translate('yes')), FALSE , ($http_only ? '1' : '0'));
        } else {
            echo '<b>'.($http_only ? translate('yes') : translate('no')).'</b>';
        }
        $http_only_input = ob_get_clean();

        //value parameter map
        ob_start();
        echo '<div>';
        $new_prefix = str_replace(array('[',']'), '_', $prefix);
        hidden_field($prefix.'[new_prefix]', $new_prefix);

        $parameter_map_value = array_get_index($settings, 'value_map', serialize(Array()));
        $atr_parameter_map = new Asset_Attribute_Parameter_Map(0, $parameter_map_value);

        $atr_parameter_map->setParameter('value', 'Value');
        echo $atr_parameter_map->paint($new_prefix.'_parameter_map', !$write_access);
        echo '</div>';
        $parameter_map_input = ob_get_clean();

        $output = translate('trigger_action_set_cookie_set_name_value', $name_input, $value_input);
        $output .= '<br />'.translate('trigger_action_set_cookie_set_expire_time', $expire_time_input).'<br /><i>'. translate('trigger_action_set_cookie_expire_time_note').'</i>';
        $output .= '<br />'.translate('trigger_action_set_cookie_set_path', $path_input).'<br /><i>'.translate('trigger_action_set_cookie_path_note').'</i>';
        $output .= '<br />'.translate('trigger_action_set_cookie_set_domain', $domain_input).'<br /><i>'.translate('trigger_action_set_cookie_domain_note').'</i>';
        $output .= '<br />'.translate('trigger_action_set_cookie_set_secure', $secure_input, translate('yes'));
        $output .= '<br />'.translate('trigger_action_set_cookie_set_http_only', $http_only_input, translate('yes')).'<br /><br />';

        $output .= $parameter_map_input;

        return $output;

    }//end getInterface()


    public static function processInterface(&$settings, $request_data)
    {

        $settings['name']           = array_get_index($request_data, 'name');
        $settings['value']          = array_get_index($request_data, 'value');
        $settings['expire_time']    = array_get_index($request_data, 'expire_time', 0);
        $settings['path']           = array_get_index($request_data, 'path');
        $settings['domain']         = array_get_index($request_data, 'domain');
        $secure = array_get_index($request_data, 'secure', '0');
        $settings['secure']         = $secure == '1' ? TRUE : FALSE;
        $http_only  = array_get_index($request_data, 'http_only', '0');
        $settings['http_only']      = $http_only == '1' ? TRUE : FALSE;

        $settings['value_map'] = '';

        $new_prefix = str_replace(array('[',']'), '_', array_get_index($request_data, 'new_prefix', ''));
        if ($new_prefix) {
            $atr_parameter_map = new Asset_Attribute_Parameter_Map();
            $atr_parameter_map->process($new_prefix.'_parameter_map');
            $settings['value_map'] = $atr_parameter_map->value;
        }

        return FALSE;

    }//end processInterface()


    public static function replaceKeywords($value, Asset $event_asset)
    {
        // replace global keywords
        replace_global_keywords($value);

        // replace event asset keywords
        $keywords = retrieve_keywords_replacements($value);
        $replacements = Array();
        foreach ($keywords as $keyword) {
            $replacements[$keyword] = $event_asset->getKeywordReplacement($keyword);
        }
        replace_keywords($value, $replacements);

        return $value;

    }//end replaceKeywordsInWebPath()


}//end class

?>