qemudb/include/distribution.php

<?php
/***************************************/
/* this class represents Distributions */
/***************************************/
require_once(BASE."include/mail.php");
require_once(BASE."include/util.php");

// Test class for handling Distributions.

class distribution {
    var $iDistributionId;
    var $sName;
    var $sUrl;
    var $sSubmitTime;
    var $iSubmitterId;
    private $sState;
    var $aTestingIds;

     // constructor, fetches the data.
    function distribution($iDistributionId = null, $oRow = null)
    {
        $this->aTestingIds = array();
        // we are working on an existing distribution.
        if(!$iDistributionId && !$oRow)
            return;

        // We fetch the data related to this distribution.
        if(!$oRow)
        {
            $sQuery = "SELECT *
                        FROM distributions
                        WHERE distributionId = '?'";
            if($hResult = query_parameters($sQuery, $iDistributionId))
                $oRow = query_fetch_object($hResult);
        }

        if($oRow)
        {
            $this->iDistributionId = $oRow->distributionId;
            $this->sName = $oRow->name;
            $this->sUrl = $oRow->url;
            $this->sSubmitTime = $oRow->submitTime;
            $this->iSubmitterId = $oRow->submitterId;
            $this->sState = $oRow->state;
        }

        /*
            * We fetch Test Result Ids. 
            */

        if($_SESSION['current']->hasPriv("admin"))
        {
            $sQuery = "SELECT testingId
                            FROM testResults
                            WHERE distributionId = '?' 
                            ORDER BY testedRating;" ;
        } else /* only let users view test results that aren't queued and for apps that */
                /* aren't queued or versions that aren't queued */
        {
            $sQuery = "SELECT testingId
                            FROM testResults, appFamily, appVersion
                            WHERE testResults.state = 'accepted' AND
                                testResults.versionId = appVersion.versionId AND
                                appFamily.appId = appVersion.appId AND
                                appFamily.state = 'accepted' AND
                                appVersion.state = 'accepted' AND
                                distributionId = '?'
                            ORDER BY testedRating;";
        }

        if($hResult = query_parameters($sQuery, $this->iDistributionId))
        {
            while($oRow = query_fetch_object($hResult))
            {
                $this->aTestingIds[] = $oRow->testingId;
            }
        }
    }

    // Creates a new distribution.
    function create()
    {
        //Let's not create a duplicate 
        $sQuery = "SELECT *
                   FROM distributions
                   WHERE name = '?'";
        $hResult = query_parameters($sQuery, $this->sName);

        if($hResult && $oRow = query_fetch_object($hResult))
        {
            if(query_num_rows($hResult))
            {
                addmsg("There was an existing distribution called ".$this->sName.".", "red");
                $this->distribution($oRow->distributionId);

                /* Even though we did not create a new distribution, the caller is provided
                with a valid distribution object.  Thus no special handling is necessary,
                so we return TRUE */
                return TRUE;
            }
        }

        $hResult = query_parameters("INSERT INTO distributions (name, url, submitTime, ".
                                    "submitterId, state) ".
                                    "VALUES ('?', '?', ?, '?', '?')",
                                    $this->sName, $this->sUrl,
                                    "NOW()",
                                    $_SESSION['current']->iUserId,
                                    $this->mustBeQueued() ? 'queued' : 'accepted');
        if($hResult)
        {
            $this->iDistributionId = query_appdb_insert_id();
            $this->distribution($this->iDistributionId);
            $this->SendNotificationMail();
            return true;
        }
        else
        {
            addmsg("Error while creating Distribution.", "red");
            return false;
        }
    }

    // Update Distribution.
    function update()
    {
        // is the current user allowed to update this Distribution? 
        if(!$_SESSION['current']->hasPriv("admin") &&
           !($_SESSION['current']->iUserId == $this->iSubmitterId))
        {
            return;
        }
        if(query_parameters("UPDATE distributions SET name = '?', url = '?' WHERE distributionId = '?'",
                            $this->sName, $this->sUrl, $this->iDistributionId))
        {
            $this->SendNotificationMail("edit");
            return true;
        } else
        {
            addmsg("Error while updating Distribution", "red");
            return false;
        }
    }

