html_form.inc

<?php
function submit_button($name, $value, $on_click='', $extras='')
{
    // Make sure that they don't use 'submit' as the form field, because it clashes
    // with the submit() fn that the form has
    if ($name == 'submit') {
        trigger_localised_error('SYS0019', E_USER_ERROR);
    }

    if ($on_click) {
        $extras .= ' onclick="'.htmlspecialchars($on_click).' "';
    }

    if (!stristr($extras, 'class=')) {
        $extras .= ' class="sq-form-field"';
    }
    if (!stristr($extras, 'id=')) {
        $extras .= ' id="'.htmlspecialchars($name).'"';
    }

    echo '<input type="submit" name="', htmlspecialchars($name), '" value="', htmlspecialchars($value), '" ', $extras, ' />';

}//end submit_button()


function reset_button($name, $value, $on_click='', $extras='')
{
    // Make sure that they don't use 'reset' as the form field, because it clashes
    // with the reset() fn that the form has
    if ($name == 'reset') {
        trigger_localised_error('SYS0018', E_USER_ERROR);
    }

    if ($on_click) {
        $extras .= ' onclick="'.htmlspecialchars($on_click).' "';
    }
    if (!stristr($extras, 'class=')) {
        $extras .= ' class="sq-form-field"';
    }
    if (!stristr($extras, 'id=')) {
        $extras .= ' id="'.htmlspecialchars($name).'"';
    }

    echo '<input type="reset" name="', htmlspecialchars($name), '" value="', htmlspecialchars($value), '" ', $extras, ' />';

}//end reset_button()


function normal_button($name, $value, $on_click='', $extras='')
{
    if ($on_click) {
        $extras .= ' onclick="'.htmlspecialchars($on_click).' "';
    }
    if (!stristr($extras, 'class=')) {
        $extras .= ' class="sq-form-field"';
    }
    echo '<input type="button" name="', htmlspecialchars($name), '" id="', htmlspecialchars($name), '" value="', htmlspecialchars($value), '" ', $extras, ' />';

}//end normal_button()


function hidden_field($name, $value='', $extras='')
{
    if (!stristr($extras, 'class=')) {
        $extras .= ' class="sq-form-field"';
    }
    if (!stristr($extras, 'id=')) {
        $extras .= ' id="'.htmlspecialchars($name).'"';
    }
    echo '<input type="hidden" name="', htmlspecialchars($name), '" value="', htmlspecialchars($value), '" ', $extras, ' />';

}//end hidden_field()


function text_box($name, $value='', $size='', $max='', $hide_value=FALSE, $extras='')
{
    $size = (int) $size;
    $max  = (int) $max;
    if (!stristr($extras, 'class=')) {
        $extras .= ' class="sq-form-field"';
    }
    if (!stristr($extras, 'id=')) {
        $extras .= ' id="'.htmlspecialchars($name).'"';
    }
    if ($hide_value) {
        if (!stristr($extras, 'onfocus')) {
            $extras .= ' onfocus="if (this.value == \''.htmlspecialchars($value).'\') { this.value = \'\'; }"';
        } else {
            $insert_pos = strpos($extras, 'onfocus="') + 8;
            $extras = substr($extras, 0, $insert_pos).'if (this.value == \''.htmlspecialchars($value).'\') { this.value = \'\'; }'.substr($extras, $insert_pos);
        }
        if (!stristr($extras, 'onblur')) {
            $extras .= ' onblur="if (this.value == \'\') { this.value=\''.htmlspecialchars($value).'\'; }"';
        } else {
            $quote_pos = strpos($extras, '"', strpos($extras, 'onblur="') + 8);
            $extras = substr($extras, 0, $quote_pos).';  if (this.value == \'\') { this.value=\''.htmlspecialchars($value).'\'; }'.substr($extras, $quote_pos);
        }
    }

    echo    '<input type="text" ',
            'name="', htmlspecialchars($name), '" ',
            'value="', htmlspecialchars($value), '" ',
            (($size)   ? 'size="'.$size.'" '     : ''),
            (($max)    ? 'maxlength="'.$max.'" ' : ''),
            $extras,
            ' />';

}//end text_box()


function int_text_box($name, $value, $allow_negative=TRUE, $size='', $range_min=NULL, $range_max=NULL, $max_chars='', $hide_value=FALSE, $allow_empty=FALSE, $extras='')
{
    ?><script type="text/javascript" src="<?php echo sq_web_path('lib')?>/html_form/html_form.js"></script><?php

    $allow_negative = $allow_negative ? 'true' : 'false';

    // ranges
    if (!is_null($range_min) && !is_null($range_max)) {
        if (strlen($value) != 0) {
            if ($value >= $range_min) {
                if ($value > $range_max) $value = $range_max;
            } else {
                $value = $range_min;
            }
        }

        $ranges = Array(
                    $range_min,
                    $range_max,
                  );
    } else {
        $ranges = Array();
    }

    $ranges_js  = implode(', ', $ranges);
    $javascript = '
        onkeyup="validate_numeric_text_field(this, '.$allow_negative.(!empty($ranges_js) ? ', '.$ranges_js : '').');"
        onblur="validate_numeric_range(this'.(!empty($ranges_js) ? ', '.$ranges_js : '').', '.($allow_empty ? 'true' : 'false').');"
    ';
    if (!$hide_value) {
        $javascript .= '    onchange="validate_numeric_text_field(this, '.$allow_negative.(!empty($ranges_js) ? ', '.$ranges_js : '').');"';
    }

    text_box($name, $value, $size, $max_chars, $hide_value, $javascript.$extras);

}//end int_text_box()


function password_box($name, $value='', $size='', $max='', $extras='')
{
    $size = (int) $size;
    $max  = (int) $max;
    if (!stristr($extras, 'class=')) {
        $extras .= ' class="sq-form-field"';
    }
    if (!stristr($extras, 'id=')) {
        $extras .= ' id="'.htmlspecialchars($name).'"';
    }
    echo    '<input type="password" ',
            'name="', htmlspecialchars($name), '" ',
            'value="', htmlspecialchars($value), '" ',
            (($size)   ? 'size="'.$size.'" '     : ''),
            (($max)    ? 'maxlength="'.$max.'" ' : ''),
            $extras,
            ' />';

}//end password_box()


