name = $name;
$this->interfaceViaDB = false;
$this->methodOpt = array('buildViewBugLink' => array('addSummary' => true, 'colorByStatus' => true));
if( !$this->setCfg($config) )
{
return false;
}
$this->completeCfg();
$this->connect();
}
/**
*
* check for configuration attributes than can be provided on
* user configuration, but that can be considered standard.
* If they are MISSING we will use 'these carved on the stone values'
* in order to simplify configuration.
*
*
**/
function completeCfg()
{
$base = trim($this->cfg->uribase,"/") . '/'; // be sure no double // at end
if( !property_exists($this->cfg,'uriview') )
{
$this->cfg->uriview = $base . 'default.asp?command=view&pg=pgEditBug&ixbug=';
}
if( !property_exists($this->cfg,'uricreate') )
{
$this->cfg->uricreate = $base . 'default.asp?command=new&pg=pgEditBug';
}
}
/**
* useful for testing
*
*
**/
function getAPIClient()
{
return $this->APIClient;
}
/**
* checks id for validity
*
* @param string issueID
*
* @return bool returns true if the bugid has the right format, false else
**/
function checkBugIDSyntax($issueID)
{
return $this->checkBugIDSyntaxNumeric($issueID);
}
/**
* establishes connection to the bugtracking system
*
* @return bool
*
**/
function connect()
{
try
{
// CRITIC NOTICE for developers
// $this->cfg is a simpleXML Object, then seems very conservative and safe
// to cast properties BEFORE using it.
$this->APIClient = new FogBugz((string)trim($this->cfg->username),(string)trim($this->cfg->password),
(string)trim($this->cfg->uribase));
$this->APIClient->logon();
$this->connected = true;
}
catch(Exception $e)
{
$logDetails = '';
foreach(array('uribase','username','password') as $v)
{
$logDetails .= "$v={$this->cfg->$v} / ";
}
$logDetails = trim($logDetails,'/ ');
$this->connected = false;
tLog(__METHOD__ . " [$logDetails] " . $e->getMessage(), 'ERROR');
}
}
/**
*
*
**/
function isConnected()
{
return $this->connected;
}
/**
*
*
**/
public function getIssue($issueID)
{
if (!$this->isConnected())
{
$msg = __METHOD__ . ' Not Connected ';
tLog($msg,'ERROR');
return false;
}
try
{
$target = array('q' => intval($issueID), 'cols' => 'sTitle,sStatus');
$xml = $this->APIClient->search($target);
if( !is_null($xml) && is_object($xml) )
{
$issue = new stdClass();
$issue->IDHTMLString = "{$issueID} : ";
$issue->statusCode = (string)$xml->cases->case->sStatus;
$issue->statusVerbose = $issue->statusCode;
$issue->statusHTMLString = "[$issue->statusCode] ";
$issue->summary = $issue->summaryHTMLString = (string)$xml->cases->case->sTitle;
}
}
catch(Exception $e)
{
$msg = __METHOD__ . '/' . $e->getMessage();
tLog($msg,'ERROR');
$issue = null;
}
return $issue;
}
/**
* Returns status for issueID
*
* @param string issueID
*
* @return
**/
function getIssueStatusCode($issueID)
{
$issue = $this->getIssue($issueID);
return (!is_null($issue) && is_object($issue)) ? $issue->statusCode : false;
}
/**
* Returns status in a readable form (HTML context) for the bug with the given id
*
* @param string issueID
*
* @return string
*
**/
function getIssueStatusVerbose($issueID)
{
return $this->getIssueStatusCode($issueID);
}
/**
*
* @param string issueID
*
* @return string
*
**/
function getIssueSummaryHTMLString($issueID)
{
$issue = $this->getIssue($issueID);
return (!is_null($issue) && is_object($issue)) ? $issue->summaryHTMLString : null;
}
/**
* @param string issueID
*
* @return bool true if issue exists on BTS
**/
function checkBugIDExistence($issueID)
{
if(($status_ok = $this->checkBugIDSyntax($issueID)))
{
$issue = $this->getIssue($issueID);
$status_ok = !is_null($issue) && is_object($issue);
}
return $status_ok;
}
/**
*
*/
public function addIssue($summary,$description)
{
try
{
$projectName = (string)$this->cfg->project;
$issue = array('sProject' => htmlentities($projectName),
'sTitle' => htmlentities($summary),
'sEvent' => htmlentities($description));
// just for the record APIClient->NAME OF FogBugz command
$op = $this->APIClient->new($issue);
$ret = array('status_ok' => true, 'id' => (string)$op->case['ixBug'],
'msg' => sprintf(lang_get('fogbugz_bug_created'),$summary,$projectName));
}
catch (Exception $e)
{
$msg = "Create FOGBUGZ Ticket FAILURE => " . $e->getMessage();
tLog($msg, 'WARNING');
$ret = array('status_ok' => false, 'id' => -1, 'msg' => $msg . ' - serialized issue:' . serialize($issue));
}
return $ret;
}
/**
*
* @author francisco.mancardi@gmail.com>
**/
public static function getCfgTemplate()
{
// https://testlink.fogbugz.com/fogbugz/default.asp?pg=pgEditBug&command=view&ixbug=
$template = "\n" .
"\n" .
"FOGBUGZ LOGIN NAME\n" .
"FOGBUGZ PASSWORD\n" .
"https://testlink.fogbugz.com\n" .
"\n" .
"FOGBUGZ PROJECT NAME\n" .
"\n";
return $template;
}
/**
*
**/
function canCreateViaAPI()
{
return (property_exists($this->cfg, 'project'));
}
}