Redmine2Github.php

<?php

/**
 * redmine2github
 * Copyright (C) 2012 MEN AT WORK
 *
 * PHP version 5
 * @copyright MEN AT WORK 2012
 * @author Andreas Isaak <cms@men-at-work.de>
 * @author Stefan Heimes <cms@men-at-work.de>
 * @author Yanick Witschi <yanick.witschi@certo-net.ch>
 * @package redmine2github
 * @license LGPL
 * @filesource
 */
class Redmine2Github
{
	/**
	 * Search patterns for the description
	 */
	protected $arrSearch = array
	(
		'/`/',
		'/([^ ]+)@([a-z0-9\.-]+\.[a-z]{2,6})/i',
		'/\n*<pre>\n?<code class="([^"]+)">\n?/',
		'/\n*<pre>\n?/',
		'/\n?<\/code>\n?<\/pre>\n*/',
		'/\n?<\/pre>\n*/',
		'/\[(http[^\]]+)\]/',
		'/"([^"]+)":(http[^\) \n]+)/',
		'/"([^"]+)":([^\) \?\n]+)/',
		'/@([^@]+)@/',
		'/Replying to "[^"]+":[^:]+:\n?/',
		'/Replying to \[[^\]]+\]:\n?/',
		'/[^ ]+ wrote:\n?/',
		'/#comment:[0-9]+/',
		'/---+/',
		'/\*([^\*\n]+)\*/',
		'/\n\*\* /',
		'/\n*!([^-][^!]+)!/',
		'/commit:/',
	);

	/**
	 * Replacement patterns for the description
	 */
	protected $arrReplace = array
	(
		"'",
		'$1[_at_]$2',
		"\n\n```$1\n",
		"\n\n```\n",
		"\n```\n\n",
		"\n```\n\n",
		'$1',
		'[$1]($2)',
		'[$1]($2)',
		'`$1`',
		'123',
		'123',
		'123',
		'123',
		'```',
		'**$1**',
		"\n* ",
		"\n\n![]($1)",
		'',
	);


	/* -------------------------------------------------------------------------
	 * Core Part
	 */
	protected $strPath = '';
	protected $arrCSV = '';
	protected $arrLabels = array();
	protected $arrIssues = array();
	protected $arrMilestones = array();
	protected $blnOneTicketOnly = false;
	protected $intTicketId = 0;
	protected $arrConfig = array();
	protected $blnLogTicketRelations = false;
	protected $strTicketLogginTpl = 'tl_template.tpl';
	protected $arrTicketRelations = array();


	/**
	 * Basic usage:
	 * php Redmine2Github.php
	 * 
	 * It will get the default config "config.php" but you can specify another if you like (to easily switch)
	 * php Redmine2Github.php config:myconfig
	 * 
	 * You can also import one ticket only for testing purposes
	 * php Redmine2Github.php 133
	 */
	public function __construct()
	{
		$strConfig = 'config.php';
		
		// args
		array_shift($_SERVER['argv']);
		$arrArgs = $_SERVER['argv'];
		
		if (!is_array($arrArgs))
		{
			$arrArgs = array();
		}
		
		foreach ($arrArgs as $arg)
		{
			// custom config
			if (strpos($arg, 'config:') !== false)
			{
				$chunks = explode(':', $arg);
				$strConfig = $chunks[1] . '.php';
			}

			// one ticket only
			if (is_numeric($arg))
			{
				$this->blnOneTicketOnly = true;
				$this->intTicketId = (int) $arg;
			}

			// ticket relation logging
			if (strpos($arg, 'tl:') !== false)
			{
				$chunks = explode(':', $arg);
				$this->strTicketLogginTpl = $chunks[1] . '.tpl';
				$this->blnLogTicketRelations = true;
			}
		}

		$this->strPath = getcwd();

		// load config
		if (!file_exists($this->strPath . '/' . $strConfig))
		{
			throw new Exception("Configuration file $strConfig could not be loaded.");
		}
		
		include_once $this->strPath . '/' . $strConfig;
		
		$this->arrConfig = $arrRedmine2GithubConfig;
	}