function text_area($name, $contents, $cols=0, $rows=0, $max=0, $extras='')
{
    $cols = (int) $cols;
    $rows = (int) $rows;
    $max  = (int) $max;
    if (!stristr($extras, 'class=')) {
        $extras .= ' class="sq-form-field"';
    }
    if (!stristr($extras, 'id=')) {
        $extras .= ' id="'.htmlspecialchars($name).'"';
    }

    // add JS translation files
    echo '<script type="text/javascript" src="'.sq_web_path('lib').'/js/general.js"></script>';
    foreach ($GLOBALS['SQ_SYSTEM']->lm->getJavascriptIncludes() as $js_include) {
        echo '<script type="text/javascript" src="'.$js_include.'"></script>';
    }

    echo    '<textarea name="', htmlspecialchars($name), '" ',
            'cols="'.$cols.'" ',
            'rows="'.$rows.'" ',
            (($max)   ? 'onkeypress="if (this.value.length > '.$max.') { this.value = this.value.substr(0,'.$max.'); alert(js_translate(\'max_characters_warning\', \''.$max.'\')); this.focus()}" ' : ''),
            $extras,
            '>',
            htmlspecialchars($contents),
            '</textarea>';

}//end text_area()


function radio_button($name, $value='1', $checked=FALSE, $on_click='', $extras='')
{
    if ($on_click) {
        $extras .= ' onclick="'.htmlspecialchars($on_click).' "';
    }
    if (!stristr($extras, 'class=')) {
        $extras .= ' class="sq-form-field"';
    }
    if (!stristr($extras, 'id=')) {
        $extras .= ' id="'.htmlspecialchars($name.'_'.$value).'"';
    }
    echo    '<input type="radio" ',
            'name="', htmlspecialchars($name), '" ',
            'value="', htmlspecialchars($value), '" ',
            (($checked) ? 'checked="checked" ' : ''),
            $extras,
            ' />';

}//end radio_button()


function check_box($name, $value='1', $checked=FALSE, $on_click='', $extras='')
{
    if ($on_click) {
        $extras .= ' onclick="'.htmlspecialchars($on_click).' "';
    }
    if (!stristr($extras, 'id=')) {
        $extras .= ' id="'.htmlspecialchars($name).'"';
    }
    if (!stristr($extras, 'class=')) {
        $extras .= ' class="sq-form-field"';
    }
    echo    '<input type="checkbox" ',
            'name="', htmlspecialchars($name), '" ',
            'value="', htmlspecialchars($value), '" ',
            (($checked) ? 'checked="checked" ' : ''),
            $extras,
            ' />';

}//end check_box()


function combo_box($name, $contents, $multiple=FALSE, $defaults='', $height=0, $extras='', $maxlength=0)
{
    $height    = (int) $height;
    $maxlength = (int) $maxlength;
    if (!stristr($extras, 'class=')) {
        $extras .= ' class="sq-form-field"';
    }
    if (!stristr($extras, 'id=')) {
        $extras .= ' id="'.htmlspecialchars($name).'"';
    }
    if ($multiple) {
        $extras .= ' multiple="multiple"';
        $name .= '[]';
    }

    if (!is_array($contents)) $contents = Array($contents);
    if (!is_array($defaults)) $defaults = Array($defaults);

    echo    '<select name="', htmlspecialchars($name), '" ',
            (($height > 1)? 'size="'.$height.'" ' : ''),
            $extras,
            '>';

    foreach ($contents as $key => $value) {
        if ($maxlength) {
            $value = str_replace('&nbsp;', ' ', $value);  // we don't want a space to take 6 chars do we ?
            if (strlen($value) > $maxlength) {
                $value = substr($value, 0, $maxlength - 3).'...';
            }
        }
        $value = str_replace(' ', '&nbsp;', htmlspecialchars($value));
        echo    '<option value="', htmlspecialchars($key), '"',
                ((in_array((string) $key, $defaults)) ? ' selected="selected"' : ''),
                '>',
                $value,
                '</option>';
    }
    echo '</select>';

}//end combo_box()


function label($text, $for='', $extras='')
{
    if (!empty($for)) $extras .= ' for="'.$for.'"';
    if (!empty($extras)) $extras = ' '.$extras;
    echo '<label'.$extras.'>'.$text.'</label>';

}//end label()


function colour_box($name, $default='000000', $allow_blanks=FALSE, $button_text='*', $show_text_box=TRUE, $show_current_colour=TRUE, $show_change_colour=TRUE)
{

    $default = strtolower($default);
    $default = preg_replace('/^#/', '', $default);

    static $initialised = FALSE;
    if (!$initialised) {
        ?>
        <script type="text/javascript" src="<?php echo sq_web_path('lib')?>/html_form/colour_picker.js"></script>
        <script type="text/javascript">var colour_change_image_dir='<?php echo sq_web_path('lib');?>/web/images/'</script>
        <?php
        $initialised = TRUE;
    }

    if ($show_current_colour) {
        ?>
        <span id="colour_span_<?php echo $name; ?>" style="background-color: <?php echo $default; ?>;">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</span>&nbsp;
        <?php
    }

    if ($show_text_box) {
        $extras  = ' id="colour_box_'.$name.'" style="font-family: courier;"'
                  .' onchange="this.value = check_colour(this.value, '.(($allow_blanks) ? 'true' : 'false').');"';
        if ($show_current_colour) {
             $extras .= ' show_colour_change(\''.addslashes($name).'\');';
        }
        text_box($name, $default, 7, 6, FALSE, $extras);
    } else {
        hidden_box($name, $default);
    }

    normal_button('', " $button_text ",
                      "load_colour_picker(this.form.elements['".addslashes($name)."'],'".sq_web_path('lib')."/html_form')",
                      'style="font-family: courier;"');

    if ($show_change_colour) {
        ?>
        <img id="colour_change_<?php echo $name; ?>" name="colour_change_<?php echo $name; ?>" src="<?php echo sq_web_path('lib'); ?>/web/images/cross.gif" width="15" height="15" border="0" align="bottom" />
        <?php
    }

}//end colour_box()


