github_dump.php

<?php 
// 
// A utility to dump github open issue & pr information.
//
// Usage guidelines:
// (1) Update User Configuration section below with info on your repo & user credentials.
// (2) Run it.
// (3) github_dump.csv will be in the directory where it was launched.
//     by sbulen
// 

//*** User Configuration
$owner = 'SimpleMachines';
$repo = 'SMF2.1';
$user = 'xxx';
$pwd = 'xxx';
//*** End User Configuration

//*** Main program
doStartup();
getInfo();
cleanUnusedColumns();
mapIssues();
exportInfo();
doWrapUp();
return;

//*** Startup 
function doStartup() {

	global $owner, $repo;

	// Without this header, flushes don't work...
	header( 'Content-type: text/html; charset=utf-8' );
	echo("<br>***********************************<br>");
	echo("******** Github export utility **********<br>");
	echo("***********************************<br><br>");

	echo("Owner: " . $owner . "<br>");
	echo("Repository: " . $repo . "<br>");

	// Yes, both flushes necessary
	@ob_flush();
	@flush();
	
	return;
}

//*** Get the full set of info from Github 
function getInfo() {

	global $githubAll, $user, $pwd, $owner, $repo, $gh_calls_remaining, $gh_calls_reset;

	// startup curl
	$ch = curl_init();
	curl_setopt_array($ch, array(
		CURLOPT_RETURNTRANSFER => true,
		CURLOPT_FOLLOWLOCATION => true,
		CURLOPT_SSL_VERIFYPEER => false,
		CURLOPT_SSL_VERIFYHOST => false,
		CURLOPT_VERBOSE => true,
		CURLOPT_USERAGENT => $user,
		CURLOPT_USERPWD => $pwd,
		CURLOPT_HEADERFUNCTION =>
			function($curl, $header) use (&$gha_header)
				{
					$len = strlen($header);
					// Split header into field & val
					$pos = strpos($header, ':');
					if ($pos === false) {
						$field = trim($header);
						$val =  '';
					}
					else {
						$field = trim(substr($header, 0, $pos));
						$val =  trim(substr($header, $pos + 1));
					}
					// Discard that empty row...
					if (empty($field))
						return $len;
					// Make this one readable, translate from unix timestamp...
					if ($field == 'X-RateLimit-Reset')
						$val = gmdate('M d Y H:i:s', $val) . ' GMT';
					// Populate gha_header.  Allow for multiples, e.g., happens with Vary
					if (!array_key_exists($field, $gha_header))
						$gha_header[$field] = $val;
					else
						$gha_header[$field] .= ', ' . $val;
					return $len;
				},
	));

	// Loop thru all the pages - 100 rows at a time
	$githubAll = array();
	$more = true;
	$page = 0;
	while ($more) {
		$more = false;
		$page++;

		// Init github API Header prior to each call
		$gha_header = array();
		curl_setopt($ch, CURLOPT_URL, 'https://api.github.com/repos/' . $owner . '/' . $repo . '/issues?per_page=100&page=' . $page);
		$githubAll_json = curl_exec($ch);
		curlErr($ch);

		// Save rate limit info
		if (isset($gha_header['X-RateLimit-Remaining']))
			$gh_calls_remaining = $gha_header['X-RateLimit-Remaining'];
		if (isset($gha_header['X-RateLimit-Reset']))
			$gh_calls_reset = $gha_header['X-RateLimit-Reset'];

		// Check status accessing repos
		if ($gha_header['Status'] != '200 OK') {
			if (isset($gh_calls_remaining))
				echo '<br>X-RateLimit-Remaining: ' . $gh_calls_remaining . '<br>';
			if (isset($gh_calls_reset))
				echo 'X-RateLimit-Reset: ' . $gh_calls_reset . '<br>';
			die('<br>Error accessing Github repository: ' . $gha_header['Status'] . '<br>');
		}

		// if next page link exists, there is more data to get & you have calls available to do so...
		if (!empty($gha_header['Link']) && strpos($gha_header['Link'], 'rel="next"') && !empty($gh_calls_reset))
			$more = true;

		// If successful response, dump it into an array
		if ($githubAll_json !== false)
			$githubAll = array_merge($githubAll, json_decode($githubAll_json, true));
	}
	curl_close($ch);
	return;
}

