summaryrefslogtreecommitdiff
path: root/bridges/GithubIssueBridge.php
blob: 91dd45ec12d312506fb6e09de013fdd8a1dc6e44 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
<?php
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');
		switch($this->queriedContext) {
		case 'Project Issues':
			$prefix = static::NAME . 's for ';
			if($this->getInput('c')) {
				$prefix = static::NAME . 's comments for ';
			}
			$name = $prefix . $name;
			break;
		case 'Issue comments':
			$name = static::NAME . ' ' . $name . ' #' . $this->getInput('i');
			break;
		default: return parent::getName();
		}
		return $name;
	}

	public function getURI(){
		if(null !== $this->getInput('u') && null !== $this->getInput('p')) {
			$uri = static::URI . $this->getInput('u') . '/'
				. $this->getInput('p') . '/issues';
			if($this->queriedContext === 'Issue comments') {
				$uri .= '/' . $this->getInput('i');
			} elseif($this->getInput('c')) {
				$uri .= '?q=is%3Aissue+sort%3Aupdated-desc';
			}
			return $uri;
		}

		return parent::getURI();
	}

	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;

		$title .= ' / ' . trim($comment->plaintext);

		$content = $title;
		if (null !== $comment->nextSibling()) {
			$content = $comment->nextSibling()->innertext;
			if ($comment->nextSibling()->nodeName() === 'span') {
				$content = $comment->nextSibling()->nextSibling()->innertext;
			}
		}

		$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){
		$uri = static::URI . $this->getInput('u') . '/'
			. $this->getInput('p') . '/issues/' . $issueNbr;

		$author = $comment->find('.author', 0)->plaintext;

		$title .= ' / ' . trim(
			$comment->find('.comment .timeline-comment-header-text', 0)->plaintext
		);

		$content = $comment->find('.comment-body', 0)->innertext;

		$item = array();
		$item['author'] = $author;
		$item['uri'] = $uri
			. '#' . $comment->firstChild()->nextSibling()->getAttribute('id');
		$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 extractIssueComments($issue){
		$items = array();
		$title = $issue->find('.gh-header-title', 0)->plaintext;
		$issueNbr = trim(
			substr($issue->find('.gh-header-number', 0)->plaintext, 1)
		);
		$comments = $issue->find('.js-discussion', 0);
		foreach($comments->children() as $comment) {
			if (!$comment->hasChildNodes()) {
				continue;
			}
			$comment = $comment->firstChild();
			$classes = explode(' ', $comment->getAttribute('class'));
			if (in_array('timeline-comment-wrapper', $classes)) {
				$item = $this->extractIssueComment($issueNbr, $title, $comment);
				$items[] = $item;
				continue;
			}
			while (in_array('discussion-item', $classes)) {
				$item = $this->extractIssueEvent($issueNbr, $title, $comment);
				$items[] = $item;
				$comment = $comment->nextSibling();
				if (null == $comment) {
					break;
				}
				$classes = explode(' ', $comment->getAttribute('class'));
			}
		}
		return $items;
	}

	public function collectData(){
		$html = getSimpleHTMLDOM($this->getURI())
			or returnServerError(
				'No results for Github Issue ' . $this->getURI()
			);

		switch($this->queriedContext) {
		case 'Issue comments':
			$this->items = $this->extractIssueComments($html);
			break;
		case 'Project Issues':
			foreach($html->find('.js-active-navigation-container .js-navigation-item') as $issue) {
				$info = $issue->find('.opened-by', 0);
				$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;
					$issue = getSimpleHTMLDOMCached($uri, static::CACHE_TIMEOUT);
					if($issue) {
						$this->items = array_merge(
							$this->items,
							$this->extractIssueComments($issue)
						);
						continue;
					}
					$item['content'] = 'Can not extract comments from ' . $uri;
				}

				$item['author'] = $info->find('a', 0)->plaintext;
				$item['timestamp'] = strtotime(
					$info->find('relative-time', 0)->getAttribute('datetime')
				);
				$item['title'] = html_entity_decode(
					$issue->find('.js-navigation-open', 0)->plaintext,
					ENT_QUOTES,
					'UTF-8'
				);
				$comments = trim($issue->find('.col-5', 0)->plaintext);
				$item['content'] .= "\n" . 'Comments: ' . ($comments ? $comments : '0');
				$item['uri'] = self::URI
					. $issue->find('.js-navigation-open', 0)->getAttribute('href');
				$this->items[] = $item;
			}
			break;
		}

		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']);
		});
	}
}