function file_upload($name, $extras='')
{
    if (!stristr($extras, 'class=')) {
        $extras .= ' class="sq-form-field"';
    }
    echo '<input type="file" name="', $name, '" ', $extras, ' />';

}//end file_upload()


function get_file_upload_info($name, $pre_uploaded=FALSE)
{
    // browsers of handheld iOS devices disables the file upload
    // input so the _FILES var will be totally empty but this 
    // doesn't mean there was error uploading the file. see more 
    // on bug #5574 Form file upload problem with  iOS device
    if (empty($_FILES)) return Array();
    if (empty($_FILES[$name])) return FALSE;

    $nice_name = $_FILES[$name]['name'];

    // Matrix file preference limits
    require_once SQ_INCLUDE_PATH.'/general_occasional.inc';
    $pref_max_filesize = sizeInBytes($GLOBALS['SQ_SYSTEM']->getUserPrefs('file', $pre_uploaded ? 'SQ_FILE_PREUPLOADED_MAX_SIZE' : 'SQ_FILE_MAX_SIZE'));
    $filesize_limits = Array();
    // Relevant limits set in php.ini
    foreach(Array('upload_max_filesize', 'post_max_size', 'memory_limit') as $param) {
        $param_val = ini_get($param);
        if ($param_val) {
            $filesize_limits[] = sizeInBytes(($param_val));
        }
    }
    $max_size = min($filesize_limits);
    if ($pref_max_filesize && $pref_max_filesize < $max_size) {
        $settings_type = "Matrix";
        $max_allowed_size = $pref_max_filesize/(1024*1024);
    } else {
        $settings_type = "PHP";
        $max_allowed_size = $max_size/(1024*1024);
    }

    // if something went wrong, sorry bad luck
    switch ($_FILES[$name]['error']) {

        case UPLOAD_ERR_NO_FILE :
            return Array();
        break;

        case UPLOAD_ERR_INI_SIZE  :
            trigger_localised_error('SYS0022', E_USER_WARNING, $nice_name, ini_get('upload_max_filesize'), $settings_type, $max_allowed_size);
            return FALSE;
        break;

        case UPLOAD_ERR_FORM_SIZE :
            trigger_localised_error('SYS0021', E_USER_WARNING, $nice_name, easy_filesize($_POST['MAX_FILE_SIZE']), $settings_type, $max_allowed_size);
            return FALSE;
        break;

        case UPLOAD_ERR_PARTIAL :
            trigger_localised_error('SYS0023', E_USER_WARNING, $nice_name);
            return FALSE;
        break;
    
    }//end switch

    if (empty($_FILES[$name]['name']) || !is_uploaded_file($_FILES[$name]['tmp_name'])) {
        return FALSE;
    }

    return $_FILES[$name];

}//end get_file_upload_info()


function commit_file_upload($name, $dest, $overwrite=FALSE, $max_size=0, $restrict_exts=TRUE, $extensions=Array())
{
    $info = get_file_upload_info($name);
    if ($info === FALSE) return FALSE;
    if (!count($info))   return '';

    $nice_name = str_replace('_', ' ', $name);

    if ($max_size > 0 && $max_size < $info['size']) {
        trigger_localised_error('SYS0020', E_USER_WARNING, $nice_name, easy_filesize($max_size));
        return FALSE;
    }


    // Are we worried about the extension ?
    if (count($extensions)) {
        $exts = Array();
        foreach ($extensions as $v) {
            $exts[] = strtolower($v);
        }
        $ext = strtolower(substr(strrchr($info['name'], '.'), 1));
        $in_arr = in_array($ext, $exts);

        // see $restrict_exts documentation in function header
        if (($restrict_exts && !$in_arr) || (!$restrict_exts && $in_arr)) {
            trigger_localised_error('SYS0002', E_USER_WARNING, $ext, $nice_name);
            return FALSE;
        }//end if
    }//end if


    // Doe dest exist and is it a directory ?
    if (is_dir($dest)) {
        if (!is_writable($dest)) {
            trigger_localised_error('SYS0007', E_USER_WARNING, $dest);
            return FALSE;
        }
        $dest .= '/'.$info['name'];
    }

    // Now we know we have a proper filename, if it exists are we allowed to write over it
    if (file_exists($dest)) {
        if (!$overwrite) {
            trigger_localised_error('SYS0027', E_USER_WARNING, $info['name']);
            return FALSE;
        }
        if (!is_writable($dest)) {
            trigger_localised_error('SYS0008', E_USER_WARNING, $dest);
            return FALSE;
        }

    // the destination doesn't exist
    } else {
        require_once SQ_FUDGE_PATH.'/general/file_system.inc';
        $parent = dirname($dest);
        // if the parent isn't a directory, can we create it ?
        if (!is_dir($parent) && !create_directory($parent)) {
            trigger_localised_error('SYS0015', E_USER_WARNING, $parent);
            return FALSE;
        } else if (!is_writable($parent)) {
            trigger_localised_error('SYS0016', E_USER_WARNING, $parent);
            return FALSE;
        }
    }//end dest exists

    // Move file over
    if (!move_uploaded_file($info['tmp_name'], $dest)) {
        trigger_localised_error('SYS0025', E_USER_WARNING, $dest);
        return FALSE;
    }

    return basename($dest);

}//end commit_file_upload()