	/**
	 * Main function for export/import
	 */
	public function run()
	{
		// Run CSV
		$this->checkFile();
		$this->importCSV();

		// Run issues
		$this->getAllIssues();

		// Run Labels
		$this->getAllLabels();
		$this->runUpdateLabels();

		// Run milestones
		$this->getAllMilestones();

		// Build Issue
		$this->runImportIssues();
		
		if ($this->blnLogTicketRelations)
		{
			$this->logTicketRelations();
		}

		echo "Done\n";
	}

	/**
	 * Create new labels, if not exists
	 */
	protected function runUpdateLabels()
	{
		$arrInsert = array();

		foreach ($this->arrConfig['labels'] as $key => $value)
		{
			if (!key_exists($value['name'], $this->arrLabels) && !in_array($value['name'], $arrInsert))
			{
				if (!$this->addNewLabel($value['name'], $value['color']))
				{
					unset($this->arrConfig['labels'][$key]);
					echo 'Could not add new label: ' . $value['name'] . " \n<br>\n";
				}
				else
				{
					$arrInsert[] = $value['name'];
				}
			}
		}
	}

	/**
	 * Import/Update all issues from csv
	 */
	protected function runImportIssues()
	{
		// Build Issue
		foreach ($this->arrCSV as $key => $value)
		{
			// Skip empty entries
			if (empty($value))
			{
				continue;
			}
			
			// utf8 encode otherwise json_encode will generate null
			$value = array_map('utf8_encode', $value);

			//  Init some vars
			$arrAdditionalContent = array();
			$strUsername = '';
			$strPassword = '';

			// User lookup
			if (key_exists($value['Author'], $this->arrConfig['users']))
			{
				$strUsername = $this->arrConfig['users'][$value['Author']]['login'];
				$strPassword = $this->arrConfig['users'][$value['Author']]['password'];
			}
			else if (is_array($this->arrConfig['users']) && count($this->arrConfig['users']) > 0)
			{
				$arrKeys = array_keys($this->arrConfig['users']);

				$strUsername = $this->arrConfig['users'][$arrKeys[0]]['login'];
				$strPassword = $this->arrConfig['users'][$arrKeys[0]]['password'];

				$arrAdditionalContent[] = vsprintf($this->arrConfig['originalAuthor'], array($value['Author'], $value['Created'], $value['id']));
			}
			else
			{
				throw new Exception('No fallback user found.');
			}

			// User lookup for assigned
			if (key_exists($value['Assigned'], $this->arrConfig['users']))
			{
				$strAssignee = $this->arrConfig['users'][$value['Assigned']]['login'];
			}
			else
			{
				$strAssignee = null;
			}

			// Basic parameter
			$strTitle = $value['Topic'];
			$strBody = $value['Description'];

			// Build labels
			$arrLabels = array();

			if (key_exists($value['Status'], $this->arrConfig['labels']))
			{
				$arrLabels[] = $this->arrConfig['labels'][$value['Status']]['name'];
			}

			if (key_exists($value['Tracker'], $this->arrConfig['labels']))
			{
				$arrLabels[] = $this->arrConfig['labels'][$value['Tracker']]['name'];
			}

			$strMilestone = null;
			$intMilestone = null;

			// Check milestones
			if ($value['Target Version'] != '')
			{
				$strMilestone = vsprintf($this->arrConfig['milestoneVersion'], array($value['Target Version']));

				if (!key_exists($strMilestone, $this->arrMilestones))
				{
					$this->addNewMilestone($strMilestone);
				}

				$intMilestone = $this->arrMilestones[$strMilestone]['number'];
			}

			// Check if we have an update or a new issue
			if (($intKey = array_search($value['Topic'], $this->arrIssues)) !== false)
			{
				$this->arrCSV[$key]['updateID'] = $intKey;
				$this->arrCSV[$key]['execute'] = $this->buildCurl($strUsername, $strPassword, $strTitle, $strBody, $strAssignee, $intMilestone, $arrLabels, $arrAdditionalContent, $intKey);
			}
			else
			{
				$this->arrCSV[$key]['execute'] = $this->buildCurl($strUsername, $strPassword, $strTitle, $strBody, $strAssignee, $intMilestone, $arrLabels, $arrAdditionalContent);
			}
		}

		// Execute
		foreach ($this->arrCSV as $key => $value)
		{
			// Skip empty or entries without execute parameter
			if (empty($value) || $value['execute'] == '')
			{
				continue;
			}

			// Insert/Update issue
			try
			{
				$arrResponse = $this->executeProc($value['execute']);

				if (isset($arrResponse['data']['message']) && ($arrResponse['data']['message'] == 'Max number of login attempt exceeded' || $arrResponse['data']['message'] == 'Bad credentials'))
				{
					throw new Exception('Wrong user login.');
				}

				if (!isset($arrResponse['data']['number']))
				{
					throw new Exception('Error by adding issue. Response from server: ' . json_encode($arrResponse['data']));
				}

				if (in_array($value['Status'], $this->arrConfig['closedStatus']))
				{
					$this->closeIssue($arrResponse['data']['number']);
				}
				
				// store old/new issue relation
				$this->arrTicketRelations[$arrResponse['data']['number']] = $value['id'];
				
				echo 'Imported #' . $value['id'] . ' ' . $value['Topic'] . "\n";
			}
			catch (Exception $exc)
			{
				echo 'Skiped #' . $value['id'] . ' with message: ' . $exc->getMessage() . "\n";
			}
		}
	}

