This file is indexed.

/usr/bin/gtkdoc-rebase is in gtk-doc-tools 1.25-1ubuntu1.

This file is owned by root:root, with mode 0o755.

The actual contents of the file can be viewed below.

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
#!/usr/bin/perl -w
# -*- cperl -*-
#
# gtk-doc - GTK DocBook documentation generator.
# Copyright (C) 1998  Damon Chaplin
# Copyright (C) 2007  David Necas (Yeti)
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
#

#############################################################################
# Script      : gtkdoc-rebase
# Description : Rebases URI references in installed HTML documentation.
#############################################################################

use strict;
use bytes;
use Getopt::Long qw(:config gnu_getopt);
use Cwd qw(realpath);

# Options

my $HTML_DIR;
my @OTHER_DIRS;
my $DEST_DIR;
my $PRINT_VERSION;
my $PRINT_HELP;
my $AGGRESSIVE;
my $ONLINE;
my $RELATIVE;
my $VERBOSE;

# Maps.
# These two point to the last seen URI of given type for a package:
# OnlineMap: package => on-line URI
# LocalMap: package => local URI
# This maps all seen URIs of a package to fix broken links in the process:
# RevMap: URI => package
my (%OnlineMap, %LocalMap, %RevMap);
# Remember what mangling we did.
my %Mapped;


run() unless caller; # Run program unless loaded as a module


sub run {
    my %optctl = ('html-dir' => \$HTML_DIR,
            'other-dir' => \@OTHER_DIRS,
            'dest-dir' => \$DEST_DIR,
            'online' => \$ONLINE,
            'relative' => \$RELATIVE,
            'aggressive' => \$AGGRESSIVE,
            'verbose' => \$VERBOSE,
            'version' => \$PRINT_VERSION,
            'help' => \$PRINT_HELP);
    GetOptions(\%optctl, 'html-dir=s', 'other-dir=s@', 'dest-dir:s',
             'online', 'relative', 'aggressive', 'verbose',
             'version', 'help');
    
    if ($PRINT_VERSION) {
        print "1.25\n";
        exit 0;
    }
    
    if ($PRINT_HELP) {
        print <<EOF;
gtkdoc-rebase version 1.25 - rewrite the base url of html files

--html-dir=HTML_DIR     The directory which contains the installed HTML
--other-dir=OTHER_DIR   Directories to recursively scan for indices (index.sgml)
                        May be used more than once for multiple directories
--online                Prefer cross-references to online documents
--relative              Prefer relative cross-references
--aggressive            Rebase links to all files that are under a directory
                        matching a package name.
--dest-dir=ROOT_DIR     Staging area virtual root, this prefix will be removed
                        from HTML_DIR fore relative link calculation.
--verbose               Be verbose
--version               Print the version of this program
--help                  Print this help
EOF
        exit 0;
    }
    
    if (!$HTML_DIR) {
        die "No HTML directory (--html-dir) given.\n";
    }
       
    my $dir;
    
    # We scan the directory containing GLib and any directories in GNOME2_PATH
    # first, but these will be overriden by any later scans.
    if (defined ($ENV{"GNOME2_PATH"})) {
        foreach $dir (split(/:/, $ENV{"GNOME2_PATH"})) {
            $dir = $dir . "/share/gtk-doc/html";
            if ($dir && -d $dir) {
                print "Prepending GNOME2_PATH directory: $dir\n" if $VERBOSE;
                unshift @OTHER_DIRS, $dir;
            }
        }
    }
    
    $dir = `pkg-config --variable=prefix glib-2.0`;
    $dir =~ s/^\s*(\S*)\s*$/$1/;
    $dir = $dir . "/share/gtk-doc/html";
    print "Prepending GLib directory $dir\n" if $VERBOSE;
    unshift @OTHER_DIRS, $dir;
    
    # Check all other dirs, but skip already scanned dirs ord subdirs of those
    if ($DEST_DIR) {
        $DEST_DIR =~ s#/?$#/#;
    }
    $HTML_DIR =~ s#/?$#/#;
    
    foreach $dir (@OTHER_DIRS) {
        &ScanDirectory($dir, $HTML_DIR);
    }
    
    if ($RELATIVE) {
        &RelativizeLocalMap($HTML_DIR);
    }
    
    &RebaseReferences($HTML_DIR);
    &PrintWhatWeHaveDone();
}


sub ScanDirectory {
    my ($dir, $self) = @_;
    # This array holds any subdirectories found.
    my (@subdirs) = ();

    print "Scanning documentation directory $dir\n" if $VERBOSE;

    if ("$dir/" eq $self) {
        print "Excluding self\n" if $VERBOSE;
        return;
    }
    if (not opendir(HTMLDIR, $dir)) {
        print "Cannot open $dir: $!\n";
        return;
    }

    my $file;
    my $onlinedir;
    my $have_index = 0;
    foreach $file (readdir(HTMLDIR)) {
        if ($file eq '.' or $file eq '..') {
            next;
        }
        elsif (-d "$dir/$file") {
            push @subdirs, $file;
            next;
        }
        if ($file =~ m/\.devhelp2$/) {
            print "Reading index from $file\n" if $VERBOSE;
            my $o = &ReadDevhelp($dir, $file);
            # Prefer this location over possibly stale index.sgml
            if ($o) {
                $onlinedir = $o;
            }
            $have_index = 1;
        }
        if (!$onlinedir and ($file eq "index.sgml")) {
            print "Reading index from index.sgml\n" if $VERBOSE;
            $onlinedir = &ReadIndex($dir, $file);
            $have_index = 1;
        }
        elsif ($file eq "index.sgml.gz") {
            # debian/ubuntu started to compress this as index.sgml.gz :/
            print <<EOF;
Please fix https://bugs.launchpad.net/ubuntu/+source/gtk-doc/+bug/77138 . For now run:
gunzip $dir/$file
EOF
        }
        elsif ($file =~ m/\.devhelp2.gz$/) {
            # debian/ubuntu started to compress this as *devhelp2.gz :/
            print <<EOF;
Please fix https://bugs.launchpad.net/ubuntu/+source/gtk-doc/+bug/1466210 . For now run:
gunzip $dir/$file
EOF
        }
        # we could consider supporting: use IO::Zlib;
    }
    closedir (HTMLDIR);
    if ($have_index) {
        &AddMap($dir, $onlinedir);
    }

    # Now recursively scan the subdirectories.
    my $d;
    foreach my $subdir (@subdirs) {
        &ScanDirectory("$dir/$subdir", $self);
    }
}