function get_type_codes_string($type_codes)
{
    $all_type_codes = Array();
    foreach ($type_codes as $type_code => $flag) {
        $all_type_codes[] = $type_code;
        switch ($flag) {
            case 'A' :
                $ancestors = $GLOBALS['SQ_SYSTEM']->am->getTypeAncestors($type_code);
                foreach ($ancestors as $ancestor) {
                    $all_type_codes[] = $ancestor;
                }
            break;
            case 'D' :
                $descendants = $GLOBALS['SQ_SYSTEM']->am->getTypeDescendants($type_code);
                foreach ($descendants as $descendant) {
                    $all_type_codes[] = $descendant;
                }
            break;
        }//end switch
    }//end foreach

    if (count($all_type_codes) == 1) {
        $type_codes = implode('', $all_type_codes).'|';
    } else {
        $type_codes = implode('|', $all_type_codes);
    }
    return $type_codes;

}//end get_type_codes_string()


function asset_finder($name, $assetid=0, $type_codes=Array(), $map_frame='sq_sidenav', $new_window=FALSE, $done_fn='null', $buttons=Array('clear', 'reset'))
{
    $finder_frame = ($new_window || empty($map_frame)) ? 'self' : 'parent.frames["sq_main"]';
    $escaped_name = str_replace('\\', '\\\\', $name);
    $assetid      = trim($assetid);

    if (!empty($map_frame)) {
        $map_frame = trim('parent.frames["'.$map_frame.'"]', '.');
    } else {
        $map_frame = 'self';
    }
    if ($new_window) {
        $map_frame = 'window.opener.'.$map_frame;
    }

    $label = '';
    if ($assetid) {
        $asset = $GLOBALS['SQ_SYSTEM']->am->getAsset($assetid, '', TRUE);
        if (is_null($asset)) {
            $assetid = 0;
        } else {
            // Dont reveal the asset name if the current user has no read permission
            if ($asset->readAccess()) {
                $label = $asset->short_name;
            }
        }
    }

    $safe_name = 'sq_asset_finder_'.preg_replace('/[^A-Za-z0-9\-]/', '_', $name);

    $type_codes = get_type_codes_string($type_codes);

    hidden_field($name.'[assetid]', $assetid);
    hidden_field($name.'[url]', '');
    hidden_field($name.'[linkid]', '');
    hidden_field($name.'[type_code]', '');
    // call the js function to set where the finder frame is

    text_box($safe_name.'_label', $label, 20, 0, FALSE, 'readonly="readonly" class="sq-form-asset-finder" onfocus="this.tmp = this.value;" onblur="this.value = this.tmp;"');
    // only print the buttons if in the backend (where there's an asset map frame available)
    if (SQ_IN_BACKEND || SQ_IN_LIMBO || defined('SQ_PAINTED_SIMPLE_ASSET_MAP')) {
        ?><span class="sq-asset-finder-id-label">Id : #</span><?php
        text_box($safe_name.'_assetid', empty($assetid) ? '' : $assetid, 2, '', FALSE, 'style="border:1px solid #EFEFEF;width:7ex;" onchange="this.value=this.value.replace(/^\s*((?:[\S\s]*\S)?)\s*$/, \'$1\');'.str_replace('"', '\'', $finder_frame).'.set_hidden_field(\''.$name.'\' + \'[assetid]\', this.value);"');
        ?> <?php
        normal_button($safe_name.'_change_btn', translate('change'), $map_frame.'.asset_finder_change_btn_press(\''.$escaped_name.'\', \''.$safe_name.'\', \''.addslashes($type_codes).'\', '.$done_fn.');');
        if (in_array('clear', $buttons)) {
            normal_button($safe_name.'_clear_btn', translate('clear'), $map_frame.'.asset_finder_clear_btn_press(\''.$escaped_name.'\', \''.$safe_name.'\');');
        }
        if (in_array('reset', $buttons)) {
            normal_button($safe_name.'_reset_btn', translate('reset'), $map_frame.'.asset_finder_reset_btn_press(\''.$escaped_name.'\', \''.$safe_name.'\', \''.$assetid.'\', \''.addslashes($label).'\');');
        }
        ?><script type="text/javascript">
                if (!window.top.frames['sq_resizer'] || <?php echo $map_frame; ?>.SQ_DOCUMENT_LOADED) {
                    <?php echo $map_frame; ?>.set_finder(<?php echo $finder_frame; ?>);
                } else {
                    // this gets overridden when multiple asset finders exist anyway,
                    // so no harm at the moment in only saving the latest set_finder call
                    if (typeof currentOnload == 'undefined') {
                        currentOnload = <?php echo $map_frame; ?>.onload;
                    }
                    <?php echo $map_frame; ?>.onload = function() { <?php echo $map_frame; ?>.set_finder(<?php echo $finder_frame; ?>); currentOnload(); }
                }
            </script><?php
    }

}//end asset_finder()


function multiple_asset_finder($name, $assetids=Array(), $type_codes=Array(), $map_frame='sq_sidenav', $new_window=FALSE, $done_fn='null', $buttons=Array('clear'))
{
    ?><script type="text/javascript" src="<?php echo sq_web_path('lib')?>/html_form/html_form.js"></script><?php

    echo '<div>';
    foreach (array_values($assetids) as $index => $assetid) {
        asset_finder($name.'['.$index.']', $assetid, $type_codes, $map_frame, $new_window, $done_fn);
        echo '<br />';
    }

    $index = count($assetids);
    asset_finder($name.'['.$index.']', 0, $type_codes, $map_frame, $new_window, $done_fn, Array('clear'));
    $index++;

    if (!empty($map_frame)) {
        $map_frame_exp = trim('parent.frames["'.$map_frame.'"]', '.');
    } else {
        $map_frame_exp = 'top';
    }

    $safe_name = 'sq_asset_finder_'.preg_replace('/[^A-Za-z0-9]/', '_', $name);
    $type_codes_string = get_type_codes_string($type_codes);
    echo '<input type="button" name="'.htmlspecialchars($safe_name.'_more_btn').'" id="'.htmlspecialchars($safe_name.'_more_btn').'" value="'.translate('more').'..." onclick="addNewAssetFinder(this, \''.$name.'\', \''.$safe_name.'\', \''.addslashes($type_codes_string).'\', \''.htmlentities($map_frame_exp, ENT_COMPAT, SQ_CONF_DEFAULT_CHARACTER_SET).'\', '.$done_fn.', '.(in_array('clear', $buttons) ? 'true' : 'false').')" />';
    echo '<br />';

    echo '</div>';

}//end multiple_asset_finder()