    // Delete Distributution.
    function delete()
    {
        /* Is the current user allowed to delete this distribution?  We allow
           everyone to delete a queued, empty distribution, because it should be
           deleted along with the last testData associated with it */
        if(!($this->canEdit() || (!sizeof($this->aTestingIds) &&
                $this->sState != 'accepted')))
            return false;

        // if the distribution has test results only enable an admin to delete
        // the distribution
        if(sizeof($this->aTestingIds) && !$_SESSION['current']->hasPriv("admin"))
          return FALSE;

        $bSuccess = TRUE;

        foreach($this->objectGetChildren() as $oChild)
        {
            if(!$oChild->delete())
                $bSuccess = FALSE;
        }

        // now delete the Distribution 
        $sQuery = "DELETE FROM distributions
                   WHERE distributionId = '?' 
                   LIMIT 1";
        if(!($hResult = query_parameters($sQuery, $this->iDistributionId)))
            $bSuccess = FALSE;

        return $bSuccess;
    }


    // Move Distribution out of the queue.
    function unQueue()
    {
        /* Check permissions */
        if($this->mustBeQueued())
            return FALSE;

        // If we are not in the queue, we can't move the Distribution out of the queue.
        if($this->sState != 'queued')
            return false;

        if(query_parameters("UPDATE distributions SET state = '?' WHERE distributionId = '?'",
                            'accepted', $this->iDistributionId))
        {
            $this->sState = 'accepted';
            // we send an e-mail to interested people
            $this->mailSubmitter("add");
            $this->SendNotificationMail();
            return true;
        } else
        {
            addmsg("Error while unqueueing Distribution", "red");
            return false;
        }
    }

    function Reject($bSilent=false)
    {
        // is the current user allowed to reject this Distribution? 
        if(!$_SESSION['current']->hasPriv("admin"))
        {
            return false;
        }

        // If we are not in the queue, we can't move the Distribution out of the queue.
        if($this->sState != 'queued')
            return false;

        return $this->delete();
    }

    function getTestResults()
    {
        $aTests = array();
        $sQuery = "SELECT * FROM testResults WHERE distributionId = '?'";
        $hResult = query_parameters($sQuery, $this->iDistributionId);

        while($oRow = mysql_fetch_object($hResult))
            $aTests[] = new testData(null, $oRow);

        return $aTests;
    }

    function objectGetChildren()
    {
        $aChildren = array();

        foreach($this->getTestResults() as $oTest)
        {
            $aChildren += $oTest->objectGetChildren();
            $aChildren[] = $oTest;
        }

        return $aChildren;
    }

    function ReQueue()
    {
        // is the current user allowed to requeue this data 
        if(!$_SESSION['current']->hasPriv("admin") &&
           !($_SESSION['current']->iUserId == $this->iSubmitterId))
        {
            return false;
        }

        if(query_parameters("UPDATE testResults SET state = '?' WHERE testingId = '?'",
                            'queued', $this->iTestingId))
        {
            if(query_parameters("UPDATE distribution SET state = '?' WHERE distributionId = '?'",
                                'queued', $this->iDistributionId))
            {
                $this->sState = 'queued';
                // we send an e-mail to interested people
                $this->SendNotificationMail();

                // the test data has been resubmitted
                addmsg("The Distribution has been resubmitted", "green");
                return true;
            }
        }

        /* something has failed if we fell through to this point without */
        /* returning */
        addmsg("Error requeueing Distribution", "red");
        return false;
    }

    function objectGetSubmitterId()
    {
        return $this->iSubmitterId;
    }

    function objectGetMailOptions($sAction, $bMailSubmitter, $bParentAction)
    {
        return new mailOptions();
    }

    function objectGetMail($sAction, $bMailSubmitter, $bParentAction)
    {
        $oSubmitter = new user($this->iSubmitterId);

        if($bMailSubmitter)
        {
            switch($sAction)
            {
                case "delete":
                    $sSubject = "Submitted distribution deleted";
                    $sMsg = "The distribution you submitted (".$this->sName.") has been ".
                            "deleted.\n";
                break;
            }
            $aMailTo = null;
        } else
        {
            switch($sAction)
            {
                case "delete":
                    $sSubject = "Distribution ".$this->sName." deleted";
                    $sMsg = "";
                break;
            }
            $aMailTo = User::get_notify_email_address_list(null, null);
        }

        return array($sSubject, $sMsg, $aMailTo);
    }

