cron_job_manage_incomplete_submissions.inc

<?php
require_once SQ_CORE_PACKAGE_PATH.'/system/cron/cron_job/cron_job.inc';
require_once SQ_FUDGE_PATH.'/db_extras/db_extras.inc';
require_once SQ_FUDGE_PATH.'/general/file_system.inc';

class Cron_Job_Manage_Incomplete_Submissions extends Cron_Job
{


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

    }//end constructor


    function create(&$link)
    {
        require_once SQ_CORE_PACKAGE_PATH.'/system/system_asset_fns.inc';
        if (!system_asset_fns_create_pre_check($this)) {
            return FALSE;
        }
        $GLOBALS['SQ_SYSTEM']->changeDatabaseConnection('db2');
        $GLOBALS['SQ_SYSTEM']->doTransaction('BEGIN');

        if ($linkid = parent::create($link)) {
            if (!system_asset_fns_create_cleanup($this)) {
                $linkid = FALSE;
            }
        }

        if ($linkid) {
            $GLOBALS['SQ_SYSTEM']->doTransaction('COMMIT');
        } else {
            $GLOBALS['SQ_SYSTEM']->doTransaction('ROLLBACK');
        }

        $GLOBALS['SQ_SYSTEM']->restoreDatabaseConnection();
        return $linkid;

    }//end create()


    function _getName($short_name=FALSE)
    {
        return $GLOBALS['SQ_SYSTEM']->am->getTypeInfo($this->type(), 'name');

    }//end _getName()


    function canClone()
    {
        return FALSE;

    }//end canClone()


    function morph($new_type_code)
    {
        trigger_localised_error('CRON0024', E_USER_WARNING, $GLOBALS['SQ_SYSTEM']->am->getTypeInfo($this->type(), 'name'));
        return FALSE;

    }//end morph()


    function canDelete()
    {
        return FALSE;

    }//end canDelete()


    function _exec(&$msg)
    {
        $GLOBALS['SQ_SYSTEM']->changeDatabaseConnection('db2');

        $assetids = $GLOBALS['SQ_SYSTEM']->am->getTypeAssetids('form', FALSE);

        // Store our list of assets that we have previously warned about
        $filepath = $this->data_path.'/warning_assets.php';
        if (is_file($filepath)) {
            $warning_assetids = require_once($filepath);
            if (!is_array($warning_assetids)) {
                $warning_assetids = Array();
            }
        } else {
            $warning_assetids = Array();
        }

        foreach ($assetids as $assetid) {
            $asset = $GLOBALS['SQ_SYSTEM']->am->getAsset($assetid);

            // Need to get the form URL from its parent wrapper page, as the
            // Form Contents asset (which is the actual form) has no URL
            $parent_assetids = $GLOBALS['SQ_SYSTEM']->am->getDependantParents($assetid);
            // Value can't be passed directly to reset function
            $parent_assetid = reset($parent_assetids);

            $form_url = $GLOBALS['SQ_SYSTEM']->am->getAssetURL($parent_assetid);

            // Get the pending accounts group, if it exists
            $incomplete_subs_folder = $asset->getSubmissionsFolder('incomplete_submissions');

            if ($incomplete_subs_folder) {
                // Remove incomplete submissions that have expired
                $remove_period = $asset->attr('submission_expiry_time');

                if ($remove_period > 0) {
                    $date_sql = db_extras_todate(MatrixDAL::getDbType(), ':created', FALSE);

                    $sql = 'SELECT DISTINCT
                                a.assetid
                            FROM sq_ast a
                                JOIN sq_ast_lnk l
                                ON a.assetid = l.minorid
                            WHERE
                                l.majorid = :majorid AND
                                a.created < '.$date_sql;

                    $query = MatrixDAL::preparePdoQuery($sql);
                    MatrixDAL::bindValueToPdo($query, 'majorid', $incomplete_subs_folder->id);
                    MatrixDAL::bindValueToPdo($query, 'created', ts_iso8601(time() - $remove_period));
                    $submission_assetids = MatrixDAL::executePdoAssoc($query);

                    foreach($submission_assetids as $submission_record) {
                        $submission_assetid = $submission_record['assetid'];
                        $submission_asset =& $GLOBALS['SQ_SYSTEM']->am->getAsset($submission_assetid);

                        $GLOBALS['SQ_SYSTEM']->am->trashAsset($submission_assetid);
                        $submission_asset->delete(FALSE);

                        // Don't need the incomplete attachments anymore, cleanup....
                        $path = $asset->data_path.'/incomplete_attachments/s'.$submission_assetid;
                        if (is_dir($path)) {
                            delete_directory($path);    
                        }//end if

                        unset($submission_asset);
                    }
                }

                // From those that are left, see which ones have exceeded the
                // warning period.
                $warning_period = $asset->attr('submission_warning_time');

                if ($warning_period > 0) {
                    $email_format = $asset->getAttribute('warning_email_format');
                    $date_sql = db_extras_todate(MatrixDAL::getDbType(), ':created', FALSE);

                    $sql = 'SELECT DISTINCT
                                a.assetid
                            FROM sq_ast a
                                JOIN sq_ast_lnk l
                                ON a.assetid = l.minorid
                            WHERE
                                l.majorid = :majorid AND
                                a.created < '.$date_sql;

                    $query = MatrixDAL::preparePdoQuery($sql);
                    MatrixDAL::bindValueToPdo($query, 'majorid', $incomplete_subs_folder->id);
                    MatrixDAL::bindValueToPdo($query, 'created', ts_iso8601(time() - $warning_period));
                    $submission_assetids = MatrixDAL::executePdoAll($query);

                    foreach($submission_assetids as $submission_record) {
                        $submission_assetid = $submission_record['assetid'];
                        $submission_asset = $GLOBALS['SQ_SYSTEM']->am->getAsset($submission_assetid);
                        
                        if(empty($submission_asset)) continue;
                        
                        $created_userid = $submission_asset->created_userid;

                        if (!isset($warning_assetids[$submission_assetid])) {
                            // Get the Email Format's value afresh, and add the
                            // submission's user to the list
                            $previous_value = $current_value = unserialize($email_format->value);
                            $current_value['to_assetids'][] = $created_userid;

                            // Add keyword replacements
                            $keywords = $email_format->getKeywords();
                            $replacements = Array();

                            foreach ($keywords as $keyword) {
                                $replacement = NULL;

                                switch ($keyword) {
                                    case 'form_submission_url_id' :
                                        $replacement = $submission_assetid;
                                    break;

                                    case 'form_total_pages' :
                                        $replacement = $asset->getTotalPages();
                                    break;

                                    case 'return_to_form_url_current' :
                                        $replacement = $form_url.'?SQ_FORM_'.$asset->id.'_SUBMISSION='.$submission_assetid.'&SQ_FORM_'.$asset->id.'_PAGE='.$submission_asset->attr('current_page');
                                    break;

                                    case 'return_to_form_url_latest' :
                                        $replacement = $form_url.'?SQ_FORM_'.$asset->id.'_SUBMISSION='.$submission_assetid.'&SQ_FORM_'.$asset->id.'_PAGE='.$submission_asset->attr('latest_page');
                                    break;

                                    default:
                                        if (substr($keyword, 0, 11) === 'form_asset_') {
                                            // Get the 'asset_*' keyword from the form PARENT page
                                            $sub_keyword = substr($keyword, 11);
                                            $parent_asset = $GLOBALS['SQ_SYSTEM']->am->getAsset($parent_assetid);
                                            if(empty($parent_asset)) continue;
                                            $replacement = $parent_asset->getKeywordReplacement('asset_'.$sub_keyword);
                                        } else if (substr($keyword, 0, 11) === 'user_asset_') {
                                            // Get the 'asset_*' keyword from the created user
                                            $sub_keyword = substr($keyword, 11);
                                            $user = $GLOBALS['SQ_SYSTEM']->am->getAsset($created_userid);
                                            if(empty($user)) continue;
                                            $replacement = $user->getKeywordReplacement('asset_'.$sub_keyword);
                                        } else if (substr($keyword, 0, 17) === 'submission_asset_') {
                                            // Get the 'asset_*' keyword from the submission
                                            $sub_keyword = substr($keyword, 17);
                                            $replacement = $submission_asset->getKeywordReplacement('asset_'.$sub_keyword);
                                        }

                                }//end switch on keyword

                                if ($replacement !== NULL) {
                                    $replacements[$keyword] = $replacement;
                                }
                            }//end foreach keyword

                            $email_format->setValue(serialize($current_value));
                            $email_format->sendMail($replacements);
                            $email_format->setValue(serialize($previous_value));

                            $warning_assetids[$submission_assetid] = TRUE;
                        }

                        unset($submission_asset);
                    }
                }

                unset($asset);

            }//end if
        }//end foreach

        // Clear out those assets from warning list that no longer exist, or
        // are no longer incomplete
        if (!empty($warning_assetids)) {

            $asset_attrs = $GLOBALS['SQ_SYSTEM']->am->getAttributeValuesByName('complete', 'form_submission', array_keys($warning_assetids));

            foreach ($warning_assetids as $warning_assetid => $dummy) {
                if (!isset($asset_attrs[$warning_assetid])) {
                    // Submission does not exist anymore - perhaps completed
                    // but we are not logging submissions from its parent form
                    unset($warning_assetids[$warning_assetid]);

                } else if ($asset_attrs[$warning_assetid] === 1) {
                    // Submission exists but is complete
                    unset($warning_assetids[$warning_assetid]);

                }

            }//end foreach

        }

        // recache our warning list
        create_directory($this->data_path);
        string_to_file('<'.'?php return '.var_export($warning_assetids, TRUE).'?'.'>', $filepath);
        $GLOBALS['SQ_SYSTEM']->restoreDatabaseConnection();

        return SQ_CRON_JOB_COMPLETED;

    }//end _exec()


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

    }//end run()


}//end class

?>