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 @ 1558:a0c46d6fe7bc

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 1557:9d6d2f696782 Chris
echo
1632
echo "$0 starting at $(date)"
1633
1634 1547:bca3b5e5bbf2 Chris
echo "Extracting author maps..."
1635 1546:248c402992ba Chris
1636 1550:7d825cbd76c8 Chris
# Delete any existing authormap files, because we want to ensure we
1637
# don't have an authormap for any project that was exportable but has
1638
# become non-exportable (e.g. has gone private)
1639 1551:36dddb6755f6 Chris
rm -f "$authordir/*"
1640 1550:7d825cbd76c8 Chris
1641 1546:248c402992ba Chris
"$rails" runner -e "$environment" "$progdir/create-repo-authormaps.rb" \
1642 1543:05d639e5d59b Chris
	 -s "$hgdir" -o "$authordir"
1643
1644
for hgrepo in "$hgdir"/*; do
1645
1646
    if [ ! -d "$hgrepo/.hg" ]; then
1647
	echo "Directory $hgrepo does not appear to be a Mercurial repo, skipping"
1648
	continue
1649
    fi
1650
1651
    reponame=$(basename "$hgrepo")
1652
    authormap="$authordir/authormap_$reponame"
1653
    gitrepo="$gitdir/$reponame"
1654
1655
    if [ ! -f "$authormap" ]; then
1656 1547:bca3b5e5bbf2 Chris
	echo "No authormap file was created for repo $reponame, skipping"
1657 1550:7d825cbd76c8 Chris
1658
	# If there is no authormap file, then we should not have a git
1659
	# mirror -- this is a form of access control, not just an
1660
	# optimisation (authormap files are expected to exist for all
1661
	# exportable projects, even if empty). So if a git mirror
1662
	# exists, we move it away
1663
	if [ -d "$gitrepo" ]; then
1664
	    mv "$gitrepo" "$wastedir/$(date +%s).$reponame"
1665
	fi
1666
1667 1543:05d639e5d59b Chris
	continue
1668
    fi
1669
1670
    if [ ! -d "$gitrepo" ]; then
1671
	git init "$gitrepo"
1672
    fi
1673
1674 1547:bca3b5e5bbf2 Chris
    echo
1675 1546:248c402992ba Chris
    echo "About to run fast export for repo $reponame..."
1676 1543:05d639e5d59b Chris
1677
    (
1678
	cd "$gitrepo"
1679 1549:28cde511f312 Chris
1680
        # Force is necessary because git-fast-import (or git) can't handle
1681
        # branches having more than one head ("Error: repository has at
1682
        # least one unnamed head"), which happens from time to time in
1683
        # valid Hg repos. With --force apparently it will just pick one
1684
        # of the two heads arbitrarily, which is also alarming but is
1685
        # more likely to be useful
1686 1558:a0c46d6fe7bc Chris
	"$fastexport" --quiet -r "$hgrepo" --hgtags -A "$authormap" --force
1687 1555:1786830cc35d Chris
1688
        git update-server-info
1689 1543:05d639e5d59b Chris
    )
1690
1691
    echo "Fast export done"
1692
1693
done
1694
1695 1557:9d6d2f696782 Chris
echo "$0 finishing at $(date)"
1696 1543:05d639e5d59b Chris
1697 203:1e55195bca45 chris
#!/bin/bash
1698
1699
# Run this script from anywhere
1700
1701
# Enumerate Hg repos; make sure they're up to date; extract docs for
1702
# each
1703
1704
hgdir="/var/hg"
1705
docdir="/var/doc"
1706 223:c3544e9fd588 chris
logfile="/var/www/test-cannam/log/extract-docs.log"
1707
1708
redgrp="redmine"
1709 203:1e55195bca45 chris
1710 218:292cde42265a chris
apikey=""
1711 339:5410d82c12df chris
apischeme="https"
1712 218:292cde42265a chris
apihost=""
1713
apiuser=""
1714
apipass=""
1715
1716 203:1e55195bca45 chris
progdir=$(dirname $0)
1717
case "$progdir" in
1718
    /*) ;;
1719
    *) progdir="$(pwd)/$progdir" ;;
1720
esac
1721
1722 411:e7ba81c8dc5a chris
types="doxygen javadoc matlabdocs" # Do Doxygen first (it can be used for Java too)
1723 203:1e55195bca45 chris
1724
for x in $types; do
1725
    if [ ! -x "$progdir/extract-$x.sh" ]; then
1726
	echo "Helper script not available: $progdir/extract-$x.sh"
1727
	exit 1
1728
    fi
1729
done
1730
1731 218:292cde42265a chris
enable_embedded()
1732
{
1733
    p="$1"
1734 228:3c084a25d8ab chris
    if [ -n "$apikey" ]; then
1735
	if [ -n "$apiuser" ]; then
1736 339:5410d82c12df chris
	    sudo -u docgen curl -u "$apiuser":"$apipass" "$apischeme://$apihost/sys/projects/$p/embedded.xml?enable=1&key=$apikey" -d ""
1737 228:3c084a25d8ab chris
	else
1738 339:5410d82c12df chris
	    sudo -u docgen curl "$apischeme://$apihost/sys/projects/$p/embedded.xml?enable=1&key=$apikey" -d ""
1739 228:3c084a25d8ab chris
	fi
1740
    else
1741
	echo "Can't enable Embedded, API not configured" 1>&2
1742 218:292cde42265a chris
    fi
1743
}
1744
1745 223:c3544e9fd588 chris
# We want to ensure the doc extraction is done by the unprivileged
1746
# user docgen, which is not a member of any interesting group
1747
#
1748
# To this end, we create the tmpdir with user docgen and group
1749
# www-data, and use the www-data user to pull out an archive of the Hg
1750
# repo tip into a location beneath that, before using the docgen user
1751
# to extract docs from that location and write them into the tmpdir
1752
1753
# Same tmpdir for each project: we delete and recreate to avoid
1754
# cleanup duty from lots of directories being created
1755
#
1756
tmpdir=$(mktemp -d "$docdir/tmp_XXXXXX")
1757
1758
fail()
1759
{
1760
    message="$1"
1761
    echo "$message" 1>&2
1762
    case "$tmpdir" in
1763
	*/tmp*) rm -rf "$tmpdir";;
1764
	*);;
1765
    esac
1766
    exit 1
1767
}
1768
1769
case "$tmpdir" in
1770
    /*) ;;
1771
    *) fail "Temporary directory creation failed";;
1772
esac
1773
1774
chown docgen.www-data "$tmpdir" || fail "Temporary directory ownership change failed"
1775
chmod g+rwx "$tmpdir" || fail "Temporary directory permissions change failed"
1776
1777 203:1e55195bca45 chris
for projectdir in "$hgdir"/* ; do
1778
1779
    if [ -d "$projectdir" ] && [ -d "$projectdir/.hg" ]; then
1780
1781 223:c3544e9fd588 chris
	if ! sudo -u www-data hg -R "$projectdir" -q update; then
1782
	    echo "Failed to update Hg in $projectdir, skipping" 1>&2
1783
	    continue
1784
	fi
1785
1786 203:1e55195bca45 chris
	project=$(basename "$projectdir")
1787
1788 223:c3544e9fd588 chris
	tmptargetdir="$tmpdir/doc"
1789
	snapshotdir="$tmpdir/hgsnapshot"
1790 203:1e55195bca45 chris
1791 223:c3544e9fd588 chris
	rm -rf "$tmptargetdir" "$snapshotdir"
1792
1793 226:5b028aef59a7 chris
	mkdir -m 770 "$tmptargetdir" || fail "Temporary target directory creation failed"
1794
	chown docgen.www-data "$tmptargetdir" || fail "Temporary target directory ownership change failed"
1795 223:c3544e9fd588 chris
1796
	mkdir -m 770 "$snapshotdir" || fail "Snapshot directory creation failed"
1797
	chown docgen.www-data "$snapshotdir" || fail "Snapshot directory ownership change failed"
1798
1799
	hgparents=$(sudo -u www-data hg -R "$projectdir" parents)
1800
	if [ -z "$hgparents" ]; then
1801
	    echo "Hg repo at $projectdir has no working copy (empty repo?), skipping"
1802
	    continue
1803
	else
1804
	    echo "Found non-empty Hg repo: $projectdir for project $project"
1805
	fi
1806
1807
	if ! sudo -u www-data hg -R "$projectdir" archive -r tip -t files "$snapshotdir"; then
1808
	    echo "Failed to pick archive from $projectdir, skipping" 1>&2
1809
	    continue
1810
	fi
1811 203:1e55195bca45 chris
1812
	targetdir="$docdir/$project"
1813
1814 223:c3544e9fd588 chris
	echo "Temporary dir is $tmpdir, temporary doc dir is $tmptargetdir, snapshot dir is $snapshotdir, eventual target is $targetdir"
1815 203:1e55195bca45 chris
1816
	for x in $types; do
1817 226:5b028aef59a7 chris
	    if sudo -u docgen "$progdir/extract-$x.sh" "$project" "$snapshotdir" "$tmptargetdir" >> "$logfile" 2>&1; then
1818
		break
1819
	    else
1820 203:1e55195bca45 chris
		echo "Failed to extract via type $x"
1821
	    fi
1822
	done
1823
1824 223:c3544e9fd588 chris
        if [ -f "$tmptargetdir/index.html" ]; then
1825 203:1e55195bca45 chris
	    echo "Processing resulted in an index.html being created, looks good!"
1826
	    if [ ! -d "$targetdir" ] || [ ! -f "$targetdir/index.html" ]; then
1827 223:c3544e9fd588 chris
		echo "This project hasn't had doc extracted before: enabling Embedded"
1828 218:292cde42265a chris
		enable_embedded "$project"
1829 203:1e55195bca45 chris
	    fi
1830
1831
	    if [ -d "$targetdir" ]; then
1832
		mv "$targetdir" "$targetdir"_"$$" && \
1833 223:c3544e9fd588 chris
		    mv "$tmptargetdir" "$targetdir" && \
1834 203:1e55195bca45 chris
		    rm -rf "$targetdir"_"$$"
1835 223:c3544e9fd588 chris
		chgrp -R "$redgrp" "$targetdir"
1836 203:1e55195bca45 chris
	    else
1837 223:c3544e9fd588 chris
		mv "$tmptargetdir" "$targetdir"
1838
		chgrp -R "$redgrp" "$targetdir"
1839 203:1e55195bca45 chris
	    fi
1840 228:3c084a25d8ab chris
	else
1841
	    echo "Processing did not result in an index.html being created"
1842 203:1e55195bca45 chris
	fi
1843
    fi
1844
done
1845
1846 223:c3544e9fd588 chris
rm -rf "$tmpdir"
1847 203:1e55195bca45 chris
#!/bin/bash
1848
1849
docdir="/var/doc"
1850
1851 228:3c084a25d8ab chris
progdir=$(dirname $0)
1852
case "$progdir" in
1853
    /*) ;;
1854
    *) progdir="$(pwd)/$progdir" ;;
1855
esac
1856
1857 203:1e55195bca45 chris
project="$1"
1858 223:c3544e9fd588 chris
projectdir="$2"
1859
targetdir="$3"
1860 203:1e55195bca45 chris
1861 223:c3544e9fd588 chris
if [ -z "$project" ] || [ -z "$targetdir" ] || [ -z "$projectdir" ]; then
1862
    echo "Usage: $0 <project> <projectdir> <targetdir>"
1863 203:1e55195bca45 chris
    exit 2
1864
fi
1865
1866 223:c3544e9fd588 chris
if [ ! -d "$projectdir" ]; then
1867
    echo "Project directory $projectdir not found"
1868 203:1e55195bca45 chris
    exit 1
1869
fi
1870
1871
if [ ! -d "$targetdir" ]; then
1872
    echo "Target dir $targetdir not found"
1873
    exit 1
1874
fi
1875
1876
if [ -f "$targetdir/index.html" ]; then
1877
    echo "Target dir $targetdir already contains index.html"
1878
    exit 1
1879
fi
1880
1881
doxyfile=$(find "$projectdir" -type f -name Doxyfile -print | head -1)
1882
1883
if [ -z "$doxyfile" ]; then
1884
    echo "No Doxyfile found for project $project"
1885
    exit 1
1886
fi
1887
1888
echo "Project $project contains a Doxyfile at $doxyfile"
1889
1890
cd "$projectdir" || exit 1
1891
1892 228:3c084a25d8ab chris
"$progdir/doxysafe.pl" "$doxyfile" | \
1893
    sed -e '$a OUTPUT_DIRECTORY='"$targetdir" | \
1894 203:1e55195bca45 chris
    doxygen -
1895
1896
#!/bin/bash
1897 168:c1e9f2dab1d5 chris
1898 203:1e55195bca45 chris
docdir="/var/doc"
1899 168:c1e9f2dab1d5 chris
1900 203:1e55195bca45 chris
project="$1"
1901 223:c3544e9fd588 chris
projectdir="$2"
1902
targetdir="$3"
1903 168:c1e9f2dab1d5 chris
1904 223:c3544e9fd588 chris
if [ -z "$project" ] || [ -z "$targetdir" ] || [ -z "$projectdir" ]; then
1905
    echo "Usage: $0 <project> <projectdir> <targetdir>"
1906 203:1e55195bca45 chris
    exit 2
1907 168:c1e9f2dab1d5 chris
fi
1908
1909 223:c3544e9fd588 chris
if [ ! -d "$projectdir" ]; then
1910
    echo "Project directory $projectdir not found"
1911 203:1e55195bca45 chris
    exit 1
1912
fi
1913 168:c1e9f2dab1d5 chris
1914 203:1e55195bca45 chris
if [ ! -d "$targetdir" ]; then
1915
    echo "Target dir $targetdir not found"
1916
    exit 1
1917
fi
1918 168:c1e9f2dab1d5 chris
1919 203:1e55195bca45 chris
if [ -f "$targetdir/index.html" ]; then
1920
    echo "Target dir $targetdir already contains index.html"
1921
    exit 1
1922 178:2cec5c53cd68 chris
fi
1923 168:c1e9f2dab1d5 chris
1924 191:0d1c6fa50d3a chris
# Identify Java files whose packages match the trailing parts of their
1925
# paths, and list the resulting packages and the path prefixes with
1926
# the packages removed (so as to find code in subdirs,
1927
# e.g. src/com/example/...)
1928
1929
# Regexp match is very rough; check what is actually permitted for
1930
# package declarations
1931
1932 203:1e55195bca45 chris
find "$projectdir" -type f -name \*.java \
1933 989:3549525ba22a Chris
    -exec egrep '^ *package +[a-zA-Z][a-zA-Z0-9\._-]*;.*$' \{\} /dev/null \; |
1934
    sed -e 's/\/[^\/]*: *package */:/' -e 's/;.*$//' |
