buildevent.class.php

<?php
/**
 * @file buildevent.class.php
 * Abstract (conceptual) class used to model an autobuilder event.
 *
 * @section License
 * GPL: http://www.gnu.org/licenses/gpl.html
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the Free
 * Software Foundation; either version 2 of the License, or (at your option)
 * any later version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
 * more details.
 *
 * You should have received a copy of the GNU General Public License along with
 * this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 *
 * @author Copyright &copy; 2009-2012 Daniel Swanson <danij@dengine.net>
 */

includeGuard('BuildEvent');

class BuildEvent
{
    private $uniqueId;
    private $startDate;
    private $authorName;
    private $authorEmail;

    private $releaseTypeId;
    private $releaseNotesUri = NULL;
    private $releaseChangeLogUri = NULL;

    // Event chains:
    private $prevForStartDate = NULL;
    private $nextForStartDate = NULL;
    private $prevForVersion = NULL;
    private $nextForVersion = NULL;

    /// @todo Collections should be private but allow public iteration.
    public $packages = array();
    public $commits = array();

    /**
     * @param uniqueId (integer)
     * @param startDate  (string) Unix timestamp when build commenced.
     * @param authorName (string)
     * @param authorEmail (string)
     * @param releaseTypeId (integer)
     */
    public function __construct($uniqueId, $startDate, $authorName, $authorEmail,
        $releaseTypeId=RT_UNKNOWN)
    {
        $this->uniqueId = $uniqueId;
        $this->startDate = $startDate;
        $this->authorName = $authorName;
        $this->authorEmail = $authorEmail;
        $this->releaseTypeId = $releaseTypeId;
    }

    public function uniqueId()
    {
        return $this->uniqueId;
    }

    public function composeName($includeReleaseType=false)
    {
        $name = "Build$this->uniqueId";
        if($includeReleaseType && $this->releaseTypeId !== RT_UNKNOWN)
        {
            $releaseType = BuildRepositoryPlugin::releaseType($this->releaseTypeId);
            $name .= ' ('. $releaseType['nicename'] .')';
        }
        return $name;
    }

    public function &startDate()
    {
        return $this->startDate;
    }

    public function composeBuildUri()
    {
        return "build$this->uniqueId";
    }

    public function releaseTypeId()
    {
        return $this->releaseTypeId;
    }

    public function hasReleaseNotesUri()
    {
        return !is_null($this->releaseNotesUri);
    }

    public function releaseNotesUri()
    {
        return $this->releaseNotesUri;
    }

    public function setReleaseNotesUri($newUri)
    {
        $this->releaseNotesUri = "$newUri";
    }

    public function hasReleaseChangeLogUri()
    {
        return !is_null($this->releaseChangeLogUri);
    }

    public function releaseChangeLogUri()
    {
        return $this->releaseChangeLogUri;
    }

    public function setReleaseChangeLogUri($newUri)
    {
        $this->releaseChangeLogUri = "$newUri";
    }

    public function addPackage(&$package)
    {
        $this->packages[] = $package;
    }

    public function prevForStartDate()
    {
        return $this->prevForStartDate;
    }

    public function setPrevForStartDate(&$event)
    {
        if(!$event instanceof BuildEvent)
        {
            $this->prevForStartDate = NULL;
            return;
        }
        $this->prevForStartDate = $event;
    }

    public function nextForStartDate()
    {
        return $this->nextForStartDate;
    }

    public function setNextForStartDate(&$event)
    {
        if(!$event instanceof BuildEvent)
        {
            $this->nextForStartDate = NULL;
            return;
        }
        $this->nextForStartDate = $event;
    }

    public function prevForVersion()
    {
        return $this->prevForVersion;
    }

    public function setPrevForVersion(&$event)
    {
        if(!$event instanceof BuildEvent)
        {
            $this->prevForVersion = NULL;
            return;
        }
        $this->prevForVersion = $event;
    }

    public function nextForVersion()
    {
        return $this->nextForVersion;
    }

    public function setNextForVersion(&$event)
    {
        if(!$event instanceof BuildEvent)
        {
            $this->nextForVersion = NULL;
            return;
        }
        $this->nextForVersion = $event;
    }

    /**
     * Add a new Commit record to this build event.
     *
     * @param commit  (Array) Commit record.
     *
     * 'submitDate': (object) Date
     * 'author': (string)
     * 'repositoryUri': (string)
     * 'sha1': (string)
     * 'title': (string)
     * 'message': (string)
     * 'tags': (array)
     */
    public function addCommit($commit)
    {
        $this->commits[] = $commit;
    }

    public function genBadge()
    {
        $shortDate = date("d/m/y", $this->startDate);
        $buildUriTitle = $shortDate .' - '. $this->composeName();

        $html = '<a href="'.$this->composeBuildUri().'" title="'.$buildUriTitle.'">'.
            $this->composeName() .'</a>';
        return '<div class="build_news">'.$html.'</div>';
    }

    public function genFancyBadge($isActive=TRUE)
    {
        $name = "Build$this->uniqueId";
        $releaseType = BuildRepositoryPlugin::releaseType($this->releaseTypeId);
        $isActive = (boolean)$isActive;

        $cssClass = 'buildevent_badge';
        if($this->releaseTypeId !== RT_UNKNOWN)
        {
            $cssClass .= " {$releaseType['name']}";
            if(!$isActive || $this->uniqueId <= 0) $cssClass .= '_disabled';
        }

        $html = '';

        if($isActive && $this->uniqueId > 0)
        {
            $inspectBuildUri = $name;
            $inspectBuildLabel = htmlspecialchars("Read more about {$releaseType['nicename']} {$name}");

            $html .= "<a href=\"{$inspectBuildUri}\" title=\"{$inspectBuildLabel}\">";
        }
        else
        {
            $html .= "<a href=\"\\\" style=\"cursor:default;pointer-events:none\">";
        }

        $html .= "<div class=\"{$cssClass}\">"
                . ($this->uniqueId > 0? htmlspecialchars($this->uniqueId) : '&nbsp;')
                ."<span class=\"startdate\">". htmlspecialchars(date('d M Y', $this->startDate)) .'</span></div>';

        //if($isActive && $this->uniqueId > 0)
        {
            $html .= '</a>';
        }

        return $html;
    }

    public function __toString()
    {
        return '('.get_class($this).":$this->name)";
    }
}