cron_job_send_submission_log.inc

<?php
require_once SQ_CORE_PACKAGE_PATH.'/system/cron/cron_job/cron_job.inc';

class Cron_Job_Send_Submission_Log extends Cron_Job
{


    function __construct($assetid=0)
    {
        parent::__construct($assetid);

    }//end constructor
    
    
    protected function _createAdditional(Array &$link)
    {
        if (!parent::_createAdditional($link)) return FALSE;

        if (!empty($this->_tmp['asset_in_link'])) {
            if (!$GLOBALS['SQ_SYSTEM']->am->acquireLock($this->id, 'links')) {
                trigger_localised_error('CRON0018', E_USER_WARNING);
                return FALSE;
            }

            $link = $this->_tmp['asset_in_link'];
            $asset = $GLOBALS['SQ_SYSTEM']->am->getAsset($link['minorid'], $link['minor_type_code']);
            if (is_null($asset) || !$this->setAssetToUpdate($asset)) {
                trigger_localised_error('CRON0017', E_USER_WARNING);
                return FALSE;
            }

            unset($this->_tmp['asset_in_link']);
            $GLOBALS['SQ_SYSTEM']->am->releaseLock($this->id, 'links');
        }
        return TRUE;

    }//end _createAdditional()


    protected function _getName($short_name=FALSE)
    {
        $asset = $this->getAssetToUpdate();
        if (is_null($asset)) {
            return 'Asset-less '.$GLOBALS['SQ_SYSTEM']->am->getTypeInfo($this->type(), 'name');
        } else if ($short_name) {
            return 'Send Submission Log Job for "'.$asset->short_name.'" [#'.$asset->id.']';
        } else {
            return 'Send Submission Log Job for "'.$asset->name.'" [#'.$asset->id.']';
        }

    }//end _getName()
    

    public function displayName()
    {
        return $this->attr('display_name');

    }//end displayName()
    


    public function _getAllowedLinks()
    {
        return Array(SQ_LINK_NOTICE => Array('form_email' => Array('card' => 1)));

    }//end _getAllowedLinks()


    public function canDelete()
    {
        if (parent::canDelete()) return TRUE;

        // read-only?
        if ($this->attr('read_only')) return FALSE;

        $asset = $this->getAssetToUpdate();
        if (!is_null($asset)) return $asset->adminAccess('');
        return FALSE;

    }//end canDelete()


    public function setAssetToUpdate(Form_Email $form_email)
    {
        if ($this->id) {
            $existing_links = $GLOBALS['SQ_SYSTEM']->am->getLinks($this->id, SQ_LINK_NOTICE, '', TRUE, 'major', $value='updating');
            $link_exists = FALSE;
            foreach ($existing_links as $old_link) {
                if ($old_link['minorid'] == $form_email->id) {
                    $link_exists = TRUE;
                } else {
                    $GLOBALS['SQ_SYSTEM']->am->deleteAssetLink($old_link['linkid']);
                }
            }
            if ($link_exists) {
                return TRUE;
            } else {
                return (bool)  $this->createLink($form_email, SQ_LINK_NOTICE, 'updating');
            }
        } else {
            if (!isset($this->_tmp['asset_in_link'])) {
                $this->_tmp['asset_in_link'] = Array();
            }
            $this->_tmp['asset_in_link'] = Array('minorid' => $form_email->id, 'minor_type_code' => $form_email->type());
            return TRUE;
        }

    }//end setAssetToUpdate()


    public function getAssetToUpdate()
    {
        // because we need to return by ref
        $null = NULL;

        if ($this->id) {
            $link = $GLOBALS['SQ_SYSTEM']->am->getLink($this->id, SQ_LINK_NOTICE, 'form_email', TRUE, 'updating');
        } else {
            $link = (isset($this->_tmp['asset_in_link'])) ? $this->_tmp['asset_in_link'] : Array();
        }
        if (empty($link)) return $null;

        return $GLOBALS['SQ_SYSTEM']->am->getAsset($link['minorid'], 'form_email');

    }//end getAssetToUpdate()


