File: LinkChecker.java

package info (click to toggle)
openjdk-24 24.0.2%2B12-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 831,900 kB
  • sloc: java: 5,677,020; cpp: 1,323,154; xml: 1,320,524; ansic: 486,889; asm: 405,131; objc: 21,025; sh: 15,221; javascript: 11,049; python: 8,222; makefile: 2,504; perl: 357; awk: 351; sed: 172; pascal: 103; exp: 54; jsp: 24; csh: 3
file content (440 lines) | stat: -rw-r--r-- 14,205 bytes parent folder | download
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
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
/*
 * Copyright (c) 2024, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.
 *
 * This code 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
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */
package doccheckutils.checkers;


import doccheckutils.HtmlChecker;
import doccheckutils.Log;

import java.io.IOException;
import java.net.URI;
import java.net.URISyntaxException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.*;

/**
 * Checks the links defined by and referenced in HTML files.
 */
public class LinkChecker implements HtmlChecker {

    private final Log log;
    private final Map<Path, IDTable> allFiles;
    private final Map<URI, IDTable> allURIs;
    // left for debugging
    private final boolean checkInwardReferencesOnly = false;
    private int files;
    private int links;
    private int duplicateIds;
    private int missingFiles;
    private int missingIds;
    private int badSchemes;
    private Path currFile;
    private IDTable currTable;
    private boolean html5;
    public LinkChecker() {
        this.log = new Log();
        allFiles = new HashMap<>();
        allURIs = new HashMap<>();
    }

    public void setBaseDir(Path dir) {
        log.setBaseDirectory(dir);
    }

    @Override
    public void startFile(Path path) {
        currFile = path.toAbsolutePath().normalize();
        currTable = allFiles.computeIfAbsent(currFile, p -> new IDTable(log.relativize(p)));
        html5 = false;
        files++;
    }

    @Override
    public void endFile() {
        currTable.check();
    }


    //unused
    public List<Path> getUncheckedFiles() {
        return allFiles.entrySet().stream()
                .filter(e -> !e.getValue().checked
                        && e.getKey().toString().endsWith(".html")
                        && Files.exists(e.getKey()))
                .map(Map.Entry::getKey)
                .toList();
    }

    public List<Path> getMissingFiles() {
        return allFiles.keySet().stream()
                .filter(idTable -> !Files.exists(idTable)).toList();
    }

    @Override
    public void xml(int line, Map<String, String> attrs) {
    }

    @Override
    public void docType(int line, String doctype) {
        html5 = doctype.matches("(?i)<\\?doctype\\s+html>");
    }

    @Override
    @SuppressWarnings("fallthrough")
    public void startElement(int line, String name, Map<String, String> attrs, boolean selfClosing) {
        switch (name) {
            case "a":
                String nameAttr = html5 ? null : attrs.get("name");
                if (nameAttr != null) {
                    foundAnchor(line, nameAttr);
                }
                // fallthrough
            case "link":
                String href = attrs.get("href");
                if (href != null && !checkInwardReferencesOnly) {
                    foundReference(line, href);
                }
                break;
        }

        String idAttr = attrs.get("id");
        if (idAttr != null) {
            foundAnchor(line, idAttr);
        }
    }

    @Override
    public void endElement(int line, String name) {
    }

    @Override
    public void content(int line, String content) {
        HtmlChecker.super.content(line, content);
    }