1935 191:0d1c6fa50d3a chris
    sort | uniq | (
1936
	current_prefix=
1937
	current_packages=
1938
	while IFS=: read filepath package; do
1939
	    echo "Looking at $package in $filepath"
1940
	    packagepath=${package//./\/}
1941
	    prefix=${filepath%$packagepath}
1942 203:1e55195bca45 chris
	    prefix=${prefix:=$projectdir}
1943 191:0d1c6fa50d3a chris
	    if [ "$prefix" = "$filepath" ]; then
1944
		echo "Package $package does not match suffix of path $filepath, skipping"
1945
		continue
1946
	    fi
1947
	    if [ "$prefix" != "$current_prefix" ]; then
1948 450:73401a15037b Chris
		echo "Package $package matches file path and has new prefix $prefix"
1949 191:0d1c6fa50d3a chris
		if [ -n "$current_packages" ]; then
1950
		    echo "Running Javadoc for packages $current_packages from prefix $current_prefix"
1951 450:73401a15037b Chris
		    echo "Command is: javadoc -sourcepath "$current_prefix" -d "$targetdir" -subpackages $current_packages"
1952 203:1e55195bca45 chris
		    javadoc -sourcepath "$current_prefix" -d "$targetdir" -subpackages $current_packages
1953 191:0d1c6fa50d3a chris
		fi
1954
		current_prefix="$prefix"
1955 450:73401a15037b Chris
		current_packages="$package"
1956 191:0d1c6fa50d3a chris
	    else
1957 450:73401a15037b Chris
		echo "Package $package matches file path with same prefix as previous file"
1958 191:0d1c6fa50d3a chris
		current_packages="$current_packages $package"
1959
	    fi
1960
	done
1961 203:1e55195bca45 chris
	prefix=${prefix:=$projectdir}
1962 191:0d1c6fa50d3a chris
	if [ -n "$current_packages" ]; then
1963
	    echo "Running Javadoc for packages $current_packages in prefix $current_prefix"
1964 450:73401a15037b Chris
  	    echo "Command is: javadoc -sourcepath "$current_prefix" -d "$targetdir" -subpackages $current_packages"
1965 203:1e55195bca45 chris
	    javadoc -sourcepath "$current_prefix" -d "$targetdir" -subpackages $current_packages
1966 191:0d1c6fa50d3a chris
	fi
1967
    )
1968
1969 450:73401a15037b Chris
if [ -f "$targetdir"/overview-tree.html ]; then
1970
    cp "$targetdir"/overview-tree.html "$targetdir"/index.html
1971
fi
1972
1973 203:1e55195bca45 chris
# for exit code:
1974
[ -f "$targetdir/index.html" ]
1975 168:c1e9f2dab1d5 chris
1976 411:e7ba81c8dc5a chris
#!/bin/bash
1977
1978
docdir="/var/doc"
1979
1980
progdir=$(dirname $0)
1981
case "$progdir" in
1982
    /*) ;;
1983
    *) progdir="$(pwd)/$progdir" ;;
1984
esac
1985
1986
project="$1"
1987
projectdir="$2"
1988
targetdir="$3"
1989
1990
if [ -z "$project" ] || [ -z "$targetdir" ] || [ -z "$projectdir" ]; then
1991
    echo "Usage: $0 <project> <projectdir> <targetdir>"
1992
    exit 2
1993
fi
1994
1995
if [ ! -d "$projectdir" ]; then
1996
    echo "Project directory $projectdir not found"
1997
    exit 1
1998
fi
1999
2000
if [ ! -d "$targetdir" ]; then
2001
    echo "Target dir $targetdir not found"
2002
    exit 1
2003
fi
2004
2005
if [ -f "$targetdir/index.html" ]; then
2006
    echo "Target dir $targetdir already contains index.html"
2007
    exit 1
2008
fi
2009
2010
mfile=$(find "$projectdir" -type f -name \*.m -print0 | xargs -0 grep -l '^% ' | head -1)
2011
2012
if [ -z "$mfile" ]; then
2013
    echo "No MATLAB files with comments found for project $project"
2014
    exit 1
2015
fi
2016
2017
echo "Project $project contains at least one MATLAB file with comments"
2018
2019
cd "$projectdir" || exit 1
2020
2021
perl "$progdir/matlab-docs.pl" -c "$progdir/matlab-docs.conf" -d "$targetdir"
2022
2023 978:bbb88c44f805 Chris
2024 980:9b4919de5317 Chris
# Read an Apache log file in SoundSoftware site format from stdin and
2025
# produce some per-project stats.
2026 978:bbb88c44f805 Chris
#
2027
# Invoke with e.g.
2028
#
2029
# cat /var/log/apache2/code-access.log | \
2030
#   script/runner -e production extra/soundsoftware/get-apache-log-stats.rb
2031
2032 975:198f764e734c Chris
2033
# Use the ApacheLogRegex parser, a neat thing
2034
# See http://www.simonecarletti.com/blog/2009/02/apache-log-regex-a-lightweight-ruby-apache-log-parser/
2035
require 'apachelogregex'
2036
2037
# This is the format defined in our httpd.conf
2038
vhost_combined_format = '%v:%p %h %{X-Forwarded-For}i %l %u %t \"%r\" %>s %O \"%{Referer}i\" \"%{User-Agent}i\"'
2039
2040
parser = ApacheLogRegex.new(vhost_combined_format)
2041
2042
# project name -> count of hg clones
2043
clones = Hash.new(0)
2044
2045
# project name -> count of hg pulls
2046
pulls = Hash.new(0)
2047
2048 978:bbb88c44f805 Chris
# project name -> count of hg pushes
2049
pushes = Hash.new(0)
2050 975:198f764e734c Chris
2051
# project name -> count of hg archive requests (i.e. Download as Zip)
2052
zips = Hash.new(0)
2053
2054
# project name -> count of hits to pages under /projects/projectname
2055
hits = Hash.new(0)
2056
2057 978:bbb88c44f805 Chris
# project name -> Project object
2058
@projects = Hash.new
2059
2060 975:198f764e734c Chris
parseable = 0
2061
unparseable = 0
2062
2063 979:56a38a9f6204 Chris
def is_public_project?(project)
2064 978:bbb88c44f805 Chris
  if !project
2065
    false
2066 983:a97e573d7f87 Chris
  elsif project =~ /^\d+$/
2067
    # ignore numerical project ids, they are only used when editing projects
2068
    false
2069 978:bbb88c44f805 Chris
  elsif @projects.key?(project)
2070 979:56a38a9f6204 Chris
    @projects[project].is_public?
2071 978:bbb88c44f805 Chris
  else
2072
    pobj = Project.find_by_identifier(project)
2073
    if pobj
2074
      @projects[project] = pobj
2075 979:56a38a9f6204 Chris
      pobj.is_public?
2076 978:bbb88c44f805 Chris
    else
2077 979:56a38a9f6204 Chris
      print "Project not found: ", project, "\n"
2078 978:bbb88c44f805 Chris
      false
2079
    end
2080
  end
2081
end
2082
2083 980:9b4919de5317 Chris
def print_stats(h)
2084
  h.keys.sort { |a,b| h[b] <=> h[a] }.each do |p|
2085 982:6edb748be064 Chris
    if h[p] > 0
2086 983:a97e573d7f87 Chris
      print h[p], " ", @projects[p].name, " [", p, "]\n"
2087 982:6edb748be064 Chris
    end
2088 980:9b4919de5317 Chris
  end
2089
end
2090
2091 979:56a38a9f6204 Chris
STDIN.each do |line|
2092 975:198f764e734c Chris
2093
  record = parser.parse(line)
2094
2095
  # most annoyingly, the parser can't handle the comma-separated list
2096
  # in X-Forwarded-For where it has more than one element. If it has
2097 983:a97e573d7f87 Chris
  # failed, remove any IP addresses or the word "unknown" with
2098
  # trailing commas and try again
2099 975:198f764e734c Chris
  if not record
2100 983:a97e573d7f87 Chris
    filtered = line.gsub(/(unknown|([0-9]+\.){3}[0-9]+),\s*/, "")
2101 975:198f764e734c Chris
    record = parser.parse(filtered)
2102
  end
2103
2104
  # discard, but count, unparseable lines
2105
  if not record
2106 979:56a38a9f6204 Chris
    print "Line not parseable: ", line, "\n"
2107 975:198f764e734c Chris
    unparseable += 1
2108
    next
2109
  end
2110
2111
  # discard everything that isn't a 200 OK response
2112
  next if record["%>s"] != "200"
2113
2114
  # discard anything apparently requested by a crawler
2115
  next if record["%{User-Agent}i"] =~ /(bot|slurp|crawler|spider|Redmine)\b/i
2116
2117
  # pull out request e.g. GET / HTTP/1.0
2118
  request = record["%r"]
2119
2120
  # split into method, path, protocol
2121
  if not request =~ /^[^\s]+ ([^\s]+) [^\s]+$/
2122 979:56a38a9f6204 Chris
    print "Line not parseable (bad method, path, protocol): ", line, "\n"
2123 975:198f764e734c Chris
    unparseable += 1
2124
    next
2125
  end
2126
2127
  # get the path e.g. /projects/weevilmatic and split on /
2128
  path = $~[1]
2129
  components = path.split("/")
2130
2131
  # should have at least two elements unless path is "/"; first should
2132
  # be empty (begins with /)
2133
  if path != "/" and (components.size < 2 or components[0] != "")
2134 979:56a38a9f6204 Chris
    print "Line not parseable (degenerate path): ", line, "\n"
2135 975:198f764e734c Chris
    unparseable += 1
2136
    next
2137
  end
2138
2139
  if components[1] == "hg"
2140
2141
    # path is /hg/project?something or /hg/project/something
2142
2143
    project = components[2].split("?")[0]
2144 979:56a38a9f6204 Chris
    if not is_public_project?(project)
2145 978:bbb88c44f805 Chris
      next
2146
    end
2147 975:198f764e734c Chris
2148
    if components[2] =~ /&roots=00*$/
2149
      clones[project] += 1
2150
    elsif components[2] =~ /cmd=capabilities/
2151
      pulls[project] += 1
2152 978:bbb88c44f805 Chris
    elsif components[2] =~ /cmd=unbundle/
2153
      pushes[project] += 1
2154 975:198f764e734c Chris
    elsif components[3] == "archive"
2155
      zips[project] += 1
2156
    end
2157
2158
  elsif components[1] == "projects"
2159
2160
    # path is /projects/project or /projects/project/something
2161
2162
    project = components[2]
2163 979:56a38a9f6204 Chris
    project = project.split("?")[0] if project
2164
    if not is_public_project?(project)
2165 978:bbb88c44f805 Chris
      next
2166 975:198f764e734c Chris
    end
2167
2168 978:bbb88c44f805 Chris
    hits[project] += 1
2169
2170 975:198f764e734c Chris
  end
2171
2172
  parseable += 1
2173
end
2174
2175
# Each clone is also a pull; deduct it from the pulls hash, because we
2176
# want that to contain only non-clone pulls
2177
2178
clones.keys.each do |project|
2179
  pulls[project] -= 1
2180
end
2181
2182 982:6edb748be064 Chris
print parseable, " parseable\n"
2183
print unparseable, " unparseable\n"
2184
2185
2186 980:9b4919de5317 Chris
print "\nMercurial clones:\n"
2187
print_stats clones
2188
2189
print "\nMercurial pulls (excluding clones):\n"
2190
print_stats pulls
2191
2192
print "\nMercurial pushes:\n"
2193
print_stats pushes
2194
2195
print "\nMercurial archive (zip file) downloads:\n"
2196
print_stats zips
2197
2198 982:6edb748be064 Chris
print "\nProject page hits (excluding crawlers):\n"
2199 980:9b4919de5317 Chris
print_stats hits
2200 975:198f764e734c Chris
2201
2202 1536:e2a3230f61fa Chris
2203
# Print out an authormap file for hg-to-git conversion using
2204
# hg-fast-export
2205
#
2206
# Invoke with the project identifier as argument, e.g.
2207
#
2208
# ./script/rails runner -e production extra/soundsoftware/get-repo-authormap.rb soundsoftware-site
2209
2210 1537:e55cbb9ba8bf Chris
proj_ident = ARGV.last
2211 1536:e2a3230f61fa Chris
proj = Project.find_by_identifier(proj_ident)
2212
repo = Repository.where(:project_id => proj.id).first
2213
csets = Changeset.where(:repository_id => repo.id)
2214
committers = csets.map do |c| c.committer end.sort.uniq
2215
committers.each do |c|
2216 1537:e55cbb9ba8bf Chris
  if not c =~ /[^<]+<.*@.*>/ then
2217
    u = repo.find_committer_user c
2218
    print "#{c}=#{u.name} <#{u.mail}>\n" unless u.nil?
2219
  end
2220 1536:e2a3230f61fa Chris
end
2221 970:6bd8364eafae luis
2222 1453:b554eb79ec7b luis
# Log user and project information
2223
#
2224
# Invoke with e.g.
2225
#
2226
# ./script/rails runner -e production extra/soundsoftware/get-statistics.rb
2227 970:6bd8364eafae luis
#
2228
2229 1454:02a05da0bedc luis
projectStats =  {
2230
        :all => Project.active.all.count,
2231
        :private => Project.active.find(:all, :conditions => {:is_public => false}).count,
2232
        :top_level => Project.active.find(:all, :conditions => {:parent_id => nil}).count,
2233
        :top_level_and_private => Project.active.find(:all, :conditions => {:is_public => false, :parent_id => nil}).count
2234
      }
