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
|
/*******************************************************************************
* Copyright (c) 2006 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.help.internal.toc;
import java.io.IOException;
import java.net.URL;
import java.util.ArrayList;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.zip.ZipEntry;
import java.util.zip.ZipFile;
import org.eclipse.core.runtime.FileLocator;
import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.Path;
import org.eclipse.core.runtime.Platform;
import org.eclipse.help.internal.HelpPlugin;
import org.eclipse.help.internal.util.ResourceLocator;
import org.osgi.framework.Bundle;
public class DocumentFinder {
public static String[] collectExtraDocuments(TocFile tocFile) {
String dir = HrefUtil.normalizeDirectoryHref(tocFile.getPluginId(), tocFile.getExtraDir());
String locale = tocFile.getLocale();
List result = new ArrayList();
String pluginID = HrefUtil.getPluginIDFromHref(dir);
if (pluginID == null) {
return new String[0];
}
Bundle pluginDesc = Platform.getBundle(pluginID);
if (pluginDesc == null || pluginDesc.getState() == Bundle.INSTALLED
|| pluginDesc.getState() == Bundle.UNINSTALLED)
return new String[0];
String directory = HrefUtil.getResourcePathFromHref(dir);
if (directory == null) {
// the root - all files in a zip should be indexed
directory = ""; //$NON-NLS-1$
}
// Find doc.zip file
IPath iPath = new Path("$nl$/doc.zip"); //$NON-NLS-1$
Map override = new HashMap(1);
override.put("$nl$", locale); //$NON-NLS-1$
URL url = FileLocator.find(pluginDesc, iPath, override);
if (url == null) {
url = FileLocator.find(pluginDesc, new Path("doc.zip"), null); //$NON-NLS-1$
}
if (url != null) {
// collect topics from doc.zip file
result.addAll(collectExtraDocumentsFromZip(pluginID, directory, url));
}
// Find topics in plugin
Set paths = ResourceLocator.findTopicPaths(pluginDesc, directory,
locale);
for (Iterator it = paths.iterator(); it.hasNext();) {
String href = "/" + pluginID + "/" + (String) it.next(); //$NON-NLS-1$//$NON-NLS-2$
href = HrefUtil.normalizeDirectoryPath(href);
result.add(href);
}
return (String[])result.toArray(new String[result.size()]);
}
private static List collectExtraDocumentsFromZip(String pluginID, String directory,
URL url) {
List result = new ArrayList();
URL realZipURL;
try {
realZipURL = FileLocator.toFileURL(FileLocator.resolve(url));
if (realZipURL.toExternalForm().startsWith("jar:")) { //$NON-NLS-1$
// doc.zip not allowed in jarred plug-ins.
return result;
}
} catch (IOException ioe) {
HelpPlugin.logError("IOException occurred, when resolving URL " //$NON-NLS-1$
+ url.toString() + ".", ioe); //$NON-NLS-1$
return result;
}
ZipFile zipFile;
try {
zipFile = new ZipFile(realZipURL.getFile());
result = createExtraTopicsFromZipFile(pluginID, zipFile, directory);
zipFile.close();
} catch (IOException ioe) {
HelpPlugin.logError(
"IOException occurred, when accessing Zip file " //$NON-NLS-1$
+ realZipURL.getFile()
+ ". File might not be locally available.", ioe); //$NON-NLS-1$
return new ArrayList();
}
return result;
}
private static List createExtraTopicsFromZipFile(String pluginID, ZipFile zipFile,
String directory) {
String constantHrefSegment = "/" + pluginID + "/"; //$NON-NLS-1$ //$NON-NLS-2$
List result = new ArrayList();
for (Enumeration entriesEnum = zipFile.entries(); entriesEnum.hasMoreElements();) {
ZipEntry zEntry = (ZipEntry) entriesEnum.nextElement();
if (zEntry.isDirectory()) {
continue;
}
String docName = zEntry.getName();
int l = directory.length();
if (l == 0 || docName.length() > l && docName.charAt(l) == '/'
&& directory.equals(docName.substring(0, l))) {
String href = constantHrefSegment + docName;
result.add(href);
}
}
return result;
}
}
|
