fossologyTestCase.php

<?php

/***********************************************************
 Copyright (C) 2008 Hewlett-Packard Development Company, L.P.

 This program is free software; you can redistribute it and/or
 modify it under the terms of the GNU General Public License
 version 2 as published by the Free Software Foundation.

 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 Street, Fifth Floor, Boston, MA  02110-1301, USA.
 ***********************************************************/
require_once ('TestEnvironment.php');
require_once ('fossologyTest.php');

class fossologyTestCase extends fossologyTest
{
  public $mybrowser;
  public $debug;
  public $webProxy;

  public function addUser($UserName, $Description = NULL, $Email = NULL, $Access = 1, $Folder = 1, $Password = NULL, $EmailNotify = 'y')
  {

    global $URL;

    // check user name, everything else defaults (not a good idea to use defaults)
    if (empty ($UserName))
    {
      return ("No User Name, cannot add user");
    }

    $page = $this->mybrowser->get($URL);
    $page = $this->mybrowser->clickLink('Add');
    $this->assertTrue($this->myassertText($page, '/Add A User/'), "Did NOT find Title, 'Add A User'");

    $this->setUserFields($UserName, $Description, $Email, $Access, $Folder, NULL, NULL, $Password, $EmailNotify);

    /* fields set, add the user */
    $page = $this->mybrowser->clickSubmit('Add!', "Could not select the Add! button");
    $this->assertTrue($page);
    //print "<pre>page after clicking Add!\n"; print_r($page) . "\n</pre>";
    if ($this->myassertText($page, "/User .*? added/"))
    {
      return (NULL);
    } else
    if ($this->myassertText($page, "/User already exists\.  Not added/"))
    {
      return ('User already exists.  Not added');
    } else
    if ($this->myassertText($page, "/ERROR/"))
    {
      return ("addUser FAILED! ERROR when adding users, please investigate");
    }
    return (NULL);
  } // addUser

  public function checkEmailNotification($number)
  {

    if (empty ($number))
    {
      return (array (
      0,
        'ERROR! Must supply a number to verify'
        ));
    }

    $headers = getMailSubjects();
    if (empty ($headers))
    {
      //print "No messages found\n";
      $this->pass();
      return (NULL);
    }
    //print "Got back from getMailSubjects:\n";print_r($headers) . "\n";

    /*
     check for errors
     */
    if (preg_match('/ERROR/', $headers[0], $matches))
    {
      $this->fail("{$headers[0]}\n");
      return (FALSE);
    }
    $pattern = 'completed with no errors';

    $failed = array ();
    foreach ($headers as $header)
    {
      /* Make sure all say completed */
      $match = preg_match("/$pattern/", $header, $matches);
      if ($match == 0)
      {
        $failed[] = $header;
      }
    }
    if (!empty ($failed))
    {
      $this->fail("Failures! there were jobs that did not report as completed\n");
      //foreach($failed as $fail) {
      //  print "$fail\n";
      return ($failed);
    }
  }

  public function createFolder($parent = null, $name, $description = null)
  {

    global $URL;
    $FolderId = 0;

    /* Need to check parameters */
    if (is_null($parent))
    {
      $FolderId = 1; // default is root folder
    }
    if (is_null($description))
    { // set default if null
      $description = "Folder $name created by createFolder as subfolder of $parent";
    }
    if(empty($name))
    {
      $this->fail("FATAL! No folder name supplied, cannot create folder\n");
    }
    $page = $this->mybrowser->get($URL);
    // There is only 1 create menu, so just select it
    // No need to make sure we are in folders menu.
    $page = $this->mybrowser->clickLink('Create');
    $this->assertTrue($this->myassertText($page, '/Create a new Fossology folder/'));
    /* if $FolderId=0 select the folder to create this folder under */
    if (!$FolderId)
    {
      $FolderId = $this->getFolderId($parent, $page, 'parentid');
    }
    $this->assertTrue($this->mybrowser->setField('parentid', $FolderId));
    $this->assertTrue($this->mybrowser->setField('newname', $name),
      "FATAL! Could not set newname for folder:$name\n");
    $this->assertTrue($this->mybrowser->setField('description', "$description"),
      "FATAL! Could not set description for folder:$name\n");
    $createdPage = $this->mybrowser->clickSubmit('Create!');
    $this->assertTrue($createdPage);
    if ($this->myassertText($createdPage, "/Folder $name Created/"))
    {
      $folderId = $this->getFolderId($name, $createdPage, 'parentid');
      return ($folderId);
    }
    if ($this->myassertText($createdPage, "/Folder $name Exists/"))
    {
      $folderId = $this->getFolderId($name, $createdPage, 'parentid');
      return ($folderId);
    }
    else
    {
      $this->fail("Failure! Did not find phrase 'Folder $name Created'\n");
    }
  }

