/inc/mr.inc.php (96eb57aa7a9008eb014a765d59d7a5431940c851) (13136 bytes) (mode 100644) (type blob)

<?php
// Merge requests

require_once(__DIR__ . '/util2.inc.php');
require_once(__DIR__ . '/sql.inc.php');
require_once(__DIR__ . '/user.inc.php');
require_once(__DIR__ . '/events.inc.php');

$rg_mr_env_q = getenv("ROCKETGIT_MR_QUEUE");
if (empty($rg_mr_env_q))
	$rg_mr_queue = $rg_state_dir . "/q_merge_requests";
else
	$rg_mr_queue = $rg_mr_env_q;

$rg_mr_error = "";

function rg_mr_set_error($str)
{
	global $rg_mr_error;
	$rg_mr_error = $str;
	rg_log($str);
}

function rg_mr_error()
{
	global $rg_mr_error;
	return $rg_mr_error;
}


/*
 * Event functions
 */
$rg_mr_functions = array(
	'mr_event_new' => 'rg_mr_event_new',
	'mr_event_add_to_db' => 'rg_mr_event_add_to_db',
	'mr_merge' => 'rg_mr_event_merge'
);
rg_event_register_functions($rg_mr_functions);

/*
 * This is called when the user press "Merge" button
 */
function rg_mr_event_merge($db, $ev)
{
	$ret = array();

	// TODO: we should send the error messages only at last try! Anywhere! Really?!
	// TODO: care! we should not send the mail before doing the merge!
	// TODO: check also all the other events.
	// do the merge

	$r = rg_git_merge($ev['repo_path'], $ev['merge_against'],
		$ev['mri']['new_rev'], $ev['merge_ff'], $ev['merge_msg']);
	if ($r === FALSE) {
		rg_log('Merge failed: ' . rg_git_error());
		// TODO: notify ui['uid'] that the merge failed
		$ev['mail'] = array();
		$ev['mail']['subject'] = 'Merge failed';
		rg_mail_template('repo/mail/merge_failed', $ev);
		return $ret;
	}

	$r = rg_mr_merge_set_status($db, $ev['ri']['repo_id'],
		$ev['mri']['id'], time());
	if ($r === FALSE)
		return FALSE;

	// notify the requester (if not anonymous)
	// TODO: notify the watchers of the project?
	// TODO: notify the users who commented on the merge request?
	// TODO: notify users who watch the merge request?

	return $ret;
}

/*
 * This is called when a new merge request is done
 */
function rg_mr_event_new($db, $ev)
{
	$ret = array();

	// Insert it into database
	$ret[] = array_merge($ev,
		array('category' => 'mr_event_add_to_db', 'prio' => 100));

	// TODO: Notify admins of the repo

	// TODO: Call a webhook

	return $ret;
}

/*
 * Add a merge request file to database
 */
function rg_mr_event_add_to_db($db, $a)
{
	rg_prof_start('mr_event_add_to_db');
	rg_log_enter('mr_add_to_db: a: ' . rg_array2string($a));

	$now = time();

	$ret = FALSE;
	$rollback = 0;
	while (1) {
		if (rg_sql_begin($db) !== TRUE) {
			rg_mr_set_error('start transaction failed');
			break;
		}

		$rollback = 1;

		$id = rg_repo_next_id($db, 'mr', $a['repo_id']);
		if ($id === FALSE) {
			rg_mr_set_error('cannot get next id');
			break;
		}

		// TODO: git may fail to update the reference after this hook;
		// the mr code should check if the update was done.
		$mr = 'refs/mr/' . $id;
		$ui_login = rg_ui_login();
		$reason = $ui_login['username'] . ' pushed a merge request'
			. ' for ref ' . $a['refname']
			. ' into ' . $mr;
		$r = rg_git_update_ref($a['repo_path'], $mr, '', $a['new_rev'], $reason);
		if ($r !== TRUE) {
			rg_mr_set_error('cannot update-ref: ' . rg_git_error());
			break;
		}

		$a['id'] = $id;
		$a['who'] = $ui_login['uid'];
		$sql = 'INSERT INTO merge_requests (repo_id, id, itime'
			. ', namespace, refname, old_rev, new_rev, done, ip'
			. ', who)'
			. ' VALUES (@@repo_id@@, @@id@@, @@itime@@'
			. ', @@namespace@@, @@refname@@, @@old_rev@@'
			. ', @@new_rev@@, 0, @@ip@@, @@who@@)';
		$res = rg_sql_query_params($db, $sql, $a);
		if ($res === FALSE) {
			rg_mr_set_error('cannot insert merge request');
			break;
		}
		rg_sql_free_result($res);

		if (rg_sql_commit($db) !== TRUE) {
			rg_mr_set_error('cannot commit');
			break;
		}

		$rollback = 0;

		$ret = array();
		break;
	}

	if ($rollback)
		rg_sql_rollback($db);

	rg_log_exit();
	rg_prof_end('mr_event_add_to_db');
	return $ret;
}

