To check out this repository please hg clone the following URL, or open the URL using EasyMercurial or your preferred Mercurial client.

Statistics Download as Zip
| Branch: | Tag: | Revision:

root / extra / soundsoftware @ 1554:e5c9809534a2

1 7:3c16ed8faa07 Chris
package Apache::Authn::SoundSoftware;
2
3
=head1 Apache::Authn::SoundSoftware
4
5
SoundSoftware - a mod_perl module for Apache authentication against a
6
Redmine database and optional LDAP implementing the access control
7
rules required for the SoundSoftware.ac.uk repository site.
8
9
=head1 SYNOPSIS
10
11
This module is closely based on the Redmine.pm authentication module
12
provided with Redmine.  It is intended to be used for authentication
13
in front of a repository service such as hgwebdir.
14
15
Requirements:
16
17
1. Clone/pull from repo for public project: Any user, no
18
authentication required
19
20
2. Clone/pull from repo for private project: Project members only
21
22
3. Push to repo for public project: "Permitted" users only (this
23 8:0c83d98252d9 Chris
probably means project members who are also identified in the hgrc web
24
section for the repository and so will be approved by hgwebdir?)
25 7:3c16ed8faa07 Chris
26 8:0c83d98252d9 Chris
4. Push to repo for private project: "Permitted" users only (as above)
27 7:3c16ed8faa07 Chris
28 300:034e9b00b341 chris
5. Push to any repo that is tracking an external repo: Refused always
29
30 7:3c16ed8faa07 Chris
=head1 INSTALLATION
31
32
Debian/ubuntu:
33
34
  apt-get install libapache-dbi-perl libapache2-mod-perl2 \
35
    libdbd-mysql-perl libauthen-simple-ldap-perl libio-socket-ssl-perl
36
37
Note that LDAP support is hardcoded "on" in this script (it is
38
optional in the original Redmine.pm).
39
40
=head1 CONFIGURATION
41
42
   ## This module has to be in your perl path
43
   ## eg:  /usr/local/lib/site_perl/Apache/Authn/SoundSoftware.pm
44
   PerlLoadModule Apache::Authn::SoundSoftware
45
46
   # Example when using hgwebdir
47
   ScriptAlias / "/var/hg/hgwebdir.cgi/"
48
49
   <Location />
50
       AuthName "Mercurial"
51
       AuthType Basic
52
       Require valid-user
53
       PerlAccessHandler Apache::Authn::SoundSoftware::access_handler
54
       PerlAuthenHandler Apache::Authn::SoundSoftware::authen_handler
55
       SoundSoftwareDSN "DBI:mysql:database=redmine;host=localhost"
56
       SoundSoftwareDbUser "redmine"
57
       SoundSoftwareDbPass "password"
58
       Options +ExecCGI
59
       AddHandler cgi-script .cgi
60
       ## Optional where clause (fulltext search would be slow and
61
       ## database dependant).
62
       # SoundSoftwareDbWhereClause "and members.role_id IN (1,2)"
63 8:0c83d98252d9 Chris
       ## Optional prefix for local repository URLs
64
       # SoundSoftwareRepoPrefix "/var/hg/"
65 7:3c16ed8faa07 Chris
  </Location>
