qemudb/include/application.php

<?php
/***********************************************************/
/* this class represents an application incl. all versions */
/***********************************************************/

require_once(BASE."include/version.php");
require_once(BASE."include/vendor.php");
require_once(BASE."include/url.php");

/**
 * Application class for handling applications.
 */
class Application {

    var $iAppId;
    var $iVendorId;
    var $iCatId;
    var $sName;
    var $sKeywords;
    var $sDescription;
    var $sWebpage;
    var $sQueued;
    var $sSubmitTime;
    var $iSubmitterId;
    var $aVersionsIds;  // an array that contains the versionId of every version linked to this app.
    var $aUrlsIds;            // an array that contains the screenshotId of every url linked to this version

    /**    
     * constructor, fetches the data.
     */
    function Application($iAppId = null)
    {
        // we are working on an existing application
        if(is_numeric($iAppId))
        {
            /*
             * We fetch application data and versionsIds. 
             */
            $sQuery = "SELECT appFamily.*, appVersion.versionId AS versionId
                       FROM appFamily, appVersion 
                       WHERE appFamily.appId = appVersion.appId 
                       AND appVersion.queued='false'
                       AND appFamily.appId = ".$iAppId." ORDER BY versionName";
            if($hResult = query_appdb($sQuery))
            {
                $this->aVersionsIds = array();
                while($oRow = mysql_fetch_object($hResult))
                {
                    if(!$this->iAppId)
                    {
                        $this->iAppId = $iAppId;
                        $this->iVendorId = $oRow->vendorId;
                        $this->iCatId = $oRow->catId;
                        $this->iSubmitterId = $oRow->submitterId;
                        $this->sSubmitTime = $oRow->submitTime;
                        $this->sDate = $oRow->submitTime;
                        $this->sName = $oRow->appName;
                        $this->sKeywords = $oRow->keywords;
                        $this->sDescription = $oRow->description;
                        $this->sWebpage = $oRow->webPage;
                        $this->sQueued = $oRow->queued;
                    }
                    $this->aVersionsIds[] = $oRow->versionId;
                }
            }

            /*
             * Then we fetch the data related to this application if the first query didn't return anything.
             * This can happen if an application has no version linked to it.
             */
            if(!$this->appId)
            {
                $sQuery = "SELECT *
                           FROM appFamily 
                           WHERE appId = ".$iAppId;
                if($hResult = query_appdb($sQuery))
                {
                    $oRow = mysql_fetch_object($hResult);
                    $this->iAppId = $iAppId;
                    $this->iVendorId = $oRow->vendorId;
                    $this->iCatId = $oRow->catId;
                    $this->iSubmitterId = $oRow->submitterId;
                    $this->sSubmitTime = $oRow->submitTime;
                    $this->sDate = $oRow->submitTime;
                    $this->sName = $oRow->appName;
                    $this->sKeywords = $oRow->keywords;
                    $this->sDescription = $oRow->description;
                    $this->sWebpage = $oRow->webPage;
                    $this->sQueued = $oRow->queued;
                }
            }

            /*
             * We fetch urlsIds. 
             */
            $this->aUrlsIds = array();
            $sQuery = "SELECT id
                       FROM appData
                       WHERE type = 'url'
                       AND appId = ".$iAppId;

            if($hResult = query_appdb($sQuery))
            {
                while($oRow = mysql_fetch_object($hResult))
                {
                    $this->aUrlsIds[] = $oRow->id;
                }
            }
        }
    }