/*
 * Loads info from a merge request file
 */
function rg_mr_queue_load_file($file)
{
	$ret = array();
	$ret['ok'] = 0;

	$c = @file_get_contents($file);
	if ($c === FALSE) {
		rg_mr_set_error("cannot load a merge request from $file (" . rg_php_err() . ")");
		return $ret;
	}

	$tokens = explode(" ", trim($c));
	foreach ($tokens as $token) {
		$p = explode("=", $token);
		$ret[$p[0]] = $p[1];
	}

	$ret['ok'] = 1;
	return $ret;
}

/*
 * Process merge requests queue
 */
function rg_mr_queue_process($db)
{
	global $rg_mr_queue;

	rg_prof_start("mr_queue_process");

	$ret = TRUE;
	$dir = @opendir($rg_mr_queue);
	if ($dir === FALSE) {
		rg_mr_set_error("cannot open dir $rg_mr_queue (" . rg_php_err() . ")!");
		return FALSE;
	}

	while (($file = readdir($dir))) {
		if (strncmp($file, "mr-", 3) != 0)
			continue;

		$path = $rg_mr_queue . "/" . $file;
		rg_log("Loading merge request from $path...");
		$d = rg_mr_queue_load_file($path);
		if ($d['ok'] != 1) {
			$ret = FALSE;
			break;
		}

		$r = rg_mr_create($db, $d['repo_id'], $d['namespace'],
			$d['old_rev'], $d['new_rev'], $d['refname'], $d['ip']);
		if ($r != TRUE) {
			rename($path, $rg_mr_queue . "/BAD-" . $file);
		} else {
			if (@unlink($path) !== TRUE)
				rg_log("Warn: Cannot unlink file $path!");
			// TODO: Verify it exists in database
		}
	}
	closedir($dir);

	rg_prof_end("mr_queue_process");
	return $ret;
}

/*
 * Helper to cosmetic mr data
 */
function rg_mr_cosmetic($db, &$row)
{
	$row['date_utc'] = gmdate("Y-m-d H:i", $row['itime']);
	$row['old_rev_short'] = substr($row['old_rev'], 0, RG_GIT_HASH_LEN);
	$row['new_rev_short'] = substr($row['new_rev'], 0, RG_GIT_HASH_LEN);

	if (!isset($row['who_nice'])) {
		if ($row['who'] == 0) {
			$row['who_nice'] = 'anonymous';
		} else {
			$ui = rg_user_info($db, $row['who'], '', '');
			if ($ui['exists'] == 1)
				$row['who_nice'] = $ui['username'];
			else
				$row['who_nice'] = 'n/a';
		}
	}
	$row['done_nice'] = gmdate("Y-m-d H:i", $row['done']);
}

/*
 * Loads merge requests
 * @type - 'pending' or 'closed'
 * @limit = 0 => no limit
 */
function rg_mr_load($db, $repo_id, $type, $limit)
{
	rg_log("mr_load: repo_id=$repo_id type=$type limit=$limit");

	if (strcmp($type, 'pending') == 0)
		$add = ' AND done = 0';
	else
		$add = ' AND done > 1000'; // first values are for different status

	$params = array('repo_id' => $repo_id);
	$sql = 'SELECT * FROM merge_requests'
		. ' WHERE repo_id = @@repo_id@@'
		. $add
		. ' ORDER BY itime';
	if ($limit > 0)
		$sql .= ' LIMIT ' . $limit;
	$res = rg_sql_query_params($db, $sql, $params);
	if ($res === FALSE) {
		rg_mr_set_error("Cannot load merge requests (" . rg_sql_error() . ")");
		return FALSE;
	}

	$ret = array();
	while (($row = rg_sql_fetch_array($res))) {
		rg_mr_cosmetic($db, $row);
		$ret[] = $row;
	}
	rg_sql_free_result($res);

	return $ret;
}

