<?php
/*=========================================================================
  Program:   CDash - Cross-Platform Dashboard System
  Module:    $Id$
  Language:  PHP
  Date:      $Date$
  Version:   $Revision$

  Copyright (c) Kitware, Inc. All rights reserved.
  See LICENSE or http://www.cdash.org/licensing/ for details.

  This software is distributed WITHOUT ANY WARRANTY; without even
  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  PURPOSE. See the above copyright notices for more information.
=========================================================================*/

require_once 'xml_handlers/abstract_handler.php';
require_once 'models/build.php';
require_once 'models/label.php';
require_once 'models/site.php';
require_once 'models/test.php';
require_once 'models/image.php';
require_once 'models/feed.php';

class TestingHandler extends AbstractHandler
{
    private $StartTimeStamp;
    private $EndTimeStamp;

    private $Test;
    private $BuildTest;
    private $TestMeasurement;
    private $Label;
    private $Append;

    // Keep a record of the number of tests passed, failed and notrun
    // This works only because we have one test file per submission
    private $NumberTestsFailed;
    private $NumberTestsNotRun;
    private $NumberTestsPassed;

    private $Feed;

    /** Constructor */
    public function __construct($projectID, $scheduleID)
    {
        parent::__construct($projectID, $scheduleID);
        $this->Build = new Build();
        $this->Site = new Site();
        $this->NumberTestsFailed = 0;
        $this->NumberTestsNotRun = 0;
        $this->NumberTestsPassed = 0;
        $this->StartTimeStamp = 0;
        $this->EndTimeStamp = 0;
        $this->Feed = new Feed();
    }

    /** Destructor */
    public function __destruct()
    {
    }

    /** Start Element */
    public function startElement($parser, $name, $attributes)
    {
        parent::startElement($parser, $name, $attributes);
        $parent = $this->getParent(); // should be before endElement

        if ($name == 'SITE') {
            $this->Site->Name = $attributes['NAME'];
            if (empty($this->Site->Name)) {
                $this->Site->Name = '(empty)';
            }
            $this->Site->Insert();

            $siteInformation = new SiteInformation();
            $buildInformation = new BuildInformation();

            // Fill in the attribute
            foreach ($attributes as $key => $value) {
                if ($key === 'CHANGEID') {
                    $this->Build->SetPullRequest($value);
                    continue;
                }
                $siteInformation->SetValue($key, $value);
                $buildInformation->SetValue($key, $value);
            }

            $this->Site->SetInformation($siteInformation);

            $this->Build->SiteId = $this->Site->Id;
            $this->Build->Name = $attributes['BUILDNAME'];
            if (empty($this->Build->Name)) {
                $this->Build->Name = '(empty)';
            }
            $this->Build->SetStamp($attributes['BUILDSTAMP']);
            $this->Build->Generator = $attributes['GENERATOR'];
            $this->Build->Information = $buildInformation;

            if (array_key_exists('APPEND', $attributes)) {
                $this->Append = $attributes['APPEND'];
            } else {
                $this->Append = false;
            }
        } elseif ($name == 'TEST' && count($attributes) > 0) {
            $this->Test = new Test();
            $this->Test->ProjectId = $this->projectid;
            $this->BuildTest = new BuildTest();
            $this->BuildTest->Status = $attributes['STATUS'];

            if ($attributes['STATUS'] == 'passed') {
                $this->NumberTestsPassed++;
            } elseif ($attributes['STATUS'] == 'failed') {
                $this->NumberTestsFailed++;
            } elseif ($attributes['STATUS'] == 'notrun') {
                $this->NumberTestsNotRun++;
            }
        } elseif ($name == 'NAMEDMEASUREMENT') {
            $this->TestMeasurement = new TestMeasurement();

            if ($attributes['TYPE'] == 'file') {
                $this->TestMeasurement->Name = $attributes['FILENAME'];
            } else {
                $this->TestMeasurement->Name = $attributes['NAME'];
            }
            $this->TestMeasurement->Type = $attributes['TYPE'];
        } elseif ($name == 'VALUE' && $parent == 'MEASUREMENT') {
            if (isset($attributes['COMPRESSION']) && $attributes['COMPRESSION'] == 'gzip') {
                $this->Test->CompressedOutput = true;
            }
        } elseif ($name == 'LABEL' && $parent == 'LABELS') {
            $this->Label = new Label();
        } elseif ($name == 'TESTLIST' && $parent == 'TESTING') {
            $start_time = gmdate(FMT_DATETIME, $this->StartTimeStamp);

            $this->Build->ProjectId = $this->projectid;
            $this->Build->StartTime = $start_time;
            // EndTimeStamp hasn't been parsed yet.
            $this->Build->EndTime = $start_time;
            $this->Build->SubmitTime = gmdate(FMT_DATETIME);
            $this->Build->SetSubProject($this->SubProjectName);

            $this->Build->GetIdFromName($this->SubProjectName);
            $this->Build->RemoveIfDone();

            // If the build doesn't exist we add it
            if ($this->Build->Id == 0) {
                $this->Build->Append = $this->Append;
                $this->Build->InsertErrors = false;
                add_build($this->Build, $this->scheduleid);
            } else {
                // Otherwise make sure that the build is up-to-date.
                $this->Build->UpdateBuild($this->Build->Id, -1, -1);

                // If the build already exists factor the number of tests
                // that have already been run into our running total.
                $this->NumberTestsFailed += $this->Build->GetNumberOfFailedTests();
                $this->NumberTestsNotRun += $this->Build->GetNumberOfNotRunTests();
                $this->NumberTestsPassed += $this->Build->GetNumberOfPassedTests();
            }

            $GLOBALS['PHP_ERROR_BUILD_ID'] = $this->Build->Id;
        }
    }

