trigger_action_set_future_lineage.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_Set_Future_Lineage extends Trigger_Action
{


    public static function execute($settings, &$state)
    {
        // check settings, status
        if (empty($settings['link_type']) || empty($settings['major_assetid'])) {
            // if no settings, fail
            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']);
            }
        }

        $cron_mgr = $GLOBALS['SQ_SYSTEM']->am->getSystemAsset('cron_manager');
        if (is_null($cron_mgr)) return FALSE;

        $GLOBALS['SQ_SYSTEM']->am->includeAsset('cron_job_future_lineage');
        $fs = new Cron_Job_Future_Lineage();

        // Set up the type of the link to make.
        $link_info = $fs->attr('link_info');
        $link_info['link_type'] = $settings['link_type'];

        // Calculate one-off date/time from asset if it was dynamically supplied
        if (!empty($settings['attribute']) && !empty($settings['asset_type']) && ($state['asset'] instanceof $settings['asset_type'])) {
            $attr = $state['asset']->getAttribute($settings['attribute']);

            // Perform some validation on the supplied date/time value
            $datetime = $attr->value;

            // If the time is not set, assume midnight so the job will run on the first cron run of the day
            $time = substr($datetime, 10);
            if ($time == ' --:--:--') {
                $time = ' 00:00:00';
                $datetime = substr($datetime, 0, 10).$time;
            }

            // Remove leading space from time component
            $time = ltrim($time);

            $timestamp = mktime(
                            (int) substr($time,0,2),
                            (int) substr($time,3,2),
                            (int) substr($time,6,2),
                            (int) substr($datetime,5,2),
                            (int) substr($datetime,8,2),
                            (int) substr($datetime,0,4)
                         );
            $parsed_datetime = date('Y-m-d H:i:s', $timestamp);
            if (strcmp($parsed_datetime, $datetime) != 0) {
                trigger_localised_error('SYS0311', E_USER_NOTICE, $datetime);
            }

            // Set a one-off job to run based on the supplied attribute value
            $fs->setAttrValue('when', 'OO='.$parsed_datetime);
        } else {
            $fs->setAttrValue('when', $settings['when']);
        }

        $fs->setAttrValue('link_info', $link_info);
        $fs->setAttrValue('delete_link_all', $settings['delete_link_all']);

        if ($GLOBALS['SQ_SYSTEM']->runLevelEnables(SQ_SECURITY_PERMISSIONS)) {
            $user_for_status_change = $GLOBALS['SQ_SYSTEM']->user;
        } else {
            // not doing the whole "security" thing - so pretend we are root
            $user_for_status_change = $GLOBALS['SQ_SYSTEM']->am->getSystemAsset('root_user');
        }

        $GLOBALS['SQ_SYSTEM']->changeDatabaseConnection('db2');
        $GLOBALS['SQ_SYSTEM']->doTransaction('BEGIN');
        $major_asset = $GLOBALS['SQ_SYSTEM']->am->getAsset($settings['major_assetid']);
        if ($fs->setAssetInLink($state['asset'], 'minor') && $fs->setAssetInLink($major_asset, 'major')) {
            if ($cron_mgr->addJob($fs, $user_for_status_change)) {
                $GLOBALS['SQ_SYSTEM']->doTransaction('COMMIT');
                $GLOBALS['SQ_SYSTEM']->restoreDatabaseConnection();
                return Array(
                        'jobid'         => $fs->id,
                        'userid'        => $user_for_status_change->id,
                        'major_assetid' => $settings['major_assetid'],
                        'when'          => $fs->attr('when'),
                       );
            }
        }
        $GLOBALS['SQ_SYSTEM']->doTransaction('ROLLBACK');
        $GLOBALS['SQ_SYSTEM']->restoreDatabaseConnection();
        return FALSE;

    }//end execute()


    public static function getInterface($settings, $prefix, $write_access=FALSE)
    {
        // First, munge the prefix so that we can use the Cron Job interfaces to paint/process
        $munge_prefix = str_replace('[', '_', $prefix);
        $munge_prefix = str_replace(']', '', $munge_prefix);

        // set defaults
        $settings['when']   = array_get_index($settings, 'when');
        $settings['link_type'] = array_get_index($settings, 'link_type');
        $settings['major_assetid'] = array_get_index($settings, 'major_assetid');
        $settings['delete_link_all'] = array_get_index($settings, 'delete_link_all', FALSE);
        $settings['prefix'] = $munge_prefix;

        require_once SQ_INCLUDE_PATH.'/general_occasional.inc';

        // Combo box for selecting the type of link.
        $editable_link_types = Array(
                                SQ_LINK_TYPE_1  => link_type_name(SQ_LINK_TYPE_1),
                                SQ_LINK_TYPE_2  => link_type_name(SQ_LINK_TYPE_2),
                               );
        ob_start();
            combo_box($prefix.'[link_type]', $editable_link_types, FALSE, $settings['link_type']);
        $output['new_link_type'] = ob_get_clean();

        // Asset finder for selecting the new parent.
        ob_start();
            asset_finder($prefix.'[major_assetid]', $settings['major_assetid'], Array(), 'sq_sidenav', FALSE, 'null', Array('clear'));
            echo ' ';
            check_box($prefix.'[delete_link_all]', 1, $settings['delete_link_all']);
            echo ' ';
            label(translate('cron_fl_delete_all_existing_links_long'), $prefix.'[delete_link_all]');
        $output['new_link_parent'] = ob_get_clean();

        // We'll use the cron job we're going to create to print the 'when' part of the interface.
        $GLOBALS['SQ_SYSTEM']->am->includeAsset('cron_job_future_lineage');
        $temporary_cron_job = new Cron_Job_Future_Lineage();
        $temporary_edit_fns = $temporary_cron_job->getEditFns();

        // Use the cron job edit functions to paint the 'when' box.
        $o = new Backend_Outputter();
        ob_start();
            $temporary_edit_fns->_paintWhenBox($temporary_cron_job, $o, $munge_prefix, $settings['when']);

            echo '<br />or by the date/time value from the ';
            $selected_type = array_get_index($settings, 'asset_type', '');
            if ($write_access) {
                asset_type_chooser($prefix.'[asset_type]', FALSE, Array($selected_type), TRUE);
            } else {
                echo '<b>'.$selected_type.'</b>';
            }
            echo ' attribute ';

            if ($selected_type == '') {
                echo '<b>['.translate('asset_type_not_selected').']</b';
            } else {
                $attribute = array_get_index($settings, 'attribute', '');
                $attrs = $GLOBALS['SQ_SYSTEM']->am->getAssetTypeAttributes($selected_type);
                if (empty($attrs)) {
                    echo '<b>['.translate('asset_type_no_attributes_found').']</b>';
                } else {
                    if ($write_access) {
                        $attr_options = Array();
                        foreach ($attrs as $attr_name => $attr_type) {
                            if ($attr_type['type'] == 'datetime') {
                                $attr_options[$attr_name] = $attr_name;
                            }
                        }
                        if (count($attr_options) > 0) {
                            combo_box($prefix.'[attribute]', $attr_options, FALSE, $attribute);
                        } else {
                            echo '<b>['.translate('asset_type_no_attributes_found').']</b>';
                        }
                    } else {
                        echo '<b>'.$attribute.'</b>';
                    }
                }
            }

        $output['at'] = ob_get_clean();

        // Remember our munge-iness.
        hidden_field($prefix.'[prefix]', $munge_prefix);

        if (!$write_access) return '';

        // Stick it all together in a table (yes, I know) so it looks pretty.
        ob_start();
            ?><table border="0" cellpadding="4" cellspacing="0"><?php
                foreach ($output as $title => $text) {
                    ?><tr><td><strong><?php echo translate($title); ?></strong></td><td><?php echo $text; ?></td></tr><?php
                }
            ?></table><?php
        return ob_get_clean();

    }//end getInterface()


    public static function processInterface(&$settings, $request_data)
    {
        $munge_prefix = $request_data['prefix'];
        $link_type = $request_data['link_type'];
        $major_assetid = $request_data['major_assetid']['assetid'];

        $delete_link_all = FALSE;
        if (isset($request_data['delete_link_all'])) {
            $delete_link_all = TRUE;
        }

        if (!$major_assetid) return 'New parent not specified';

        $GLOBALS['SQ_SYSTEM']->am->includeAsset('cron_job_future_lineage');
        $fs = new Cron_Job_Future_Lineage();
        $edit_fns = $fs->getEditFns();

        $o = new Backend_Outputter();
        $settings['when'] = $edit_fns->_processWhenBox($fs, $o, $munge_prefix);

        $type_code = array_get_index($request_data, 'asset_type', FALSE);
        if ($type_code) {
            $settings['asset_type'] = $type_code;
            $settings['attribute'] = array_get_index($request_data, 'attribute', '');

            if (!empty($settings['attribute']) && !empty($settings['asset_type'])) {
                $GLOBALS['SQ_SYSTEM']->am->includeAsset($settings['asset_type']);
                $dummy_asset = new $settings['asset_type'];
                $attr = $dummy_asset->getAttribute($settings['attribute']);
                if (is_null($attr) || (get_class($attr) != 'Asset_Attribute_DateTime')) {
                    // selected asset type does not have an attribute with the selected name, so reset
                    $settings['attribute'] = '';
                }
            }
        }

        $settings['prefix'] = $munge_prefix;

        $settings['link_type'] = $link_type;
        $settings['major_assetid'] = $major_assetid;
        $settings['delete_link_all'] = $delete_link_all;

        // Right, everything went well, so let's return FALSE?!!
        return FALSE;

    }//end processInterface()


}//end class

?>