//*** Way too much stuff, strip most of it...
function cleanUnusedColumns() {

	global $githubAll;

	// Put the header row in there...
	$githubTemp[0] = array(
				'type', 
				'number',
				'title',
				'login',
				'labels',
				'assignees',
				'milestone',
				'comments',
				'fixes issues',
				'issue milestones',
				'body',
				'created_at',
	);

	foreach($githubAll as $row) {
		$githubTemp[$row['number']] = array(
			empty($row['pull_request']) ? 'Issue' : 'PR',
			$row['number'],
			$row['title'],
			$row['user']['login'],
			col2csv($row['labels'], 'name'),
			col2csv($row['assignees'], 'login'),
			$row['milestone']['title'],
			$row['comments'],
			'',		// populated later
			'',		// populated later
			$row['body'],
			substr($row['created_at'],0,10),
		);
	}
	$githubAll = $githubTemp;
	return;
}

//*** Pluck a column out of array into a comma delimited string
function col2csv($labels, $col) {

	$values = array_column($labels, $col);
	$lstring = implode(', ', $values);
	return $lstring;
}

//*** Find issues and issue milestones associated with PRs
function mapIssues() {

	global $githubAll;
	$pattern = '/(\/|#)(\d{1,8})/';

	// check whole table
	foreach($githubAll as $ix => $row) {	
		//Look at each PR...
		if ($row[0] == 'PR') {
			// allow for multiple matches of #9999 or /9999 (when folks use links) in body of issue (10th field)
			preg_match_all($pattern, $row[10], $matches);
			foreach ($matches[2] AS $match) {
				// finally look for active issue entries
				if (array_key_exists($match, $githubAll) && $githubAll[$match][0] == 'Issue') {
					// add issue number
					if (empty($githubAll[$ix][8]))
						$githubAll[$ix][8] = $githubAll[$match][1];
					else
						$githubAll[$ix][8] .= ', ' . $githubAll[$match][1];
					// add milestone info
					if (!empty($githubAll[$match][6])) {
						if (empty($githubAll[$ix][9]))
							$githubAll[$ix][9] = $githubAll[$match][6];
						else
							$githubAll[$ix][9] .= ', ' . $githubAll[$match][6];
					}
				}
			}
		}
	}

	// Done with the message body - delete it
	foreach($githubAll AS $ix => $row)
		unset($githubAll[$ix][10]);

	return;
}

// Dump to screen and to .csv
function exportInfo() {

	global $githubAll;

	dumpTable($githubAll);

	$fp = fopen('github_dump.csv', 'w');
	if ($fp === false)
		die ("Cannot open github_dump.csv");

	foreach($githubAll AS $row)
		fputcsv($fp, $row);
	fclose($fp);

	return;
}

//*** Check for curl error
function curlErr($ch) {

	// Check for errors and display the error message
	if($errno = curl_errno($ch)) {
		$error_message = curl_strerror($errno);
		die("cURL error ({$errno}):\n {$error_message}");
	}
	return;
}

//*** Wrap Up 
function doWrapUp() {

	global $gh_calls_remaining, $gh_calls_reset;
	
	echo "<br>Completed!<br><br>";
	if (isset($gh_calls_remaining))
		echo 'X-RateLimit-Remaining: ' . $gh_calls_remaining . '<br>';
	if (isset($gh_calls_reset))
		echo 'X-RateLimit-Reset: ' . $gh_calls_reset . '<br><br>';
	
	// Yes, both flushes necessary
	@ob_flush();
	@flush();	
	return;
}

//*** Dump Table
// Takes a simple 2 dimensional array & dumps it in table format
function dumpTable($passedArray) {
	echo '<br><table border="1" cellpadding="3" frame="border" rules="all">';
	foreach($passedArray as $row) {
		echo '<tr><td>';
		echo implode('</td><td>', $row);
		echo '</td></tr>';
	}
	echo '</table><br>';
	@ob_flush();
	@flush();	
	return;
}