3 require_once 'MTrack/Interface/CommitListener.php';
4 require_once 'MTrack/Interface/CommitHookBridge.php';
5 require_once 'MTrack/Interface/CommitHookBridge2.php';
7 //require_once 'MTrack/Issue.php';
8 //require_once 'MTrack/Changeset.php';
13 class MTrack_CommitChecker {
15 static $fileChecks = array(
20 static $listeners = array();
22 static function addCheck($name)
24 require_once "MTrack/CommitCheck/$name.php";
25 $cls = "MTrackCommitCheck_$name";
26 self::$listeners[] = new $cls;
34 var $checks = array();
36 function __construct($ar) {
37 foreach($ar as $k=>$v) {
40 foreach($this->checks as $chk) {
50 $args = func_get_args();
51 $method = array_shift($args);
54 foreach (self::$listeners as $l) {
55 $v = call_user_func_array(array($l, $method), $args);
57 if ($v === null || $v === false) {
58 $reasons[] = sprintf("%s:%s() returned %s",
59 get_class($l), $method, $v === null ? 'null' : 'false');
60 } elseif (is_array($v)) {
69 if (count($reasons)) {
70 require_once 'MTrack/Exception/Veto.php';
71 throw new MTrackVetoException($reasons);
75 function parseCommitMessage($msg)
77 // Parse the commit message and look for commands;
78 // returns each recognized command and its args in an array
80 $close = array('resolves', 'resolved', 'close', 'closed',
81 'closes', 'fix', 'fixed', 'fixes');
82 $refs = array('addresses', 'references', 'referenced',
83 'refs', 'ref', 'see', 're');
85 $cmds = join('|', $close) . '|' . join('|', $refs);
88 $timepat = ''; //'(?:\s*\((?:spent|sp)\s*(-?[0-9]*(?:\.[0-9]+)?)\s*(?:hours?|hrs)?\s*\))?';
89 $tktref = "(?:#|(?:(?:ticket|issue|bug):?\s*))([a-z]*[0-9]+)$timepat";
91 $pat = "(?P<action>(?:$cmds))\s*(?P<ticket>$tktref(?:(?:[, &]*|\s+and\s+)$tktref)*)";
97 if (preg_match_all("/$pat/smi", $msg, $M, PREG_SET_ORDER)) {
99 foreach ($M as $match) {
100 if (in_array($match['action'], $close)) {
101 $action = 'ref'; // 'close'; - commits need reviewing before they can close something.
107 if (preg_match_all("/$tktref/smi", $match['ticket'],
108 $T, PREG_SET_ORDER)) {
110 foreach ($T as $tmatch) {
111 if (isset($tmatch[2])) {
112 // [ action, ticket, spent ]
113 $actions[] = array($action, $tmatch[1], $tmatch[2]);
115 // [ action, ticket ]
116 $actions[] = array($action, $tmatch[1]);
126 function preCommit(IMTrackCommitHookBridge $bridge)
128 die("NOT SUPPORTED YET!");
131 $this->bridge = $bridge;
132 MTrackACL::requireAllRights("repo:" . $this->repo->id, 'commit');
135 $files = $bridge->enumChangedOrModifiedFileNames();
137 $changes = $this->_getChanges($bridge);
138 foreach ($changes as $c) {
139 $log = $c->changelog;
140 $actions = $this->parseCommitMessage($log);
142 // check permissions on the tickets
144 foreach ($actions as $act) {
146 $tickets[$tkt] = $tkt;
149 foreach ($tickets as $tkt) {
150 if (strlen($tkt) == 32) {
151 $T = MTrackIssue::loadById($tkt);
153 $T = MTrackIssue::loadByNSIdent($tkt);
157 $reasons[] = "#$tkt is not a valid ticket\n";
162 if ($c->hash !== null) {
163 list($accounted) = MTrackDB::q(
164 'select count(hash) from ticket_changeset_hashes
165 where tid = ? and hash = ?',
166 $T->tid, $c->hash)->fetchAll(PDO::FETCH_COLUMN, 0);
172 if (!MTrackACL::hasAllRights("ticket:$T->tid", "modify")) {
173 $reasons[] = MTrackAuth::whoami() . " does not have permission to modify #$tkt\n";
174 } else if (!$T->isOpen()) {
175 $reasons[] = " ** #$tkt is already closed.\n ** You must either re-open it (if it has not already shipped)\n ** or open a new ticket to track this issue\n";
179 if (count($reasons) > 0) {
180 require_once 'MTrack/Exception/Veto.php';
181 throw new MTrackVetoException($reasons);
183 $this->checkVeto('vetoCommit', $log, $files, $actions, $this);
186 private function _getChanges(IMTrackCommitHookBridge $bridge)
189 if ($bridge instanceof IMTrackCommitHookBridge2) {
190 // this is HG only at present.
191 $changes = $bridge->getChanges();
193 require_once 'MTrack/CommitHookChangeEvent.php';
194 $c = new MTrackCommitHookChangeEvent;
195 $c->rev = $bridge->getChangesetDescriptor();
196 $c->changelog = $bridge->getCommitMessage();
197 $c->changeby = $this->authUser->email; //???
198 $c->changeby_id = $this->authUser->id; //???
200 $c->fileActions = $bridge->fileActions;
206 function postCommit(IMTrackCommitHookBridge $bridge)
209 // this might be run on multiple commits (big push...)
212 // in our system, we not only log commits that are against a
213 // ticket, but also ones that are not..
216 $files = $bridge->enumChangedOrModifiedFileNames();
219 foreach ($files as $filename) {
220 $fqfiles[] = $this->repo->shortname . '/' . $filename;
223 // build up overall picture of what needs to be applied to tickets
224 $changes = $this->_getChanges($bridge);
235 // For correct attribution of spent time
236 $spent_by_tid_by_user = array();
238 // Changes that didn't ref a ticket; we want to show something
240 $no_ticket = array();
242 $me = $this->authUser;
247 foreach ($changes as $c) {
249 $log = $c->changelog;
251 $actions = $this->parseCommitMessage($log);
252 foreach ($actions as $act) {
255 $tickets[$tkt][$what] = $what;
256 if (isset($act[2])) {
257 $tickets[$tkt]['spent'] += $act[2];
260 if (count($tickets) == 0) {
266 // apply changes to tickets
267 foreach ($tickets as $tkt => $act) {
268 // removed all the code that handles hashed ticked ids...
270 $T = DB_DataObject::Factory('mtrack_ticket');
272 if (!$T->get($tkt)) {
276 $T_by_tid[$T->id] = $T;
281 if ($c->hash !== null) {
282 if (isset($hashed[$T->tid][$c->hash])) {
285 // see if we already have a reference
288 list($accounted) = MTrackDB::q(
289 'select count(hash) from ticket_changeset_hashes
290 where tid = ? and hash = ?',
291 $T->tid, $c->hash)->fetchAll(PDO::FETCH_COLUMN, 0);
293 $hashed[$T->tid][$c->hash] = $c->hash;
299 $deferred[$T->tid]['comments'][] =
300 "(In $c->rev) merged to [repo:" .
301 $this->repo->getBrowseRootName() . "]";
307 $log = "(In " . $c->rev . ") ";
309 .. we do not support commits on behalf of yet..
310 .. to fix this we need to change the auth code to
311 .. really pick up auth data..
313 if ($c->changeby != $me) {
314 $log .= " (on behalf of [user:$c->changeby]) ";
318 // for the stuff below we do not currently support multiple tickets..
320 $log .= $c->changelog;
321 if (!isset($deferred[$T->id])) {
322 $deferred[$T->id] = array(
323 'comments' => array(),
324 'changes' => array(),
331 $deferred[$T->id]['comments'][] = $log;
332 $deferred[$T->id]['changes'][] = $c;
333 $deferred[$T->id]['ticket'] = $T;
336 if (isset($act['spent']) && $c->changeby != $me) {
337 $spent_by_tid_by_user[$T->id][$c->changeby_id][] = $act['spent'];
338 unset($act['spent']);
340 $deferred[$T->id]['act'][] = $act;
343 $this->checkVeto('postCommit', $log, $fqfiles, $actions);
347 // defered is a list of actions...
348 $this->no_ticket = $no_ticket;
349 $this->deferred = $deferred;
350 $this->spent_by_tid_by_user = $spent_by_tid_by_user;
357 // print_r($deferred);
358 foreach ($deferred as $tid => $info) {
359 $T = $T_by_tid[$tid];
361 $log = join("\n\n", $info['comments']);
367 $CS = MTrackChangeset::begin("ticket:" . $T->tid, $log);
369 if (isset($hashed[$T->tid])) {
370 foreach ($hashed[$T->tid] as $hash) {
372 'insert into ticket_changeset_hashes(tid, hash) values (?, ?)',
377 $T->addComment($log);
378 if (isset($info['act'])) foreach ($info['act'] as $act) {
379 if (isset($act['close'])) {
380 $T->resolution = 'fixed';
383 if (isset($act['spent'])) {
384 $T->addEffort($act['spent']);
390 foreach ($spent_by_tid_by_user as $tid => $sdata) {
391 // Load it fresh here, as there seems to be an issue with saving
392 // a second set of changes on a pre-existing object
393 $T = MTrackIssue::loadById($tid);
394 foreach ($sdata as $user => $time) {
395 MTrackAuth::su($user);
396 $CS = MTrackChangeset::begin("ticket:" . $T->tid,
397 "Tracking time from prior push");
399 foreach ($time as $spent) {
400 $T->addEffort($spent);
407 foreach ($no_ticket as $c) {
408 $log .= "(In " . $c->rev . ") ";
409 if ($c->changeby != $me) {
410 $log .= " (on behalf of [user:$c->changeby]) ";
412 $log .= $c->changelog . "\n\n";
414 $CS = MTrackChangeset::begin("repo:" . $this->repo->id, $log);