66
67
See the original Redmine.pm for further configuration notes.
68
69
=cut
70
71
use strict;
72
use warnings FATAL => 'all', NONFATAL => 'redefine';
73
74
use DBI;
75
use Digest::SHA1;
76
use Authen::Simple::LDAP;
77
use Apache2::Module;
78
use Apache2::Access;
79
use Apache2::ServerRec qw();
80
use Apache2::RequestRec qw();
81
use Apache2::RequestUtil qw();
82
use Apache2::Const qw(:common :override :cmd_how);
83
use APR::Pool ();
84
use APR::Table ();
85
86
my @directives = (
87
  {
88
    name => 'SoundSoftwareDSN',
89
    req_override => OR_AUTHCFG,
90
    args_how => TAKE1,
91
    errmsg => 'Dsn in format used by Perl DBI. eg: "DBI:Pg:dbname=databasename;host=my.db.server"',
92
  },
93
  {
94
    name => 'SoundSoftwareDbUser',
95
    req_override => OR_AUTHCFG,
96
    args_how => TAKE1,
97
  },
98
  {
99
    name => 'SoundSoftwareDbPass',
100
    req_override => OR_AUTHCFG,
101
    args_how => TAKE1,
102
  },
103
  {
104
    name => 'SoundSoftwareDbWhereClause',
105
    req_override => OR_AUTHCFG,
106
    args_how => TAKE1,
107
  },
108
  {
109 8:0c83d98252d9 Chris
    name => 'SoundSoftwareRepoPrefix',
110 7:3c16ed8faa07 Chris
    req_override => OR_AUTHCFG,
111
    args_how => TAKE1,
112
  },
113
);
114
115
sub SoundSoftwareDSN {
116 8:0c83d98252d9 Chris
    my ($self, $parms, $arg) = @_;
117
    $self->{SoundSoftwareDSN} = $arg;
118
    my $query = "SELECT
119 7:3c16ed8faa07 Chris
                 hashed_password, auth_source_id, permissions
120
              FROM members, projects, users, roles, member_roles
121
              WHERE
122
                projects.id=members.project_id
123
                AND member_roles.member_id=members.id
124
                AND users.id=members.user_id
125
                AND roles.id=member_roles.role_id
126
                AND users.status=1
127
                AND login=?
128
                AND identifier=? ";
129 8:0c83d98252d9 Chris
    $self->{SoundSoftwareQuery} = trim($query);
130 7:3c16ed8faa07 Chris
}
131
132
sub SoundSoftwareDbUser { set_val('SoundSoftwareDbUser', @_); }
133
sub SoundSoftwareDbPass { set_val('SoundSoftwareDbPass', @_); }
134
sub SoundSoftwareDbWhereClause {
135 8:0c83d98252d9 Chris
    my ($self, $parms, $arg) = @_;
136
    $self->{SoundSoftwareQuery} = trim($self->{SoundSoftwareQuery}.($arg ? $arg : "")." ");
137 7:3c16ed8faa07 Chris
}
138
139 8:0c83d98252d9 Chris
sub SoundSoftwareRepoPrefix {
140
    my ($self, $parms, $arg) = @_;
141
    if ($arg) {
142
	$self->{SoundSoftwareRepoPrefix} = $arg;
143
    }
144 7:3c16ed8faa07 Chris
}
145
146
sub trim {
147 8:0c83d98252d9 Chris
    my $string = shift;
148
    $string =~ s/\s{2,}/ /g;
149
    return $string;
150 7:3c16ed8faa07 Chris
}
151
152
sub set_val {
153 8:0c83d98252d9 Chris
    my ($key, $self, $parms, $arg) = @_;
154
    $self->{$key} = $arg;
155 7:3c16ed8faa07 Chris
}
156
157
Apache2::Module::add(__PACKAGE__, \@directives);
158
159
160
my %read_only_methods = map { $_ => 1 } qw/GET PROPFIND REPORT OPTIONS/;
161
162
sub access_handler {
163 8:0c83d98252d9 Chris
    my $r = shift;
164 7:3c16ed8faa07 Chris
165 152:a389c77da9fd Chris
    print STDERR "SoundSoftware.pm: In access handler at " . scalar localtime() . "\n";
166 7:3c16ed8faa07 Chris
167 8:0c83d98252d9 Chris
    unless ($r->some_auth_required) {
168
	$r->log_reason("No authentication has been configured");
169
	return FORBIDDEN;
170
    }
171 7:3c16ed8faa07 Chris
172 8:0c83d98252d9 Chris
    my $method = $r->method;
173 7:3c16ed8faa07 Chris
174 8:0c83d98252d9 Chris
    print STDERR "SoundSoftware.pm: Method: $method, uri " . $r->uri . ", location " . $r->location . "\n";
175
    print STDERR "SoundSoftware.pm: Accept: " . $r->headers_in->{Accept} . "\n";
176 7:3c16ed8faa07 Chris
177 8:0c83d98252d9 Chris
    my $dbh = connect_database($r);
178 152:a389c77da9fd Chris
    unless ($dbh) {
179
	print STDERR "SoundSoftware.pm: Database connection failed!: " . $DBI::errstr . "\n";
180
	return FORBIDDEN;
181
    }
182
183 300:034e9b00b341 chris
    print STDERR "Connected to db, dbh is " . $dbh . "\n";
184 7:3c16ed8faa07 Chris
185 8:0c83d98252d9 Chris
    my $project_id = get_project_identifier($dbh, $r);
186 300:034e9b00b341 chris
187
    if (!defined $read_only_methods{$method}) {
188
        print STDERR "SoundSoftware.pm: Method is not read-only\n";
189
        if (project_repo_is_readonly($dbh, $project_id, $r)) {
190
            print STDERR "SoundSoftware.pm: Project repo is read-only, refusing access\n";
191
	    return FORBIDDEN;
192
        } else {
193
	    print STDERR "SoundSoftware.pm: Project repo is read-write, authentication handler required\n";
194
            return OK;
195
        }
196
    }
197
198 8:0c83d98252d9 Chris
    my $status = get_project_status($dbh, $project_id, $r);
199 7:3c16ed8faa07 Chris
200 8:0c83d98252d9 Chris
    $dbh->disconnect();
201
    undef $dbh;
202 7:3c16ed8faa07 Chris
203 8:0c83d98252d9 Chris
    if ($status == 0) { # nonexistent
204
	print STDERR "SoundSoftware.pm: Project does not exist, refusing access\n";
205
	return FORBIDDEN;
206
    } elsif ($status == 1) { # public
207
	print STDERR "SoundSoftware.pm: Project is public, no restriction here\n";
208
	$r->set_handlers(PerlAuthenHandler => [\&OK])
209
    } else { # private
210
	print STDERR "SoundSoftware.pm: Project is private, authentication handler required\n";
211
    }
212 7:3c16ed8faa07 Chris
213 8:0c83d98252d9 Chris
    return OK
214 7:3c16ed8faa07 Chris
}
215
216
sub authen_handler {
217 8:0c83d98252d9 Chris
    my $r = shift;
218
219 152:a389c77da9fd Chris
    print STDERR "SoundSoftware.pm: In authentication handler at " . scalar localtime() . "\n";
220 7:3c16ed8faa07 Chris
221 8:0c83d98252d9 Chris
    my $dbh = connect_database($r);
222 152:a389c77da9fd Chris
    unless ($dbh) {
223
        print STDERR "SoundSoftware.pm: Database connection failed!: " . $DBI::errstr . "\n";
224
        return AUTH_REQUIRED;
225
    }
226 8:0c83d98252d9 Chris
227
    my $project_id = get_project_identifier($dbh, $r);
228
    my $realm = get_realm($dbh, $project_id, $r);
229
    $r->auth_name($realm);
230
231
    my ($res, $redmine_pass) =  $r->get_basic_auth_pw();
232
    unless ($res == OK) {
233
	$dbh->disconnect();
234
	undef $dbh;
235
	return $res;
236
    }
237
238
    print STDERR "SoundSoftware.pm: User is " . $r->user . ", got password\n";
239
240
    my $permitted = is_permitted($dbh, $project_id, $r->user, $redmine_pass, $r);
241
242
    $dbh->disconnect();
243
    undef $dbh;
244
245
    if ($permitted) {
246
	return OK;
247
    } else {
248
	print STDERR "SoundSoftware.pm: Not permitted\n";
249
	$r->note_auth_failure();
250
	return AUTH_REQUIRED;
251
    }
252 7:3c16ed8faa07 Chris
}
253
254
sub get_project_status {
255 8:0c83d98252d9 Chris
    my $dbh = shift;
256 7:3c16ed8faa07 Chris
    my $project_id = shift;
257
    my $r = shift;
258 8:0c83d98252d9 Chris
259
    if (!defined $project_id or $project_id eq '') {
260
	return 0; # nonexistent
261
    }
262 7:3c16ed8faa07 Chris
263
    my $sth = $dbh->prepare(
264
        "SELECT is_public FROM projects WHERE projects.identifier = ?;"
265
    );
266
267
    $sth->execute($project_id);
268 8:0c83d98252d9 Chris
    my $ret = 0; # nonexistent
269 7:3c16ed8faa07 Chris
    if (my @row = $sth->fetchrow_array) {
270
    	if ($row[0] eq "1" || $row[0] eq "t") {
271
	    $ret = 1; # public
272
    	} else {
273 8:0c83d98252d9 Chris
	    $ret = 2; # private
274 7:3c16ed8faa07 Chris
	}
275
    }
276
    $sth->finish();
277
    undef $sth;
278
279
    $ret;
280
}
281
282 300:034e9b00b341 chris
sub project_repo_is_readonly {
283
    my $dbh = shift;
284
    my $project_id = shift;
285
    my $r = shift;
286
287
    if (!defined $project_id or $project_id eq '') {
288
        return 0; # nonexistent
289
    }
290
291
    my $sth = $dbh->prepare(
292
        "SELECT repositories.is_external FROM repositories, projects WHERE projects.identifier = ? AND repositories.project_id = projects.id;"
293
    );
294
295
    $sth->execute($project_id);
296
    my $ret = 0; # nonexistent
297
    if (my @row = $sth->fetchrow_array) {
298 301:6d3f8aeb51b7 chris
        if (defined($row[0]) && ($row[0] eq "1" || $row[0] eq "t")) {
299 300:034e9b00b341 chris
            $ret = 1; # read-only (i.e. external)
300
        } else {
301
            $ret = 0; # read-write
302
        }
303
    }
304
    $sth->finish();
305
    undef $sth;
306
307
    $ret;
308
}
309
310 8:0c83d98252d9 Chris
sub is_permitted {
311
    my $dbh = shift;
312
    my $project_id = shift;
313
    my $redmine_user = shift;
314
    my $redmine_pass = shift;
315
    my $r = shift;
316 7:3c16ed8faa07 Chris
317 8:0c83d98252d9 Chris
    my $pass_digest = Digest::SHA1::sha1_hex($redmine_pass);
318 7:3c16ed8faa07 Chris
319 8:0c83d98252d9 Chris
    my $cfg = Apache2::Module::get_config
320
	(__PACKAGE__, $r->server, $r->per_dir_config);
321 7:3c16ed8faa07 Chris
322 8:0c83d98252d9 Chris
    my $query = $cfg->{SoundSoftwareQuery};
323
    my $sth = $dbh->prepare($query);
324
    $sth->execute($redmine_user, $project_id);
325 7:3c16ed8faa07 Chris
326 8:0c83d98252d9 Chris
    my $ret;
327
    while (my ($hashed_password, $auth_source_id, $permissions) = $sth->fetchrow_array) {
328 7:3c16ed8faa07 Chris
329 8:0c83d98252d9 Chris
	# Test permissions for this user before we verify credentials
330
	# -- if the user is not permitted this action anyway, there's
331
	# not much point in e.g. contacting the LDAP
332 7:3c16ed8faa07 Chris
333 8:0c83d98252d9 Chris
	my $method = $r->method;
334 7:3c16ed8faa07 Chris
335 8:0c83d98252d9 Chris
	if ((defined $read_only_methods{$method} && $permissions =~ /:browse_repository/)
336
	    || $permissions =~ /:commit_access/) {
337
338
	    # User would be permitted this action, if their
339
	    # credentials checked out -- test those now
340
341
	    print STDERR "SoundSoftware.pm: User $redmine_user has required role, checking credentials\n";
342
343
	    unless ($auth_source_id) {
344
		if ($hashed_password eq $pass_digest) {
345
		    print STDERR "SoundSoftware.pm: User $redmine_user authenticated via password\n";
346
		    $ret = 1;
347
		    last;
348
		}
349
	    } else {
350
		my $sthldap = $dbh->prepare(
351
		    "SELECT host,port,tls,account,account_password,base_dn,attr_login FROM auth_sources WHERE id = ?;"
352
		    );
353
		$sthldap->execute($auth_source_id);
354
		while (my @rowldap = $sthldap->fetchrow_array) {
355
		    my $ldap = Authen::Simple::LDAP->new(
356
			host    => ($rowldap[2] eq "1" || $rowldap[2] eq "t") ? "ldaps://$rowldap[0]" : $rowldap[0],
357
			port    => $rowldap[1],
358
			basedn  => $rowldap[5],
359
			binddn  => $rowldap[3] ? $rowldap[3] : "",
360
			bindpw  => $rowldap[4] ? $rowldap[4] : "",
361
			filter  => "(".$rowldap[6]."=%s)"
362
			);
363
		    if ($ldap->authenticate($redmine_user, $redmine_pass)) {
364
			print STDERR "SoundSoftware.pm: User $redmine_user authenticated via LDAP\n";
365
			$ret = 1;
366
		    }
367
		}
368
		$sthldap->finish();
369
		undef $sthldap;
370
	    }
371
	} else {
372
	    print STDERR "SoundSoftware.pm: User $redmine_user lacks required role for this project\n";
373
	}
374 7:3c16ed8faa07 Chris
    }
375
376 8:0c83d98252d9 Chris
    $sth->finish();
377
    undef $sth;
378
379
    $ret;
380 7:3c16ed8faa07 Chris
}
381
382
sub get_project_identifier {
383 8:0c83d98252d9 Chris
    my $dbh = shift;
384 7:3c16ed8faa07 Chris
    my $r = shift;
385
386
    my $location = $r->location;
387
    my ($repo) = $r->uri =~ m{$location/*([^/]+)};
388 10:2c10dc5f122d Chris
389
    return $repo if (!$repo);
390
391 7:3c16ed8faa07 Chris
    $repo =~ s/[^a-zA-Z0-9\._-]//g;
392
393 8:0c83d98252d9 Chris
    # The original Redmine.pm returns the string just calculated as
394
    # the project identifier.  That won't do for us -- we may have
395
    # (and in fact already do have, in our test instance) projects
396
    # whose repository names differ from the project identifiers.
397
398
    # This is a rather fundamental change because it means that almost
399
    # every request needs more than one database query -- which
400
    # prompts us to start passing around $dbh instead of connecting
401
    # locally within each function as is done in Redmine.pm.
402
403 7:3c16ed8faa07 Chris
    my $sth = $dbh->prepare(
404
        "SELECT projects.identifier FROM projects, repositories WHERE repositories.project_id = projects.id AND repositories.url LIKE ?;"
405
    );
406
407 8:0c83d98252d9 Chris
    my $cfg = Apache2::Module::get_config
408
	(__PACKAGE__, $r->server, $r->per_dir_config);
409
410
    my $prefix = $cfg->{SoundSoftwareRepoPrefix};
411
    if (!defined $prefix) { $prefix = '%/'; }
412
413 7:3c16ed8faa07 Chris
    my $identifier = '';
414
415 8:0c83d98252d9 Chris
    $sth->execute($prefix . $repo);
416 7:3c16ed8faa07 Chris
    my $ret = 0;
417
    if (my @row = $sth->fetchrow_array) {
418
	$identifier = $row[0];
419
    }
420
    $sth->finish();
421
    undef $sth;
422
423 8:0c83d98252d9 Chris
    print STDERR "SoundSoftware.pm: Repository '$repo' belongs to project '$identifier'\n";
424 7:3c16ed8faa07 Chris
425
    $identifier;
426
}
427
428 8:0c83d98252d9 Chris
sub get_realm {
429
    my $dbh = shift;
430
    my $project_id = shift;
431
    my $r = shift;
432
433
    my $sth = $dbh->prepare(
434
        "SELECT projects.name FROM projects WHERE projects.identifier = ?;"
435
    );
436
437
    my $name = $project_id;
438
439
    $sth->execute($project_id);
440
    my $ret = 0;
441
    if (my @row = $sth->fetchrow_array) {
442
	$name = $row[0];
443
    }
444
    $sth->finish();
445
    undef $sth;
446
447
    # be timid about characters not permitted in auth realm and revert
448
    # to project identifier if any are found
449
    if ($name =~ m/[^\w\d\s\._-]/) {
450
	$name = $project_id;
451
    }
452
453
    my $realm = '"Mercurial repository for ' . "'$name'" . '"';
454
455
    $realm;
456
}
457
458 7:3c16ed8faa07 Chris
sub connect_database {
459
    my $r = shift;
460
461 8:0c83d98252d9 Chris
    my $cfg = Apache2::Module::get_config
462
	(__PACKAGE__, $r->server, $r->per_dir_config);
463
464
    return DBI->connect($cfg->{SoundSoftwareDSN},
465 152:a389c77da9fd Chris
	                $cfg->{SoundSoftwareDbUser},
466
		        $cfg->{SoundSoftwareDbPass});
467 7:3c16ed8faa07 Chris
}
468
469
1;
470
package Apache::Authn::SoundSoftware;
471
472
=head1 Apache::Authn::SoundSoftware
473
474
SoundSoftware - a mod_perl module for Apache authentication against a
475
Redmine database and optional LDAP implementing the access control
476
rules required for the SoundSoftware.ac.uk repository site.
477
478
=head1 SYNOPSIS
479
480
This module is closely based on the Redmine.pm authentication module
481
provided with Redmine.  It is intended to be used for authentication
482
in front of a repository service such as hgwebdir.
483
484
Requirements:
485
486
1. Clone/pull from repo for public project: Any user, no
487
authentication required
488
489
2. Clone/pull from repo for private project: Project members only
490
491
3. Push to repo for public project: "Permitted" users only (this
492 8:0c83d98252d9 Chris
probably means project members who are also identified in the hgrc web
493
section for the repository and so will be approved by hgwebdir?)
494 7:3c16ed8faa07 Chris
495 8:0c83d98252d9 Chris
4. Push to repo for private project: "Permitted" users only (as above)
496 7:3c16ed8faa07 Chris
497 300:034e9b00b341 chris
5. Push to any repo that is tracking an external repo: Refused always
498
499 7:3c16ed8faa07 Chris
=head1 INSTALLATION
500
501
Debian/ubuntu:
502
503
  apt-get install libapache-dbi-perl libapache2-mod-perl2 \
504
    libdbd-mysql-perl libauthen-simple-ldap-perl libio-socket-ssl-perl
505
506
Note that LDAP support is hardcoded "on" in this script (it is
507
optional in the original Redmine.pm).
508
509
=head1 CONFIGURATION
510
511
   ## This module has to be in your perl path
512
   ## eg:  /usr/local/lib/site_perl/Apache/Authn/SoundSoftware.pm
513
   PerlLoadModule Apache::Authn::SoundSoftware
514
515
   # Example when using hgwebdir
516
   ScriptAlias / "/var/hg/hgwebdir.cgi/"
517
518
   <Location />
519
       AuthName "Mercurial"
520
       AuthType Basic
521
       Require valid-user
522
       PerlAccessHandler Apache::Authn::SoundSoftware::access_handler
523
       PerlAuthenHandler Apache::Authn::SoundSoftware::authen_handler
524
       SoundSoftwareDSN "DBI:mysql:database=redmine;host=localhost"
525
       SoundSoftwareDbUser "redmine"
526
       SoundSoftwareDbPass "password"
527
       Options +ExecCGI
528
       AddHandler cgi-script .cgi
529
       ## Optional where clause (fulltext search would be slow and
530
       ## database dependant).
531
       # SoundSoftwareDbWhereClause "and members.role_id IN (1,2)"
532 8:0c83d98252d9 Chris
       ## Optional prefix for local repository URLs
533
       # SoundSoftwareRepoPrefix "/var/hg/"
534 7:3c16ed8faa07 Chris
  </Location>
535
536
See the original Redmine.pm for further configuration notes.
537
538
=cut
539
540
use strict;
541
use warnings FATAL => 'all', NONFATAL => 'redefine';
542
543
use DBI;
544 1331:1e9b1bdd062e Chris
use Digest::SHA;
545 7:3c16ed8faa07 Chris
use Authen::Simple::LDAP;
546
use Apache2::Module;
547
use Apache2::Access;
548
use Apache2::ServerRec qw();
549
use Apache2::RequestRec qw();
550
use Apache2::RequestUtil qw();
551
use Apache2::Const qw(:common :override :cmd_how);
552
use APR::Pool ();
553
use APR::Table ();
554
555
my @directives = (
556
  {
557
    name => 'SoundSoftwareDSN',
558
    req_override => OR_AUTHCFG,
559
    args_how => TAKE1,
560
    errmsg => 'Dsn in format used by Perl DBI. eg: "DBI:Pg:dbname=databasename;host=my.db.server"',
561
  },
562
  {
563
    name => 'SoundSoftwareDbUser',
564
    req_override => OR_AUTHCFG,
565
    args_how => TAKE1,
566
  },
567
  {
568
    name => 'SoundSoftwareDbPass',
569
    req_override => OR_AUTHCFG,
570
    args_how => TAKE1,
571
  },
572
  {
573
    name => 'SoundSoftwareDbWhereClause',
574
    req_override => OR_AUTHCFG,
575
    args_how => TAKE1,
576
  },
577
  {
578 8:0c83d98252d9 Chris
    name => 'SoundSoftwareRepoPrefix',
579 7:3c16ed8faa07 Chris
    req_override => OR_AUTHCFG,
580
    args_how => TAKE1,
581
  },
582 732:897bc2b63bfe Chris
  {
583
    name => 'SoundSoftwareSslRequired',
584
    req_override => OR_AUTHCFG,
585
    args_how => TAKE1,
586
  },
587 7:3c16ed8faa07 Chris
);
588
589
sub SoundSoftwareDSN {
590 8:0c83d98252d9 Chris
    my ($self, $parms, $arg) = @_;
591
    $self->{SoundSoftwareDSN} = $arg;
592
    my $query = "SELECT
593 301:6d3f8aeb51b7 chris
                 hashed_password, salt, auth_source_id, permissions
594 7:3c16ed8faa07 Chris
              FROM members, projects, users, roles, member_roles
595
              WHERE
596
                projects.id=members.project_id
597
                AND member_roles.member_id=members.id
598
                AND users.id=members.user_id
599
                AND roles.id=member_roles.role_id
600
                AND users.status=1
601
                AND login=?
602
                AND identifier=? ";
603 8:0c83d98252d9 Chris
    $self->{SoundSoftwareQuery} = trim($query);
604 7:3c16ed8faa07 Chris
}
605
606
sub SoundSoftwareDbUser { set_val('SoundSoftwareDbUser', @_); }
607
sub SoundSoftwareDbPass { set_val('SoundSoftwareDbPass', @_); }
608
sub SoundSoftwareDbWhereClause {
609 8:0c83d98252d9 Chris
    my ($self, $parms, $arg) = @_;
610
    $self->{SoundSoftwareQuery} = trim($self->{SoundSoftwareQuery}.($arg ? $arg : "")." ");
611 7:3c16ed8faa07 Chris
}
612
613 8:0c83d98252d9 Chris
sub SoundSoftwareRepoPrefix {
614
    my ($self, $parms, $arg) = @_;
615
    if ($arg) {
616
	$self->{SoundSoftwareRepoPrefix} = $arg;
617
    }
618 7:3c16ed8faa07 Chris
}
619
620 732:897bc2b63bfe Chris
sub SoundSoftwareSslRequired { set_val('SoundSoftwareSslRequired', @_); }
621
622 7:3c16ed8faa07 Chris
sub trim {
623 8:0c83d98252d9 Chris
    my $string = shift;
624
    $string =~ s/\s{2,}/ /g;
625
    return $string;
626 7:3c16ed8faa07 Chris
}
627
628
sub set_val {
629 8:0c83d98252d9 Chris
    my ($key, $self, $parms, $arg) = @_;
630
    $self->{$key} = $arg;
631 7:3c16ed8faa07 Chris
}
632
633
Apache2::Module::add(__PACKAGE__, \@directives);
634
635
636
my %read_only_methods = map { $_ => 1 } qw/GET PROPFIND REPORT OPTIONS/;
637
638
sub access_handler {
639 8:0c83d98252d9 Chris
    my $r = shift;
640 7:3c16ed8faa07 Chris
641 517:bd1d512f9e1b Chris
    print STDERR "SoundSoftware.pm:$$: In access handler at " . scalar localtime() . "\n";
642 7:3c16ed8faa07 Chris
643 8:0c83d98252d9 Chris
    unless ($r->some_auth_required) {
644
	$r->log_reason("No authentication has been configured");
645
	return FORBIDDEN;
646
    }
647 7:3c16ed8faa07 Chris
648 8:0c83d98252d9 Chris
    my $method = $r->method;
649 7:3c16ed8faa07 Chris
650 517:bd1d512f9e1b Chris
    print STDERR "SoundSoftware.pm:$$: Method: $method, uri " . $r->uri . ", location " . $r->location . "\n";
651
    print STDERR "SoundSoftware.pm:$$: Accept: " . $r->headers_in->{Accept} . "\n";
652 7:3c16ed8faa07 Chris
653 8:0c83d98252d9 Chris
    my $dbh = connect_database($r);
654 152:a389c77da9fd Chris
    unless ($dbh) {
655 517:bd1d512f9e1b Chris
	print STDERR "SoundSoftware.pm:$$: Database connection failed!: " . $DBI::errstr . "\n";
656 152:a389c77da9fd Chris
	return FORBIDDEN;
657
    }
658
659 300:034e9b00b341 chris
    print STDERR "Connected to db, dbh is " . $dbh . "\n";
660 7:3c16ed8faa07 Chris
661 8:0c83d98252d9 Chris
    my $project_id = get_project_identifier($dbh, $r);
662 300:034e9b00b341 chris
663 732:897bc2b63bfe Chris
    # We want to delegate most of the work to the authentication
664
    # handler (to ensure that user is asked to login even for
665
    # nonexistent projects -- so they can't tell whether a private
666
    # project exists or not without authenticating). So
667
    #
668
    # * if the project is public
669
    #   - if the method is read-only
670
    #     + set handler to OK, no auth needed
671
    #   - if the method is not read-only
672
    #     + if the repo is read-only, return forbidden
673
    #     + else require auth
674
    # * if the project is not public or does not exist
675
    #     + require auth
676
    #
677
    # If we are requiring auth and are not currently https, and
678
    # https is required, then we must return a redirect to https
679
    # instead of an OK.
680 300:034e9b00b341 chris
681 8:0c83d98252d9 Chris
    my $status = get_project_status($dbh, $project_id, $r);
682 732:897bc2b63bfe Chris
    my $readonly = project_repo_is_readonly($dbh, $project_id, $r);
683 7:3c16ed8faa07 Chris
684 8:0c83d98252d9 Chris
    $dbh->disconnect();
685
    undef $dbh;
686 7:3c16ed8faa07 Chris
687 734:1d1b8170c2f7 Chris
    my $auth_ssl_reqd = will_require_ssl_auth($r);
688
689 732:897bc2b63bfe Chris
    if ($status == 1) { # public
690
691
	print STDERR "SoundSoftware.pm:$$: Project is public\n";
692
693
	if (!defined $read_only_methods{$method}) {
694
695
	    print STDERR "SoundSoftware.pm:$$: Method is not read-only\n";
696
697
	    if ($readonly) {
698
		print STDERR "SoundSoftware.pm:$$: Project repo is read-only, refusing access\n";
699
		return FORBIDDEN;
700
	    } else {
701
		print STDERR "SoundSoftware.pm:$$: Project repo is read-write, auth required\n";
702
		# fall through, this is the normal case
703
	    }
704
705 734:1d1b8170c2f7 Chris
        } elsif ($auth_ssl_reqd and $r->unparsed_uri =~ m/cmd=branchmap/) {
706
707
            # A hac^H^H^Hspecial case. We want to ensure we switch to
708
            # https (if it will be necessarily for authentication)
709
            # before the first POST request, and this is what I think
710
            # will give us suitable warning for Mercurial.
711
712
            print STDERR "SoundSoftware.pm:$$: Switching to HTTPS in preparation\n";
713
            # fall through, this is the normal case
714
715 732:897bc2b63bfe Chris
	} else {
716
	    # Public project, read-only method -- this is the only
717
	    # case we can decide for certain to accept in this function
718
	    print STDERR "SoundSoftware.pm:$$: Method is read-only, no restriction here\n";
719
	    $r->set_handlers(PerlAuthenHandler => [\&OK]);
720
	    return OK;
721
	}
722
723
    } else { # status != 1, i.e. nonexistent or private -- equivalent here
724
725
	print STDERR "SoundSoftware.pm:$$: Project is private or nonexistent, auth required\n";
726
	# fall through
727 8:0c83d98252d9 Chris
    }
728 7:3c16ed8faa07 Chris
729 734:1d1b8170c2f7 Chris
    if ($auth_ssl_reqd) {
730
        my $redir_to = "https://" . $r->hostname() . $r->unparsed_uri();
731
        print STDERR "SoundSoftware.pm:$$: Need to switch to HTTPS, redirecting to $redir_to\n";
732
        $r->headers_out->add('Location' => $redir_to);
733
        return REDIRECT;
734 732:897bc2b63bfe Chris
    } else {
735 734:1d1b8170c2f7 Chris
        return OK;
736 732:897bc2b63bfe Chris
    }
737 7:3c16ed8faa07 Chris
}
738
739
sub authen_handler {
740 8:0c83d98252d9 Chris
    my $r = shift;
741
742 517:bd1d512f9e1b Chris
    print STDERR "SoundSoftware.pm:$$: In authentication handler at " . scalar localtime() . "\n";
743 7:3c16ed8faa07 Chris
744 8:0c83d98252d9 Chris
    my $dbh = connect_database($r);
745 152:a389c77da9fd Chris
    unless ($dbh) {
746 517:bd1d512f9e1b Chris
        print STDERR "SoundSoftware.pm:$$: Database connection failed!: " . $DBI::errstr . "\n";
747 152:a389c77da9fd Chris
        return AUTH_REQUIRED;
748
    }
749 8:0c83d98252d9 Chris
750
    my $project_id = get_project_identifier($dbh, $r);
751
    my $realm = get_realm($dbh, $project_id, $r);
752
    $r->auth_name($realm);
753
754
    my ($res, $redmine_pass) =  $r->get_basic_auth_pw();
755
    unless ($res == OK) {
756
	$dbh->disconnect();
757
	undef $dbh;
758
	return $res;
759
    }
760
761 517:bd1d512f9e1b Chris
    print STDERR "SoundSoftware.pm:$$: User is " . $r->user . ", got password\n";
762 8:0c83d98252d9 Chris
763 732:897bc2b63bfe Chris
    my $status = get_project_status($dbh, $project_id, $r);
764
    if ($status == 0) {
765
	# nonexistent, behave like private project you aren't a member of
766
	print STDERR "SoundSoftware.pm:$$: Project doesn't exist, not permitted\n";
767
	$dbh->disconnect();
768
	undef $dbh;
769
	$r->note_auth_failure();
770
	return AUTH_REQUIRED;
771
    }
772
773 8:0c83d98252d9 Chris
    my $permitted = is_permitted($dbh, $project_id, $r->user, $redmine_pass, $r);
774
775
    $dbh->disconnect();
776
    undef $dbh;
777
778
    if ($permitted) {
779
	return OK;
780
    } else {
781 517:bd1d512f9e1b Chris
	print STDERR "SoundSoftware.pm:$$: Not permitted\n";
782 8:0c83d98252d9 Chris
	$r->note_auth_failure();
783
	return AUTH_REQUIRED;
784
    }
785 7:3c16ed8faa07 Chris
}
786
787
sub get_project_status {
788 8:0c83d98252d9 Chris
    my $dbh = shift;
789 7:3c16ed8faa07 Chris
    my $project_id = shift;
790
    my $r = shift;
791 8:0c83d98252d9 Chris
792
    if (!defined $project_id or $project_id eq '') {
793
	return 0; # nonexistent
794
    }
795 7:3c16ed8faa07 Chris
796
    my $sth = $dbh->prepare(
797
        "SELECT is_public FROM projects WHERE projects.identifier = ?;"
798
    );
799
800
    $sth->execute($project_id);
801 8:0c83d98252d9 Chris
    my $ret = 0; # nonexistent
802 7:3c16ed8faa07 Chris
    if (my @row = $sth->fetchrow_array) {
803
    	if ($row[0] eq "1" || $row[0] eq "t") {
804
	    $ret = 1; # public
805
    	} else {
806 8:0c83d98252d9 Chris
	    $ret = 2; # private
807 7:3c16ed8faa07 Chris
	}
808
    }
809
    $sth->finish();
810
    undef $sth;
811
812
    $ret;
813
}
814
815 734:1d1b8170c2f7 Chris
sub will_require_ssl_auth {
816
    my $r = shift;
817
818
    my $cfg = Apache2::Module::get_config
819
        (__PACKAGE__, $r->server, $r->per_dir_config);
820
821
    if ($cfg->{SoundSoftwareSslRequired} eq "on") {
822
        if ($r->dir_config('HTTPS') eq "on") {
823
            # already have ssl
824
            return 0;
825
        } else {
826
            # require ssl for auth, don't have it yet
827
            return 1;
828
        }
829
    } elsif ($cfg->{SoundSoftwareSslRequired} eq "off") {
830
        # don't require ssl for auth
831
        return 0;
832
    } else {
833
        print STDERR "WARNING: SoundSoftware.pm:$$: SoundSoftwareSslRequired should be either 'on' or 'off'\n";
834
        # this is safer
835
        return 1;
836
    }
837
}
838
839 300:034e9b00b341 chris
sub project_repo_is_readonly {
840
    my $dbh = shift;
841
    my $project_id = shift;
842
    my $r = shift;
843
844
    if (!defined $project_id or $project_id eq '') {
845
        return 0; # nonexistent
846
    }
847
848
    my $sth = $dbh->prepare(
849
        "SELECT repositories.is_external FROM repositories, projects WHERE projects.identifier = ? AND repositories.project_id = projects.id;"
850
    );
851
852
    $sth->execute($project_id);
853
    my $ret = 0; # nonexistent
854
    if (my @row = $sth->fetchrow_array) {
855 301:6d3f8aeb51b7 chris
        if (defined($row[0]) && ($row[0] eq "1" || $row[0] eq "t")) {
856 300:034e9b00b341 chris
            $ret = 1; # read-only (i.e. external)
857
        } else {
858
            $ret = 0; # read-write
859
        }
860
    }
861
    $sth->finish();
862
    undef $sth;
863
864
    $ret;
865
}
866
867 8:0c83d98252d9 Chris
sub is_permitted {
868
    my $dbh = shift;
869
    my $project_id = shift;
870
    my $redmine_user = shift;
871
    my $redmine_pass = shift;
872
    my $r = shift;
873 7:3c16ed8faa07 Chris
874 1331:1e9b1bdd062e Chris
    my $pass_digest = Digest::SHA::sha1_hex($redmine_pass);
875 7:3c16ed8faa07 Chris
876 8:0c83d98252d9 Chris
    my $cfg = Apache2::Module::get_config
877
	(__PACKAGE__, $r->server, $r->per_dir_config);
878 7:3c16ed8faa07 Chris
879 8:0c83d98252d9 Chris
    my $query = $cfg->{SoundSoftwareQuery};
880
    my $sth = $dbh->prepare($query);
881
    $sth->execute($redmine_user, $project_id);
882 7:3c16ed8faa07 Chris
883 8:0c83d98252d9 Chris
    my $ret;
884 301:6d3f8aeb51b7 chris
    while (my ($hashed_password, $salt, $auth_source_id, $permissions) = $sth->fetchrow_array) {
885 7:3c16ed8faa07 Chris
886 8:0c83d98252d9 Chris
	# Test permissions for this user before we verify credentials
887
	# -- if the user is not permitted this action anyway, there's
888
	# not much point in e.g. contacting the LDAP
889 7:3c16ed8faa07 Chris
890 8:0c83d98252d9 Chris
	my $method = $r->method;
891 7:3c16ed8faa07 Chris
892 8:0c83d98252d9 Chris
	if ((defined $read_only_methods{$method} && $permissions =~ /:browse_repository/)
893
	    || $permissions =~ /:commit_access/) {
894
895
	    # User would be permitted this action, if their
896
	    # credentials checked out -- test those now
897
898
	    print STDERR "SoundSoftware.pm: User $redmine_user has required role, checking credentials\n";
899
900
	    unless ($auth_source_id) {
901 1331:1e9b1bdd062e Chris
                my $salted_password = Digest::SHA::sha1_hex($salt.$pass_digest);
902 301:6d3f8aeb51b7 chris
		if ($hashed_password eq $salted_password) {
903 8:0c83d98252d9 Chris
		    print STDERR "SoundSoftware.pm: User $redmine_user authenticated via password\n";
904
		    $ret = 1;
905
		    last;
906
		}
907
	    } else {
908
		my $sthldap = $dbh->prepare(
909
		    "SELECT host,port,tls,account,account_password,base_dn,attr_login FROM auth_sources WHERE id = ?;"
910
		    );
911
		$sthldap->execute($auth_source_id);
912
		while (my @rowldap = $sthldap->fetchrow_array) {
913
		    my $ldap = Authen::Simple::LDAP->new(
914
			host    => ($rowldap[2] eq "1" || $rowldap[2] eq "t") ? "ldaps://$rowldap[0]" : $rowldap[0],
915
			port    => $rowldap[1],
916
			basedn  => $rowldap[5],
917
			binddn  => $rowldap[3] ? $rowldap[3] : "",
918
			bindpw  => $rowldap[4] ? $rowldap[4] : "",
919
			filter  => "(".$rowldap[6]."=%s)"
920
			);
921
		    if ($ldap->authenticate($redmine_user, $redmine_pass)) {
922 517:bd1d512f9e1b Chris
			print STDERR "SoundSoftware.pm:$$: User $redmine_user authenticated via LDAP\n";
923 8:0c83d98252d9 Chris
			$ret = 1;
924
		    }
925
		}
926
		$sthldap->finish();
927
		undef $sthldap;
928 735:8653bddf26a6 Chris
                last if ($ret);
929 8:0c83d98252d9 Chris
	    }
930
	} else {
931 517:bd1d512f9e1b Chris
	    print STDERR "SoundSoftware.pm:$$: User $redmine_user lacks required role for this project\n";
932 8:0c83d98252d9 Chris
	}
933 7:3c16ed8faa07 Chris
    }
934
935 8:0c83d98252d9 Chris
    $sth->finish();
936
    undef $sth;
937
938
    $ret;
939 7:3c16ed8faa07 Chris
}
940
941
sub get_project_identifier {
942 8:0c83d98252d9 Chris
    my $dbh = shift;
943 7:3c16ed8faa07 Chris
    my $r = shift;
944
    my $location = $r->location;
945 737:1ce6efe3db0e Chris
    my ($repo) = $r->uri =~ m{$location/*([^/]*)};
946 10:2c10dc5f122d Chris
947
    return $repo if (!$repo);
948
949 7:3c16ed8faa07 Chris
    $repo =~ s/[^a-zA-Z0-9\._-]//g;
950 736:51c97efbe241 Chris
951 8:0c83d98252d9 Chris
    # The original Redmine.pm returns the string just calculated as
952
    # the project identifier.  That won't do for us -- we may have
953
    # (and in fact already do have, in our test instance) projects
954
    # whose repository names differ from the project identifiers.
955
956
    # This is a rather fundamental change because it means that almost
957
    # every request needs more than one database query -- which
958
    # prompts us to start passing around $dbh instead of connecting
959
    # locally within each function as is done in Redmine.pm.
960
961 7:3c16ed8faa07 Chris
    my $sth = $dbh->prepare(
962
        "SELECT projects.identifier FROM projects, repositories WHERE repositories.project_id = projects.id AND repositories.url LIKE ?;"
963
    );
964
965 8:0c83d98252d9 Chris
    my $cfg = Apache2::Module::get_config
966
	(__PACKAGE__, $r->server, $r->per_dir_config);
967
968
    my $prefix = $cfg->{SoundSoftwareRepoPrefix};
969
    if (!defined $prefix) { $prefix = '%/'; }
970 7:3c16ed8faa07 Chris
    my $identifier = '';
971
972 8:0c83d98252d9 Chris
    $sth->execute($prefix . $repo);
973 7:3c16ed8faa07 Chris
    my $ret = 0;
974
    if (my @row = $sth->fetchrow_array) {
975
	$identifier = $row[0];
976
    }
977
    $sth->finish();
978
    undef $sth;
979
980 517:bd1d512f9e1b Chris
    print STDERR "SoundSoftware.pm:$$: Repository '$repo' belongs to project '$identifier'\n";
981 7:3c16ed8faa07 Chris
982
    $identifier;
983
}
984
985 8:0c83d98252d9 Chris
sub get_realm {
986
    my $dbh = shift;
987
    my $project_id = shift;
988
    my $r = shift;
989
990
    my $sth = $dbh->prepare(
991
        "SELECT projects.name FROM projects WHERE projects.identifier = ?;"
992
    );
993
994
    my $name = $project_id;
995
996
    $sth->execute($project_id);
997
    my $ret = 0;
998
    if (my @row = $sth->fetchrow_array) {
999
	$name = $row[0];
1000
    }
1001
    $sth->finish();
1002
    undef $sth;
1003
1004
    # be timid about characters not permitted in auth realm and revert
1005
    # to project identifier if any are found
1006
    if ($name =~ m/[^\w\d\s\._-]/) {
1007
	$name = $project_id;
1008 733:c7a731db96e5 Chris
    } elsif ($name =~ m/^\s*$/) {
1009
	# empty or whitespace
1010
	$name = $project_id;
1011
    }
1012
1013
    if ($name =~ m/^\s*$/) {
1014
        # nothing even in $project_id -- probably a nonexistent project.
1015
        # use repo name instead (don't want to admit to user that project
1016
        # doesn't exist)
1017
        my $location = $r->location;
1018 737:1ce6efe3db0e Chris
        my ($repo) = $r->uri =~ m{$location/*([^/]*)};
1019 733:c7a731db96e5 Chris
        $name = $repo;
1020 8:0c83d98252d9 Chris
    }
1021
1022 1271:cf4cc816278a Chris
#    my $realm = '"Mercurial repository for ' . "'$name'" . '"';
1023
# see #577:
1024
    my $realm = '"Mercurial repository for ' . "$name" . '"';
1025 8:0c83d98252d9 Chris
1026
    $realm;
1027
}
1028
1029 7:3c16ed8faa07 Chris
sub connect_database {
1030
    my $r = shift;
1031
1032 8:0c83d98252d9 Chris
    my $cfg = Apache2::Module::get_config
1033
	(__PACKAGE__, $r->server, $r->per_dir_config);
1034
1035
    return DBI->connect($cfg->{SoundSoftwareDSN},
1036 152:a389c77da9fd Chris
	                $cfg->{SoundSoftwareDbUser},
1037
		        $cfg->{SoundSoftwareDbPass});
1038 7:3c16ed8faa07 Chris
}
1039
1040
1;
1041 217:ed8222a04634 chris
#!/usr/bin/env ruby
1042
1043
# == Synopsis
1044
#
1045 241:7658d21a1493 chris
# convert-external-repos: Update local Mercurial mirrors of external repos,
1046
# by running an external command for each project requiring an update.
1047 217:ed8222a04634 chris
#
1048
# == Usage
1049
#
1050
#    convert-external-repos [OPTIONS...] -s [DIR] -r [HOST]
1051
#
1052
# == Arguments (mandatory)
1053
#
1054 241:7658d21a1493 chris
#   -s, --scm-dir=DIR         use DIR as base directory for repositories
1055 217:ed8222a04634 chris
#   -r, --redmine-host=HOST   assume Redmine is hosted on HOST. Examples:
1056
#                             -r redmine.example.net
1057
#                             -r http://redmine.example.net
1058
#                             -r https://example.net/redmine
1059
#   -k, --key=KEY             use KEY as the Redmine API key
1060 241:7658d21a1493 chris
#   -c, --command=COMMAND     use this command to update each external
1061
#                             repository: command is called with the name
1062
#                             of the project, the path to its repo, and
1063
#                             its external repo url as its three args
1064 217:ed8222a04634 chris
#
1065
# == Options
1066
#
1067
#   --http-user=USER          User for HTTP Basic authentication with Redmine WS
1068
#   --http-pass=PASSWORD      Password for Basic authentication with Redmine WS
1069
#   -t, --test                only show what should be done
1070
#   -h, --help                show help and exit
1071
#   -v, --verbose             verbose
1072
#   -V, --version             print version and exit
1073
#   -q, --quiet               no log
1074
1075
1076
require 'getoptlong'
1077
require 'find'
1078
require 'etc'
1079
1080
Version = "1.0"
1081
1082
opts = GetoptLong.new(
1083 241:7658d21a1493 chris
                      ['--scm-dir',      '-s', GetoptLong::REQUIRED_ARGUMENT],
1084 217:ed8222a04634 chris
                      ['--redmine-host', '-r', GetoptLong::REQUIRED_ARGUMENT],
1085
                      ['--key',          '-k', GetoptLong::REQUIRED_ARGUMENT],
1086
                      ['--http-user',          GetoptLong::REQUIRED_ARGUMENT],
1087
                      ['--http-pass',          GetoptLong::REQUIRED_ARGUMENT],
1088 241:7658d21a1493 chris
                      ['--command' ,     '-c', GetoptLong::REQUIRED_ARGUMENT],
1089 217:ed8222a04634 chris
                      ['--test',         '-t', GetoptLong::NO_ARGUMENT],
1090
                      ['--verbose',      '-v', GetoptLong::NO_ARGUMENT],
1091
                      ['--version',      '-V', GetoptLong::NO_ARGUMENT],
1092
                      ['--help'   ,      '-h', GetoptLong::NO_ARGUMENT],
1093
                      ['--quiet'  ,      '-q', GetoptLong::NO_ARGUMENT]
1094
                      )
1095
1096
$verbose      = 0
1097
$quiet        = false
1098
$redmine_host = ''
1099
$repos_base   = ''
1100
$http_user    = ''
1101
$http_pass    = ''
1102
$test         = false
1103
1104 437:102056ec2de9 chris
$mirrordir    = '/var/mirror'
1105
1106 217:ed8222a04634 chris
def log(text, options={})
1107
  level = options[:level] || 0
1108
  puts text unless $quiet or level > $verbose
1109
  exit 1 if options[:exit]
1110
end
1111
1112
def system_or_raise(command)
1113
  raise "\"#{command}\" failed" unless system command
1114
end
1115
1116
begin
1117
  opts.each do |opt, arg|
1118
    case opt
1119 241:7658d21a1493 chris
    when '--scm-dir';        $repos_base   = arg.dup
1120 217:ed8222a04634 chris
    when '--redmine-host';   $redmine_host = arg.dup
1121
    when '--key';            $api_key      = arg.dup
1122
    when '--http-user';      $http_user    = arg.dup
1123
    when '--http-pass';      $http_pass    = arg.dup
1124 241:7658d21a1493 chris
    when '--command';        $command      = arg.dup
1125 217:ed8222a04634 chris
    when '--verbose';        $verbose += 1
1126
    when '--test';           $test = true
1127
    when '--version';        puts Version; exit
1128 1336:b61a51fb42b9 Chris
    when '--help';           puts "Read source for documentation"; exit
1129 217:ed8222a04634 chris
    when '--quiet';          $quiet = true
1130
    end
1131
  end
1132
rescue
1133
  exit 1
1134
end
1135
1136
if $test
1137
  log("running in test mode")
1138
end
1139
1140 241:7658d21a1493 chris
if ($redmine_host.empty? or $repos_base.empty? or $command.empty?)
1141 1336:b61a51fb42b9 Chris
  puts "Read source for documentation"; exit
1142 217:ed8222a04634 chris
end
1143
1144
unless File.directory?($repos_base)
1145
  log("directory '#{$repos_base}' doesn't exist", :exit => true)
1146
end
1147
1148
begin
1149
  require 'active_resource'
1150
rescue LoadError
1151
  log("This script requires activeresource.\nRun 'gem install activeresource' to install it.", :exit => true)
1152
end
1153
1154
class Project < ActiveResource::Base
1155
  self.headers["User-agent"] = "SoundSoftware external repository converter/#{Version}"
1156 1336:b61a51fb42b9 Chris
  self.format = :xml
1157 217:ed8222a04634 chris
end
1158
1159
log("querying Redmine for projects...", :level => 1);
1160
1161
$redmine_host.gsub!(/^/, "http://") unless $redmine_host.match("^https?://")
1162
$redmine_host.gsub!(/\/$/, '')
1163
1164
Project.site = "#{$redmine_host}/sys";
1165
Project.user = $http_user;
1166
Project.password = $http_pass;
1167
1168
begin
1169
  # Get all active projects that have the Repository module enabled
1170
  projects = Project.find(:all, :params => {:key => $api_key})
1171 1336:b61a51fb42b9 Chris
rescue ActiveResource::ForbiddenAccess
1172
  log("Request was denied by your Redmine server. Make sure that 'WS for repository management' is enabled in application settings and that you provided the correct API key.")
1173 217:ed8222a04634 chris
rescue => e
1174
  log("Unable to connect to #{Project.site}: #{e}", :exit => true)
1175
end
1176
1177
if projects.nil?
1178
  log('no project found, perhaps you forgot to "Enable WS for repository management"', :exit => true)
1179
end
1180
1181
log("retrieved #{projects.size} projects", :level => 1)
1182
1183
projects.each do |project|
1184
  log("treating project #{project.name}", :level => 1)
1185
1186
  if project.identifier.empty?
1187
    log("\tno identifier for project #{project.name}")
1188
    next
1189 1445:0c7b3bb73517 Chris
  elsif not project.identifier.match(/^[a-z0-9_\-]+$/)
1190 217:ed8222a04634 chris
    log("\tinvalid identifier for project #{project.name} : #{project.identifier}");
1191
    next
1192
  end
1193
1194
  if !project.respond_to?(:repository) or !project.repository.is_external?
1195
    log("\tproject #{project.identifier} does not use an external repository");
1196
    next
1197
  end
1198
1199
  external_url = project.repository.external_url;
1200
  log("\tproject #{project.identifier} has external repository url #{external_url}");
1201
1202
  if !external_url.match(/^[a-z][a-z+]{0,8}[a-z]:\/\//)
1203
    log("\tthis doesn't look like a plausible url to me, skipping")
1204
    next
1205
  end
1206
1207
  repos_path = File.join($repos_base, project.identifier).gsub(File::SEPARATOR, File::ALT_SEPARATOR || File::SEPARATOR)
1208
1209 241:7658d21a1493 chris
  unless File.directory?(repos_path)
1210
    log("\tproject repo directory '#{repos_path}' doesn't exist")
1211 217:ed8222a04634 chris
    next
1212
  end
1213
1214 241:7658d21a1493 chris
  system($command, project.identifier, repos_path, external_url)
1215 437:102056ec2de9 chris
1216
  $cache_clearance_file = File.join($mirrordir, project.identifier, 'url_changed')
1217
  if File.file?($cache_clearance_file)
1218
    log("\tproject repo url has changed, requesting cache clearance")
1219
    if project.post(:repository_cache, :key => $api_key)
1220
      File.delete($cache_clearance_file)
1221
    end
1222
  end
1223 217:ed8222a04634 chris
1224
end
1225
1226 1538:87bea4981d6d Chris
#!/usr/bin/env ruby
1227
1228
# Create authormap files for hg repos based on the changeset & project
1229
# member info available to Redmine.
1230
#
1231
# We have a set of hg repos in a given directory:
1232
#
1233
# /var/hg/repo_1
1234
# /var/hg/repo_2
1235
# /var/hg/repo_3
1236
#
1237
# and we want to produce authormap files in another directory:
1238
#
1239
# /var/repo-export/authormap/authormap_repo_1
1240
# /var/repo-export/authormap/authormap_repo_2
1241
# /var/repo-export/authormap/authormap_repo_3
1242
#
1243
# This script does that, if given the two directory names as arguments
1244
# to the -s and -o options. In the above example:
1245
#
1246 1543:05d639e5d59b Chris
# ./script/rails runner -e production extra/soundsoftware/create-repo-authormaps.rb -s /var/hg -o /var/repo-export/authormap
1247 1538:87bea4981d6d Chris
#
1248
# Note that this script will overwrite any existing authormap
1249
# files. (That's why the output files are given an authormap_ prefix,
1250
# so we're less likely to clobber something else if the user gets the
1251
# arguments wrong.)
1252
1253
require 'getoptlong'
1254
1255
opts = GetoptLong.new(
1256 1543:05d639e5d59b Chris
                      ['--scm-dir', '-s', GetoptLong::REQUIRED_ARGUMENT],
1257
                      ['--out-dir', '-o', GetoptLong::REQUIRED_ARGUMENT],
1258
                      ['--environment', '-e', GetoptLong::OPTIONAL_ARGUMENT]
1259 1538:87bea4981d6d Chris
)
1260
1261
$repos_base   = ''
1262
$out_base     = ''
1263
1264
def usage
1265
  puts "See source code for supported options"
1266
  exit
1267
end
1268
1269
begin
1270
  opts.each do |opt, arg|
1271
    case opt
1272
    when '--scm-dir';   $repos_base   = arg.dup
1273
    when '--out-dir';   $out_base     = arg.dup
1274
    end
1275
  end
1276
rescue
1277
  exit 1
1278
end
1279
1280
if ($repos_base.empty? or $out_base.empty?)
1281
  usage
1282
end
1283
1284
unless File.directory?($repos_base)
1285 1540:322d7b57e5f0 chris
  puts "input directory '#{$repos_base}' doesn't exist"
1286
  exit 1
1287 1538:87bea4981d6d Chris
end
1288
1289
unless File.directory?($out_base)
1290 1540:322d7b57e5f0 chris
  puts "output directory '#{$out_base}' doesn't exist"
1291
  exit 1
1292 1538:87bea4981d6d Chris
end
1293
1294
projects = Project.find(:all)
1295
1296
if projects.nil?
1297 1540:322d7b57e5f0 chris
  puts 'No projects found'
1298
  exit 1
1299 1538:87bea4981d6d Chris
end
1300
1301
projects.each do |proj|
1302 1548:fd4cc11ae096 Chris
1303
  next unless proj.is_public
1304
1305 1538:87bea4981d6d Chris
  next unless proj.respond_to?(:repository)
1306
1307
  repo = proj.repository
1308 1539:22d57b0e0a77 chris
  next if repo.nil? or repo.url.empty?
1309 1538:87bea4981d6d Chris
1310
  repo_url = repo.url
1311
  repo_url = repo_url.gsub(/^file:\/*/, "/");
1312
  if repo_url != File.join($repos_base, proj.identifier)
1313 1542:60acfbd8f6d6 Chris
    puts "Project #{proj.identifier} has repo in unsupported location #{repo_url}, skipping"
1314 1538:87bea4981d6d Chris
    next
1315
  end
1316
1317 1542:60acfbd8f6d6 Chris
  committers = repo.committers
1318 1538:87bea4981d6d Chris
1319
  authormap = ""
1320 1542:60acfbd8f6d6 Chris
  committers.each do |c, uid|
1321 1552:3a2254124fa8 Chris
1322
    # Some of our repos have broken email addresses in them: e.g. one
1323
    # changeset has a committer name of the form
1324
    #
1325
    # NAME <name <NAME <name@example.com">
1326
    #
1327
    # I don't know how it got like that... If the committer has more
1328
    # than one '<' in it, truncate it just before the first one, and
1329 1553:baac54711ee9 Chris
    # then look up the author name again.
1330
    #
1331 1552:3a2254124fa8 Chris
    if c =~ /<.*</ then
1332 1553:baac54711ee9 Chris
      # So this is a completely pathological case
1333
      user = User.find_by_id uid
1334
      if user.nil? then
1335
        # because the given committer is bogus, we must write something in the map
1336 1554:e5c9809534a2 Chris
        name = c.sub(/\s*<.*$/, "")
1337
        authormap << "#{c}=#{name} <unknown@example.com>\n"
1338 1553:baac54711ee9 Chris
      else
1339
        authormap << "#{c}=#{user.name} <#{user.mail}>\n"
1340
      end
1341
    elsif not c =~ /[^<]+<.*@.*>/ then
1342
      # This is the "normal" case that needs work, where a user has
1343
      # their name in the commit but no email address
1344 1542:60acfbd8f6d6 Chris
      user = User.find_by_id uid
1345 1539:22d57b0e0a77 chris
      authormap << "#{c}=#{user.name} <#{user.mail}>\n" unless user.nil?
1346 1538:87bea4981d6d Chris
    end
1347
  end
1348
1349 1539:22d57b0e0a77 chris
  File.open(File.join($out_base, "authormap_#{proj.identifier}"), "w") do |f|
1350 1538:87bea4981d6d Chris
    f.puts(authormap)
1351
  end
1352
1353
end
1354
1355 226:5b028aef59a7 chris
#!/usr/bin/perl -w
1356
1357
# Read a Doxyfile and print it out again to stdout, with only
1358
# whitelisted keys in it and with some keys set to pre-fixed values.
1359
#
1360
# Note that OUTPUT_DIRECTORY is not included; it should be added by
1361
# the caller
1362
1363
use strict;
1364
1365
my $txt = join "", <>;
1366
$txt =~ s/^\s*#.*$//gm;
1367
$txt =~ s/\\\n//gs;
1368
$txt =~ s/\r//g;
1369
$txt =~ s/\n\s*\n/\n/gs;
1370
1371
my %fixed = (
1372
    FULL_PATH_NAMES => "NO",
1373
    SYMBOL_CACHE_SIZE => 2,
1374
    EXCLUDE_SYMLINKS => "YES",
1375
    GENERATE_HTML => "YES",
1376
    PERL_PATH => "/usr/bin/perl",
1377
    HAVE_DOT => "YES",
1378
    HTML_OUTPUT => ".",
1379 228:3c084a25d8ab chris
    HTML_DYNAMIC_SECTIONS => "NO",
1380 226:5b028aef59a7 chris
    SEARCHENGINE => "NO",
1381
    DOT_FONTNAME => "FreeMono",
1382
    DOT_FONTSIZE => 10,
1383
    DOT_FONTPATH => "/usr/share/fonts/truetype/freefont",
1384
    DOT_IMAGE_FORMAT => "png",
1385
    DOT_PATH => "/usr/bin/dot",
1386
    DOT_TRANSPARENT => "YES",
1387
);
1388
1389 233:df89e7aa3ce8 Chris
# These are the keys that are safe to take from the output and include
1390
# in the output; they may still need to be checked for safe values (if
1391
# file paths).
1392 226:5b028aef59a7 chris
my @safe = qw(
1393 233:df89e7aa3ce8 Chris
INPUT
1394
FILE_PATTERNS
1395
EXAMPLE_PATH
1396
EXAMPLE_PATTERNS
1397
IMAGE_PATH
1398
INCLUDE_PATH
1399
INCLUDE_FILE_PATTERNS
1400 226:5b028aef59a7 chris
DOXYFILE_ENCODING
1401
PROJECT_NAME
1402
PROJECT_NUMBER
1403
CREATE_SUBDIRS
1404
OUTPUT_LANGUAGE
1405
BRIEF_MEMBER_DESC
1406
REPEAT_BRIEF
1407
ABBREVIATE_BRIEF
1408
ALWAYS_DETAILED_SEC
1409
INLINE_INHERITED_MEMB
1410
STRIP_FROM_PATH
1411
STRIP_FROM_INC_PATH
1412
JAVADOC_AUTOBRIEF
1413
QT_AUTOBRIEF
1414
MULTILINE_CPP_IS_BRIEF
1415
INHERIT_DOCS
1416
SEPARATE_MEMBER_PAGES
1417
TAB_SIZE
1418
ALIASES
1419
OPTIMIZE_OUTPUT_FOR_C
1420
OPTIMIZE_OUTPUT_JAVA
1421
OPTIMIZE_FOR_FORTRAN
1422
OPTIMIZE_OUTPUT_VHDL
1423
EXTENSION_MAPPING
1424
BUILTIN_STL_SUPPORT
1425
CPP_CLI_SUPPORT
1426
SIP_SUPPORT
1427
IDL_PROPERTY_SUPPORT
1428
DISTRIBUTE_GROUP_DOC
1429
SUBGROUPING
1430
TYPEDEF_HIDES_STRUCT
1431
EXTRACT_ALL
1432
EXTRACT_PRIVATE
1433
EXTRACT_STATIC
1434
EXTRACT_LOCAL_CLASSES
1435
EXTRACT_LOCAL_METHODS
1436
EXTRACT_ANON_NSPACES
1437
HIDE_UNDOC_MEMBERS
1438
HIDE_UNDOC_CLASSES
1439
HIDE_FRIEND_COMPOUNDS
1440
HIDE_IN_BODY_DOCS
1441
INTERNAL_DOCS
1442
HIDE_SCOPE_NAMES
1443
SHOW_INCLUDE_FILES
1444
FORCE_LOCAL_INCLUDES
1445
INLINE_INFO
1446
SORT_MEMBER_DOCS
1447
SORT_BRIEF_DOCS
1448
SORT_MEMBERS_CTORS_1ST
1449
SORT_GROUP_NAMES
1450
SORT_BY_SCOPE_NAME
1451
GENERATE_TODOLIST
1452
GENERATE_TESTLIST
1453
GENERATE_BUGLIST
1454
GENERATE_DEPRECATEDLIST
1455
ENABLED_SECTIONS
1456
MAX_INITIALIZER_LINES
1457
SHOW_USED_FILES
1458
SHOW_DIRECTORIES
1459
SHOW_FILES
1460
SHOW_NAMESPACES
1461
QUIET
1462
WARNINGS
1463
WARN_IF_UNDOCUMENTED
1464
WARN_IF_DOC_ERROR
1465
WARN_NO_PARAMDOC
1466
INPUT_ENCODING
1467
RECURSIVE
1468
EXCLUDE
1469
EXCLUDE_SYMLINKS
1470
EXCLUDE_PATTERNS
1471
EXCLUDE_SYMBOLS
1472
EXAMPLE_RECURSIVE
1473
SOURCE_BROWSER
1474
INLINE_SOURCES
1475
STRIP_CODE_COMMENTS
1476
REFERENCED_BY_RELATION
1477
REFERENCES_RELATION
1478
REFERENCES_LINK_SOURCE
1479
VERBATIM_HEADERS
1480
ALPHABETICAL_INDEX
1481
COLS_IN_ALPHA_INDEX
1482
IGNORE_PREFIX
1483
HTML_TIMESTAMP
1484
HTML_ALIGN_MEMBERS
1485
ENABLE_PREPROCESSING
1486
MACRO_EXPANSION
1487
EXPAND_ONLY_PREDEF
1488
SEARCH_INCLUDES
1489
PREDEFINED
1490
EXPAND_AS_DEFINED
1491
SKIP_FUNCTION_MACROS
1492
ALLEXTERNALS
1493
EXTERNAL_GROUPS
1494
CLASS_DIAGRAMS
1495
HIDE_UNDOC_RELATIONS
1496
CLASS_GRAPH
1497
COLLABORATION_GRAPH
1498
GROUP_GRAPHS
1499
UML_LOOK
1500
TEMPLATE_RELATIONS
1501
INCLUDE_GRAPH
1502
INCLUDED_BY_GRAPH
1503
CALL_GRAPH
1504
CALLER_GRAPH
1505
GRAPHICAL_HIERARCHY
1506
DIRECTORY_GRAPH
1507
DOT_GRAPH_MAX_NODES
1508
MAX_DOT_GRAPH_DEPTH
1509
DOT_MULTI_TARGETS
1510
DOT_CLEANUP
1511
);
1512
1513
my %safehash;
1514
for my $sk (@safe) { $safehash{$sk} = 1; }
1515
1516
my @lines = split "\n", $txt;
1517
1518
my %settings;
1519
1520
sub is_safe {
1521
    my $key = shift;
1522
    defined $safehash{$key} and $safehash{$key} == 1;
1523
}
1524
1525
sub has_file_path {
1526
    # Returns true if the given key expects a file path as a value.
1527
    # We only need to test keys that are safe; unsafe keys have been
1528
    # rejected already.
1529
    my $key = shift;
1530
    $key eq "INPUT" or
1531
	$key =~ /^OUTPUT_/ or
1532
	$key =~ /_PATH$/ or
1533
	$key =~ /_PATTERNS$/;
1534
}
1535
1536
sub is_safe_file_path {
1537
    my $value = shift;
1538
    not $value =~ /^\// and not $value =~ /\.\./;
1539
}
1540
1541
foreach my $line (@lines) {
1542
1543
    chomp $line;
1544
    my ($key, $value) = split /\s*=\s*/, $line;
1545
1546
    next if !defined $key;
1547
1548
    if ($key =~ /^GENERATE_/ and not $key =~ /LIST$/) {
1549
	print STDERR "NOTE: Setting $key explicitly to NO\n";
1550
	$settings{$key} = "NO";
1551
	next;
1552
    }
1553
1554
    if (!is_safe($key)) {
1555
	print STDERR "NOTE: Skipping non-whitelisted key $key\n";
1556
	next;
1557
    }
1558
1559
    if (has_file_path($key) and !is_safe_file_path($value)) {
1560
	print STDERR "ERROR: Unsafe file path \"$value\" for key $key\n";
1561
	exit 1;
1562
    }
1563
1564
    $settings{$key} = $value;
1565
}
1566
1567 228:3c084a25d8ab chris
foreach my $key (keys %fixed) {
1568
    my $value = $fixed{$key};
1569
    print STDERR "NOTE: Setting $key to fixed value $value\n";
1570
    $settings{$key} = $value;
1571
}
1572
1573 226:5b028aef59a7 chris
print join "\n", map { "$_ = $settings{$_}" } keys %settings;
1574
print "\n";
1575 1543:05d639e5d59b Chris
#!/bin/bash
1576
1577
set -e
1578
1579
progdir=$(dirname $0)
1580
case "$progdir" in
1581
    /*) ;;
1582
    *) progdir="$(pwd)/$progdir" ;;
1583
esac
1584
1585
rails_scriptdir="$progdir/../../script"
1586
rails="$rails_scriptdir/rails"
1587
1588
if [ ! -x "$rails" ]; then
1589
    echo "Expected to find rails executable at $rails"
1590
    exit 2
1591
fi
1592
1593
fastexport="$progdir/../fast-export/hg-fast-export.sh"
1594
if [ ! -x "$fastexport" ]; then
1595
    echo "Expected to find hg-fast-export.sh executable at $fastexport"
1596
    exit 2
1597
fi
1598
1599 1546:248c402992ba Chris
environment="$1"
1600
hgdir="$2"
1601
gitdir="$3"
1602 1543:05d639e5d59b Chris
1603
if [ -z "$hgdir" ] || [ -z "$gitdir" ]; then
1604 1546:248c402992ba Chris
    echo "Usage: $0 <environment> <hgdir> <gitdir>"
1605
    echo "  where"
1606
    echo "  - environment is the Rails environment (development or production)"
1607
    echo "  - hgdir is the directory containing project Mercurial repositories"
1608
    echo "  - gitdir is the directory in which output git repositories are to be"
1609
    echo "    created or updated"
1610 1543:05d639e5d59b Chris
    exit 2
1611
fi
1612
1613
if [ ! -d "$hgdir" ]; then
1614
    echo "Mercurial repository directory $hgdir not found"
1615
    exit 1
1616
fi
1617
1618
if [ ! -d "$gitdir" ]; then
1619
    echo "Target git repository dir $gitdir not found (please create at least the empty directory)"
1620
    exit 1
1621
fi
1622
1623
set -u
1624
1625 1550:7d825cbd76c8 Chris
authordir="$gitdir/__AUTHORMAPS"
1626 1543:05d639e5d59b Chris
mkdir -p "$authordir"
1627
1628 1550:7d825cbd76c8 Chris
wastedir="$gitdir/__WASTE"
1629
mkdir -p "$wastedir"
1630
1631 1547:bca3b5e5bbf2 Chris
echo "Extracting author maps..."
1632 1546:248c402992ba Chris
1633 1550:7d825cbd76c8 Chris
# Delete any existing authormap files, because we want to ensure we
1634
# don't have an authormap for any project that was exportable but has
1635
# become non-exportable (e.g. has gone private)
1636 1551:36dddb6755f6 Chris
rm -f "$authordir/*"
1637 1550:7d825cbd76c8 Chris
1638 1546:248c402992ba Chris
"$rails" runner -e "$environment" "$progdir/create-repo-authormaps.rb" \
1639 1543:05d639e5d59b Chris
	 -s "$hgdir" -o "$authordir"
1640
1641
for hgrepo in "$hgdir"/*; do
1642
1643
    if [ ! -d "$hgrepo/.hg" ]; then
1644
	echo "Directory $hgrepo does not appear to be a Mercurial repo, skipping"
1645
	continue
1646
    fi
1647
1648
    reponame=$(basename "$hgrepo")
1649
    authormap="$authordir/authormap_$reponame"
1650
    gitrepo="$gitdir/$reponame"
1651
1652
    if [ ! -f "$authormap" ]; then
1653 1547:bca3b5e5bbf2 Chris
	echo "No authormap file was created for repo $reponame, skipping"
1654 1550:7d825cbd76c8 Chris
1655
	# If there is no authormap file, then we should not have a git
1656
	# mirror -- this is a form of access control, not just an
1657
	# optimisation (authormap files are expected to exist for all
1658
	# exportable projects, even if empty). So if a git mirror
1659
	# exists, we move it away
1660
	if [ -d "$gitrepo" ]; then
1661
	    mv "$gitrepo" "$wastedir/$(date +%s).$reponame"
1662
	fi
1663
1664 1543:05d639e5d59b Chris
	continue
1665
    fi
1666
1667
    if [ ! -d "$gitrepo" ]; then
1668
	git init "$gitrepo"
1669
    fi
1670
1671 1547:bca3b5e5bbf2 Chris
    echo
1672 1546:248c402992ba Chris
    echo "About to run fast export for repo $reponame..."
1673 1543:05d639e5d59b Chris
1674
    (
1675
	cd "$gitrepo"
1676 1549:28cde511f312 Chris
1677
        # Force is necessary because git-fast-import (or git) can't handle
1678
        # branches having more than one head ("Error: repository has at
1679
        # least one unnamed head"), which happens from time to time in
1680
        # valid Hg repos. With --force apparently it will just pick one
1681
        # of the two heads arbitrarily, which is also alarming but is
1682
        # more likely to be useful
1683
	"$fastexport" --quiet -r "$hgrepo" -A "$authormap" --hg-hash --force
1684 1543:05d639e5d59b Chris
    )
1685
1686
    echo "Fast export done"
1687
1688
done
1689
1690
echo "All done"
1691
1692 203:1e55195bca45 chris
#!/bin/bash
1693
1694
# Run this script from anywhere
1695
1696
# Enumerate Hg repos; make sure they're up to date; extract docs for
1697
# each
1698
1699
hgdir="/var/hg"
1700
docdir="/var/doc"
1701 223:c3544e9fd588 chris
logfile="/var/www/test-cannam/log/extract-docs.log"
1702
1703
redgrp="redmine"
1704 203:1e55195bca45 chris
1705 218:292cde42265a chris
apikey=""
1706 339:5410d82c12df chris
apischeme="https"
1707 218:292cde42265a chris
apihost=""
1708
apiuser=""
1709
apipass=""
1710
1711 203:1e55195bca45 chris
progdir=$(dirname $0)
1712
case "$progdir" in
1713
    /*) ;;
1714
    *) progdir="$(pwd)/$progdir" ;;
1715
esac
1716
1717 411:e7ba81c8dc5a chris
types="doxygen javadoc matlabdocs" # Do Doxygen first (it can be used for Java too)
1718 203:1e55195bca45 chris
1719
for x in $types; do
1720
    if [ ! -x "$progdir/extract-$x.sh" ]; then
1721
	echo "Helper script not available: $progdir/extract-$x.sh"
1722
	exit 1
1723
    fi
1724
done
1725
1726 218:292cde42265a chris
enable_embedded()
1727
{
1728
    p="$1"
1729 228:3c084a25d8ab chris
    if [ -n "$apikey" ]; then
1730
	if [ -n "$apiuser" ]; then
1731 339:5410d82c12df chris
	    sudo -u docgen curl -u "$apiuser":"$apipass" "$apischeme://$apihost/sys/projects/$p/embedded.xml?enable=1&key=$apikey" -d ""
1732 228:3c084a25d8ab chris
	else
1733 339:5410d82c12df chris
	    sudo -u docgen curl "$apischeme://$apihost/sys/projects/$p/embedded.xml?enable=1&key=$apikey" -d ""
1734 228:3c084a25d8ab chris
	fi
1735
    else
1736
	echo "Can't enable Embedded, API not configured" 1>&2
1737 218:292cde42265a chris
    fi
1738
}
1739
1740 223:c3544e9fd588 chris
# We want to ensure the doc extraction is done by the unprivileged
1741
# user docgen, which is not a member of any interesting group
1742
#
1743
# To this end, we create the tmpdir with user docgen and group
1744
# www-data, and use the www-data user to pull out an archive of the Hg
1745
# repo tip into a location beneath that, before using the docgen user
1746
# to extract docs from that location and write them into the tmpdir
1747
1748
# Same tmpdir for each project: we delete and recreate to avoid
1749
# cleanup duty from lots of directories being created
1750
#
1751
tmpdir=$(mktemp -d "$docdir/tmp_XXXXXX")
1752
1753
fail()
1754
{
1755
    message="$1"
1756
    echo "$message" 1>&2
1757
    case "$tmpdir" in
1758
	*/tmp*) rm -rf "$tmpdir";;