function security_key($key_len, $box_len, $zoom=1, $img_on_newline=FALSE, $bg='FFFFFF', $text='000000', $border='000000', $use_colours=FALSE, $use_font=FALSE, $font='', $font_size=20, $min_angle=10, $max_angle=20, $x_start=20, $min_dist=20, $max_dist=20, $ttf_width=200, $ttf_height=36, $use_arc=FALSE, $arc_colour='D20A0A', $include_uppercase=FALSE, $include_numbers=FALSE, $provide_accessible_captcha = FALSE)
{

    // generate a random security key string
    require_once SQ_FUDGE_PATH.'/general/general.inc';
    $password = generate_security_key($key_len, $include_uppercase, $include_numbers);

    // work out the width and height of the image
    $img_width  = $key_len * 10.5;
    $img_height = 20;

    // we need to store these vars in the session so we can get the
    // system to print the security image for us
    $security_vars = Array(
                        'key_len'           => $key_len,
                        'key'               => $password,
                        'width'             => $img_width,
                        'height'            => $img_height,
                        'use_colours'       => $use_colours,
                        'bg_colour'         => $bg,
                        'text_colour'       => $text,
                        'border_colour'     => $border,
                        'zoom'              => $zoom,
                        'use_font'          => $use_font,
                        'font'              => $font,
                        'font_size'         => $font_size,
                        'min_angle'         => $min_angle,
                        'max_angle'         => $max_angle,
                        'x_start'           => $x_start,
                        'min_dist'          => $min_dist,
                        'max_dist'          => $max_dist,
                        'ttf_width'         => $ttf_width,
                        'ttf_height'        => $ttf_height,
                        'use_arc'           => $use_arc,
                        'arc_colour'        => $arc_colour,
                        'include_uppercase' => $include_uppercase,
                        'include_numbers'   => $include_numbers,
                        'provide_accessible_captcha'    => $provide_accessible_captcha,
                     );
    $_SESSION['SQ_SYSTEM_SECURITY_KEY'] = $security_vars;

    // generate the url to get the security image to print
    $img_url = $_SERVER['PHP_SELF'].'?SQ_ACTION=send_security_key';
    ?>
    <table border="0">
        <tr>
            <td valign="top"><?php echo text_box('SQ_SYSTEM_SECURITY_KEY_VALUE', '', $box_len); ?></td>
    <?php
    if ($img_on_newline) {
    ?>
        </tr>
        <tr>
    <?php
    }//end if
    ?>
            <td valign="top"><img id="sq_security_key" src="<?php echo $img_url; ?>" alt="Security key" border="0" />
    <?php

    if ($provide_accessible_captcha) {
        print_accessible_captcha_interface();
    }
?>
</td>
        </tr>
        <tr>
        <?php
            ob_start();
                ?><a href="#" onclick="var img = document.getElementById('sq_security_key'); img.src = '<?php echo $img_url; ?>&amp;regen_key=1&amp;t=' + new Date().getTime(); return false;"><?php echo translate('security_key_link'); ?></a><?php
                $replacements_link = ob_get_contents();
            ob_end_clean()
        ?>
            <td class="sq-backend-data" id="sq_regen_captcha" colspan="<?php echo (($img_on_newline) ? '1' : '2'); ?>"><i><?php echo translate('security_key_question', $replacements_link); ?></i></td>
        </tr>
    </table>
    <?php

}//end security_key()


function security_key_image_box($key_len, $zoom=1, $bg='FFFFFF', $text='000000', $border='000000', $use_colours=FALSE, $use_font=FALSE, $font='', $font_size=20, $min_angle=10, $max_angle=20, $x_start=20, $min_dist=20, $max_dist=20, $ttf_width=200, $ttf_height=36, $use_arc=false, $arc_colour='D20A0A', $include_uppercase=FALSE, $include_numbers=FALSE, $provide_accessible_captcha = FALSE)
{
    // generate a random security key string
    require_once SQ_FUDGE_PATH.'/general/general.inc';
    $password = generate_security_key($key_len, $include_uppercase, $include_numbers);

    // work out the width and height of the image
    $img_width  = $key_len * 10.5;
    $img_height = 20;

    // we need to store these vars in the session so we can get the
    // system to print the security image for us
    $security_vars = Array(
                        'key_len'       => $key_len,
                        'key'           => $password,
                        'width'         => $img_width,
                        'height'        => $img_height,
                        'use_colours'   => $use_colours,
                        'bg_colour'     => $bg,
                        'text_colour'   => $text,
                        'border_colour' => $border,
                        'zoom'          => $zoom,
                        'use_font'      => $use_font,
                        'font'          => $font,
                        'font_size'     => $font_size,
                        'min_angle'     => $min_angle,
                        'max_angle'     => $max_angle,
                        'x_start'       => $x_start,
                        'min_dist'      => $min_dist,
                        'max_dist'      => $max_dist,
                        'ttf_width'     => $ttf_width,
                        'ttf_height'    => $ttf_height,
                        'use_arc'       => $use_arc,
                        'arc_colour'    => $arc_colour,
                        'include_uppercase' => $include_uppercase,
                        'include_numbers'   => $include_numbers,
                        'provide_accessible_captcha'    => $provide_accessible_captcha,
                     );
    $_SESSION['SQ_SYSTEM_SECURITY_KEY'] = $security_vars;

    // generate the url to get the security image to print
    $img_url = $_SERVER['PHP_SELF'].'?SQ_ACTION=send_security_key';
    ?>
        <img id="sq_security_key" src="<?php echo $img_url; ?>" border="0" alt="Security key" />
    <?php

    if ($provide_accessible_captcha) {
        print_accessible_captcha_interface();
    }

}//end security_key_image_box()