    protected function _exec(&$msg)
    {
        $form = $this->getAssetToUpdate();      
        
        if (!is_null($form) && $GLOBALS['SQ_SYSTEM']->am->getAssetInfo($form->id, 'form_email')) {          
            
            $log_file_info = $this->_getFormSubmissionLogFile($form);               
            
            if (is_array($log_file_info)) {
        
                $email_format = $this->getAttribute('email_format');
                $email_format_val = @unserialize($email_format->value);
                
                $text_email = array_get_index($email_format_val, 'text_format', '');
                $html_email = array_get_index($email_format_val, 'html_format', '');
                $email_subject = array_get_index($email_format_val, 'subject', '');
                $email_from = array_get_index($email_format_val, 'from', '');
                $email_reply_to = array_get_index($email_format_val, 'from', '');               
                
                $keywords = extract_keywords($text_email.$html_email.$email_subject.$email_from.$email_reply_to);
                $keyword_replacements = Array();
                foreach($keywords as $full_keyword) {
                    $modifiers = NULL;
                    $part_keyword = parse_keyword($full_keyword, $modifiers);
                    if ($part_keyword == 'submission_log_from_date') {
                        $keyword_value = date('Y-m-d H:i', $log_file_info['from']);
                    } else if ($part_keyword == 'submission_log_to_date') {
                        $keyword_value = date('Y-m-d H:i', $log_file_info['till']);
                    } else {
                        $keyword_value = $form->getKeywordReplacement($part_keyword);
                    }
                    if ($part_keyword != $full_keyword) {
                        apply_keyword_modifiers($keyword_value, $modifiers, Array('assetid' => $form->id));
                    }
                    $keyword_replacements[$full_keyword] = $keyword_value;
                }
                
                $email_format->sendMail($keyword_replacements, Array($log_file_info['file']));
                
                // Mark the run time
                $this->setAttrValue('previous_run', $log_file_info['till']);
                $this->saveAttributes();
                
                $msg = 'Submission log sent for form #'.$form->id.' (job #'.$this->id.')';
                
                return SQ_CRON_JOB_COMPLETED;
            }
        } else {
            // asset not found
            trigger_localised_error('CMS0120', E_USER_WARNING);
        }
        
        return SQ_CRON_JOB_ERROR;

    }//end _exec()


