trigger_action_add_web_path.inc

<?php
require_once SQ_INCLUDE_PATH.'/general_occasional.inc';
require_once SQ_CORE_PACKAGE_PATH.'/system/triggers/trigger_action/trigger_action.inc';

class Trigger_Action_Add_Web_Path extends Trigger_Action
{


    public static function execute($settings, &$state)
    {
        // check required settings
        if (empty($settings['path'])) return FALSE;

        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;

        // replace keywords
        $web_path = self::replaceKeywordsInWebPath($settings['path'], $state['asset']);
        $valid_paths = make_valid_web_paths(Array($web_path));
        $web_path = array_shift($valid_paths);

        // lowercase the new web path, if needed
        if (!empty($settings['make_lowercase'])) {
            $web_path = strtolower($web_path);
        }
        
        // add the new web path
        $web_paths_new = $web_paths_old = $state['asset']->getWebPaths();
        if (!in_array($web_path, $web_paths_new)) {
            $web_paths_new[] = $web_path;
        }

        // remove all other paths, if needed
        if (!empty($settings['remove_all'])) {
            $web_paths_new = Array($web_path);
        }
        
        // don't add remaps, if set so
        $add_auto_remaps = !isset($settings['dont_add_remap']) || !$settings['dont_add_remap'];
        
        // only save the new paths if they have changed
        // (note that lookups are updated by the saveWebPaths fn)
        if ($web_paths_new !== $web_paths_old) {
            if (!$state['asset']->saveWebPaths($web_paths_new, $add_auto_remaps)) {
                return FALSE;
            }

            // note that we dont update the lookups of all our children so we have
            // the greatest level of control over what occurs during things like imports

            // probably need another trigger action to update lookups (run the HIPO job)
        }

        //update lookups for children
        if(!empty($settings['update_children'])){
            $hh = $GLOBALS['SQ_SYSTEM']->getHipoHerder();   
            $vars = Array('assetids' => Array($state['asset']->id));
            $lookup_errors = $hh->freestyleHipo('hipo_job_update_lookups', $vars);
            if (!empty($lookup_errors)) {
                return FALSE;
            }
        }

        return Array(
                'assetid'   => $state['asset']->id,
                'path'      => $web_path,
               );

    }//end execute()


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

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

        return $web_path;

    }//end replaceKeywordsInWebPath()


    public static function getInterface($settings, $prefix, $write_access=FALSE)
    {
        ob_start();

        $web_path = array_get_index($settings, 'path', '');
        echo translate('add_web_path').' ';
        if ($write_access) {
            text_box($prefix.'[path]', $web_path, 40);
        } else {
            echo '<b>'.$web_path.'</b>';
        }
        echo '<br />';
        echo '<div class="sq-backend-section-note">'.translate('trigger_add_web_path_note').'</div>';
        check_box($prefix.'[remove_all]', '1', array_get_index($settings, 'remove_all', '0'), '', ($write_access ? '' : 'disabled="disabled"'));
        echo '<label for='.$prefix.'[remove_all]'.'>'.translate('trigger_add_web_path_remove_all').'.</label>';
        echo '<br />';
        check_box($prefix.'[make_lowercase]', '1', array_get_index($settings, 'make_lowercase', '0'), '', ($write_access ? '' : 'disabled="disabled"'));
        echo '<label for='.$prefix.'[make_lowercase]'.'>'.translate('trigger_add_web_path_make_lowercase').'.</label>';
        echo '<br />';
        check_box($prefix.'[update_children]', '1', array_get_index($settings, 'update_children', '0'), '', ($write_access ? '' : 'disabled="disabled"'));
        echo '<label for='.$prefix.'[update_children]'.'>'.translate('trigger_add_web_path_update_children').'.</label>';
        echo '<br />';
        check_box($prefix.'[dont_add_remap]', '1', array_get_index($settings, 'dont_add_remap', '0'), '', ($write_access ? '' : 'disabled="disabled"'));
        echo '<label for='.$prefix.'[dont_add_remap]'.'>'.translate('trigger_add_web_path_dont_add_remap').'.</label>'; 
        return ob_get_clean();

    }//end getInterface()


    public static function processInterface(&$settings, $request_data)
    {
        $web_path = array_get_index($request_data, 'path', '');
        $web_path = trim($web_path);
        if ($web_path == '') {
            return translate('web_path_not_specified');
        }
        $settings['path'] = $web_path;
        $settings['remove_all'] = array_get_index($request_data, 'remove_all', '');
        $settings['make_lowercase'] = array_get_index($request_data, 'make_lowercase', '');
        $settings['update_children'] = array_get_index($request_data, 'update_children', '');
        $settings['dont_add_remap'] = array_get_index($request_data, 'dont_add_remap', '');
        return FALSE;

    }//end processInterface()

    
    public static function getLocks($settings, &$state)
    {
        return Array($state['assetid'] => Array('lookups'));

    }//end getLocks()


}//end class

?>