1759
	*);;
1760
    esac
1761
    exit 1
1762
}
1763
1764
case "$tmpdir" in
1765
    /*) ;;
1766
    *) fail "Temporary directory creation failed";;
1767
esac
1768
1769
chown docgen.www-data "$tmpdir" || fail "Temporary directory ownership change failed"
1770
chmod g+rwx "$tmpdir" || fail "Temporary directory permissions change failed"
1771
1772 203:1e55195bca45 chris
for projectdir in "$hgdir"/* ; do
1773
1774
    if [ -d "$projectdir" ] && [ -d "$projectdir/.hg" ]; then
1775
1776 223:c3544e9fd588 chris
	if ! sudo -u www-data hg -R "$projectdir" -q update; then
1777
	    echo "Failed to update Hg in $projectdir, skipping" 1>&2
1778
	    continue
1779
	fi
1780
1781 203:1e55195bca45 chris
	project=$(basename "$projectdir")
1782
1783 223:c3544e9fd588 chris
	tmptargetdir="$tmpdir/doc"
1784
	snapshotdir="$tmpdir/hgsnapshot"
1785 203:1e55195bca45 chris
1786 223:c3544e9fd588 chris
	rm -rf "$tmptargetdir" "$snapshotdir"
1787
1788 226:5b028aef59a7 chris
	mkdir -m 770 "$tmptargetdir" || fail "Temporary target directory creation failed"
1789
	chown docgen.www-data "$tmptargetdir" || fail "Temporary target directory ownership change failed"
1790 223:c3544e9fd588 chris
1791
	mkdir -m 770 "$snapshotdir" || fail "Snapshot directory creation failed"
1792
	chown docgen.www-data "$snapshotdir" || fail "Snapshot directory ownership change failed"
1793
1794
	hgparents=$(sudo -u www-data hg -R "$projectdir" parents)
1795
	if [ -z "$hgparents" ]; then
1796
	    echo "Hg repo at $projectdir has no working copy (empty repo?), skipping"
1797
	    continue
1798
	else
1799
	    echo "Found non-empty Hg repo: $projectdir for project $project"
1800
	fi
1801
1802
	if ! sudo -u www-data hg -R "$projectdir" archive -r tip -t files "$snapshotdir"; then
1803
	    echo "Failed to pick archive from $projectdir, skipping" 1>&2
1804
	    continue
1805
	fi
1806 203:1e55195bca45 chris
1807
	targetdir="$docdir/$project"
1808
1809 223:c3544e9fd588 chris
	echo "Temporary dir is $tmpdir, temporary doc dir is $tmptargetdir, snapshot dir is $snapshotdir, eventual target is $targetdir"
1810 203:1e55195bca45 chris
1811
	for x in $types; do
1812 226:5b028aef59a7 chris
	    if sudo -u docgen "$progdir/extract-$x.sh" "$project" "$snapshotdir" "$tmptargetdir" >> "$logfile" 2>&1; then
1813
		break
1814
	    else
1815 203:1e55195bca45 chris
		echo "Failed to extract via type $x"
1816
	    fi
1817
	done
1818
1819 223:c3544e9fd588 chris
        if [ -f "$tmptargetdir/index.html" ]; then
1820 203:1e55195bca45 chris
	    echo "Processing resulted in an index.html being created, looks good!"
1821
	    if [ ! -d "$targetdir" ] || [ ! -f "$targetdir/index.html" ]; then
1822 223:c3544e9fd588 chris
		echo "This project hasn't had doc extracted before: enabling Embedded"
1823 218:292cde42265a chris
		enable_embedded "$project"
1824 203:1e55195bca45 chris
	    fi
1825
1826
	    if [ -d "$targetdir" ]; then
1827
		mv "$targetdir" "$targetdir"_"$$" && \
1828 223:c3544e9fd588 chris
		    mv "$tmptargetdir" "$targetdir" && \
1829 203:1e55195bca45 chris
		    rm -rf "$targetdir"_"$$"
1830 223:c3544e9fd588 chris
		chgrp -R "$redgrp" "$targetdir"
1831 203:1e55195bca45 chris
	    else
1832 223:c3544e9fd588 chris
		mv "$tmptargetdir" "$targetdir"
1833
		chgrp -R "$redgrp" "$targetdir"
1834 203:1e55195bca45 chris
	    fi
1835 228:3c084a25d8ab chris
	else
1836
	    echo "Processing did not result in an index.html being created"
1837 203:1e55195bca45 chris
	fi
1838
    fi
1839
done
1840
1841 223:c3544e9fd588 chris
rm -rf "$tmpdir"
1842 203:1e55195bca45 chris
#!/bin/bash
1843
1844
docdir="/var/doc"
1845
1846 228:3c084a25d8ab chris
progdir=$(dirname $0)
1847
case "$progdir" in
1848
    /*) ;;
1849
    *) progdir="$(pwd)/$progdir" ;;
1850
esac
1851
1852 203:1e55195bca45 chris
project="$1"
1853 223:c3544e9fd588 chris
projectdir="$2"
1854
targetdir="$3"
1855 203:1e55195bca45 chris
1856 223:c3544e9fd588 chris
if [ -z "$project" ] || [ -z "$targetdir" ] || [ -z "$projectdir" ]; then
1857
    echo "Usage: $0 <project> <projectdir> <targetdir>"
1858 203:1e55195bca45 chris
    exit 2
1859
fi
1860
1861 223:c3544e9fd588 chris
if [ ! -d "$projectdir" ]; then
1862
    echo "Project directory $projectdir not found"
1863 203:1e55195bca45 chris
    exit 1
1864
fi
1865
1866
if [ ! -d "$targetdir" ]; then
1867
    echo "Target dir $targetdir not found"
1868
    exit 1
1869
fi
1870
1871
if [ -f "$targetdir/index.html" ]; then
1872
    echo "Target dir $targetdir already contains index.html"
1873
    exit 1
1874
fi
1875
1876
doxyfile=$(find "$projectdir" -type f -name Doxyfile -print | head -1)
1877
1878
if [ -z "$doxyfile" ]; then
1879
    echo "No Doxyfile found for project $project"
1880
    exit 1
1881
fi
1882
1883
echo "Project $project contains a Doxyfile at $doxyfile"
1884
1885
cd "$projectdir" || exit 1
1886
1887 228:3c084a25d8ab chris
"$progdir/doxysafe.pl" "$doxyfile" | \
1888
    sed -e '$a OUTPUT_DIRECTORY='"$targetdir" | \
1889 203:1e55195bca45 chris
    doxygen -
1890
1891
#!/bin/bash
1892 168:c1e9f2dab1d5 chris
1893 203:1e55195bca45 chris
docdir="/var/doc"
1894 168:c1e9f2dab1d5 chris
1895 203:1e55195bca45 chris
project="$1"
1896 223:c3544e9fd588 chris
projectdir="$2"
1897
targetdir="$3"
1898 168:c1e9f2dab1d5 chris
1899 223:c3544e9fd588 chris
if [ -z "$project" ] || [ -z "$targetdir" ] || [ -z "$projectdir" ]; then
1900
    echo "Usage: $0 <project> <projectdir> <targetdir>"
1901 203:1e55195bca45 chris
    exit 2
1902 168:c1e9f2dab1d5 chris
fi
1903
1904 223:c3544e9fd588 chris
if [ ! -d "$projectdir" ]; then
1905
    echo "Project directory $projectdir not found"
1906 203:1e55195bca45 chris
    exit 1
1907
fi
1908 168:c1e9f2dab1d5 chris
1909 203:1e55195bca45 chris
if [ ! -d "$targetdir" ]; then
1910
    echo "Target dir $targetdir not found"
1911
    exit 1
1912
fi
1913 168:c1e9f2dab1d5 chris
1914 203:1e55195bca45 chris
if [ -f "$targetdir/index.html" ]; then
1915
    echo "Target dir $targetdir already contains index.html"
1916
    exit 1
1917 178:2cec5c53cd68 chris
fi
1918 168:c1e9f2dab1d5 chris
1919 191:0d1c6fa50d3a chris
# Identify Java files whose packages match the trailing parts of their
1920
# paths, and list the resulting packages and the path prefixes with
1921
# the packages removed (so as to find code in subdirs,
1922
# e.g. src/com/example/...)
1923
1924
# Regexp match is very rough; check what is actually permitted for
1925
# package declarations
1926
1927 203:1e55195bca45 chris
find "$projectdir" -type f -name \*.java \
1928 989:3549525ba22a Chris
    -exec egrep '^ *package +[a-zA-Z][a-zA-Z0-9\._-]*;.*$' \{\} /dev/null \; |
1929
    sed -e 's/\/[^\/]*: *package */:/' -e 's/;.*$//' |