    function mailSubmitter($sAction="add")
    {
        global $aClean;

        if($this->iSubmitterId)
        {
            $oSubmitter = new User($this->iSubmitterId);
            switch($sAction)
            {
            case "add":
               {
                   $sSubject =  "Submitted Distribution accepted";
                   $sMsg  = "The Distribution you submitted (".$this->sName.") has been accepted.\n";
               }
            break;
            case "delete":
                {
                    $sSubject =  "Submitted Distribution deleted";
                    $sMsg  = "The Distribution you submitted (".$this->sName.") has been deleted.";
                    $sMsg .= "Reason given:\n";
                    $sMsg .= $aClean['sReplyText']."\n"; // append the reply text, if there is any 
                }
            break;
            }
            $sMsg .= "We appreciate your help in making the Application Database better for all users.";

            mail_appdb($oSubmitter->sEmail, $sSubject ,$sMsg);
        }
    }

 
    function SendNotificationMail($sAction="add",$sMsg=null)
    {
        global $aClean;

        switch($sAction)
        {
            case "add":
                if($this->sState == 'accepted')
                {
                    $sSubject = "Distribution ".$this->sName." added by ".
                            $_SESSION['current']->sRealname;
                    $sMsg  = $this->objectMakeUrl()."\n";
                    if($this->iSubmitterId)
                    {
                        $oSubmitter = new User($this->iSubmitterId);
                        $sMsg .= "This Distribution has been submitted by ".$oSubmitter->sRealname.".";
                        $sMsg .= "\n";
                        $sMsg .= "Appdb admin reply text:\n";
                        $sMsg .= $aClean['sReplyText']."\n"; // append the reply text, if there is any 
                    }
                    addmsg("The Distribution was successfully added into the database.", "green");
                } else // test data queued.
                {
                    $sSubject = "Distribution ".$this->sName." submitted by ".$_SESSION['current']->sRealname;
                    $sMsg .= "This test data has been queued.";
                    $sMsg .= "\n";
                    addmsg("The Distribution you submitted will be added to the database after being reviewed.", "green");
                }
            break;
            case "edit":
                $sSubject =  "Distribution ".$this->sName." has been modified by ".$_SESSION['current']->sRealname;
                $sMsg  = $this->objectMakeUrl()."\n";
                addmsg("Distribution modified.", "green");
            break;
            case "delete":
                $sSubject = "Distribution ".$this->sName." has been deleted by ".$_SESSION['current']->sRealname;

                // if sReplyText is set we should report the reason the data was deleted 
                if($aClean['sReplyText'])
                {
                    $sMsg .= "Reason given:\n";
                    $sMsg .= $aClean['sReplyText']."\n"; // append the reply text, if there is any 
                }

                addmsg("Distribution deleted.", "green");
            break;
            case "reject":
                $sSubject = "Distribution '".$this->sName." has been rejected by ".
                        $_SESSION['current']->sRealname;
                $sMsg  = $this->objectMakeUrl()."\n";

                 // if sReplyText is set we should report the reason the data was rejected 
                if($aClean['sReplyText'])
                {
                    $sMsg .= "Reason given:\n";
                    $sMsg .= $aClean['sReplyText']."\n"; // append the reply text, if there is any 
                }

                addmsg("Distribution rejected.", "green");
            break;
        }
        $sEmail = User::get_notify_email_address_list(null, null);
        if($sEmail)
            mail_appdb($sEmail, $sSubject ,$sMsg);
    }

    function outputEditor()
    {
        echo "<table width='100%' border=0 cellpadding=2 cellspacing=0>\n";

        $this->sName = str_replace('"', '&quot;', $this->sName);
        // Name
        echo html_tr(array(
                array("<b>Distribution Name:</b>", 'align=right class="color0"'),
                array('<input type=text name="sDistribution" value="'.$this->sName.
                        '" size="60" />', 'class="color0"')
                    ));

        // URL
        echo html_tr(array(
                array("<b>Distribution URL:</b>", 'align=right class="color0"'),
                array('<input type=text name="sUrl" value="'.$this->sUrl.
                        '" size="60" />', 'class="color0"')
                    ));


        echo "</table>\n";

        if($this->iDistributionId)
        {
            echo  '<input type="hidden" name="iDistributionId" '.
                    'value="'.$this->iDistributionId.'">',"\n";
        }
    }

