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 @ 1536:e2a3230f61fa

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