2235 970:6bd8364eafae luis
2236 1453:b554eb79ec7b luis
userStats = {:all => User.active.all.count}
2237 1002:f6ede18f3e6e Chris
2238 1453:b554eb79ec7b luis
stats = {:date => Date.today, :projects => projectStats, :users => userStats}.to_json
2239 1002:f6ede18f3e6e Chris
2240 1453:b554eb79ec7b luis
print "#{stats}\n"
2241 1002:f6ede18f3e6e Chris
2242 383:47ae83ce8db8 Chris
<div style="clear: both; float: right"><small><i>Produced by mtree2html by Hartmut Pohlheim</i></small></div>
2243
# configuration file for generation of html-docu from m-files
2244
#
2245
# Author:   Hartmut Pohlheim
2246
# History:  05.11.2000  file created (parameters for mtree2html2001)
2247
#
2248
# The following options/variables must be changed/adapted:
2249
#   dirmfiles
2250
#   dirhtml
2251
#   csslink
2252
#   texttitleframelayout
2253
#   texttitlefiles
2254
#
2255
# The following options/variables should be adapted:
2256
#   authorfile
2257
#   filenametopframe
2258
#   codeheadmeta
2259
2260
#========================================================================
2261
# Variables (possible keywords: set)
2262
# to use the built-in settings, comment the line using # in first column
2263
#========================================================================
2264
2265
#------------------------------------------------------------------------
2266
# dirmfiles: name of directory containing Matlab m-files
2267
# dirhtml: name of directory to place the html-files into
2268
# exthtml: extension used for the html files (.html or .htm)
2269
#          don't forget the point in front of the extension
2270
#------------------------------------------------------------------------
2271
set dirmfiles = .
2272
set dirhtml = doc-output
2273
set exthtml = .html
2274
2275
#------------------------------------------------------------------------
2276
# authorfile:   name of file containing info about author (in html)
2277
#               if defined, this text is included at the bottom of the
2278
#               html files
2279
#------------------------------------------------------------------------
2280 410:675de8e6becf chris
set authorfile = matlab-docs-credit.html
2281 383:47ae83ce8db8 Chris
2282
#------------------------------------------------------------------------
2283
# csslink:   text for linking to css file (style sheets)
2284
#            the text defined here is directly included into the head
2285
#            of the html file
2286
#------------------------------------------------------------------------
2287 410:675de8e6becf chris
#set csslink = <link rel=stylesheet type="text/css" href="CSSFILENAME.css" />
2288 383:47ae83ce8db8 Chris
2289
#------------------------------------------------------------------------
2290
# links2filescase: this is a bit difficult
2291
#                  Matlab is case sensitive on UNIX, but case insensitive
2292
#                  on Windows. Under UNIX Matlab function calls work
2293
#                  only, when the case of file name and function call are
2294
#                  identical, under Windows you can do what you want.
2295
#                  This scripts help you, to keep an exact case in your
2296
#                  project.
2297
#          exact - internal links are only generated, when case of file
2298
#                  name and in source code are identical
2299
#            all - case doesn't matter
2300
#     exactupper - same as exact, additionally links are also vreated to
2301
#                  all upper case function names in source code (often
2302
#                  used by Mathworks)
2303
#      exactvery - same as exact, additionally info about not matching
2304
#                  case is written to screen (stdout), this can be very
2305
#                  helpful in cleaning up the case in a project
2306
#------------------------------------------------------------------------
2307
set links2filescase = all
2308
2309
#------------------------------------------------------------------------
2310
# texttitleframelayout:    text of title for frame layout file (whole docu)
2311
#------------------------------------------------------------------------
2312 389:0bc92382a86b chris
set texttitleframelayout = MATLAB Function Documentation
2313 383:47ae83ce8db8 Chris
2314
#------------------------------------------------------------------------
2315
# texttitle/headerindexalldirs: text of title and header for directory index
2316
#------------------------------------------------------------------------
2317
set texttitleindexalldirs = Index of Directories
2318
set textheaderindexalldirs = Index of Directories
2319
2320
#------------------------------------------------------------------------
2321
# texttitle/headerindex:    text of title and header for index file
2322
#------------------------------------------------------------------------
2323
set texttitleindex = A-Z Index of Functions
2324
set textheaderindex = A-Z Index of Functions
2325
2326
#------------------------------------------------------------------------
2327
# texttitle/headerfiles:    text of title and header for files
2328
#                           name of file will be added at the end
2329
#------------------------------------------------------------------------
2330 389:0bc92382a86b chris
set texttitlefiles = Function
2331 383:47ae83ce8db8 Chris
set textheaderfiles = Documentation of
2332
2333
#------------------------------------------------------------------------
2334
# frames: whether to use frames in layout (yes or no)
2335
#------------------------------------------------------------------------
2336
set frames = no
2337
2338
#------------------------------------------------------------------------
2339
# filenametopframe: name of file including frame layout (highest level file)
2340
# [default: index]
2341
#------------------------------------------------------------------------
2342
set filenametopframe = index
2343
2344
#------------------------------------------------------------------------
2345
# textjumpindexglobal: text displayed for jump to index of all files
2346
#                      (global)
2347
# textjumpindexlocal:  text displayed for jump to index of files in actual
2348
#                      directory (local)
2349
#------------------------------------------------------------------------
2350 389:0bc92382a86b chris
set textjumpindexglobal = <b>Index of</b> all files:
2351
set textjumpindexlocal = this subdirectory only:
2352 383:47ae83ce8db8 Chris
2353
#------------------------------------------------------------------------
2354
# includesource: include source of m-files in documentation [YES|no]
2355
#------------------------------------------------------------------------
2356
set includesource = yes
2357
2358
#------------------------------------------------------------------------
2359
# usecontentsm: use contents.m files as well for structured
2360
#               (hopefully) index [YES|no]
2361
#------------------------------------------------------------------------
2362
set usecontentsm = no
2363
2364
#------------------------------------------------------------------------
2365
# includesource: write/update contents.m files [yes|NO]
2366
#------------------------------------------------------------------------
2367
set writecontentsm = no
2368
2369
#------------------------------------------------------------------------
2370
# processtree:  parse whole directory tree recursively [YES|no]
2371
#------------------------------------------------------------------------
2372
set processtree = yes
2373
2374
#------------------------------------------------------------------------
2375
# producetree:  produce tree for html-files in same structure than
2376
#		          tree of m-files [yes|NO]
2377
#               if no, all files are saved in the same directory, often
2378
#               easier for outside linking to files
2379
#------------------------------------------------------------------------
2380 401:a0f6e994657f chris
set producetree = yes
2381 383:47ae83ce8db8 Chris
2382
#------------------------------------------------------------------------
2383
# codebodyindex/files: HTML-code for adding to BODY tag
2384
#                      can be used for defining colors and
2385
#                      backgroundimages of the files
2386
#                      No longer recommended, use the css file
2387
#------------------------------------------------------------------------
2388
set codebodyindex =
2389
set codebodyfiles =
2390
2391
#------------------------------------------------------------------------
2392
# codeheadmeta: HTML-code added in HEAD area, use for supplying META info
2393
#------------------------------------------------------------------------
2394
set codeheadmeta =
2395
2396
#------------------------------------------------------------------------
2397
# codehr: HTML-code used to define a <HR>, do what you want
2398
#------------------------------------------------------------------------
2399 411:e7ba81c8dc5a chris
set codehr = <hr>
2400 383:47ae83ce8db8 Chris
2401
#------------------------------------------------------------------------
2402
# codeheader: HTML-code added to <H*> tags, use for centering header text
2403
#             or changing the colour/size/font of the header text
2404
#------------------------------------------------------------------------
2405 389:0bc92382a86b chris
set codeheader =
2406 383:47ae83ce8db8 Chris
2407
2408
# End of parameter file
2409 381:2dc8163e9150 Chris
@rem = '--*-Perl-*--';
2410
@rem = '
2411
@echo off
2412
perl -w -S %0.bat %1 %2 %3 %4 %5 %6 %7 %8 %9
2413
goto endofperl
2414
@rem ';
2415
# perl -w -S %0.bat "$@"
2416 382:baff1c482d98 Chris
#!/usr/bin/perl
2417 381:2dc8163e9150 Chris
#
2418
# mtree2html_2000 - produce html files from Matlab m-files.
2419
#                   use configuration file for flexibility
2420
#                   can process tree of directories
2421
#
2422
# Copyright (C) 1996-2000 Hartmut Pohlheim.  All rights reserved.
2423
# includes small parts of m2html from Jeffrey C. Kantor 1995
2424
#
2425
# Author:  Hartmut Pohlheim
2426
# History: 06.03.1996  file created
2427
#          07.03.1996  first working version
2428
#          08.03.1996  modularized, help text only once included
2429
#          11.03.1996  clean up, some functions rwritten
2430
#          18.04.1996  silent output with writing in one line only
2431
#                      version 0.20 fixed
2432
#          14.05.1996  start of adding tree structure, could create tree
2433
#          15.05.1996  creating of index files for every directory
2434
#          17.05.1996  first working version except compact A-Z index
2435
#          20.05.1996  cleanup of actual version, more variables and
2436
#                      configurable settings
2437
#          21.05.1996  reading, update and creation of contents.m added
2438
#          22.05.1996  creation of short index started
2439
#          28.05.1996  jump letters for short index,
2440
#                      3 different directory indexes (short/long/contents)
2441
#          29.05.1996  major cleanup, short and long index created from one function
2442
#                      links for HTML and Indexes from 1 function,
2443
#                      version 0.9
2444
#          30.05.1996  contents.m changed to Contents.m (because unix likes it)
2445
#                      function definition can be in first line of m file before comments
2446
#                      version 0.91 fixed
2447
#          03.06.1996  contents file can be written as wanted, the links will be correct
2448
#                      cross references in help block of m-file will be found and
2449
#                      converted, even if the name of the function is written upper case
2450
#                      version 0.92 fixed
2451
#          05.06.1996  construction of dependency matrix changed, is able now to process
2452
#                      even the whole matlab tree (previous version needed to much memory)
2453
#                      removed warning for contents files in different directories
2454
#                      version 0.94 fixed
2455
#          06.06.1996  new link name matrices for ConstructHTMLFile created,
2456
#                      everything is done in ConstructDependencyMatrix,
2457
#                      both dependencies (calls and called) and matrix
2458
#                      with all mentioned names in this m-file, thus, much
2459
#                      less scanning in html construction
2460
#                      script is now (nearly) linear scalable, thus, matlab-toolbox
2461
#                      tree takes less than 1 hour on a Pentium120, with source
2462
#                      version 0.96 fixed
2463
#          10.06.1996  order of creation changed, first all indexes (includes
2464
#                      update/creation of contents.m) and then ConstructDepency
2465
#                      thus, AutoAdd section will be linked as well
2466
#                      excludenames extended, some more common word function names added
2467
#                      version 0.97 fixed
2468
#          17.02.1998  writecontentsm as command line parameter added
2469
#                      error of file not found will even appear when silent
2470
#                      version 1.02
2471
#          21.05.2000  mark comments in source code specially (no fully correct,
2472
#                      can't handle % in strings)
2473
#                      version 1.11
2474
#          05.11.2000  link also to upper and mixed case m-files
2475
#                      searching for .m files now really works (doesn't find grep.com any longer)
2476
#                      file renamed to mtree2html2001
2477
#                      generated html code now all lower case
2478
#                      inclusion of meta-description and meta-keywords in html files
2479
#                      HTML4 compliance done (should be strict HTML4.0, quite near XHTML)
2480
#                      version 1.23
2481
#
2482 383:47ae83ce8db8 Chris
#	   29.03.2011  (Chris Cannam) add frames option.
2483 381:2dc8163e9150 Chris
2484
$VERSION  = '1.23';
2485
($PROGRAM = $0) =~ s@.*/@@; $PROGRAM = "\U$PROGRAM\E";
2486 411:e7ba81c8dc5a chris
$debug = 1;
2487 381:2dc8163e9150 Chris
2488
#------------------------------------------------------------------------
2489
# Define platform specific things
2490
#------------------------------------------------------------------------
2491
# suffix for files to search is defined twice
2492
# the first ($suffix) is for string creation and contains the . as well
2493
# the second ($suffixforsearch) is for regular expression, handling of . is quite special
2494
$suffix = ".m";
2495
$suffixforsearch = "m";
2496
# the directory separator
2497
$dirsep = "/";
2498
# what is the current directory
2499
$diract = ".";
2500
2501
#------------------------------------------------------------------------
2502 382:baff1c482d98 Chris
#  Define all variables and their standard settings
2503 381:2dc8163e9150 Chris
#  documentation of variables is contained in accompanying rc file
2504
#------------------------------------------------------------------------
2505
%var =
2506
(
2507
   'authorfile',                '',
2508
   'codebodyfiles',             '',
2509
   'codebodyindex',             '',
2510
   'codeheadmeta',              '<meta name="author of conversion perl script" content="Hartmut Pohlheim" />',
2511
   'codehr',                    '<hr size="3" noshade="noshade" />',
2512
   'codeheader',                '',
2513 383:47ae83ce8db8 Chris
   'configfile',                'matlab-docs.conf',
2514 381:2dc8163e9150 Chris
   'csslink',                   '',
2515
   'dirmfiles',                 $diract,
2516
   'dirhtml',                   $diract,
2517
   'exthtml',                   '.html',
2518 382:baff1c482d98 Chris
   'frames',                    'yes',
2519 381:2dc8163e9150 Chris
   'filenametopframe',          'index',
2520
   'filenameindexlongglobal',   'indexlg',
2521
   'filenameindexlonglocal',    'indexll',
2522
   'filenameindexshortglobal',  'indexsg',
2523
   'filenameindexshortlocal',   'indexsl',
2524
   'filenameextensionframe',    'f',
2525
   'filenameextensionindex',    'i',
2526
   'filenameextensionjump',     'j',
2527
   'filenamedirshort',          'dirtops',
2528
   'filenamedirlong',           'dirtopl',
2529
   'filenamedircontents',       'dirtopc',
2530
   'includesource',             'yes',
2531
   'links2filescase',           'all',
2532
   'processtree',               'yes',
2533
   'producetree',               'yes',
2534
   'textjumpindexlocal',        'Local Index',
2535
   'textjumpindexglobal',       'Global Index',
2536
   'texttitleframelayout',      'Documentation of Matlab Files',
2537
   'texttitleindexalldirs',     'Index of Directories',
2538
   'textheaderindexalldirs',    'Index of Directories',
2539
   'texttitleindex',            '',
2540
   'textheaderindex',           '',
2541
   'texttitlefiles',            'Documentation of ',
2542
   'textheaderfiles',           'Documentation of ',
2543
   'usecontentsm',              'yes',
2544
   'writecontentsm',            'no'
2545
);
2546
2547
2548
# define all m-file names, that should be excluded from linking
2549
# however, files will still be converted
2550
@excludenames = ( 'all','ans','any','are',
2551
                  'cs',
2552
                  'demo','dos',
2553
                  'echo','edit','else','elseif','end','exist',
2554
                  'flag','for','function',
2555
                  'global',
2556
                  'help',
2557
                  'i','if','inf','info',
2558
                  'j',
2559
                  'more',
2560
                  'null',
2561
                  'return',
2562
                  'script','strings',
2563
                  'what','which','while','who','whos','why',
2564
                );
2565
2566
# Text for inclusion in created HTML/Frame files: Doctype and Charset
2567
$TextDocTypeHTML  = '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN" "http://www.w3.org/TR/REC-html40/strict.dtd">';
2568
$TextDocTypeFrame = '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Frameset//EN" "http://www.w3.org/TR/REC-html40/frameset.dtd">';
2569
$TextMetaCharset = '<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />';
2570
2571
#------------------------------------------------------------------------
2572
# Read the command line arguments
2573
#------------------------------------------------------------------------
2574
if (@ARGV == 0) {
2575
   &DisplayHelp()  if &CheckFileName($var{'configfile'}, 'configuration file');
2576
}
2577
2578
# Print provided command line arguments on screen
2579
foreach (@ARGV) { print "   $_\n      "; }
2580
2581
# Get the options
2582
use Getopt::Long;
2583
@options = ('help|h', 'todo|t', 'version|v',
2584
            'authorfile|a=s', 'configfile|c=s', 'dirhtml|html|d=s',
2585
            'dirmfiles|mfiles|m=s', 'includesource|i=s',
2586
            'processtree|r=s', 'producetree|p=s',
2587
            'silent|quiet|q', 'writecontentsm|w=s');