  public function deleteFolder($folder)
  {
    global $URL;

    $page = $this->mybrowser->get($URL);
    $page = $this->mybrowser->clickLink('Delete Folder');
    $this->assertTrue($this->myassertText($page, '/Select the folder to delete/'));
    $FolderId = $this->getFolderId($folder, $page, 'folder');
    if (empty ($FolderId)) // not in the list of folders
    {
      return (true);
    }
    $this->assertTrue($this->mybrowser->setField('folder', $FolderId));
    $page = $this->mybrowser->clickSubmit('Delete!');
    $this->assertTrue($page);
    $this->assertTrue($this->myassertText($page, "/Deletion of folder $folder added to job queue/"), "delete Folder Failed!\nPhrase 'Deletion of folder $folder added to job queue' not found\n");
  }

  public function deleteUpload($upload)
  {
    global $URL;

    $page = $this->mybrowser->get($URL);
    $page = $this->mybrowser->clickLink('Delete Uploaded File');
    $this->assertTrue($this->myassertText($page, '/Select the uploaded file to delete/'));
    $UploadId = $this->getUploadId($upload, $page, 'upload');
    if (empty ($UploadId)) // not in the list of uploads on the root page
    {
      return (FALSE);
    }
    $this->assertTrue($this->mybrowser->setField('upload', $UploadId));
    $page = $this->mybrowser->clickSubmit('Delete!');
    $this->assertTrue($page);
    $this->assertTrue($this->myassertText($page, "/Deletion added to job queue/"), "delete Upload Failed!\nPhrase 'Deletion added to job queue' not found\n");
  }

