cron_job_funnelback_log_rotation.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';

class Cron_Job_Funnelback_Log_Rotation 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)
    {
        $fm = $GLOBALS['SQ_SYSTEM']->am->getSystemAsset('funnelback_manager');

        $collections = $fm->getCollections();
        $rotated = Array();

        // Rotate the logs for each collection
        foreach ($collections as $collection_id => $collection) {
            $log_path = $fm->getCollectionDataPath($collection_id, 'log');

            $log_files = glob($log_path.'/*.log');
            if (!empty($log_files)) {
                foreach ($log_files as $log_file) {
                    $log_name = basename($log_file);

                    // Click logs are not rotated yet, remove this line if needed
                    if ($log_name == 'click.log') continue;

                    // Archive
                    $archive_name = $log_name.'.'.date('Ymd');
                    $archive_path = $log_path.'/'.$archive_name;
                    $alternative  = 1;
                    while (file_exists($archive_path)) {
                        $archive_path = $log_path.'/'.$archive_name.'.'.((string) $alternative);
                        $alternative++;
                    }//end while
                    require_once SQ_FUDGE_PATH.'/general/file_system.inc';
                    move_file($log_file, $archive_path);
                    touch($log_file);

                    // Keep a list for the report to work against
                    $rotated[$collection_id] = $archive_path;

                    // Clean up
                    $period = $fm->attr('keep_log_period');
                    if (!empty($period)) {
                        $expiry_date = strtotime('-'.((int) $period).' months');
                        $archive_logs = glob($log_path.'/'.$log_name.'.*');
                        foreach ($archive_logs as $archive_log) {
                            $found_archive_log_name = basename($archive_log);
                            preg_match('/log\.([0-9]+)/i', $found_archive_log_name, $match);
                            $log_date = array_get_index($match, 1, 0);
                            if (!empty($log_date)) {
                                $log_date_expiry = strtotime($log_date);
                                if ($log_date_expiry < $expiry_date) {
                                    // Log expired, removing....
                                    unlink($archive_log);
                                    
                                    // Also remember to remove from rotated (no point trying to generate a report if a log is missing)
                                    if (isset($rotated[$collection_id]) && $rotated[$collection_id] == $found_archive_log_name) {
                                        unset($rotated[$collection_id]);
                                    }//end if
                                }//end if
                            }//end if
                        }//end foreach
                    }//end if
                }//end foreach
            }//end if
        }//end foreach

        if (!empty($rotated)) {
            // Logs were rotated, now to generate some reports
            $log_reports  = $GLOBALS['SQ_SYSTEM']->am->getTypeAssetids('funnelback_search_log_report', FALSE, TRUE);
    
            // start up a hipo for each report
            $hh = $GLOBALS['SQ_SYSTEM']->getHipoHerder();
    
            foreach ($log_reports as $reportid => $info) {
                    $report = $GLOBALS['SQ_SYSTEM']->am->getAsset($reportid);
                    $vars   = Array(
                                'assetid'   => $reportid,
                                'report'        => $report,
                                'logs'      => $rotated,
                              );
                    $status = $hh->freestyleHIPO('hipo_job_generate_report', $vars);
            }//end foreach
        }//end if

        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

?>