2588
&GetOptions(@options) || die "use -h switch to display help statement\n";
2589
2590
2591
# Display help or todo list, when requested
2592
&DisplayHelp()                         if $opt_help;
2593
&DisplayTodo()                         if $opt_todo;
2594
die "$PROGRAM v$VERSION\n"             if $opt_version;
2595
2596
$exit_status = 0;
2597
2598
#------------------------------------------------------------------------
2599
# Read the config file
2600
#------------------------------------------------------------------------
2601
$var{'configfile'} = $opt_configfile         if $opt_configfile;
2602
&GetConfigFile($var{'configfile'});
2603
2604
2605
#------------------------------------------------------------------------
2606
# Process/Check the command line otions
2607
#------------------------------------------------------------------------
2608
$var{'dirhtml'}   = $opt_dirhtml              if $opt_dirhtml;
2609
if (!(substr($var{'dirhtml'}, -1, 1) eq $dirsep)) { $var{'dirhtml'} = $var{'dirhtml'}.$dirsep; }
2610
$var{'dirmfiles'} = $opt_dirmfiles            if $opt_dirmfiles;
2611
if (!(substr($var{'dirmfiles'}, -1, 1) eq $dirsep)) { $var{'dirmfiles'} = $var{'dirmfiles'}.$dirsep; }
2612
2613
$var{'authorfile'} = $opt_author              if $opt_author;
2614
$var{'includesource'} = $opt_includesource    if $opt_includesource;
2615
if ($var{'includesource'} ne 'no') { $var{'includesource'} = 'yes'; }
2616
$var{'processtree'} = $opt_processtree        if $opt_processtree;
2617
if ($var{'processtree'} ne 'no') { $var{'processtree'} = 'yes'; }
2618
$var{'producetree'} = $opt_producetree        if $opt_producetree;
2619
if ($var{'producetree'} ne 'no') { $var{'producetree'} = 'yes'; }
2620
if ($var{'processtree'} eq 'no') { $var{'producetree'} = 'no'; }
2621 382:baff1c482d98 Chris
if ($var{'frames'} ne 'no') { $var{'frames'} = 'yes'; }
2622 381:2dc8163e9150 Chris
# if (($var{'processtree'} eq 'yes') && ($var{'producetree'} eq 'no')) { $var{'usecontentsm'} = 'no'; }
2623
2624
$var{'writecontentsm'} = $opt_writecontentsm  if $opt_writecontentsm;
2625
2626
#------------------------------------------------------------------------
2627
# Do the real stuff
2628
#------------------------------------------------------------------------
2629
2630
# Print variables on screen, when not silent
2631
&ListVariables                          if !$opt_silent;
2632
2633
# Check the author file
2634
if ($var{'authorfile'} ne '') {
2635 410:675de8e6becf chris
    if (!($var{'authorfile'} =~ m,^/,)) {
2636
	# relative path: treat as relative to config file
2637
	my $cfd = $var{'configfile'};
2638
	$cfd =~ s,/[^/]*$,/,;
2639
	$cfd =~ s,^[^/]*$,.,;
2640
	$var{'authorfile'} = "$cfd/" . $var{'authorfile'};
2641
    }
2642
    if (&CheckFileName($var{'authorfile'}, 'author file')) {
2643
	$var{'authorfile'} = '';
2644
	if (!$opt_silent) { print "   Proceeding without author information!\n"; }
2645
    }
2646 381:2dc8163e9150 Chris
}
2647
2648
# Call the function doing all the real work
2649
&ConstructNameMatrix;
2650
2651
&ConstructDependencyMatrix;
2652
2653
&ConstructAllIndexFiles;
2654
2655
&ConstructHTMLFiles;
2656
2657
exit $exit_status;
2658
2659
#------------------------------------------------------------------------
2660
# Construct list of all mfile names and initialize various data arrays.
2661
#------------------------------------------------------------------------
2662
sub ConstructNameMatrix
2663
{
2664
   local(*MFILE);
2665
   local($file, $dirname);
2666
   local(@newdirectories);
2667
   local(%localnames);
2668
2669
   $RecDeep = 0;
2670
   &ParseTreeReadFiles($var{'dirmfiles'}, $RecDeep);
2671
2672
   foreach $dirname (@directories) {
2673
      if ($dirnumbermfiles{$dirname} > 0) {
2674
         push(@newdirectories, $dirname);
2675
         if (! defined($contentsname{$dirname})) {
2676
            $contentsname{$dirname} = 'Contents';
2677
            if (($var{'writecontentsm'} eq 'no') && ($var{'usecontentsm'} eq 'yes')) {
2678
               print "\r ParseTree - for directory  $dirname  no contents file found!\n";
2679
               print   "             create one or enable writing of contents file (writecontentsm = yes)!\n";
2680
            }
2681
         }
2682
      }
2683
   }
2684
   @alldirectories = @directories;
2685
   @directories = @newdirectories;
2686
2687
   foreach $dirname (@directories) {
2688
      if ($debug > 0) { print "Dir: $dirname \t\t $dirnumbermfiles{$dirname} \t$contentsname{$dirname}\n"; }
2689
   }
2690
2691
   @names = sort(keys %mfile);
2692
2693
   # check, if name of directory is identical to name of file
2694
   @dirsinglenames = values(%dirnamesingle);
2695
   grep($localnames{$_}++, @dirsinglenames);
2696
   @dirandfilename = grep($localnames{$_}, @names);
2697
   if (@dirandfilename) {
2698
      print "\r   Name clash between directory and file name: @dirandfilename\n";
2699
      print   "      These files will be excluded from linking!\n";
2700
      push(@excludenames, @dirandfilename);
2701
   }
2702
2703
   # construct names matrix for help text linking
2704
   #    exclude some common words (and at the same time m-functions) from linking in help text
2705
   grep($localnames{$_}++, @excludenames);
2706
   @linknames = grep(!$localnames{$_}, @names);
2707
2708
   if ($debug > 2) { print "linknames (names of found m-files):\n    @linknames\n"; }
2709
2710
}
2711
2712
#------------------------------------------------------------------------
2713
# Parse tree and collect all Files
2714
#------------------------------------------------------------------------
2715
sub ParseTreeReadFiles
2716
{
2717
   local($dirname, $localRecDeep) = @_;
2718
   local($file, $name, $filewosuffix);
2719
   local($dirhtmlname, $dirmode);
2720
   local($relpath, $relpathtoindex, $replacevardir);
2721
   local(*CHECKDIR, *AKTDIR);
2722
   local(@ALLEFILES);
2723
2724
   opendir(AKTDIR, $dirname) || die "ParseTree - Can't open directory $dirname: $!";
2725
   if ($debug > 1) { print "\nDirectory: $dirname\n"; }
2726
2727
   # create relative path
2728
   $_ = $dirname; $replacevardir = $var{'dirmfiles'};
2729
   s/$replacevardir//; $relpath = $_;
2730
   s/[^\/]+/../g; $relpathtoindex = $_;
2731
2732
   # producetree no
2733
   if ($var{'producetree'} eq 'no') { $relpath = ''; $relpathtoindex = ''; }
2734
2735
   # names of directories (top-level and below top-level m-file-directory)
2736
   push(@directories, $dirname);
2737
   $dirnumbermfiles{$dirname} = 0;    # set number of m-files for this dir to zero
2738
   # relative path from top-level directory, depends on directory name
2739
   $dirnamerelpath{$dirname} = $relpath;
2740
   # relative path from actual directory to top-level directory, depends on directory name
2741
   $dirnamerelpathtoindex{$dirname} = $relpathtoindex;
2742
   # recursion level for directory, depends on directory name
2743
   $dirnamerecdeep{$dirname} = $localRecDeep;
2744
2745
   # only the name of the directory, without path
2746
   $rindexprint = rindex($dirname, $dirsep, length($dirname)-2);
2747
   $rindsub = substr($dirname, $rindexprint+1, length($dirname)-$rindexprint-2);
2748
   $dirnamesingle{$dirname} = $rindsub;
2749
2750
   # create name of html-directories
2751
   $_ = $dirname;
2752
   s/$var{'dirmfiles'}/$var{'dirhtml'}/;
2753
   $dirhtmlname = $_;
2754
   if ($var{'producetree'} eq 'no') { $dirhtmlname = $var{'dirhtml'}; }
2755
   # try to open html directory, if error, then create directory,
2756
   # use same mode as for corresponding m-file directory
2757
   opendir(CHECKDIR,"$dirhtmlname") || do {
2758
      $dirmode = (stat($dirname))[2]; # print "$dirmode\n";
2759
      mkdir("$dirhtmlname", $dirmode) || die ("Cannot create directory $dirhtmlname: $! !");
2760
   };
2761
   closedir(CHECKDIR);
2762
2763
2764
   # read everything from this directory and process them
2765
   @ALLEFILES = readdir(AKTDIR);
2766
2767
   foreach $file (@ALLEFILES) {
2768
      # exclude . and .. directories
2769
      next if $file eq '.';  next if $file eq '..';
2770
2771
      # test for existense of entry (redundant, used for debugging)
2772
      if (-e $dirname.$file) {
2773
         # if it's a directory, call this function recursively
2774
         if (-d $dirname.$file) {
2775
            if ($var{'processtree'} eq 'yes') {
2776
               &ParseTreeReadFiles($dirname.$file.$dirsep, $localRecDeep+1);
2777
            }
2778
         }
2779
         # if it's a file - test for m-file, save name and create some arrays
2780
         elsif (-f $dirname.$file) {
2781
            if ($file =~ /\.$suffixforsearch$/i) {
2782
               # Remove the file suffix to establish the matlab identifiers
2783
               $filewosuffix = $file;
2784
               $filewosuffix =~ s/\.$suffixforsearch$//i;
2785
               # $filename = $name;
2786
2787
               # Contents file in unix must start with a capital letter (Contents.m)
2788
               # ensure, that m-file name is lower case, except the contents file
2789
               if (! ($filewosuffix =~ /^contents$/i)) {
2790 388:dad587ecb8d0 chris
		   # if ($var{'links2filescase'}  eq 'low') { $filewosuffix = "\L$filewosuffix\E"; }
2791 381:2dc8163e9150 Chris
                  $filewosuffixlow = "\L$filewosuffix\E";
2792
               }
2793
               else { $contentsname{$dirname} = $filewosuffix; }
2794
2795
               # internal handle name is always lower case
2796
               $name     = $filewosuffixlow;
2797
               # file name is not lower case
2798
               $filename = $filewosuffix;
2799
2800
               # if don't use C|contents.m, then forget all C|contents.m
2801
               if ($var{'usecontentsm'} eq 'no') { if ($name =~ /contents/i) { next; } }
2802
2803
               # if m-file with this name already exists, use directory and name for name
2804
               # only the first occurence of name will be used for links
2805
               if (defined $mfile{$name}) {
2806
                  if (! ($name =~ /^contents$/i) ) {
2807
                     print "\r ParseTree - Name conflict:  $name in $dirname already exists: $mfile{$name} !\n";
2808
                     print   "             $mfile{$name}  will be used for links!\n";
2809
                  }
2810
                  $name = $dirname.$name;
2811
               }
2812
               # mfile name with path
2813
               $mfile{$name} = $dirname.$file;
2814
               # mfile name (without path)
2815
               $mfilename{$name} = $filename;
2816
               # mfile directory
2817
               $mfiledir{$name} = $dirname;
2818
2819
               # html file name and full path, special extension of Contents files
2820
               if ($name =~ /contents/i) { $extrahtmlfilename = $dirnamesingle{$dirname}; }
2821
               else { $extrahtmlfilename = ''; }
2822
               $hfile{$name} = $dirhtmlname.$mfilename{$name}.$extrahtmlfilename.$var{'exthtml'};
2823
2824
               # save relative html path
2825
               # if ($var{'producetree'} eq 'yes') {
2826
               $hfilerelpath{$name} = $relpath;
2827
               # } else { # if no tree to produce, relative path is empty
2828
               #    $hfilerelpath{$name} = '';
2829
               # }
2830
2831
               # create relative path from html file to directory with global index file
2832
               $hfileindexpath{$name} = $relpathtoindex;
2833
2834
               # Function declaration, if one exists, set default to script
2835
               $synopsis{$name} = "";
2836
               $mtype{$name} = "script";
2837
2838
               # First comment line
2839
               $apropos{$name} = "";
2840
2841
               # count number of m-files in directories
2842
               $dirnumbermfiles{$dirname}++;
2843
2844
               if ($debug > 1) {
2845
                  if ($opt_silent) { print "\r"; }
2846
                  print "   ParseTree: $name \t\t $mfile{$name} \t\t $hfile{$name}\t\t";
2847
                  if (!$opt_silent) { print "\n"; }
2848
               }
2849
            }
2850
         }
2851
         else {
2852
            print "Unknown type of file in $dirname: $file\n";
2853
         }
2854
      }
2855
      else { print "Error: Not existing file in $dirname: $file\n"; }
2856
   }
2857
2858
   closedir(AKTDIR)
2859
2860
}
2861
2862
#------------------------------------------------------------------------
2863
# Construct Dependency matrix
2864
#    $dep{$x,$y} > 0 if $x includes a reference to $y.
2865
#------------------------------------------------------------------------
2866
sub ConstructDependencyMatrix
2867
{
2868
   &ConstructDependencyMatrixReadFiles('all');
2869
   &ConstructDependencyMatrixReally;
2870
}
2871
2872
2873
#------------------------------------------------------------------------
2874
# Construct Dependency matrix
2875
#    $dep{$x,$y} > 0 if $x includes a reference to $y.
2876
#------------------------------------------------------------------------
2877
sub ConstructDependencyMatrixReadFiles
2878
{
2879
   local($whatstring) = @_;
2880
   local(*MFILE);
2881
   local($name, $inames);
2882
   local(%symbolsdep, %symbolsall);
2883
2884
   # Initialize as all zeros.
2885
   # foreach $name (@names) { grep($dep{$name,$_}=0,@names); if ($debug > 0) { print "\r   DepMatrix anlegen: $name\t$#names\t"; } }
2886
2887
   # Compute the dependency matrix
2888
   $inames = -1;
2889
   foreach $name (@names) {
2890
      # Read each file and tabulate the distinct alphanumeric identifiers in
2891
      # an array of symbols. Also scan for:
2892
      #   synopsis: The function declaration line
2893
      #   apropos:  The first line of the help text
2894
2895
      # look for whatstring, if all: process every file, if contents: process only contents files
2896
      if ($whatstring eq 'contents') { if (! ($name =~ /contents$/i) ) { next; } }
2897
      elsif ($whatstring eq 'all') { }    # do nothing
2898
      else { print "\r   ConstructDependency: Unknown parameter whatstring: $whatstring \n"; }
2899
2900
      undef %symbolsall; undef %symbolsdep;
2901
      open(MFILE,"<$mfile{$name}") || die("Can't open $mfile{$name}: $!\n");
2902
      while (<MFILE>) {
2903
         chop;
2904
2905
         # Split on nonalphanumerics, then look for all words, used for links later
2906
         # this one for all references
2907
         @wordsall = grep(/[a-zA-Z]\w*/, split('\W',$_));
2908
         # set all words to lower case for link checking
2909
         undef @wordsall2;
2910
         # do case conversion not, case checking is done later
2911
         foreach (@wordsall) { push(@wordsall2, "\L$_\E"); }
2912
         # @wordsall2 = @wordsall;
2913
         grep($symbolsall{$_}++, @wordsall2);
2914
2915
         # Store first comment line, skip all others.
2916
         if (/^\s*%/) {
2917
            if (!$apropos{$name}) {
2918
               s/^\s*%\s*//;   # remove % and leading white spaces on line
2919
               $_ = &SubstituteHTMLEntities($_);
2920
               $apropos{$name} = $_;
2921
            }
2922
            next;
2923
         }
2924
2925
         # If it's the function declaration line, then store it and skip
2926
         # but only, when first function definition (multiple function lines when private subfunctions in file
2927
         if ($synopsis{$name} eq '') {
2928
            if (/^\s*function/) {
2929
               s/^\s*function\s*//;
2930
               $synopsis{$name} = $_;
2931
               $mtype{$name} = "function";
2932
               next;
2933
            }
2934
         }
2935
2936
         # Split off any trailing comments
2937
         if ($_ ne '') {
2938
            # this one for references in program code only
2939
            # when syntax parsing, here is a working place
2940
            ($statement) = split('%',$_,1);
2941
            @wordsdep = grep(/[a-zA-Z]\w*/,split('\W',$statement));
2942
            # do case conversion not, case checking is done later
2943
            undef @wordsdep2;
2944
            foreach (@wordsdep) { push(@wordsdep2, "\L$_\E"); }
2945
            grep($symbolsdep{$_}++, @wordsdep2);
2946
         }
2947
      }
2948
      close MFILE;
2949
2950
      # compute intersection between %symbolsall and @linknames
2951
      delete($symbolsall{$name});
2952
      # foreach $localsumall ($symbolsall) {
2953
      #    $localsumall = "\L$localsumall\E";
2954
      # }
2955
      @{'all'.$name} = grep($symbolsall{$_}, @linknames);
2956
2957
      # compute intersection between %symbolsdep and @linknames
2958
      delete($symbolsdep{$name});
2959
      @{'depcalls'.$name} = grep($symbolsdep{$_}, @linknames);
2960
2961
      $inames++; print "\r   DepCallsMatrix: $inames/$#names\t $name\t";
2962
      if ($debug > 2) { print "\n      depnames: @{'depcalls'.$name}\n      all: @{'all'.$name}\n"; }
2963
   }
2964
}
2965
2966
2967
#------------------------------------------------------------------------
2968
# Construct Dependency matrix
2969
#    $dep{$x,$y} > 0 if $x includes a reference to $y.
2970
#------------------------------------------------------------------------
2971
sub ConstructDependencyMatrixReally
2972
{
2973
   local($inames, $name);
2974
2975
   $inames = -1;
2976
   foreach $name (@names) { undef %{'depint'.$name}; }
2977
   foreach $name (@names) {
2978
      grep(${'depint'.$_}{$name}++, @{'depcalls'.$name});
2979
      $inames++; print "\r   DepCalledMatrix1: $inames/$#names\t $name\t";
2980
   }
2981
   $inames = -1;
2982
   foreach $name (@names) {
2983
      # compute intersection between %depint.name{$_} and @linknames
2984
      if (defined (%{'depint'.$name})) { @{'depcalled'.$name} = grep(${'depint'.$name}{$_}, @linknames); }
2985
      $inames++; print "\r   DepCalledMatrix2: $inames/$#names\t $name\t";
2986
      if ($debug > 2) { print "\n      depcalled: @{'depcalled'.$name}\n"; }
2987
   }
2988
2989
}
2990
2991
2992
#========================================================================
2993
# Construct all index files
2994
#========================================================================
2995
sub ConstructAllIndexFiles
2996
{
2997
   local(@localnames);
2998
   local($ActDir);
2999
   local($name);
3000
3001
   # define variables and names for frame target
3002
   $GlobalNameFrameMainLeft = 'Cont_Main';
3003
   $GlobalNameFrameMainRight = 'Cont_Lower';
3004
   $GlobalNameFrameAZIndexsmall = 'IndexAZindex';
3005
   $GlobalNameFrameAZIndexjump = 'IndexAZjump';
3006
3007
   $indexcreated = 0;
3008
3009
   &ConstructHighestIndexFile;
3010
   $indexcreated++;
3011
3012
   # if ($var{'producetree'} eq 'yes') {
3013
      # moved next 2 lines out of if for producetree no
3014
      # &ConstructHighestIndexFile;
3015
      # $indexcreated++;
3016
3017
      foreach $ActDir (@directories) {
3018
         undef @localnames;
3019
         foreach $name (@names) {
3020
            local($pathsubstr) = substr($mfile{$name}, 0, rindex($mfile{$name}, "/")+1);
3021
            if ($ActDir eq $pathsubstr) {
3022
               if ($debug > 1) { print "IndexFile: $pathsubstr    ActDir: $ActDir   Hfilerelpath: $hfilerelpath{$name}\n"; }
3023
               push(@localnames, $name);
3024
            }
3025
         }
3026
         if ($debug > 2) { print "localnames: @localnames\n"; }
3027
         # create contents file and short|long index of files in local directory
3028
         &ConstructContentsmFile($ActDir, @localnames);
3029
         &ConstructAZIndexFile($ActDir, 'short', 'local', @localnames);
3030
         &ConstructAZIndexFile($ActDir, 'long', 'local', @localnames);
3031
         $indexcreated+=2;
3032
      }
3033
   # } else {
3034
   #    &ConstructContentsmFile($var{'dirmfiles'}, @names);
3035
   # }
3036
3037
   # create short|long index of files in all directory
3038
   &ConstructAZIndexFile($var{'dirmfiles'}, 'short', 'global', @names);
3039
   &ConstructAZIndexFile($var{'dirmfiles'}, 'long', 'global', @names);
3040
   $indexcreated+=2;
3041
3042
   # if contents.m were created or updated, the dependency matrices should
3043
   # be updated as well
3044
   if ($var{'writecontentsm'} eq 'yes') { &ConstructDependencyMatrixReadFiles('contents');; }
3045
}
3046
3047
3048
#========================================================================
3049
# Construct the highest level index file
3050
#========================================================================
3051
sub ConstructHighestIndexFile
3052
{
3053
   local(*IFILE);
3054
   local($indexfile, $filename);
3055
3056
   # Build the frame layout file, this files includes the layout of the frames
3057
   # Build the frame layout file name (highest one)
3058
   $indexfile = $var{'dirhtml'}.$var{'filenametopframe'}.$var{'exthtml'};
3059
3060 382:baff1c482d98 Chris
   if ($var{'frames'} eq 'yes') {
3061 381:2dc8163e9150 Chris
3062 382:baff1c482d98 Chris
       open(IFILE,">$indexfile") || die("Cannot open frame layout file $indexfile\n");
3063 381:2dc8163e9150 Chris
3064 382:baff1c482d98 Chris
       # Write the header of frame file
3065
       print IFILE "$TextDocTypeFrame\n<html>\n<head>\n$var{'codeheadmeta'}\n$TextMetaCharset\n";
3066
       print IFILE "   <title>$var{'texttitleframelayout'}</title>\n";
3067
       print IFILE "</head>\n";
3068 381:2dc8163e9150 Chris
3069 382:baff1c482d98 Chris
       # definition of 2 frames, left the tree of directories,
3070
       # right the index of that directory or the docu of a file
3071
       print IFILE "<frameset  cols=\"25%,75%\">\n";
3072
       print IFILE "   <frame src=\"$var{'filenamedirshort'}$var{'exthtml'}\" name=\"$GlobalNameFrameMainLeft\" />\n";
3073
       print IFILE "   <frame src=\"$var{'filenameindexshortglobal'}$var{'filenameextensionframe'}$var{'exthtml'}\" name=\"$GlobalNameFrameMainRight\" />\n";   print IFILE "</frameset>\n";
3074 381:2dc8163e9150 Chris
3075 382:baff1c482d98 Chris
       print IFILE "</html>\n";
3076
3077
       close(IFILE);
3078
3079
       if ($opt_silent) { print "\r"; }
3080
       print "   Frame layout file created: $indexfile\t";
3081
       if (!$opt_silent) { print "\n"; }
3082
   }
3083 381:2dc8163e9150 Chris
3084
   for($irun=0; $irun <= 2; $irun++) {
3085
      # Build the top directory index file, these files include the directory tree
3086
      # Build the directory tree index file name
3087
3088
      # Create no directory file for contents, when no contents to use
3089
      if (($irun == 2) && ($var{'usecontentsm'} eq 'no')) { next; }
3090
3091
      # Assign the correct index file name
3092
      if ($irun == 0) { $filename = $var{'filenamedirshort'}; }
3093
      elsif ($irun == 1) { $filename = $var{'filenamedirlong'}; }
3094
      elsif ($irun == 2) { $filename = $var{'filenamedircontents'}; }
3095
3096
      $indexfile = $var{'dirhtml'}.$filename.$var{'exthtml'};
3097
3098
      open(IFILE,">$indexfile") || die("Cannot open directory tree index file $indexfile\n");
3099
      # Write header of HTML file
3100
      print IFILE "$TextDocTypeHTML\n<html>\n<head>\n$var{'codeheadmeta'}\n$TextMetaCharset\n$var{'csslink'}\n";
3101
3102
      if ($var{'texttitleindexalldirs'} eq '') {
3103
         print IFILE "<title>Index of Directories of $var{'dirmfiles'}</title>\n";
3104
      } else {
3105
         print IFILE "<title>$var{'texttitleindexalldirs'}</title>\n";
3106
      }
3107 382:baff1c482d98 Chris
3108
      if ($var{'frames'} eq 'yes') {
3109
	  print IFILE "<base target=\"$GlobalNameFrameMainRight\" />\n";
3110
      }
3111
3112 381:2dc8163e9150 Chris
      print IFILE "</head>\n";
3113
      print IFILE "<body $var{'codebodyindex'}>\n";
3114 410:675de8e6becf chris
      print IFILE "<div id=\"matlabdoc\">\n";
3115 381:2dc8163e9150 Chris
      if ($var{'textheaderindexalldirs'} eq '') {
3116
         print IFILE "<h1 $var{'codeheader'}>Index of Directories of <em>$var{'dirmfiles'}</em></h1>\n";
3117
      } else {
3118
         print IFILE "<h1 $var{'codeheader'}>$var{'textheaderindexalldirs'}</h1>\n";
3119
      }
3120 389:0bc92382a86b chris
      print IFILE "<p>\n";
3121 382:baff1c482d98 Chris
3122
      if ($var{'frames'} eq 'yes') {
3123
	  if ($irun == 0) { print IFILE "<strong>short</strong>\n"; }
3124
	  else { print IFILE "<a href=\"$var{'filenamedirshort'}$var{'exthtml'}\" target=\"$GlobalNameFrameMainLeft\">short</a>\n"; }
3125
	  if ($irun == 1) { print IFILE " | <strong>long</strong>\n"; }
3126
	  else { print IFILE " | <a href=\"$var{'filenamedirlong'}$var{'exthtml'}\" target=\"$GlobalNameFrameMainLeft\">long</a>\n"; }
3127
	  if ($var{'usecontentsm'} eq 'yes') {
3128
	      if ($irun == 2) { print IFILE " | <strong>contents</strong>\n"; }
3129
	      else { print IFILE " | <a href=\"$var{'filenamedircontents'}$var{'exthtml'}\" target=\"$GlobalNameFrameMainLeft\">contents</a>\n"; }
3130
	  }
3131
      } else {
3132
	  if ($irun == 0) { print IFILE "<strong>short</strong>\n"; }
3133
	  else { print IFILE "<a href=\"$var{'filenamedirshort'}$var{'exthtml'}\">short</a>\n"; }
3134
	  if ($irun == 1) { print IFILE " | <strong>long</strong>\n"; }
3135
	  else { print IFILE " | <a href=\"$var{'filenamedirlong'}$var{'exthtml'}\">long</a>\n"; }
3136
	  if ($var{'usecontentsm'} eq 'yes') {
3137
	      if ($irun == 2) { print IFILE " | <strong>contents</strong>\n"; }
3138
	      else { print IFILE " | <a href=\"$var{'filenamedircontents'}$var{'exthtml'}\">contents</a>\n"; }
3139
	  }
3140 381:2dc8163e9150 Chris
      }
3141
3142
      print IFILE "</p><br />\n\n";
3143
      print IFILE "<ul>\n";
3144
3145
      # go through all directories and create a list entry for each one,
3146
      # depending on recursion level create sublists
3147
      $prevrecdeeplevel = 0;
3148
      foreach $name (@alldirectories) {
3149
         $actrecdeeplevel = $dirnamerecdeep{$name};
3150
         for( ; $prevrecdeeplevel < $actrecdeeplevel; $prevrecdeeplevel++ ) { print IFILE "<ul>\n"; }
3151
         for( ; $prevrecdeeplevel > $actrecdeeplevel; $prevrecdeeplevel-- ) { print IFILE "</ul>\n"; }
3152
         if ($irun == 0) { $indexfilenameused = $var{'filenameindexshortlocal'}.$var{'filenameextensionframe'}; }
3153
         elsif ($irun == 1) { $indexfilenameused = $var{'filenameindexlonglocal'}.$var{'filenameextensionframe'}; }
3154
         elsif ($irun == 2) { $indexfilenameused = $contentsname{$name}; }
3155
         else { die "ConstructHighestIndexFile: Unknown value of irun"; }
3156
         if ($dirnumbermfiles{$name} > 0) {
3157
            # producetree no
3158
            # if ($var{'producetree'} eq 'no') { $dirnamehere = ''; }
3159
            # else { $dirnamehere = '$dirnamerelpath{$name}'; }
3160
            # print IFILE "<LI><A HREF=\"$dirnamehere$indexfilenameused_$dirnamesingle{$name}$var{'exthtml'}\">$dirnamesingle{$name}</A>\n";
3161
            print IFILE "<li><a href=\"$dirnamerelpath{$name}$indexfilenameused$dirnamesingle{$name}$var{'exthtml'}\">$dirnamesingle{$name}</a></li>\n";
3162
         } else {
3163
            # print directories with no m-files inside not
3164
            # print IFILE "<li>$dirnamesingle{$name}</li>\n";
3165
         }
3166
      }
3167
      $actrecdeeplevel = 0;
3168
      for( ; $prevrecdeeplevel > $actrecdeeplevel; $prevrecdeeplevel-- ) { print IFILE "</ul>\n"; }
3169
      print IFILE "</ul>\n<br />$var{'codehr'}\n";
3170
3171
      # Include info about author from authorfile
3172
      &WriteFile2Handle($var{'authorfile'}, IFILE);
3173
3174
      print IFILE "<!--navigate-->\n";
3175
      print IFILE "<!--copyright-->\n";
3176 410:675de8e6becf chris
      print IFILE "</div>\n</body>\n</html>\n";
3177 381:2dc8163e9150 Chris
3178
      close(IFILE);
3179
3180
      if ($opt_silent) { print "\r"; }
3181
      print "   Directory - Indexfile created: $indexfile\t";
3182
      if (!$opt_silent) { print "\n"; }
3183
   }
3184
}
3185
3186
3187
#========================================================================
3188
# Construct the A-Z index file (global/local and/or short/long)
3189
#========================================================================
3190
sub ConstructAZIndexFile
3191
{
3192
   local($LocalActDir, $LocalShortLong, $LocalGlobalLocal, @localnames) = @_;
3193
   local(*IFILE);
3194
   local($name, $indexfilename, $dirpath);
3195
   local($firstletter, $firstone);
3196
3197
   if ($debug > 2) { print "localnames in AZ small: @localnames\n"; print "     ActDir in A-Z: $LocalActDir\n"; }
3198
3199
   # extract filename of index file from parameters of function
3200
   if ($LocalShortLong eq 'short') {
3201
      if ($LocalGlobalLocal eq 'global') { $indexfilename = $var{'filenameindexshortglobal'}; }
3202
      elsif ($LocalGlobalLocal eq 'local') { $indexfilename = $var{'filenameindexshortlocal'}; }
3203
      else { die "wrong parameter for LocalGlobalLocal in ConstructAZIndexFile: $LocalGlobalLocal."; }
3204
   } elsif ($LocalShortLong eq 'long') {
3205
      if ($LocalGlobalLocal eq 'global') { $indexfilename = $var{'filenameindexlongglobal'}; }
3206
      elsif ($LocalGlobalLocal eq 'local') { $indexfilename = $var{'filenameindexlonglocal'}; }
3207
      else { die "wrong parameter for LocalGlobalLocal in ConstructAZIndexFile: $LocalGlobalLocal."; }
3208
   } else { die "wrong parameter for LocalShortLong in ConstructAZIndexFile: $LocalShortLong."; }
3209
3210
   # producetree no
3211
   # if ($var{'producetree'} eq 'no') { $dirnamehere = ''; }
3212
   # else { $dirnamehere = '$dirnamerelpath{$LocalActDir}'; }
3213
   # Build the index file name
3214
   # handle the global index file case separately (no extra directory name in file)
3215
   #    the local index file name must be extended by the name of the directory
3216
   if ($LocalGlobalLocal eq 'global') { $extradirfilename = ''; }
3217
   else { $extradirfilename = $dirnamesingle{$LocalActDir}; }
3218
   $indexfile = $var{'dirhtml'}.$dirnamerelpath{$LocalActDir}.$indexfilename.$var{'filenameextensionindex'}.$extradirfilename.$var{'exthtml'};
3219 382:baff1c482d98 Chris
3220 401:a0f6e994657f chris
   if ($LocalShortLong eq 'short' and $extradirfilename eq '' and $var{'frames'} ne 'yes') {
3221
       # With no frames and no subdir path, this must go in the
3222
       # top-level index file instead
3223 382:baff1c482d98 Chris
       $indexfile = $var{'dirhtml'}.$var{'filenametopframe'}.$var{'exthtml'};
3224
   }
3225
3226 381:2dc8163e9150 Chris
   if ($debug > 2) { print "   indexfilename (a-z small): $indexfile\n"; }
3227
3228
   open(IFILE,">$indexfile") || die("Cannot open index file $indexfile: $!\n");
3229
3230
   # Write the header of HTML file
3231
   print IFILE "$TextDocTypeHTML\n<html>\n<head>\n$var{'codeheadmeta'}\n$TextMetaCharset\n$var{'csslink'}\n";
3232
3233 410:675de8e6becf chris
   my $dirToPrint = $LocalActDir;
3234
   $dirToPrint =~ s,^./,,;
3235
3236 381:2dc8163e9150 Chris
   if ($var{'texttitleindex'} eq '') {
3237 410:675de8e6becf chris
      print IFILE "<title>Index of Matlab Files in Directory $dirToPrint</title>\n";
3238 381:2dc8163e9150 Chris
   } else {
3239
      if ($LocalGlobalLocal eq 'global') { print IFILE "<title>$var{'texttitleindex'}</title>\n"; }
3240 410:675de8e6becf chris
      else { print IFILE "<title>$var{'texttitleindex'} in Directory $dirToPrint</title>\n"; }
3241 381:2dc8163e9150 Chris
   }
3242 382:baff1c482d98 Chris
3243
   if ($var{'frames'} eq 'yes') {
3244
       print IFILE "<base target=\"$GlobalNameFrameMainRight\" />\n";
3245
   }
3246 381:2dc8163e9150 Chris
   print IFILE "</head>\n";
3247 382:baff1c482d98 Chris
3248 381:2dc8163e9150 Chris
   print IFILE "<body $var{'codebodyindex'}>\n";
3249 410:675de8e6becf chris
   print IFILE "<div id=\"matlabdoc\">\n";
3250 381:2dc8163e9150 Chris
   if ($var{'textheaderindex'} eq '') {
3251 410:675de8e6becf chris
      print IFILE "<h1 $var{'codeheader'}>Index of Matlab Files in Directory $dirToPrint</h1>\n";
3252 381:2dc8163e9150 Chris
   } else {
3253
      if ($LocalGlobalLocal eq 'global') { print IFILE "<h1 $var{'codeheader'}>$var{'textheaderindex'}</h1>\n"; }
3254 410:675de8e6becf chris
      else { print IFILE "<h1 $var{'codeheader'}>$var{'textheaderindex'} in Directory $dirToPrint</h1>\n"; }
3255 381:2dc8163e9150 Chris
   }
3256
3257
   # include links to indexes
3258
   &ConstructLinks2Index(IFILE, $dirnamerelpathtoindex{$LocalActDir}, $LocalActDir, $LocalGlobalLocal);
3259
3260
   # Collect the starting letters of m files in this directory or all m-files
3261
   for('a'..'z') { undef @{$_}; }
3262
   foreach $name (@localnames) {
3263
      if (! ($mfilename{$name} =~ /contents/i)) {
3264
         $firstletter = substr($mfilename{$name}, 0, 1);
3265
         # convert first letter always to lower case
3266
         # needed for reference to lower and upper case m-files
3267
         $firstletter = "\L$firstletter\E";
3268
         push(@{$firstletter}, $name);
3269
      }
3270
   }
3271
3272
   if ($LocalShortLong eq 'short') {
3273
      # begin create short index
3274
      print IFILE "<table width=\"100%\">\n";
3275
3276
      for('a'..'z') {
3277
         # print "   $_: @{$_}\n";
3278
         $numberofletter = $#{$_}+1;
3279 410:675de8e6becf chris
	 $cols = 3;
3280 381:2dc8163e9150 Chris
         if ($numberofletter > 0) {
3281 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";
3282
            for ($count = 0; $count < $numberofletter; $count++) {
3283
		if (($count % $cols) == 0) {
3284
		    if ($count > 0) {
3285
			print IFILE "</tr><tr>\n";
3286
		    }
3287
		    print IFILE "<tr><td></td>";
3288
		}
3289
		$name = @{$_}[$count];
3290
		if ($LocalGlobalLocal eq 'global') { $dirpath = $hfilerelpath{$name}; } else { $dirpath = ""; }
3291
		print IFILE "<td><a href=\"$dirpath$mfilename{$name}$var{'exthtml'}\">$mfilename{$name}</a></td>";
3292
	    }
3293
3294
	    print IFILE "</tr>\n";
3295
3296
            # $numberhalf = ($numberofletter + 1 - (($numberofletter+1) % 2))/2;
3297
            # if ($debug > 2) { print "   $_: @{$_} \t $numberhalf \t $numberofletter\n"; }
3298
            # for($count = 0; $count < $numberhalf; $count++) {
3299
            #    $name = @{$_}[$count];
3300
            #    if ($LocalGlobalLocal eq 'global') { $dirpath = $hfilerelpath{$name}; } else { $dirpath = ""; }
3301
            #    print IFILE "<tr><td width=\"50%\"><a href=\"$dirpath$mfilename{$name}$var{'exthtml'}\">$mfilename{$name}</a></td>";
3302
            #    if (($count + $numberhalf) < $numberofletter) {
3303
            #       $name = @{$_}[$count + $numberhalf];
3304
            #       if ($LocalGlobalLocal eq 'global') { $dirpath = $hfilerelpath{$name}; } else { $dirpath = ""; }
3305
            #       print IFILE "<td width=\"50%\"><a href=\"$dirpath$mfilename{$name}$var{'exthtml'}\">$mfilename{$name}</a></td></tr>\n";
3306
            #    } else {
3307
            #       print IFILE "<td width=\"50%\"></td></tr>\n";
3308
            #    }
3309
            # }
3310 381:2dc8163e9150 Chris
         }
3311
      }
3312
      print IFILE "</table>\n<br />$var{'codehr'}\n";
3313
3314
   } elsif ($LocalShortLong eq 'long') {
3315
      # begin create long index
3316 410:675de8e6becf chris
      print IFILE "<table width=\"100%\">\n";
3317 401:a0f6e994657f chris
      print IFILE "<tr><th>Name</th><th>Synopsis</th></tr>\n";
3318 381:2dc8163e9150 Chris
3319
      for('a'..'z') {
3320
         # print "   $_: @{$_}\n";
3321
         $numberofletter = $#{$_}+1;
3322
         if ($numberofletter > 0) {
3323
            $firstone = 1;
3324
            foreach $name (@{$_}) {
3325
               if ($debug > 1) { print "   AZinforeach1: $name \t\t $hfilerelpath{$name} \t\t $dirnamerelpath{$LocalActDir}\n"; }
3326
               if ($LocalGlobalLocal eq 'global') { $dirpath = $hfilerelpath{$name}; } else { $dirpath = ""; }
3327
               if (! ($mfilename{$name} =~ /contents/i)) {
3328 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; }
3329 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";
3330
               }
3331
            }
3332
         }
3333
      }
3334
      print IFILE "</table>\n<br />$var{'codehr'}\n";
3335
   } else { die "wrong parameter for LocalShortLong in ConstructAZIndexFile: $LocalShortLong."; }