function print_accessible_captcha_interface()
{
    ?>
    <script type="text/javascript" src="<?php echo sq_web_path('lib'); ?>/js/JsHttpConnector.js"></script>
    <script type="text/javascript" src="<?php echo sq_web_path('lib'); ?>/js/captcha.js"></script>
    <noscript>
        Please enable JavaScript to access the Accessible CAPTCHA interface.
    </noscript>
    <?php

        // The following flag is used to verify that the AJAX request originated from Matrix - it does not indicate a CAPTCHA "pass"
        $_SESSION['SQ_ACCESSIBLE_CAPTCHA_GENERATED'] = 1;
    ?>
<span style="display: none; visibility: hidden;" id="sq_accessible_captcha">
<?php
    echo '<label for="SQ_SYSTEM_SECURITY_KEY_EMAIL">Please enter your email address: </label>';
    echo text_box('SQ_SYSTEM_SECURITY_KEY_EMAIL', '', 40, '', FALSE, 'onkeypress="enable_submission_button();"');
?>
    <input type="button" id="sq_submit_accessible_captcha" value="Submit address" onclick="submit_email_captcha('<?php echo sq_web_path('lib'); ?>');" />
</span>
<span id="sq_accessible_validation_link">&nbsp;<a href="javascript:show_accessible_captcha();">Use accessible validation</a></span>
    <?php

}//end print_accessible_captcha_interface()


function security_key_field($box_len)
{
    echo text_box('SQ_SYSTEM_SECURITY_KEY_VALUE', '', $box_len);

}//end security_key_field()


function security_key_image_link($link_text)
{
    $img_url = $_SERVER['PHP_SELF'].'?SQ_ACTION=send_security_key';
    ob_start();
        ?><span id="sq_regen_captcha"><a href="#" onclick="var img = document.getElementById('sq_security_key'); img.src = '<?php echo $img_url; ?>&regen_key=1&t=' + new Date().getTime(); return false;"><?php echo $link_text; ?></a></span><?php
        $replacement_link = ob_get_contents();
    ob_end_clean();

    echo $replacement_link;

}//end security_key_image_link()


function validate_security_key()
{
    // If we are using an Accessible CAPTCHA, have received a verification link and clicked it,
    // and there's a grin from the man upstairs, then I think we're golden
    if ((isset($_SESSION['SQ_ACCESSIBLE_CAPTCHA_PASSED'])) && ($_SESSION['SQ_ACCESSIBLE_CAPTCHA_PASSED'] === 1)) {
        // The actual key comparison is done upon the secondary page request at core/lib/accessible_captcha.php
        unset($_SESSION['SQ_ACCESSIBLE_CAPTCHA_PASSED']);

        return TRUE;
    }

    if (!isset($_POST['SQ_SYSTEM_SECURITY_KEY_VALUE'])) {
        return FALSE;
    }
    if (!isset($_SESSION['SQ_SYSTEM_SECURITY_KEY']['key'])) {
        return FALSE;
    }
    $entered_value = $_POST['SQ_SYSTEM_SECURITY_KEY_VALUE'];
    $real_value = $_SESSION['SQ_SYSTEM_SECURITY_KEY']['key'];
    unset($_SESSION['SQ_SYSTEM_SECURITY_KEY']);
    return ($entered_value === $real_value);

}//end validate_security_key()


function var_to_hidden_field($var, $name='')
{
    if (is_array($var) || is_object($var)) {
        foreach ($var as $k => $v) {
            var_to_hidden_field($v, (($name) ? $name.'['.$k.']' : $k));
        }
    } else {
        if ($name) hidden_field($name, $var);
    }

}//end var_to_hidden_field()


function asset_type_chooser($name, $multiple=FALSE, $defaults=Array(), $instantiable=NULL, $system_accessible=FALSE, $show_inherit_checkbox=FALSE, $specified_types=Array())
{
    // if we specified types for the listing, build a list with these
    if (!empty($specified_types)) {
        foreach ($specified_types as $specified_type) {
            $new_types = $GLOBALS['SQ_SYSTEM']->am->getTypeDescendants($specified_type, TRUE);

            foreach ($new_types as $new_type) {
                $types[$new_type] = $GLOBALS['SQ_SYSTEM']->am->getTypeInfo($new_type, 'name');
            }
        }
    } else {
        $types = $GLOBALS['SQ_SYSTEM']->am->getAssetTypes($instantiable, !$system_accessible);

        foreach ($types as $code => $details) {
            $types[$code] = $details['name'];
        }
    }

    asort($types);
    $types = Array('' => '') + $types;
    if ($multiple) {
        if ($show_inherit_checkbox) {
            if (!empty($defaults)) {
                foreach ($defaults['type_code'] as $i => $type_code) {
                    if (empty($type_code)) continue;
                    combo_box($name.'[type_code][]', $types, FALSE, $type_code);
                    hidden_field($name.'[inherit][]', $defaults['inherit'][$i]);
                    check_box('', 1, $defaults['inherit'][$i], 'toggleLastHiddenField(this)');
                    label(strtolower(translate('inherit')), '');
                    normal_button('', translate('clear'), 'resetLastSelect(this)');
                    echo '<br />';
                }
            }
            combo_box($name.'[type_code][]', $types, FALSE, '');
            hidden_field($name.'[inherit][]', 0);
            check_box('', 1, FALSE, 'toggleLastHiddenField(this)');
            label(strtolower(translate('inherit')), '');
            normal_button('', translate('clear'), 'resetLastSelect(this); clearLastCheckbox(this);');
            normal_button('', translate('more').'...', 'prependTypeSelector(this); prependInheritSelector(this); prependClearButton(this, true)');
        } else {
            foreach ($defaults as $default) {
                if (!empty($default)) {
                    combo_box($name.'[]', $types, FALSE, $default);
                    normal_button('', translate('clear'), 'resetLastSelect(this)');
                    echo '<br />';
                }
            }
            combo_box($name.'[]', $types, FALSE, '');
            normal_button('', translate('clear'), 'resetLastSelect(this)');
            normal_button('', translate('more').'...', 'prependTypeSelector(this); prependClearButton(this, false)');
        }
        echo '<br />';
    } else {
        if ($show_inherit_checkbox) {
            combo_box($name.'[type_code]', $types, FALSE, array_get_index($defaults, 'type_code', ''));
            hidden_field($name.'[inherit]', array_get_index($defaults, 'inherit', '0'));
            check_box('', 1, array_get_index($defaults, 'inherit', '0'), 'toggleLastHiddenField(this)');
            label(strtolower(translate('inherit')), '');
        } else {
            combo_box($name, $types, FALSE, $defaults);
        }
    }

}//end asset_type_chooser()