1930 191:0d1c6fa50d3a chris
    sort | uniq | (
1931
	current_prefix=
1932
	current_packages=
1933
	while IFS=: read filepath package; do
1934
	    echo "Looking at $package in $filepath"
1935
	    packagepath=${package//./\/}
1936
	    prefix=${filepath%$packagepath}
1937 203:1e55195bca45 chris
	    prefix=${prefix:=$projectdir}
1938 191:0d1c6fa50d3a chris
	    if [ "$prefix" = "$filepath" ]; then
1939
		echo "Package $package does not match suffix of path $filepath, skipping"
1940
		continue
1941
	    fi
1942
	    if [ "$prefix" != "$current_prefix" ]; then
1943 450:73401a15037b Chris
		echo "Package $package matches file path and has new prefix $prefix"
1944 191:0d1c6fa50d3a chris
		if [ -n "$current_packages" ]; then
1945
		    echo "Running Javadoc for packages $current_packages from prefix $current_prefix"
1946 450:73401a15037b Chris
		    echo "Command is: javadoc -sourcepath "$current_prefix" -d "$targetdir" -subpackages $current_packages"
1947 203:1e55195bca45 chris
		    javadoc -sourcepath "$current_prefix" -d "$targetdir" -subpackages $current_packages
1948 191:0d1c6fa50d3a chris
		fi
1949
		current_prefix="$prefix"
1950 450:73401a15037b Chris
		current_packages="$package"
1951 191:0d1c6fa50d3a chris
	    else
1952 450:73401a15037b Chris
		echo "Package $package matches file path with same prefix as previous file"
1953 191:0d1c6fa50d3a chris
		current_packages="$current_packages $package"
1954
	    fi
1955
	done
1956 203:1e55195bca45 chris
	prefix=${prefix:=$projectdir}
1957 191:0d1c6fa50d3a chris
	if [ -n "$current_packages" ]; then
1958
	    echo "Running Javadoc for packages $current_packages in prefix $current_prefix"
1959 450:73401a15037b Chris
  	    echo "Command is: javadoc -sourcepath "$current_prefix" -d "$targetdir" -subpackages $current_packages"
1960 203:1e55195bca45 chris
	    javadoc -sourcepath "$current_prefix" -d "$targetdir" -subpackages $current_packages
1961 191:0d1c6fa50d3a chris
	fi
1962
    )
1963
1964 450:73401a15037b Chris
if [ -f "$targetdir"/overview-tree.html ]; then
1965
    cp "$targetdir"/overview-tree.html "$targetdir"/index.html
1966
fi
1967
1968 203:1e55195bca45 chris
# for exit code:
1969
[ -f "$targetdir/index.html" ]
1970 168:c1e9f2dab1d5 chris
1971 411:e7ba81c8dc5a chris
#!/bin/bash
1972
1973
docdir="/var/doc"
1974
1975
progdir=$(dirname $0)
1976
case "$progdir" in
1977
    /*) ;;
1978
    *) progdir="$(pwd)/$progdir" ;;
1979
esac
1980
1981
project="$1"
1982
projectdir="$2"
1983
targetdir="$3"
1984
1985
if [ -z "$project" ] || [ -z "$targetdir" ] || [ -z "$projectdir" ]; then
1986
    echo "Usage: $0 <project> <projectdir> <targetdir>"
1987
    exit 2
1988
fi
1989
1990
if [ ! -d "$projectdir" ]; then
1991
    echo "Project directory $projectdir not found"
1992
    exit 1
1993
fi
1994
1995
if [ ! -d "$targetdir" ]; then
1996
    echo "Target dir $targetdir not found"
1997
    exit 1
1998
fi
1999
2000
if [ -f "$targetdir/index.html" ]; then
2001
    echo "Target dir $targetdir already contains index.html"
2002
    exit 1
2003
fi
2004
2005
mfile=$(find "$projectdir" -type f -name \*.m -print0 | xargs -0 grep -l '^% ' | head -1)
2006
2007
if [ -z "$mfile" ]; then
2008
    echo "No MATLAB files with comments found for project $project"
2009
    exit 1
2010
fi
2011
2012
echo "Project $project contains at least one MATLAB file with comments"
2013
2014
cd "$projectdir" || exit 1
2015
2016
perl "$progdir/matlab-docs.pl" -c "$progdir/matlab-docs.conf" -d "$targetdir"
2017
2018 978:bbb88c44f805 Chris
2019 980:9b4919de5317 Chris
# Read an Apache log file in SoundSoftware site format from stdin and
2020
# produce some per-project stats.
2021 978:bbb88c44f805 Chris
#
2022
# Invoke with e.g.
2023
#
2024
# cat /var/log/apache2/code-access.log | \
2025
#   script/runner -e production extra/soundsoftware/get-apache-log-stats.rb
2026
2027 975:198f764e734c Chris
2028
# Use the ApacheLogRegex parser, a neat thing
2029
# See http://www.simonecarletti.com/blog/2009/02/apache-log-regex-a-lightweight-ruby-apache-log-parser/
2030
require 'apachelogregex'
2031
2032
# This is the format defined in our httpd.conf
2033
vhost_combined_format = '%v:%p %h %{X-Forwarded-For}i %l %u %t \"%r\" %>s %O \"%{Referer}i\" \"%{User-Agent}i\"'
2034
2035
parser = ApacheLogRegex.new(vhost_combined_format)
2036
2037
# project name -> count of hg clones
2038
clones = Hash.new(0)
2039
2040
# project name -> count of hg pulls
2041
pulls = Hash.new(0)
2042
2043 978:bbb88c44f805 Chris
# project name -> count of hg pushes
2044
pushes = Hash.new(0)
2045 975:198f764e734c Chris
2046
# project name -> count of hg archive requests (i.e. Download as Zip)
2047
zips = Hash.new(0)
2048
2049
# project name -> count of hits to pages under /projects/projectname
2050
hits = Hash.new(0)
2051
2052 978:bbb88c44f805 Chris
# project name -> Project object
2053
@projects = Hash.new
2054
2055 975:198f764e734c Chris
parseable = 0
2056
unparseable = 0
2057
2058 979:56a38a9f6204 Chris
def is_public_project?(project)
2059 978:bbb88c44f805 Chris
  if !project
2060
    false
2061 983:a97e573d7f87 Chris
  elsif project =~ /^\d+$/
2062
    # ignore numerical project ids, they are only used when editing projects
2063
    false
2064 978:bbb88c44f805 Chris
  elsif @projects.key?(project)
2065 979:56a38a9f6204 Chris
    @projects[project].is_public?
2066 978:bbb88c44f805 Chris
  else
2067
    pobj = Project.find_by_identifier(project)
2068
    if pobj
2069
      @projects[project] = pobj
2070 979:56a38a9f6204 Chris
      pobj.is_public?
2071 978:bbb88c44f805 Chris
    else
2072 979:56a38a9f6204 Chris
      print "Project not found: ", project, "\n"
2073 978:bbb88c44f805 Chris
      false
2074
    end
2075
  end
2076
end
2077
2078 980:9b4919de5317 Chris
def print_stats(h)
2079
  h.keys.sort { |a,b| h[b] <=> h[a] }.each do |p|
2080 982:6edb748be064 Chris
    if h[p] > 0
2081 983:a97e573d7f87 Chris
      print h[p], " ", @projects[p].name, " [", p, "]\n"
2082 982:6edb748be064 Chris
    end
2083 980:9b4919de5317 Chris
  end
2084
end
2085
2086 979:56a38a9f6204 Chris
STDIN.each do |line|
2087 975:198f764e734c Chris
2088
  record = parser.parse(line)
2089
2090
  # most annoyingly, the parser can't handle the comma-separated list
2091
  # in X-Forwarded-For where it has more than one element. If it has
2092 983:a97e573d7f87 Chris
  # failed, remove any IP addresses or the word "unknown" with
2093
  # trailing commas and try again
2094 975:198f764e734c Chris
  if not record
2095 983:a97e573d7f87 Chris
    filtered = line.gsub(/(unknown|([0-9]+\.){3}[0-9]+),\s*/, "")
2096 975:198f764e734c Chris
    record = parser.parse(filtered)
2097
  end
2098
2099
  # discard, but count, unparseable lines
2100
  if not record
2101 979:56a38a9f6204 Chris
    print "Line not parseable: ", line, "\n"
2102 975:198f764e734c Chris
    unparseable += 1
2103
    next
2104
  end
2105
2106
  # discard everything that isn't a 200 OK response
2107
  next if record["%>s"] != "200"
2108
2109
  # discard anything apparently requested by a crawler
2110
  next if record["%{User-Agent}i"] =~ /(bot|slurp|crawler|spider|Redmine)\b/i
2111
2112
  # pull out request e.g. GET / HTTP/1.0
2113
  request = record["%r"]
2114
2115
  # split into method, path, protocol
2116
  if not request =~ /^[^\s]+ ([^\s]+) [^\s]+$/
2117 979:56a38a9f6204 Chris
    print "Line not parseable (bad method, path, protocol): ", line, "\n"
2118 975:198f764e734c Chris
    unparseable += 1
2119
    next
2120
  end
2121
2122
  # get the path e.g. /projects/weevilmatic and split on /
2123
  path = $~[1]
2124
  components = path.split("/")
2125
2126
  # should have at least two elements unless path is "/"; first should
2127
  # be empty (begins with /)
2128
  if path != "/" and (components.size < 2 or components[0] != "")
2129 979:56a38a9f6204 Chris
    print "Line not parseable (degenerate path): ", line, "\n"
2130 975:198f764e734c Chris
    unparseable += 1
2131
    next
2132
  end
2133
2134
  if components[1] == "hg"
2135
2136
    # path is /hg/project?something or /hg/project/something
2137
2138
    project = components[2].split("?")[0]
2139 979:56a38a9f6204 Chris
    if not is_public_project?(project)
2140 978:bbb88c44f805 Chris
      next
2141
    end
2142 975:198f764e734c Chris
2143
    if components[2] =~ /&roots=00*$/
2144
      clones[project] += 1
2145
    elsif components[2] =~ /cmd=capabilities/
2146
      pulls[project] += 1
2147 978:bbb88c44f805 Chris
    elsif components[2] =~ /cmd=unbundle/
2148
      pushes[project] += 1
2149 975:198f764e734c Chris
    elsif components[3] == "archive"
2150
      zips[project] += 1
2151
    end
2152
2153
  elsif components[1] == "projects"
2154
2155
    # path is /projects/project or /projects/project/something
2156
2157
    project = components[2]
2158 979:56a38a9f6204 Chris
    project = project.split("?")[0] if project
2159
    if not is_public_project?(project)
2160 978:bbb88c44f805 Chris
      next
2161 975:198f764e734c Chris
    end
2162
2163 978:bbb88c44f805 Chris
    hits[project] += 1
2164
2165 975:198f764e734c Chris
  end
2166
2167
  parseable += 1
2168
end
2169
2170
# Each clone is also a pull; deduct it from the pulls hash, because we
2171
# want that to contain only non-clone pulls
2172
2173
clones.keys.each do |project|
2174
  pulls[project] -= 1
2175
end
2176
2177 982:6edb748be064 Chris
print parseable, " parseable\n"
2178
print unparseable, " unparseable\n"
2179
2180
2181 980:9b4919de5317 Chris
print "\nMercurial clones:\n"
2182
print_stats clones
2183
2184
print "\nMercurial pulls (excluding clones):\n"
2185
print_stats pulls
2186
2187
print "\nMercurial pushes:\n"
2188
print_stats pushes
2189
2190
print "\nMercurial archive (zip file) downloads:\n"
2191
print_stats zips
2192
2193 982:6edb748be064 Chris
print "\nProject page hits (excluding crawlers):\n"
2194 980:9b4919de5317 Chris
print_stats hits
2195 975:198f764e734c Chris
2196
2197 1536:e2a3230f61fa Chris
2198
# Print out an authormap file for hg-to-git conversion using
2199
# hg-fast-export
2200
#
2201
# Invoke with the project identifier as argument, e.g.
2202
#
2203
# ./script/rails runner -e production extra/soundsoftware/get-repo-authormap.rb soundsoftware-site
2204
2205 1537:e55cbb9ba8bf Chris
proj_ident = ARGV.last
2206 1536:e2a3230f61fa Chris
proj = Project.find_by_identifier(proj_ident)
2207
repo = Repository.where(:project_id => proj.id).first
2208
csets = Changeset.where(:repository_id => repo.id)
2209
committers = csets.map do |c| c.committer end.sort.uniq
2210
committers.each do |c|
2211 1537:e55cbb9ba8bf Chris
  if not c =~ /[^<]+<.*@.*>/ then
2212
    u = repo.find_committer_user c
2213
    print "#{c}=#{u.name} <#{u.mail}>\n" unless u.nil?
2214
  end
2215 1536:e2a3230f61fa Chris
end
2216 970:6bd8364eafae luis
2217 1453:b554eb79ec7b luis
# Log user and project information
2218
#
2219
# Invoke with e.g.
2220
#
2221
# ./script/rails runner -e production extra/soundsoftware/get-statistics.rb
2222 970:6bd8364eafae luis
#
2223
2224 1454:02a05da0bedc luis
projectStats =  {
2225
        :all => Project.active.all.count,
2226
        :private => Project.active.find(:all, :conditions => {:is_public => false}).count,
2227
        :top_level => Project.active.find(:all, :conditions => {:parent_id => nil}).count,
2228
        :top_level_and_private => Project.active.find(:all, :conditions => {:is_public => false, :parent_id => nil}).count
2229
      }