    /* retrieves values from $_REQUEST that were output by outputEditor() */
    /* $aValues can be $_REQUEST or any array with the values from outputEditor() */
    function GetOutputEditorValues($aValues)
    {
        if($aClean['iDistributionId'])
            $this->iDistributionId = $aValues['iDistributionId'];

        $this->sName = $aValues['sDistribution'];
        $this->sUrl = $aValues['sUrl'];
    }

    /* Get the total number of Distributions in the database */
    function objectGetEntriesCount($bQueued, $bRejected)
    {
        /* Not implemented */
        if($bRejected)
            return FALSE;

        $hResult = query_parameters("SELECT count(distributionId) as num_dists FROM
                                     distributions WHERE state='?'",
                                    $bQueued ? 'queued' : 'accepted');

        if($hResult)
        {
            $oRow = query_fetch_object($hResult);
            return $oRow->num_dists;
        }
        return 0;
    }

    /* Make a dropdown list of distributions */
    function make_distribution_list($varname, $cvalue)
    {
        $sQuery = "SELECT name, distributionId FROM distributions
                WHERE state = 'accepted'
                ORDER BY name";
        $hResult = query_parameters($sQuery);
        if(!$hResult) return;

        echo "<select name='$varname'>\n";
        echo "<option value=\"\">Choose ...</option>\n";
        while(list($name, $value) = query_fetch_row($hResult))
        {
            if($value == $cvalue)
                echo "<option value=$value selected>$name\n";
            else
                echo "<option value=$value>$name\n";
        }
        echo "</select>\n";
    }

    function objectGetHeader()
    {
        $oTableRow = new TableRowSortable();

        $oTableRow->AddSortableTextCell("Distribution name", "name");

        $oTableRow->AddTextCell("Distribution url");

        $oTableCell = new TableCell("Linked Tests");
        $oTableCell->SetAlign("right");
        $oTableRow->AddCell($oTableCell);

        return $oTableRow;
    }

    public static function objectGetSortableFields()
    {
        return array('name');
    }

    function objectGetEntries($bQueued, $bRejected, $iRows = 0, $iStart = 0, $sOrderBy = "name", $bAscending = TRUE)
    {
        /* Not implemented */
        if($bRejected)
            return FALSE;

        /* Only users with edit privileges are allowed to view queued
           items, so return NULL in that case */
        if($bQueued && !distribution::canEdit())
            return NULL;

        $sOrder = $bAscending ? "ASC" : "DESC";

        /* If row limit is 0 we want to fetch all rows */
        if(!$iRows)
            $iRows = distribution::objectGetEntriesCount($bQueued, $bRejected);

        $sQuery = "SELECT * FROM distributions
                       WHERE state = '?' ORDER BY $sOrderBy $sOrder LIMIT ?,?";

        return query_parameters($sQuery, $bQueued ? 'queued' : 'accepted',
                                $iStart, $iRows);
    }

    function objectGetTableRow()
    {
        $oTableRow = new TableRow();

        $oTableRow->AddTextCell($this->objectMakeLink());

        $oTableCell = new TableCell("$this->sUrl");
        $oTableCell->SetCellLink($this->sUrl);
        $oTableRow->AddCell($oTableCell);

        $oTableCell = new TableCell(sizeof($this->aTestingIds));
        $oTableCell->SetAlign("right");
        $oTableRow->AddCell($oTableCell);

        // enable the 'delete' action if this distribution has no testing results
        $bDeleteLink = sizeof($this->aTestingIds) ? FALSE : TRUE;

        $oOMTableRow = new OMTableRow($oTableRow);
        $oOMTableRow->SetHasDeleteLink($bDeleteLink);
        return $oOMTableRow;
    }

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

    // Whether the user has permission to edit distributions
    function canEdit()
    {
        if($_SESSION['current']->hasPriv("admin"))
            return TRUE;

        /* Maintainers are allowed to process queued test results and therefore also
           queued distributions */
        if(is_object($this) && $this->sState != 'accepted' &&
           maintainer::isUserMaintainer($_SESSION['current']))
            return TRUE;

        return FALSE;
    }

    function mustBeQueued()
    {
        if($_SESSION['current']->hasPriv("admin") ||
          maintainer::isUserMaintainer($_SESSION['current']))
            return FALSE;
        else
            return TRUE;
    }

    function objectHideDelete()
    {
        return TRUE;
    }