	/* -------------------------------------------------------------------------
	 * GitHub Api Calls
	 */

	/**
	 * Get all labels from repo.
	 */
	protected function getAllLabels()
	{
		$strCurl = 'curl -i ' . $this->arrConfig['repoURL'] . '/labels -X GET';

		$arrLables = $this->executeProc($strCurl);
		$arrLables = $arrLables['data'];

		if (!is_array($arrLables) || (key_exists('message', $arrLables) && $arrLables['message'] == 'Not Found'))
		{
			throw new Exception('Could not load labels from repo.');
		}

		foreach ($arrLables as $key => $value)
		{
			$this->arrLabels[$value['name']] = $value;
		}
	}

	/**
	 * Get all milestones from repo.
	 */
	protected function getAllMilestones()
	{
		// Load all opend milestones		
		$strCurl = "curl -i '" . $this->arrConfig['repoURL'] . "/milestones?state=open' -X GET";

		$arrMilestonesOpened = $this->executeProc($strCurl);
		$arrMilestonesOpened = $arrMilestonesOpened['data'];

		if (!is_array($arrMilestonesOpened) || (key_exists('message', $arrMilestonesOpened) && $arrMilestonesOpened['message'] == 'Not Found'))
		{
			throw new Exception('Could not load open milestones from repo.');
		}

		// Load all closed milestones
		$strCurl = "curl -i '" . $this->arrConfig['repoURL'] . "/milestones?state=closed' -X GET";

		$arrMilestonesClosed = $this->executeProc($strCurl);
		$arrMilestonesClosed = $arrMilestonesClosed['data'];

		if (!is_array($arrMilestonesClosed) || (key_exists('message', $arrMilestonesClosed) && $arrMilestonesClosed['message'] == 'Not Found'))
		{
			throw new Exception('Could not load closed milestones from repo.');
		}
		
		// Merge both
		$arrMilestones = array();
		$arrMilestones = array_merge($arrMilestonesClosed, $arrMilestonesOpened);
		
		// Set Title as key
		foreach ($arrMilestones as $key => $value)
		{
			$this->arrMilestones[$value['title']] = $value;
		}
	}

