name = $name;
$this->interfaceViaDB = false;
if( !$this->setCfg($config) )
{
return false;
}
$this->methodOpt['buildViewBugLink'] = array('addSummary' => true, 'colorByStatus' => false);
$this->defaultResolvedStatus = array();
$this->defaultResolvedStatus[] = array('code' => 'r', 'verbose' => 'resolved');
$this->defaultResolvedStatus[] = array('code' => 'v', 'verbose' => 'verified');
$this->defaultResolvedStatus[] = array('code' => 'c', 'verbose' => 'closed');
$this->setResolvedStatusCfg();
$this->completeCfg();
$this->connect();
$this->guiCfg = array('use_decoration' => true); // add [] on summary
}
/**
*
* 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,'urixmlrpc') )
{
$this->cfg->urixmlrpc = $base . 'xmlrpc';
}
if( !property_exists($this->cfg,'uriview') )
{
$this->cfg->uriview = $base . 'ticket/';
}
if( !property_exists($this->cfg,'uricreate') )
{
$this->cfg->uricreate = $base . 'newticket/';
}
}
/**
* 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()
{
// echo __METHOD__ . '
';
try
{
// CRITIC NOTICE for developers
// $this->cfg is a simpleXML Object, then seems very conservative and safe
// to cast properties BEFORE using it.
$this->createAPIClient();
$this->connected = true;
//var_dump($this->APIClient);
//echo '
END ' . __METHOD__ . '
';
}
catch(Exception $e)
{
$logDetails = '';
foreach(array('uribase','apikey') 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)
{
// array ticket.get(int id) Fetch a ticket.
// Returns [id, time_created, time_changed, attributes].
// attributes is following map (@20120826)
//
// ------------------------------------------
// key | value
// ------------------------------------------
// status | new
// description | MERCURIAL FIRST TICKET
// reporter | admin
// cc | [empty string]
// component | component1
// summary | MERCURIAL FIRST TICKET
// priority | major
// keywords | [empty string]
// version | [empty string]
// milestone | [empty string]
// owner | somebody
// type | defect
//
$resp = $this->sendCmd('ticket.get', $issueID);
if( $resp == false )
{
$issue = null;
}
else
{
$attrib = $resp[self::TICKET_GET_ATTRIBUTES_IDX];
$issue = new stdClass();
$issue->IDHTMLString = "{$issueID} : ";
$issue->statusCode = 0;
$issue->statusVerbose = $attrib['status'];
$issue->statusHTMLString = "[$issue->statusVerbose] ";
$issue->summary = $issue->summaryHTMLString = $attrib['summary'];
$issue->isResolved = isset($this->resolvedStatus->byName[$issue->statusVerbose]);
}
return $issue;
}
/**
* Returns status for issueID
*
* @param string issueID
*
* @return
**/
function getIssueStatusCode($issueID)
{
$issue = $this->getIssue($issueID);
return !is_null($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);
$str = $issue->summaryHTMLString;
if($this->guiCfg['use_decoration'])
{
$str = "[" . $str . "] ";
}
return $str;
}
/**
* @param string issueID
*
* @return bool true if issue exists on BTS
**/
function checkBugIDExistence($issueID)
{
$dBugLabel = array('label' => __METHOD__);
if(($status_ok = $this->checkBugIDSyntax($issueID)))
{
$issue = $this->getIssue($issueID);
$status_ok = is_object($issue) && !is_null($issue);
}
return $status_ok;
}
/**
*
*
**/
function createAPIClient()
{
try
{
// Create a new connection with the TRAC-server.
$this->APIClient = new xmlrpc_client($this->cfg->urixmlrpc);
// Set the credentials to use to log in.
$this->APIClient->setCredentials($this->cfg->username, $this->cfg->password);
// Disable certificate checking. Don't need to check it.
$this->APIClient->verifyhost = false;
$this->APIClient->verifypeer = false;
}
catch(Exception $e)
{
$this->connected = false;
tLog(__METHOD__ . $e->getMessage(), 'ERROR');
}
}
/**
*
*/
function sendCmd($cmd, $id)
{
$param = new xmlrpcval(intval($id));
$msg = new xmlrpcmsg($cmd);
$msg->addParam($param);
// Send request with timeout disabled
$response = $this->APIClient->send($msg, 0);
if (!$response->errno)
{
$response = php_xmlrpc_decode($response->val);
}
else
{
tLog(__METHOD__ . (serialize($response)), 'ERROR');
$response = false;
}
return $response;
}
/**
*
* @author francisco.mancardi@gmail.com>
**/
public static function getCfgTemplate()
{
$tpl = "\n" .
"\n" .
"USERNAME\n" .
"PASSWORD\n" .
"'http:///\n" .
"\n";
return $tpl;
}
}