/*
 * Loads a merge request
 */
function rg_mr_load_one($db, $repo_id, $id)
{
	rg_prof_start('mr_load_one');
	rg_log('mr_load_one: repo_id=' . $repo_id . ' id=' . $id);

	$ret = FALSE;
	while (1) {
		$params = array('repo_id' => $repo_id, 'id' => $id);
		$sql = 'SELECT * FROM merge_requests'
			. ' WHERE repo_id = @@repo_id@@'
			. ' AND id = @@id@@';
		$res = rg_sql_query_params($db, $sql, $params);
		if ($res === FALSE) {
			rg_mr_set_error('cannot load the merge request');
			break;
		}

		$rows = rg_sql_num_rows($res);
		if ($rows)
			$ret = rg_sql_fetch_array($res);
		rg_sql_free_result($res);

		if ($rows == 0) {
			rg_mr_set_error('mr not found');
			break;
		}

		rg_mr_cosmetic($db, $ret);
		break;
	}

	rg_prof_end('mr_load_one');
	return $ret;
}

/*
 * Sets the status ('done' filed of a merge request
 * @status - 0 - not merged, > 10 = timestamp when the merge took place
 */
function rg_mr_merge_set_status($db, $repo_id, $id, $status)
{
	$ret = FALSE;
	while (1) {
		$params = array('repo_id' => $repo_id,
			'id' => $id,
			'status' => $status
		);
		$sql = 'UPDATE merge_requests'
			. ' SET done = @@status@@'
			. ' WHERE repo_id = @@repo_id@@'
			. ' AND id = @@id@@';
		$res = rg_sql_query_params($db, $sql, $params);
		if ($res === FALSE) {
			rg_mr_set_error('cannot update status (' . rg_sql_error());
			break;
		}
		rg_sql_free_result($res);

		$ret = TRUE;
		break;
	}

	return $ret;
}

/*
 * Loads data for graphs
 * @unit - interval on which a sum is made
 */
function rg_mr_data($db, $type, $start, $end, $unit, $mode)
{
	$params = array('start' => $start, 'end' => $end);
	switch ($type) {
	case 'create_mr':
		$q = 'SELECT itime FROM merge_requests'
			. ' WHERE itime >= @@start@@ AND itime <= @@end@@';
		break;

	default:
		rg_internal_error('invalid type');
		return FALSE;
	}

	$ret = rg_graph_query($db, $start, $end, $unit, $mode, $q, $params, '');
	if ($ret === FALSE)
		rg_mr_set_error(rg_graph_error());

	return $ret;
}

/*
 * High level merge request function
 */