  public function deleteUser($User)
  {

    global $URL;

    if (empty ($User))
    {
      return ('No User Specified');
    }
    // Should already be logged in... no need to call this: $this->Login();
    $page = $this->mybrowser->get("$URL?mod=user_del");
    /* Get the user id */
    $select = $this->parseSelectStmnt($page, 'userid', $User);
    if (!is_null($select))
    {
      $this->assertTrue($this->mybrowser->setField('userid', $select));
      $this->assertTrue($this->mybrowser->setField('confirm', 1));
      $page = $this->mybrowser->clickSubmit('Delete!', "Could not select the Delete! button");
      $this->assertTrue($page);
      if ($this->myassertText($page, "/User deleted/"))
      {
        print "User $User Deleted\n";
        $this->pass();
      } else
      {
        $this->fail("Delete User Failed!\nPhrase 'User deleted' not found\n");
      }
    }
  } // Delete User
  public function editFolder($folder, $newName, $description = null)
  {
    global $URL;

    /* Need to check parameters */
    if (empty ($folder))
    {
      return (FALSE);
    }
    if (is_null($description)) // set default if null
    {
      $description = "Folder $newName edited by editFolder Test, this is the changed description";
    }
    $page = $this->mybrowser->get($URL);
    $page = $this->mybrowser->clickLink('Edit Properties');
    $this->assertTrue($this->myassertText($page, '/Edit Folder Properties/'));
    $FolderId = $this->getFolderId($folder, $page, 'oldfolderid');
    $this->assertTrue($this->mybrowser->setField('oldfolderid', $FolderId));
    if (!(empty ($newName)))
    {
      $this->assertTrue($this->mybrowser->setField('newname', $newName));
    }
    $this->assertTrue($this->mybrowser->setField('newdesc', "$description"));
    $page = $this->mybrowser->clickSubmit('Edit!');
    $this->assertTrue($page);
    $this->assertTrue($this->myassertText($page, "/Folder Properties changed/"), "editFolder Failed!\nPhrase 'Folder Properties changed' not found\n");
  }
  public function editUser($UserName, $Description = NULL, $Email = NULL, $Access = 1, $Folder = 1, $Block = NULL, $Blank = NULL, $Password = NULL, $EmailNotify = 'y')
  {

    global $URL;

    // check user name, everything else defaults (not a good idea to use defaults)
    if (empty ($UserName))
    {
      return ("No User Name, cannot add user");
    }
    $page = $this->mybrowser->get($URL);
    $page = $this->mybrowser->clickLink('Edit Users');
    $this->assertTrue($this->myassertText($page, '/Edit A User/'), "Did NOT find Title, 'Edit A User'");
    $this->setUserFields($UserName, $Description, $Email, $Access, $Folder, NULL, NULL, $Password, $EmailNotify);

    /* fields set, edit the user */
    $page = $this->mybrowser->clickSubmit('Edit!', "Could not select the Edit! button");
    $this->assertTrue($page);
    //print "<pre>page after clicking Add!\n"; print_r($page) . "\n</pre>";
    if ($this->myassertText($page, "/User edited/"))
    {
      return (NULL);
    }
    return;
  } // addUser
  public function moveUpload($oldFolder, $destFolder, $upload)
  {
    global $URL;
    print "mU: OF:$oldFolder DF:$destFolder U:$upload\n";
    if (empty ($oldFolder))
    {
      return FALSE;
    }
    if (empty ($destFolder))
    {
      $destFolder = 'root'; // default is root folder
    }
    $page = $this->mybrowser->get($URL);
    /* use the method below till you write a menu function */
    $page = $this->mybrowser->get("$URL?mod=upload_move");
    //$page = $this->mybrowser->clickLink('Move');
    $this->assertTrue($this->myassertText($page, '/Move upload to different folder/'));
    $oldFolderId = $this->getFolderId($oldFolder, $page, 'oldfolderid');
    $this->assertTrue($this->mybrowser->setField('oldfolderid', $oldFolderId));
    $uploadId = $this->getUploadId($upload, $page, 'uploadid');
    if (empty ($uploadId))
    {
      $this->fail("moveUpload FAILED! could not find upload id for upload" .
      "$upload\n is $upload in $oldFolder?\n");
    }
    $this->assertTrue($this->mybrowser->setField('uploadid', $uploadId));
    $destFolderId = $this->getFolderId($destFolder, $page, 'targetfolderid');
    $this->assertTrue($this->mybrowser->setField('targetfolderid', $destFolderId));
    $page = $this->mybrowser->clickSubmit('Move!');
    $this->assertTrue($page);
    print "page after move is:\n$page\n";
    $this->assertTrue($this->myassertText($page,
    //"/Moved $upload from folder $oldFolder to folder $destFolder/"),
    "/Moved $upload from folder /"), "moveUpload Failed!\nPhrase 'Move $upload from folder $oldFolder " .
    "to folder $destFolder' not found\n");
  }

  public function mvFolder($folder, $destination)
  {
    global $URL;
    if (empty ($folder))
    {
      return (FALSE);
    }
    if (empty ($destination))
    {
      $destination = 1;
    }
    $page = $this->mybrowser->get($URL);
    $page = $this->mybrowser->clickLink('Move');
    $this->assertTrue($this->myassertText($page, '/Move Folder/'));
    $FolderId = $this->getFolderId($folder, $page, 'oldfolderid');
    $this->assertTrue($this->mybrowser->setField('oldfolderid', $FolderId));
    if ($destination != 1)
    {
      $DfolderId = $this->getFolderId($destination, $page, 'targetfolderid');
    }
    $this->assertTrue($this->mybrowser->setField('targetfolderid', $DfolderId));
    $page = $this->mybrowser->clickSubmit('Move!');
    $this->assertTrue($page);
    $this->assertTrue($this->myassertText($page, "/Moved folder $folder to folder $destination/"), "moveFolder Failed!\nPhrase 'Move folder $folder to folder ....' not found\n");
  }

