data_source_edit_fns.inc

<?php
require_once SQ_INCLUDE_PATH.'/asset_edit/asset_edit_fns.inc';

class Data_Source_Edit_Fns extends Asset_Edit_Fns
{


    function __construct()
    {
        parent::__construct();

    }//end constructor


    public function paintShadow(Data_Source $asset, Backend_Outputter $o, $prefix)
    {
        $name = $asset->attr('shadow_name');
        $wa = $asset->writeAccess('attributes');
        if ($wa) {
            text_box('shadow_name', !empty($name) ? $name : '', 80);
        } else {
            if (!empty($name)) echo $name;
        }

        return $wa;

    }//end paintShadow()


    public function processShadow(Data_Source $asset, Backend_Outputter $o, $prefix)
    {
        if (!$asset->writeAccess('attributes')) return FALSE;

        $new_name = NULL;
        $name = $asset->attr('shadow_name');
        if (!empty($_POST['shadow_name'])) {
            $new_name = $_POST['shadow_name'];
        }
        if ($name != $new_name) {
            $res = $asset->setAttrValue('shadow_name', $new_name);
            return TRUE;
        } else {
            return FALSE;
        }

    }//end processShadow()


    public function paintKeywords(Data_Source $asset, Backend_Outputter $o, $prefix)
    {
        $shadow_asset = $asset->getAsset($asset->id.':0');
        if (is_null($shadow_asset)) {
            echo '<strong>'.translate('data_source_no_keywords').'</strong>';
            return;
        }
        $keywords = $shadow_asset->getAvailableKeywords();
        $write_access = $asset->writeAccess('attributes');
        ?>
        <table class="sq-backend-table">
            <tr>
                <th><?php echo translate('keyword');?></th>
                <th><?php echo translate('description');?></th>
            </tr>
            <?php
            foreach ($keywords as $key => $desc) {
                // all the keywords other than the shadow asset name are to be displayed for the user to choose the
                // keywords or a combination of keywords and strings to set the shadow asset name
                if ($key == 'data_source_record_set_shadow_asset_name' || $key == 'ds__shadow_asset_name') {
                    unset($keywords[$key]);
                    continue;
                } else {
                    if (strpos($key, 'data_source_record_set') === FALSE && strpos($key, 'ds__') === FALSE) {
                        unset($keywords[$key]);
                        continue;
                    }
                }
                ?>
                <tr>
                    <td><?php echo '%'.$key.'%';?> </td>
                    <td><?php echo $desc; ?> </td>
                </tr>
            <?php
            }
        ?>
        </table>
        <?php

        return $write_access;

    }//end paintKeywords()
    
    
    


    public function processKeywords(Data_Source $asset, Backend_Outputter $o, $prefix)
    {
        return FALSE;

    }//end processKeywords()


    public function paintRecordFilter(&$asset, &$o, $prefix)
    {
        $filters = $asset->attr('record_filters');
        $wa = $asset->writeAccess('attributes');
        ?>
        <table class ="sq-backend-table" border="1" style="margin-bottom: 7px">
            <tr>
                <th width="20%"><?php echo translate('data_source_filter_name'); ?></th>
                <th width="45%"><?php echo translate('data_source_value_to_match'); ?></th>
                <th><?php echo translate('data_source_match_type'); ?></th>
                <th><?php echo translate('data_source_match_case'); ?></th>
                <?php
                if ($wa) {
                    ?>
                    <th><?php echo translate('delete'); ?></th>
                    <?php
                }
                ?>
            </tr>
            <?php
            
            $match_options = Array(
                                'exact' => 'String match - Exact',
                                'contains' => 'String match - Contains',
                                'regex' => 'Regex match',
                                );
            $case_options = Array(
                                'ignore_case' => 'No',
                                'match_case' => 'Yes',
                            );
            
            foreach ($filters as $index => $field_data) {
                $field_name = $field_data['name'];
                $field_value = $field_data['value'];
                $match_type = $field_data['match_type'];
                $match_case = $field_data['match_case'];                
                
                ?>
                <tr>                
                    <td>
                        <?php
                            if ($wa) {
                                text_box($prefix.'_filter['.$index.'][name]', $field_name, 30);
                            } else {
                                echo $field_name;
                            }
                        ?>
                    </td>
                    <td>
                        <?php
                            if ($wa) {
                                text_box($prefix.'_filter['.$index.'][value]', $field_value, 80);
                            } else {
                                echo $field_value;
                            }
                        ?>
                    </td>
                    <td>
                        <?php
                            if ($wa) {
                                combo_box($prefix.'_filter['.$index.'][match_type]', $match_options, FALSE, $match_type);
                            } else {
                                echo $match_options[$match_type];
                            }
                        ?>
                    </td>
                    <td>
                        <?php
                            if ($wa) {
                                combo_box($prefix.'_filter['.$index.'][match_case]', $case_options, FALSE, $match_case);
                            } else {
                                echo $case_options[$match_case];
                            }
                        ?>
                    </td>
                    <?php
                        if ($wa) {                      
                            echo '<td>';
                            check_box($prefix.'_filter['.$index.'][delete]');
                            echo '</td>';
                        }
                    ?>


                </tr>
            <?php
            }
            ?>
        </table>
        <?php
        if ($wa) {
            label(translate('data_source_new_filter'), $prefix.'_new_filter_name');
            echo '&nbsp;';
            text_box($prefix.'_new_filter_name', '', 25);
        }
        
        $o->sectionNote(translate('data_source_dynamic_keywords_node'));

        return $wa;

    }//end paintRecordFilter()