    /**
     * Creates a new application.
     */
    function create()
    {
        // Security, if we are not an administrator the application must be queued.
        if(!($_SESSION['current']->hasPriv("admin")))
            $this->sQueued = 'true';
        else
            $this->sQueued = 'false';

        $aInsert = compile_insert_string(array( 'appName'    => $this->sName,
                                                'description'=> $this->sDescription,
                                                'keywords'   => $this->sKeywords,
                                                'webPage'    => $this->sWebpage,
                                                'vendorId'   => $this->iVendorId,
                                                'catId'      => $this->iCatId,
                                                'submitterId'=> $_SESSION['current']->iUserId,
                                                'queued'     => $this->sQueued));
        $sFields = "({$aInsert['FIELDS']})";
        $sValues = "({$aInsert['VALUES']})";

        if(query_appdb("INSERT INTO appFamily $sFields VALUES $sValues", "Error while creating a new application."))
        {
            $this->iAppId = mysql_insert_id();
            $this->application($this->iAppId);
            $this->SendNotificationMail();  // Only administrators will be mailed as no supermaintainers exist for this app.
            return true;
        }
        else
            return false;
    }


    /**
     * Update application.
     * Returns true on success and false on failure.
     */
    function update()
    {
        $sWhatChanged = "";

        /* create an instance of ourselves so we can see what has changed */
        $oApp = new Application($this->iAppId);

        if ($this->sName && ($this->sName!=$oApp->sName))
        {
            $sUpdate = compile_update_string(array('appName'    => $this->sName));
            if (!query_appdb("UPDATE appFamily SET ".$sUpdate." WHERE appId = ".$this->iAppId))
                return false;
            $sWhatChanged .= "Name was changed from ".$oApp->sName." to ".$this->sName.".\n\n";
        }     

        if ($this->sDescription && ($this->sDescription!=$oApp->sDescription))
        {
            $sUpdate = compile_update_string(array('description'    => $this->sDescription));
            if (!query_appdb("UPDATE appFamily SET ".$sUpdate." WHERE appId = ".$this->iAppId))
                return false;
            $sWhatChanged .= "Description was changed from\n ".$oApp->sDescription."\n to \n".$this->sDescription.".\n\n";
        }

        if ($this->sKeywords && ($this->sKeywords!=$oApp->sKeywords))
        {
            $sUpdate = compile_update_string(array('keywords'    => $this->sKeywords));
            if (!query_appdb("UPDATE appFamily SET ".$sUpdate." WHERE appId = ".$this->iAppId))
                return false;
            $sWhatChanged .= "Keywords were changed from\n ".$oApp->sKeywords."\n to \n".$this->sKeywords.".\n\n";
        }

        if ($this->sWebpage && ($this->sWebpage!=$oApp->sWebpage))
        {
            $sUpdate = compile_update_string(array('webPage'    => $this->sWebpage));
            if (!query_appdb("UPDATE appFamily SET ".$sUpdate." WHERE appId = ".$this->iAppId))
                return false;
            $sWhatChanged .= "Web page was changed from ".$oApp->sWebpage." to ".$this->sWebpage.".\n\n";
        }
     
        if ($this->iVendorId && ($this->iVendorId!=$oApp->iVendorId))
        {
            $sUpdate = compile_update_string(array('vendorId'    => $this->iVendorId));
            if (!query_appdb("UPDATE appFamily SET ".$sUpdate." WHERE appId = ".$this->iAppId))
                return false;
            $oVendorBefore = new Vendor($oApp->iVendorId);
            $oVendorAfter = new Vendor($this->iVendorId);
            $sWhatChanged .= "Vendor was changed from ".$oVendorBefore->sName." to ".$oVendorBefore->sName.".\n\n";
        }

        if ($this->iCatId && ($this->iCatId!=$oApp->iCatId))
        {
            $sUpdate = compile_update_string(array('catId'    => $this->iCatId));
            if (!query_appdb("UPDATE appFamily SET ".$sUpdate." WHERE appId = ".$this->iAppId))
                return false;
            $oCatBefore = new Category($oApp->iCatId);
            $oCatAfter = new Category($this->iCatId);
            $sWhatChanged .= "Vendor was changed from ".$oCatBefore->sName." to ".$oCatAfter->sName.".\n\n";
        }
        if($sWhatChanged)
            $this->SendNotificationMail("edit",$sWhatChanged);
        return true;
    }