2230 970:6bd8364eafae luis
2231 1453:b554eb79ec7b luis
userStats = {:all => User.active.all.count}
2232 1002:f6ede18f3e6e Chris
2233 1453:b554eb79ec7b luis
stats = {:date => Date.today, :projects => projectStats, :users => userStats}.to_json
2234 1002:f6ede18f3e6e Chris
2235 1453:b554eb79ec7b luis
print "#{stats}\n"
2236 1002:f6ede18f3e6e Chris
2237 383:47ae83ce8db8 Chris
<div style="clear: both; float: right"><small><i>Produced by mtree2html by Hartmut Pohlheim</i></small></div>
2238
# configuration file for generation of html-docu from m-files
2239
#
2240
# Author:   Hartmut Pohlheim
2241
# History:  05.11.2000  file created (parameters for mtree2html2001)
2242
#
2243
# The following options/variables must be changed/adapted:
2244
#   dirmfiles
2245
#   dirhtml
2246
#   csslink
2247
#   texttitleframelayout
2248
#   texttitlefiles
2249
#
2250
# The following options/variables should be adapted:
2251
#   authorfile
2252
#   filenametopframe
2253
#   codeheadmeta
2254
2255
#========================================================================
2256
# Variables (possible keywords: set)
2257
# to use the built-in settings, comment the line using # in first column
2258
#========================================================================
2259
2260
#------------------------------------------------------------------------
2261
# dirmfiles: name of directory containing Matlab m-files
2262
# dirhtml: name of directory to place the html-files into
2263
# exthtml: extension used for the html files (.html or .htm)
2264
#          don't forget the point in front of the extension
2265
#------------------------------------------------------------------------
2266
set dirmfiles = .
2267
set dirhtml = doc-output
2268
set exthtml = .html
2269
2270
#------------------------------------------------------------------------
2271
# authorfile:   name of file containing info about author (in html)
2272
#               if defined, this text is included at the bottom of the
2273
#               html files
2274
#------------------------------------------------------------------------
2275 410:675de8e6becf chris
set authorfile = matlab-docs-credit.html
2276 383:47ae83ce8db8 Chris
2277
#------------------------------------------------------------------------
2278
# csslink:   text for linking to css file (style sheets)
2279
#            the text defined here is directly included into the head
2280
#            of the html file
2281
#------------------------------------------------------------------------
2282 410:675de8e6becf chris
#set csslink = <link rel=stylesheet type="text/css" href="CSSFILENAME.css" />
2283 383:47ae83ce8db8 Chris
2284
#------------------------------------------------------------------------
2285
# links2filescase: this is a bit difficult
2286
#                  Matlab is case sensitive on UNIX, but case insensitive
2287
#                  on Windows. Under UNIX Matlab function calls work
2288
#                  only, when the case of file name and function call are
2289
#                  identical, under Windows you can do what you want.
2290
#                  This scripts help you, to keep an exact case in your
2291
#                  project.
2292
#          exact - internal links are only generated, when case of file
2293
#                  name and in source code are identical
2294
#            all - case doesn't matter
2295
#     exactupper - same as exact, additionally links are also vreated to
2296
#                  all upper case function names in source code (often
2297
#                  used by Mathworks)
2298
#      exactvery - same as exact, additionally info about not matching
2299
#                  case is written to screen (stdout), this can be very
2300
#                  helpful in cleaning up the case in a project
2301
#------------------------------------------------------------------------
2302
set links2filescase = all
2303
2304
#------------------------------------------------------------------------
2305
# texttitleframelayout:    text of title for frame layout file (whole docu)
2306
#------------------------------------------------------------------------
2307 389:0bc92382a86b chris
set texttitleframelayout = MATLAB Function Documentation
2308 383:47ae83ce8db8 Chris
2309
#------------------------------------------------------------------------
2310
# texttitle/headerindexalldirs: text of title and header for directory index
2311
#------------------------------------------------------------------------
2312
set texttitleindexalldirs = Index of Directories
2313
set textheaderindexalldirs = Index of Directories
2314
2315
#------------------------------------------------------------------------
2316
# texttitle/headerindex:    text of title and header for index file
2317
#------------------------------------------------------------------------
2318
set texttitleindex = A-Z Index of Functions
2319
set textheaderindex = A-Z Index of Functions
2320
2321
#------------------------------------------------------------------------
2322
# texttitle/headerfiles:    text of title and header for files
2323
#                           name of file will be added at the end
2324
#------------------------------------------------------------------------
2325 389:0bc92382a86b chris
set texttitlefiles = Function
2326 383:47ae83ce8db8 Chris
set textheaderfiles = Documentation of
2327
2328
#------------------------------------------------------------------------
2329
# frames: whether to use frames in layout (yes or no)
2330
#------------------------------------------------------------------------
2331
set frames = no
2332
2333
#------------------------------------------------------------------------
2334
# filenametopframe: name of file including frame layout (highest level file)
2335
# [default: index]
2336
#------------------------------------------------------------------------
2337
set filenametopframe = index
2338
2339
#------------------------------------------------------------------------
2340
# textjumpindexglobal: text displayed for jump to index of all files
2341
#                      (global)
2342
# textjumpindexlocal:  text displayed for jump to index of files in actual
2343
#                      directory (local)
2344
#------------------------------------------------------------------------
2345 389:0bc92382a86b chris
set textjumpindexglobal = <b>Index of</b> all files:
2346
set textjumpindexlocal = this subdirectory only:
2347 383:47ae83ce8db8 Chris
2348
#------------------------------------------------------------------------
2349
# includesource: include source of m-files in documentation [YES|no]
2350
#------------------------------------------------------------------------
2351
set includesource = yes
2352
2353
#------------------------------------------------------------------------
2354
# usecontentsm: use contents.m files as well for structured
2355
#               (hopefully) index [YES|no]
2356
#------------------------------------------------------------------------
2357
set usecontentsm = no
2358
2359
#------------------------------------------------------------------------
2360
# includesource: write/update contents.m files [yes|NO]
2361
#------------------------------------------------------------------------
2362
set writecontentsm = no
2363
2364
#------------------------------------------------------------------------
2365
# processtree:  parse whole directory tree recursively [YES|no]
2366
#------------------------------------------------------------------------
2367
set processtree = yes
2368
2369
#------------------------------------------------------------------------
2370
# producetree:  produce tree for html-files in same structure than
2371
#		          tree of m-files [yes|NO]
2372
#               if no, all files are saved in the same directory, often
2373
#               easier for outside linking to files
2374
#------------------------------------------------------------------------
2375 401:a0f6e994657f chris
set producetree = yes
2376 383:47ae83ce8db8 Chris
2377
#------------------------------------------------------------------------
2378
# codebodyindex/files: HTML-code for adding to BODY tag
2379
#                      can be used for defining colors and
2380
#                      backgroundimages of the files
2381
#                      No longer recommended, use the css file
2382
#------------------------------------------------------------------------
2383
set codebodyindex =
2384
set codebodyfiles =
2385
2386
#------------------------------------------------------------------------
2387
# codeheadmeta: HTML-code added in HEAD area, use for supplying META info
2388
#------------------------------------------------------------------------
2389
set codeheadmeta =
2390
2391
#------------------------------------------------------------------------
2392
# codehr: HTML-code used to define a <HR>, do what you want
2393
#------------------------------------------------------------------------
2394 411:e7ba81c8dc5a chris
set codehr = <hr>
2395 383:47ae83ce8db8 Chris
2396
#------------------------------------------------------------------------
2397
# codeheader: HTML-code added to <H*> tags, use for centering header text
2398
#             or changing the colour/size/font of the header text
2399
#------------------------------------------------------------------------
2400 389:0bc92382a86b chris
set codeheader =
2401 383:47ae83ce8db8 Chris
2402
2403
# End of parameter file
2404 381:2dc8163e9150 Chris
@rem = '--*-Perl-*--';
2405
@rem = '
2406
@echo off
2407
perl -w -S %0.bat %1 %2 %3 %4 %5 %6 %7 %8 %9
2408
goto endofperl
2409
@rem ';
2410
# perl -w -S %0.bat "$@"
2411 382:baff1c482d98 Chris
#!/usr/bin/perl
2412 381:2dc8163e9150 Chris
#
2413
# mtree2html_2000 - produce html files from Matlab m-files.
2414
#                   use configuration file for flexibility
2415
#                   can process tree of directories
2416
#
2417
# Copyright (C) 1996-2000 Hartmut Pohlheim.  All rights reserved.
2418
# includes small parts of m2html from Jeffrey C. Kantor 1995
2419
#
2420
# Author:  Hartmut Pohlheim
2421
# History: 06.03.1996  file created
2422
#          07.03.1996  first working version
2423
#          08.03.1996  modularized, help text only once included
2424
#          11.03.1996  clean up, some functions rwritten
2425
#          18.04.1996  silent output with writing in one line only
2426
#                      version 0.20 fixed
2427
#          14.05.1996  start of adding tree structure, could create tree
2428
#          15.05.1996  creating of index files for every directory
2429
#          17.05.1996  first working version except compact A-Z index
2430
#          20.05.1996  cleanup of actual version, more variables and
2431
#                      configurable settings
2432
#          21.05.1996  reading, update and creation of contents.m added
2433
#          22.05.1996  creation of short index started
2434
#          28.05.1996  jump letters for short index,
2435
#                      3 different directory indexes (short/long/contents)
2436
#          29.05.1996  major cleanup, short and long index created from one function
2437
#                      links for HTML and Indexes from 1 function,
2438
#                      version 0.9
2439
#          30.05.1996  contents.m changed to Contents.m (because unix likes it)
2440
#                      function definition can be in first line of m file before comments
2441
#                      version 0.91 fixed
2442
#          03.06.1996  contents file can be written as wanted, the links will be correct
2443
#                      cross references in help block of m-file will be found and
2444
#                      converted, even if the name of the function is written upper case
2445
#                      version 0.92 fixed
2446
#          05.06.1996  construction of dependency matrix changed, is able now to process
2447
#                      even the whole matlab tree (previous version needed to much memory)
2448
#                      removed warning for contents files in different directories
2449
#                      version 0.94 fixed
2450
#          06.06.1996  new link name matrices for ConstructHTMLFile created,
2451
#                      everything is done in ConstructDependencyMatrix,
2452
#                      both dependencies (calls and called) and matrix
2453
#                      with all mentioned names in this m-file, thus, much
2454
#                      less scanning in html construction
2455
#                      script is now (nearly) linear scalable, thus, matlab-toolbox
2456
#                      tree takes less than 1 hour on a Pentium120, with source
2457
#                      version 0.96 fixed
2458
#          10.06.1996  order of creation changed, first all indexes (includes
2459
#                      update/creation of contents.m) and then ConstructDepency
2460
#                      thus, AutoAdd section will be linked as well
2461
#                      excludenames extended, some more common word function names added
2462
#                      version 0.97 fixed
2463
#          17.02.1998  writecontentsm as command line parameter added
2464
#                      error of file not found will even appear when silent
2465
#                      version 1.02
2466
#          21.05.2000  mark comments in source code specially (no fully correct,
2467
#                      can't handle % in strings)
2468
#                      version 1.11
2469
#          05.11.2000  link also to upper and mixed case m-files
2470
#                      searching for .m files now really works (doesn't find grep.com any longer)
2471
#                      file renamed to mtree2html2001
2472
#                      generated html code now all lower case
2473
#                      inclusion of meta-description and meta-keywords in html files
2474
#                      HTML4 compliance done (should be strict HTML4.0, quite near XHTML)
2475
#                      version 1.23
2476
#
2477 383:47ae83ce8db8 Chris
#	   29.03.2011  (Chris Cannam) add frames option.
2478 381:2dc8163e9150 Chris
2479
$VERSION  = '1.23';
2480
($PROGRAM = $0) =~ s@.*/@@; $PROGRAM = "\U$PROGRAM\E";
2481 411:e7ba81c8dc5a chris
$debug = 1;
2482 381:2dc8163e9150 Chris
2483
#------------------------------------------------------------------------
2484
# Define platform specific things
2485
#------------------------------------------------------------------------
2486
# suffix for files to search is defined twice
2487
# the first ($suffix) is for string creation and contains the . as well
2488
# the second ($suffixforsearch) is for regular expression, handling of . is quite special
2489
$suffix = ".m";
2490
$suffixforsearch = "m";
2491
# the directory separator
2492
$dirsep = "/";
2493
# what is the current directory
2494
$diract = ".";
2495
2496
#------------------------------------------------------------------------
2497 382:baff1c482d98 Chris
#  Define all variables and their standard settings
2498 381:2dc8163e9150 Chris
#  documentation of variables is contained in accompanying rc file
2499
#------------------------------------------------------------------------
2500
%var =
2501
(
2502
   'authorfile',                '',
2503
   'codebodyfiles',             '',
2504
   'codebodyindex',             '',
2505
   'codeheadmeta',              '<meta name="author of conversion perl script" content="Hartmut Pohlheim" />',
2506
   'codehr',                    '<hr size="3" noshade="noshade" />',
2507
   'codeheader',                '',
2508 383:47ae83ce8db8 Chris
   'configfile',                'matlab-docs.conf',
2509 381:2dc8163e9150 Chris
   'csslink',                   '',
2510
   'dirmfiles',                 $diract,
2511
   'dirhtml',                   $diract,
2512
   'exthtml',                   '.html',
2513 382:baff1c482d98 Chris
   'frames',                    'yes',
2514 381:2dc8163e9150 Chris
   'filenametopframe',          'index',
2515
   'filenameindexlongglobal',   'indexlg',
2516
   'filenameindexlonglocal',    'indexll',
2517
   'filenameindexshortglobal',  'indexsg',
2518
   'filenameindexshortlocal',   'indexsl',
2519
   'filenameextensionframe',    'f',
2520
   'filenameextensionindex',    'i',
2521
   'filenameextensionjump',     'j',
2522
   'filenamedirshort',          'dirtops',
2523
   'filenamedirlong',           'dirtopl',
2524
   'filenamedircontents',       'dirtopc',
2525
   'includesource',             'yes',
2526
   'links2filescase',           'all',
2527
   'processtree',               'yes',
2528
   'producetree',               'yes',
2529
   'textjumpindexlocal',        'Local Index',
2530
   'textjumpindexglobal',       'Global Index',
2531
   'texttitleframelayout',      'Documentation of Matlab Files',
2532
   'texttitleindexalldirs',     'Index of Directories',
2533
   'textheaderindexalldirs',    'Index of Directories',
2534
   'texttitleindex',            '',
2535
   'textheaderindex',           '',
2536
   'texttitlefiles',            'Documentation of ',
2537
   'textheaderfiles',           'Documentation of ',
2538
   'usecontentsm',              'yes',
2539
   'writecontentsm',            'no'
2540
);
2541
2542
2543
# define all m-file names, that should be excluded from linking
2544
# however, files will still be converted
2545
@excludenames = ( 'all','ans','any','are',
2546
                  'cs',
2547
                  'demo','dos',
2548
                  'echo','edit','else','elseif','end','exist',
2549
                  'flag','for','function',
2550
                  'global',
2551
                  'help',
2552
                  'i','if','inf','info',
2553
                  'j',
2554
                  'more',
2555
                  'null',
2556
                  'return',
2557
                  'script','strings',
2558
                  'what','which','while','who','whos','why',
2559
                );
2560
2561
# Text for inclusion in created HTML/Frame files: Doctype and Charset
2562
$TextDocTypeHTML  = '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN" "http://www.w3.org/TR/REC-html40/strict.dtd">';
2563
$TextDocTypeFrame = '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Frameset//EN" "http://www.w3.org/TR/REC-html40/frameset.dtd">';
2564
$TextMetaCharset = '<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />';
2565
2566
#------------------------------------------------------------------------
2567
# Read the command line arguments
2568
#------------------------------------------------------------------------
2569
if (@ARGV == 0) {
2570
   &DisplayHelp()  if &CheckFileName($var{'configfile'}, 'configuration file');
2571
}
2572
2573
# Print provided command line arguments on screen
2574
foreach (@ARGV) { print "   $_\n      "; }
2575
2576
# Get the options
2577
use Getopt::Long;
2578
@options = ('help|h', 'todo|t', 'version|v',
2579
            'authorfile|a=s', 'configfile|c=s', 'dirhtml|html|d=s',
2580
            'dirmfiles|mfiles|m=s', 'includesource|i=s',
2581
            'processtree|r=s', 'producetree|p=s',
2582
            'silent|quiet|q', 'writecontentsm|w=s');
