2016-06-26 00:33:27 +02:00
|
|
|
<?php
|
|
|
|
class GithubIssueBridge extends BridgeAbstract{
|
|
|
|
|
2016-08-30 11:23:55 +02:00
|
|
|
const MAINTAINER = 'Pierre Mazière';
|
|
|
|
const NAME = 'Github Issue';
|
|
|
|
const URI = 'https://github.com/';
|
2016-09-25 17:04:28 +02:00
|
|
|
const CACHE_TIMEOUT = 600; // 10min
|
2016-08-30 11:23:55 +02:00
|
|
|
const DESCRIPTION = 'Returns the issues or comments of an issue of a github project';
|
2016-06-26 00:33:27 +02:00
|
|
|
|
2016-08-30 11:23:55 +02:00
|
|
|
const PARAMETERS=array(
|
2016-08-27 21:03:26 +02:00
|
|
|
'global'=>array (
|
2016-08-22 01:25:56 +02:00
|
|
|
'u'=>array(
|
|
|
|
'name'=>'User name',
|
|
|
|
'required'=>true
|
|
|
|
),
|
|
|
|
'p'=>array(
|
|
|
|
'name'=>'Project name',
|
|
|
|
'required'=>true
|
2016-08-23 20:29:29 +02:00
|
|
|
)
|
2016-08-27 21:03:26 +02:00
|
|
|
),
|
2016-08-23 20:29:29 +02:00
|
|
|
|
2016-09-19 23:52:44 +02:00
|
|
|
'Project Issues'=>array(
|
|
|
|
'c'=>array(
|
|
|
|
'name'=>'Show Issues Comments',
|
|
|
|
'type'=>'checkbox'
|
|
|
|
)
|
|
|
|
),
|
2016-08-27 21:03:26 +02:00
|
|
|
'Issue comments'=>array(
|
2016-08-22 01:25:56 +02:00
|
|
|
'i'=>array(
|
|
|
|
'name'=>'Issue number',
|
|
|
|
'type'=>'number',
|
2016-08-23 20:29:29 +02:00
|
|
|
'required'=>'true'
|
2016-08-22 01:25:56 +02:00
|
|
|
)
|
2016-08-27 21:03:26 +02:00
|
|
|
)
|
|
|
|
);
|
2016-06-26 00:33:27 +02:00
|
|
|
|
2016-09-10 11:44:55 +02:00
|
|
|
public function getName(){
|
|
|
|
$name=$this->getInput('u').'/'.$this->getInput('p');
|
|
|
|
switch($this->queriedContext){
|
|
|
|
case 'Project Issues':
|
2016-09-19 23:52:44 +02:00
|
|
|
if($this->getInput('c')){
|
|
|
|
$prefix=static::NAME.'s comments for ';
|
|
|
|
}else{
|
|
|
|
$prefix=static::NAME.'s for ';
|
|
|
|
}
|
|
|
|
$name=$prefix.$name;
|
2016-09-10 11:44:55 +02:00
|
|
|
break;
|
|
|
|
case 'Issue comments':
|
|
|
|
$name=static::NAME.' '.$name.' #'.$this->getInput('i');
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
return $name;
|
|
|
|
}
|
|
|
|
|
|
|
|
public function getURI(){
|
2016-09-19 23:52:44 +02:00
|
|
|
$uri = static::URI.$this->getInput('u').'/'.$this->getInput('p').'/issues';
|
2016-09-10 11:44:55 +02:00
|
|
|
if($this->queriedContext==='Issue comments'){
|
2016-09-19 23:52:44 +02:00
|
|
|
$uri.='/'.$this->getInput('i');
|
|
|
|
}else if($this->getInput('c')){
|
|
|
|
$uri.='?q=is%3Aissue+sort%3Aupdated-desc';
|
2016-09-10 11:44:55 +02:00
|
|
|
}
|
|
|
|
return $uri;
|
|
|
|
}
|
|
|
|
|
2016-09-19 23:52:44 +02:00
|
|
|
protected function extractIssueComment($issueNbr,$title,$comment){
|
2016-09-23 14:15:07 +02:00
|
|
|
$class=$comment->getAttribute('class');
|
|
|
|
$classes=explode(' ',$class);
|
|
|
|
$event=false;
|
|
|
|
if(in_array('discussion-item',$classes)){
|
|
|
|
$event=true;
|
|
|
|
}
|
|
|
|
|
|
|
|
$author='unknown';
|
|
|
|
if($comment->find('.author',0)){
|
|
|
|
$author=$comment->find('.author',0)->plaintext;
|
|
|
|
}
|
|
|
|
|
|
|
|
$uri=static::URI.$this->getInput('u').'/'.$this->getInput('p').'/issues/'
|
|
|
|
.$issueNbr;
|
2016-06-26 00:33:27 +02:00
|
|
|
|
2016-09-23 14:15:07 +02:00
|
|
|
$comment=$comment->firstChild();
|
|
|
|
if(!$event){
|
|
|
|
$comment=$comment->nextSibling();
|
|
|
|
}
|
2016-06-26 00:33:27 +02:00
|
|
|
|
2016-09-23 14:15:07 +02:00
|
|
|
if($event){
|
|
|
|
$title.=' / '.substr($class,strpos($class,'discussion-item-')+strlen('discussion-item-'));
|
|
|
|
if(!$comment->hasAttribute('id')){
|
|
|
|
$items=array();
|
|
|
|
$timestamp=strtotime($comment->find('relative-time',0)->getAttribute('datetime'));
|
|
|
|
$content=$comment->innertext;
|
|
|
|
while($comment=$comment->nextSibling()){
|
|
|
|
$item=array();
|
|
|
|
$item['author']=$author;
|
|
|
|
$item['title']=html_entity_decode($title,ENT_QUOTES,'UTF-8');
|
|
|
|
$item['timestamp']=$timestamp;
|
|
|
|
$item['content']=$content.'<p>'.$comment->children(1)->innertext.'</p>';
|
|
|
|
$item['uri']=$uri.'#'.$comment->children(1)->getAttribute('id');
|
|
|
|
$items[]=$item;
|
|
|
|
}
|
|
|
|
return $items;
|
|
|
|
}
|
|
|
|
$content=$comment->parent()->innertext;
|
|
|
|
}else{
|
|
|
|
$title.=' / '.trim($comment->firstChild()->plaintext);
|
|
|
|
$content="<pre>".$comment->find('.comment-body',0)->innertext."</pre>";
|
|
|
|
}
|
|
|
|
|
|
|
|
$item = array();
|
|
|
|
$item['author']=$author;
|
|
|
|
$item['uri']= $uri.'#'.$comment->getAttribute('id');
|
2016-09-20 00:21:42 +02:00
|
|
|
$item['title']=html_entity_decode($title,ENT_QUOTES,'UTF-8');
|
2016-09-19 23:52:44 +02:00
|
|
|
$item['timestamp']=strtotime($comment->find('relative-time',0)->getAttribute('datetime'));
|
2016-09-23 14:15:07 +02:00
|
|
|
$item['content']=$content;
|
2016-09-19 23:52:44 +02:00
|
|
|
return $item;
|
|
|
|
}
|
2016-06-26 00:33:27 +02:00
|
|
|
|
2016-09-19 23:52:44 +02:00
|
|
|
protected function extractIssueComments($issue){
|
|
|
|
$items=array();
|
|
|
|
$title=$issue->find('.gh-header-title',0)->plaintext;
|
|
|
|
$issueNbr=trim(substr($issue->find('.gh-header-number',0)->plaintext,1));
|
2016-09-23 14:15:07 +02:00
|
|
|
$comments=$issue->find('.js-discussion',0);
|
|
|
|
foreach($comments->children() as $comment){
|
|
|
|
$classes=explode(' ',$comment->getAttribute('class'));
|
|
|
|
if(in_array('discussion-item',$classes) ||
|
|
|
|
in_array('timeline-comment-wrapper',$classes)
|
|
|
|
){
|
|
|
|
$item=$this->extractIssueComment($issueNbr,$title,$comment);
|
|
|
|
if(array_keys($item)!==range(0,count($item)-1)){
|
|
|
|
$item=array($item);
|
|
|
|
}
|
|
|
|
$items=array_merge($items,$item);
|
|
|
|
}
|
2016-09-19 23:52:44 +02:00
|
|
|
}
|
|
|
|
return $items;
|
|
|
|
}
|
2016-06-26 00:33:27 +02:00
|
|
|
|
2016-09-19 23:52:44 +02:00
|
|
|
public function collectData(){
|
2016-09-25 23:22:33 +02:00
|
|
|
$html = getSimpleHTMLDOM($this->getURI())
|
|
|
|
or returnServerError('No results for Github Issue '.$this->getURI());
|
2016-09-19 23:52:44 +02:00
|
|
|
|
|
|
|
switch($this->queriedContext){
|
|
|
|
case 'Issue comments':
|
|
|
|
$this->items=$this->extractIssueComments($html);
|
2016-08-29 00:12:42 +02:00
|
|
|
break;
|
|
|
|
case 'Project Issues':
|
2016-08-23 20:29:29 +02:00
|
|
|
foreach($html->find('.js-active-navigation-container .js-navigation-item') as $issue){
|
|
|
|
$info=$issue->find('.opened-by',0);
|
2016-09-19 23:52:44 +02:00
|
|
|
$issueNbr=substr(trim($info->plaintext),1,strpos(trim($info->plaintext),' '));
|
|
|
|
|
|
|
|
$item=array();
|
|
|
|
$item['content']='';
|
|
|
|
|
|
|
|
if($this->getInput('c')){
|
|
|
|
$uri=static::URI.$this->getInput('u').'/'.$this->getInput('p').'/issues/'.$issueNbr;
|
2016-10-02 16:05:58 +02:00
|
|
|
$issue=getSimpleHTMLDOMCached($uri,static::CACHE_TIMEOUT);
|
2016-09-19 23:52:44 +02:00
|
|
|
if($issue){
|
|
|
|
$this->items=array_merge($this->items,$this->extractIssueComments($issue));
|
|
|
|
continue;
|
|
|
|
}
|
|
|
|
$item['content']='Can not extract comments from '.$uri;
|
|
|
|
}
|
|
|
|
|
2016-08-23 20:29:29 +02:00
|
|
|
$item['author']=$info->find('a',0)->plaintext;
|
|
|
|
$item['timestamp']=strtotime($info->find('relative-time',0)->getAttribute('datetime'));
|
2016-09-20 00:21:42 +02:00
|
|
|
$item['title']=html_entity_decode(
|
|
|
|
$issue->find('.js-navigation-open',0)->plaintext,
|
|
|
|
ENT_QUOTES,
|
|
|
|
'UTF-8'
|
|
|
|
);
|
2016-08-29 00:12:42 +02:00
|
|
|
$comments=$issue->find('.col-5',0)->plaintext;
|
2016-09-19 23:52:44 +02:00
|
|
|
$item['content'].="\n".'Comments: '.($comments?$comments:'0');
|
2016-08-30 11:23:55 +02:00
|
|
|
$item['uri']=self::URI.$issue->find('.js-navigation-open',0)->getAttribute('href');
|
2016-08-23 20:29:29 +02:00
|
|
|
$this->items[]=$item;
|
|
|
|
}
|
2016-08-29 00:12:42 +02:00
|
|
|
break;
|
2016-06-26 00:33:27 +02:00
|
|
|
}
|
2016-09-23 14:15:07 +02:00
|
|
|
|
|
|
|
array_walk($this->items, function(&$item){
|
|
|
|
$item['content']=preg_replace('/\s+/',' ',$item['content']);
|
|
|
|
$item['content']=str_replace('href="/','href="'.static::URI,$item['content']);
|
|
|
|
$item['content']=str_replace(
|
|
|
|
'href="#',
|
|
|
|
'href="'.substr($item['uri'],0,strpos($item['uri'],'#')+1),
|
|
|
|
$item['content']
|
|
|
|
);
|
|
|
|
$item['title']=preg_replace('/\s+/',' ',$item['title']);
|
|
|
|
});
|
2016-06-26 00:33:27 +02:00
|
|
|
}
|
|
|
|
}
|