function url_tester($name, $value='', $protocols=Array('http'), $width=50)
{
    ?><script type="text/javascript" src="<?php echo sq_web_path('lib'); ?>/js/JsHttpConnector.js"></script><?php
    ?><script type="text/javascript">

        function getFullUrl(id_name) {
            var elementName = id_name + "_protocol";
            var protocol = document.getElementById(elementName).value;
            var url = document.getElementById(id_name + "_url").value;
            var fullUrl = protocol + url;

            return fullUrl;
        }

        function <?php echo $name; ?>changeStatusText(responseState)
        {
            switch (responseState) {
                case "0":
                    responseText = js_translate('non_existent_page');
                break;
                case "1":
                    responseText = js_translate('valid_page');
                break;
                default:
                    responseText = js_translate('unknown_state');
            }

            document.getElementById('<?php echo $name.'_status_text'; ?>').innerHTML = responseText;

        }//end changeStatusText()

        function checkUrlExists(id_name)
        {
            document.getElementById(id_name + "_status_text").innerHTML = js_translate('testing');
            var testUrl = "<?php echo sq_web_path('lib').'/web/connectivity.php'; ?>" + "?connect_url=" + getFullUrl(id_name);
            JsHttpConnector.submitRequest(testUrl, eval(id_name + "changeStatusText"));

        }//end checkUrlExists()

        function protocolChanged(id_name)
        {
            var protocol = document.getElementById(id_name + "_protocol").value;
            if (protocol == "http://") {
                document.getElementById(id_name + "_button_auto").disabled = "";
            } else {
                document.getElementById(id_name + "_button_auto").disabled = "disabled";
            }
            document.getElementById(id_name + "_status_text").innerHTML = "";

        }//end protocolChanged()

        function testUrl(id_name)
        {
            window.open(getFullUrl(id_name));

        }
    </script><?php

    $default_prot = '';
    $dd_values = array_flip($protocols);
    foreach ($dd_values as $key => $prot) {
        $replacement = '';
        if ($key == 'mailto') {
            $replacement = $key.':';
            $dd_values[$replacement] = $replacement;
        } else {
            $replacement = $key.'://';
            $dd_values[$replacement] = $replacement;
        }
        unset($dd_values[$key]);

        // because we are storing the protocol + URL as the value, we
        // need to separate the two
        $protocol = substr($value, 0, strlen($replacement));
        if ($protocol == $replacement) {
            $default_prot = $protocol;
            $value = substr($value, strlen($replacement));
        }
    }

    combo_box($name.'_protocol', $dd_values, FALSE, $default_prot, 0, 'onChange="protocolChanged(\''.$name.'\')";');
    echo '&nbsp;';

    text_box($name.'_url', $value, $width);
    echo '&nbsp;';

    normal_button($name.'_button_auto', 'Auto-Test', 'javascript: checkUrlExists(\''.$name.'\');');
    normal_button($name.'button_manual', 'Open URL', 'javascript: testUrl(\''.$name.'\');');

    ?><div id="<?php echo $name; ?>_status_text"></div><?php

}//end url_tester()


function get_url_tester_url($name)
{
    $url = '';
    if ( (!empty($_REQUEST[$name.'_protocol'])) && (!empty($_REQUEST[$name.'_url'])) ) {
        $url = $_REQUEST[$name.'_protocol'].$_REQUEST[$name.'_url'];
    }
    return trim($url);

}//end get_url_tester_url()