2583
&GetOptions(@options) || die "use -h switch to display help statement\n";
2584
2585
2586
# Display help or todo list, when requested
2587
&DisplayHelp()                         if $opt_help;
2588
&DisplayTodo()                         if $opt_todo;
2589
die "$PROGRAM v$VERSION\n"             if $opt_version;
2590
2591
$exit_status = 0;
2592
2593
#------------------------------------------------------------------------
2594
# Read the config file
2595
#------------------------------------------------------------------------
2596
$var{'configfile'} = $opt_configfile         if $opt_configfile;
2597
&GetConfigFile($var{'configfile'});
2598
2599
2600
#------------------------------------------------------------------------
2601
# Process/Check the command line otions
2602
#------------------------------------------------------------------------
2603
$var{'dirhtml'}   = $opt_dirhtml              if $opt_dirhtml;
2604
if (!(substr($var{'dirhtml'}, -1, 1) eq $dirsep)) { $var{'dirhtml'} = $var{'dirhtml'}.$dirsep; }
2605
$var{'dirmfiles'} = $opt_dirmfiles            if $opt_dirmfiles;
2606
if (!(substr($var{'dirmfiles'}, -1, 1) eq $dirsep)) { $var{'dirmfiles'} = $var{'dirmfiles'}.$dirsep; }
2607
2608
$var{'authorfile'} = $opt_author              if $opt_author;
2609
$var{'includesource'} = $opt_includesource    if $opt_includesource;
2610
if ($var{'includesource'} ne 'no') { $var{'includesource'} = 'yes'; }
2611
$var{'processtree'} = $opt_processtree        if $opt_processtree;
2612
if ($var{'processtree'} ne 'no') { $var{'processtree'} = 'yes'; }
2613
$var{'producetree'} = $opt_producetree        if $opt_producetree;
2614
if ($var{'producetree'} ne 'no') { $var{'producetree'} = 'yes'; }
2615
if ($var{'processtree'} eq 'no') { $var{'producetree'} = 'no'; }
2616 382:baff1c482d98 Chris
if ($var{'frames'} ne 'no') { $var{'frames'} = 'yes'; }
2617 381:2dc8163e9150 Chris
# if (($var{'processtree'} eq 'yes') && ($var{'producetree'} eq 'no')) { $var{'usecontentsm'} = 'no'; }
2618
2619
$var{'writecontentsm'} = $opt_writecontentsm  if $opt_writecontentsm;
2620
2621
#------------------------------------------------------------------------
2622
# Do the real stuff
2623
#------------------------------------------------------------------------
2624
2625
# Print variables on screen, when not silent
2626
&ListVariables                          if !$opt_silent;
2627
2628
# Check the author file
2629
if ($var{'authorfile'} ne '') {
2630 410:675de8e6becf chris
    if (!($var{'authorfile'} =~ m,^/,)) {
2631
	# relative path: treat as relative to config file
2632
	my $cfd = $var{'configfile'};
2633
	$cfd =~ s,/[^/]*$,/,;
2634
	$cfd =~ s,^[^/]*$,.,;
2635
	$var{'authorfile'} = "$cfd/" . $var{'authorfile'};
2636
    }
2637
    if (&CheckFileName($var{'authorfile'}, 'author file')) {
2638
	$var{'authorfile'} = '';
2639
	if (!$opt_silent) { print "   Proceeding without author information!\n"; }
2640
    }
2641 381:2dc8163e9150 Chris
}
2642
2643
# Call the function doing all the real work
2644
&ConstructNameMatrix;
2645
2646
&ConstructDependencyMatrix;
2647
2648
&ConstructAllIndexFiles;
2649
2650
&ConstructHTMLFiles;
2651
2652
exit $exit_status;
2653
2654
#------------------------------------------------------------------------
2655
# Construct list of all mfile names and initialize various data arrays.
2656
#------------------------------------------------------------------------
2657
sub ConstructNameMatrix
2658
{
2659
   local(*MFILE);
2660
   local($file, $dirname);
2661
   local(@newdirectories);
2662
   local(%localnames);
2663
2664
   $RecDeep = 0;
2665
   &ParseTreeReadFiles($var{'dirmfiles'}, $RecDeep);
2666
2667
   foreach $dirname (@directories) {
2668
      if ($dirnumbermfiles{$dirname} > 0) {
2669
         push(@newdirectories, $dirname);
2670
         if (! defined($contentsname{$dirname})) {
2671
            $contentsname{$dirname} = 'Contents';
2672
            if (($var{'writecontentsm'} eq 'no') && ($var{'usecontentsm'} eq 'yes')) {
2673
               print "\r ParseTree - for directory  $dirname  no contents file found!\n";
2674
               print   "             create one or enable writing of contents file (writecontentsm = yes)!\n";
2675
            }
2676
         }
2677
      }
2678
   }
2679
   @alldirectories = @directories;
2680
   @directories = @newdirectories;
2681
2682
   foreach $dirname (@directories) {
2683
      if ($debug > 0) { print "Dir: $dirname \t\t $dirnumbermfiles{$dirname} \t$contentsname{$dirname}\n"; }
2684
   }
2685
2686
   @names = sort(keys %mfile);
2687
2688
   # check, if name of directory is identical to name of file
2689
   @dirsinglenames = values(%dirnamesingle);
2690
   grep($localnames{$_}++, @dirsinglenames);
2691
   @dirandfilename = grep($localnames{$_}, @names);
2692
   if (@dirandfilename) {
2693
      print "\r   Name clash between directory and file name: @dirandfilename\n";
2694
      print   "      These files will be excluded from linking!\n";
2695
      push(@excludenames, @dirandfilename);
2696
   }
2697
2698
   # construct names matrix for help text linking
2699
   #    exclude some common words (and at the same time m-functions) from linking in help text
2700
   grep($localnames{$_}++, @excludenames);
2701
   @linknames = grep(!$localnames{$_}, @names);
2702
2703
   if ($debug > 2) { print "linknames (names of found m-files):\n    @linknames\n"; }
2704
2705
}
2706
2707
#------------------------------------------------------------------------
2708
# Parse tree and collect all Files
2709
#------------------------------------------------------------------------
2710
sub ParseTreeReadFiles
2711
{
2712
   local($dirname, $localRecDeep) = @_;
2713
   local($file, $name, $filewosuffix);
2714
   local($dirhtmlname, $dirmode);
2715
   local($relpath, $relpathtoindex, $replacevardir);
2716
   local(*CHECKDIR, *AKTDIR);
2717
   local(@ALLEFILES);
2718
2719
   opendir(AKTDIR, $dirname) || die "ParseTree - Can't open directory $dirname: $!";
2720
   if ($debug > 1) { print "\nDirectory: $dirname\n"; }
2721
2722
   # create relative path
2723
   $_ = $dirname; $replacevardir = $var{'dirmfiles'};
2724
   s/$replacevardir//; $relpath = $_;
2725
   s/[^\/]+/../g; $relpathtoindex = $_;
2726
2727
   # producetree no
2728
   if ($var{'producetree'} eq 'no') { $relpath = ''; $relpathtoindex = ''; }
2729
2730
   # names of directories (top-level and below top-level m-file-directory)
2731
   push(@directories, $dirname);
2732
   $dirnumbermfiles{$dirname} = 0;    # set number of m-files for this dir to zero
2733
   # relative path from top-level directory, depends on directory name
2734
   $dirnamerelpath{$dirname} = $relpath;
2735
   # relative path from actual directory to top-level directory, depends on directory name
2736
   $dirnamerelpathtoindex{$dirname} = $relpathtoindex;
2737
   # recursion level for directory, depends on directory name
2738
   $dirnamerecdeep{$dirname} = $localRecDeep;
2739
2740
   # only the name of the directory, without path
2741
   $rindexprint = rindex($dirname, $dirsep, length($dirname)-2);
2742
   $rindsub = substr($dirname, $rindexprint+1, length($dirname)-$rindexprint-2);
2743
   $dirnamesingle{$dirname} = $rindsub;
2744
2745
   # create name of html-directories
2746
   $_ = $dirname;
2747
   s/$var{'dirmfiles'}/$var{'dirhtml'}/;
2748
   $dirhtmlname = $_;
2749
   if ($var{'producetree'} eq 'no') { $dirhtmlname = $var{'dirhtml'}; }
2750
   # try to open html directory, if error, then create directory,
2751
   # use same mode as for corresponding m-file directory
2752
   opendir(CHECKDIR,"$dirhtmlname") || do {
2753
      $dirmode = (stat($dirname))[2]; # print "$dirmode\n";
2754
      mkdir("$dirhtmlname", $dirmode) || die ("Cannot create directory $dirhtmlname: $! !");
2755
   };
2756
   closedir(CHECKDIR);
2757
2758
2759
   # read everything from this directory and process them
2760
   @ALLEFILES = readdir(AKTDIR);
2761
2762
   foreach $file (@ALLEFILES) {
2763
      # exclude . and .. directories
2764
      next if $file eq '.';  next if $file eq '..';
2765
2766
      # test for existense of entry (redundant, used for debugging)
2767
      if (-e $dirname.$file) {
2768
         # if it's a directory, call this function recursively
2769
         if (-d $dirname.$file) {
2770
            if ($var{'processtree'} eq 'yes') {
2771
               &ParseTreeReadFiles($dirname.$file.$dirsep, $localRecDeep+1);
2772
            }
2773
         }
2774
         # if it's a file - test for m-file, save name and create some arrays
2775
         elsif (-f $dirname.$file) {
2776
            if ($file =~ /\.$suffixforsearch$/i) {
2777
               # Remove the file suffix to establish the matlab identifiers
2778
               $filewosuffix = $file;
2779
               $filewosuffix =~ s/\.$suffixforsearch$//i;
2780
               # $filename = $name;
2781
2782
               # Contents file in unix must start with a capital letter (Contents.m)
2783
               # ensure, that m-file name is lower case, except the contents file
2784
               if (! ($filewosuffix =~ /^contents$/i)) {
2785 388:dad587ecb8d0 chris
		   # if ($var{'links2filescase'}  eq 'low') { $filewosuffix = "\L$filewosuffix\E"; }
2786 381:2dc8163e9150 Chris
                  $filewosuffixlow = "\L$filewosuffix\E";
2787
               }
2788
               else { $contentsname{$dirname} = $filewosuffix; }
2789
2790
               # internal handle name is always lower case
2791
               $name     = $filewosuffixlow;
2792
               # file name is not lower case
2793
               $filename = $filewosuffix;
2794
2795
               # if don't use C|contents.m, then forget all C|contents.m
2796
               if ($var{'usecontentsm'} eq 'no') { if ($name =~ /contents/i) { next; } }
2797
2798
               # if m-file with this name already exists, use directory and name for name
2799
               # only the first occurence of name will be used for links
2800
               if (defined $mfile{$name}) {
2801
                  if (! ($name =~ /^contents$/i) ) {
2802
                     print "\r ParseTree - Name conflict:  $name in $dirname already exists: $mfile{$name} !\n";
2803
                     print   "             $mfile{$name}  will be used for links!\n";
2804
                  }
2805
                  $name = $dirname.$name;
2806
               }
2807
               # mfile name with path
2808
               $mfile{$name} = $dirname.$file;
2809
               # mfile name (without path)
2810
               $mfilename{$name} = $filename;
2811
               # mfile directory
2812
               $mfiledir{$name} = $dirname;
2813
2814
               # html file name and full path, special extension of Contents files
2815
               if ($name =~ /contents/i) { $extrahtmlfilename = $dirnamesingle{$dirname}; }
2816
               else { $extrahtmlfilename = ''; }
2817
               $hfile{$name} = $dirhtmlname.$mfilename{$name}.$extrahtmlfilename.$var{'exthtml'};
2818
2819
               # save relative html path
2820
               # if ($var{'producetree'} eq 'yes') {
2821
               $hfilerelpath{$name} = $relpath;
2822
               # } else { # if no tree to produce, relative path is empty
2823
               #    $hfilerelpath{$name} = '';
2824
               # }
2825
2826
               # create relative path from html file to directory with global index file
2827
               $hfileindexpath{$name} = $relpathtoindex;
2828
2829
               # Function declaration, if one exists, set default to script
2830
               $synopsis{$name} = "";
2831
               $mtype{$name} = "script";
2832
2833
               # First comment line
2834
               $apropos{$name} = "";
2835
2836
               # count number of m-files in directories
2837
               $dirnumbermfiles{$dirname}++;
2838
2839
               if ($debug > 1) {
2840
                  if ($opt_silent) { print "\r"; }
2841
                  print "   ParseTree: $name \t\t $mfile{$name} \t\t $hfile{$name}\t\t";
2842
                  if (!$opt_silent) { print "\n"; }
2843
               }
2844
            }
2845
         }
2846
         else {
2847
            print "Unknown type of file in $dirname: $file\n";
2848
         }
2849
      }
2850
      else { print "Error: Not existing file in $dirname: $file\n"; }
2851
   }
2852
2853
   closedir(AKTDIR)
2854
2855
}
2856
2857
#------------------------------------------------------------------------
2858
# Construct Dependency matrix
2859
#    $dep{$x,$y} > 0 if $x includes a reference to $y.
2860
#------------------------------------------------------------------------
2861
sub ConstructDependencyMatrix
2862
{
2863
   &ConstructDependencyMatrixReadFiles('all');
2864
   &ConstructDependencyMatrixReally;
2865
}
2866
2867
2868
#------------------------------------------------------------------------
2869
# Construct Dependency matrix
2870
#    $dep{$x,$y} > 0 if $x includes a reference to $y.
2871
#------------------------------------------------------------------------
2872
sub ConstructDependencyMatrixReadFiles
2873
{
2874
   local($whatstring) = @_;
2875
   local(*MFILE);
2876
   local($name, $inames);
2877
   local(%symbolsdep, %symbolsall);
2878
2879
   # Initialize as all zeros.
2880
   # foreach $name (@names) { grep($dep{$name,$_}=0,@names); if ($debug > 0) { print "\r   DepMatrix anlegen: $name\t$#names\t"; } }
2881
2882
   # Compute the dependency matrix
2883
   $inames = -1;
2884
   foreach $name (@names) {
2885
      # Read each file and tabulate the distinct alphanumeric identifiers in
2886
      # an array of symbols. Also scan for:
2887
      #   synopsis: The function declaration line
2888
      #   apropos:  The first line of the help text
2889
2890
      # look for whatstring, if all: process every file, if contents: process only contents files
2891
      if ($whatstring eq 'contents') { if (! ($name =~ /contents$/i) ) { next; } }
2892
      elsif ($whatstring eq 'all') { }    # do nothing
2893
      else { print "\r   ConstructDependency: Unknown parameter whatstring: $whatstring \n"; }
2894
2895
      undef %symbolsall; undef %symbolsdep;
2896
      open(MFILE,"<$mfile{$name}") || die("Can't open $mfile{$name}: $!\n");
2897
      while (<MFILE>) {
2898
         chop;
2899
2900
         # Split on nonalphanumerics, then look for all words, used for links later
2901
         # this one for all references
2902
         @wordsall = grep(/[a-zA-Z]\w*/, split('\W',$_));
2903
         # set all words to lower case for link checking
2904
         undef @wordsall2;
2905
         # do case conversion not, case checking is done later
2906
         foreach (@wordsall) { push(@wordsall2, "\L$_\E"); }
2907
         # @wordsall2 = @wordsall;
2908
         grep($symbolsall{$_}++, @wordsall2);
2909
2910
         # Store first comment line, skip all others.
2911
         if (/^\s*%/) {
2912
            if (!$apropos{$name}) {
2913
               s/^\s*%\s*//;   # remove % and leading white spaces on line
2914
               $_ = &SubstituteHTMLEntities($_);
2915
               $apropos{$name} = $_;
2916
            }
2917
            next;
2918
         }
2919
2920
         # If it's the function declaration line, then store it and skip
2921
         # but only, when first function definition (multiple function lines when private subfunctions in file
2922
         if ($synopsis{$name} eq '') {
2923
            if (/^\s*function/) {
2924
               s/^\s*function\s*//;
2925
               $synopsis{$name} = $_;
2926
               $mtype{$name} = "function";
2927
               next;
2928
            }
2929
         }
2930
2931
         # Split off any trailing comments
2932
         if ($_ ne '') {
2933
            # this one for references in program code only
2934
            # when syntax parsing, here is a working place
2935
            ($statement) = split('%',$_,1);
2936
            @wordsdep = grep(/[a-zA-Z]\w*/,split('\W',$statement));
2937
            # do case conversion not, case checking is done later
2938
            undef @wordsdep2;
2939
            foreach (@wordsdep) { push(@wordsdep2, "\L$_\E"); }
2940
            grep($symbolsdep{$_}++, @wordsdep2);
2941
         }
2942
      }
2943
      close MFILE;
2944
2945
      # compute intersection between %symbolsall and @linknames
2946
      delete($symbolsall{$name});
2947
      # foreach $localsumall ($symbolsall) {
2948
      #    $localsumall = "\L$localsumall\E";
2949
      # }
2950
      @{'all'.$name} = grep($symbolsall{$_}, @linknames);
2951
2952
      # compute intersection between %symbolsdep and @linknames
2953
      delete($symbolsdep{$name});
2954
      @{'depcalls'.$name} = grep($symbolsdep{$_}, @linknames);
2955
2956
      $inames++; print "\r   DepCallsMatrix: $inames/$#names\t $name\t";
2957
      if ($debug > 2) { print "\n      depnames: @{'depcalls'.$name}\n      all: @{'all'.$name}\n"; }
2958
   }
2959
}
2960
2961
2962
#------------------------------------------------------------------------
2963
# Construct Dependency matrix
2964
#    $dep{$x,$y} > 0 if $x includes a reference to $y.
2965
#------------------------------------------------------------------------
2966
sub ConstructDependencyMatrixReally
2967
{
2968
   local($inames, $name);
2969
2970
   $inames = -1;
2971
   foreach $name (@names) { undef %{'depint'.$name}; }
2972
   foreach $name (@names) {
2973
      grep(${'depint'.$_}{$name}++, @{'depcalls'.$name});
2974
      $inames++; print "\r   DepCalledMatrix1: $inames/$#names\t $name\t";
2975
   }
2976
   $inames = -1;
2977
   foreach $name (@names) {
2978
      # compute intersection between %depint.name{$_} and @linknames
2979
      if (defined (%{'depint'.$name})) { @{'depcalled'.$name} = grep(${'depint'.$name}{$_}, @linknames); }
2980
      $inames++; print "\r   DepCalledMatrix2: $inames/$#names\t $name\t";
2981
      if ($debug > 2) { print "\n      depcalled: @{'depcalled'.$name}\n"; }
2982
   }
2983
2984
}
2985
2986
2987
#========================================================================
2988
# Construct all index files
2989
#========================================================================
2990
sub ConstructAllIndexFiles
2991
{
2992
   local(@localnames);
2993
   local($ActDir);
2994
   local($name);
2995
2996
   # define variables and names for frame target
2997
   $GlobalNameFrameMainLeft = 'Cont_Main';
2998
   $GlobalNameFrameMainRight = 'Cont_Lower';
2999
   $GlobalNameFrameAZIndexsmall = 'IndexAZindex';
3000
   $GlobalNameFrameAZIndexjump = 'IndexAZjump';
3001
3002
   $indexcreated = 0;
3003
3004
   &ConstructHighestIndexFile;
3005
   $indexcreated++;
3006
3007
   # if ($var{'producetree'} eq 'yes') {
3008
      # moved next 2 lines out of if for producetree no
3009
      # &ConstructHighestIndexFile;
3010
      # $indexcreated++;
3011
3012
      foreach $ActDir (@directories) {
3013
         undef @localnames;
3014
         foreach $name (@names) {
3015
            local($pathsubstr) = substr($mfile{$name}, 0, rindex($mfile{$name}, "/")+1);
3016
            if ($ActDir eq $pathsubstr) {
3017
               if ($debug > 1) { print "IndexFile: $pathsubstr    ActDir: $ActDir   Hfilerelpath: $hfilerelpath{$name}\n"; }
3018
               push(@localnames, $name);
3019
            }
3020
         }
3021
         if ($debug > 2) { print "localnames: @localnames\n"; }
3022
         # create contents file and short|long index of files in local directory
3023
         &ConstructContentsmFile($ActDir, @localnames);
3024
         &ConstructAZIndexFile($ActDir, 'short', 'local', @localnames);
3025
         &ConstructAZIndexFile($ActDir, 'long', 'local', @localnames);
3026
         $indexcreated+=2;
3027
      }
3028
   # } else {
3029
   #    &ConstructContentsmFile($var{'dirmfiles'}, @names);
3030
   # }
3031
3032
   # create short|long index of files in all directory
3033
   &ConstructAZIndexFile($var{'dirmfiles'}, 'short', 'global', @names);
3034
   &ConstructAZIndexFile($var{'dirmfiles'}, 'long', 'global', @names);
3035
   $indexcreated+=2;
3036
3037
   # if contents.m were created or updated, the dependency matrices should
3038
   # be updated as well
3039
   if ($var{'writecontentsm'} eq 'yes') { &ConstructDependencyMatrixReadFiles('contents');; }
3040
}
3041
3042
3043
#========================================================================
3044
# Construct the highest level index file
3045
#========================================================================
3046
sub ConstructHighestIndexFile
3047
{
3048
   local(*IFILE);
3049
   local($indexfile, $filename);
3050
3051
   # Build the frame layout file, this files includes the layout of the frames
3052
   # Build the frame layout file name (highest one)
3053
   $indexfile = $var{'dirhtml'}.$var{'filenametopframe'}.$var{'exthtml'};
3054
3055 382:baff1c482d98 Chris
   if ($var{'frames'} eq 'yes') {
3056 381:2dc8163e9150 Chris
3057 382:baff1c482d98 Chris
       open(IFILE,">$indexfile") || die("Cannot open frame layout file $indexfile\n");
3058 381:2dc8163e9150 Chris
3059 382:baff1c482d98 Chris
       # Write the header of frame file
3060
       print IFILE "$TextDocTypeFrame\n<html>\n<head>\n$var{'codeheadmeta'}\n$TextMetaCharset\n";
3061
       print IFILE "   <title>$var{'texttitleframelayout'}</title>\n";
3062
       print IFILE "</head>\n";
3063 381:2dc8163e9150 Chris
3064 382:baff1c482d98 Chris
       # definition of 2 frames, left the tree of directories,
3065
       # right the index of that directory or the docu of a file
3066
       print IFILE "<frameset  cols=\"25%,75%\">\n";
3067
       print IFILE "   <frame src=\"$var{'filenamedirshort'}$var{'exthtml'}\" name=\"$GlobalNameFrameMainLeft\" />\n";
3068
       print IFILE "   <frame src=\"$var{'filenameindexshortglobal'}$var{'filenameextensionframe'}$var{'exthtml'}\" name=\"$GlobalNameFrameMainRight\" />\n";   print IFILE "</frameset>\n";
3069 381:2dc8163e9150 Chris
3070 382:baff1c482d98 Chris
       print IFILE "</html>\n";
3071
3072
       close(IFILE);
3073
3074
       if ($opt_silent) { print "\r"; }
3075
       print "   Frame layout file created: $indexfile\t";
3076
       if (!$opt_silent) { print "\n"; }
3077
   }
3078 381:2dc8163e9150 Chris
3079
   for($irun=0; $irun <= 2; $irun++) {
3080
      # Build the top directory index file, these files include the directory tree
3081
      # Build the directory tree index file name
3082
3083
      # Create no directory file for contents, when no contents to use
3084
      if (($irun == 2) && ($var{'usecontentsm'} eq 'no')) { next; }
3085
3086
      # Assign the correct index file name
3087
      if ($irun == 0) { $filename = $var{'filenamedirshort'}; }
3088
      elsif ($irun == 1) { $filename = $var{'filenamedirlong'}; }
3089
      elsif ($irun == 2) { $filename = $var{'filenamedircontents'}; }
3090
3091
      $indexfile = $var{'dirhtml'}.$filename.$var{'exthtml'};
3092
3093
      open(IFILE,">$indexfile") || die("Cannot open directory tree index file $indexfile\n");
3094
      # Write header of HTML file
3095
      print IFILE "$TextDocTypeHTML\n<html>\n<head>\n$var{'codeheadmeta'}\n$TextMetaCharset\n$var{'csslink'}\n";
3096
3097
      if ($var{'texttitleindexalldirs'} eq '') {
3098
         print IFILE "<title>Index of Directories of $var{'dirmfiles'}</title>\n";
3099
      } else {
3100
         print IFILE "<title>$var{'texttitleindexalldirs'}</title>\n";
3101
      }
3102 382:baff1c482d98 Chris
3103
      if ($var{'frames'} eq 'yes') {
3104
	  print IFILE "<base target=\"$GlobalNameFrameMainRight\" />\n";
3105
      }
3106
3107 381:2dc8163e9150 Chris
      print IFILE "</head>\n";
3108
      print IFILE "<body $var{'codebodyindex'}>\n";
3109 410:675de8e6becf chris
      print IFILE "<div id=\"matlabdoc\">\n";
3110 381:2dc8163e9150 Chris
      if ($var{'textheaderindexalldirs'} eq '') {
3111
         print IFILE "<h1 $var{'codeheader'}>Index of Directories of <em>$var{'dirmfiles'}</em></h1>\n";
3112
      } else {
3113
         print IFILE "<h1 $var{'codeheader'}>$var{'textheaderindexalldirs'}</h1>\n";
3114
      }
3115 389:0bc92382a86b chris
      print IFILE "<p>\n";
3116 382:baff1c482d98 Chris
3117
      if ($var{'frames'} eq 'yes') {
3118
	  if ($irun == 0) { print IFILE "<strong>short</strong>\n"; }
3119
	  else { print IFILE "<a href=\"$var{'filenamedirshort'}$var{'exthtml'}\" target=\"$GlobalNameFrameMainLeft\">short</a>\n"; }
3120
	  if ($irun == 1) { print IFILE " | <strong>long</strong>\n"; }
3121
	  else { print IFILE " | <a href=\"$var{'filenamedirlong'}$var{'exthtml'}\" target=\"$GlobalNameFrameMainLeft\">long</a>\n"; }
3122
	  if ($var{'usecontentsm'} eq 'yes') {
3123
	      if ($irun == 2) { print IFILE " | <strong>contents</strong>\n"; }
3124
	      else { print IFILE " | <a href=\"$var{'filenamedircontents'}$var{'exthtml'}\" target=\"$GlobalNameFrameMainLeft\">contents</a>\n"; }
3125
	  }
3126
      } else {
3127
	  if ($irun == 0) { print IFILE "<strong>short</strong>\n"; }
3128
	  else { print IFILE "<a href=\"$var{'filenamedirshort'}$var{'exthtml'}\">short</a>\n"; }
3129
	  if ($irun == 1) { print IFILE " | <strong>long</strong>\n"; }
3130
	  else { print IFILE " | <a href=\"$var{'filenamedirlong'}$var{'exthtml'}\">long</a>\n"; }
3131
	  if ($var{'usecontentsm'} eq 'yes') {
3132
	      if ($irun == 2) { print IFILE " | <strong>contents</strong>\n"; }
3133
	      else { print IFILE " | <a href=\"$var{'filenamedircontents'}$var{'exthtml'}\">contents</a>\n"; }
3134
	  }
3135 381:2dc8163e9150 Chris
      }
3136
3137
      print IFILE "</p><br />\n\n";
3138
      print IFILE "<ul>\n";
3139
3140
      # go through all directories and create a list entry for each one,
3141
      # depending on recursion level create sublists
3142
      $prevrecdeeplevel = 0;
3143
      foreach $name (@alldirectories) {
3144
         $actrecdeeplevel = $dirnamerecdeep{$name};
3145
         for( ; $prevrecdeeplevel < $actrecdeeplevel; $prevrecdeeplevel++ ) { print IFILE "<ul>\n"; }
3146
         for( ; $prevrecdeeplevel > $actrecdeeplevel; $prevrecdeeplevel-- ) { print IFILE "</ul>\n"; }
3147
         if ($irun == 0) { $indexfilenameused = $var{'filenameindexshortlocal'}.$var{'filenameextensionframe'}; }
3148
         elsif ($irun == 1) { $indexfilenameused = $var{'filenameindexlonglocal'}.$var{'filenameextensionframe'}; }
3149
         elsif ($irun == 2) { $indexfilenameused = $contentsname{$name}; }
3150
         else { die "ConstructHighestIndexFile: Unknown value of irun"; }
3151
         if ($dirnumbermfiles{$name} > 0) {
3152
            # producetree no
3153
            # if ($var{'producetree'} eq 'no') { $dirnamehere = ''; }
3154
            # else { $dirnamehere = '$dirnamerelpath{$name}'; }
3155
            # print IFILE "<LI><A HREF=\"$dirnamehere$indexfilenameused_$dirnamesingle{$name}$var{'exthtml'}\">$dirnamesingle{$name}</A>\n";
3156
            print IFILE "<li><a href=\"$dirnamerelpath{$name}$indexfilenameused$dirnamesingle{$name}$var{'exthtml'}\">$dirnamesingle{$name}</a></li>\n";
3157
         } else {
3158
            # print directories with no m-files inside not
3159
            # print IFILE "<li>$dirnamesingle{$name}</li>\n";
3160
         }
3161
      }
3162
      $actrecdeeplevel = 0;
3163
      for( ; $prevrecdeeplevel > $actrecdeeplevel; $prevrecdeeplevel-- ) { print IFILE "</ul>\n"; }
3164
      print IFILE "</ul>\n<br />$var{'codehr'}\n";
3165
3166
      # Include info about author from authorfile
3167
      &WriteFile2Handle($var{'authorfile'}, IFILE);
3168
3169
      print IFILE "<!--navigate-->\n";
3170
      print IFILE "<!--copyright-->\n";
3171 410:675de8e6becf chris
      print IFILE "</div>\n</body>\n</html>\n";
3172 381:2dc8163e9150 Chris
3173
      close(IFILE);
3174
3175
      if ($opt_silent) { print "\r"; }
3176
      print "   Directory - Indexfile created: $indexfile\t";
3177
      if (!$opt_silent) { print "\n"; }
3178
   }
3179
}
3180
3181
3182
#========================================================================
3183
# Construct the A-Z index file (global/local and/or short/long)
3184
#========================================================================
3185
sub ConstructAZIndexFile
3186
{
3187
   local($LocalActDir, $LocalShortLong, $LocalGlobalLocal, @localnames) = @_;
3188
   local(*IFILE);
3189
   local($name, $indexfilename, $dirpath);
3190
   local($firstletter, $firstone);
3191
3192
   if ($debug > 2) { print "localnames in AZ small: @localnames\n"; print "     ActDir in A-Z: $LocalActDir\n"; }
3193
3194
   # extract filename of index file from parameters of function
3195
   if ($LocalShortLong eq 'short') {
3196
      if ($LocalGlobalLocal eq 'global') { $indexfilename = $var{'filenameindexshortglobal'}; }
3197
      elsif ($LocalGlobalLocal eq 'local') { $indexfilename = $var{'filenameindexshortlocal'}; }
3198
      else { die "wrong parameter for LocalGlobalLocal in ConstructAZIndexFile: $LocalGlobalLocal."; }
3199
   } elsif ($LocalShortLong eq 'long') {
3200
      if ($LocalGlobalLocal eq 'global') { $indexfilename = $var{'filenameindexlongglobal'}; }
3201
      elsif ($LocalGlobalLocal eq 'local') { $indexfilename = $var{'filenameindexlonglocal'}; }
3202
      else { die "wrong parameter for LocalGlobalLocal in ConstructAZIndexFile: $LocalGlobalLocal."; }
3203
   } else { die "wrong parameter for LocalShortLong in ConstructAZIndexFile: $LocalShortLong."; }
3204
3205
   # producetree no
3206
   # if ($var{'producetree'} eq 'no') { $dirnamehere = ''; }
3207
   # else { $dirnamehere = '$dirnamerelpath{$LocalActDir}'; }
3208
   # Build the index file name
3209
   # handle the global index file case separately (no extra directory name in file)
3210
   #    the local index file name must be extended by the name of the directory
3211
   if ($LocalGlobalLocal eq 'global') { $extradirfilename = ''; }
3212
   else { $extradirfilename = $dirnamesingle{$LocalActDir}; }
3213
   $indexfile = $var{'dirhtml'}.$dirnamerelpath{$LocalActDir}.$indexfilename.$var{'filenameextensionindex'}.$extradirfilename.$var{'exthtml'};
3214 382:baff1c482d98 Chris
3215 401:a0f6e994657f chris
   if ($LocalShortLong eq 'short' and $extradirfilename eq '' and $var{'frames'} ne 'yes') {
3216
       # With no frames and no subdir path, this must go in the
3217
       # top-level index file instead
3218 382:baff1c482d98 Chris
       $indexfile = $var{'dirhtml'}.$var{'filenametopframe'}.$var{'exthtml'};
3219
   }
3220
3221 381:2dc8163e9150 Chris
   if ($debug > 2) { print "   indexfilename (a-z small): $indexfile\n"; }
3222
3223
   open(IFILE,">$indexfile") || die("Cannot open index file $indexfile: $!\n");
3224
3225
   # Write the header of HTML file
3226
   print IFILE "$TextDocTypeHTML\n<html>\n<head>\n$var{'codeheadmeta'}\n$TextMetaCharset\n$var{'csslink'}\n";
3227
3228 410:675de8e6becf chris
   my $dirToPrint = $LocalActDir;
3229
   $dirToPrint =~ s,^./,,;
3230
3231 381:2dc8163e9150 Chris
   if ($var{'texttitleindex'} eq '') {
3232 410:675de8e6becf chris
      print IFILE "<title>Index of Matlab Files in Directory $dirToPrint</title>\n";
3233 381:2dc8163e9150 Chris
   } else {
3234
      if ($LocalGlobalLocal eq 'global') { print IFILE "<title>$var{'texttitleindex'}</title>\n"; }
3235 410:675de8e6becf chris
      else { print IFILE "<title>$var{'texttitleindex'} in Directory $dirToPrint</title>\n"; }
3236 381:2dc8163e9150 Chris
   }
3237 382:baff1c482d98 Chris
3238
   if ($var{'frames'} eq 'yes') {
3239
       print IFILE "<base target=\"$GlobalNameFrameMainRight\" />\n";
3240
   }
3241 381:2dc8163e9150 Chris
   print IFILE "</head>\n";
3242 382:baff1c482d98 Chris
3243 381:2dc8163e9150 Chris
   print IFILE "<body $var{'codebodyindex'}>\n";
3244 410:675de8e6becf chris
   print IFILE "<div id=\"matlabdoc\">\n";
3245 381:2dc8163e9150 Chris
   if ($var{'textheaderindex'} eq '') {
3246 410:675de8e6becf chris
      print IFILE "<h1 $var{'codeheader'}>Index of Matlab Files in Directory $dirToPrint</h1>\n";
3247 381:2dc8163e9150 Chris
   } else {
3248
      if ($LocalGlobalLocal eq 'global') { print IFILE "<h1 $var{'codeheader'}>$var{'textheaderindex'}</h1>\n"; }
3249 410:675de8e6becf chris
      else { print IFILE "<h1 $var{'codeheader'}>$var{'textheaderindex'} in Directory $dirToPrint</h1>\n"; }
3250 381:2dc8163e9150 Chris
   }
3251
3252
   # include links to indexes
3253
   &ConstructLinks2Index(IFILE, $dirnamerelpathtoindex{$LocalActDir}, $LocalActDir, $LocalGlobalLocal);
3254
3255
   # Collect the starting letters of m files in this directory or all m-files
3256
   for('a'..'z') { undef @{$_}; }
3257
   foreach $name (@localnames) {
3258
      if (! ($mfilename{$name} =~ /contents/i)) {
3259
         $firstletter = substr($mfilename{$name}, 0, 1);
3260
         # convert first letter always to lower case
3261
         # needed for reference to lower and upper case m-files
3262
         $firstletter = "\L$firstletter\E";
3263
         push(@{$firstletter}, $name);
3264
      }
3265
   }
3266
3267
   if ($LocalShortLong eq 'short') {
3268
      # begin create short index
3269
      print IFILE "<table width=\"100%\">\n";
3270
3271
      for('a'..'z') {
3272
         # print "   $_: @{$_}\n";
3273
         $numberofletter = $#{$_}+1;
3274 410:675de8e6becf chris
	 $cols = 3;
3275 381:2dc8163e9150 Chris
         if ($numberofletter > 0) {
3276 410:675de8e6becf chris
            print IFILE "\n<tr><td><br/><strong><a name=\"\U$_\E$_\"></a><span class=\"an\">\U$_\E</span></strong></td></tr>\n";
3277
            for ($count = 0; $count < $numberofletter; $count++) {
3278
		if (($count % $cols) == 0) {
3279
		    if ($count > 0) {
3280
			print IFILE "</tr><tr>\n";
3281
		    }
3282
		    print IFILE "<tr><td></td>";
3283
		}
3284
		$name = @{$_}[$count];
3285
		if ($LocalGlobalLocal eq 'global') { $dirpath = $hfilerelpath{$name}; } else { $dirpath = ""; }
3286
		print IFILE "<td><a href=\"$dirpath$mfilename{$name}$var{'exthtml'}\">$mfilename{$name}</a></td>";
3287
	    }
3288
3289
	    print IFILE "</tr>\n";
3290
3291
            # $numberhalf = ($numberofletter + 1 - (($numberofletter+1) % 2))/2;
3292
            # if ($debug > 2) { print "   $_: @{$_} \t $numberhalf \t $numberofletter\n"; }
3293
            # for($count = 0; $count < $numberhalf; $count++) {
3294
            #    $name = @{$_}[$count];
3295
            #    if ($LocalGlobalLocal eq 'global') { $dirpath = $hfilerelpath{$name}; } else { $dirpath = ""; }
3296
            #    print IFILE "<tr><td width=\"50%\"><a href=\"$dirpath$mfilename{$name}$var{'exthtml'}\">$mfilename{$name}</a></td>";
3297
            #    if (($count + $numberhalf) < $numberofletter) {
3298
            #       $name = @{$_}[$count + $numberhalf];
3299
            #       if ($LocalGlobalLocal eq 'global') { $dirpath = $hfilerelpath{$name}; } else { $dirpath = ""; }
3300
            #       print IFILE "<td width=\"50%\"><a href=\"$dirpath$mfilename{$name}$var{'exthtml'}\">$mfilename{$name}</a></td></tr>\n";
3301
            #    } else {
3302
            #       print IFILE "<td width=\"50%\"></td></tr>\n";
3303
            #    }
3304
            # }
3305 381:2dc8163e9150 Chris
         }
3306
      }
3307
      print IFILE "</table>\n<br />$var{'codehr'}\n";
3308
3309
   } elsif ($LocalShortLong eq 'long') {
3310
      # begin create long index
3311 410:675de8e6becf chris
      print IFILE "<table width=\"100%\">\n";
3312 401:a0f6e994657f chris
      print IFILE "<tr><th>Name</th><th>Synopsis</th></tr>\n";
3313 381:2dc8163e9150 Chris
3314
      for('a'..'z') {
3315
         # print "   $_: @{$_}\n";
3316
         $numberofletter = $#{$_}+1;
3317
         if ($numberofletter > 0) {
3318
            $firstone = 1;
3319
            foreach $name (@{$_}) {
3320
               if ($debug > 1) { print "   AZinforeach1: $name \t\t $hfilerelpath{$name} \t\t $dirnamerelpath{$LocalActDir}\n"; }
3321
               if ($LocalGlobalLocal eq 'global') { $dirpath = $hfilerelpath{$name}; } else { $dirpath = ""; }
3322
               if (! ($mfilename{$name} =~ /contents/i)) {
3323 400:4ad6499d7998 chris
                  if ($firstone == 1) { print IFILE "\n<tr><td colspan=\"2\"><br /><strong><a name=\"\U$_\E$_\"></a><span class=\"an\">\U$_\E</span></strong></td></tr>\n"; $firstone = 0; }
3324 381:2dc8163e9150 Chris
                  print IFILE "<tr><td valign=\"top\"><a href=\"$dirpath$mfilename{$name}$var{'exthtml'}\">$mfilename{$name}</a></td><td>$apropos{$name}</td></tr>\n";
3325
               }
3326
            }
3327
         }
3328
      }
3329
      print IFILE "</table>\n<br />$var{'codehr'}\n";
3330
   } else { die "wrong parameter for LocalShortLong in ConstructAZIndexFile: $LocalShortLong."; }
3331
3332
   # Include info about author from authorfile
3333
   &WriteFile2Handle($var{'authorfile'}, IFILE);
3334
3335
   print IFILE "<!--navigate-->\n";
3336
   print IFILE "<!--copyright-->\n";
3337 410:675de8e6becf chris
   print IFILE "</div>\n</body>\n</html>\n";
3338 381:2dc8163e9150 Chris
3339
   close(IFILE);
3340
3341
   if ($opt_silent) { print "\r"; }
3342
   print "   Indexfile small (A-Z) created: $indexfile\t";
3343
   if (!$opt_silent) { print "\n"; }
3344
3345
3346
   # Build the A-Z jump index file name
3347
   # handle the global index file case separately (no extra directory name in file)
3348
   if ($LocalGlobalLocal eq 'global') { $extradirfilename = ''; }
3349
   else { $extradirfilename = $dirnamesingle{$LocalActDir}; }
3350
3351 382:baff1c482d98 Chris
   if ($var{'frames'} eq 'yes') {
3352
3353
       $indexfile = $var{'dirhtml'}.$dirnamerelpath{$LocalActDir}.$indexfilename.$var{'filenameextensionjump'}.$extradirfilename.$var{'exthtml'};
3354
       if ($debug > 2) { print "   indexfilename (a-z jump): $indexfile\n"; }
3355
       open(IFILE,">$indexfile") || die("Cannot open jump index file $indexfile: $!\n");
3356
3357
       # Write the header of HTML file
3358
       print IFILE "$TextDocTypeHTML\n<html>\n<head>\n$var{'codeheadmeta'}\n$TextMetaCharset\n$var{'csslink'}\n";
3359
3360
       if ($var{'texttitleindex'} eq '') {
3361 410:675de8e6becf chris
	   print IFILE "<title>A-Z jump index in directory $dirToPrint</title>\n";
3362 382:baff1c482d98 Chris
       } else {
3363
	   if ($LocalGlobalLocal eq 'global') { print IFILE "<title>$var{'texttitleindex'}</title>\n"; }
3364 410:675de8e6becf chris
	   else { print IFILE "<title>$var{'texttitleindex'} in Directory $dirToPrint</title>\n"; }
3365 382:baff1c482d98 Chris
       }
3366
3367
       if ($var{'frames'} eq 'yes') {
3368
	   print IFILE "<base target=\"$GlobalNameFrameAZIndexsmall\" />\n";
3369
       }
3370
       print IFILE "</head>\n";
3371
       print IFILE "<body $var{'codebodyindex'}>\n";
3372 410:675de8e6becf chris
       print IFILE "<div id=\"matlabdoc\">\n";
3373 382:baff1c482d98 Chris
3374
       # Write the A-Z jump line, generate link for letters with files starting with this letter
3375
       # and only letters for no files starting with this letter
3376
       # use previously generated arrays with names of files sorted by starting letter
3377
       for('a'..'z') {
3378
	   $numberofletter = $#{$_}+1;
3379
	   if ($numberofletter > 0) {
3380
	       print IFILE "<strong><a href=\"$indexfilename$var{'filenameextensionindex'}$extradirfilename$var{'exthtml'}#\U$_\E$_\">\U$_\E</a> </strong>\n";
3381
	   } else {
3382
	       print IFILE "\U$_\E \n";
3383
	   }
3384
       }
3385
3386 410:675de8e6becf chris
       print IFILE "</div></body>\n</html>\n";
3387 382:baff1c482d98 Chris
3388
       close(IFILE);
3389
3390
       if ($opt_silent) { print "\r"; }
3391
       print "   Indexfile small (A-Z jump) created: $indexfile\t";
3392
       if (!$opt_silent) { print "\n"; }
3393 381:2dc8163e9150 Chris
   }
3394
3395
3396
   # Build the frame layout file, this file includes the layout of the frames
3397
   # Build the frame layout file name (for small/compact A-Z index)
3398
   # handle the global index file case separately (no extra directory name in file)
3399
   if ($LocalGlobalLocal eq 'global') { $extradirfilename = ''; }
3400
   else { $extradirfilename = $dirnamesingle{$LocalActDir}; }
3401
3402 382:baff1c482d98 Chris
   if ($var{'frames'} eq 'yes') {
3403 381:2dc8163e9150 Chris
3404 382:baff1c482d98 Chris
       $indexfile = $var{'dirhtml'}.$dirnamerelpath{$LocalActDir}.$indexfilename.$var{'filenameextensionframe'}.$extradirfilename.$var{'exthtml'};
3405
       if ($debug > 2) { print "   indexfilename (a-z frame): $indexfile\n"; }
3406 381:2dc8163e9150 Chris
3407 382:baff1c482d98 Chris
       open(IFILE,">$indexfile") || die("Cannot open jump index frame file $indexfile: $!\n");
3408
3409
       # Write the header of Frame file
3410
       print IFILE "$TextDocTypeHTML\n<html>\n<head>\n$var{'codeheadmeta'}\n$TextMetaCharset\n$var{'csslink'}\n";
3411
3412
       if ($var{'texttitleindex'} eq '') {
3413 410:675de8e6becf chris
	   print IFILE "<title>Index of Matlab Files in Directory $dirToPrint</title>\n";
3414 382:baff1c482d98 Chris
       } else {
3415
	   if ($LocalGlobalLocal eq 'global') { print IFILE "<title>$var{'texttitleindex'}</title>\n"; }
3416 410:675de8e6becf chris
	   else { print IFILE "<title>$var{'texttitleindex'} in Directory $dirToPrint</title>\n"; }
3417 382:baff1c482d98 Chris
       }
3418
       print IFILE "</head>\n";
3419
3420
       # definition of 2 frames, top the A-Z index, below the jump letter line
3421
       print IFILE "<frameset  rows=\"90%,10%\">\n";
3422
       print IFILE "   <frame src=\"$indexfilename$var{'filenameextensionindex'}$extradirfilename$var{'exthtml'}\" name=\"$GlobalNameFrameAZIndexsmall\" />\n";
3423
       print IFILE "   <frame src=\"$indexfilename$var{'filenameextensionjump'}$extradirfilename$var{'exthtml'}\" name=\"$GlobalNameFrameAZIndexjump\" />\n";
3424
       print IFILE "</frameset>\n";
3425
3426
       print IFILE "</html>\n";
3427
3428
       close(IFILE);
3429
3430
       if ($opt_silent) { print "\r"; }
3431
       print "   Frame layout file created: $indexfile\t";
3432
       if (!$opt_silent) { print "\n"; }
3433 381:2dc8163e9150 Chris
   }
3434
}
3435 382:baff1c482d98 Chris
3436 381:2dc8163e9150 Chris
3437
#========================================================================
3438
# Construct the links to all indexes
3439
#========================================================================
3440
sub ConstructLinks2Index
3441
{
3442
   local(*WRITEFILE, $LocalPath2Index, $PathContents, $LocalGlobalLocal) = @_;
3443
3444
   # include links to short/long - local/global index and C|contents.m
3445 389:0bc92382a86b chris
   print WRITEFILE "\n<p>";
3446
   print WRITEFILE "$var{'textjumpindexglobal'} ";
3447 382:baff1c482d98 Chris
3448
   if ($var{'frames'} eq 'yes') {
3449
       print WRITEFILE "<a href=\"$LocalPath2Index$var{'filenameindexshortglobal'}$var{'filenameextensionframe'}$var{'exthtml'}\">short</a> | ";
3450 389:0bc92382a86b chris
       print WRITEFILE "<a href=\"$LocalPath2Index$var{'filenameindexlongglobal'}$var{'filenameextensionframe'}$var{'exthtml'}\">long</a>\n";
3451 382:baff1c482d98 Chris
   } else {
3452 387:f89765996ef9 Chris
       print WRITEFILE "<a href=\"$LocalPath2Index$var{'filenametopframe'}$var{'exthtml'}\">short</a> | ";
3453 389:0bc92382a86b chris
       print WRITEFILE "<a href=\"$LocalPath2Index$var{'filenameindexlongglobal'}$var{'filenameextensionindex'}$var{'exthtml'}\">long</a>\n";
3454 382:baff1c482d98 Chris
   }
3455
3456 381:2dc8163e9150 Chris
   if ($LocalGlobalLocal eq 'local') {
3457
      if ($var{'usecontentsm'} eq 'yes') {
3458
         print WRITEFILE " | <a href=\"$contentsname{$PathContents}$dirnamesingle{$PathContents}$var{'exthtml'}\">Local contents</a>\n";
3459
      }
3460 389:0bc92382a86b chris
      if ($var{'frames'} eq 'yes') {
3461
         print WRITEFILE " | $var{'textjumpindexlocal'} ";
3462 382:baff1c482d98 Chris
         print WRITEFILE "<a href=\"$var{'filenameindexshortlocal'}$var{'filenameextensionframe'}$dirnamesingle{$PathContents}$var{'exthtml'}\">short</a> | ";
3463 389:0bc92382a86b chris
         print WRITEFILE "<a href=\"$var{'filenameindexlonglocal'}$var{'filenameextensionframe'}$dirnamesingle{$PathContents}$var{'exthtml'}\">long</a>\n";
3464
      } else {
3465
         print WRITEFILE " | $var{'textjumpindexlocal'} ";
3466
         print WRITEFILE "<a href=\"$var{'filenameindexshortlocal'}$var{'filenameextensionindex'}$dirnamesingle{$PathContents}$var{'exthtml'}\">short</a> | ";
3467
         print WRITEFILE "<a href=\"$var{'filenameindexlonglocal'}$var{'filenameextensionindex'}$dirnamesingle{$PathContents}$var{'exthtml'}\">long</a>\n";
3468
      }
3469 381:2dc8163e9150 Chris
   }
3470
   print WRITEFILE "</p>\n\n";
3471
   print WRITEFILE "$var{'codehr'}\n";
3472
}
3473
3474
3475
#========================================================================
3476
# Construct the contents.m files or update
3477
#========================================================================
3478
sub ConstructContentsmFile
3479
{
3480
   local($LocalActDir, @localnames) = @_;
3481
   local(*CFILE, $name,$newline);
3482
   local($contentsfile, $isincontentsonly);
3483
   local(@lines, @autoaddlines, @emptylines);
3484
   local($autoadd) = 'AutoAdd';
3485
   local($autoaddsection) = 0;
3486
   local($emptylineflag) = 0;
3487
   local(%nameincontents);
3488
3489
   # Build the contents file name
3490
   $contentsfile = $LocalActDir.$contentsname{$LocalActDir}.$suffix;
3491
3492
   if (-e $contentsfile) {
3493
      open(CFILE,"<$contentsfile") || die("Cannot open contents file $contentsfile: $!\n");
3494
      while (<CFILE>) {
3495
         # Search for the specified string pattern
3496
         @words = split;
3497
         if ((@words >= 3) && ($words[2] eq '-')) {
3498
            $isincontentsonly = 0;
3499
            foreach $name (@localnames) {
3500
               if ($name eq $words[1]) {    # old
3501
               # if ($mfilename{$name} eq $words[1]) {
3502
                  $isincontentsonly = 1;
3503
                  $nameincontents{$name} = 1;
3504
                  $newline = sprintf("%% %-13s - %s\n", $mfilename{$name}, $apropos{$name});
3505
                  push(@lines, $newline);
3506
               }
3507
            }
3508
            # issue a warning, if file is in contents, but not as file in the directory
3509
            if ($isincontentsonly == 0) {
3510
               print "\rConstructContents: Obsolete entry  $words[1]  in  $contentsfile ! Entry not used.\n";
3511
            }
3512
         } else {
3513
            # look for the AutoAdd section, should be the second word
3514
            if ((@words >= 2) && ($words[1] eq $autoadd)) { $autoaddsection = 1; }
3515
            # push the red line in an array
3516
            push(@lines, $_);
3517
         }
3518
      }
3519
      close(CFILE);
3520
   } else {
3521
      $newline = "% MATLAB Files in directory  $LocalActDir\n%\n";
3522
      push(@lines, $newline);
3523
3524
   }
3525
3526
   # collect the file names, that were not included in original C|contents.m
3527
   foreach $name (@localnames) {
3528
      if (! defined $nameincontents{$name}) {
3529
         if (! ($mfilename{$name} =~ /contents/i)) {
3530
            $newline = sprintf("%% %-13s - %s\n", $mfilename{$name}, $apropos{$name});
3531
            push(@autoaddlines, $newline);
3532
         }
3533
      }
3534
   }
3535
3536
   # write/update C|contents.m only if variable is set
3537
   if ($var{'writecontentsm'} eq 'yes') {
3538
      unlink($contentsfile);
3539
      open(CFILE,">$contentsfile") || die("Cannot open contents file $contentsfile: $!\n");
3540
      # write old C|contents.m or header of new file, as long as comment lines
3541
      foreach $line (@lines) {
3542
         if ($emptylineflag == 0) {
3543
            if ($line =~ /^\s*%/) { print CFILE $line; }
3544
            else { $emptylineflag = 1; push(@emptylines, $line); }
3545
         } else { push(@emptylines, $line); }
3546
      }
3547
      # add header of AutoAdd section
3548
      if (($autoaddsection == 0) && (@autoaddlines > 0)) { print CFILE "%\n% $autoadd\n"; }
3549
      # add autoadd section lines (previously undocumented files
3550
      foreach $line (@autoaddlines) { print CFILE $line; }
3551
      # add tail of original C|contents.m (everything behind first non-comment line)
3552
      foreach $line (@emptylines)   { print CFILE $line; }
3553
      print CFILE "\n";
3554
      close CFILE;
3555
      if ($opt_silent) { print "\r"; }
3556
      print "   Contents file created/updated: $contentsfile\t";
3557
      if (!$opt_silent) { print "\n"; }
3558
   }
3559
}
3560
3561
3562
#========================================================================
3563
# Replace found special characters with their HTMl Entities
3564
#========================================================================
3565
sub SubstituteHTMLEntities {
3566
   local($_) = @_;
3567
3568
   # Replace & <-> &amp;  < <-> &lt;  > <-> &gt;  " <-> &quot;
3569
   s/&/&amp;/g; s/\</&lt;/g; s/\>/&gt;/g; s/\"/&quot;/g;
3570
   return $_;
3571
}
3572
3573
#========================================================================
3574
# Replace found m-filenamestring with full link.
3575
#========================================================================
3576
sub SubstituteName2Link {
3577
   local($_, $funname) = @_;
3578
   local($refstr1, $refstr2, $reffound);
3579
3580
   # Look for something matching in the line
3581
   if ( /(\W+)($funname)(\W+)/i ) {
3582
      $reffound = $2;
3583 388:dad587ecb8d0 chris
      $refstr1 = "<a class=\"mfun\" href=\"$hfileindexpath{$name}$hfilerelpath{$funname}$mfilename{$funname}$var{'exthtml'}\">";
3584 381:2dc8163e9150 Chris
      $refstr2 = "<\/a>";
3585
      # Do links only for exact case match
3586
      if ( ($var{'links2filescase'}  eq 'exact') || ($var{'links2filescase'}  eq 'exactvery') ) {
3587
         if ( /(\W+)($funname)(\W+)/g ) {
3588
            s/(\W+)($funname)(\W+)/$1$refstr1$funname$refstr2$3/g;
3589
         }
3590
         else {
3591
            # Print info for not matching case in references, good for check up of files
3592
            if ( ($var{'links2filescase'}  eq 'exactvery') ) {
3593
               print "Diff in case found: $funname  (case of file name)   <->  $reffound  (case in source code)\n";
3594
               print "     (source line)  $_ \n";
3595
            }
3596
         }
3597
      }
3598
      # Do links for exact match and additionally for all upper case (often used in original matlab help text)
3599
      elsif ( ($var{'links2filescase'}  eq 'exactupper') ) {
3600
         s/(\W+)($funname)(\W+)/$1$refstr1$2$refstr2$3/g;
3601
         $funname2 = "\U$funname\E";
3602
         s/(\W+)($funname2)(\W+)/$1$refstr1$2$refstr2$3/g;
3603
      }
3604
      # Do links for all case mixes, this calls for trouble under LINUX/UNIX
3605
      else {  #elsif ( ($var{'links2filescase'}  eq 'all') )
3606
         s/(\W+)($funname)(\W+)/$1$refstr1$2$refstr2$3/ig;
3607
      }
3608
   }
3609
3610
   return $_;
3611
}
3612
3613
#========================================================================
3614
# Construct the html files for each matlab file.
3615
#    Need to reread each matlab file to find the help text.
3616
#    Note that we can't do this in a single loop because sometimes
3617
#    the help text maybe before the function declaration.
3618
#========================================================================
3619
sub ConstructHTMLFiles
3620
{
3621
   local(*MFILE);
3622
   local(*HFILE);
3623
3624
   local($filescreated) = 0;
3625
   local($functionline);
3626
3627
   foreach $name (@names) {
3628
      # Create cross reference information already here, used for keywords as well
3629
      # Construct list of referenced functions
3630
      @xref = @{'depcalls'.$name};    # the functions, that this m-file calls
3631
      @yref = @{'depcalled'.$name};   # the functions, that this m-file is called from
3632
      # print "   depcalls: @{'depcalls'.$name}\n   depcalled: @{'depcalled'.$name}\n";
3633
      # foreach $cname (@names) { next if $cname eq $name; push(@yref,$cname) if grep(/$name/,@{'depcalls'.$cname}); }
3634
3635
3636
      # Open m-file and html-file
3637
      open(MFILE,"<$mfile{$name}");
3638
      open(HFILE,">$hfile{$name}");
3639
3640
      # Write the header of HTML file
3641
      print HFILE "$TextDocTypeHTML\n<html>\n<head>\n$var{'codeheadmeta'}\n$TextMetaCharset\n$var{'csslink'}\n";
3642
3643
      # Write meta tags: use apropos (one line function description) for description
3644
      # and cross reference function names for keywords (any better ideas?)
3645
      print HFILE "<meta name=\"description\" content=\" $apropos{$name} \" />\n";
3646
      print HFILE "<meta name=\"keywords\" content=\" @xref @yref \" />\n";
3647
3648
      # Write Title and start body of html-file
3649
      print HFILE "<title>$var{'texttitlefiles'} $mfilename{$name}</title>\n</head>\n";
3650
      print HFILE "<body $var{'codebodyfiles'}>\n";
3651 410:675de8e6becf chris
      print HFILE "<div id=\"matlabdoc\">\n";
3652 381:2dc8163e9150 Chris
      print HFILE "<h1 $var{'codeheader'}>$var{'textheaderfiles'} $mfilename{$name}</h1>\n";
3653 401:a0f6e994657f chris
3654
# http://test.soundsoftware.ac.uk/cannam/projects/smallbox/repository/annotate/DL/RLS-DLA/SolveFISTA.m
3655 410:675de8e6becf chris
#      print HFILE "<a href=\"" . $hfileindexpath{$name} . "../../projects/smallbox/repository/annotate/" . $mfiledir{$name}  . $mfilename{$name} . ".m\">View in repository</a>\n";
3656 401:a0f6e994657f chris
3657 381:2dc8163e9150 Chris
      print HFILE "$var{'codehr'}\n";
3658
3659
      # include links to short/long - local/global index and C|contents.m
3660
      &ConstructLinks2Index(HFILE, $hfileindexpath{$name}, $mfiledir{$name}, 'local');
3661
3662
      # If this is a function, then write out the first line as a synopsis
3663
      if ($mtype{$name} eq "function") {
3664
         print HFILE "<h2 $var{'codeheader'}>Function Synopsis</h2>\n";
3665
         print HFILE "<pre>$synopsis{$name}</pre>\n$var{'codehr'}\n";
3666
      }
3667
3668
      # Look for the matlab help text block
3669
      $functionline = "\n";
3670
      do {
3671
         $_ = <MFILE>;
3672
         # remember functionline, if before help text block
3673
         if (/^\s*function/) { $functionline = $_; }
3674
      } until (/^\s*%/ || eof);
3675
      if (! (eof(MFILE))) {
3676
         print HFILE "<h2 $var{'codeheader'}>Help text</h2>\n";
3677
         print HFILE "<pre>\n";
3678
         while (/^\s*%/) {
3679
            # First remove leading % and white space, then Substitute special characlers
3680
            s/^\s*%//;
3681
            $_ = &SubstituteHTMLEntities($_);
3682
3683
            # check/create cross references
3684
            foreach $funname (@{'all'.$name}) {
3685
               if ($funname =~ /simulink/) { print "\n Simulink - Filename: $name;  scanname: $funname\n"; }
3686
               next if $funname eq $name;
3687
               $_ = &SubstituteName2Link($_, $funname);
3688
            }
3689
            print HFILE $_;
3690
            if (! eof) { $_ = <MFILE>; }
3691
         }
3692
         print HFILE "</pre>\n$var{'codehr'}\n";
3693
      }
3694
3695
      # Write the cross reference information
3696
      if (@xref || @yref) {
3697
         print HFILE "<h2 $var{'codeheader'}>Cross-Reference Information</H2>\n";
3698
         print HFILE "<table border=\"0\" width=\"100%\">\n<tr align=\"left\">\n<th width=\"50%\">";
3699
         if (@xref) {
3700
            print HFILE "This $mtype{$name} calls";
3701
         }
3702
         print HFILE "</th>\n<th width=\"50%\">";
3703
         if (@yref) {
3704
            print HFILE "This $mtype{$name} is called by";
3705
         }
3706
         print HFILE "</th>\n</tr>\n<tr valign=\"top\"><td>";
3707
         if (@xref) {
3708
            print HFILE "\n<ul>\n";
3709
            foreach $cname (sort @xref) {
3710
               print HFILE "<li><a class=\"mfun\" href=\"$hfileindexpath{$name}$hfilerelpath{$cname}$mfilename{$cname}$var{'exthtml'}\">$mfilename{$cname}</a></li>\n";
3711
            }
3712
            print HFILE "</ul>\n";
3713
         }
3714
         print HFILE "</td><td>";
3715
         if (@yref) {
3716
            print HFILE "\n<ul>\n";
3717
            foreach $cname (sort @yref) {
3718
               print HFILE "<li><a class=\"mfun\" href=\"$hfileindexpath{$name}$hfilerelpath{$cname}$mfilename{$cname}$var{'exthtml'}\">$mfilename{$cname}</a></li>\n";
3719
            }
3720
            print HFILE "</ul>\n";
3721
         }
3722
         print HFILE "</td>\n</tr>\n</table>\n";
3723
         print HFILE "$var{'codehr'}\n";
3724
      }
3725
3726
      # Include source text if requested
3727
      if (($var{'includesource'} eq 'yes') && (! ($mfilename{$name} =~ /^contents$/i))) {
3728
         print HFILE "<h2 $var{'codeheader'}>Listing of $mtype{$name} $mfilename{$name}</h2>\n";
3729
         seek(MFILE,0,0);
3730
         print HFILE "<pre>\n";
3731
         $IsStillHelp = 2;
3732
         print HFILE $functionline;    # functionline from scanning of help
3733
         while (<MFILE>) {
3734
            if ($IsStillHelp == 2) {
3735
               next     if (/^\s*$/);
3736
               next     if (/^\s*function/);
3737
               if (/^\s*%/) { $IsStillHelp = 1; next; }
3738
            } elsif ($IsStillHelp == 1) {
3739
               next     if (/^\s*%/);
3740
               $IsStillHelp = 0;
3741
            }
3742
3743
            # Substritute special characters
3744
            $_ = &SubstituteHTMLEntities($_);
3745
3746
            # check for comment in line and format with css em
3747 400:4ad6499d7998 chris
            s/^(.*)%(.*?)([\s\r\n]+)$/$1<em class=\"mcom\">%$2<\/em>$3/;
3748 381:2dc8163e9150 Chris
3749
            # check/create cross references
3750
            foreach $funname (@{'all'.$name}) {
3751
               next if $funname eq $name;
3752
               $_ = &SubstituteName2Link($_, $funname);
3753
            }
3754
            print HFILE $_;
3755
         }
3756
         print HFILE "</pre>\n$var{'codehr'}\n";
3757
      }
3758
3759
      # Include info about author from authorfile
3760
      &WriteFile2Handle($var{'authorfile'}, HFILE)   ;
3761
3762
      print HFILE "<!--navigate-->\n";
3763
      print HFILE "<!--copyright-->\n";
3764 410:675de8e6becf chris
      print HFILE "</div>\n</body>\n</html>\n";
3765 381:2dc8163e9150 Chris
      close(MFILE);
3766
      close(HFILE);
3767
3768
      # Print name of finished file
3769
      if ($opt_silent) { print "\r"; }
3770
      print "   HTML-File created: $hfile{$name}\t";
3771
      if (!$opt_silent) { print "\n"; }
3772
      $filescreated++;
3773
   }
3774
3775
   print "\n$PROGRAM: $indexcreated index and $filescreated files created.\n";
3776
}
3777
3778
#========================================================================
3779
# Function:	CheckFileName
3780
# Purpose:	.
3781
#========================================================================
3782
sub CheckFileName {
3783
   local($filename, $description) = @_;
3784
   local(*CHECKFILE);
3785
3786
   open(CHECKFILE,"<$filename") || do {
3787
      if ($description eq '') {$description = 'file';}
3788
      # if (!$opt_silent) { print "Cannot open $description $filename: $!\n"; }
3789
      print "Cannot open $description $filename: $!\n";
3790
      return 1;
3791
   };
3792
   close(CHECKFILE);
3793
   return 0;
3794
3795
}
3796
3797
#========================================================================
3798
# Function:	CheckDirName
3799
# Purpose:	.
3800
#========================================================================
3801
sub CheckDirName {
3802
   local($dirname, $description) = @_;
3803
   local(*CHECKDIR);
3804
3805
   opendir(CHECKDIR,"$dirname") || die ("Cannot open $description directory $dirname: $!\n");
3806
   closedir(CHECKDIR);
3807
}
3808
3809
#========================================================================
3810
# Function:	WriteFile2Handle
3811
# Purpose:	.
3812
#========================================================================
3813
sub WriteFile2Handle {
3814
   local($filename, *WRITEFILE) = @_;
3815
   local(*READFILE);
3816
3817
   if ($filename ne '') {
3818
      open(READFILE,"<$filename");
3819
      @filecontents = <READFILE>;
3820
      close(READFILE);
3821
      print WRITEFILE "@filecontents\n";
3822
      # if (!$opt_silent) {print "      Contents of $filename added\n"};
3823
   }
3824
}
3825
3826
3827
#========================================================================
3828
# Function:	GetConfigFile
3829
# Purpose:	Read user's configuration file, if such exists.
3830
#========================================================================
3831
sub GetConfigFile
3832
{
3833
   local($filename) = @_;
3834
   local(*CONFIG);
3835
   local($value);
3836
3837
   if (&CheckFileName($filename, 'configuration file')) {
3838
      # if (!$opt_silent) { print "   Proceeding using built-in defaults for configuration.\n"; }
3839
      print "   Proceeding using built-in defaults for configuration.\n";
3840
      return 0;
3841
   };
3842
3843
   open(CONFIG,"< $filename");
3844
   while (<CONFIG>) {
3845
      s/#.*$//;
3846
      next if /^\s*$/o;
3847
3848
      # match keyword: process one or more arguments
3849
      # keyword set
3850
      if (/^\s*set\s+(\S+)\s*=\s*(.*)/) {
3851
         # setting a configuration variable
3852
         if (defined $var{$1}) {
3853
            $var{$1} = $2;
3854
            if ($debug > 3) { print "$1:   $var{$1}\n"; }
3855
         }
3856
         else {
3857
            print "$PROGRAM: unknown variable `$1' in configuration file\n"
3858
         }
3859
      } else {
3860
         chop($_);
3861
         print "$PROGRAM: unknown keyword in configuration file in line: `$_'\n"
3862
      }
3863
   }
3864
   close CONFIG;
3865
   1;
3866
}
3867
3868
3869
#------------------------------------------------------------------------
3870
# DisplayHelp - display help text using -h or -help command-line switch
3871
#------------------------------------------------------------------------
3872
sub DisplayHelp
3873
{
3874
   $help=<<EofHelp;
3875
   $PROGRAM v$VERSION - generate html documentation from Matlab m-files
3876
3877
   Usage: $PROGRAM [-h] [-c config_file] [-m|dirmfiles matlab_dir] [-d|dirhtml html_dir]
3878
                   [-i yes|no] [-r yes|no] [-p yes|no] [-quiet|q] [-a authorfile]
3879
3880
   $PROGRAM is a perl script that reads each matlab .m file in a directory
3881
   to produce a corresponding .html file of help documentation and cross
3882
   reference information. An index file is written with links to all of
3883
   the html files produced. The options are:
3884
3885
      -quiet         or -q : be silent, no status information during generation
3886
      -help          or -h : display this help message
3887
      -todo          or -t : print the todo list for $PROGRAM
3888
      -version       or -v : display version
3889
3890
      -configfile    or -c : name of configuration file (default to $var{'configfile'}).
3891
      -dirmfiles     or -m : top level directory containing matlab files to generate html for;
3892
                             default to actual directory.
3893
      -dirhtml       or -d : top level directory for generated html files;
3894
                             default to actual directory.
3895
3896
      -includesource or -i : Include matlab source in the html documentation [yes|no]
3897
                             default to yes.
3898
      -processtree   or -r : create docu for m-file directory and all subdirectories [yes|no];
3899
                             default to yes.
3900
      -producetree   or -p : create multi-level docu identical to directory structure
3901
                             of m-files [yes|no]; default to yes.
3902
      -writecontentsm or -w: update or write contents.m files into the matlab source
3903
                             directories [yes|no]; default to no.
3904
3905
      -authorfile    or -a : name of file including author information, last element in html;
3906
                             default to empty.
3907
3908
   The command line setting overwrite all other settings (built-in and configuration file).
3909
   The configuration file settings overwrite the built-in settings (and not the command
3910
   line settings).
3911
3912
   Typical usages are:
3913
     $PROGRAM
3914
        (use default parameters from perl script, if configuration
3915
         file is found -> generation of docu, else display of help)
3916
3917
     $PROGRAM -dirmfiles matlab -dirhtml html
3918
        (generate html documentation for all m-files in directory matlab,
3919
         place html files in directory html, use built-in defaults for
3920
         all other parameters, this way all m-files in the directory
3921
         matlab and below are converted and the generated html-files are
3922
         placed in the directory html and below producing the same
3923
         directory structure than below matlab)
3924
3925
     $PROGRAM -quiet
3926
        (use built-in parameters from perl script, if configuration
3927
         file is found use these settings as well, do generation,
3928
         no display except critical errors, status of conversion and result)
3929
3930
     $PROGRAM -m toolbox -dirhtml doc/html -r yes -p no
3931
        (convert all m-files in directory toolbox and below and place
3932
         the generated html files in directory doc/html, read all m-files
3933
         recursively, however, the generated html files are placed in one
3934
         directory)
3935
3936
     $PROGRAM -m toolbox -dirhtml doc/html -i no -r no
3937
        (convert all m-files in directory toolbox and place
3938
         the generated html files in directory doc/html, do not read m-files
3939
         recursively, do not include source code in documentation)
3940
3941
EofHelp
3942
3943
   die "$help";
3944
}
3945
3946
#------------------------------------------------------------------------
3947
# DisplayTodo - display ToDo list using -t or -todo command-line switch
3948
#------------------------------------------------------------------------
3949
sub DisplayTodo
3950
{
3951
   $todo=<<EofToDo;
3952
      $PROGRAM v$VERSION - ToDo list
3953
3954
       o	use more than one high level directory
3955
3956
       o	what should/could be done here???
3957
3958
EofToDo
3959
3960
   die "$todo";
3961
}
3962
3963
3964
#------------------------------------------------------------------------
3965
# ListVariables - list all defined variables and their values
3966
#------------------------------------------------------------------------
3967
sub ListVariables
3968
{
3969
   local($value);
3970
3971
   if ($debug > 0) {
3972
      print "List of all variables and their values\n";
3973
      foreach (sort keys %var)
3974
      {
3975
         if ($var{$_} eq '') {
3976
            $value = "empty";
3977
         } else {
3978
            $value = $var{$_};
3979
         }
3980
         print "   $_\n      $value\n";
3981
      }
3982
      print "\n\n";
3983
   }
3984
}
3985
3986
3987
__END__
3988
:endofperl
3989 0:513646585e45 Chris
#!/usr/bin/env ruby
3990
3991
# == Synopsis
3992
#
3993
# reposman: manages your repositories with Redmine
3994
#
3995
# == Usage
3996
#
3997
#    reposman [OPTIONS...] -s [DIR] -r [HOST]
3998 441:cbce1fd3b1b7 Chris
#
3999 0:513646585e45 Chris
#  Examples:
4000 241:7658d21a1493 chris
#    reposman --scm-dir=/var/svn --redmine-host=redmine.example.net --scm subversion
4001 0:513646585e45 Chris
#    reposman -s /var/git -r redmine.example.net -u http://svn.example.net --scm git
4002
#
4003
# == Arguments (mandatory)
4004
#
4005 241:7658d21a1493 chris
#   -s, --scm-dir=DIR         use DIR as base directory for repositories
4006 0:513646585e45 Chris
#   -r, --redmine-host=HOST   assume Redmine is hosted on HOST. Examples:
4007
#                             -r redmine.example.net
4008
#                             -r http://redmine.example.net
4009
#                             -r https://example.net/redmine
4010 909:cbb26bc654de Chris
#   -k, --key=KEY             use KEY as the Redmine API key (you can use the
4011
#                             --key-file option as an alternative)
4012 0:513646585e45 Chris
#
4013
# == Options
4014
#
4015
#   -o, --owner=OWNER         owner of the repository. using the rails login
4016
#                             allow user to browse the repository within
4017
#                             Redmine even for private project. If you want to
4018
#                             share repositories through Redmine.pm, you need
4019
#                             to use the apache owner.
4020
#   -g, --group=GROUP         group of the repository. (default: root)
4021
#   --scm=SCM                 the kind of SCM repository you want to create (and
4022
#                             register) in Redmine (default: Subversion).
4023
#                             reposman is able to create Git and Subversion
4024
#                             repositories. For all other kind, you must specify
4025
#                             a --command option
4026
#   -u, --url=URL             the base url Redmine will use to access your
4027
#                             repositories. This option is used to automatically
4028
#                             register the repositories in Redmine. The project
4029
#                             identifier will be appended to this url. Examples:
4030
#                             -u https://example.net/svn
4031
#                             -u file:///var/svn/
4032 28:12420e46bed9 chris
#                             if this option isn't set, reposman will register
4033
#                             the repositories with local file paths in Redmine
4034 0:513646585e45 Chris
#   -c, --command=COMMAND     use this command instead of "svnadmin create" to
4035
#                             create a repository. This option can be used to
4036
#                             create repositories other than subversion and git
4037
#                             kind.
4038
#                             This command override the default creation for git
4039
#                             and subversion.
4040 13:80433603a2cd Chris
#   --http-user=USER          User for HTTP Basic authentication with Redmine WS
4041
#   --http-pass=PASSWORD      Password for Basic authentication with Redmine WS
4042 909:cbb26bc654de Chris
#       --key-file=PATH       path to a file that contains the Redmine API key
4043
#                             (use this option instead of --key if you don't
4044
#                             the key to appear in the command line)
4045 0:513646585e45 Chris
#   -t, --test                only show what should be done
4046
#   -h, --help                show help and exit
4047
#   -v, --verbose             verbose
4048
#   -V, --version             print version and exit
4049
#   -q, --quiet               no log
4050
#
4051
# == References
4052 441:cbce1fd3b1b7 Chris
#
4053 0:513646585e45 Chris
# You can find more information on the redmine's wiki : http://www.redmine.org/wiki/redmine/HowTos
4054
4055
4056
require 'getoptlong'
4057 1332:1d1cb01c0417 Chris
#require 'rdoc/usage'
4058 0:513646585e45 Chris
require 'find'
4059
require 'etc'
4060
4061
Version = "1.3"
4062
SUPPORTED_SCM = %w( Subversion Darcs Mercurial Bazaar Git Filesystem )
4063
4064
opts = GetoptLong.new(
4065 241:7658d21a1493 chris
                      ['--scm-dir',      '-s', GetoptLong::REQUIRED_ARGUMENT],
4066 0:513646585e45 Chris
                      ['--redmine-host', '-r', GetoptLong::REQUIRED_ARGUMENT],
4067
                      ['--key',          '-k', GetoptLong::REQUIRED_ARGUMENT],
4068 909:cbb26bc654de Chris
                      ['--key-file',           GetoptLong::REQUIRED_ARGUMENT],
4069 0:513646585e45 Chris
                      ['--owner',        '-o', GetoptLong::REQUIRED_ARGUMENT],
4070
                      ['--group',        '-g', GetoptLong::REQUIRED_ARGUMENT],
4071
                      ['--url',          '-u', GetoptLong::REQUIRED_ARGUMENT],
4072
                      ['--command' ,     '-c', GetoptLong::REQUIRED_ARGUMENT],
4073
                      ['--scm',                GetoptLong::REQUIRED_ARGUMENT],
4074 13:80433603a2cd Chris
                      ['--http-user',          GetoptLong::REQUIRED_ARGUMENT],
4075
                      ['--http-pass',          GetoptLong::REQUIRED_ARGUMENT],
4076 0:513646585e45 Chris
                      ['--test',         '-t', GetoptLong::NO_ARGUMENT],
4077
                      ['--verbose',      '-v', GetoptLong::NO_ARGUMENT],
4078
                      ['--version',      '-V', GetoptLong::NO_ARGUMENT],
4079
                      ['--help'   ,      '-h', GetoptLong::NO_ARGUMENT],
4080
                      ['--quiet'  ,      '-q', GetoptLong::NO_ARGUMENT]
4081
                      )
