PrivacyManagerTest.php

<?php
/**
 * Piwik - Open source web analytics
 *
 * @link http://piwik.org
 * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
 * @version $Id$
 */
require_once 'PrivacyManager/PrivacyManager.php';

class PrivacyManagerTest extends DatabaseTestCase
{
    // constants used in checking whether numeric tables are populated correctly.
    // 'done' entries exist for every period, even if there's no metric data, so we need the 
    // total archive count for each month.
    const TOTAL_JAN_ARCHIVE_COUNT = 37; // 31 + 4 + 1 + 1;
    const TOTAL_FEB_ARCHIVE_COUNT = 34; // 29 + 4 + 1;

    // the number of archive entries for a single metric if no purging is done. this #
    // is dependent on the number of periods for which there were visits.
    const JAN_METRIC_ARCHIVE_COUNT = 11; // 5 days + 4 weeks + 1 month + 1 year
    const FEB_METRIC_ARCHIVE_COUNT = 11; // 6 days + 4 weeks + 1 month

    // fake metric/report name used to make sure unwanted metrics are purged
    const GARBAGE_FIELD = 'abcdefg';

    private $idSite = null;
    private $dateTime = null;
    /**
     * @var Piwik_PrivacyManager
     */
    private $instance = null;
    private $daysAgoStart = 50;
    private $settings = null;

    private $unusedIdAction = null;

    public function setUp()
    {
        parent::setUp();

        $this->dateTime = Piwik_Date::factory('2012-02-28');

        Piwik_PluginsManager::getInstance()->loadPlugins( array('API', 'PrivacyManager', 'VisitsSummary', 'VisitorInterest', 'UserSettings', 'Goals') );
        Piwik_PluginsManager::getInstance()->installLoadedPlugins();

        Piwik::createAccessObject();
        Piwik_PostEvent('FrontController.initAuthenticationObject');

        // We need to be SU to create websites for tests
        Piwik::setUserIsSuperUser();

        Piwik_TablePartitioning::$tablesAlreadyInstalled = null;

        Piwik_PrivacyManager_LogDataPurger::$selectSegmentSize = 2;
        Piwik_PrivacyManager_ReportsPurger::$selectSegmentSize = 2;
        Piwik::$lockPrivilegeGranted = null;

        // purging depends upon today's date, so 'older_than' parts must be dependent upon today
        $today = Piwik_Date::factory('today');
        $daysSinceToday = ($today->getTimestamp() - $this->dateTime->getTimestamp()) / (24 * 60 * 60);
        
        $monthsSinceToday = 0;
        for ($date = $today; $date->toString('Y-m') != $this->dateTime->toString('Y-m'); $date = $date->subMonth(1))
        {
            ++$monthsSinceToday;
        }
        
        // set default config
        $settings = array();
        $settings['delete_logs_enable'] = 1;
        // purging log data from before 2012-01-24
        $settings['delete_logs_older_than'] = 35 + $daysSinceToday;
        $settings['delete_logs_schedule_lowest_interval'] = 7;
        $settings['delete_logs_max_rows_per_query'] = 100000;
        $settings['delete_reports_enable'] = 1;
        $settings['delete_reports_older_than'] = $monthsSinceToday;
        $settings['delete_reports_keep_basic_metrics'] = 0;
        $settings['delete_reports_keep_day_reports'] = 0;
        $settings['delete_reports_keep_week_reports'] = 0;
        $settings['delete_reports_keep_month_reports'] = 0;
        $settings['delete_reports_keep_year_reports'] = 0;
        $settings['delete_reports_keep_range_reports'] = 0;
        $settings['delete_reports_keep_segment_reports'] = 0;
        Piwik_PrivacyManager::savePurgeDataSettings($settings);
        
        $this->settings = $settings;
        $this->instance = new Piwik_PrivacyManager();
    }
    
    /**
     * Make sure the first time deleteLogData is run, nothing happens.
     *
     * @group Plugins
     * @group PrivacyManager
     */
    public function testDeleteLogDataInitialRun()
    {
        $this->_addLogData();
        $this->_addReportData();
        
        $this->instance->deleteLogData();
        
        // check that initial option is set
        $this->assertEquals(
            1, Piwik_GetOption(Piwik_PrivacyManager::OPTION_LAST_DELETE_PIWIK_LOGS_INITIAL));
        
        // perform other checks
        $this->_checkNoDataChanges();
    }
    