  public function fillGroupForm($groupName, $user)
  {
    global $URL;

    if (is_NULL($groupName))
    {
      $msg = "FATAL! no group name to set\n";
      $this->fail($msg);
      return ($msg);
    }
    if (is_NULL($user))
    {
      $msg = "FATAL! no user name to set\n";
      $this->fail($msg);
      return ($msg);
    }
    // make sure we are on the page
    $page = $this->mybrowser->get("$URL?mod=group_manage");
    $this->assertTrue($this->myassertText($page, '/Manage Group/'), "Did NOT find Title, 'Manage Group'");
    $this->assertTrue($this->myassertText($page, '/Add a Group/'), "Did NOT find phrase, 'Add a Group'");

    // set the fields
    $groupNotSet = 'FATAL! Could Not set the groupname field';
    if (!empty ($groupName))
    {
      $this->assertTrue($this->mybrowser->setField('groupname', $groupName), $groupNotSet);
    }
    if (!empty ($user))
    {
      $userNotSet = 'FATAL! Could Not set the userid field in select';
      $this->assertTrue($this->mybrowser->setField('userid', $user), $userNotSet);
      //return($userNotSet);
    }
    return (NULL);
  } //fillGroupForm

  protected function setUserFields($UserName = NULL, $Description = NULL,
  $Email = NULL, $Access = 1, $Folder = 1, $Block = NULL, $Blank = NULL,
  $Password = NULL, $EmailNotify = NULL, $BucketPool = 1, $Ui = 'simple')
  {

    $FailStrings = NULL;
    $simple = FALSE;
    $original = FALSE;

    global $URL;

    if (strtoupper($UserName) == 'NULL')
    {
      $this->fail("setUserFields, FATAL! no user name to set\n");
    }
    if (strtoupper($Description) == 'NULL')
    {
      $Description = '';
    }
    if (strtoupper($Email) == 'NULL')
    {
      $Email = '';
    }
    if (strtoupper($Access) == 'NULL')
    {
      $Access = 1;
    }
    if (strtoupper($Folder) == 'NULL')
    {
      $Folder = 1;
    }
    if (strtoupper($Block) == 'NULL')
    {
      $Block = '';
    }
    if (strtoupper($Blank) == 'NULL')
    {
      $Blank = '';
    }
    if (strtoupper($Password) == 'NULL')
    {
      $Password = '';
    }
    if (strtoupper($EmailNotify) == 'NULL' || is_null($EmailNotify))
    {
      unset ($EmailNotify);
    }
    if ($BucketPool == NULL)
    {
      $BucketPool = 1;  // default bucket pool
    }
    if (strcasecmp($Ui, 'simple'))
    {
      $simple = TRUE;
    }
    else if (strcasecmp($Ui, 'original'))
    {
      $orignal = TRUE;
    }

    $page = $this->mybrowser->get($URL);
    $page = $this->mybrowser->clickLink('Add');
    $this->assertTrue($this->myassertText($page, '/Add A User/'),
      "Did NOT find Title, 'Add A User'");

    if (!empty ($UserName))
    {
      $this->assertTrue($this->mybrowser->setField('username', $UserName),
        "Could Not set the username field");
    }
    if (!empty ($Description))
    {
      $this->assertTrue($this->mybrowser->setField('description', $Description),
        "Could Not set the description field");
    }
    if (!empty ($Email))
    {
      $this->assertTrue($this->mybrowser->setField('email', $Email),
        "Could Not set the email field");
    }
    if (!empty ($Access))
    {
      $this->assertTrue($this->mybrowser->setField('permission', $Access),
        "Could Not set the permission field");
    } else
    {
      return ('FATAL: Access/permission is a required field');
    }
    if (!empty ($Folder))
    {
      $this->assertTrue($this->mybrowser->setField('folder', $Folder),
        "Could Not set the folder Field");
    }
    if (!empty ($Block))
    {
      $this->assertTrue($this->mybrowser->setField('block', $Block),
        "Could Not set the block Field");
    }
    if (!empty ($Blank))
    {
      $this->assertTrue($this->mybrowser->setField('blank', $Blank),
        "Could Not set the blank Field");
    }
    if (!empty ($Password))
    {
      $this->assertTrue($this->mybrowser->setField('pass1', $Password),
        "Could Not set the pass1 field");
      $this->assertTrue($this->mybrowser->setField('pass2', $Password),
        "Could Not set the pass2 field");
    }
    if (isset ($EmailNotify))
    {
      $this->assertTrue($this->mybrowser->setField('enote', TRUE),
        "Could Not set the enote Field to non default value");
    } else
    {
      $this->assertTrue($this->mybrowser->setField('enote', FALSE),
        "Could Not set the enote Field");
    }
    if (!empty($BucketPool))
    {
      $this->assertTrue($this->mybrowser->setField('default_bucketpool_fk', $BucketPool),
        "Could Not set the default bucketpool select");
    }
    if ($simple)
    {
      $this->assertTrue($this->mybrowser->setField('simple', 'checked'),
        "Could Not set the simple check box");

    }
    if($original)
    {
      $this->assertTrue($this->mybrowser->setField('original', 'checked'),
        "Could Not set the original check box");
    }
    return (NULL);
  } // setUserFields

