'its_duedate_with_separator');
private $soapOpt = array("connection_timeout" => 1, 'exceptions' => 1);
private $issueDefaults;
private $issueAttr = null;
var $defaultResolvedStatus;
var $support;
/**
* Construct and connect to BTS.
*
* @param str $type (see tlIssueTracker.class.php $systems property)
* @param xml $cfg
**/
function __construct($type,$config,$name)
{
$this->name = $name;
$this->interfaceViaDB = false;
$this->support = new jiraCommons();
$this->support->guiCfg = array('use_decoration' => true);
$proxyCfg = config_get('proxy');
if(!is_null($proxyCfg->host))
{
$key2loop = array('host','port','login','password');
foreach($key2loop as $fi)
{
if(!is_null($proxyCfg->$fi))
{
$this->soapOpt['proxy_' . $fi] = $proxyCfg->$fi;
}
}
}
$this->methodOpt = array('buildViewBugLink' => array('addSummary' => true, 'colorByStatus' => true));
if( $this->setCfg($config) )
{
$this->completeCfg();
$this->connect();
$this->guiCfg = array('use_decoration' => true);
// Attention has to be done AFTER CONNECT OK, because we need info setted there
if( $this->isConnected())
{
$this->setResolvedStatusCfg();
}
}
}
/**
*
* 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()
{
$step = 1; // just for debug
$base = trim($this->cfg->uribase,"/") . '/' ;
if( !property_exists($this->cfg,'uriwsdl') )
{
//DEBUG-echo __FUNCTION__ . "::Debug::Step#$step Going To Add uriwsdl
";$step++;
$this->cfg->uriwsdl = $base . 'rpc/soap/jirasoapservice-v2?wsdl';
}
if( !property_exists($this->cfg,'uriview') )
{
//DEBUG-echo __FUNCTION__ . "::Debug::Step#$step Going To Add uriview
";$step++;
$this->cfg->uriview = $base . 'browse/';
}
if( !property_exists($this->cfg,'uricreate') )
{
//DEBUG-echo __FUNCTION__ . "::Debug::Step#$step Going To Add uricreate
";$step++;
$this->cfg->uricreate = $base . 'secure/CreateIssue!default.jspa';
}
if( property_exists($this->cfg,'attributes') )
{
// echo __FUNCTION__ . "::Debug::Step#$step Going To Add attributes
";$step++;
$this->processAttributes();
}
$this->issueDefaults = array('issuetype' => 1);
foreach($this->issueDefaults as $prop => $default)
{
if(!isset($this->issueAttr[$prop]))
{
$this->issueAttr[$prop] = $default;
}
// $this->cfg->$prop = (string)(property_exists($this->cfg,$prop) ? $this->cfg->$prop : $default);
}
}
/**
* @internal precondition: TestLink has to be connected to Jira
*
* @param string issueID
*
**/
function getIssue($issueID)
{
$issue = null;
try
{
$issue = $this->APIClient->getIssue($this->authToken, $issueID);
if(!is_null($issue) && is_object($issue))
{
// We are going to have a set of standard properties
$issue->id = $issueID;
$issue->IDHTMLString = "{$issueID} : ";
$issue->statusCode = $issue->status;
$issue->statusVerbose = array_search($issue->statusCode, $this->statusDomain);
$issue->statusHTMLString = $this->support->buildStatusHTMLString($issue->statusVerbose);
$issue->summaryHTMLString = $this->support->buildSummaryHTMLString($issue);
$issue->isResolved = isset($this->resolvedStatus->byCode[$issue->statusCode]);
}
}
catch (Exception $e)
{
tLog("JIRA Ticket ID $issueID - " . $e->getMessage(), 'WARNING');
$issue = null;
}
return $issue;
}
/**
* checks id for validity
*
* @param string issueID
*
* @return bool returns true if the bugid has the right format
**/
function checkBugIDSyntax($issueID)
{
return $this->checkBugIDSyntaxString($issueID);
}
/**
* establishes connection to the bugtracking system
*
* @return bool returns true if the soap connection was established and the
* wsdl could be downloaded, false else
*
**/
function connect()
{
$this->interfaceViaDB = false;
$op = $this->getClient(array('log' => true));
// echo '
OP
';var_dump($op);
if( ($this->connected = $op['connected']) )
{
// OK, we have got WSDL => server is up and we can do SOAP calls, but now we need
// to do a simple call with user/password only to understand if we are really connected
try
{
$this->APIClient = $op['client'];
$this->authToken = $this->APIClient->login($this->cfg->username, $this->cfg->password);
$statusSet = $op['client']->getStatuses($this->authToken);
foreach ($statusSet as $key => $pair)
{
$this->statusDomain[$pair->name]=$pair->id;
}
$this->defaultResolvedStatus = $this->support->initDefaultResolvedStatus($this->statusDomain);
$this->l18n = init_labels($this->labels);
}
catch (SoapFault $f)
{
$this->connected = false;
$msg = __CLASS__ . " - SOAP Fault: (code: {$f->faultcode}, string: {$f->faultstring})";
// echo $msg;
tLog($msg,"ERROR");
}
}
return $this->connected;
}
/**
*
*
**/
function isConnected()
{
return $this->connected;
}
/**
*
*
**/
function getClient($opt=null)
{
// IMPORTANT NOTICE - 2012-01-06 - If you are using XDEBUG, Soap Fault will not work
$res = array('client' => null, 'connected' => false, 'msg' => 'generic ko');
$my['opt'] = array('log' => false);
$my['opt'] = array_merge($my['opt'],(array)$opt);
try
{
// IMPORTANT NOTICE
// $this->cfg is a simpleXML object, then is ABSOLUTELY CRITICAL
// DO CAST any member before using it.
// If we do following call WITHOUT (string) CAST, SoapClient() fails
// complaining '... wsdl has to be an STRING or null ...'
//
$res['client'] = new SoapClient((string)$this->cfg->uriwsdl,$this->soapOpt);
$res['connected'] = true;
$res['msg'] = 'iupi!!!';
}
catch (SoapFault $f)
{
$res['connected'] = false;
$res['msg'] = "SOAP Fault: (code: {$f->faultcode}, string: {$f->faultstring})";
if($my['opt']['log'])
{
tLog("SOAP Fault: (code: {$f->faultcode}, string: {$f->faultstring})","ERROR");
}
}
return $res;
}
/**
*
* @author francisco.mancardi@gmail.com>
**/
public static function getCfgTemplate()
{
$template = "\n" .
"\n" .
"JIRA LOGIN NAME\n" .
"JIRA PASSWORD\n" .
"http://testlink.atlassian.net/\n" .
"http://testlink.atlassian.net/rpc/soap/jirasoapservice-v2?wsdl\n" .
"testlink.atlassian.net/browse/\n" .
"testlink.atlassian.net/secure/CreateIssue!default.jspa\n" .
"\n" .
"JIRA PROJECT KEY\n" .
"JIRA ISSUE TYPE\n" .
"\n" .
"\n" .
" --> \n" .
" \n" .
" \n" .
" customfield_10800\n" .
" 111\n" .
" \n" .
" \n" .
" customfield_10900\n" .
" Yamaha Factory RacingDucati\n" .
" \n" .
" \n" .
" -->\n" .
"\n" .
"\n" .
"5Resolved\n" .
"6Closed\n" .
"\n" .
"\n";
return $template;
}
/**
*
* @author francisco.mancardi@gmail.com>
**/
public function getStatusDomain()
{
return $this->statusDomain;
}
public static function checkEnv()
{
$ret = array();
$ret['status'] = extension_loaded('soap');
$ret['msg'] = $ret['status'] ? 'OK' : 'You need to enable SOAP extension';
return $ret;
}
// useful info
// https://github.com/ricardocasares/jira-soap-api
//
// CRITIC ISSUE TYPE IS MANDATORY.
//
public function addIssue($summary,$description)
{
try
{
$issue = array('project' => (string)$this->cfg->projectkey,
'type' => (int)$this->cfg->issuetype,
'summary' => $summary,
'description' => $description);
if(!is_null($this->issueAttr))
{
$issue = array_merge($issue,$this->issueAttr);
}
//DEBUG-echo 'This Will Be Sent to JIRA
';echo '';var_dump($issue);echo '
';
$op = $this->APIClient->createIssue($this->authToken, $issue);
$ret = array('status_ok' => true, 'id' => $op->key,
'msg' => sprintf(lang_get('jira_bug_created'),$summary,$issue['project']));
}
catch (Exception $e)
{
$msg = "Create JIRA Ticket FAILURE => " . $e->getMessage();
tLog($msg, 'WARNING');
$ret = array('status_ok' => false, 'id' => -1, 'msg' => $msg . ' - serialized issue:' . serialize($issue));
}
return $ret;
}
/**
*
* If connection fails $this->defaultResolvedStatus is null
*
*/
public function setResolvedStatusCfg()
{
if( property_exists($this->cfg,'resolvedstatus') )
{
$statusCfg = (array)$this->cfg->resolvedstatus;
}
else
{
$statusCfg['status'] = $this->defaultResolvedStatus;
}
$this->resolvedStatus = new stdClass();
$this->resolvedStatus->byCode = array();
if(!is_null($statusCfg['status']))
{
foreach($statusCfg['status'] as $cfx)
{
$e = (array)$cfx;
$this->resolvedStatus->byCode[$e['code']] = $e['verbose'];
}
}
$this->resolvedStatus->byName = array_flip($this->resolvedStatus->byCode);
}
/**
*
*/
public function addIssueFromArray($issue)
{
try
{
$op = $this->APIClient->createIssue($this->authToken, $issue);
$ret = array('status_ok' => true, 'id' => $op->key,
'msg' => sprintf(lang_get('jira_bug_created'),$summary,$issue['project']));
}
catch (Exception $e)
{
$msg = "Create JIRA Ticket FAILURE => " . $e->getMessage();
tLog($msg, 'WARNING');
$ret = array('status_ok' => false, 'id' => -1, 'msg' => $msg . ' - serialized issue:' . serialize($issue));
}
return $ret;
}
/**
*
**/
function canCreateViaAPI()
{
return (property_exists($this->cfg, 'projectkey') &&
property_exists($this->cfg, 'issuetype'));
}
/**
*
**/
function processAttributes()
{
$attr = get_object_vars($this->cfg->attributes);
foreach ($attr as $name => $elem)
{
$name = (string)$name;
switch($name)
{
case 'customFieldValues':
$this->getCustomFieldsAttribute($name,$elem);
break;
case 'affectsVersions':
$this->getAffectsVersionsAttribute($name,$elem);
break;
default:
$this->getRelaxedAttribute($name,$elem);
break;
}
}
}
/**
*
**/
function getRelaxedAttribute($name,$elem)
{
if( is_object($elem) )
{
$ovars = get_object_vars($elem);
$cc = (array)current($ovars);
$kk = key($ovars);
foreach($cc as $value)
{
$this->issueAttr[$name][] = array($kk => (string)$value);
}
}
else
{
$this->issueAttr[$name] = (string)$elem;
}
}
/**
*
*
**/
function getCustomFieldsAttribute($name,$objCFSet)
{
// loop on fields of a Custom Field
// According to JIRA Documentation and some hands on examples
// customfieldId, key, values => has to be sent as an array
//
$elem = get_object_vars($objCFSet);
$elem = $elem['customField'];
// Because how XML works, when we have ONLY one CF we do not get an array,
// but only when we have more.
// This forces us to do this kind of processing => cast always to an array,
// but paying special attention to complex elements.
// Remember we get data from simpleXML processing
//
if(is_object($elem))
{
$elem = array($elem);
}
foreach ($elem as $item)
{
// dev notes
// key attribute is not managed yet
// may be trim on each $item->values->value will be good
$this->issueAttr[$name][] = array('customfieldId' => trim((string)$item->customfieldId),
'values' => (array)$item->values->value);
}
}
/**
*
*
*
* 10000
*
*
*
*
* 10002
*
*
*
*
*
*
**/
function getAffectsVersionsAttribute($name,$objItemSet)
{
$elem = get_object_vars($objItemSet);
$elem = $elem['version'];
// Because how XML works, when we have ONLY one CF we do not get an array,
// but only when we have more.
// This forces us to do this kind of processing => cast always to an array,
// but paying special attention to complex elements.
// Remember we get data from simpleXML processing
//
if(is_object($elem))
{
$elem = array($elem);
}
foreach ($elem as $item)
{
$this->issueAttr[$name][] = array('id' => trim((string)$item->id),
'archived' => trim((string)$item->archived),
'released' => trim((string)$item->released));
}
}
}