3 * FusionForge Subversion plugin
5 * Copyright 2003-2010, Roland Mas, Franck Villaume
6 * Copyright 2004, GForge, LLC
7 * Copyright 2010, Alain Peyrat <aljeux@free.fr>
8 * Copyright 2012-2013, Franck Villaume - TrivialDev
9 * Copyright 2013, French Ministry of National Education
11 * This file is part of FusionForge.
13 * FusionForge is free software; you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License as published
15 * by the Free Software Foundation; either version 2 of the License,
16 * or (at your option) any later version.
18 * FusionForge is distributed in the hope that it will be useful, but
19 * WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
21 * General Public License for more details.
23 * You should have received a copy of the GNU General Public License along
24 * with this program; if not, write to the Free Software Foundation, Inc.,
25 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
28 forge_define_config_item('default_server', 'scmsvn', forge_get_config ('web_host'));
29 forge_define_config_item('repos_path', 'scmsvn', forge_get_config('chroot').'/scmrepos/svn');
30 forge_define_config_item('use_ssh', 'scmsvn', false);
31 forge_set_config_item_bool('use_ssh', 'scmsvn');
32 forge_define_config_item('use_dav', 'scmsvn', true);
33 forge_set_config_item_bool('use_dav', 'scmsvn');
34 forge_define_config_item('use_ssl', 'scmsvn', true);
35 forge_set_config_item_bool('use_ssl', 'scmsvn');
36 forge_define_config_item('anonsvn_login','scmsvn', 'anonsvn');
37 forge_define_config_item('anonsvn_password','scmsvn', 'anonsvn');
39 class SVNPlugin extends SCMPlugin {
40 function SVNPlugin() {
42 $this->name = 'scmsvn';
43 $this->text = 'Subversion';
44 $this->svn_root_fs = '/scmrepos/svn';
45 if (!file_exists($this->svn_root_fs.'/.')) {
46 $this->svn_root_fs = forge_get_config('repos_path',
49 $this->svn_root_dav = '/svn';
50 $this->_addHook('scm_browser_page');
51 $this->_addHook('scm_update_repolist');
52 $this->_addHook('scm_generate_snapshots');
53 $this->_addHook('scm_gather_stats');
54 $this->_addHook('activity');
56 $this->provides['svn'] = true;
61 function getDefaultServer() {
62 return forge_get_config('default_server', 'scmsvn') ;
65 function printShortStats($params) {
66 $project = $this->checkParams($params);
71 if ($project->usesPlugin($this->name) && forge_check_perm('scm', $project->getID(), 'read')) {
72 $result = db_query_params('SELECT sum(commits) AS commits, sum(adds) AS adds FROM stats_cvs_group WHERE group_id=$1',
73 array ($project->getID())) ;
74 $commit_num = db_result($result,0,'commits');
75 $add_num = db_result($result,0,'adds');
82 echo ' (Subversion: '.sprintf(_('<strong>%1$s</strong> commits, <strong>%2$s</strong> adds'), number_format($commit_num, 0), number_format($add_num, 0)).")";
87 return '<p>' . _('Documentation for Subversion (sometimes referred to as "SVN") is available <a href="http://svnbook.red-bean.com/">here</a>.') . '</p>';
90 function topModule($project) {
91 // Check toplevel module presence
92 $repo = 'file://' . forge_get_config('repos_path', $this->name).'/'.$project->getUnixName().'/';
95 if (!(exec("svn ls '$repo'", $res) && in_array($module.'/', $res)))
103 function getInstructionsForAnon($project) {
104 $b = '<h2>' . _('Anonymous Subversion Access') . '</h2>';
106 $b .= _("This project's SVN repository can be checked out through anonymous access with the following command(s).");
110 $module = $this->topModule($project);
111 if (forge_get_config('use_ssh', 'scmsvn')) {
112 $b .= '<tt>svn checkout svn://'.$this->getBoxForProject($project).$this->svn_root_fs.'/'.$project->getUnixName().$module.'</tt><br />';
114 if (forge_get_config('use_dav', 'scmsvn')) {
115 $b .= '<tt>svn checkout --username '.forge_get_config('anonsvn_login', 'scmsvn').' http'.((forge_get_config('use_ssl', 'scmsvn')) ? 's' : '').'://' . $this->getBoxForProject($project). $this->svn_root_dav .'/'. $project->getUnixName() .$module.'</tt><br />';
116 $b .= _('The password is ').forge_get_config('anonsvn_password', 'scmsvn').'<br />';
122 function getInstructionsForRW($project) {
125 $module = $this->topModule($project);
127 if (session_loggedin()) {
128 $u =& user_get_object(user_getid());
129 $d = $u->getUnixName() ;
130 if (forge_get_config('use_ssh', 'scmsvn')) {
132 $b .= _('Developer Subversion Access via SSH');
135 $b .= _('Only project developers can access the SVN tree via this method. SSH must be installed on your client machine. Enter your site password when prompted.');
137 $b .= '<p><tt>svn checkout svn+ssh://'.$d.'@' . $this->getBoxForProject($project) . $this->svn_root_fs .'/'. $project->getUnixName().$module.'</tt></p>' ;
139 if (forge_get_config('use_dav', 'scmsvn')) {
141 $b .= _('Developer Subversion Access via DAV');
144 $b .= _('Only project developers can access the SVN tree via this method. Enter your site password when prompted.');
146 $b .= '<p><tt>svn checkout --username '.$d.' http'.((forge_get_config('use_ssl', 'scmsvn')) ? 's' : '').'://'. $this->getBoxForProject($project) . $this->svn_root_dav .'/'.$project->getUnixName().$module.'</tt></p>' ;
149 if (forge_get_config('use_ssh', 'scmsvn')) {
151 $b .= _('Developer Subversion Access via SSH');
154 $b .= _('Only project developers can access the SVN tree via this method. SSH must be installed on your client machine. Substitute <i>developername</i> with the proper values. Enter your site password when prompted.');
156 $b .= '<p><tt>svn checkout svn+ssh://<i>'._('developername').'</i>@' . $this->getBoxForProject($project) . $this->svn_root_fs .'/'. $project->getUnixName().$module.'</tt></p>' ;
158 if (forge_get_config('use_dav', 'scmsvn')) {
160 $b .= _('Developer Subversion Access via DAV');
163 $b .= _('Only project developers can access the SVN tree via this method. Substitute <i>developername</i> with the proper values. Enter your site password when prompted.');
165 $b .= '<p><tt>svn checkout --username <i>'._('developername').'</i> http'.((forge_get_config('use_ssl', 'scmsvn')) ? 's' : '').'://'. $this->getBoxForProject($project) . $this->svn_root_dav .'/'.$project->getUnixName().$module.'</tt></p>' ;
171 function getSnapshotPara($project) {
175 function getBrowserLinkBlock($project) {
177 $b = $HTML->boxMiddle(_('Subversion Repository Browser'));
179 $b .= _('Browsing the Subversion tree gives you a view into the current status of this project\'s code. You may also view the complete histories of any file in the repository.');
182 $b .= util_make_link ("/scm/browser.php?group_id=".$project->getID(),
183 _('Browse Subversion Repository')
189 function getStatsBlock($project) {
193 $result = db_query_params('SELECT u.realname, u.user_name, u.user_id, sum(commits) as commits, sum(adds) as adds, sum(adds+commits) as combined FROM stats_cvs_user s, users u WHERE group_id=$1 AND s.user_id=u.user_id AND (commits>0 OR adds >0) GROUP BY u.user_id, realname, user_name, u.user_id ORDER BY combined DESC, realname',
194 array ($project->getID()));
196 if (db_numrows($result) > 0) {
197 $b .= $HTML->boxMiddle(_('Repository Statistics'));
199 $tableHeaders = array(
204 $b .= $HTML->listTableTop($tableHeaders);
207 $total = array('adds' => 0, 'commits' => 0);
209 while($data = db_fetch_array($result)) {
210 $b .= '<tr '. $HTML->boxGetAltRowStyle($i) .'>';
211 $b .= '<td width="50%">' ;
212 $b .= util_make_link_u ($data['user_name'], $data['user_id'], $data['realname']) ;
213 $b .= '</td><td width="25%" align="right">'.$data['adds']. '</td>'.
214 '<td width="25%" align="right">'.$data['commits'].'</td></tr>';
215 $total['adds'] += $data['adds'];
216 $total['commits'] += $data['commits'];
219 $b .= '<tr '. $HTML->boxGetAltRowStyle($i) .'>';
220 $b .= '<td width="50%"><strong>'._('Total').':</strong></td>'.
221 '<td width="25%" align="right"><strong>'.$total['adds']. '</strong></td>'.
222 '<td width="25%" align="right"><strong>'.$total['commits'].'</strong></td>';
224 $b .= $HTML->listTableBottom();
230 function printBrowserPage($params) {
231 $project = $this->checkParams($params);
236 if ($project->usesPlugin($this->name)) {
237 if ($this->browserDisplayable($project)) {
238 session_redirect("/scm/viewvc.php/?root=".$project->getUnixName());
243 function createOrUpdateRepo($params) {
244 $project = $this->checkParams($params);
249 if (! $project->usesPlugin($this->name)) {
253 $repo = forge_get_config('repos_path', 'scmsvn') . '/' . $project->getUnixName();
255 if (!is_dir ($repo) || !is_file ("$repo/format")) {
256 if (!mkdir($repo, 0700, true)) {
260 system ("svnadmin create $repo", $ret);
264 system ("svn mkdir -m'Init' file:///$repo/trunk file:///$repo/tags file:///$repo/branches >/dev/null") ;
265 if (forge_get_config('use_ssh', 'scmsvn')) {
266 $unix_group = 'scm_' . $project->getUnixName() ;
267 system ("find $repo -type d | xargs -I{} chmod g+s {}") ;
268 if ($project->enableAnonSCM()) {
269 system ("chmod -R g+wX,o+rX-w $repo") ;
271 system ("chmod -R g+wX,o-rwx $repo") ;
273 system ("chgrp -R $unix_group $repo") ;
275 $unix_user = forge_get_config('apache_user');
276 $unix_group = forge_get_config('apache_group');
277 system ("chmod -R g-rwx,o-rwx $repo") ;
278 system ("chown -R $unix_user:$unix_group $repo") ;
282 if (forge_get_config('use_ssh', 'scmsvn')) {
283 $unix_group = 'scm_' . $project->getUnixName();
284 system("find $repo -type d | xargs -I{} chmod g+s {}");
285 if (forge_get_config('use_dav', 'scmsvn')) {
286 $unix_user = forge_get_config('apache_user');
287 system("chown $unix_user:$unix_group $repo");
289 system("chgrp $unix_group $repo");
291 if ($project->enableAnonSCM()) {
292 system("chmod g+wX,o+rX-w $repo") ;
294 system("chmod g+wX,o-rwx $repo") ;
297 $unix_user = forge_get_config('apache_user');
298 $unix_group = forge_get_config('apache_group');
299 system("chown $unix_user:$unix_group $repo") ;
300 system("chmod g-rwx,o-rwx $repo") ;
304 function updateRepositoryList($params) {
305 $groups = $this->getGroups();
307 // Update WebDAV stuff
308 if (!forge_get_config('use_dav', 'scmsvn')) {
314 $engine = RBACEngine::getInstance() ;
317 foreach ($groups as $project) {
318 if ( !$project->isActive()) {
321 if ( !$project->usesSCM()) {
324 $access_data .= '[' . $project->getUnixName() . ":/]\n";
326 $users = $engine->getUsersByAllowedAction('scm',$project->getID(),'read');
327 foreach ($users as $user) {
328 $svnusers[$user->getID()] = $user;
329 if (forge_check_perm_for_user($user,
333 $access_data .= $user->getUnixName() . "= rw\n";
335 $access_data .= $user->getUnixName() . "= r\n";
339 if ($project->enableAnonSCM()) {
340 $access_data .= forge_get_config('anonsvn_login', 'scmsvn')." = r\n";
341 $access_data .= "* = r\n";
344 $access_data .= "\n";
347 foreach ($svnusers as $user_id => $user) {
348 $password_data .= $user->getUnixName().':'.$user->getUnixPasswd()."\n";
350 $password_data .= forge_get_config('anonsvn_login', 'scmsvn').":".htpasswd_apr1_md5(forge_get_config('anonsvn_password', 'scmsvn'))."\n";
352 $fname = forge_get_config('data_path').'/svnroot-authfile';
353 $f = fopen($fname.'.new', 'w');
354 fwrite($f, $password_data);
356 chmod($fname.'.new', 0644);
357 rename($fname.'.new', $fname);
359 $fname = forge_get_config('data_path').'/svnroot-access';
360 $f = fopen($fname.'.new', 'w');
361 fwrite($f, $access_data);
363 chmod($fname.'.new', 0644);
364 rename($fname.'.new', $fname);
367 function gatherStats($params) {
368 global $last_user, $last_time, $last_tag, $time_ok, $start_time, $end_time,
369 $adds, $deletes, $updates, $commits, $date_key,
370 $usr_adds, $usr_deletes, $usr_updates;
374 $project = $this->checkParams($params);
379 if (! $project->usesPlugin($this->name)) {
383 if ($params['mode'] == 'day') {
386 $year = $params['year'];
387 $month = $params['month'];
388 $day = $params['day'];
389 $month_string = sprintf("%04d%02d", $year, $month);
390 $start_time = gmmktime(0, 0, 0, $month, $day, $year);
391 $end_time = $start_time + 86400;
396 $usr_updates = array();
398 $repo = forge_get_config('repos_path', 'scmsvn') . '/' . $project->getUnixName();
399 if (!is_dir ($repo) || !is_file ("$repo/format")) {
400 echo "No repository\n";
405 $d1 = date('Y-m-d', $start_time - 150000);
406 $d2 = date('Y-m-d', $end_time + 150000);
408 $pipe = popen ("svn log file://$repo --xml -v -q -r '".'{'.$d2.'}:{'.$d1.'}'."' 2> /dev/null", 'r' ) ;
410 // cleaning stats_cvs_* table for the current day
411 $res = db_query_params('DELETE FROM stats_cvs_group WHERE month=$1 AND day=$2 AND group_id=$3',
416 echo "Error while cleaning stats_cvs_group\n" ;
421 $res = db_query_params ('DELETE FROM stats_cvs_user WHERE month=$1 AND day=$2 AND group_id=$3',
422 array ($month_string,
424 $project->getID())) ;
426 echo "Error while cleaning stats_cvs_user\n" ;
431 $xml_parser = xml_parser_create();
432 xml_set_element_handler($xml_parser, "SVNPluginStartElement", "SVNPluginEndElement");
433 xml_set_character_data_handler($xml_parser, "SVNPluginCharData");
435 // Analyzing history stream
436 while (!feof($pipe) &&
437 $data = fgets ($pipe, 4096)) {
438 if (!xml_parse ($xml_parser, $data, feof ($pipe))) {
439 debug("Unable to parse XML with error " .
440 xml_error_string(xml_get_error_code($xml_parser)) .
442 xml_get_current_line_number($xml_parser));
449 xml_parser_free($xml_parser);
451 // inserting group results in stats_cvs_groups
452 if ($updates > 0 || $adds > 0) {
453 if (!db_query_params('INSERT INTO stats_cvs_group (month,day,group_id,checkouts,commits,adds) VALUES ($1,$2,$3,$4,$5,$6)',
454 array ($month_string,
460 echo "Error while inserting into stats_cvs_group\n" ;
466 // building the user list
467 $user_list = array_unique( array_merge( array_keys( $usr_adds ), array_keys( $usr_updates ) ) );
469 foreach ( $user_list as $user ) {
470 // trying to get user id from user name
471 $u = &user_get_object_by_name ($user) ;
473 $user_id = $u->getID();
478 $uu = isset($usr_updates[$user]) ? $usr_updates[$user] : 0 ;
479 $ua = isset($usr_adds[$user]) ? $usr_adds[$user] : 0 ;
480 if ($uu > 0 || $ua > 0) {
481 if (!db_query_params ('INSERT INTO stats_cvs_user (month,day,group_id,user_id,commits,adds) VALUES ($1,$2,$3,$4,$5,$6)',
482 array ($month_string,
488 echo "Error while inserting into stats_cvs_user\n" ;
498 function generateSnapshots($params) {
500 $project = $this->checkParams($params);
505 $group_name = $project->getUnixName();
507 $snapshot = forge_get_config('scm_snapshots_path').'/'.$group_name.'-scm-latest.tar'.util_get_compressed_file_extension();
508 $tarball = forge_get_config('scm_tarballs_path').'/'.$group_name.'-scmroot.tar'.util_get_compressed_file_extension();
510 if (! $project->usesPlugin($this->name)) {
514 if (! $project->enableAnonSCM()) {
515 if (is_file($snapshot)) {
518 if (is_file($tarball)) {
524 $toprepo = forge_get_config('repos_path', 'scmsvn');
525 $repo = $toprepo . '/' . $project->getUnixName();
527 if (!is_dir ($repo) || !is_file ("$repo/format")) {
528 if (is_file($snapshot)) {
531 if (is_file($tarball)) {
537 $tmp = trim (`mktemp -d`) ;
541 $today = date ('Y-m-d') ;
542 $dir = $project->getUnixName ()."-$today" ;
543 system ("mkdir -p $tmp") ;
545 system ("svn ls file://$repo/trunk > /dev/null", $code) ;
547 system ("cd $tmp ; svn export file://$repo/trunk $dir > /dev/null 2>&1") ;
548 system ("tar cCf $tmp - $dir |".forge_get_config('compression_method')."> $tmp/snapshot") ;
549 chmod ("$tmp/snapshot", 0644) ;
550 copy ("$tmp/snapshot", $snapshot) ;
551 unlink ("$tmp/snapshot") ;
552 system ("rm -rf $tmp/$dir") ;
554 if (is_file($snapshot)) {
559 system ("tar cCf $toprepo - ".$project->getUnixName() ."|".forge_get_config('compression_method')."> $tmp/tarball") ;
560 chmod ("$tmp/tarball", 0644) ;
561 copy ("$tmp/tarball", $tarball) ;
562 unlink ("$tmp/tarball") ;
563 system ("rm -rf $tmp") ;
566 function activity($params) {
567 global $last_user, $last_time, $last_tag, $time_ok, $start_time, $end_time,
568 $adds, $deletes, $updates, $commits, $date_key,
569 $usr_adds, $usr_deletes, $usr_updates, $old_commit,
570 $messages, $last_message, $times, $revisions, $users;
571 $group_id = $params['group'];
572 $project = group_get_object($group_id);
573 if (! $project->usesPlugin($this->name)) {
577 if (in_array('scmsvn', $params['show']) || (count($params['show']) < 1)) {
580 $start_time = $params['begin'];
581 $end_time = $params['end'];
582 $d1 = date('Y-m-d', $start_time - 80000);
583 $d2 = date('Y-m-d', $end_time + 80000);
585 $repo = forge_get_config('repos_path', 'scmsvn') . '/' . $project->getUnixName();
586 $pipe = popen("svn log file://$repo --xml -v -r '".'{'.$d2.'}:{'.$d1.'}'."' 2> /dev/null", 'r' );
587 $xml_parser = xml_parser_create();
588 xml_set_element_handler($xml_parser, "SVNPluginStartElement", "SVNPluginEndElement");
589 xml_set_character_data_handler($xml_parser, "SVNPluginCharData");
590 while (!feof($pipe) && $data = fgets($pipe, 4096)) {
591 if (!xml_parse($xml_parser, $data, feof ($pipe))) {
592 debug("Unable to parse XML with error " .
593 xml_error_string(xml_get_error_code($xml_parser)) .
595 xml_get_current_line_number($xml_parser));
600 xml_parser_free($xml_parser);
601 if ($adds > 0 || $updates > 0) {
603 foreach ($messages as $message) {
605 $result['section'] = 'scm';
606 $result['group_id'] = $group_id;
607 $result['ref_id'] = 'viewvc.php/?root='.$project->getUnixName();
608 $result['description'] = $message.' (r'.$revisions[$i].')';
609 $result['user_name'] = $users[$i];
610 $userObject = user_get_object_by_name($users[$i]);
611 if (is_a($userObject, 'GFUser')) {
612 $result['realname'] = $userObject->getFirstName().' '.$userObject->getLastName();
613 $result['user_id'] = $userObject->getId();
615 $result['realname'] = '';
616 $result['user_id'] = '';
618 $result['activity_date'] = $times[$i];
619 $result['subref_id'] = '&view=rev&revision='.$revisions[$i];
620 $params['results'][] = $result;
625 $params['ids'][] = $this->name;
626 $params['texts'][] = _('Subversion Commits');
631 // End of class, helper functions now
633 function SVNPluginCharData($parser, $chars) {
634 global $last_tag, $last_user, $last_time, $start_time, $end_time, $old_commit, $commits,
635 $time_ok, $user_list, $last_message, $messages, $times, $users;
638 $last_user = preg_replace('/[^a-z0-9_-]/', '', strtolower(trim($chars)));
639 $users[] = $last_user;
643 $chars = preg_replace('/T(\d\d:\d\d:\d\d)\.\d+Z?$/', ' ${1}', $chars);
644 $last_time = strtotime($chars);
645 if ($start_time <= $last_time && $last_time < $end_time) {
650 $times[] = $last_time;
654 /* If commit id is the same, then concatenate the string with the previous
655 + * (happen when the message contain accents).
657 if ($old_commit == $commits) {
658 $messages[count($messages)-1] .= $chars;
660 $messages[] = $chars;
662 $old_commit = $commits;
668 function SVNPluginStartElement($parser, $name, $attrs) {
669 global $last_user, $last_time, $last_tag, $time_ok,
670 $adds, $updates, $usr_adds, $usr_updates, $last_message, $messages, $times, $revisions;
674 // Make sure we clean up before doing a new log entry
677 $revisions[] = $attrs['REVISION'];
682 if ($attrs['ACTION'] == "M") {
685 $usr_updates[$last_user] = isset($usr_updates[$last_user]) ? ($usr_updates[$last_user]+1) : 1 ;
687 } elseif ($attrs['ACTION'] == "A") {
690 $usr_adds[$last_user] = isset($usr_adds[$last_user]) ? ($usr_adds[$last_user]+1) : 1 ;
699 function SVNPluginEndElement($parser, $name) {
700 global $time_ok, $last_tag, $commits;
701 if ($name == "LOGENTRY" && $time_ok) {
709 // c-file-style: "bsd"