    /**
     * Make sure the first time deleteReportData is run, nothing happens.
     *
     * @group Plugins
     * @group PrivacyManager
     */
    public function testDeleteReportDataInitialRun()
    {
        $this->_addLogData();
        $this->_addReportData();
        
        $this->instance->deleteReportData();
        
        // check that initial option is set
        $this->assertEquals(1, Piwik_GetOption(Piwik_PrivacyManager::OPTION_LAST_DELETE_PIWIK_LOGS_INITIAL));
        
        // perform other checks
        $this->_checkNoDataChanges();
    }
    
    /**
     * Make sure the task is not run when its scheduled for later.
     *
     * @group Plugins
     * @group PrivacyManager
     */
    public function testPurgeDataNotTimeToRun()
    {
        $this->_addLogData();
        $this->_addReportData();
        
        $yesterdaySecs = Piwik_Date::factory('yesterday')->getTimestamp();
        
        Piwik_SetOption(Piwik_PrivacyManager::OPTION_LAST_DELETE_PIWIK_LOGS_INITIAL, 1);
        Piwik_SetOption(Piwik_PrivacyManager::OPTION_LAST_DELETE_PIWIK_LOGS, $yesterdaySecs);
        Piwik_SetOption(Piwik_PrivacyManager::OPTION_LAST_DELETE_PIWIK_REPORTS, $yesterdaySecs);
        $this->instance->deleteLogData();
        $this->instance->deleteReportData();
        
        // perform checks
        $this->_checkNoDataChanges();
    }
    
    /**
     * Make sure purging data runs when scheduled.
     *
     * @group Plugins
     * @group PrivacyManager
     */
    public function testPurgeDataNotInitialAndTimeToRun()
    {
        $this->_addLogData();
        $this->_addReportData();
        
        // get purge data prediction
        $prediction = Piwik_PrivacyManager::getPurgeEstimate();
        
        // perform checks on prediction
        $expectedPrediction = array(
            Piwik_Common::prefixTable('log_conversion') => 6,
            Piwik_Common::prefixTable('log_link_visit_action') => 6,
            Piwik_Common::prefixTable('log_visit') => 3,
            Piwik_Common::prefixTable('log_conversion_item') => 3,
            Piwik_Common::prefixTable('archive_numeric_2012_01') => -1,
            Piwik_Common::prefixTable('archive_blob_2012_01') => -1
        );
        $this->assertEquals($expectedPrediction, $prediction);
        
        // purge data
        $this->_setTimeToRun();
        $this->instance->deleteLogData();
        $this->instance->deleteReportData();
        
        // perform checks
        $this->checkLogDataPurged();
        
        $archiveTables = $this->_getArchiveTableNames();
        
        // January numeric table should be dropped
        $this->assertFalse($this->_tableExists($archiveTables['numeric'][0])); // January
        
        // Check february metric count (5 metrics per period w/ visits + 1 'done' archive for every period)
        // + 1 garbage metric
        $febRowCount = self::FEB_METRIC_ARCHIVE_COUNT * 5 + self::TOTAL_FEB_ARCHIVE_COUNT + 1;
        $this->assertEquals($febRowCount, $this->_getTableCount($archiveTables['numeric'][1])); // February
        
        // January blob table should be dropped
        $this->assertFalse($this->_tableExists($archiveTables['blob'][0])); // January
        
        // Check february blob count (1 blob per period w/ visits + 1 garbage report)
        $this->assertEquals(self::FEB_METRIC_ARCHIVE_COUNT + 1, $this->_getTableCount($archiveTables['blob'][1])); // February
    }
    
    /**
     * Make sure nothing happens when deleting logs & reports are both disabled.
     *
     * @group Plugins
     * @group PrivacyManager
     */
    public function testPurgeDataBothDisabled()
    {
        Piwik_PrivacyManager::savePurgeDataSettings(array(
            'delete_logs_enable' => 0,
            'delete_reports_enable' => 0
        ));

        $this->_addLogData();
        $this->_addReportData();
        
        // get purge data prediction
        $prediction = Piwik_PrivacyManager::getPurgeEstimate();
        
        // perform checks on prediction
        $expectedPrediction = array();
        $this->assertEquals($expectedPrediction, $prediction);
        
        // purge data
        $this->_setTimeToRun();
        $this->instance->deleteLogData();
        $this->instance->deleteReportData();
        
        // perform checks
        $this->_checkNoDataChanges();
    }
    