    function display()
    {
        echo "Distribution Name:";

        if($this->sUrl)
            echo "<a href='".$this->sUrl."'>";

        echo $this->sName;

        if ($this->sUrl) 
        {
            echo " (".$this->sUrl.")";
            echo "</a> <br />\n";
        } else 
        {
            echo "<br />\n";
        }

        if($this->aTestingIds)
        {
            echo '<p><span class="title">Test Results for '.$this->sName.'</span><br />',"\n";
            echo '<table width="100%" border="1">',"\n";
            echo '<thead class="historyHeader">',"\n";
            echo '<tr>',"\n";
            echo '<td>Application Version</td>',"\n";
            echo '<td>Submitter</td>',"\n";
            echo '<td>Date Submitted</td>',"\n";
            echo '<td>Wine version</td>',"\n";
            echo '<td>Installs?</td>',"\n";
            echo '<td>Runs?</td>',"\n";
            echo '<td>Rating</td>',"\n";
            echo '</tr></thead>',"\n";
            foreach($this->aTestingIds as $iTestingId)
            {
                $oTest = new testData($iTestingId);
                $oVersion = new Version($oTest->iVersionId);
                $oApp  = new Application($oVersion->iAppId);
                $oSubmitter = new User($oTest->iSubmitterId);
                $bgcolor = $oTest->sTestedRating;

                /* make sure the user can view the versions we list in the table */
                /* otherwise skip over displaying the entries in this table */
                if(!$_SESSION[current]->canViewApplication($oApp))
                    continue;
                if(!$_SESSION[current]->canViewVersion($oVersion))
                    continue;

                echo '<tr class='.$bgcolor.'>',"\n";
                echo '<td><a href="'.$oVersion->objectMakeUrl().'&iTestingId='.$oTest->iTestingId.'">',"\n";
                echo version::fullName($oVersion->iVersionId).'</a></td>',"\n";
                echo '<td>',"\n";
                if($_SESSION['current']->isLoggedIn())
                {
                    echo $oSubmitter->sEmail ? "<a href=\"mailto:".$oSubmitter->sEmail."\">":"";
                    echo $oSubmitter->sRealname;
                    echo $oSubmitter->sEmail ? "</a>":"";
                }
                else
                    echo $oSubmitter->sRealname;
                echo '</td>',"\n";
                echo '<td>'.date("M d Y", mysqldatetime_to_unixtimestamp($oTest->sSubmitTime)).'</td>',"\n";
                echo '<td>'.$oTest->sTestedRelease.'&nbsp</td>',"\n";
                echo '<td>'.$oTest->sInstalls.'&nbsp</td>',"\n";
                echo '<td>'.$oTest->sRuns.'&nbsp</td>',"\n";
                echo '<td>'.$oTest->sTestedRating.'&nbsp</td>',"\n";
                if ($_SESSION['current']->hasAppVersionModifyPermission($oVersion))
                {
                    echo '<td><a href="'.$oTest->objectMakeUrl().'">',"\n";
                    echo 'Edit</a></td>',"\n";
                }
                echo '</tr>',"\n";
            }
            echo '</table>',"\n";
        }
    }

    /* Make a URL for viewing the specified distribution */
    function objectMakeUrl()
    {
        $oObject = new objectManager("distribution", "View Distribution");
        return $oObject->makeUrl("view", $this->iDistributionId);
    }

    /* Make an HTML link for viewing the specified distirbution */
    function objectMakeLink()
    {
        return "<a href=\"".$this->objectMakeUrl()."\">$this->sName</a>";
    }

    function objectMoveChildren($iNewId)
    {
        /* Keep track of how many children we modified */
        $iCount = 0;

        foreach($this->aTestingIds as $iTestId)
        {
            $oTest = new testData($iTestId);
            $oTest->iDistributionId = $iNewId;
            if($oTest->update(TRUE))
                $iCount++;
            else
                return FALSE;
        }

        return $iCount;
    }

    function objectGetItemsPerPage($bQueued = false)
    {
        $aItemsPerPage = array(25, 50, 100, 200);
        $iDefaultPerPage = 25;
        return array($aItemsPerPage, $iDefaultPerPage);
    }

    function objectGetid()
    {
        return $this->iDistributionId;
    }

    function allowAnonymousSubmissions()
    {
        return FALSE;
    }

    function objectShowAddEntry()
    {
        return TRUE;
    }
}

?>