    public function processRecordFilter(&$asset, &$o, $prefix)
    {   
        if (!$asset->writeAccess('attributes')) return FALSE;       
        
        $updated_filters = Array();
        if (isset($_POST[$prefix.'_filter'])) {
            foreach($_POST[$prefix.'_filter'] as $index => $filter_data) {
                if (isset($filter_data['delete'])) {                    
                    continue;
                }
                $filter_name = trim($filter_data['name']);
                $filter_value = $filter_data['value'];
                $match_type = $filter_data['match_type'];
                $match_case = $filter_data['match_case'];
                
                // Validate the regex string
                if ($match_type == 'regex' && !empty($filter_value)) {
                    $valid_regex = @preg_match('/'.str_replace('/', '\/',$filter_value).'/', 'test');
                    if ($valid_regex === FALSE) {
                        trigger_localised_error('DATA0007', E_USER_WARNING, $filter_value);                     
                        $filter_value = '';
                    }
                }
                
                $updated_filters[] = Array(
                                    'name' => $filter_name,
                                    'value' => $filter_value,
                                    'match_type' => $match_type,
                                    'match_case' => $match_case,
                                );
            }//end foreach
        }//end if
        
        if (!empty($_POST[$prefix.'_new_filter_name'])) {
            $updated_filters[] = Array(
                                'name' => trim($_POST[$prefix.'_new_filter_name']),
                                'value' => '',
                                'match_type' => 'contains',
                                'match_case' => 'ignore_case',
                            );
        }       
        
        return $asset->setAttrValue('record_filters', $updated_filters);

    }//end processRecordFilter()

    
    public function resultSetExists(&$asset, $prefix)
    {
        $result = $asset->getResultSet();
        return !empty($result);

    }//end resultSetExists()
    
    
    function paintDynamicData(&$asset, &$o, $prefix)
    {
        $write_access = $asset->writeAccess('attributes');

        $var_list = $asset->attr('dynamic_vars');

        $o->openRaw();

        echo '<table class="sq-backend-table">';
        echo '<tr>';
        echo '<th>Name</th>';
        echo '<th>Default Value</th>';
        if ($write_access) {
            echo '<th width="10%" align="right" style="border-left: dotted 1px grey;">Delete</th>';
        }
        echo '</tr>';
        foreach ($var_list as $var => $value) {
            $var_id = base64_encode($var);

            echo '<tr>';
            echo '<td>';
            if ($write_access) {
                text_box($prefix.'_var_name['.$var_id.']', $var);
            } else {
                echo $var;
            }
            echo '</td>';
            echo '<td valign="top" align="left">';
            $value = urldecode($value);
            if ($write_access) {
                text_box($prefix.'_var_value['.$var_id.']', urlencode($value));
            } else {
                echo urlencode($value);
            }
            echo '</td>';
            if ($write_access) {
                echo '<td style="border-left: dotted 1px grey;">';
                check_box($prefix.'_delete_var['.$var_id.']');
                echo '</td>';
            }
            echo '</tr>';
        }

        if ($write_access) {
            echo '<tr class="new-data-row">';
            echo '<th colspan="3" align="left">';
            echo '<em style="color:#666">Add New Variables Below</em>';
            echo '</th>';
            echo '</tr>';

            echo '<tr class="new-data-row">';
            echo '<td>';
            text_box($prefix.'_new_dynamic_data_name[]', NULL);
            echo '</td>';
            echo '<td>';
            text_box($prefix.'_new_dynamic_data_value[]', NULL);
            echo '</td>';
            echo '<td style="border-left: dotted 1px grey;">';
            echo '</td>';
            echo '</tr>';
        }
        echo '</table>';

        $o->closeRaw();

        $o->sectionNote(translate('data_source_variable_section_note'));

        $o->closeSection();

        $o->openSection('Data Mappings');
        $o->openRaw();
        $map = $asset->getAttribute('parameter_map');

        $parameter_names = $map->getParameters();

        foreach ($var_list as $var_name => $default) {
            $map->setParameter($var_name, 'Variable: '.$var_name);
        }

        $map->paint($prefix.'_parameter_map', !$write_access);
        $o->closeRaw();

        $o->sectionNote(translate('data_source_mappings_section_note'));
        
        return $write_access;

    }//end paintDynamicData()