3336
3337
   # Include info about author from authorfile
3338
   &WriteFile2Handle($var{'authorfile'}, IFILE);
3339
3340
   print IFILE "<!--navigate-->\n";
3341
   print IFILE "<!--copyright-->\n";
3342 410:675de8e6becf chris
   print IFILE "</div>\n</body>\n</html>\n";
3343 381:2dc8163e9150 Chris
3344
   close(IFILE);
3345
3346
   if ($opt_silent) { print "\r"; }
3347
   print "   Indexfile small (A-Z) created: $indexfile\t";
3348
   if (!$opt_silent) { print "\n"; }
3349
3350
3351
   # Build the A-Z jump index file name
3352
   # handle the global index file case separately (no extra directory name in file)
3353
   if ($LocalGlobalLocal eq 'global') { $extradirfilename = ''; }
3354
   else { $extradirfilename = $dirnamesingle{$LocalActDir}; }
3355
3356 382:baff1c482d98 Chris
   if ($var{'frames'} eq 'yes') {
3357
3358
       $indexfile = $var{'dirhtml'}.$dirnamerelpath{$LocalActDir}.$indexfilename.$var{'filenameextensionjump'}.$extradirfilename.$var{'exthtml'};
3359
       if ($debug > 2) { print "   indexfilename (a-z jump): $indexfile\n"; }
3360
       open(IFILE,">$indexfile") || die("Cannot open jump index file $indexfile: $!\n");
3361
3362
       # Write the header of HTML file
3363
       print IFILE "$TextDocTypeHTML\n<html>\n<head>\n$var{'codeheadmeta'}\n$TextMetaCharset\n$var{'csslink'}\n";
3364
3365
       if ($var{'texttitleindex'} eq '') {
3366 410:675de8e6becf chris
	   print IFILE "<title>A-Z jump index in directory $dirToPrint</title>\n";
3367 382:baff1c482d98 Chris
       } else {
3368
	   if ($LocalGlobalLocal eq 'global') { print IFILE "<title>$var{'texttitleindex'}</title>\n"; }
3369 410:675de8e6becf chris
	   else { print IFILE "<title>$var{'texttitleindex'} in Directory $dirToPrint</title>\n"; }
3370 382:baff1c482d98 Chris
       }
3371
3372
       if ($var{'frames'} eq 'yes') {
3373
	   print IFILE "<base target=\"$GlobalNameFrameAZIndexsmall\" />\n";
3374
       }
3375
       print IFILE "</head>\n";
3376
       print IFILE "<body $var{'codebodyindex'}>\n";
3377 410:675de8e6becf chris
       print IFILE "<div id=\"matlabdoc\">\n";
3378 382:baff1c482d98 Chris
3379
       # Write the A-Z jump line, generate link for letters with files starting with this letter
3380
       # and only letters for no files starting with this letter
3381
       # use previously generated arrays with names of files sorted by starting letter
3382
       for('a'..'z') {
3383
	   $numberofletter = $#{$_}+1;
3384
	   if ($numberofletter > 0) {
3385
	       print IFILE "<strong><a href=\"$indexfilename$var{'filenameextensionindex'}$extradirfilename$var{'exthtml'}#\U$_\E$_\">\U$_\E</a> </strong>\n";
3386
	   } else {
3387
	       print IFILE "\U$_\E \n";
3388
	   }
3389
       }
3390
3391 410:675de8e6becf chris
       print IFILE "</div></body>\n</html>\n";
3392 382:baff1c482d98 Chris
3393
       close(IFILE);
3394
3395
       if ($opt_silent) { print "\r"; }
3396
       print "   Indexfile small (A-Z jump) created: $indexfile\t";
3397
       if (!$opt_silent) { print "\n"; }
3398 381:2dc8163e9150 Chris
   }
3399
3400
3401
   # Build the frame layout file, this file includes the layout of the frames
3402
   # Build the frame layout file name (for small/compact A-Z index)
3403
   # handle the global index file case separately (no extra directory name in file)
3404
   if ($LocalGlobalLocal eq 'global') { $extradirfilename = ''; }
3405
   else { $extradirfilename = $dirnamesingle{$LocalActDir}; }
