include/monitor.php

   1 <?php
   2 /***************************************/
   3 /* Monitor class and related functions */
   4 /***************************************/
   5
   6
   7 /**
   8  * Monitor class for handling Monitors
   9  */
  10 class Monitor {
  11     var $iMonitorId;
  12
  13     // variables necessary for creating a monitor
  14     var $iAppId;
  15     var $iVersionId;
  16     var $iUserId;
  17
  18     /**
  19      * Constructor.
  20      * If $iMonitorId is provided, fetches Monitor.
  21      */
  22     function Monitor($iMonitorId="", $oRow = null)
  23     {
  24         if(!$iMonitorId && !$oRow)
  25             return;
  26
  27         if(!$oRow)
  28         {
  29             $sQuery = "SELECT *
  30                        FROM appMonitors
  31                        WHERE monitorId = '".$iMonitorId."'";
  32             $hResult = query_appdb($sQuery);
  33             $oRow = query_fetch_object($hResult);
  34         }
  35
  36         if($oRow)
  37         {
  38             $this->iMonitorId = $oRow->monitorId;
  39             $this->iAppId = $oRow->appId;
  40             $this->iVersionId = $oRow->versionId;
  41             $this->iUserId = $oRow->userId;
  42         }
  43     }
  44
  45     function find($iUserId, $iVersionId=0)
  46     {
  47         if($iUserId && $iVersionId)
  48         {
  49             $sQuery = "SELECT *
  50                           FROM appMonitors
  51                           WHERE userId = '".$iUserId."'
  52                           AND versionId = '".$iVersionId."'";
  53             $hResult = query_appdb($sQuery);
  54             if( $oRow = query_fetch_object($hResult) )
  55             {
  56                 $this->iMonitorId = $oRow->monitorId;
  57                 $this->iAppId = $oRow->appId;
  58                 $this->iVersionId = $oRow->versionId;
  59                 $this->iUserId = $oRow->userId;
  60             }
  61         }
  62     }
  63
  64     function objectGetChildren($bIncludeDeleted = false)
  65     {
  66         /* We have none */
  67         return array();
  68     }
  69
  70     /*
  71      * Creates a new Monitor.
  72      * Informs interested people about the creation.
  73      * Returns true on success, false on failure
  74      */
  75     function create()
  76     {
  77         /* Check for duplicate entries */
  78         $oMonitor = new monitor();
  79         $this->iUserId = $_SESSION['current']->iUserId;
  80         $oMonitor->find($this->iUserId, $this->iVersionId);
  81         if($oMonitor->iVersionId)
  82             return FALSE;
  83
  84         // create the new monitor entry
  85         $hResult = query_parameters("INSERT INTO appMonitors (versionId, appId,".
  86                                     "submitTime, userId) ".
  87                                     "VALUES ('?', '?', ?, '?')",
  88                                     $this->iVersionId, $this->iAppId,
  89                                     "NOW()", $this->iUserId);
  90
  91         if($hResult)
  92         {
  93             $this->Monitor(query_appdb_insert_id());
  94             $sWhatChanged = "New monitor\n\n";
  95             $this->SendNotificationMail("add", $sWhatChanged);
  96             return true;
  97         } else
  98         {
  99             addmsg("Error while creating a new Monitor.", "red");
 100             return false;
 101         }
 102     }
 103
 104     function update()
 105     {
 106         /* Stub */
 107         return TRUE;
 108     }
 109
 110     function unQueue()
 111     {
 112         return true; // We don't queue monitors
 113     }
 114
 115     function objectGetSubmitterId()
 116     {
 117         return $this->iUserId;
 118     }
 119
 120     function objectGetMailOptions($sAction, $bMailSubmitter, $bParentAction)
 121     {
 122         return new mailOptions();
 123     }
 124
 125     function objectGetMail($sAction, $bMailSubmitter, $bParentAction)
 126     {
 127         $sSubject = null;
 128         $sMsg = null;
 129
 130         if($this->iVersionId)
 131         {
 132             $sWhat = "version";
 133             $sName = version::fullName($this->iVersionId);
 134             $oVersion = new version($this->iVersionId);
 135             $sUrl = $oVersion->objectMakeUrl();
 136         } else
 137         {
 138             $sWhat = "application";
 139             $oApp = new application($this->iAppId);
 140             $sName = $oApp->sName;
 141             $sUrl = $oApp->objectMakeUrl();
 142         }
 143
 144         if($bMailSubmitter)
 145         {
 146             switch($sAction)
 147             {
 148                 case "delete":
 149                     if($bParentActino)
 150                     {
 151                         $sSubject = "Monitored $sWhat deleted";
 152                         $sMsg = "The $sWhat $sName which you monitored has been ".
 153                                 "deleted by ".$_SESSION['current']->iUserId.".";
 154                     }
 155                 break;
 156             }
 157             $aMailTo = null;
 158         } else
 159         {
 160             $oUser = new user($this->iUserId);
 161             $sUser = $oUser->sName;
 162             switch($sAction)
 163             {
 164                 case "delete":
 165                     if(!$bParentAction)
 166                     {
 167                         $sSubject = "Monitor for $sName removed: $sUser";
 168                         $sMsg = $sUrl;
 169                     }
 170                 break;
 171             }
 172             User::get_notify_email_address_list(null, $this->iVersionId);
 173         }
 174         return array($sSubject, $sMsg, $aMailTo);
 175     }
 176
 177     function purge()
 178     {
 179         return $this->delete();
 180     }
 181
 182    /**
 183      * Removes the current Monitor from the database.
 184      * Informs interested people about the deletion.
 185      */
 186     function delete()
 187     {
 188         $hResult = query_parameters("DELETE FROM appMonitors WHERE monitorId = '?'", $this->iMonitorId);
 189
 190         if(!$hResult)
 191             return FALSE;
 192
 193         return TRUE;
 194     }
 195
 196     function SendNotificationMail($sAction="add",$sMsg=null)
 197     {
 198         /* Set variables depending on whether it is an application or version monitor */
 199         if(isset($this->iVersionId))
 200         {
 201             $oVersion = new version($this->iVersionId);
 202             $sAppName = version::fullName($this->iVersionId);
 203             $sUrl = $oVersion->objectMakeUrl();
 204             $sVersion = " version";
 205         } else
 206         {
 207             $oApp = new application($this->iAppId);
 208             $sAppName = Application::lookup_name($this->iAppId);
 209             $sUrl = $oApp->objectMakeUrl();
 210         }
 211
 212         switch($sAction)
 213         {
 214             case "add":
 215                 $sSubject = "Monitor for ".$sAppName;
 216                 $sSubject .= " added: ".$_SESSION['current']->sRealname;
 217                 $sMsg .= "$sUrl\n";
 218                 addmsg("You will now receive an email whenever changes are made ".
 219                 "to this application$sVersion.", "green");
 220             break;
 221             case "delete":
 222                 $sSubject = "Monitor for ".$sAppName;
 223                 $sSubject .= " removed: ".$_SESSION['current']->sRealname;
 224                 $sMsg .= "$sUrl\n";
 225                 addmsg("You will no longer receive an email whenever changes ".
 226                 "are made to this application$sVersion.", "green");
 227             break;
 228         }
 229         $sEmail = User::get_notify_email_address_list(null, $this->iVersionId);
 230         if($sEmail)
 231             mail_appdb($sEmail, $sSubject ,$sMsg);
 232     }
 233
 234     function objectGetState()
 235     {
 236         // We don't queue monitors
 237         return 'accepted';
 238     }
 239
 240     function canEdit()
 241     {
 242         if($_SESSION['current']->hasPriv("admin") ||
 243            ($this->iUserId == $_SESSION['current']->iUserId))
 244             return TRUE;
 245
 246         return FALSE;
 247     }
 248
 249     function mustBeQueued()
 250     {
 251         return FALSE;
 252     }
 253
 254     /* Stub */
 255     function display()
 256     {
 257         return "";
 258     }
 259
 260     /* Stub */
 261     function getOutputEditorValues($aClean)
 262     {
 263         $this->iVersionId = $aClean['iVersionId'];
 264         $this->iAppId = $aClean['iAppId'];
 265     }
 266
 267     /* Stub */
 268     function objectGetHeader()
 269     {
 270         return null;
 271     }
 272
 273     function objectGetId()
 274     {
 275         return $this->iMonitorId;
 276     }
 277
 278         /* Stub */
 279     function objectGetTableRow()
 280     {
 281         return null;
 282     }
 283
 284     /* Stub */
 285     function objectMakeLink()
 286     {
 287         return "";
 288     }
 289
 290     /* Stub */
 291     function objectMakeUrl()
 292     {
 293         return "";
 294     }
 295
 296     /* Stub */
 297     function outputEditor()
 298     {
 299         return "";
 300     }
 301
 302     function objectGetEntries($sState, $iRows = 0, $iStart = 0, $sOrderBy = '', $bAscending = true)
 303     {
 304         $hResult = query_parameters("SELECT * FROM appMonitors");
 305
 306         if(!$hResult)
 307             return FALSE;
 308
 309         return $hResult;
 310     }
 311
 312     function objectGetEntriesCount($sState)
 313     {
 314         $hResult = query_parameters("SELECT COUNT(DISTINCT monitorId) as count
 315                                     FROM appMonitors");
 316
 317         if(!$hResult)
 318             return FALSE;
 319
 320         $oRow = query_fetch_object($hResult);
 321
 322         if(!$oRow)
 323             return FALSE;
 324
 325         return $oRow->count;
 326     }
 327
 328     function allowAnonymousSubmissions()
 329     {
 330         /* That makes no sense */
 331         return FALSE;
 332     }
 333
 334     /* Retrieve the user's monitored versions */
 335     function getVersionsMonitored($oUser)
 336     {
 337          $hResult = query_parameters("SELECT appId, versionId FROM appMonitors WHERE userId = '?'", $oUser->iUserId);
 338
 339          if(!$hResult || query_num_rows($hResult) == 0)
 340              return NULL;
 341
 342          $aVersionsMonitored = array();
 343
 344          for($i = 0; $oRow = query_fetch_object($hResult); $i++)
 345              $aVersionsMonitored[$i] = array($oRow->appId, $oRow->versionId);
 346
 347          return $aVersionsMonitored;
 348     }
 349 }
 350 ?>