	/**
	 * Get akk issues from repo.
	 */
	protected function getAllIssues()
	{
		$arrIssues = array();

		// Load open issues
		for ($i = 1; $i < 100; $i++)
		{
			$strCurl = "curl -i '" . $this->arrConfig['repoURL'] . "/issues?state=open&page=$i'";
			$arrIssuesOpen = $this->executeProc($strCurl);

			if (!is_array($arrIssuesOpen['data']))
			{
				$arrIssuesOpen['data'] = array();
			}

			$arrIssues = array_merge($arrIssues, $arrIssuesOpen['data']);

			if (key_exists('Link', $arrIssuesOpen['header']))
			{
				if (strpos($arrIssuesOpen['header']['Link'], "rel=\"next\"") === false)
				{
					break;
				}
			}
			else
			{
				break;
			}
		}

		// Load closed issues
		for ($i = 1; $i < 100; $i++)
		{
			$strCurl = "curl -i '" . $this->arrConfig['repoURL'] . "/issues?page=$i&state=closed'";
			$arrIssuesClosed = $this->executeProc($strCurl);
			
			if (!is_array($arrIssuesClosed['data']))
			{
				$arrIssuesClosed['data'] = array();
			}

			$arrIssues = array_merge($arrIssues, $arrIssuesClosed['data']);

			if (key_exists('Link', $arrIssuesClosed['header']))
			{
				if (strpos($arrIssuesClosed['header']['Link'], "rel=\"next\"") === false)
				{
					break;
				}
			}
			else
			{
				break;
			}
		}

		if (!is_array($arrIssues) || (key_exists('message', $arrIssues) && $arrIssues['message'] == 'Not Found'))
		{
			throw new Exception('Could not load issues from repo.');
		}

		foreach ($arrIssues as $key => $value)
		{
			$this->arrIssues[$value['number']] = $value['title'];
		}
	}

	/**
	 * Add a new label
	 * 
	 * @param string $strName
	 * @param sting $strColor
	 * @return boolean 
	 */
	protected function addNewLabel($strName, $strColor)
	{
		$strParameter = json_encode(array('name' => $strName, 'color' => $strColor));
		$strCurl = "curl -i " . $this->arrConfig['repoURL'] . "/labels -u \"" . $this->arrConfig['repoUser'] . ":" . $this->arrConfig['repoPassword'] . "\" -X POST -d '$strParameter'";

		$arrResponse = $this->executeProc($strCurl);

		if (isset($arrResponse['data']['message']) && ($arrResponse['data']['message'] == 'Max number of login attempt exceeded' || $arrResponse['data']['message'] == 'Bad credentials'))
		{
			throw new Exception('Error by login with user: ' . $this->arrConfig['repoUser'] . ' to create labels.');
		}

		$arrResponse = $arrResponse['data'];

		if ($arrResponse === false)
		{
			return false;
		}
		else
		{
			return true;
		}
	}

	/**
	 * Add a new milestone
	 * 
	 * @param string $strName
	 * @param sting $strColor
	 * @return boolean 
	 */
	protected function addNewMilestone($strName)
	{
		$strParameter = json_encode(array('title' => $strName));
		$strCurl = "curl -i " . $this->arrConfig['repoURL'] . "/milestones -u \"" . $this->arrConfig['repoUser'] . ":" . $this->arrConfig['repoPassword'] . "\" -X POST -d '$strParameter'";

		$arrResponse = $this->executeProc($strCurl);

		if (isset($arrResponse['data']['message']) && ($arrResponse['data']['message'] == 'Max number of login attempt exceeded' || $arrResponse['data']['message'] == 'Bad credentials'))
		{
			throw new Exception("Error by login with user: $this->arrConfig['repoUser'] to create milestones.");
		}

		$arrResponse = $arrResponse['data'];

		$this->arrMilestones[$strName] = $arrResponse;

		if ($arrResponse === false)
		{
			return false;
		}
		else
		{
			return true;
		}
	}

	/**
	 * Close a issue
	 * 
	 * @param int $intID 
	 */
	protected function closeIssue($intID)
	{
		$strParameter = json_encode(array('state' => 'closed'));
		$strCurl = "curl -i " . $this->arrConfig['repoURL'] . "/issues/$intID -u \"" . $this->arrConfig['repoUser'] . ":" . $this->arrConfig['repoPassword'] . "\" -X POST -d '$strParameter'";

		$arrResponse = $this->executeProc($strCurl);

		if ($arrResponse['data']['message'] == 'Max number of login attempt exceeded' || $arrResponse['data']['message'] == 'Bad credentials')
		{
			throw new Exception("Could not close issue $intID, because we have a wrong user or password.");
		}
		else if (strpos($arrResponse['header']['Status'], '200 OK') === false)
		{
			throw new Exception("Could not close issue $intID, because we have erro on server side with id: " . $arrResponse['header']['Status']);
		}
	}