    /**
     * Test that purgeData works when there's no data.
     *
     * @group Plugins
     * @group PrivacyManager
     */
    public function testPurgeDataDeleteLogsNoData()
    {
        // get purge data prediction
        $prediction = Piwik_PrivacyManager::getPurgeEstimate();
        
        // perform checks on prediction
        $expectedPrediction = array();
        $this->assertEquals($expectedPrediction, $prediction);
        
        // purge data
        $this->_setTimeToRun();
        $this->instance->deleteLogData();
        $this->instance->deleteReportData();
        
        // perform checks
        $this->assertEquals(0, $this->_getTableCount('log_visit'));
        $this->assertEquals(0, $this->_getTableCount('log_conversion'));
        $this->assertEquals(0, $this->_getTableCount('log_link_visit_action'));
        $this->assertEquals(0, $this->_getTableCount('log_conversion_item'));
        
        $archiveTables = $this->_getArchiveTableNames();
        $this->assertFalse($this->_tableExists($archiveTables['numeric'][0])); // January
        $this->assertFalse($this->_tableExists($archiveTables['numeric'][1])); // February
        $this->assertFalse($this->_tableExists($archiveTables['blob'][0])); // January
        $this->assertFalse($this->_tableExists($archiveTables['blob'][1])); // February
    }
    
    /**
     * Test that purgeData works correctly when the 'keep basic metrics' setting is set to true.
     *
     * @group Plugins
     * @group PrivacyManager
     */
    public function testPurgeDataDeleteReportsKeepBasicMetrics()
    {
        Piwik_PrivacyManager::savePurgeDataSettings(array(
            'delete_reports_keep_basic_metrics' => 1
        ));
        
        $this->_addLogData();
        $this->_addReportData();

        // get purge data prediction
        $prediction = Piwik_PrivacyManager::getPurgeEstimate();
        
        // perform checks on prediction
        $expectedPrediction = array(
            Piwik_Common::prefixTable('log_conversion') => 6,
            Piwik_Common::prefixTable('log_link_visit_action') => 6,
            Piwik_Common::prefixTable('log_visit') => 3,
            Piwik_Common::prefixTable('log_conversion_item') => 3,
            Piwik_Common::prefixTable('archive_numeric_2012_01') => 1, // remove the garbage metric
            Piwik_Common::prefixTable('archive_blob_2012_01') => -1
        );
        $this->assertEquals($expectedPrediction, $prediction);
        
        // purge data
        $this->_setTimeToRun();
        $this->instance->deleteLogData();
        $this->instance->deleteReportData();
        
        // perform checks
        $this->checkLogDataPurged();
        
        $archiveTables = $this->_getArchiveTableNames();
        
        // all numeric metrics should be saved except the garbage metric
        $janRowCount = $this->_getExpectedNumericArchiveCountJan() - 1;
        $this->assertEquals($janRowCount, $this->_getTableCount($archiveTables['numeric'][0])); // January
        
        // check february numerics not deleted
        $febRowCount = $this->_getExpectedNumericArchiveCountFeb();
        $this->assertEquals($febRowCount, $this->_getTableCount($archiveTables['numeric'][1])); // February
        
        // check that the january blob table was dropped
        $this->assertFalse($this->_tableExists($archiveTables['blob'][0])); // January
        
        // check for no changes in the february blob table
        $this->assertEquals(self::FEB_METRIC_ARCHIVE_COUNT + 1, $this->_getTableCount($archiveTables['blob'][1])); // February
    }
    
    /**
     * Test that purgeData works correctly when the 'keep daily reports' setting is set to true.
     *
     * @group Plugins
     * @group PrivacyManager
     */
    public function testPurgeDataDeleteReportsKeepDailyReports()
    {
        Piwik_PrivacyManager::savePurgeDataSettings(array(
            'delete_reports_keep_day_reports' => 1
        ));

        $this->_addLogData();
        $this->_addReportData();

        // get purge data prediction
        $prediction = Piwik_PrivacyManager::getPurgeEstimate();
        
        // perform checks on prediction
        $expectedPrediction = array(
            Piwik_Common::prefixTable('log_conversion') => 6,
            Piwik_Common::prefixTable('log_link_visit_action') => 6,
            Piwik_Common::prefixTable('log_visit') => 3,
            Piwik_Common::prefixTable('log_conversion_item') => 3,
            Piwik_Common::prefixTable('archive_numeric_2012_01') => -1,
            Piwik_Common::prefixTable('archive_blob_2012_01') => 10 // removing 4 weeks, 1 month & 1 year + 1 garbage report + 2 range reports + 1 segmented report
        );
        $this->assertEquals($expectedPrediction, $prediction);
        
        // purge data
        $this->_setTimeToRun();
        $this->instance->deleteLogData();
        $this->instance->deleteReportData();
        
        // perform checks
        $this->checkLogDataPurged();
        $this->_checkReportsAndMetricsPurged($janBlobsRemaining = 5); // 5 blobs for 5 days
    }
    