function structured_drop_down($name, $root_id, $type_codes, $selected=Array(), $width=0, $height=0, $max_depth=0, $allow_multiple=FALSE, $seperator='-', $include_root=FALSE, $root_text='', $check_boxes=FALSE, $statuses=Array(), $structured=TRUE, $link_types=Array(), $allow_empty=FALSE, $permission=NULL)
{
    $all_child_links = $GLOBALS['SQ_SYSTEM']->am->getAllChildLinks($root_id, 0, $permission, TRUE, 'gc_', $max_depth);

    $child_links = $all_child_links;
    $search_tree = Array();

    $asset_info_ids = Array();

    $invalid = Array();
    $invalid_type = Array();

    // weed out any unwanted entries
    foreach ($all_child_links as $treeid => $data) {
        // build an array of assetids as we go
        $asset_info_ids[] = $data['assetid'];

        if (!in_array($data['type_code'], $type_codes) && !empty($type_codes)) {
            $invalid_type[] = $child_links[$treeid]['assetid']; // we need this
            unset($child_links[$treeid]);
            // need to take this bit off as it is storing the treeid of the asset which has invalid type_code match
            // by doing so we are not looking under this tree id. But what if i have a Folder under a Standard Page
            // and i have restricted type to "Folder" ???
            // below code will result id not looking under the standard page all together since it is a type_code mismatch
            // $invalid[] = $treeid;
            continue;
        }

        if ($child_links[$treeid]['is_dependant']) {
            $invalid_type[] = $child_links[$treeid]['assetid']; // we need this
            unset($child_links[$treeid]);
            $invalid[] = $treeid;
            continue;
        }

        if ($structured) {
            // Bug #2914 - Returning folders that are listed under assets which should not be printed
            // This had an if statement here to test for structured=TRUE which did not filter all out properly
            // Bug Fix #3534. This need to be put back from the previous bug fix. Just the logic was wrong
            foreach ($invalid as $banned) {
                if (strlen($banned) > strlen($treeid)) continue;
                if (substr($treeid, 0, strlen($banned)) == $banned) {
                    unset($child_links[$treeid]);
                    continue 1;
                }
            }
        }

        if (!empty($link_types) && !in_array($data['link_type'], $link_types)) {
            unset($child_links[$treeid]);
            $invalid[] = $treeid;
        }
    }//end foreach

    // check if we have statuses we want to filter out, and also check user has atleast read permission
    if (!empty($statuses) && count($statuses) < 9) {
        foreach ($child_links as $treeid => $data) {
            $asset_info = $GLOBALS['SQ_SYSTEM']->am->getAssetInfo(Array($data['assetid']));
            if (!in_array($asset_info[$data['assetid']]['status'], $statuses)) {
                unset($child_links[$treeid]);
            }
        }
    }

    $options = Array();
    if ($allow_empty) $options[''] = '';
    $level = 1;
    if ($include_root) {
        if (!empty($root_text)) {
            $options[$root_id] = $root_text;
        } else {
            $options[$root_id] = 'All';
        }
        $level = 0;
    }
    // Insert each node into the tree
    $search_tree = Array();
    foreach ($child_links as $treeid => $child) {
        id_list_to_tree($treeid, $search_tree, '', $child['sort_order']);
    }
    sort_tree($search_tree);
    draw_tree($search_tree, $all_child_links, $options, '', $level, $seperator, $max_depth, $structured);

    // some how while in draw_tree function, matrix is putting back the assets that were removed in the
    // very first foreach() method call in the function. so we have to get rid of them
    foreach ($options as $key_id => $name_value) {
        if (in_array($key_id,$invalid_type)) {
            unset($options[$key_id]);
        }
    }

    if ($check_boxes) {
        foreach ($options as $id => $output) {
            if ($allow_multiple) {
                check_box($name.'['.$id.']', $id, in_array($id, $selected));
            } else {
                radio_button($name, $id, in_array($id, $selected));
            }
            label($output, $name.'['.$id.']');
            echo '<br />';
        }
    } else {
        combo_box($name, $options, $allow_multiple, $selected, $height, ($width != '0') ? 'style="width:'.$width.'px;"' : '');
    }

}//end structured_drop_down()


function id_list_to_tree($treeid, &$tree, $chunk_prefix='', $sort_order)
{
    if (strlen($treeid) < SQ_CONF_ASSET_TREE_SIZE) return FALSE;

    $first_chunk = substr($treeid, 0, SQ_CONF_ASSET_TREE_SIZE);

    if (strlen($treeid) > SQ_CONF_ASSET_TREE_SIZE) {
        $remaining_chunk = substr($treeid, SQ_CONF_ASSET_TREE_SIZE, strlen($treeid));
        if (!isset($tree[$chunk_prefix.$first_chunk]) || !is_array($tree[$chunk_prefix.$first_chunk])) {
            $tree[$chunk_prefix.$first_chunk] = Array();
            $tree[$chunk_prefix.$first_chunk]['sort_order'] = 0;
        }
        id_list_to_tree($remaining_chunk, $tree[$chunk_prefix.$first_chunk], $chunk_prefix.$first_chunk, $sort_order);
    } else {
        $tree[$chunk_prefix.$first_chunk]['sort_order'] = $sort_order;
    }

}//end id_list_to_tree()


function draw_tree($tree, &$all_child_links, &$output_tree, $branch='', $level=0, $seperator='-', $max_depth=0, $use_seperator=TRUE)
{
    if (empty($tree)) return FALSE;
    foreach ($tree as $branch => $branch_data) {
        // skip if current node is not treeid element
        if ($branch == 'sort_order') continue;
        $prefix = '';

        $lvl = $all_child_links[$branch]['lvl'] - $level;
        if ($max_depth != 0 && $lvl >= $max_depth) {
            return;
        }
        if ($use_seperator == TRUE) {
            for ($i = 0; $i < $lvl; $i++) {
                $prefix .= ' '.$seperator.' ';
            }
        }
        $output_tree[$all_child_links[$branch]['assetid']] = $prefix.$all_child_links[$branch]['short_name'];
        if (is_array($branch_data) && !empty($branch_data)) {
            draw_tree($branch_data, $all_child_links, $output_tree, $branch, $level, $seperator, $max_depth, $use_seperator);
        }
    }

}//end draw_tree()


function keyword_selector($keywords, $target_id, $self_id=NULL, $prompt=NULL)
{
    static $internal_id = 0;
    if (is_null($self_id)) {
        $internal_id++;
        $self_id = 'sq_keyword_selector_'.$internal_id;
    }

    if (empty($prompt)) {
        $prompt = '-- '.translate('insert_keyword').' --';
    }

    ?><script type="text/javascript" src="<?php echo sq_web_path('lib')?>/html_form/html_form.js"></script>
    <select id="<?php echo $self_id; ?>" onchange="insert_text(this.value, '<?php echo $target_id; ?>', this.selectedIndex=0)">
        <option value=""><?php echo $prompt; ?></option>
    <?php
    foreach ($keywords as $kw => $name) {
        ?>
        <option value="<?php echo htmlentities($kw, ENT_COMPAT, SQ_CONF_DEFAULT_CHARACTER_SET); ?>"><?php echo htmlentities($name, ENT_COMPAT, SQ_CONF_DEFAULT_CHARACTER_SET); ?></option>
        <?php
    }
    ?>
    </select>
    <?php

}//end keyword_selector()


function sort_tree(&$tree)
{
    foreach ($tree as &$treeid) {
        // checks if nested array has more entries than just sort_order key
        if (count($treeid) > 1) {
            sort_tree($treeid);
        }
    }

    uasort($tree, 'sort_compare');

}//end sort_tree()


function sort_compare($left, $right)
{   
    if (!is_array($left) || !is_array($right)) {
        return 0;
    }
    if ($left['sort_order'] > $right['sort_order']) {
        return 1;
    } else {
        return -1;
    }

}//end sort_compare()


?>