	/**
	 * Build execution string for a new issue
	 * 
	 * @param string $strUsername
	 * @param string $strUserpassword
	 * @param string $strTitle
	 * @param string $strBody
	 * @param string $strAssignee
	 * @param string $strMilestone
	 * @param string $arrLabels
	 * @param string $arrAdditionalContent
	 * @param int $intUpdateID
	 * @return string 
	 */
	protected function buildCurl($strUsername, $strUserpassword, $strTitle, $strBody, $strAssignee = null, $intMilestone = null, $arrLabels = null, $arrAdditionalContent = null, $intUpdateID = false)
	{
		if (empty($strUsername) || empty($strUserpassword))
		{
			throw new Exception('Missing user login.');
		}

		if (empty($strTitle))
		{
			throw new Exception('Missing issue title.');
		}

		$arrParamteter = array();

		// Build body
		if (!empty($arrAdditionalContent) && is_array($arrAdditionalContent) && count($arrAdditionalContent) > 0)
		{
			$arrParamteter['body'] = $strBody;
			$arrParamteter['body'] .= "\n\n";

			foreach ($arrAdditionalContent as $key => $value)
			{
				$arrParamteter['body'] .= $value . "\n";
			}
		}
		else
		{
			$arrParamteter['body'] = $strBody;
		}

		$arrParamteter['title'] = $strTitle;

		// Check assignee
		if (!empty($strAssignee))
		{
			$arrParamteter['assignee'] = $strAssignee;
		}

		// Check milestone
		if ($intMilestone != null)
		{
			$arrParamteter['milestone'] = $intMilestone;
		}

		// Check and build lables
		if (!empty($arrLabels) && is_array($arrLabels) && count($arrLabels) != 0)
		{
			$arrParamteter['labels'] = $arrLabels;
		}

		if ($intUpdateID == false)
		{
			$strParameter = $this->escape(json_encode($arrParamteter));
			return "curl -i " . $this->arrConfig['repoURL'] . "/issues -u \"" . $strUsername . ":" . $strUserpassword . "\" -X POST -d '$strParameter'";
		}
		else
		{
			$strParameter = $this->escape(json_encode($arrParamteter));
			return "curl -i " . $this->arrConfig['repoURL'] . "/issues/$intUpdateID -u \"$strUsername:$strUserpassword\" -X POST -d '$strParameter'";
		}
	}

	/* -------------------------------------------------------------------------
	 * Helper Part
	 */

	/**
	 * Check if file exists
	 */
	protected function checkFile()
	{
		if (!file_exists($this->strPath . '/' . $this->arrConfig['csvPath']))
		{
			throw new Exception('Missing CSV file');
		}
	}

	/**
	 * Formate funktion 
	 * 
	 * @param String $str
	 * @return String 
	 */
	protected function format($str)
	{
		$str = str_replace("\r", '', $str);
		$str = preg_replace($this->arrSearch, $this->arrReplace, $str);
		$str = str_replace('[_at_]', '@', $str);
		return trim($str);
	}