    /**
     * Test that purgeData works correctly when the 'keep weekly reports' setting is set to true.
     *
     * @group Plugins
     * @group PrivacyManager
     */
    public function testPurgeDataDeleteReportsKeepWeeklyReports()
    {
        Piwik_PrivacyManager::savePurgeDataSettings(array(
            'delete_reports_keep_week_reports' => 1
        ));

        $this->_addLogData();
        $this->_addReportData();

        // get purge data prediction
        $prediction = Piwik_PrivacyManager::getPurgeEstimate();
        
        // perform checks on prediction
        $expectedPrediction = array(
            Piwik_Common::prefixTable('log_conversion') => 6,
            Piwik_Common::prefixTable('log_link_visit_action') => 6,
            Piwik_Common::prefixTable('log_visit') => 3,
            Piwik_Common::prefixTable('log_conversion_item') => 3,
            Piwik_Common::prefixTable('archive_numeric_2012_01') => -1,
            Piwik_Common::prefixTable('archive_blob_2012_01') => 11 // 5 days, 1 month & 1 year to remove + 1 garbage report + 2 range reports + 1 segmented report
        );
        $this->assertEquals($expectedPrediction, $prediction);
        
        // purge data
        $this->_setTimeToRun();
        $this->instance->deleteLogData();
        $this->instance->deleteReportData();
        
        // perform checks
        $this->checkLogDataPurged();
        $this->_checkReportsAndMetricsPurged($janBlobsRemaining = 4); // 4 blobs for 4 weeks
    }
    
    /**
     * Test that purgeData works correctly when the 'keep monthly reports' setting is set to true.
     *
     * @group Plugins
     * @group PrivacyManager
     */
    public function testPurgeDataDeleteReportsKeepMonthlyReports()
    {
        Piwik_PrivacyManager::savePurgeDataSettings(array(
            'delete_reports_keep_month_reports' => 1
        ));

        $this->_addLogData();
        $this->_addReportData();
        
        // get purge data prediction
        $prediction = Piwik_PrivacyManager::getPurgeEstimate();
        
        // perform checks on prediction
        $expectedPrediction = array(
            Piwik_Common::prefixTable('log_conversion') => 6,
            Piwik_Common::prefixTable('log_link_visit_action') => 6,
            Piwik_Common::prefixTable('log_visit') => 3,
            Piwik_Common::prefixTable('log_conversion_item') => 3,
            Piwik_Common::prefixTable('archive_numeric_2012_01') => -1,
            Piwik_Common::prefixTable('archive_blob_2012_01') => 14 // 5 days, 4 weeks, 1 year to remove + 1 garbage report + 2 range reports + 1 segmented report
        );
        $this->assertEquals($expectedPrediction, $prediction);
        
        // purge data
        $this->_setTimeToRun();
        $this->instance->deleteLogData();
        $this->instance->deleteReportData();
        
        // perform checks
        $this->checkLogDataPurged();
        $this->_checkReportsAndMetricsPurged($janBlobsRemaining = 1); // 1 blob for 1 month
    }
    
    /**
     * Test that purgeData works correctly when the 'keep yearly reports' setting is set to true.
     *
     * @group Plugins
     * @group PrivacyManager
     */
    public function testPurgeDataDeleteReportsKeepYearlyReports()
    {
        Piwik_PrivacyManager::savePurgeDataSettings(array(
            'delete_reports_keep_year_reports' => 1
        ));

        $this->_addLogData();
        $this->_addReportData();
        
        // get purge data prediction
        $prediction = Piwik_PrivacyManager::getPurgeEstimate();
        
        // perform checks on prediction
        $expectedPrediction = array(
            Piwik_Common::prefixTable('log_conversion') => 6,
            Piwik_Common::prefixTable('log_link_visit_action') => 6,
            Piwik_Common::prefixTable('log_visit') => 3,
            Piwik_Common::prefixTable('log_conversion_item') => 3,
            Piwik_Common::prefixTable('archive_numeric_2012_01') => -1,
            Piwik_Common::prefixTable('archive_blob_2012_01') => 14 // 5 days, 4 weeks & 1 year to remove + 1 garbage report + 2 range reports + 1 segmented report
        );
        $this->assertEquals($expectedPrediction, $prediction);
        
        // purge data
        $this->_setTimeToRun();
        $this->instance->deleteLogData();
        $this->instance->deleteReportData();
        
        // perform checks
        $this->checkLogDataPurged();
        $this->_checkReportsAndMetricsPurged($janBlobsRemaining = 1); // 1 blob for 1 year
    }
    
