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