    public static function &getActiveJobs(Form_Email $form_email)
    {
        $links = $GLOBALS['SQ_SYSTEM']->am->getLinks($form_email->id, SQ_LINK_NOTICE, strtolower(__CLASS__), TRUE, 'minor', 'updating');
        $assetids = Array();
        $cm = $GLOBALS['SQ_SYSTEM']->am->getSystemAsset('cron_manager');
        foreach ($links as $link) {
            $cm_links = $GLOBALS['SQ_SYSTEM']->am->getLinkByAsset($cm->id, $link['majorid']);
            if (!empty($cm_links)) {
                // This asset is still linked to the cron manager, so its still active.
                $assetids[] = $link['majorid'];
            }
        }
        $dates = $GLOBALS['SQ_SYSTEM']->am->getAttributeValuesByName('when', 'cron_job_send_submission_log', $assetids);
        asort($dates, SORT_STRING);
        $res = Array();
        foreach ($dates as $assetid => $date) {
            $res[] = $GLOBALS['SQ_SYSTEM']->am->getAsset($assetid, strtolower(__CLASS__));
        }
        return $res;

    }//end getActiveJobs()

    
    function run()
    {
        $res = parent::run();
        if ($res & SQ_CRON_JOB_REMOVE) {
            $res = $res - SQ_CRON_JOB_REMOVE;
        }
        return $res;

    }//end run()

    
    function _getFormSubmissionLogFile($form)
    {   
        $edit_fns = $form->getEditFns();
        
        // Pick the submissions starting from this date
        $start_date = str_replace('--:', '00:', str_replace(':--', ':00', $this->attr('submissions_from_date')));       
        // If any date component is not setup
        $pick_from_date = strpos($start_date, '--') !== FALSE ? '' : strtotime($start_date);
        
        // Last time the job actually ran
        $previous_run = $this->attr('previous_run');
        
        if ($this->attr('submissions_range') == 'last_run') {           
            if (!empty($previous_run)) {
                // If the job ran previosuly, pick it from there
                $from_ts = $previous_run;
            } else if ($pick_from_date) {
                // The job is running for first time, pick since the "Start" date
                $from_ts = $pick_from_date;
            } else {
                // No "Start" date configured, pick submissions since the creation of the form
                $from_ts = $form->created;
            }
        } else {
            $from_ts = !empty($pick_from_date) ? $pick_from_date : $form->created;
        }
        
        if (!$from_ts) {
            trigger_localised_error('CMS0121', E_USER_WARNING);
            return FALSE;
        }       
        
        $till_ts = time();
        
        switch($this->attr('logs_format')) {
            case 'csv_nhr':
            case 'csv': 
                $csv = $edit_fns->createCSVSubmissionLogs($form, $from_ts, $till_ts);               
                $delimiter = $this->attr('csv_delimiter');
                $csv->setDeliminator(!empty($delimiter) ? $delimiter : ',');
                
                if ($this->attr('logs_format') == 'csv_nhr') {
                    $empty_header = FALSE;
                    $csv->setFieldHeaders($empty_header);
                }               
                ob_start();                     
                    @$csv->export(TRUE);
                    $output = ob_get_contents();
                ob_end_clean();
            break;
            
            case 'xml':
                $o = NULL;
                ob_start();     
                    @$this->_processExportXML($form, $from_ts, $till_ts);
                    $output = ob_get_contents();
                ob_end_clean();
            break;          
        
        }//end switch
        
        $job_name = trim(preg_replace('|[^a-z0-9\-_]+|', '_', strtolower($this->displayName())), '_');      
        $file_name = SQ_TEMP_PATH.'/submissions_log_'.$job_name.'('.date('Y-m-d H:i', $from_ts).' to '.date('Y-m-d H:i', $till_ts).')';
        file_put_contents($file_name, $output);

        return Array(
                'file' => $file_name,
                'from' => $from_ts,
                'till' => $till_ts,
            );
        
    }//end getFormSubmissionLogFile()
    
    
    function _processExportXML($asset, $from_ts, $to_ts)
    {
        $edit_fns = $asset->getEditFns();
        
        $from_time = ts_iso8601($from_ts);
        $to_time = ts_iso8601($to_ts);
        $sub_folder = $asset->getSubmissionsFolder();
        $assetids = Array($asset->id, $sub_folder->id);

        try {
            $bind_vars = Array(
                            'assetids'  => $assetids,
                            'from_time' => $from_time,
                            'to_time'   => $to_time,
                            'name'      => 'submitted',
                            'context'   => $GLOBALS['SQ_SYSTEM']->getContextId(),
                         );
            $result = $edit_fns->_getSubmissionLog($bind_vars);
        } catch (Exception $e) {
            throw new Exception("Unable to get submission log due to database error: ".$e->getMessage());           
        }

        echo "<submissions>\n";
        foreach ($result as $asset_info) {
            $assetid = $asset_info['assetid'];
            $type_code = $asset_info['type_code'];

            $sub_asset = $GLOBALS['SQ_SYSTEM']->am->getAsset($assetid, $type_code);
            if (!$sub_asset->attr('complete')) continue;

            if (trim($sub_asset->attr('xml')) == '') continue;
            echo "\t".$sub_asset->attr('xml')."\n";
        }
        echo '</submissions>';      

    }//end processExportXML()
    
    

}//end class

?>