sub ReadDevhelp {
    my ($dir, $file) = @_;
    my $onlinedir;

    open(INDEXFILE, "$dir/$file") || die "Can't open $dir/$file: $!";
    while (<INDEXFILE>) {
        # online must come before chapter/functions
        last if m/<(chapters|functions)/;
        if (m/ online="([^"]*)"/) {
            $onlinedir = $1;
            # Remove trailing non-directory component.
            $onlinedir =~ s#(.*/).*#$1#;
        }
    }
    close (INDEXFILE);
    return $onlinedir;
}


sub ReadIndex {
    my ($dir, $file) = @_;
    my $onlinedir;

    open(INDEXFILE, "$dir/$file") || die "Can't open $dir/$file: $!";
    while (<INDEXFILE>) {
        # ONLINE must come before any ANCHORs
        last if m/^<ANCHOR/;
        if (m/^<ONLINE\s+href\s*=\s*"([^"]+)"\s*>/) {
            $onlinedir = $1;
            # Remove trailing non-directory component.
            $onlinedir =~ s#(.*/).*#$1#;
        }
    }
    close (INDEXFILE);
    return $onlinedir;
}


sub AddMap {
    my ($dir, $onlinedir) = @_;
    my $package;

    $dir =~ s#/?$#/#;
    ($package = $dir) =~ s#.*/([^/]+)/#$1#;
    if ($DEST_DIR and substr($dir, 0, length $DEST_DIR) eq $DEST_DIR) {
        $dir = substr($dir, -1 + length $DEST_DIR);
    }
    if ($onlinedir) {
        print "On-line location of $package: $onlinedir\n" if $VERBOSE;
        $OnlineMap{ $package } = $onlinedir;
        $RevMap{ $onlinedir } = $package;
    } else {
        print "No On-line location for $package found\n" if $VERBOSE;
    }
    print "Local location of $package: $dir\n" if $VERBOSE;
    $LocalMap{ $package } = $dir;
    $RevMap{ $dir } = $package;
}


sub RelativizeLocalMap {
    my ($self) = @_;
    my $prefix;
    my $dir;

    $self = realpath $self;
    $self =~ s#/?$#/#;
    ($prefix = $self) =~ s#[^/]+/$##;
    foreach my $package (keys %LocalMap) {
        $dir = $LocalMap{ $package };
        if (substr($dir, 0, length $prefix) eq $prefix) {
            $dir = "../" . substr($dir, length $prefix);
            $LocalMap{ $package } = $dir;
            print "Relativizing local location of $package to $dir\n" if $VERBOSE;
        }
    }
}


sub RebaseReferences {
    my ($dir) = @_;

    opendir(HTMLDIR, $dir) || die "Can't open HTML directory $dir: $!";
    foreach my $file (readdir(HTMLDIR)) {
        if ($file =~ m/\.html?$/) {
            &RebaseFile("$dir$file");
        }
    }
    closedir (HTMLDIR);
}


sub RebaseFile {
    my ($file) = @_;
    print "Fixing file: $file\n" if $VERBOSE;

    open(HTMLFILE, $file) || die "Can't open $file: $!";
    local $/;
    undef $/;
    my $text = <HTMLFILE>;
    close(HTMLFILE);

    $text =~ s#(<a(?:\s+\w+=(?:"[^"]*"|'[^']*'))*\s+href=")([^"]*)(")#$1 . &RebaseLink($2) .$3#gse;

    open(NEWFILE, ">$file.new") || die "Can't open $file: $!";
    print NEWFILE $text;
    close(NEWFILE);

    unlink($file) || die "Can't delete $file: $!";
    rename("$file.new", $file) || die "Can't rename $file.new: $!";
}


sub RebaseLink {
    my ($href) = @_;
    my ($dir, $origdir, $file, $package);

    if ($href =~ m#^(.*/)([^/]*)$#) {
        $dir = $origdir = $1;
        $file = $2;
        if ($RevMap{ $dir }) {
            $package = $RevMap{ $dir };
        }
        elsif ($dir =~ m#^\.\./([^/]+)/#) {
            $package = $1
        }
        elsif ($AGGRESSIVE) {
            $dir =~ m#([^/]+)/$#;
            $package = $1;
        }
      
        if ($package) {
            if ($ONLINE && $OnlineMap{ $package }) {
              $dir = $OnlineMap{ $package };
            }
            elsif ($LocalMap{ $package }) {
              $dir = $LocalMap{ $package };
            }
            $href = $dir . $file;
        }
        if ($dir ne $origdir) {
            if ($Mapped{ $origdir }) {
              $Mapped{ $origdir }->[1]++;
            }
            else {
              $Mapped{ $origdir } = [ $dir, 1 ];
            }
        }
    }
    return $href;
}


sub PrintWhatWeHaveDone {
    my ($origdir, $info);
    foreach $origdir (sort keys %Mapped) {
        $info = $Mapped{$origdir};
        print "$origdir -> ", $info->[0], " (", $info->[1], ")\n";
    }
}