    /**
     * Test no concurrency issues when deleting log data from log_action table.
     *
     * @group Plugins
     * @group PrivacyManager
     */
    public function testPurgeLogDataConcurrency()
    {
        Piwik_AddAction("LogDataPurger.actionsToKeepInserted.olderThan", array($this, 'addReferenceToUnusedAction'));
        
        $this->_addLogData();
        
        $purger = Piwik_PrivacyManager_LogDataPurger::make($this->settings, true);
        
        $this->unusedIdAction = Piwik_FetchOne(
            "SELECT idaction FROM ".Piwik_Common::prefixTable('log_action')." WHERE name = ?",
            array('whatever.com/_40'));
        $this->assertTrue($this->unusedIdAction > 0);
        
        // purge data
        $purger->purgeData();
        
        // check that actions were purged
        $this->assertEquals(22, $this->_getTableCount('log_action')); // January
        
        // check that the unused action still exists
        $count = Piwik_FetchOne(
            "SELECT COUNT(*) FROM ".Piwik_Common::prefixTable('log_action')." WHERE idaction = ?",
            array($this->unusedIdAction));
        $this->assertEquals(1, $count);
        
        $this->unusedIdAction = null; // so the hook won't get executed twice
    }

    /**
     * Tests that purgeData works correctly when the 'keep range reports' setting is set to true.
     *
     * @group Plugins
     * @group PrivacyManager
     */
    public function testPurgeDataDeleteReportsKeepRangeReports()
    {
        Piwik_PrivacyManager::savePurgeDataSettings(array(
            'delete_reports_keep_range_reports' => 1
        ));
        
        $this->_addLogData();
        $this->_addReportData();
        
        // get purge data prediction
        $prediction = Piwik_PrivacyManager::getPurgeEstimate();
        
        // perform checks on prediction
        $expectedPrediction = array(
            Piwik_Common::prefixTable('log_conversion') => 6,
            Piwik_Common::prefixTable('log_link_visit_action') => 6,
            Piwik_Common::prefixTable('log_visit') => 3,
            Piwik_Common::prefixTable('log_conversion_item') => 3,
            Piwik_Common::prefixTable('archive_numeric_2012_01') => -1,
            Piwik_Common::prefixTable('archive_blob_2012_01') => 13 // 5 days, 4 weeks, 1 month & 1 year + 1 garbage report + 1 segmented report
        );
        $this->assertEquals($expectedPrediction, $prediction);
        
        // purge data
        $this->_setTimeToRun();
        $this->instance->deleteLogData();
        $this->instance->deleteReportData();
        
        // perform checks
        $this->checkLogDataPurged();
        $this->_checkReportsAndMetricsPurged($janBlobsRemaining = 2); // 2 range blobs
    }
    
    /**
     * Tests that purgeData works correctly when the 'keep segment reports' setting is set to true.
     *
     * @group Plugins
     * @group PrivacyManager
     */
    public function testPurgeDataDeleteReportsKeepSegmentsReports()
    {
        Piwik_PrivacyManager::savePurgeDataSettings(array(
            'delete_reports_keep_day_reports' => 1,
            'delete_reports_keep_segment_reports' => 1
        ));
        
        $this->_addLogData();
        $this->_addReportData();
        
        // get purge data prediction
        $prediction = Piwik_PrivacyManager::getPurgeEstimate();
        
        // perform checks on prediction
        $expectedPrediction = array(
            Piwik_Common::prefixTable('log_conversion') => 6,
            Piwik_Common::prefixTable('log_link_visit_action') => 6,
            Piwik_Common::prefixTable('log_visit') => 3,
            Piwik_Common::prefixTable('log_conversion_item') => 3,
            Piwik_Common::prefixTable('archive_numeric_2012_01') => -1,
            Piwik_Common::prefixTable('archive_blob_2012_01') => 9 // 4 weeks, 1 month & 1 year + 1 garbage report + 2 range reports
        );
        $this->assertEquals($expectedPrediction, $prediction);
        
        // purge data
        $this->_setTimeToRun();
        $this->instance->deleteLogData();
        $this->instance->deleteReportData();
        
        // perform checks
        $this->checkLogDataPurged();
        $this->_checkReportsAndMetricsPurged($janBlobsRemaining = 6); // 1 segmented blob + 5 day blobs
    }
    
    // --- utility functions follow ---
    