  public function uploadFile($parentFolder, $uploadFile, $description = null, $uploadName = null, $agents = null)
  {
    global $URL;
    /*
     * check parameters:
     * default parent folder is root folder
     * no uploadfile return false
     * description and upload name are optonal
     * future: agents are optional
     */
    if (empty ($parentFolder))
    {
      $parentFolder = 1;
    }
    if (empty ($uploadFile))
    {
      return (FALSE);
    }
    if (is_null($description)) // set default if null
    {
      $description = "File $uploadFile uploaded by test UploadFileTest";
    }
    //print "starting uploadFile\n";
    $loggedIn = $this->mybrowser->get($URL);
    $this->assertTrue($this->myassertText($loggedIn, '/Upload/'));
    $page = $this->mybrowser->get("$URL?mod=upload_file");
    $this->assertTrue($this->myassertText($page, '/Upload a New File/'));
    $this->assertTrue($this->myassertText($page, '/Select the file to upload:/'));
    $FolderId = $this->getFolderId($parentFolder, $page, 'folder');
    $this->assertTrue($this->mybrowser->setField('folder', $FolderId),
     "uploadFile FAILED! could not set 'folder' field!\n");
    $this->assertTrue($this->mybrowser->setField('getfile', "$uploadFile"),
     "uploadFile FAILED! could not set 'getfile' field!\n");
    $this->assertTrue($this->mybrowser->setField('description', "$description"),
     "uploadFile FAILED! could not set 'description' field!\n");
    /*
     * the test will fail if name is set to null, so we special case it
     * rather than just set it.
     */
    if (!(is_null($uploadName)))
    {
      $this->assertTrue($this->mybrowser->setField('name', "$uploadName"),
       "uploadFile FAILED! could not set 'name' field!\n");
    }
    /*
     * Select agents to run, we just pass on the parameter to setAgents,
     * don't bother if null
     */
    if (!(is_null($agents)))
    {
      $this->setAgents($agents);
    }
    $page = $this->mybrowser->clickSubmit('Upload');
    $this->assertTrue($page);
    $this->assertTrue($this->myassertText($page, '/The file .*? has been uploaded/'), "FAILURE:Did not find the message 'The file .*? has been uploaded'\n");
  } // uploadFile
  public function uploadServer($parentFolder = 1, $uploadPath, $description = null, $uploadName = null, $agents = null)
  {
    global $URL;
    global $PROXY;
    /*
     * check parameters:
     * default parent folder is root folder
     * no uploadfile return false
     * description and upload name are optonal
     * future: agents are optional
     */
    if (empty ($parentFolder))
    {
      $parentFolder = 1;
    }
    if (empty ($uploadPath))
    {
      return (FALSE);
    }
    if (is_null($description)) // set default if null
    {
      $description = "File $uploadPath uploaded by test UploadAUrl";
    }
    //print "starting UploadAUrl\n";
    $loggedIn = $this->mybrowser->get($URL);
    $this->assertTrue($this->myassertText($loggedIn, '/Upload/'), "uploadURL FAILED! cannot file Upload menu, did we get a fossology page?\n");
    $page = $this->mybrowser->clickLink("From Server");

    $this->assertTrue($this->myassertText($page, '/Upload from Server/'));
    $this->assertTrue($this->myassertText($page, '/Select the directory or file\(s\) on the server to upload/'));
    /* only look for the the folder id if it's not the root folder */
    $folderId = $parentFolder;
    if ($parentFolder != 1)
    {
      $folderId = $this->getFolderId($parentFolder, $page, 'folder');
    }
    $this->assertTrue($this->mybrowser->setField('folder', $folderId), "Count not set folder field\n");
    $this->assertTrue($this->mybrowser->setField('sourcefiles', $uploadPath), "Count not set sourcefiles field\n");
    $this->assertTrue($this->mybrowser->setField('description', "$description"), "Count not set description field\n");
    /* Set the name field if an upload name was passed in. */
    if (!is_null($uploadName))
    {
      $this->assertTrue($this->mybrowser->setField('name', $uploadName));
    }
    /* selects agents */
    $rtn = $this->setAgents($agents);
    if (!is_null($rtn))
    {
      $this->fail("FAIL: could not set agents in uploadServer test\n");
    }
    $page = $this->mybrowser->clickSubmit('Upload!');
    $this->assertTrue($page);
    $this->assertTrue($this->myassertText($page, '/The upload for .*? has been scheduled/'), "FAIL! did not see phrase The upload for .*? has been scheduled\n");
    //print  "************ page after Upload! *************\n$page\n";
  } //uploadServer

