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 @ 1562:3107eacaddf7

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