    @Override
    public void report() {
        List<Path> pathList = getMissingFiles();
        log.log("");
        log.log("Link Checker Report");

        if (!pathList.isEmpty()) {
            log.log("");
            log.log("Missing files: (" + pathList.size() + ")");
            pathList.stream()
                    .sorted()
                    .forEach(this::reportMissingFile);
        }

        int anchors = 0;
        for (IDTable t : allFiles.values()) {
            anchors += (int) t.map.values().stream()
                    .filter(e -> !e.getReferences().isEmpty())
                    .count();
        }
        for (IDTable t : allURIs.values()) {
            anchors += (int) t.map.values().stream()
                    .filter(e -> !e.references.isEmpty())
                    .count();
        }

        log.log("Checked " + files + " files.");
        log.log("Found " + links + " references to " + anchors + " anchors "
                + "in " + allFiles.size() + " files and " + allURIs.size() + " other URIs.");
        if (!pathList.isEmpty()) {
            log.log("%6d missing files", pathList.size());
        }
        if (duplicateIds > 0) {
            log.log("%6d duplicate ids", duplicateIds);

        }
        if (missingIds > 0) {
            log.log("%6d missing ids", missingIds);

        }

        Map<String, Integer> hostCounts = new TreeMap<>(new HostComparator());
        for (URI uri : allURIs.keySet()) {
            String host = uri.getHost();
            if (host != null) {
                hostCounts.put(host, hostCounts.computeIfAbsent(host, h -> 0) + 1);
            }
        }

//        if (hostCounts.size() > 0) {
//            log.log("");
//            log.log("Hosts");
//            hostCounts.forEach((h, n) -> log.log("%6d %s", n, h));
//        }


        for (String message : log.getErrors()) {
            System.err.println(message);
        }

    }

    private void reportMissingFile(Path file) {
        log.log(log.relativize(file).toString());
        IDTable table = allFiles.get(file);
        Set<Path> refs = new TreeSet<>();
        for (IDInfo id : table.map.values()) {
            if (id.references != null) {
                for (Position ref : id.references) {
                    refs.add(ref.path);
                }
            }
        }
        int n = 0;
        int MAX_REFS = 10;
        for (Path ref : refs) {
            log.log("    in " + log.relativize(ref));
            if (++n == MAX_REFS) {
                log.log("    ... and %d more", refs.size() - n);
                break;
            }
        }
        missingFiles++;
    }

    @Override
    public boolean isOK() {
        return duplicateIds == 0
                && missingIds == 0
                && missingFiles == 0
                && badSchemes == 0;
    }

    @Override
    public void close() {
        report();
        if (!isOK()) {
            throw new RuntimeException(
                    "LinkChecker encountered errors. Duplicate IDs: "
                            + duplicateIds + ", Missing IDs: " + missingIds
                            + ", Missing Files: " + missingFiles + ", Bad Schemes: " + badSchemes);
        }
    }

    private void foundAnchor(int line, String name) {
        currTable.addID(line, name);
    }

    private void foundReference(int line, String ref) {
        links++;
        try {
            String uriPath = ref;
            String fragment = null;

            // The checker runs into a problem with links that have more than one hash character.
            // You cannot create a URI unless the second hash is escaped.

            int firstHashIndex = ref.indexOf('#');
            int lastHashIndex = ref.lastIndexOf('#');
            if (firstHashIndex != -1 && firstHashIndex != lastHashIndex) {
                uriPath = ref.substring(0, firstHashIndex);
                fragment = ref.substring(firstHashIndex + 1).replace("#", "%23");
            } else if (firstHashIndex != -1) {
                uriPath = ref.substring(0, firstHashIndex);
                fragment = ref.substring(firstHashIndex + 1);
            }

            URI uri = new URI(uriPath);
            if (fragment != null) {
                uri = new URI(uri + "#" + fragment);
            }

            if (uri.isAbsolute()) {
                foundReference(line, uri);
            } else {
                Path p;
                String resolvedUriPath = uri.getPath();
                if (resolvedUriPath == null || resolvedUriPath.isEmpty()) {
                    p = currFile;
                } else {
                    p = currFile.getParent().resolve(resolvedUriPath).normalize();
                }

                if (fragment != null && !fragment.isEmpty()) {
                    foundReference(line, p, fragment);
                }
            }
        } catch (URISyntaxException e) {
            System.err.println("Failed to create URI: " + ref);
            log.log(currFile, line, "invalid URI: " + e);
        }
    }


    private void foundReference(int line, Path p, String fragment) {
        IDTable t = allFiles.computeIfAbsent(p, key -> new IDTable(log.relativize(key)));
        t.addReference(fragment, currFile, line);
    }