3406
3407 382:baff1c482d98 Chris
   if ($var{'frames'} eq 'yes') {
3408 381:2dc8163e9150 Chris
3409 382:baff1c482d98 Chris
       $indexfile = $var{'dirhtml'}.$dirnamerelpath{$LocalActDir}.$indexfilename.$var{'filenameextensionframe'}.$extradirfilename.$var{'exthtml'};
3410
       if ($debug > 2) { print "   indexfilename (a-z frame): $indexfile\n"; }
3411 381:2dc8163e9150 Chris
3412 382:baff1c482d98 Chris
       open(IFILE,">$indexfile") || die("Cannot open jump index frame file $indexfile: $!\n");
3413
3414
       # Write the header of Frame file
3415
       print IFILE "$TextDocTypeHTML\n<html>\n<head>\n$var{'codeheadmeta'}\n$TextMetaCharset\n$var{'csslink'}\n";
3416
3417
       if ($var{'texttitleindex'} eq '') {
3418 410:675de8e6becf chris
	   print IFILE "<title>Index of Matlab Files in Directory $dirToPrint</title>\n";
3419 382:baff1c482d98 Chris
       } else {
3420
	   if ($LocalGlobalLocal eq 'global') { print IFILE "<title>$var{'texttitleindex'}</title>\n"; }
3421 410:675de8e6becf chris
	   else { print IFILE "<title>$var{'texttitleindex'} in Directory $dirToPrint</title>\n"; }
3422 382:baff1c482d98 Chris
       }
3423
       print IFILE "</head>\n";
3424
3425
       # definition of 2 frames, top the A-Z index, below the jump letter line
3426
       print IFILE "<frameset  rows=\"90%,10%\">\n";
3427
       print IFILE "   <frame src=\"$indexfilename$var{'filenameextensionindex'}$extradirfilename$var{'exthtml'}\" name=\"$GlobalNameFrameAZIndexsmall\" />\n";
3428
       print IFILE "   <frame src=\"$indexfilename$var{'filenameextensionjump'}$extradirfilename$var{'exthtml'}\" name=\"$GlobalNameFrameAZIndexjump\" />\n";
3429
       print IFILE "</frameset>\n";
3430
3431
       print IFILE "</html>\n";
3432
3433
       close(IFILE);
3434
3435
       if ($opt_silent) { print "\r"; }
3436
       print "   Frame layout file created: $indexfile\t";
3437
       if (!$opt_silent) { print "\n"; }
3438 381:2dc8163e9150 Chris
   }