4082
4083
$verbose      = 0
4084
$quiet        = false
4085
$redmine_host = ''
4086
$repos_base   = ''
4087 13:80433603a2cd Chris
$http_user    = ''
4088
$http_pass    = ''
4089 0:513646585e45 Chris
$svn_owner    = 'root'
4090
$svn_group    = 'root'
4091
$use_groupid  = true
4092
$svn_url      = false
4093
$test         = false
4094
$scm          = 'Subversion'
4095
4096
def log(text, options={})
4097
  level = options[:level] || 0
4098
  puts text unless $quiet or level > $verbose
4099
  exit 1 if options[:exit]
4100
end
4101
4102
def system_or_raise(command)
4103
  raise "\"#{command}\" failed" unless system command
4104
end
4105
4106 1332:1d1cb01c0417 Chris
def usage
4107
  puts "See source code for supported options"
4108
  exit
4109
end
4110
4111 0:513646585e45 Chris
module SCM
4112
4113
  module Subversion
4114
    def self.create(path)
4115
      system_or_raise "svnadmin create #{path}"
4116
    end
4117
  end
4118
4119
  module Git
4120
    def self.create(path)
4121
      Dir.mkdir path
4122
      Dir.chdir(path) do
4123
        system_or_raise "git --bare init --shared"