    /**    
     * Deletes the application from the database. 
     * and request the deletion of linked elements.
     */
    function delete($bSilent=false)
    {
        /* don't let non-admins delete applications */
        if(!($_SESSION['current']->hasPriv("admin")))
            return;

        foreach($this->aVersionsIds as $iVersionId)
        {
            $oVersion = new Version($iVersionId);
            $oVersion->delete($bSilent);
        }
        foreach($this->aUrlsIds as $iUrlId)
        {
            $oUrl = new Url($iUrlId);
            $oUrl->delete($bSilent);
        }

        // remove any supermaintainers for this application so we don't orphan them
        $sQuery = "DELETE from appMaintainers WHERE appId='".$this->iAppId."';";
        if(!($hResult = query_appdb($sQuery)))
        {
            addmsg("Error removing app maintainers for the deleted application!", "red");
        }

        $sQuery = "DELETE FROM appFamily 
                   WHERE appId = ".$this->iAppId." 
                   LIMIT 1";
        if(!($hResult = query_appdb($sQuery)))
        {
            addmsg("Error deleting application!", "red");
        }

        if(!$bSilent)
            $this->SendNotificationMail("delete");
    }


    /**
     * Move application out of the queue.
     */
    function unQueue()
    {
        // If we are not in the queue, we can't move the application out of the queue.
        if(!$this->sQueued == 'true')
            return false;

        $sUpdate = compile_update_string(array('queued'  => "false",
                                               'keywords'=> str_replace(" *** ","",$this->sKeywords) ));
        if(query_appdb("UPDATE appFamily SET ".$sUpdate." WHERE appId = ".$this->iAppId))
        {
            $this->sQueued = 'false';
            // we send an e-mail to intersted people
            $this->mailSubmitter();
            $this->SendNotificationMail();

            // the application has been unqueued
            addmsg("The application has been unqueued.", "green");
        }
    }

    function Reject()
    {
        // If we are not in the queue, we can't move the application out of the queue.
        if(!$this->sQueued == 'true')
            return false;

        $sUpdate = compile_update_string(array('queued'    => "rejected"));
        if(query_appdb("UPDATE appFamily SET ".$sUpdate." WHERE appId = ".$this->iAppId))
        {
            $this->sQueued = 'rejected';
            // we send an e-mail to intersted people
            $this->mailSubmitter("reject");
            $this->SendNotificationMail("reject");

            // the application has been rejectedd
            addmsg("The application has been rejected.", "green");
        }
    }
    function ReQueue()
    {
        // If we are not in the rejected, we can't move the application into the queue.
        if(!$this->sQueued == 'rejected')
            return false;

        $sUpdate = compile_update_string(array('queued'    => "true"));
        if(query_appdb("UPDATE appFamily SET ".$sUpdate." WHERE appId = ".$this->iAppId))
        {
            $this->sQueued = 'true';
            // we send an e-mail to intersted people
            $this->SendNotificationMail();

            // the application has been re-queued
            addmsg("The application has been re-queued.", "green");
        }
    }