function rg_mr_high_level($db, &$rg, $paras)
{
	rg_prof_start('mr_high_level');
	rg_log_enter('mr_high_level');

	$ret = '';
	while (1) {
		if ($rg['ri']['git_dir_done'] == 0) {
			$ret .= rg_template('repo/err/no_git_dir.html',
				$rg, TRUE /*xss*/);
			break;
		}

		// TODO: mrs.html is empty!
		$ret .= rg_template('repo/mrs.html', $rg, TRUE /*xss*/);

		$op = array_shift($paras);
		if (empty($op)) {
			$op = 'pending';
		} else {
			$mr = sprintf('%u', $op);
			if ($mr > 0)
				$op = '';
		}

		rg_log_debug('op=' . $op);
		$rg['menu']['mr'][$op] = 1;
		$rg['HTML:menu_repo_level2'] =
			rg_template('repo/mr/menu.html', $rg, TRUE /*xss*/);

		if ((strcmp($op, 'pending') == 0) || (strcmp($op, 'closed') == 0)) {
			$rg['mr']['op'] = $op;
			$r = rg_mr_load($db, $rg['ri']['repo_id'], $op,
				0 /*no limit*/);
			if ($r === FALSE) {
				$ret .= 'error getting merge request list ('
					. rg_mr_error() . ')';
			} else {
				$ret .= rg_template_table('repo/mr/list', $r, $rg);
			}
			break;
		} else if (strcmp($op, 'create') == 0) {
			$ret .= rg_warning('not yet implemented'); // TODO
			break;
		}

		$mri = rg_mr_load_one($db, $rg['ri']['repo_id'], $mr);
		if ($mri === FALSE) {
			$ret .= 'error loading merge request'
				. ' (' . rg_mr_error() . ')';
			break;
		}

		$mri['merge_in_progress'] = 0;
		$mri['already_merged'] = 0;
		$against = rg_git_short($mri['refname']);

		$mr_op = array_shift($paras);
		rg_log_debug('mr_op=' . $mr_op);
		if (strcmp($mr_op, 'merge') == 0) {
			if ($rg['can_admin'] !== 1) {
				$ret .= rg_warning('Not allowed!');
				break;
			}

			if (!rg_valid_referer()) {
				$ret .= rg_warning('Invalid referer; try again.');
				break;
			}

			if (!rg_token_valid($db, $rg, 'mr_merge', FALSE)) {
				$ret .= rg_warning('Invalid token; try again.');
				break;
			}

			$event = array(
				'category' => 'mr_merge',
				'prio' => 30,
				'ri' => $rg['ri'],
				'repo_path' => $rg['repo_path'],
				'mri' => $mri,
				'merge_against' => $against,
				'merge_ff' => rg_var_uint('merge_ff'),
				'merge_msg' => rg_var_str('merge_msg')
			);
			$r = rg_event_add($db, $event);
			if ($r !== TRUE) {
				$ret .= rg_warning('Cannot add event; try again later.');
				break;
			}
			rg_event_signal_daemon('', 0);

			$mri['merge_in_progress'] = 1;
			$mri['HTML:body'] = rg_template(
				'repo/mr/merge_in_progress.html',
				$rg, TRUE /*xss*/);
		} else {
			$mri['HTML:body'] = '';

			if ($mri['done'] > 10) { // already merged
				$mri['merge_in_progress'] = 1;
				$mri['already_merged'] = 1;
				$mri['done_nice'] =
					gmdate('Y-m-d H:i', $mri['done']) . ' UTC';
				$mri['can_merge_without_conflicts'] = 0;
			} else {
				$r = rg_git_merge_without_conflict($rg['repo_path'],
					$against, $mri['new_rev']);
				if ($r === FALSE) {
					$ret .= rg_warning('Error testing if merge will work'
						. ' (' . rg_git_error() . ').');
					break;
				}
				rg_log_debug('can merge without conflict:' . ($r == 1 ? 'yes' : 'no'));
				$mri['can_merge_without_conflicts'] = $r;

				if ($mri['can_merge_without_conflicts'] == 0) {
					$base = rg_git_merge_base($rg['repo_path'],
						$against, $mri['new_rev']);
					if ($base === FALSE) {
						$ret .= rg_warning('Error: finding base: '
							. rg_git_error() . '.');
						break;
					}

					$mri['HTML:status'] = rg_git_merge_tree_html(
						$rg['repo_path'], $base, $against,
						$mri['new_rev']);
					rg_log_debug('status: ' . print_r($mri['HTML:status'], TRUE));
					$mri['HTML:body'] .= rg_template(
						'repo/mr/conflicts.html', $mri, TRUE /*xss*/);
				}
			}

			$patch_limit = rg_git_patch_limit($db);
			$_log = rg_git_log($rg['repo_path'], 0, $mri['old_rev'],
				$mri['new_rev'], TRUE /*also_patch*/, $patch_limit);
			if ($_log === FALSE) {
				$ret .= rg_warning('Error generating patch.');
				break;
			}

			$rg['HTML:commit_labels'] = '';
			$mri['HTML:body'] .=
				rg_git_log2listing($_log, $rg, TRUE /*commit_table*/);

			if ($mri['can_merge_without_conflicts'] == 1)
				$rg['rg_form_token'] = rg_token_get($db, $rg, 'mr_merge');
		}

		//rg_log_debug('mri: ' . print_r($mri, TRUE));
		$rg['mr'] = $mri;

		$hints = array();
		$hints[]['HTML:hint'] = rg_template('hints/repo/merge.html',
			$rg, TRUE /*xss*/);
		$rg['mr']['HTML:hints'] = rg_template_table('hints/list',
			$hints, $rg);

		$ret .= rg_template('repo/mr/page.html', $rg,
			TRUE/*xss*/);
		break;
	}

	rg_log_exit();
	rg_prof_end('mr_high_level');
	return $ret;
}