4124
        system_or_raise "git update-server-info"
4125
      end
4126
    end
4127
  end
4128
4129
end
4130
4131
begin
4132
  opts.each do |opt, arg|
4133
    case opt
4134 241:7658d21a1493 chris
    when '--scm-dir';        $repos_base   = arg.dup
4135 0:513646585e45 Chris
    when '--redmine-host';   $redmine_host = arg.dup
4136
    when '--key';            $api_key      = arg.dup
4137 909:cbb26bc654de Chris
    when '--key-file'
4138
      begin
4139
        $api_key = File.read(arg).strip
4140
      rescue Exception => e
4141
        $stderr.puts "Unable to read the key from #{arg}: #{e.message}"
4142
        exit 1
4143
      end
4144 0:513646585e45 Chris
    when '--owner';          $svn_owner    = arg.dup; $use_groupid = false;
4145
    when '--group';          $svn_group    = arg.dup; $use_groupid = false;
4146
    when '--url';            $svn_url      = arg.dup
4147
    when '--scm';            $scm          = arg.dup.capitalize; log("Invalid SCM: #{$scm}", :exit => true) unless SUPPORTED_SCM.include?($scm)
4148 13:80433603a2cd Chris
    when '--http-user';      $http_user    = arg.dup
4149
    when '--http-pass';      $http_pass    = arg.dup
4150 0:513646585e45 Chris
    when '--command';        $command =      arg.dup
4151
    when '--verbose';        $verbose += 1
4152
    when '--test';           $test = true
4153
    when '--version';        puts Version; exit
4154 1332:1d1cb01c0417 Chris
    when '--help';           usage
4155 0:513646585e45 Chris
    when '--quiet';          $quiet = true
4156
    end
4157
  end
4158
rescue
4159
  exit 1
4160
end
4161
4162
if $test
4163
  log("running in test mode")
4164
end
4165
4166
# Make sure command is overridden if SCM vendor is not handled internally (for the moment Subversion and Git)
4167
if $command.nil?
4168
  begin
4169
    scm_module = SCM.const_get($scm)
4170
  rescue
4171
    log("Please use --command option to specify how to create a #{$scm} repository.", :exit => true)
4172
  end
4173
end
4174
4175
$svn_url += "/" if $svn_url and not $svn_url.match(/\/$/)
4176
4177
if ($redmine_host.empty? or $repos_base.empty?)
4178 1332:1d1cb01c0417 Chris
  usage
4179 0:513646585e45 Chris
end
4180
4181
unless File.directory?($repos_base)
4182 217:ed8222a04634 chris
  log("directory '#{$repos_base}' doesn't exist", :exit => true)
4183 0:513646585e45 Chris
end
4184
4185
begin
4186
  require 'active_resource'
4187
rescue LoadError
4188
  log("This script requires activeresource.\nRun 'gem install activeresource' to install it.", :exit => true)
4189
end
4190
4191 37:94944d00e43c chris
class Project < ActiveResource::Base
4192 217:ed8222a04634 chris
  self.headers["User-agent"] = "SoundSoftware repository manager/#{Version}"
4193 909:cbb26bc654de Chris
  self.format = :xml
4194 37:94944d00e43c chris
end
4195 0:513646585e45 Chris
4196
log("querying Redmine for projects...", :level => 1);
4197
4198
$redmine_host.gsub!(/^/, "http://") unless $redmine_host.match("^https?://")
4199
$redmine_host.gsub!(/\/$/, '')
4200
4201
Project.site = "#{$redmine_host}/sys";
4202 13:80433603a2cd Chris
Project.user = $http_user;
4203
Project.password = $http_pass;
4204 0:513646585e45 Chris
4205
begin
4206
  # Get all active projects that have the Repository module enabled
4207
  projects = Project.find(:all, :params => {:key => $api_key})
4208 909:cbb26bc654de Chris
rescue ActiveResource::ForbiddenAccess
4209
  log("Request was denied by your Redmine server. Make sure that 'WS for repository management' is enabled in application settings and that you provided the correct API key.")
4210 0:513646585e45 Chris
rescue => e
4211
  log("Unable to connect to #{Project.site}: #{e}", :exit => true)
4212
end
4213
4214
if projects.nil?
4215 909:cbb26bc654de Chris
  log('No project found, perhaps you forgot to "Enable WS for repository management"', :exit => true)
4216 0:513646585e45 Chris
end
4217
4218 1107:4f45ab104990 Chris
log("found #{projects.size} projects at " + Time.now.inspect);
4219 0:513646585e45 Chris
4220
def set_owner_and_rights(project, repos_path, &block)
4221 441:cbce1fd3b1b7 Chris
  if mswin?
4222 0:513646585e45 Chris
    yield if block_given?
4223
  else
4224
    uid, gid = Etc.getpwnam($svn_owner).uid, ($use_groupid ? Etc.getgrnam(project.identifier).gid : Etc.getgrnam($svn_group).gid)
4225 34:09b1d4349da3 Chris
    right = project.is_public ? 02775 : 02770
4226 0:513646585e45 Chris
    yield if block_given?
4227
    Find.find(repos_path) do |f|
4228
      File.chmod right, f
4229
      File.chown uid, gid, f
4230
    end
4231
  end
4232
end
4233
4234
def other_read_right?(file)
4235
  (File.stat(file).mode & 0007).zero? ? false : true
4236
end
4237
4238
def owner_name(file)
4239
  mswin? ?
4240
    $svn_owner :
4241 441:cbce1fd3b1b7 Chris
    Etc.getpwuid( File.stat(file).uid ).name
4242 0:513646585e45 Chris
end
4243 441:cbce1fd3b1b7 Chris
4244 0:513646585e45 Chris
def mswin?
4245
  (RUBY_PLATFORM =~ /(:?mswin|mingw)/) || (RUBY_PLATFORM == 'java' && (ENV['OS'] || ENV['os']) =~ /windows/i)
4246
end
4247
4248
projects.each do |project|
4249 1107:4f45ab104990 Chris
  log("inspecting project #{project.name}", :level => 1)
4250 0:513646585e45 Chris
4251
  if project.identifier.empty?
4252 1107:4f45ab104990 Chris
    log("\tno identifier for project #{project.name}!")
4253 0:513646585e45 Chris
    next
4254 1445:0c7b3bb73517 Chris
  elsif not project.identifier.match(/^[a-z0-9_\-]+$/)
4255 1107:4f45ab104990 Chris
    log("\tinvalid identifier for project #{project.name} : #{project.identifier}!");
4256 0:513646585e45 Chris
    next;
4257
  end
4258
4259
  repos_path = File.join($repos_base, project.identifier).gsub(File::SEPARATOR, File::ALT_SEPARATOR || File::SEPARATOR)
4260
4261 28:12420e46bed9 chris
  create_repos = false
4262
  # Logic required for SoundSoftware.ac.uk repositories:
4263
  #
4264
  # * If the project has a repository path declared already,
4265
  #   - if it's a local path,
4266
  #     - if it does not exist
4267
  #       - if it has the right root
4268
  #         - create it
4269
  #   - else
4270
  #     - leave alone (remote repository)
4271
  # * else
4272
  #   - create repository with same name as project
4273
  #   - set to project
4274
4275
  if project.respond_to?(:repository)
4276
4277
    repos_url = project.repository.url;
4278 1107:4f45ab104990 Chris
    log("\texisting url for project #{project.identifier} is #{repos_url}", :level => 2);
4279 28:12420e46bed9 chris
4280
    if repos_url.match(/^file:\//) || repos_url.match(/^\//)
4281
4282
      repos_url = repos_url.gsub(/^file:\/*/, "/");
4283 1107:4f45ab104990 Chris
      log("\tthis is a local file path, at #{repos_url}", :level => 2);
4284 28:12420e46bed9 chris
4285
      if repos_url.slice(0, $repos_base.length) != $repos_base
4286
        # leave repos_path set to our original suggestion
4287 1107:4f45ab104990 Chris
        log("\tpreparing to replace incorrect repo location #{repos_url} for #{project.name} with #{repos_path}");
4288 28:12420e46bed9 chris
        create_repos = true
4289
      else
4290
        if !File.directory?(repos_url)
4291 1107:4f45ab104990 Chris
          log("\tpreparing to create repo for #{project.name} at #{repos_url}");
4292 28:12420e46bed9 chris
          repos_path = repos_url
4293
          create_repos = true
4294
        else
4295 1107:4f45ab104990 Chris
          log("\tit exists and is in the right place", :level => 2);
4296 28:12420e46bed9 chris
        end
4297
      end
4298
    else
4299 1107:4f45ab104990 Chris
      log("\tthis is a remote path, leaving alone", :level => 2);
4300 28:12420e46bed9 chris
    end
4301
  else
4302 1107:4f45ab104990 Chris
    log("\tpreparing to set repo location and create for #{project.name} at #{repos_url}")
4303 28:12420e46bed9 chris
#    if File.directory?(repos_path)
4304
#      log("\trepository path #{repos_path} already exists, not creating")
4305
#    else
4306
      create_repos = true
4307
#    end
4308
  end
4309
4310
  if create_repos
4311
4312
    registration_url = repos_path
4313
    if $svn_url
4314
      registration_url = "#{$svn_url}#{project.identifier}"
4315
    end
4316 0:513646585e45 Chris
4317
    if $test
4318 28:12420e46bed9 chris
      log("\tproposal: create repository #{repos_path}")
4319
      log("\tproposal: register repository #{repos_path} in Redmine with vendor #{$scm}, url #{registration_url}")
4320 0:513646585e45 Chris
      next
4321
    end
4322
4323 52:8c3409528d3a Chris
# No -- we need "other" users to be able to read it.  Access control
4324
# is not handled through Unix user id anyway
4325
#    project.is_public ? File.umask(0002) : File.umask(0007)
4326
    File.umask(0002)
4327
4328 28:12420e46bed9 chris
    log("\taction: create repository #{repos_path}")
4329 0:513646585e45 Chris
4330
    begin
4331 28:12420e46bed9 chris
      if !File.directory?(repos_path)
4332
        set_owner_and_rights(project, repos_path) do
4333
          if scm_module.nil?
4334
            log("\trunning command: #{$command} #{repos_path}")
4335
            system_or_raise "#{$command} #{repos_path}"
4336
          else
4337
            scm_module.create(repos_path)
4338
          end
4339 0:513646585e45 Chris
        end
4340
      end
4341
    rescue => e
4342
      log("\tunable to create #{repos_path} : #{e}\n")
4343
      next
4344
    end
4345
4346 28:12420e46bed9 chris
    begin
4347
      log("\taction: register repository #{repos_path} in Redmine with vendor #{$scm}, url #{registration_url}");
4348
      project.post(:repository, :vendor => $scm, :repository => {:url => "#{registration_url}"}, :key => $api_key)
4349
    rescue => e
4350
      log("\trepository #{repos_path} not registered in Redmine: #{e.message}");
4351 0:513646585e45 Chris
    end
4352
    log("\trepository #{repos_path} created");
4353
  end
4354 37:94944d00e43c chris
end
4355 0:513646585e45 Chris
4356 1107:4f45ab104990 Chris
log("project review completed at " + Time.now.inspect);
4357
4358 241:7658d21a1493 chris
#!/bin/sh
4359
4360 242:bde4f47b6427 chris
mirrordir="/var/mirror"
4361 1336:b61a51fb42b9 Chris
hg="/usr/bin/hg"
4362 242:bde4f47b6427 chris
4363 241:7658d21a1493 chris
project="$1"
4364
local_repo="$2"
4365
remote_repo="$3"
4366
4367
if [ -z "$project" ] || [ -z "$local_repo" ] || [ -z "$remote_repo" ]; then
4368
    echo "Usage: $0 <project> <local-repo-path> <remote-repo-url>"
4369
    exit 2
4370
fi
4371
4372
  # We need to handle different source repository types separately.
4373
  #
4374
  # The convert extension cannot convert directly from a remote git
4375
  # repo; we'd have to mirror to a local repo first.  Incremental
4376
  # conversions do work though.  The hg-git plugin will convert
4377
  # directly from remote repositories, but not via all schemes
4378
  # (e.g. https is not currently supported).  It's probably easier to
4379
  # use git itself to clone locally and then convert or hg-git from
4380
  # there.
4381
  #
4382
  # We can of course convert directly from remote Subversion repos,
4383
  # but we need to keep track of that -- you can ask to convert into a
4384
  # repo that has already been used (for Mercurial) and it'll do so
4385
  # happily; we don't want that.
4386
  #
4387
  # Converting from a remote Hg repo should be fine!
4388
  #
4389
  # One other thing -- we can't actually tell the difference between
4390
  # the various SCM types based on URL alone.  We have to try them
4391
  # (ideally in an order determined by a guess based on the URL) and
4392
  # see what happens.
4393
4394 242:bde4f47b6427 chris
project_mirror="$mirrordir/$project"
4395
mkdir -p "$project_mirror"
4396
project_repo_mirror="$project_mirror/repo"
4397 241:7658d21a1493 chris
4398 242:bde4f47b6427 chris
  # Some test URLs:
4399
  #
4400
  # http://aimc.googlecode.com/svn/trunk/
4401
  # http://aimc.googlecode.com/svn/
4402
  # http://vagar.org/git/flam
4403
  # https://github.com/wslihgt/IMMF0salience.git
4404
  # http://hg.breakfastquay.com/dssi-vst/
4405
  # git://github.com/schacon/hg-git.git
4406
  # http://svn.drobilla.net/lad (externals!)
4407
4408
# If we are importing from another distributed system, then our aim is
4409
# to create either a Hg repo or a git repo at $project_mirror, which
4410
# we can then pull from directly to the Hg repo at $local_repo (using
4411
# hg-git, in the case of a git repo).
4412
4413
# Importing from SVN, we should use hg convert directly to the target
4414
# hg repo (or should we?) but keep a record of the last changeset ID
4415
# we brought in, and test each time whether it matches the last
4416
# changeset ID actually in the repo
4417
4418
success=""
4419
4420 436:4eb486dbf730 Chris
# If we have a record of the last successfully updated remote repo
4421
# URL, check it against our current remote URL: if it has changed, we
4422
# will need to start again with a new clone rather than pulling
4423
# updates into the existing local mirror
4424
4425
successfile="$project_mirror/last_successful_url"
4426
if [ -f "$successfile" ]; then
4427
    last=$(cat "$successfile")
4428 437:102056ec2de9 chris
    if [ x"$last" = x"$remote_repo" ]; then
4429 436:4eb486dbf730 Chris
	echo "$$: Remote URL is unchanged from last successful update"
4430
    else
4431
	echo "$$: Remote URL has changed since last successful update:"
4432
	echo "$$: Last URL was $last, current is $remote_repo"
4433
	suffix="$$.$(date +%s)"
4434
	echo "$$: Moving existing repos to $suffix suffix and starting afresh"
4435
	mv "$project_repo_mirror" "$project_repo_mirror"."$suffix"
4436
	mv "$local_repo" "$local_repo"."$suffix"
4437
	mv "$successfile" "$successfile"."$suffix"
4438 437:102056ec2de9 chris
	touch "$project_mirror/url_changed"
4439 436:4eb486dbf730 Chris
    fi
4440
fi
4441
4442 242:bde4f47b6427 chris
if [ -d "$project_repo_mirror" ]; then
4443
4444
    # Repo mirror exists: update it
4445
    echo "$$: Mirror for project $project exists at $project_repo_mirror, updating" 1>&2
4446
4447
    if [ -d "$project_repo_mirror/.hg" ]; then
4448 433:7fd72f22a42b Chris
	"$hg" --config extensions.convert= convert --datesort "$remote_repo" "$project_repo_mirror" && success=true
4449 439:d3faf348b287 chris
	if [ -z "$success" ]; then
4450
	    ( cd "$project_repo_mirror" && "$hg" pull "$remote_repo" ) && success=true
4451
	fi
4452 242:bde4f47b6427 chris
    elif [ -d "$project_repo_mirror/.git" ]; then
4453 431:d3af621ba9d4 Chris
	( cd "$project_repo_mirror" && git pull "$remote_repo" master ) && success=true
4454 242:bde4f47b6427 chris
    else
4455
	echo "$$: ERROR: Repo mirror dir $project_repo_mirror exists but is not an Hg or git repo" 1>&2
4456
    fi
4457
4458
else
4459
4460
    # Repo mirror does not exist yet
4461
    echo "$$: Mirror for project $project does not yet exist at $project_repo_mirror, trying to convert or clone" 1>&2
4462
4463
    case "$remote_repo" in
4464
	*git*)
4465
	    git clone "$remote_repo" "$project_repo_mirror" ||
4466 433:7fd72f22a42b Chris
	    "$hg" --config extensions.convert= convert --datesort "$remote_repo" "$project_repo_mirror"
4467 242:bde4f47b6427 chris
	    ;;
4468
	*)
4469 433:7fd72f22a42b Chris
	    "$hg" --config extensions.convert= convert --datesort "$remote_repo" "$project_repo_mirror" ||
4470 299:defe55be97b9 chris
	    git clone "$remote_repo" "$project_repo_mirror" ||
4471 433:7fd72f22a42b Chris
	    "$hg" clone "$remote_repo" "$project_repo_mirror"
4472 242:bde4f47b6427 chris
	    ;;
4473
    esac && success=true
4474
4475
fi
4476
4477
echo "Success=$success"
4478
4479
if [ -n "$success" ]; then
4480
    echo "$$: Update successful, pulling into local repo at $local_repo"
4481 436:4eb486dbf730 Chris
    if [ ! -d "$local_repo" ]; then
4482
	"$hg" init "$local_repo"
4483
    fi
4484 242:bde4f47b6427 chris
    if [ -d "$project_repo_mirror/.git" ]; then
4485 436:4eb486dbf730 Chris
	( cd "$local_repo" && "$hg" --config extensions.hggit= pull "$project_repo_mirror" ) && echo "$remote_repo" > "$successfile"
4486 242:bde4f47b6427 chris
    else
4487 436:4eb486dbf730 Chris
	( cd "$local_repo" && "$hg" pull "$project_repo_mirror" ) && echo "$remote_repo" > "$successfile"
4488 242:bde4f47b6427 chris
    fi
4489
fi