3439
}
3440 382:baff1c482d98 Chris
3441 381:2dc8163e9150 Chris
3442
#========================================================================
3443
# Construct the links to all indexes
3444
#========================================================================
3445
sub ConstructLinks2Index
3446
{
3447
   local(*WRITEFILE, $LocalPath2Index, $PathContents, $LocalGlobalLocal) = @_;
3448
3449
   # include links to short/long - local/global index and C|contents.m
3450 389:0bc92382a86b chris
   print WRITEFILE "\n<p>";
3451
   print WRITEFILE "$var{'textjumpindexglobal'} ";
3452 382:baff1c482d98 Chris
3453
   if ($var{'frames'} eq 'yes') {
3454
       print WRITEFILE "<a href=\"$LocalPath2Index$var{'filenameindexshortglobal'}$var{'filenameextensionframe'}$var{'exthtml'}\">short</a> | ";
3455 389:0bc92382a86b chris
       print WRITEFILE "<a href=\"$LocalPath2Index$var{'filenameindexlongglobal'}$var{'filenameextensionframe'}$var{'exthtml'}\">long</a>\n";
3456 382:baff1c482d98 Chris
   } else {
3457 387:f89765996ef9 Chris
       print WRITEFILE "<a href=\"$LocalPath2Index$var{'filenametopframe'}$var{'exthtml'}\">short</a> | ";
3458 389:0bc92382a86b chris
       print WRITEFILE "<a href=\"$LocalPath2Index$var{'filenameindexlongglobal'}$var{'filenameextensionindex'}$var{'exthtml'}\">long</a>\n";
3459 382:baff1c482d98 Chris
   }
3460
3461 381:2dc8163e9150 Chris
   if ($LocalGlobalLocal eq 'local') {
3462
      if ($var{'usecontentsm'} eq 'yes') {
3463
         print WRITEFILE " | <a href=\"$contentsname{$PathContents}$dirnamesingle{$PathContents}$var{'exthtml'}\">Local contents</a>\n";
3464
      }
3465 389:0bc92382a86b chris
      if ($var{'frames'} eq 'yes') {
3466
         print WRITEFILE " | $var{'textjumpindexlocal'} ";
3467 382:baff1c482d98 Chris
         print WRITEFILE "<a href=\"$var{'filenameindexshortlocal'}$var{'filenameextensionframe'}$dirnamesingle{$PathContents}$var{'exthtml'}\">short</a> | ";
3468 389:0bc92382a86b chris
         print WRITEFILE "<a href=\"$var{'filenameindexlonglocal'}$var{'filenameextensionframe'}$dirnamesingle{$PathContents}$var{'exthtml'}\">long</a>\n";
3469
      } else {
3470
         print WRITEFILE " | $var{'textjumpindexlocal'} ";
3471
         print WRITEFILE "<a href=\"$var{'filenameindexshortlocal'}$var{'filenameextensionindex'}$dirnamesingle{$PathContents}$var{'exthtml'}\">short</a> | ";
3472
         print WRITEFILE "<a href=\"$var{'filenameindexlonglocal'}$var{'filenameextensionindex'}$dirnamesingle{$PathContents}$var{'exthtml'}\">long</a>\n";
3473
      }
3474 381:2dc8163e9150 Chris
   }
3475
   print WRITEFILE "</p>\n\n";
3476
   print WRITEFILE "$var{'codehr'}\n";
3477
}
3478
3479
3480
#========================================================================
3481
# Construct the contents.m files or update
3482
#========================================================================
3483
sub ConstructContentsmFile
3484
{
3485
   local($LocalActDir, @localnames) = @_;
3486
   local(*CFILE, $name,$newline);
3487
   local($contentsfile, $isincontentsonly);
3488
   local(@lines, @autoaddlines, @emptylines);
3489
   local($autoadd) = 'AutoAdd';
3490
   local($autoaddsection) = 0;
3491
   local($emptylineflag) = 0;
3492
   local(%nameincontents);
3493
3494
   # Build the contents file name
3495
   $contentsfile = $LocalActDir.$contentsname{$LocalActDir}.$suffix;
3496
3497
   if (-e $contentsfile) {
3498
      open(CFILE,"<$contentsfile") || die("Cannot open contents file $contentsfile: $!\n");
3499
      while (<CFILE>) {
3500
         # Search for the specified string pattern
3501
         @words = split;
3502
         if ((@words >= 3) && ($words[2] eq '-')) {
3503
            $isincontentsonly = 0;
3504
            foreach $name (@localnames) {
3505
               if ($name eq $words[1]) {    # old
3506
               # if ($mfilename{$name} eq $words[1]) {
3507
                  $isincontentsonly = 1;
3508
                  $nameincontents{$name} = 1;
3509
                  $newline = sprintf("%% %-13s - %s\n", $mfilename{$name}, $apropos{$name});
3510
                  push(@lines, $newline);
3511
               }
3512
            }
3513
            # issue a warning, if file is in contents, but not as file in the directory
3514
            if ($isincontentsonly == 0) {
3515
               print "\rConstructContents: Obsolete entry  $words[1]  in  $contentsfile ! Entry not used.\n";
3516
            }
3517
         } else {
3518
            # look for the AutoAdd section, should be the second word
3519
            if ((@words >= 2) && ($words[1] eq $autoadd)) { $autoaddsection = 1; }
3520
            # push the red line in an array
3521
            push(@lines, $_);
3522
         }
3523
      }
3524
      close(CFILE);
3525
   } else {
3526
      $newline = "% MATLAB Files in directory  $LocalActDir\n%\n";
3527
      push(@lines, $newline);
3528
3529
   }
3530
3531
   # collect the file names, that were not included in original C|contents.m
3532
   foreach $name (@localnames) {
3533
      if (! defined $nameincontents{$name}) {
3534
         if (! ($mfilename{$name} =~ /contents/i)) {
3535
            $newline = sprintf("%% %-13s - %s\n", $mfilename{$name}, $apropos{$name});
3536
            push(@autoaddlines, $newline);
3537
         }
3538
      }
3539
   }
3540
3541
   # write/update C|contents.m only if variable is set
3542
   if ($var{'writecontentsm'} eq 'yes') {
3543
      unlink($contentsfile);
3544
      open(CFILE,">$contentsfile") || die("Cannot open contents file $contentsfile: $!\n");
3545
      # write old C|contents.m or header of new file, as long as comment lines
3546
      foreach $line (@lines) {
3547
         if ($emptylineflag == 0) {
3548
            if ($line =~ /^\s*%/) { print CFILE $line; }
3549
            else { $emptylineflag = 1; push(@emptylines, $line); }
3550
         } else { push(@emptylines, $line); }
3551
      }
3552
      # add header of AutoAdd section
3553
      if (($autoaddsection == 0) && (@autoaddlines > 0)) { print CFILE "%\n% $autoadd\n"; }
3554
      # add autoadd section lines (previously undocumented files
3555
      foreach $line (@autoaddlines) { print CFILE $line; }
3556
      # add tail of original C|contents.m (everything behind first non-comment line)
3557
      foreach $line (@emptylines)   { print CFILE $line; }
3558
      print CFILE "\n";
3559
      close CFILE;
3560
      if ($opt_silent) { print "\r"; }
3561
      print "   Contents file created/updated: $contentsfile\t";
3562
      if (!$opt_silent) { print "\n"; }
3563
   }
3564
}
3565
3566
3567
#========================================================================
3568
# Replace found special characters with their HTMl Entities
3569
#========================================================================
3570
sub SubstituteHTMLEntities {
3571
   local($_) = @_;
3572
3573
   # Replace & <-> &amp;  < <-> &lt;  > <-> &gt;  " <-> &quot;
3574
   s/&/&amp;/g; s/\</&lt;/g; s/\>/&gt;/g; s/\"/&quot;/g;
3575
   return $_;
3576
}
3577
3578
#========================================================================
3579
# Replace found m-filenamestring with full link.
3580
#========================================================================
3581
sub SubstituteName2Link {
3582
   local($_, $funname) = @_;
3583
   local($refstr1, $refstr2, $reffound);
3584
3585
   # Look for something matching in the line
3586
   if ( /(\W+)($funname)(\W+)/i ) {
3587
      $reffound = $2;
3588 388:dad587ecb8d0 chris
      $refstr1 = "<a class=\"mfun\" href=\"$hfileindexpath{$name}$hfilerelpath{$funname}$mfilename{$funname}$var{'exthtml'}\">";
3589 381:2dc8163e9150 Chris
      $refstr2 = "<\/a>";
3590
      # Do links only for exact case match
3591
      if ( ($var{'links2filescase'}  eq 'exact') || ($var{'links2filescase'}  eq 'exactvery') ) {
3592
         if ( /(\W+)($funname)(\W+)/g ) {
3593
            s/(\W+)($funname)(\W+)/$1$refstr1$funname$refstr2$3/g;
3594
         }
3595
         else {
3596
            # Print info for not matching case in references, good for check up of files
3597
            if ( ($var{'links2filescase'}  eq 'exactvery') ) {
3598
               print "Diff in case found: $funname  (case of file name)   <->  $reffound  (case in source code)\n";
3599
               print "     (source line)  $_ \n";
3600
            }
3601
         }
3602
      }
3603
      # Do links for exact match and additionally for all upper case (often used in original matlab help text)
3604
      elsif ( ($var{'links2filescase'}  eq 'exactupper') ) {
3605
         s/(\W+)($funname)(\W+)/$1$refstr1$2$refstr2$3/g;
3606
         $funname2 = "\U$funname\E";
3607
         s/(\W+)($funname2)(\W+)/$1$refstr1$2$refstr2$3/g;
3608
      }
3609
      # Do links for all case mixes, this calls for trouble under LINUX/UNIX
3610
      else {  #elsif ( ($var{'links2filescase'}  eq 'all') )
3611
         s/(\W+)($funname)(\W+)/$1$refstr1$2$refstr2$3/ig;
3612
      }
3613
   }
3614
3615
   return $_;
3616
}
3617
3618
#========================================================================
3619
# Construct the html files for each matlab file.
3620
#    Need to reread each matlab file to find the help text.
3621
#    Note that we can't do this in a single loop because sometimes
3622
#    the help text maybe before the function declaration.
3623
#========================================================================
3624
sub ConstructHTMLFiles
3625
{
3626
   local(*MFILE);
3627
   local(*HFILE);
3628
3629
   local($filescreated) = 0;
3630
   local($functionline);
3631
3632
   foreach $name (@names) {
3633
      # Create cross reference information already here, used for keywords as well
3634
      # Construct list of referenced functions
3635
      @xref = @{'depcalls'.$name};    # the functions, that this m-file calls
3636
      @yref = @{'depcalled'.$name};   # the functions, that this m-file is called from
3637
      # print "   depcalls: @{'depcalls'.$name}\n   depcalled: @{'depcalled'.$name}\n";
3638
      # foreach $cname (@names) { next if $cname eq $name; push(@yref,$cname) if grep(/$name/,@{'depcalls'.$cname}); }
3639
3640
3641
      # Open m-file and html-file
3642
      open(MFILE,"<$mfile{$name}");
3643
      open(HFILE,">$hfile{$name}");
3644
3645
      # Write the header of HTML file
3646
      print HFILE "$TextDocTypeHTML\n<html>\n<head>\n$var{'codeheadmeta'}\n$TextMetaCharset\n$var{'csslink'}\n";
3647
3648
      # Write meta tags: use apropos (one line function description) for description
3649
      # and cross reference function names for keywords (any better ideas?)
3650
      print HFILE "<meta name=\"description\" content=\" $apropos{$name} \" />\n";
3651
      print HFILE "<meta name=\"keywords\" content=\" @xref @yref \" />\n";
3652
3653
      # Write Title and start body of html-file
3654
      print HFILE "<title>$var{'texttitlefiles'} $mfilename{$name}</title>\n</head>\n";
3655
      print HFILE "<body $var{'codebodyfiles'}>\n";
3656 410:675de8e6becf chris
      print HFILE "<div id=\"matlabdoc\">\n";
3657 381:2dc8163e9150 Chris
      print HFILE "<h1 $var{'codeheader'}>$var{'textheaderfiles'} $mfilename{$name}</h1>\n";
3658 401:a0f6e994657f chris
3659
# http://test.soundsoftware.ac.uk/cannam/projects/smallbox/repository/annotate/DL/RLS-DLA/SolveFISTA.m
3660 410:675de8e6becf chris
#      print HFILE "<a href=\"" . $hfileindexpath{$name} . "../../projects/smallbox/repository/annotate/" . $mfiledir{$name}  . $mfilename{$name} . ".m\">View in repository</a>\n";
3661 401:a0f6e994657f chris
3662 381:2dc8163e9150 Chris
      print HFILE "$var{'codehr'}\n";
3663
3664
      # include links to short/long - local/global index and C|contents.m
3665
      &ConstructLinks2Index(HFILE, $hfileindexpath{$name}, $mfiledir{$name}, 'local');
3666
3667
      # If this is a function, then write out the first line as a synopsis
3668
      if ($mtype{$name} eq "function") {
3669
         print HFILE "<h2 $var{'codeheader'}>Function Synopsis</h2>\n";
3670
         print HFILE "<pre>$synopsis{$name}</pre>\n$var{'codehr'}\n";
3671
      }
3672
3673
      # Look for the matlab help text block
3674
      $functionline = "\n";
3675
      do {
3676
         $_ = <MFILE>;
3677
         # remember functionline, if before help text block
3678
         if (/^\s*function/) { $functionline = $_; }
3679
      } until (/^\s*%/ || eof);
3680
      if (! (eof(MFILE))) {
3681
         print HFILE "<h2 $var{'codeheader'}>Help text</h2>\n";
3682
         print HFILE "<pre>\n";
3683
         while (/^\s*%/) {
3684
            # First remove leading % and white space, then Substitute special characlers
3685
            s/^\s*%//;
3686
            $_ = &SubstituteHTMLEntities($_);
3687
3688
            # check/create cross references
3689
            foreach $funname (@{'all'.$name}) {
3690
               if ($funname =~ /simulink/) { print "\n Simulink - Filename: $name;  scanname: $funname\n"; }
3691
               next if $funname eq $name;
3692
               $_ = &SubstituteName2Link($_, $funname);
3693
            }
3694
            print HFILE $_;
3695
            if (! eof) { $_ = <MFILE>; }
3696
         }
3697
         print HFILE "</pre>\n$var{'codehr'}\n";
3698
      }
3699
3700
      # Write the cross reference information
3701
      if (@xref || @yref) {
3702
         print HFILE "<h2 $var{'codeheader'}>Cross-Reference Information</H2>\n";
3703
         print HFILE "<table border=\"0\" width=\"100%\">\n<tr align=\"left\">\n<th width=\"50%\">";
3704
         if (@xref) {
3705
            print HFILE "This $mtype{$name} calls";
3706
         }
3707
         print HFILE "</th>\n<th width=\"50%\">";
3708
         if (@yref) {
3709
            print HFILE "This $mtype{$name} is called by";
3710
         }
3711
         print HFILE "</th>\n</tr>\n<tr valign=\"top\"><td>";
3712
         if (@xref) {
3713
            print HFILE "\n<ul>\n";
3714
            foreach $cname (sort @xref) {
3715
               print HFILE "<li><a class=\"mfun\" href=\"$hfileindexpath{$name}$hfilerelpath{$cname}$mfilename{$cname}$var{'exthtml'}\">$mfilename{$cname}</a></li>\n";
3716
            }
3717
            print HFILE "</ul>\n";
3718
         }
3719
         print HFILE "</td><td>";
3720
         if (@yref) {
3721
            print HFILE "\n<ul>\n";
3722
            foreach $cname (sort @yref) {
3723
               print HFILE "<li><a class=\"mfun\" href=\"$hfileindexpath{$name}$hfilerelpath{$cname}$mfilename{$cname}$var{'exthtml'}\">$mfilename{$cname}</a></li>\n";
3724
            }
3725
            print HFILE "</ul>\n";
3726
         }
3727
         print HFILE "</td>\n</tr>\n</table>\n";
3728
         print HFILE "$var{'codehr'}\n";
3729
      }
3730
3731
      # Include source text if requested
3732
      if (($var{'includesource'} eq 'yes') && (! ($mfilename{$name} =~ /^contents$/i))) {
3733
         print HFILE "<h2 $var{'codeheader'}>Listing of $mtype{$name} $mfilename{$name}</h2>\n";
3734
         seek(MFILE,0,0);
3735
         print HFILE "<pre>\n";
3736
         $IsStillHelp = 2;
3737
         print HFILE $functionline;    # functionline from scanning of help
3738
         while (<MFILE>) {
3739
            if ($IsStillHelp == 2) {
3740
               next     if (/^\s*$/);
3741
               next     if (/^\s*function/);
3742
               if (/^\s*%/) { $IsStillHelp = 1; next; }
3743
            } elsif ($IsStillHelp == 1) {
3744
               next     if (/^\s*%/);
3745
               $IsStillHelp = 0;
3746
            }
3747
3748
            # Substritute special characters
3749
            $_ = &SubstituteHTMLEntities($_);
3750
3751
            # check for comment in line and format with css em
3752 400:4ad6499d7998 chris
            s/^(.*)%(.*?)([\s\r\n]+)$/$1<em class=\"mcom\">%$2<\/em>$3/;
3753 381:2dc8163e9150 Chris
3754
            # check/create cross references
3755
            foreach $funname (@{'all'.$name}) {
3756
               next if $funname eq $name;
3757
               $_ = &SubstituteName2Link($_, $funname);
3758
            }
3759
            print HFILE $_;
3760
         }
3761
         print HFILE "</pre>\n$var{'codehr'}\n";
3762
      }
3763
3764
      # Include info about author from authorfile
3765
      &WriteFile2Handle($var{'authorfile'}, HFILE)   ;
3766
3767
      print HFILE "<!--navigate-->\n";
3768
      print HFILE "<!--copyright-->\n";
3769 410:675de8e6becf chris
      print HFILE "</div>\n</body>\n</html>\n";
3770 381:2dc8163e9150 Chris
      close(MFILE);
3771
      close(HFILE);
3772
3773
      # Print name of finished file
3774
      if ($opt_silent) { print "\r"; }
3775
      print "   HTML-File created: $hfile{$name}\t";
3776
      if (!$opt_silent) { print "\n"; }
3777
      $filescreated++;
3778
   }
3779
3780
   print "\n$PROGRAM: $indexcreated index and $filescreated files created.\n";
3781
}
3782
3783
#========================================================================
3784
# Function:	CheckFileName
3785
# Purpose:	.
3786
#========================================================================
3787
sub CheckFileName {
3788
   local($filename, $description) = @_;
3789
   local(*CHECKFILE);
3790
3791
   open(CHECKFILE,"<$filename") || do {
3792
      if ($description eq '') {$description = 'file';}
3793
      # if (!$opt_silent) { print "Cannot open $description $filename: $!\n"; }
3794
      print "Cannot open $description $filename: $!\n";
3795
      return 1;
3796
   };
3797
   close(CHECKFILE);
3798
   return 0;
3799
3800
}
3801
3802
#========================================================================
3803
# Function:	CheckDirName
3804
# Purpose:	.
3805
#========================================================================
3806
sub CheckDirName {
3807
   local($dirname, $description) = @_;
3808
   local(*CHECKDIR);
3809
3810
   opendir(CHECKDIR,"$dirname") || die ("Cannot open $description directory $dirname: $!\n");
3811
   closedir(CHECKDIR);
3812
}
3813
3814
#========================================================================
3815
# Function:	WriteFile2Handle
3816
# Purpose:	.
3817
#========================================================================
3818
sub WriteFile2Handle {
3819
   local($filename, *WRITEFILE) = @_;
3820
   local(*READFILE);
3821
3822
   if ($filename ne '') {
3823
      open(READFILE,"<$filename");
3824
      @filecontents = <READFILE>;
3825
      close(READFILE);
3826
      print WRITEFILE "@filecontents\n";
3827
      # if (!$opt_silent) {print "      Contents of $filename added\n"};
3828
   }
3829
}
3830
3831
3832
#========================================================================
3833
# Function:	GetConfigFile
3834
# Purpose:	Read user's configuration file, if such exists.
3835
#========================================================================
3836
sub GetConfigFile
3837
{
3838
   local($filename) = @_;
3839
   local(*CONFIG);
3840
   local($value);
3841
3842
   if (&CheckFileName($filename, 'configuration file')) {
3843
      # if (!$opt_silent) { print "   Proceeding using built-in defaults for configuration.\n"; }
3844
      print "   Proceeding using built-in defaults for configuration.\n";
3845
      return 0;
3846
   };
3847
3848
   open(CONFIG,"< $filename");
3849
   while (<CONFIG>) {
3850
      s/#.*$//;
3851
      next if /^\s*$/o;
3852
3853
      # match keyword: process one or more arguments
3854
      # keyword set
3855
      if (/^\s*set\s+(\S+)\s*=\s*(.*)/) {
3856
         # setting a configuration variable
3857
         if (defined $var{$1}) {
3858
            $var{$1} = $2;
3859
            if ($debug > 3) { print "$1:   $var{$1}\n"; }
3860
         }
3861
         else {
3862
            print "$PROGRAM: unknown variable `$1' in configuration file\n"
3863
         }
3864
      } else {
3865
         chop($_);
3866
         print "$PROGRAM: unknown keyword in configuration file in line: `$_'\n"
3867
      }
3868
   }
3869
   close CONFIG;
3870
   1;
3871
}
3872
3873
3874
#------------------------------------------------------------------------
3875
# DisplayHelp - display help text using -h or -help command-line switch
3876
#------------------------------------------------------------------------
3877
sub DisplayHelp
3878
{
3879
   $help=<<EofHelp;
3880
   $PROGRAM v$VERSION - generate html documentation from Matlab m-files
3881
3882
   Usage: $PROGRAM [-h] [-c config_file] [-m|dirmfiles matlab_dir] [-d|dirhtml html_dir]
3883
                   [-i yes|no] [-r yes|no] [-p yes|no] [-quiet|q] [-a authorfile]
3884
3885
   $PROGRAM is a perl script that reads each matlab .m file in a directory
3886
   to produce a corresponding .html file of help documentation and cross
3887
   reference information. An index file is written with links to all of
3888
   the html files produced. The options are:
3889
3890
      -quiet         or -q : be silent, no status information during generation
3891
      -help          or -h : display this help message
3892
      -todo          or -t : print the todo list for $PROGRAM
3893
      -version       or -v : display version
3894
3895
      -configfile    or -c : name of configuration file (default to $var{'configfile'}).
3896
      -dirmfiles     or -m : top level directory containing matlab files to generate html for;
3897
                             default to actual directory.
3898
      -dirhtml       or -d : top level directory for generated html files;
3899
                             default to actual directory.
3900
3901
      -includesource or -i : Include matlab source in the html documentation [yes|no]
3902
                             default to yes.
3903
      -processtree   or -r : create docu for m-file directory and all subdirectories [yes|no];
3904
                             default to yes.
3905
      -producetree   or -p : create multi-level docu identical to directory structure
3906
                             of m-files [yes|no]; default to yes.
3907
      -writecontentsm or -w: update or write contents.m files into the matlab source
3908
                             directories [yes|no]; default to no.
3909
3910
      -authorfile    or -a : name of file including author information, last element in html;
3911
                             default to empty.
3912
3913
   The command line setting overwrite all other settings (built-in and configuration file).
3914
   The configuration file settings overwrite the built-in settings (and not the command
3915
   line settings).
3916
3917
   Typical usages are:
3918
     $PROGRAM
3919
        (use default parameters from perl script, if configuration
3920
         file is found -> generation of docu, else display of help)
3921
3922
     $PROGRAM -dirmfiles matlab -dirhtml html
3923
        (generate html documentation for all m-files in directory matlab,
3924
         place html files in directory html, use built-in defaults for
3925
         all other parameters, this way all m-files in the directory
3926
         matlab and below are converted and the generated html-files are
3927
         placed in the directory html and below producing the same
3928
         directory structure than below matlab)
3929
3930
     $PROGRAM -quiet
3931
        (use built-in parameters from perl script, if configuration
3932
         file is found use these settings as well, do generation,
3933
         no display except critical errors, status of conversion and result)
3934
3935
     $PROGRAM -m toolbox -dirhtml doc/html -r yes -p no
3936
        (convert all m-files in directory toolbox and below and place
3937
         the generated html files in directory doc/html, read all m-files
3938
         recursively, however, the generated html files are placed in one
3939
         directory)
3940
3941
     $PROGRAM -m toolbox -dirhtml doc/html -i no -r no
3942
        (convert all m-files in directory toolbox and place
3943
         the generated html files in directory doc/html, do not read m-files
3944
         recursively, do not include source code in documentation)
3945
3946
EofHelp
3947
3948
   die "$help";
3949
}
3950
3951
#------------------------------------------------------------------------
3952
# DisplayTodo - display ToDo list using -t or -todo command-line switch
3953
#------------------------------------------------------------------------
3954
sub DisplayTodo
3955
{
3956
   $todo=<<EofToDo;
3957
      $PROGRAM v$VERSION - ToDo list
3958
3959
       o	use more than one high level directory
3960
3961
       o	what should/could be done here???
3962
3963
EofToDo
3964
3965
   die "$todo";
3966
}
3967
3968
3969
#------------------------------------------------------------------------
3970
# ListVariables - list all defined variables and their values
3971
#------------------------------------------------------------------------
3972
sub ListVariables
3973
{
3974
   local($value);
3975
3976
   if ($debug > 0) {
3977
      print "List of all variables and their values\n";
3978
      foreach (sort keys %var)
3979
      {
3980
         if ($var{$_} eq '') {
3981
            $value = "empty";
3982
         } else {
3983
            $value = $var{$_};
3984
         }
3985
         print "   $_\n      $value\n";
3986
      }
3987
      print "\n\n";
3988
   }
3989
}
3990
3991
3992
__END__
3993
:endofperl
3994 0:513646585e45 Chris
#!/usr/bin/env ruby
3995
3996
# == Synopsis
3997
#
3998
# reposman: manages your repositories with Redmine
3999
#
4000
# == Usage
4001
#
4002
#    reposman [OPTIONS...] -s [DIR] -r [HOST]
4003 441:cbce1fd3b1b7 Chris
#
4004 0:513646585e45 Chris
#  Examples:
4005 241:7658d21a1493 chris
#    reposman --scm-dir=/var/svn --redmine-host=redmine.example.net --scm subversion
4006 0:513646585e45 Chris
#    reposman -s /var/git -r redmine.example.net -u http://svn.example.net --scm git
4007
#
4008
# == Arguments (mandatory)
4009
#
4010 241:7658d21a1493 chris
#   -s, --scm-dir=DIR         use DIR as base directory for repositories
4011 0:513646585e45 Chris
#   -r, --redmine-host=HOST   assume Redmine is hosted on HOST. Examples:
4012
#                             -r redmine.example.net
4013
#                             -r http://redmine.example.net
4014
#                             -r https://example.net/redmine
4015 909:cbb26bc654de Chris
#   -k, --key=KEY             use KEY as the Redmine API key (you can use the
4016
#                             --key-file option as an alternative)
4017 0:513646585e45 Chris
#
4018
# == Options
4019
#
4020
#   -o, --owner=OWNER         owner of the repository. using the rails login
4021
#                             allow user to browse the repository within
4022
#                             Redmine even for private project. If you want to
4023
#                             share repositories through Redmine.pm, you need
4024
#                             to use the apache owner.
4025
#   -g, --group=GROUP         group of the repository. (default: root)
4026
#   --scm=SCM                 the kind of SCM repository you want to create (and
4027
#                             register) in Redmine (default: Subversion).
4028
#                             reposman is able to create Git and Subversion
4029
#                             repositories. For all other kind, you must specify
4030
#                             a --command option
4031
#   -u, --url=URL             the base url Redmine will use to access your
4032
#                             repositories. This option is used to automatically
4033
#                             register the repositories in Redmine. The project
4034
#                             identifier will be appended to this url. Examples:
4035
#                             -u https://example.net/svn
4036
#                             -u file:///var/svn/
4037 28:12420e46bed9 chris
#                             if this option isn't set, reposman will register
4038
#                             the repositories with local file paths in Redmine
4039 0:513646585e45 Chris
#   -c, --command=COMMAND     use this command instead of "svnadmin create" to
4040
#                             create a repository. This option can be used to
4041
#                             create repositories other than subversion and git
4042
#                             kind.
4043
#                             This command override the default creation for git
4044
#                             and subversion.
4045 13:80433603a2cd Chris
#   --http-user=USER          User for HTTP Basic authentication with Redmine WS
4046
#   --http-pass=PASSWORD      Password for Basic authentication with Redmine WS
4047 909:cbb26bc654de Chris
#       --key-file=PATH       path to a file that contains the Redmine API key
4048
#                             (use this option instead of --key if you don't
4049
#                             the key to appear in the command line)
4050 0:513646585e45 Chris
#   -t, --test                only show what should be done
4051
#   -h, --help                show help and exit
4052
#   -v, --verbose             verbose
4053
#   -V, --version             print version and exit
4054
#   -q, --quiet               no log
4055
#
4056
# == References
4057 441:cbce1fd3b1b7 Chris
#
4058 0:513646585e45 Chris
# You can find more information on the redmine's wiki : http://www.redmine.org/wiki/redmine/HowTos
4059
4060
4061
require 'getoptlong'
4062 1332:1d1cb01c0417 Chris
#require 'rdoc/usage'
4063 0:513646585e45 Chris
require 'find'
4064
require 'etc'
4065
4066
Version = "1.3"
4067
SUPPORTED_SCM = %w( Subversion Darcs Mercurial Bazaar Git Filesystem )
4068
4069
opts = GetoptLong.new(
4070 241:7658d21a1493 chris
                      ['--scm-dir',      '-s', GetoptLong::REQUIRED_ARGUMENT],
4071 0:513646585e45 Chris
                      ['--redmine-host', '-r', GetoptLong::REQUIRED_ARGUMENT],
4072
                      ['--key',          '-k', GetoptLong::REQUIRED_ARGUMENT],
4073 909:cbb26bc654de Chris
                      ['--key-file',           GetoptLong::REQUIRED_ARGUMENT],
4074 0:513646585e45 Chris
                      ['--owner',        '-o', GetoptLong::REQUIRED_ARGUMENT],
4075
                      ['--group',        '-g', GetoptLong::REQUIRED_ARGUMENT],
4076
                      ['--url',          '-u', GetoptLong::REQUIRED_ARGUMENT],
4077
                      ['--command' ,     '-c', GetoptLong::REQUIRED_ARGUMENT],
4078
                      ['--scm',                GetoptLong::REQUIRED_ARGUMENT],
4079 13:80433603a2cd Chris
                      ['--http-user',          GetoptLong::REQUIRED_ARGUMENT],
4080
                      ['--http-pass',          GetoptLong::REQUIRED_ARGUMENT],
4081 0:513646585e45 Chris
                      ['--test',         '-t', GetoptLong::NO_ARGUMENT],
4082
                      ['--verbose',      '-v', GetoptLong::NO_ARGUMENT],
4083
                      ['--version',      '-V', GetoptLong::NO_ARGUMENT],
4084
                      ['--help'   ,      '-h', GetoptLong::NO_ARGUMENT],
4085
                      ['--quiet'  ,      '-q', GetoptLong::NO_ARGUMENT]
4086
                      )
4087
4088
$verbose      = 0
4089
$quiet        = false
4090
$redmine_host = ''
4091
$repos_base   = ''
4092 13:80433603a2cd Chris
$http_user    = ''
4093
$http_pass    = ''
4094 0:513646585e45 Chris
$svn_owner    = 'root'
4095
$svn_group    = 'root'
4096
$use_groupid  = true
4097
$svn_url      = false
4098
$test         = false
4099
$scm          = 'Subversion'
4100
4101
def log(text, options={})
4102
  level = options[:level] || 0
4103
  puts text unless $quiet or level > $verbose
4104
  exit 1 if options[:exit]
4105
end
4106
4107
def system_or_raise(command)
4108
  raise "\"#{command}\" failed" unless system command
4109
end
4110
4111 1332:1d1cb01c0417 Chris
def usage
4112
  puts "See source code for supported options"
4113
  exit
4114
end
4115
4116 0:513646585e45 Chris
module SCM
4117
4118
  module Subversion
4119
    def self.create(path)
4120
      system_or_raise "svnadmin create #{path}"
4121
    end
4122
  end
4123
4124
  module Git
4125
    def self.create(path)
4126
      Dir.mkdir path
4127
      Dir.chdir(path) do
4128
        system_or_raise "git --bare init --shared"
4129
        system_or_raise "git update-server-info"
4130
      end
4131
    end
4132
  end
4133
4134
end
4135
4136
begin
4137
  opts.each do |opt, arg|
4138
    case opt
4139 241:7658d21a1493 chris
    when '--scm-dir';        $repos_base   = arg.dup