	/**
	 * Import CSV File
	 */
	protected function importCSV()
	{
		// Read CSV and formate it
		$objFH = fopen($this->strPath . '/' . $this->arrConfig['csvPath'], 'r+');

		$strFileBody = '';

		while (($strRow = fgets($objFH)) !== false)
		{
			$strFileBody .= $strRow;
		}

		fclose($objFH);

		$strFileBody = str_replace(array('Ä', 'Ö', 'Ü', 'ä', 'ö', 'ü'), array('##Ä', '##Ö', '##Ü', '##ä', '##ö', '##ü'), $strFileBody);

		// Write Temp file
		$objTFH = tmpfile();
		fputs($objTFH, $strFileBody, strlen($strFileBody));
		rewind($objTFH);

		// Convert to array
		while (($arrRow = fgetcsv($objTFH, 0, $this->arrConfig['csvDelimiter'])) !== false)
		{
			
			$this->arrCSV[] = array_combine($this->arrConfig['csvKeys'], $arrRow);
		}

		// Formate some Strings
		foreach ($this->arrCSV as $key => $value)
		{
			foreach ($value as $keyField => $valueField)
			{
				
				$valueField = str_replace(array('##Ä', '##Ö', '##Ü', '##ä', '##ö', '##ü'), array('Ä', 'Ö', 'Ü', 'ä', 'ö', 'ü'), $valueField);

				switch ($keyField)
				{
					case 'Description':
						$valueField = $this->format($valueField);
						break;
				}

				$this->arrCSV[$key][$keyField] = $valueField;
			}
		}

		// skip the first entry as it contains the headers
		array_shift($this->arrCSV);
		
		// only one ticket feature
		if ($this->blnOneTicketOnly)
		{
			$arrCSVnew = array();
			$blnFound = false;
			
			foreach ($this->arrCSV as $key => $value)
			{
				if ($value['id'] == $this->intTicketId)
				{
					$arrCSVnew = $value;
					$blnFound = true;
				}
			}

			if (!$blnFound)
			{
				throw new Exception('You tried to only import ticket id "' . $this->intTicketId . '" which is not defined in the csv file.');
				
			}
			
			$this->arrCSV = array();
			$this->arrCSV[] = $arrCSVnew;
		}
	}

	/**
	 * Execute external program
	 * Big thanks to Tristan Lins <tristan.lins@infinitysoft.de> for the inspiration
	 *
	 * @arg mixed...
	 * @return boolean
	 */
	protected function executeProc($strExecute)
	{
		// execute the command
		$proc = proc_open(
				$strExecute, array(
			0 => array('pipe', 'r'),
			1 => array('pipe', 'w'),
			2 => array('pipe', 'w')
				), $arrPipes);

		// test if command start failed
		if ($proc === false)
		{
			throw new Exception("Could not execute command: '$strExecute' ");
		}

		// close stdin
		fclose($arrPipes[0]);

		// read and close stdout
		$strOut = stream_get_contents($arrPipes[1]);
		fclose($arrPipes[1]);

		// read and close stderr
		$strErr = stream_get_contents($arrPipes[2]);
		fclose($arrPipes[2]);

		// wait until process terminates
		$intCode = proc_close($proc);

		// log if process does not terminate without errors
		if ($intCode != 0)
		{
			throw new Exception("Program execution failed command: $strExecute\n  stdout: $strOut\n stderr: $strErr");
		}

		$arrHeaderData = explode("\r\n\r\n", $strOut);
		$count = count($arrHeaderData);
		$header = $arrHeaderData[$count - 2];
		$body = $arrHeaderData[$count - 1];
		$headers = explode("\n", $header);
		$arrHeader = array();
		$strStatus = '';

		foreach ($headers as $k => $header)
		{
			// extract status
			if ($k == 0)
			{
				$chunks = explode(' ', $header, 3);
				$strStatus = $chunks[1];
			}
			// Save Header
			$arrHeaderPair = explode(':', $header, 2);
			$arrHeader[$arrHeaderPair[0]] = $arrHeaderPair[1];
		}

		$bodydecoded = json_decode($body, true);

		if (!in_array($strStatus, array('200', '201')))
		{
			throw new Exception('We have an error on server side with id: ' . $arrHeader['Status'] . "\n" . $strExecute . "\n" . print_r($arrHeader, true));
		}

		return array('data' => $bodydecoded, 'header' => $arrHeader);
	}

	protected function escape($string)
	{
		return str_replace(array("(", ")", "'", "?", "`"), array("\\u0028", "\\u0029", "\\u0027", "\\u00DF", "\\u0060"), $string);
	}
	
	protected function logTicketRelations()
	{
		$strBuffer = '';
		$arrRelations = $this->arrTicketRelations;
		ob_start();
		include $this->strPath . '/' . $this->strTicketLogginTpl;
		$strBuffer = ob_get_contents();
		ob_end_clean();

		$handle = fopen($this->strPath . '/ticketrelations.log','w');
		fwrite($handle, $strBuffer);
		fclose($handle);
	}
}

try
{
	$Redmine2Github = new Redmine2Github();
	$Redmine2Github->run();
}
catch (Exception $exc)
{
	echo 'Sorry we have an error: ';
	echo $exc->getMessage();
	echo "\n";
}