    protected function _addLogData()
    {
        // tracks visits on the following days:
        // - 2012-01-09
        // - 2012-01-14
        // - 2012-01-19
        // - 2012-01-24 <--- everything before this date is to be purged
        // - 2012-01-29
        // - 2012-02-03
        // - 2012-02-08
        // - 2012-02-13
        // - 2012-02-18
        // - 2012-02-23
        // - 2012-02-28
        // 6 visits in feb, 5 in jan
        
        // following actions are created:
        // - 'First page view'
        // - 'Second page view'
        // - 'SKU2'
        // - 'Canon SLR'
        // - 'Electronics & Cameras'
        // - for every visit (11 visits total):
        //   - http://whatever.com/_{$daysSinceLastVisit}
        //   - http://whatever.com/42/{$daysSinceLastVisit}
        
        $start = $this->dateTime;
        $this->idSite = IntegrationTestCase::createWebsite('2012-01-01', $ecommerce=1);
        $idGoal = Piwik_Goals_API::getInstance()->addGoal($this->idSite, 'match all', 'url', 'http', 'contains');
        
        $t = IntegrationTestCase::getTracker($this->idSite, $start, $defaultInit = true);
        $t->enableBulkTracking();
        $t->setTokenAuth(IntegrationTestCase::getTokenAuth());
        for ($daysAgo = $this->daysAgoStart; $daysAgo >= 0; $daysAgo -= 5) // one visit every 5 days
        {
            $dateTime = $start->subDay($daysAgo)->toString();
            
            $t->setForceVisitDateTime($dateTime);
            $t->setUserAgent('Mozilla/5.0 (Windows; U; Windows NT 5.1; en-GB; rv:1.9.2.6) Gecko/20100625 Firefox/3.6.6 (.NET CLR 3.5.30729)');
            
            // use $daysAgo to make sure new actions are created for every day and aren't used again.
            // when deleting visits, some of these actions will no longer be referenced in the DB.
            $t->setUrl("http://whatever.com/_$daysAgo");
            $t->doTrackPageView('First page view');
            
            $t->setUrl("http://whatever.com/42/$daysAgo");
            $t->doTrackPageView('Second page view');
            
            $t->addEcommerceItem($sku = 'SKU2', $name = 'Canon SLR' , $category = 'Electronics & Cameras',
                                 $price = 1500, $quantity = 1);
            $t->doTrackEcommerceOrder($orderId = '937nsjusu '.$dateTime, $grandTotal = 1111.11, $subTotal = 1000,
                                      $tax = 111, $shipping = 0.11, $discount = 666);
        }
        $t->doBulkTrack();
    }
    