    function mailSubmitter($sAction="add")
    {
        if($this->iSubmitterId)
        {
            $oSubmitter = new User($this->iSubmitterId);
            switch($sAction)
            {
            case "add":
               {
                   $sSubject =  "Submitted application accepted";
                   $sMsg  = "The application you submitted (".$oApp->sName." ".$this->sName.") has been accepted.";
               }
            break;
            case "reject":
                {
                    $sSubject =  "Submitted application rejected";
                    $sMsg  = "The application you submitted (".$oApp->sName." ".$this->sName.") has been rejected.";
                    $sMsg .= "Clicking on the link in this email will allow you to modify and resubmit the application. ";
                    $sMsg .= "A link to your queue of applications and versions will also show up on the left hand side of the Appdb site once you have logged in. ";
                    $sMsg .= APPDB_ROOT."admin/resubmitRejectedApps.php?sub=view&appId=".$this->iAppId."\n";
                    $sMsg .= "Reason given:\n";
                    $sMsg .= $_REQUEST['replyText']."\n"; /* append the reply text, if there is any */
                }
            break;
            case "delete":
                {
                    $sSubject =  "Submitted application deleted";
                    $sMsg  = "The application you submitted (".$oApp->sName." ".$this->sName.") has been deleted.";
                    $sMsg .= "Reason given:\n";
                    $sMsg .= $_REQUEST['replyText']."\n"; /* append the reply text, if there is any */
                }
            break;

            $sMsg .= $_REQUEST['replyText']."\n";
            $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)
    {
        switch($sAction)
        {
            case "add":
                if(!$this->sQueued == 'true')
                {
                    $sSubject = $this->sName." has been added by ".$_SESSION['current']->sRealname;
                    $sMsg  = APPDB_ROOT."appview.php?appId=".$this->iAppId."\n";
                    if($this->iSubmitterId)
                    {
                        $oSubmitter = new User($this->iSubmitterId);
                        $sMsg .= "This application has been submitted by ".$oSubmitter->sRealname.".";
                        $sMsg .= "\n";
                    }
                    addmsg("The application was successfully added into the database.", "green");
                } else // Application queued.
                {
                    $sSubject = $this->sName." has been submitted by ".$_SESSION['current']->sRealname;
                    $sMsg .= "This application has been queued.";
                    $sMsg .= "\n";
                    addmsg("The application you submitted will be added to the database after being reviewed.", "green");
                }
            break;
            case "edit":
                $sSubject =  $this->sName." has been modified by ".$_SESSION['current']->sRealname;
                $sMsg  = APPDB_ROOT."appview.php?appId=".$this->iAppId."\n";
                addmsg("Application modified.", "green");
            break;
            case "delete":
                $sSubject = $this->sName." has been deleted by ".$_SESSION['current']->sRealname;

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

                addmsg("Application deleted.", "green");
            break;
            case "reject":
                $sSubject = $this->sName." has been rejected by ".$_SESSION['current']->sRealname;
                $sMsg .= APPDB_ROOT."admin/resubmitRejectedApps.php?sub=view&appId=".$this->iAppId."\n";

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

                addmsg("Application rejected.", "green");
            break;
        }
        $sEmail = get_notify_email_address_list($this->iAppId);
        if($sEmail)
            mail_appdb($sEmail, $sSubject ,$sMsg);
    } 


    /* output a html table and this applications values to the fields for editing */
    function OutputEditor($sVendorName)
    {
        HtmlAreaLoaderScript(array("app_editor"));

        echo '<input type="hidden" name="appId" value="'.$this->iAppId.'">';

        echo html_frame_start("Application Form", "90%", "", 0);
        echo "<table width='100%' border=0 cellpadding=2 cellspacing=0>\n";
        echo '<tr valign=top><td class="color0"><b>Application name</b></td>',"\n";
        echo '<td><input size="20" type="text" name="appName" value="'.$this->sName.'"></td></tr>',"\n";

        // app Category
        $w = new TableVE("view");
        echo '<tr valign=top><td class="color0"><b>Category</b></td><td>',"\n";
        $w->make_option_list("appCatId", $this->iCatId,"appCategory","catId","catName");
        echo '</td></tr>',"\n";

        // vendor name
        echo '<tr valign=top><td class="color0"><b>Vendor</b></td>',"\n";
        echo '<td><input size="20" type=text name="appVendorName" value="'.$sVendorName.'"></td></tr>',"\n";

        // alt vendor
        $x = new TableVE("view");
        echo '<tr valign=top><td class="color0">&nbsp;</td><td>',"\n";
        $x->make_option_list("appVendorId", $this->iVendorId,"vendor","vendorId","vendorName");
        echo '</td></tr>',"\n";

        // url
        echo '<tr valign=top><td class="color0"><b>URL</b></td>',"\n";
        echo '<td><input size="20" type=text name="appWebpage" value="'.$this->sWebpage.'"></td></tr>',"\n";

        echo '<tr valign=top><td class="color0"><b>Keywords</b></td>',"\n";
        echo '<td><input size="90%" type="text" name="appKeywords" value="'.$this->sKeywords.'"></td></tr>',"\n";

        echo '<tr valign=top><td class="color0"><b>Application Description</b></td>',"\n";
        echo '<td><p><textarea cols="80" rows="20" id="app_editor" name="appDescription">';

        if(get_magic_quotes_gpc())
            echo stripslashes($this->sDescription).'</textarea></p></td></tr>',"\n";
        else
            echo $this->sDescription.'</textarea></p></td></tr>',"\n";

        echo "</table>\n";

        echo html_frame_end();
    }

    function CheckOutputEditorInput()
    {
        $errors = "";

        if (empty($_REQUEST['appCatId']))
            $errors .= "<li>Please enter a category for your application.</li>\n";

        if (strlen($_REQUEST['appName']) > 200 )
            $errors .= "<li>Your application name is too long.</li>\n";

        if (empty($_REQUEST['appName']))
            $errors .= "<li>Please enter an application name.</li>\n";

        // No vendor entered, and nothing in the list is selected
        if (empty($_REQUEST['appVendorName']) && !$_REQUEST['appVendorId'])
            $errors .= "<li>Please enter a vendor.</li>\n";

        if (empty($_REQUEST['appDescription']))
            $errors .= "<li>Please enter a description of your application.</li>\n";

        return $errors;
    }

    /* retrieves values from $_REQUEST that were output by OutputEditor() */
    function GetOutputEditorValues()
    {
        if(get_magic_quotes_gpc())
        {
            $this->iAppId = stripslashes($_REQUEST['appId']);
            $this->sName = stripslashes($_REQUEST['appName']);
            $this->sDescription = stripslashes($_REQUEST['appDescription']);
            $this->iCatId = stripslashes($_REQUEST['appCatId']);
            $this->iVendorId = stripslashes($_REQUEST['appVendorId']);
            $this->sWebpage = stripslashes($_REQUEST['appWebpage']);
            $this->sKeywords = stripslashes($_REQUEST['appKeywords']);
        } else
        {
            $this->iAppId = $_REQUEST['appId'];
            $this->sName = $_REQUEST['appName'];
            $this->sDescription = $_REQUEST['appDescription'];
            $this->iCatId = $_REQUEST['appCatId'];
            $this->iVendorId = $_REQUEST['appVendorId'];
            $this->sWebpage = $_REQUEST['appWebpage'];
            $this->sKeywords = $_REQUEST['appKeywords'];
        }
    }
}


/*
 * Application functions that are not part of the class
 */

function lookup_version_name($versionId)
{
    if(!$versionId) return null;
    $result = query_appdb("SELECT versionName FROM appVersion WHERE versionId = $versionId");
    if(!$result || mysql_num_rows($result) != 1)
        return null;
    $ob = mysql_fetch_object($result);
    return $ob->versionName;
}


function lookup_app_name($appId)
{
    if(!$appId) return null;
    $result = query_appdb("SELECT appName FROM appFamily WHERE appId = $appId");
    if(!$result || mysql_num_rows($result) != 1)
        return null;
    $ob = mysql_fetch_object($result);
    return $ob->appName;
}


/**
 * Remove html formatting from description and extract the first part of the description only.
 * This is to be used for search results, application summary tables, etc.
 */ 
function trim_description($sDescription)
{
    // 1) let's take the first line of the description:
    $aDesc = explode("\n",trim($sDescription),2);
    // 2) maybe it's an html description and lines are separated with <br> or </p><p>
    $aDesc = explode("<br>",$aDesc[0],2);
    $aDesc = explode("<br />",$aDesc[0],2);
    $aDesc = explode("</p><p>",$aDesc[0],2);
    $aDesc = explode("</p><p /><p>",$aDesc[0],2);
    return trim(strip_tags($aDesc[0]));
}

function GetDefaultApplicationDescription()
{
    return "<p>Enter a description of the application here</p>";
}
?>