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
|
/*******************************************************************************
* Copyright (c) 2006, 2019 IBM Corporation and others.
*
* This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.help.internal.base.remote;
import java.io.IOException;
import java.io.InputStream;
import java.net.URL;
import org.eclipse.help.AbstractTocProvider;
import org.eclipse.help.ITocContribution;
import org.eclipse.help.internal.base.HelpBasePlugin;
import org.eclipse.help.internal.base.util.ProxyUtil;
/*
* Provides the TOC data that is located on the remote infocenter, if the system
* is configured for remote help. If not, returns no contributions.
*/
public class RemoteTocProvider extends AbstractTocProvider {
private static final String PATH_TOC = "/toc"; //$NON-NLS-1$
private static final String PROTOCOL = "http"; //$NON-NLS-1$
private static final String PARAM_LANG = "lang"; //$NON-NLS-1$
private static final String PROTOCOL_HTTPS = "https"; //$NON-NLS-1$
/*
* Constructs a new remote toc provider, which listens for remote
* help preference changes.
*/
public RemoteTocProvider() {
RemoteHelp.addPreferenceChangeListener(event -> contentChanged());
}
@Override
public ITocContribution[] getTocContributions(String locale) {
if (RemoteHelp.isEnabled()) {
InputStream in = null;
/*
* Loop through remote all the InfoCenters and get their TOCs.
* Combine the TOCs into an array of ITocContribution[]
*/
PreferenceFileHandler prefHandler = new PreferenceFileHandler();
// myHandler.getHost
RemoteTocParser parser = new RemoteTocParser();
String host[] = prefHandler.getHostEntries();
String port[] = prefHandler.getPortEntries();
String path[] = prefHandler.getPathEntries();
String protocol[] = prefHandler.getProtocolEntries();
String isEnabled[] = prefHandler.isEnabled();
ITocContribution[] currentContributions = new ITocContribution[0];
ITocContribution[] temp = new ITocContribution[0];
ITocContribution[] totalContributions = new ITocContribution[0];
int numICs = host.length;
if (numICs == 0) // No remote InfoCenters in preferences.ini
return new ITocContribution[0];
URL url = null;
String urlStr = ""; //$NON-NLS-1$
for (int i = numICs-1; i >= 0; i--) {
if (isEnabled[i].equalsIgnoreCase("true")) { //$NON-NLS-1$
try {
if(protocol[i].equalsIgnoreCase(PROTOCOL))
{
url = new URL(protocol[i], host[i], Integer.valueOf(port[i]) .intValue(),
path[i] + PATH_TOC + '?' + PARAM_LANG + '=' + locale);
in = ProxyUtil.getStream(url);
urlStr = PROTOCOL + "://"+host[i] + ":" + port[i] + path[i]; //$NON-NLS-1$ //$NON-NLS-2$
}
else
{
in = HttpsUtility.getHttpsInputStream(protocol[i],host[i],port[i],path[i],locale);
urlStr = PROTOCOL_HTTPS + "://"+host[i] + ":" + port[i] + path[i]; //$NON-NLS-1$ //$NON-NLS-2$
}
if (in != null) {
// pass URL to parser
currentContributions = parser.parse(in, urlStr);
/*
* Save previous contributed tocs to a temp variable
*/
temp = new ITocContribution[totalContributions.length];
System.arraycopy(totalContributions, 0, temp, 0,
totalContributions.length);
/*
* Combine current contributed tocs and previous
* contributed
*/
totalContributions = new ITocContribution[temp.length
+ currentContributions.length];
System.arraycopy(temp, 0, totalContributions, 0,
temp.length);
System.arraycopy(currentContributions, 0,
totalContributions, temp.length,
currentContributions.length);
}
} catch (Throwable t) {
String msg = "Internal error while reading TOC contents from remote server"; //$NON-NLS-1$
HelpBasePlugin.logError(msg, t);
RemoteHelp.setError(t);
} finally {
if (in != null) {
try {
in.close();
in = null;
} catch (IOException e) {
// nothing more we can do
}
}
}
}
}
return totalContributions;
}
return new ITocContribution[0];
}
@Override
public int getPriority() {
int helpOption=PreferenceFileHandler.getEmbeddedHelpOption();
if(helpOption ==PreferenceFileHandler.LOCAL_HELP_ONLY || helpOption==PreferenceFileHandler.LOCAL_HELP_PRIORITY)
return TOC_FILE_PRIORITY+1;
else return DEFAULT_PRIORITY-1;
}
}
|