    protected function _addReportData()
    {
        $archive = Piwik_Archive::build($this->idSite, 'year', $this->dateTime);
        $archive->getNumeric('nb_visits', 'nb_hits');
        
        Piwik_VisitorInterest_API::getInstance()->getNumberOfVisitsPerVisitDuration(
            $this->idSite, 'year', $this->dateTime);
        
        // months are added via the 'year' period, but weeks must be done manually
        for ($daysAgo = $this->daysAgoStart; $daysAgo > 0; $daysAgo -= 7) // every week
        {
            $dateTime = $this->dateTime->subDay($daysAgo);
            
            $archive = Piwik_Archive::build($this->idSite, 'week', $dateTime);
            $archive->getNumeric('nb_visits');
            
            Piwik_VisitorInterest_API::getInstance()->getNumberOfVisitsPerVisitDuration(
                $this->idSite, 'week', $dateTime);
        }
        
        // add segment for one day
        $archive = Piwik_Archive::build($this->idSite, 'day', '2012-01-14', 'browserName==FF');
        $archive->getNumeric('nb_visits', 'nb_hits');
        
        Piwik_VisitorInterest_API::getInstance()->getNumberOfVisitsPerVisitDuration(
            $this->idSite, 'day', '2012-01-14', 'browserName==FF');
        
        // add range within January
        $rangeEnd = Piwik_Date::factory('2012-01-29');
        $rangeStart = $rangeEnd->subDay(1);
        $range = $rangeStart->toString('Y-m-d').",".$rangeEnd->toString('Y-m-d');
        
        $rangeArchive = Piwik_Archive::build($this->idSite, 'range', $range);
        $rangeArchive->getNumeric('nb_visits', 'nb_hits');
        
        Piwik_VisitorInterest_API::getInstance()->getNumberOfVisitsPerVisitDuration($this->idSite, 'range', $range);
        
        // add range between January & February
        $rangeStart = $rangeEnd;
        $rangeEnd = $rangeStart->addDay(3);
        $range = $rangeStart->toString('Y-m-d').",".$rangeEnd->toString('Y-m-d');
        
        $rangeArchive = Piwik_Archive::build($this->idSite, 'range', $range);
        $rangeArchive->getNumeric('nb_visits', 'nb_hits');
        
        Piwik_VisitorInterest_API::getInstance()->getNumberOfVisitsPerVisitDuration($this->idSite, 'range', $range);
        
        // when archiving is initiated, the archive metrics & reports for EVERY loaded plugin
        // are archived. don't want this test to depend on every possible metric, so get rid of
        // the unwanted archive data now.
        $metricsToSave = array(
            'nb_visits',
            'nb_actions',
            Piwik_Goals::getRecordName('revenue'),
            Piwik_Goals::getRecordName('nb_conversions', 1),
            Piwik_Goals::getRecordName('revenue', Piwik_Tracker_GoalManager::IDGOAL_ORDER)
        );
        
        $archiveTables = $this->_getArchiveTableNames();
        foreach ($archiveTables['numeric'] as $table)
        {
            $realTable = Piwik_Common::prefixTable($table);
            Piwik_Query("DELETE FROM $realTable WHERE name NOT IN ('".implode("','", $metricsToSave)."') AND name NOT LIKE 'done%'");
        }
        foreach ($archiveTables['blob'] as $table)
        {
            $realTable = Piwik_Common::prefixTable($table);
            Piwik_Query("DELETE FROM $realTable WHERE name NOT IN ('VisitorInterest_timeGap')");
        }
        
        // add garbage metrics
        $janDate1 = '2012-01-05';
        $febDate1 = '2012-02-04';
        
        $sql = "INSERT INTO %s (idarchive,name,idsite,date1,date2,period,ts_archived,value)
                        VALUES (10000,?,1,?,?,?,?,?)";
        
        // one metric for jan & one for feb
        Piwik_Query(sprintf($sql, Piwik_Common::prefixTable($archiveTables['numeric'][0])),
                    array(self::GARBAGE_FIELD, $janDate1, $janDate1, $janDate1, 1, 100));
        Piwik_Query(sprintf($sql, Piwik_Common::prefixTable($archiveTables['numeric'][1])),
                    array(self::GARBAGE_FIELD, $febDate1, $febDate1, $febDate1, 1, 200));
        
        // add garbage reports
        Piwik_Query(sprintf($sql, Piwik_Common::prefixTable($archiveTables['blob'][0])),
                    array(self::GARBAGE_FIELD, $janDate1, $janDate1, $janDate1, 10, 'blobval'));
        Piwik_Query(sprintf($sql, Piwik_Common::prefixTable($archiveTables['blob'][1])),
                    array(self::GARBAGE_FIELD, $febDate1, $febDate1, $febDate1, 20, 'blobval'));
    }
    
    protected function _checkNoDataChanges()
    {
        // 11 visits total w/ 2 actions per visit & 2 conversions per visit. 1 e-commerce order per visit.
        $this->assertEquals(11, $this->_getTableCount('log_visit'));
        $this->assertEquals(22, $this->_getTableCount('log_conversion'));
        $this->assertEquals(22, $this->_getTableCount('log_link_visit_action'));
        $this->assertEquals(11, $this->_getTableCount('log_conversion_item'));
        $this->assertEquals(27, $this->_getTableCount('log_action'));
        
        $archiveTables = $this->_getArchiveTableNames();
        
        $janMetricCount = $this->_getExpectedNumericArchiveCountJan();
        $this->assertEquals($janMetricCount, $this->_getTableCount($archiveTables['numeric'][0])); // January
        
        // no range metric for february
        $febMetricCount = $this->_getExpectedNumericArchiveCountFeb();
        $this->assertEquals($febMetricCount, $this->_getTableCount($archiveTables['numeric'][1])); // February
        
        // 1 entry per period w/ visits + 1 garbage report + 2 range reports + 1 segment report
        $this->assertEquals(self::JAN_METRIC_ARCHIVE_COUNT + 1 + 2 + 1, $this->_getTableCount($archiveTables['blob'][0])); // January
        $this->assertEquals(self::FEB_METRIC_ARCHIVE_COUNT + 1, $this->_getTableCount($archiveTables['blob'][1])); // February
    }
    
    /**
     * Helper method. Performs checks after reports are purged. Checks that the january numeric table
     * was dropped, that the february metric & blob tables are unaffected, and that the january blob
     * table has a certain number of blobs.
     */
    protected function _checkReportsAndMetricsPurged( $janBlobsRemaining )
    {
        $archiveTables = $this->_getArchiveTableNames();
        
        // check that the january numeric table was dropped
        $this->assertFalse($this->_tableExists($archiveTables['numeric'][0])); // January
        
        // check february numerics not deleted
        $febRowCount = $this->_getExpectedNumericArchiveCountFeb();
        $this->assertEquals($febRowCount, $this->_getTableCount($archiveTables['numeric'][1])); // February
        
        // check the january blob count
        $this->assertEquals($janBlobsRemaining, $this->_getTableCount($archiveTables['blob'][0])); // January
        
        // check for no changes in the february blob table (1 blob for every period w/ visits in feb + 1 garbage report)
        $this->assertEquals(self::FEB_METRIC_ARCHIVE_COUNT + 1, $this->_getTableCount($archiveTables['blob'][1])); // February
    }
    