    /** End Element */
    public function endElement($parser, $name)
    {
        $parent = $this->getParent(); // should be before endElement
        parent::endElement($parser, $name);

        if ($name == 'TEST' && $parent == 'TESTING') {
            $this->Test->Insert();
            if ($this->Test->Id > 0) {
                $this->BuildTest->TestId = $this->Test->Id;
                $this->BuildTest->BuildId = $this->Build->Id;
                $this->BuildTest->Insert();

                $this->Test->InsertLabelAssociations($this->Build->Id);
            } else {
                add_log('Cannot insert test', 'Test XML parser', LOG_ERR,
                    $this->projectid, $this->Build->Id);
            }
        } elseif ($name == 'LABEL' && $parent == 'LABELS') {
            if (isset($this->Test)) {
                $this->Test->AddLabel($this->Label);
            }
        } elseif ($name == 'NAMEDMEASUREMENT') {
            if ($this->TestMeasurement->Name == 'Execution Time') {
                $this->BuildTest->Time = $this->TestMeasurement->Value;
            } elseif ($this->TestMeasurement->Name == 'Exit Code') {
                if (strlen($this->Test->Details) > 0) {
                    $this->Test->Details .= ' (' . $this->TestMeasurement->Value . ')';
                } else {
                    $this->Test->Details = $this->TestMeasurement->Value;
                }
            } elseif ($this->TestMeasurement->Name == 'Completion Status') {
                if (strlen($this->Test->Details) > 0) {
                    $this->Test->Details = $this->TestMeasurement->Value . ' (' . $this->Test->Details . ')';
                } else {
                    $this->Test->Details = $this->TestMeasurement->Value;
                }
            } elseif ($this->TestMeasurement->Name == 'Command Line') {
                // don't do anything since it should already be in the FullCommandLine
            } else {
                // explicit measurement

                // If it's an image we add it as an image
                if (strpos($this->TestMeasurement->Type, 'image') !== false) {
                    $image = new Image();
                    $image->Extension = $this->TestMeasurement->Type;
                    $image->Data = $this->TestMeasurement->Value;
                    $image->Name = $this->TestMeasurement->Name;
                    $this->Test->AddImage($image);
                } else {
                    $this->TestMeasurement->Value = trim($this->TestMeasurement->Value);
                    $this->Test->AddMeasurement($this->TestMeasurement);
                }
            }
        } elseif ($name == 'SITE') {
            // Update the number of tests in the Build table
            $this->Build->UpdateTestNumbers($this->NumberTestsPassed,
                $this->NumberTestsFailed,
                $this->NumberTestsNotRun);
            $this->Build->ComputeTestTiming();

            if ($this->StartTimeStamp > 0 && $this->EndTimeStamp > 0) {
                // Update test duration in the Build table.
                $this->Build->SaveTotalTestsTime(
                    $this->EndTimeStamp - $this->StartTimeStamp);
            }

            // Update the build's end time to extend through testing.
            $end_time = gmdate(FMT_DATETIME, $this->EndTimeStamp);
            $this->Build->EndTime = $end_time;
            $this->Build->UpdateBuild($this->Build->Id, -1, -1);

            global $CDASH_ENABLE_FEED;
            if ($CDASH_ENABLE_FEED) {
                // Insert the build into the feed
                $this->Feed->InsertTest($this->projectid, $this->Build->Id);
            }
        }
    }

    /** Text function */
    public function text($parser, $data)
    {
        $parent = $this->getParent();
        $element = $this->getElement();

        if ($parent == 'TESTING' && $element == 'STARTDATETIME') {
            // Defer to StartTestTime as it has higher precision.
            if (!isset($this->StartTimeStamp)) {
                $this->StartTimeStamp =
                    str_to_time($data, $this->Build->GetStamp());
            }
        } elseif ($parent == 'TESTING' && $element == 'STARTTESTTIME') {
            $this->StartTimeStamp = $data;
        } elseif ($parent == 'TESTING' && $element == 'ENDDATETIME') {
            // Defer to EndTestTime as it has higher precision.
            if (!isset($this->EndTimeStamp)) {
                $this->EndTimeStamp =
                    str_to_time($data, $this->Build->GetStamp());
            }
        } elseif ($parent == 'TESTING' && $element == 'ENDTESTTIME') {
            $this->EndTimeStamp = $data;
        } elseif ($parent == 'TEST') {
            switch ($element) {
                case 'NAME':
                    $this->Test->Name .= $data;
                    break;
                case 'PATH':
                    $this->Test->Path .= $data;
                    break;
                case 'FULLNAME':
                    //$this->Test->Command = $data;
                    break;
                case 'FULLCOMMANDLINE':
                    $this->Test->Command .= $data;
                    break;
            }
        } elseif ($parent == 'NAMEDMEASUREMENT' && $element == 'VALUE') {
            $this->TestMeasurement->Value .= $data;
        } elseif ($parent == 'MEASUREMENT' && $element == 'VALUE') {
            $this->Test->Output .= $data;
        } elseif ($parent == 'LABELS' && $element == 'LABEL') {
            $this->Label->SetText($data);
        }
    }
}