  public function uploadUrl($parentFolder = 1, $url, $description = null, $uploadName = null, $agents = null)
  {
    global $URL;
    global $PROXY;
    /*
     * check parameters:
     * default parent folder is root folder
     * no uploadfile return false
     * description and upload name are optonal
     * future: agents are optional
     */
    if (empty ($parentFolder))
    {
      $parentFolder = 1;
    }
    if (empty ($url))
    {
      return (FALSE);
    }
    if (is_null($description)) // set default if null
    {
      $description = "File $url uploaded by test UploadAUrl";
    }
    //print "starting UploadAUrl\n";
    $loggedIn = $this->mybrowser->get($URL);
    $this->assertFalse($this->myassertText($loggedIn, '/Network Error/'), "uploadURL FAILED! there was a Newtwork Error (dns lookup?)\n");
    $this->assertTrue($this->myassertText($loggedIn, '/Upload/'), "uploadURL FAILED! cannot file Upload menu, did we get a fossology page?\n");
    $this->assertTrue($this->myassertText($loggedIn, '/From URL/'));
    $page = $this->mybrowser->get("$URL?mod=upload_url");

    $this->assertTrue($this->myassertText($page, '/Upload from URL/'));
    $this->assertTrue($this->myassertText($page, '/Enter the URL to the file/'));
    /* only look for the the folder id if it's not the root folder */
    $folderId = $parentFolder;
    if ($parentFolder != 1)
    {
      $folderId = $this->getFolderId($parentFolder, $page, 'folder');
    }
    $this->assertTrue($this->mybrowser->setField('folder', $folderId));
    $this->assertTrue($this->mybrowser->setField('geturl', $url));
    $this->assertTrue($this->mybrowser->setField('description', "$description"));
    /* Set the name field if an upload name was passed in. */
    if (!(is_null($uploadName)))
    {
      $this->assertTrue($this->mybrowser->setField('name', $url));
    }
    /* selects agents using numbers 1,2,3 or names license, mime, pkgmetagetta */
    $rtn = $this->setAgents($agents);
    if (!is_null($rtn))
    {
      $this->fail("FAIL: could not set agents in uploadAFILE test\n");
    }
    $page = $this->mybrowser->clickSubmit('Upload!');
    $this->assertTrue($page);
    $this->assertTrue($this->myassertText($page, '/The upload .*? has been scheduled/'), "FAIL! did find phrase The upload .*? has been scheduled\n");
    //print  "************ page after Upload! *************\n$page\n";
  } //uploadUrl

  public function wait4jobs()
  {

    require_once ('testClasses/check4jobs.php');

    define("FiveMIN", "300");

    $Jq = new check4jobs();

    /* wait at most 2 hours for test jobs to finish */
    $done = FALSE;
    for ($i = 1; $i <= 24; $i++)
    {
      //print "DB:W4Q: checking Q...\n";
      $number = $Jq->Check();
      if ($number != 0)
      {
        //print "sleeping 10 min...\n";
        sleep(FiveMIN);
      } else
      {
        //print "$number jobs found in the Queue\n";
        $done = TRUE;
        break;
      }
    }
    if ($done === FALSE)
    {
      print "{$argv[0]} waited for 2 hours and the jobs are still not done\n" .
      "Please investigate\n";
      return (FALSE);
    }
    if ($done === TRUE)
    {
      return (TRUE);
    }
  } // wait4jobs

  /* possible methods to add */
  public function dbCheck()
  {
    return TRUE;
  }

  public function jobsSummary()
  {
    return TRUE;
  }
  public function jobsDetail()
  {
    return TRUE;
  }

  public function oneShotLicense()
  {
    return TRUE;
  }
  public function rmLicAnalysis()
  {
    return TRUE;
  }
}
?>