?>


Mode Type Size Ref File
100644 blob 9 f3c7a7c5da68804a1bdf391127ba34aed33c3cca .exclude
100644 blob 95 3e2e24ae7f12c3618604c014e2a5cdbc7572d73d .gitignore
100644 blob 375 1f425bcd2049c526744d449511094fc045ceac74 AUTHORS
100644 blob 1132 dd65951315f3de6d52d52a82fca59889d1d95187 Certs.txt
100644 blob 1630 554f955bfcebeed1265de4e91e474390d859b528 History.txt
100644 blob 34520 dba13ed2ddf783ee8118c6a581dbf75305f816a3 LICENSE
100644 blob 3341 994c8a35a81ada4c768ba38bbea6dae006a35be0 Makefile.in
100644 blob 5013 726b89f5ea8777af6099eb82110136fb1702c41b README
100644 blob 180754 5fe4f3f76fbe2540ba01f7f12a9708651095340d TODO
100644 blob 1294 f22911eb777f0695fcf81ad686eac133eb11fcc4 TODO-plans
100644 blob 203 a2863c67c3da44126b61a15a6f09738c25e0fbe0 TODO.perf
100644 blob 967 56bbaa7c937381fb10a2907b6bbe056ef8cc824a TODO.vm
040000 tree - 21928e906ad2907a55c2e81c2a8b0502b586b8a0 artwork
100644 blob 5292 cf28f2fcc8c67fb2c6931cf14605c5def5c11bbe compare.csv
100755 blob 30 92c4bc48245c00408cd7e1fd89bc1a03058f4ce4 configure
040000 tree - 1611834711e4fe96d3ebd57a77893c0c690cda3e debian
040000 tree - 2e58bf5808e1f01f1e5f9fbc8764427436b6490f docker
040000 tree - f67d3605efbd6422a8acdd953578991139266391 docs
100755 blob 17577 06fe0062db5d1135bcfa1f48a10e84b3596d8c15 duilder
100644 blob 536 e31b63f440c725a5b491489e6a4bf35ee66ff073 duilder.conf.dis
040000 tree - 1a62427b7e1e1e78bbb0c05f5d7bc62d7306e4d3 hooks
040000 tree - 29b3a559216ebec66d513b56c82a2c8db2af4dd3 inc
040000 tree - e255ce234c3993998edc12bc7e93fff555376eda misc
100644 blob 5070 0497a4d8b238a9a8fb91409eb0b4db6a8a1fa3a8 rocketgit.spec
040000 tree - 27ff4b28c8d7b1ec18b513278b145dfa7d2e328d root
040000 tree - db7d2b745ed42be9773f3680152df280df757627 samples
040000 tree - cefc697f26ebbd149a56adebc2e421f601fe2543 scripts
040000 tree - a3cb7109a47e7dae03a78667841b986e23baa224 selinux
100755 blob 256 462ccd108c431f54e380cdac2329129875a318b5 spell_check.sh
040000 tree - ec9f6648549672e8909ba80c8b49fba20da990b3 techdocs
040000 tree - 4bf43340a24dd859890f3133b501bbd528389691 tests
040000 tree - e810d7397575886ef495708d571eb3675f6928ba tools
Hints:
Before first commit, do not forget to setup your git environment:
git config --global user.name "your_name_here"
git config --global user.email "your@email_here"

Clone this repository using HTTP(S):
git clone https://rocketgit.com/user/catalinux/rocketgit

Clone this repository using ssh (do not forget to upload a key first):
git clone ssh://rocketgit@ssh.rocketgit.com/user/catalinux/rocketgit

Clone this repository using git:
git clone git://git.rocketgit.com/user/catalinux/rocketgit

You are allowed to anonymously push to this repository.
This means that your pushed commits will automatically be transformed into a merge request:
... clone the repository ...
... make some changes and some commits ...
git push origin main