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 @ 1549:28cde511f312

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