1 /*
2 * Copyright (c) 1998, 2016, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26 package jdk.javadoc.internal.doclets.toolkit.util;
27
28 import java.io.*;
29 import java.net.*;
30 import java.util.HashMap;
31 import java.util.Map;
32
33 import javax.lang.model.element.Element;
34 import javax.lang.model.element.PackageElement;
35 import javax.tools.Diagnostic;
36 import javax.tools.DocumentationTool;
37
38 import jdk.javadoc.doclet.Reporter;
39 import jdk.javadoc.internal.doclets.toolkit.Configuration;
40
41 /**
42 * Process and manage "-link" and "-linkoffline" to external packages. The
43 * options "-link" and "-linkoffline" both depend on the fact that Javadoc now
44 * generates "package-list"(lists all the packages which are getting
45 * documented) file in the current or the destination directory, while
46 * generating the documentation.
47 *
48 * <p><b>This is NOT part of any supported API.
49 * If you write code that depends on this, you do so at your own risk.
50 * This code and its internal interfaces are subject to change or
51 * deletion without notice.</b>
52 *
53 * @author Atul M Dambalkar
54 * @author Robert Field
55 */
56 public class Extern {
57
58 /**
59 * Map package names onto Extern Item objects.
60 * Lazily initialized.
61 */
62 private Map<String, Item> packageToItemMap;
63
64 /**
65 * The global configuration information for this run.
66 */
67 private final Configuration configuration;
68
69 /**
70 * True if we are using -linkoffline and false if -link is used instead.
71 */
72 private boolean linkoffline = false;
73
74 /**
75 * Stores the info for one external doc set
76 */
77 private class Item {
78
79 /**
80 * Package name, found in the "package-list" file in the {@link path}.
81 */
82 final String packageName;
83
84 /**
85 * The URL or the directory path at which the package documentation will be
86 * avaliable.
87 */
88 final String path;
89
90 /**
91 * If given path is directory path then true else if it is a URL then false.
92 */
93 final boolean relative;
94
95 /**
96 * Constructor to build a Extern Item object and map it with the package name.
97 * If the same package name is found in the map, then the first mapped
98 * Item object or offline location will be retained.
99 *
100 * @param packageName Package name found in the "package-list" file.
101 * @param path URL or Directory path from where the "package-list"
102 * file is picked.
103 * @param relative True if path is URL, false if directory path.
104 */
105 Item(String packageName, String path, boolean relative) {
106 this.packageName = packageName;
107 this.path = path;
108 this.relative = relative;
109 if (packageToItemMap == null) {
110 packageToItemMap = new HashMap<>();
111 }
112 if (!packageToItemMap.containsKey(packageName)) { // save the previous
113 packageToItemMap.put(packageName, this); // mapped location
114 }
115 }
116
117 /**
118 * String representation of "this" with packagename and the path.
119 */
120 public String toString() {
121 return packageName + (relative? " -> " : " => ") + path;
122 }
123 }
124
125 public Extern(Configuration configuration) {
126 this.configuration = configuration;
127 }
128
129 /**
130 * Determine if a element item is externally documented.
131 *
132 * @param element an Element.
133 */
134 public boolean isExternal(Element element) {
135 if (packageToItemMap == null) {
136 return false;
137 }
138 PackageElement pe = configuration.utils.containingPackage(element);
139 if (pe.isUnnamed()) {
140 return false;
141 }
142 return packageToItemMap.get(configuration.utils.getPackageName(pe)) != null;
143 }
144
145 /**
146 * Convert a link to be an external link if appropriate.
147 *
148 * @param pkgName The package name.
149 * @param relativepath The relative path.
150 * @param filename The link to convert.
151 * @return if external return converted link else return null
152 */
153 public DocLink getExternalLink(String pkgName, DocPath relativepath, String filename) {
154 return getExternalLink(pkgName, relativepath, filename, null);
155 }
156
157 public DocLink getExternalLink(String pkgName, DocPath relativepath, String filename,
158 String memberName) {
159 Item fnd = findPackageItem(pkgName);
160 if (fnd == null)
161 return null;
162
163 DocPath p = fnd.relative ?
164 relativepath.resolve(fnd.path).resolve(filename) :
165 DocPath.create(fnd.path).resolve(filename);
166
167 return new DocLink(p, "is-external=true", memberName);
168 }
169
170 /**
171 * Build the extern package list from given URL or the directory path.
172 * Flag error if the "-link" or "-linkoffline" option is already used.
173 *
174 * @param url URL or Directory path.
175 * @param pkglisturl This can be another URL for "package-list" or ordinary
176 * file.
177 * @param reporter The <code>DocErrorReporter</code> used to report errors.
178 * @param linkoffline True if -linkoffline is used and false if -link is used.
179 */
180 public boolean link(String url, String pkglisturl, Reporter reporter, boolean linkoffline) {
181 this.linkoffline = linkoffline;
182 try {
183 url = adjustEndFileSeparator(url);
184 if (isUrl(pkglisturl)) {
185 readPackageListFromURL(url, toURL(adjustEndFileSeparator(pkglisturl)));
186 } else {
187 readPackageListFromFile(url, DocFile.createFileForInput(configuration, pkglisturl));
188 }
189 return true;
190 } catch (Fault f) {
191 reporter.print(Diagnostic.Kind.WARNING, f.getMessage());
192 return false;
193 }
194 }
195
196 private URL toURL(String url) throws Fault {
197 try {
198 return new URL(url);
199 } catch (MalformedURLException e) {
200 throw new Fault(configuration.getText("doclet.MalformedURL", url), e);
201 }
202 }
203
204 private class Fault extends Exception {
205 private static final long serialVersionUID = 0;
206
207 Fault(String msg, Exception cause) {
208 super(msg, cause);
209 }
210 }
211
212 /**
213 * Get the Extern Item object associated with this package name.
214 *
215 * @param pkgName Package name.
216 */
217 private Item findPackageItem(String pkgName) {
218 if (packageToItemMap == null) {
219 return null;
220 }
221 return packageToItemMap.get(pkgName);
222 }
223
224 /**
225 * If the URL or Directory path is missing end file separator, add that.
226 */
227 private String adjustEndFileSeparator(String url) {
228 return url.endsWith("/") ? url : url + '/';
229 }
230
231 /**
232 * Fetch the URL and read the "package-list" file.
233 *
234 * @param urlpath Path to the packages.
235 * @param pkglisturlpath URL or the path to the "package-list" file.
236 */
237 private void readPackageListFromURL(String urlpath, URL pkglisturlpath) throws Fault {
238 try {
239 URL link = pkglisturlpath.toURI().resolve(DocPaths.PACKAGE_LIST.getPath()).toURL();
240 readPackageList(link.openStream(), urlpath, false);
241 } catch (URISyntaxException | MalformedURLException exc) {
242 throw new Fault(configuration.getText("doclet.MalformedURL", pkglisturlpath.toString()), exc);
243 }
244 catch (IOException exc) {
245 throw new Fault(configuration.getText("doclet.URL_error", pkglisturlpath.toString()), exc);
246 }
247 }
248
249 /**
250 * Read the "package-list" file which is available locally.
251 *
252 * @param path URL or directory path to the packages.
253 * @param pkgListPath Path to the local "package-list" file.
254 */
255 private void readPackageListFromFile(String path, DocFile pkgListPath)
256 throws Fault {
257 DocFile file = pkgListPath.resolve(DocPaths.PACKAGE_LIST);
258 if (! (file.isAbsolute() || linkoffline)){
259 file = file.resolveAgainst(DocumentationTool.Location.DOCUMENTATION_OUTPUT);
260 }
261 try {
262 if (file.exists() && file.canRead()) {
263 boolean pathIsRelative =
264 !DocFile.createFileForInput(configuration, path).isAbsolute()
265 && !isUrl(path);
266 readPackageList(file.openInputStream(), path, pathIsRelative);
267 } else {
268 throw new Fault(configuration.getText("doclet.File_error", file.getPath()), null);
269 }
270 } catch (IOException exc) {
271 throw new Fault(configuration.getText("doclet.File_error", file.getPath()), exc);
272 }
273 }
274
275 /**
276 * Read the file "package-list" and for each package name found, create
277 * Extern object and associate it with the package name in the map.
278 *
279 * @param input InputStream from the "package-list" file.
280 * @param path URL or the directory path to the packages.
281 * @param relative Is path relative?
282 */
283 private void readPackageList(InputStream input, String path, boolean relative)
284 throws IOException {
285 BufferedReader in = new BufferedReader(new InputStreamReader(input));
286 StringBuilder strbuf = new StringBuilder();
287 try {
288 int c;
289 while ((c = in.read()) >= 0) {
290 char ch = (char)c;
291 if (ch == '\n' || ch == '\r') {
292 if (strbuf.length() > 0) {
293 String packname = strbuf.toString();
294 String packpath = path +
295 packname.replace('.', '/') + '/';
296 new Item(packname, packpath, relative);
297 strbuf.setLength(0);
298 }
299 } else {
300 strbuf.append(ch);
301 }
302 }
303 } finally {
304 input.close();
305 }
306 }
307
308 public boolean isUrl (String urlCandidate) {
309 try {
310 new URL(urlCandidate);
311 //No exception was thrown, so this must really be a URL.
312 return true;
313 } catch (MalformedURLException e) {
314 //Since exception is thrown, this must be a directory path.
315 return false;
316 }
317 }
318 }