4140 0:513646585e45 Chris
    when '--redmine-host';   $redmine_host = arg.dup
4141
    when '--key';            $api_key      = arg.dup
4142 909:cbb26bc654de Chris
    when '--key-file'
4143
      begin
4144
        $api_key = File.read(arg).strip
4145
      rescue Exception => e
4146
        $stderr.puts "Unable to read the key from #{arg}: #{e.message}"
4147
        exit 1
4148
      end
4149 0:513646585e45 Chris
    when '--owner';          $svn_owner    = arg.dup; $use_groupid = false;
4150
    when '--group';          $svn_group    = arg.dup; $use_groupid = false;
4151
    when '--url';            $svn_url      = arg.dup
4152
    when '--scm';            $scm          = arg.dup.capitalize; log("Invalid SCM: #{$scm}", :exit => true) unless SUPPORTED_SCM.include?($scm)
4153 13:80433603a2cd Chris
    when '--http-user';      $http_user    = arg.dup
4154
    when '--http-pass';      $http_pass    = arg.dup
4155 0:513646585e45 Chris
    when '--command';        $command =      arg.dup
4156
    when '--verbose';        $verbose += 1
4157
    when '--test';           $test = true
4158
    when '--version';        puts Version; exit
4159 1332:1d1cb01c0417 Chris
    when '--help';           usage
4160 0:513646585e45 Chris
    when '--quiet';          $quiet = true
4161
    end
4162
  end
4163
rescue
4164
  exit 1
4165
end
4166
4167
if $test
4168
  log("running in test mode")
4169
end
4170
4171
# Make sure command is overridden if SCM vendor is not handled internally (for the moment Subversion and Git)
4172
if $command.nil?
4173
  begin
4174
    scm_module = SCM.const_get($scm)
4175
  rescue
4176
    log("Please use --command option to specify how to create a #{$scm} repository.", :exit => true)
4177
  end
4178
end
4179
4180
$svn_url += "/" if $svn_url and not $svn_url.match(/\/$/)
4181
4182
if ($redmine_host.empty? or $repos_base.empty?)
4183 1332:1d1cb01c0417 Chris
  usage
4184 0:513646585e45 Chris
end
4185
4186
unless File.directory?($repos_base)
4187 217:ed8222a04634 chris
  log("directory '#{$repos_base}' doesn't exist", :exit => true)
4188 0:513646585e45 Chris
end
4189
4190
begin
4191
  require 'active_resource'
4192
rescue LoadError
4193
  log("This script requires activeresource.\nRun 'gem install activeresource' to install it.", :exit => true)
4194
end
4195
4196 37:94944d00e43c chris
class Project < ActiveResource::Base
4197 217:ed8222a04634 chris
  self.headers["User-agent"] = "SoundSoftware repository manager/#{Version}"
4198 909:cbb26bc654de Chris
  self.format = :xml
4199 37:94944d00e43c chris
end
4200 0:513646585e45 Chris
4201
log("querying Redmine for projects...", :level => 1);
4202
4203
$redmine_host.gsub!(/^/, "http://") unless $redmine_host.match("^https?://")
4204
$redmine_host.gsub!(/\/$/, '')
4205
4206
Project.site = "#{$redmine_host}/sys";
4207 13:80433603a2cd Chris
Project.user = $http_user;
4208
Project.password = $http_pass;
4209 0:513646585e45 Chris
4210
begin
4211
  # Get all active projects that have the Repository module enabled
4212
  projects = Project.find(:all, :params => {:key => $api_key})
4213 909:cbb26bc654de Chris
rescue ActiveResource::ForbiddenAccess
4214
  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.")
4215 0:513646585e45 Chris
rescue => e
4216
  log("Unable to connect to #{Project.site}: #{e}", :exit => true)
4217
end
4218
4219
if projects.nil?
4220 909:cbb26bc654de Chris
  log('No project found, perhaps you forgot to "Enable WS for repository management"', :exit => true)
4221 0:513646585e45 Chris
end
4222
4223 1107:4f45ab104990 Chris
log("found #{projects.size} projects at " + Time.now.inspect);
4224 0:513646585e45 Chris
4225
def set_owner_and_rights(project, repos_path, &block)
4226 441:cbce1fd3b1b7 Chris
  if mswin?
4227 0:513646585e45 Chris
    yield if block_given?
4228
  else
4229
    uid, gid = Etc.getpwnam($svn_owner).uid, ($use_groupid ? Etc.getgrnam(project.identifier).gid : Etc.getgrnam($svn_group).gid)
4230 34:09b1d4349da3 Chris
    right = project.is_public ? 02775 : 02770
4231 0:513646585e45 Chris
    yield if block_given?
4232
    Find.find(repos_path) do |f|
4233
      File.chmod right, f
4234
      File.chown uid, gid, f
4235
    end
4236
  end
4237
end
4238
4239
def other_read_right?(file)
4240
  (File.stat(file).mode & 0007).zero? ? false : true
4241
end
4242
4243
def owner_name(file)
4244
  mswin? ?
4245
    $svn_owner :
4246 441:cbce1fd3b1b7 Chris
    Etc.getpwuid( File.stat(file).uid ).name
4247 0:513646585e45 Chris
end
4248 441:cbce1fd3b1b7 Chris
4249 0:513646585e45 Chris
def mswin?
4250
  (RUBY_PLATFORM =~ /(:?mswin|mingw)/) || (RUBY_PLATFORM == 'java' && (ENV['OS'] || ENV['os']) =~ /windows/i)
4251
end
4252
4253
projects.each do |project|
4254 1107:4f45ab104990 Chris
  log("inspecting project #{project.name}", :level => 1)
4255 0:513646585e45 Chris
4256
  if project.identifier.empty?
4257 1107:4f45ab104990 Chris
    log("\tno identifier for project #{project.name}!")
4258 0:513646585e45 Chris
    next
4259 1445:0c7b3bb73517 Chris
  elsif not project.identifier.match(/^[a-z0-9_\-]+$/)
4260 1107:4f45ab104990 Chris
    log("\tinvalid identifier for project #{project.name} : #{project.identifier}!");
4261 0:513646585e45 Chris
    next;
4262
  end
4263
4264
  repos_path = File.join($repos_base, project.identifier).gsub(File::SEPARATOR, File::ALT_SEPARATOR || File::SEPARATOR)
4265
4266 28:12420e46bed9 chris
  create_repos = false
4267
  # Logic required for SoundSoftware.ac.uk repositories:
4268
  #
4269
  # * If the project has a repository path declared already,
4270
  #   - if it's a local path,
4271
  #     - if it does not exist
4272
  #       - if it has the right root
4273
  #         - create it
4274
  #   - else
4275
  #     - leave alone (remote repository)
4276
  # * else
4277
  #   - create repository with same name as project
4278
  #   - set to project
4279
4280
  if project.respond_to?(:repository)
4281
4282
    repos_url = project.repository.url;
4283 1107:4f45ab104990 Chris
    log("\texisting url for project #{project.identifier} is #{repos_url}", :level => 2);
4284 28:12420e46bed9 chris
4285
    if repos_url.match(/^file:\//) || repos_url.match(/^\//)
4286
4287
      repos_url = repos_url.gsub(/^file:\/*/, "/");
4288 1107:4f45ab104990 Chris
      log("\tthis is a local file path, at #{repos_url}", :level => 2);
4289 28:12420e46bed9 chris
4290
      if repos_url.slice(0, $repos_base.length) != $repos_base
4291
        # leave repos_path set to our original suggestion
4292 1107:4f45ab104990 Chris
        log("\tpreparing to replace incorrect repo location #{repos_url} for #{project.name} with #{repos_path}");
4293 28:12420e46bed9 chris
        create_repos = true
4294
      else
4295
        if !File.directory?(repos_url)
4296 1107:4f45ab104990 Chris
          log("\tpreparing to create repo for #{project.name} at #{repos_url}");
4297 28:12420e46bed9 chris
          repos_path = repos_url
4298
          create_repos = true
4299
        else
4300 1107:4f45ab104990 Chris
          log("\tit exists and is in the right place", :level => 2);
4301 28:12420e46bed9 chris
        end
4302
      end
4303
    else
4304 1107:4f45ab104990 Chris
      log("\tthis is a remote path, leaving alone", :level => 2);
4305 28:12420e46bed9 chris
    end
4306
  else
4307 1107:4f45ab104990 Chris
    log("\tpreparing to set repo location and create for #{project.name} at #{repos_url}")
4308 28:12420e46bed9 chris
#    if File.directory?(repos_path)
4309
#      log("\trepository path #{repos_path} already exists, not creating")
4310
#    else
4311
      create_repos = true
4312
#    end
4313
  end
4314
4315
  if create_repos
4316
4317
    registration_url = repos_path
4318
    if $svn_url
4319
      registration_url = "#{$svn_url}#{project.identifier}"
4320
    end
4321 0:513646585e45 Chris
4322
    if $test
4323 28:12420e46bed9 chris
      log("\tproposal: create repository #{repos_path}")
4324
      log("\tproposal: register repository #{repos_path} in Redmine with vendor #{$scm}, url #{registration_url}")
4325 0:513646585e45 Chris
      next
4326
    end
4327
4328 52:8c3409528d3a Chris
# No -- we need "other" users to be able to read it.  Access control
4329
# is not handled through Unix user id anyway
4330
#    project.is_public ? File.umask(0002) : File.umask(0007)
4331
    File.umask(0002)
4332
4333 28:12420e46bed9 chris
    log("\taction: create repository #{repos_path}")
4334 0:513646585e45 Chris
4335
    begin
4336 28:12420e46bed9 chris
      if !File.directory?(repos_path)
4337
        set_owner_and_rights(project, repos_path) do
4338
          if scm_module.nil?
4339
            log("\trunning command: #{$command} #{repos_path}")
4340
            system_or_raise "#{$command} #{repos_path}"
4341
          else
4342
            scm_module.create(repos_path)
4343
          end
4344 0:513646585e45 Chris
        end
4345
      end
4346
    rescue => e
4347
      log("\tunable to create #{repos_path} : #{e}\n")
4348
      next
4349
    end
4350
4351 28:12420e46bed9 chris
    begin
4352
      log("\taction: register repository #{repos_path} in Redmine with vendor #{$scm}, url #{registration_url}");
4353
      project.post(:repository, :vendor => $scm, :repository => {:url => "#{registration_url}"}, :key => $api_key)
4354
    rescue => e
4355
      log("\trepository #{repos_path} not registered in Redmine: #{e.message}");
4356 0:513646585e45 Chris
    end
4357
    log("\trepository #{repos_path} created");
4358
  end
4359 37:94944d00e43c chris
end
4360 0:513646585e45 Chris
4361 1107:4f45ab104990 Chris
log("project review completed at " + Time.now.inspect);
4362
4363 241:7658d21a1493 chris
#!/bin/sh
4364
4365 242:bde4f47b6427 chris
mirrordir="/var/mirror"
4366 1336:b61a51fb42b9 Chris
hg="/usr/bin/hg"
4367 242:bde4f47b6427 chris
4368 241:7658d21a1493 chris
project="$1"
4369
local_repo="$2"
4370
remote_repo="$3"
4371
4372
if [ -z "$project" ] || [ -z "$local_repo" ] || [ -z "$remote_repo" ]; then
4373
    echo "Usage: $0 <project> <local-repo-path> <remote-repo-url>"
4374
    exit 2
4375
fi
4376
4377
  # We need to handle different source repository types separately.
4378
  #
4379
  # The convert extension cannot convert directly from a remote git
4380
  # repo; we'd have to mirror to a local repo first.  Incremental
4381
  # conversions do work though.  The hg-git plugin will convert
4382
  # directly from remote repositories, but not via all schemes
4383
  # (e.g. https is not currently supported).  It's probably easier to
4384
  # use git itself to clone locally and then convert or hg-git from
4385
  # there.
4386
  #
4387
  # We can of course convert directly from remote Subversion repos,
4388
  # but we need to keep track of that -- you can ask to convert into a
4389
  # repo that has already been used (for Mercurial) and it'll do so
4390
  # happily; we don't want that.
4391
  #
4392
  # Converting from a remote Hg repo should be fine!
4393
  #
4394
  # One other thing -- we can't actually tell the difference between
4395
  # the various SCM types based on URL alone.  We have to try them
4396
  # (ideally in an order determined by a guess based on the URL) and
4397
  # see what happens.
4398
4399 242:bde4f47b6427 chris
project_mirror="$mirrordir/$project"
4400
mkdir -p "$project_mirror"
4401
project_repo_mirror="$project_mirror/repo"
4402 241:7658d21a1493 chris
4403 242:bde4f47b6427 chris
  # Some test URLs:
4404
  #
4405
  # http://aimc.googlecode.com/svn/trunk/
4406
  # http://aimc.googlecode.com/svn/
4407
  # http://vagar.org/git/flam
4408
  # https://github.com/wslihgt/IMMF0salience.git
4409
  # http://hg.breakfastquay.com/dssi-vst/
4410
  # git://github.com/schacon/hg-git.git
4411
  # http://svn.drobilla.net/lad (externals!)
4412
4413
# If we are importing from another distributed system, then our aim is
4414
# to create either a Hg repo or a git repo at $project_mirror, which
4415
# we can then pull from directly to the Hg repo at $local_repo (using
4416
# hg-git, in the case of a git repo).
4417
4418
# Importing from SVN, we should use hg convert directly to the target
4419
# hg repo (or should we?) but keep a record of the last changeset ID
4420
# we brought in, and test each time whether it matches the last
4421
# changeset ID actually in the repo
4422
4423
success=""
4424
4425 436:4eb486dbf730 Chris
# If we have a record of the last successfully updated remote repo
4426
# URL, check it against our current remote URL: if it has changed, we
4427
# will need to start again with a new clone rather than pulling
4428
# updates into the existing local mirror
4429
4430
successfile="$project_mirror/last_successful_url"
4431
if [ -f "$successfile" ]; then
4432
    last=$(cat "$successfile")
4433 437:102056ec2de9 chris
    if [ x"$last" = x"$remote_repo" ]; then
4434 436:4eb486dbf730 Chris
	echo "$$: Remote URL is unchanged from last successful update"
4435
    else
4436
	echo "$$: Remote URL has changed since last successful update:"
4437
	echo "$$: Last URL was $last, current is $remote_repo"
4438
	suffix="$$.$(date +%s)"
4439
	echo "$$: Moving existing repos to $suffix suffix and starting afresh"
4440
	mv "$project_repo_mirror" "$project_repo_mirror"."$suffix"
4441
	mv "$local_repo" "$local_repo"."$suffix"
4442
	mv "$successfile" "$successfile"."$suffix"
4443 437:102056ec2de9 chris
	touch "$project_mirror/url_changed"
4444 436:4eb486dbf730 Chris
    fi
4445
fi
4446
4447 242:bde4f47b6427 chris
if [ -d "$project_repo_mirror" ]; then
4448
4449
    # Repo mirror exists: update it
4450
    echo "$$: Mirror for project $project exists at $project_repo_mirror, updating" 1>&2
4451
4452
    if [ -d "$project_repo_mirror/.hg" ]; then
4453 433:7fd72f22a42b Chris
	"$hg" --config extensions.convert= convert --datesort "$remote_repo" "$project_repo_mirror" && success=true
4454 439:d3faf348b287 chris
	if [ -z "$success" ]; then
4455
	    ( cd "$project_repo_mirror" && "$hg" pull "$remote_repo" ) && success=true
4456
	fi
4457 242:bde4f47b6427 chris
    elif [ -d "$project_repo_mirror/.git" ]; then
4458 431:d3af621ba9d4 Chris
	( cd "$project_repo_mirror" && git pull "$remote_repo" master ) && success=true
4459 242:bde4f47b6427 chris
    else
4460
	echo "$$: ERROR: Repo mirror dir $project_repo_mirror exists but is not an Hg or git repo" 1>&2
4461
    fi
4462
4463
else
4464
4465
    # Repo mirror does not exist yet
4466
    echo "$$: Mirror for project $project does not yet exist at $project_repo_mirror, trying to convert or clone" 1>&2
4467
4468
    case "$remote_repo" in
4469
	*git*)
4470
	    git clone "$remote_repo" "$project_repo_mirror" ||
4471 433:7fd72f22a42b Chris
	    "$hg" --config extensions.convert= convert --datesort "$remote_repo" "$project_repo_mirror"
4472 242:bde4f47b6427 chris
	    ;;
4473
	*)
4474 433:7fd72f22a42b Chris
	    "$hg" --config extensions.convert= convert --datesort "$remote_repo" "$project_repo_mirror" ||
4475 299:defe55be97b9 chris
	    git clone "$remote_repo" "$project_repo_mirror" ||
4476 433:7fd72f22a42b Chris
	    "$hg" clone "$remote_repo" "$project_repo_mirror"
4477 242:bde4f47b6427 chris
	    ;;
4478
    esac && success=true
4479
4480
fi
4481
4482
echo "Success=$success"
4483
4484
if [ -n "$success" ]; then
4485
    echo "$$: Update successful, pulling into local repo at $local_repo"
4486 436:4eb486dbf730 Chris
    if [ ! -d "$local_repo" ]; then
4487
	"$hg" init "$local_repo"
4488
    fi
4489 242:bde4f47b6427 chris
    if [ -d "$project_repo_mirror/.git" ]; then
4490 436:4eb486dbf730 Chris
	( cd "$local_repo" && "$hg" --config extensions.hggit= pull "$project_repo_mirror" ) && echo "$remote_repo" > "$successfile"
4491 242:bde4f47b6427 chris
    else
4492 436:4eb486dbf730 Chris
	( cd "$local_repo" && "$hg" pull "$project_repo_mirror" ) && echo "$remote_repo" > "$successfile"
4493 242:bde4f47b6427 chris
    fi
4494
fi