    function processDynamicData(&$asset, &$o, $prefix)
    {
        $var_name_pattern = '/^[a-zA-Z_\-0-9\.]+$/';

        $write_access = $asset->writeAccess('attributes');
        if (!$write_access) return FALSE;

        $to_delete = array_get_index($_REQUEST, $prefix.'_delete_var', Array());
        $var_value = array_get_index($_REQUEST, $prefix.'_var_value', Array());
        $var_name = array_get_index($_REQUEST, $prefix.'_var_name', Array());

        $var_list = $asset->attr('dynamic_vars');

        $map = $asset->getAttribute('parameter_map');

        $parameter_names = $map->getParameters();
        foreach ($var_list as $name => $default) {
            $map->setParameter($name, 'Variable: '.$name);
        }

        $map->process($prefix.'_parameter_map');
        
        foreach ($var_value as $hash => $value) {
            $name = base64_decode($hash);
            if (isset($to_delete[$hash])) {
                unset($var_list[$name]);
                // also need to delete it from the PARAMETER MAP
                if (in_array($name, $parameter_names)) {
                    $map->unsetParameter($name);
                }

                continue;
            }
            $value = urldecode($value);
            $var_list[$name] = urlencode($value);
        }

        $new_var_list = Array();
        $rename_success = FALSE;

        // now we rename variables
        foreach ($var_name as $hash => $new_name) {
            $new_name = trim($new_name);

            if (empty($new_name)) {
                $rename_success = FALSE;
                trigger_error('Variable name cannot be empty. No variables were renamed.', E_USER_NOTICE);
                break;
            }

            // check new name against regex
            $new_name_is_valid = preg_match($var_name_pattern, $new_name);
            if (!$new_name_is_valid) {
                $rename_success = FALSE;
                trigger_error('Variable name ['.htmlentities($new_name).'] contains characters that are not allowed. Can only use letters (A-Za-z), digits(0-9), underscore (_), dash (-) and dot (.)', E_USER_NOTICE);
                break;
            }

            $name = base64_decode($hash);

            // skip the deleted vars
            if (!isset($var_list[$name])) continue;

            if (isset($new_var_list[$new_name])) {
                $rename_success = FALSE;
                trigger_error('Could not rename variables because variable name "'.htmlentities($new_name).'" already exists', E_USER_NOTICE);
                break;
            }

            if ($new_name != $name) {
                if (in_array($name, $parameter_names)) {
                    $map->moveParameter($name, $new_name);
                }
                $rename_success = TRUE;
            }

            $new_var_list[$new_name] = $var_list[$name];

        }//end foreach


        if ($rename_success) $var_list = $new_var_list;

        $new_names = array_get_index($_REQUEST, $prefix.'_new_dynamic_data_name', Array());
        if (!empty($new_names)) {

            foreach ($new_names as $seq_number => $new_var_name) {
                $new_var_name = trim($new_var_name);

                $new_var_value = array_get_index($_REQUEST[$prefix.'_new_dynamic_data_value'], $seq_number, '');
                if (empty($new_var_name)) {
                    if (!empty($new_var_value)) {
                        trigger_error('New variable name cannot be empty', E_USER_WARNING);
                    }
                    continue;
                }

                // check new name against regex
                $new_name_is_valid = preg_match($var_name_pattern, $new_var_name);
                if (!$new_name_is_valid) {
                    trigger_error('Variable name "'.htmlentities($new_var_name).'" contains characters that are not allowed. Can only use letters (A-Za-z), digits(0-9), underscore (_), dash (-) and dot (.)', E_USER_NOTICE);
                    continue;
                }

                if (isset($var_list[$new_var_name])) {
                    trigger_error('Variable Name "'.htmlentities($new_var_name).'" is already in use', E_USER_WARNING);
                    continue;
                }
                $new_var_value = urldecode($new_var_value);
                $var_list[$new_var_name] = urlencode($new_var_value);
                $map->setParameter($new_var_name, 'Variable: '.$new_var_name);
            }
        }

        $asset->setAttrValue('dynamic_vars', $var_list);
        $asset->setAttrValue('parameter_map', unserialize($map->value));

        return TRUE;

    }//end processDynamicData() 


}//end class

?>