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 @ 1555:1786830cc35d

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