    private function checkLogDataPurged()
    {
        // 3 days removed by purge, so 3 visits, 6 conversions, 6 visit actions, 3 e-commerce orders
        // & 6 actions removed
        $this->assertEquals(8, $this->_getTableCount('log_visit'));
        $this->assertEquals(16, $this->_getTableCount('log_conversion'));
        $this->assertEquals(16, $this->_getTableCount('log_link_visit_action'));
        $this->assertEquals(8, $this->_getTableCount('log_conversion_item'));
        $this->assertEquals(21, $this->_getTableCount('log_action'));
    }
    
    /**
     * Event hook that adds a row into the DB that references unused idaction AFTER LogDataPurger
     * does the insert into the temporary table. When log_actions are deleted, this idaction should still
     * be kept. w/ the wrong strategy, it won't be and there will be a dangling reference
     * in the log_link_visit_action table.
     *
     * @param Piwik_Event_Notification $notification  notification object
     */
    public function addReferenceToUnusedAction( $notification )
    {
        $unusedIdAction = $this->unusedIdAction;
        if (empty($unusedIdAction)) // make sure we only do this for one test case
        {
            return;
        }
        
        $tempTableName = Piwik_Common::prefixTable(Piwik_PrivacyManager_LogDataPurger::TEMP_TABLE_NAME);
        $logLinkVisitActionTable = Piwik_Common::prefixTable("log_link_visit_action");
        
        $sql = "INSERT INTO $logLinkVisitActionTable
                            (idsite, idvisitor, server_time, idvisit, idaction_url, idaction_url_ref,
                            idaction_name, idaction_name_ref, time_spent_ref_action)
                     VALUES (1, 'abc', NOW(), 15, $unusedIdAction, $unusedIdAction,
                             $unusedIdAction, $unusedIdAction, 1000)";
        
        Piwik_Query($sql);
    }
    
    protected function _setTimeToRun()
    {
        $lastDateSecs = Piwik_Date::factory('today')->subDay(8)->getTimestamp();
        
        Piwik_SetOption(Piwik_PrivacyManager::OPTION_LAST_DELETE_PIWIK_LOGS_INITIAL, 1);
        Piwik_SetOption(Piwik_PrivacyManager::OPTION_LAST_DELETE_PIWIK_LOGS, $lastDateSecs);
        Piwik_SetOption(Piwik_PrivacyManager::OPTION_LAST_DELETE_PIWIK_REPORTS, $lastDateSecs);
    }
    
    protected function _getTableCount( $tableName, $where = '' )
    {
        $sql = "SELECT COUNT(*) FROM ".Piwik_Common::prefixTable($tableName)." $where";
        return Piwik_FetchOne($sql);
    }
    
    protected function _tableExists( $tableName )
    {
        $dbName = Piwik_Config::getInstance()->database['dbname'];
        
        $sql = "SELECT COUNT(*) FROM information_schema.tables WHERE table_schema = ? AND table_name = ?";
        return Piwik_FetchOne($sql, array($dbName, Piwik_Common::prefixTable($tableName))) == 1;
    }
    
    protected function _getArchiveTableNames()
    {
        return array(
            'numeric' => array(
                'archive_numeric_2012_01',
                'archive_numeric_2012_02'
            ),
            'blob' => array(
                'archive_blob_2012_01',
                'archive_blob_2012_02'
            )
        );
    }
    
    protected function _getExpectedNumericArchiveCountJan()
    {
        // 5 entries per period w/ visits
        // + 1 entry for every period in the month (the 'done' rows)
        // + 1 garbage metric
        // + 2 entries per range period (4 total) + 2 'done...' entries per range period (4 total)
        // + 2 entries per segment (2 total) + 2 'done...' entries per segment (2 total)
        return self::JAN_METRIC_ARCHIVE_COUNT * 5 + self::TOTAL_JAN_ARCHIVE_COUNT + 1 + 8 + 4;
    }
    
    protected function _getExpectedNumericArchiveCountFeb()
    {
        // (5 metrics per period w/ visits
        // + 1 'done' archive for every period)
        // + 1 garbage metric
        return self::FEB_METRIC_ARCHIVE_COUNT * 5 + self::TOTAL_FEB_ARCHIVE_COUNT + 1;
    }
}