    private void foundReference(int line, URI uri) {
        if (!isSchemeOK(uri.getScheme()) && !checkInwardReferencesOnly) {
            log.log(currFile, line, "bad scheme in URI");
            badSchemes++;
        }

        String fragment = uri.getRawFragment();
        if (fragment != null && !fragment.isEmpty()) {
            try {
                URI noFrag = new URI(uri.toString().replaceAll("#\\Q" + fragment + "\\E$", ""));
                IDTable t = allURIs.computeIfAbsent(noFrag, IDTable::new);
                t.addReference(fragment, currFile, line);
            } catch (URISyntaxException e) {
                throw new Error(e);
            }
        }
    }

    private boolean isSchemeOK(String uriScheme) {
        if (uriScheme == null) {
            return true;
        }

        return switch (uriScheme) {
            case "ftp", "http", "https", "javascript" -> true;
            default -> false;
        };
    }

    static class Position implements Comparable<Position> {
        Path path;
        int line;

        Position(Path path, int line) {
            this.path = path;
            this.line = line;
        }

        @Override
        public int compareTo(Position o) {
            int v = path.compareTo(o.path);
            return v != 0 ? v : Integer.compare(line, o.line);
        }

        @Override
        public boolean equals(Object obj) {
            if (this == obj) {
                return true;
            } else if (obj == null || getClass() != obj.getClass()) {
                return false;
            } else {
                final Position other = (Position) obj;
                return Objects.equals(this.path, other.path)
                        && this.line == other.line;
            }
        }

        @Override
        public int hashCode() {
            return Objects.hashCode(path) * 37 + line;
        }
    }

    static class IDInfo {
        boolean declared;
        Set<Position> references;

        Set<Position> getReferences() {
            return references == null ? Collections.emptySet() : references;
        }
    }

    static class HostComparator implements Comparator<String> {
        @Override
        public int compare(String h1, String h2) {
            List<String> l1 = new ArrayList<>(Arrays.asList(h1.split("\\.")));
            Collections.reverse(l1);
            String r1 = String.join(".", l1);
            List<String> l2 = new ArrayList<>(Arrays.asList(h2.split("\\.")));
            Collections.reverse(l2);
            String r2 = String.join(".", l2);
            return r1.compareTo(r2);
        }
    }

    class IDTable {
        private final Map<String, IDInfo> map = new HashMap<>();
        private final String pathOrURI;
        private boolean checked;

        IDTable(Path path) {
            this.pathOrURI = path.toString();
        }

        IDTable(URI uri) {
            this.pathOrURI = uri.toString();
        }

        void addID(int line, String name) {
            if (checked) {
                throw new IllegalStateException("Adding ID after file has been");
            }
            Objects.requireNonNull(name);
            IDInfo info = map.computeIfAbsent(name, _ -> new IDInfo());
            if (info.declared) {
                if (info.references != null || !checkInwardReferencesOnly) {
                    // don't report error if we're only checking inbound references
                    // and there are no references to this ID.
                    log.log(log.relativize(currFile), line, "name already declared: " + name);
                    duplicateIds++;
                }
            } else {
                info.declared = true;
            }
        }

        void addReference(String name, Path from, int line) {
            if (checked) {
                if (name != null) {
                    IDInfo id = map.get(name);
                    if (id == null || !id.declared) {
                        log.log(log.relativize(from), line, "id not found: " + this.pathOrURI + "#" + name);
                    }
                }
            } else {
                IDInfo id = map.computeIfAbsent(name, x -> new IDInfo());
                if (id.references == null) {
                    id.references = new TreeSet<>();
                }
                id.references.add(new Position(from, line));
            }
        }

        void check() {
            map.forEach((name, id) -> {
                if (name != null && !id.declared) {
                    for (Position ref : id.references) {
                        log.log(log.relativize(ref.path), ref.line, "id not found: " + this.pathOrURI + "#" + name);
                    }
                    missingIds++;
                }
            });
            checked = true;
        }
    }
}