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
|
/*******************************************************************************
* Copyright (c) 2000, 2011 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.base;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.RandomAccessFile;
import java.nio.channels.FileLock;
import java.util.Map;
import java.util.Properties;
import org.eclipse.core.runtime.IConfigurationElement;
import org.eclipse.core.runtime.IExecutableExtension;
import org.eclipse.core.runtime.Platform;
import org.eclipse.equinox.app.IApplication;
import org.eclipse.equinox.app.IApplicationContext;
import org.eclipse.help.internal.server.WebappManager;
import org.eclipse.osgi.util.NLS;
/**
* Help application. Starts webserver and help web application for use by
* infocenter and stand-alone help. Application takes a parameter "mode", that
* can take values: "infocenter" - when help system should run as infocenter,
* "standalone" - when help system should run as standalone.
*/
public class HelpApplication implements IApplication, IExecutableExtension {
private static final String APPLICATION_LOCK_FILE = ".applicationlock"; //$NON-NLS-1$
private static final int STATE_EXITING = 0;
private static final int STATE_RUNNING = 1;
private static final int STATE_RESTARTING = 2;
private static int status = STATE_RUNNING;
private static boolean shutdownOnClose = false; // Shutdown help when the embedded browser is closed
private File metadata;
private FileLock lock;
private RandomAccessFile raf;
/* (non-Javadoc)
* @see org.eclipse.equinox.app.IApplication#start(org.eclipse.equinox.app.IApplicationContext)
*/
@Override
public synchronized Object start(IApplicationContext context) throws Exception {
if (status == STATE_RESTARTING) {
return EXIT_RESTART;
}
metadata = new File(Platform.getLocation().toFile(), ".metadata/"); //$NON-NLS-1$
if (!BaseHelpSystem.ensureWebappRunning()) {
System.out.println(NLS.bind(HelpBaseResources.HelpApplication_couldNotStart, Platform.getLogFileLocation().toOSString()));
return EXIT_OK;
}
if (status == STATE_RESTARTING) {
return EXIT_RESTART;
}
writeHostAndPort();
obtainLock();
if (BaseHelpSystem.MODE_STANDALONE == BaseHelpSystem.getMode()) {
//try running UI loop if possible
DisplayUtils.runUI();
}
//run a headless loop;
while (status == STATE_RUNNING) {
try {
Thread.sleep(100);
} catch (InterruptedException ie) {
break;
}
}
releaseLock();
if (status == STATE_RESTARTING) {
return EXIT_RESTART;
}
return EXIT_OK;
}
/* (non-Javadoc)
* @see org.eclipse.equinox.app.IApplication#stop()
*/
@Override
public void stop() {
stopHelp();
// wait until start has finished
synchronized(this) {};
}
/**
* Causes help service to stop and exit
*/
public static void stopHelp() {
status = STATE_EXITING;
if (BaseHelpSystem.MODE_STANDALONE == BaseHelpSystem.getMode()) {
// UI loop may be sleeping if no SWT browser is up
DisplayUtils.wakeupUI();
}
}
/**
* Causes help service to exit and start again
*/
public static void restartHelp() {
if (status != STATE_EXITING) {
status = STATE_RESTARTING;
}
}
/* (non-Javadoc)
* @see org.eclipse.core.runtime.IExecutableExtension#setInitializationData(org.eclipse.core.runtime.IConfigurationElement, java.lang.String, java.lang.Object)
*/
@Override
public void setInitializationData(IConfigurationElement configElement, String propertyName, Object data) {
String value = (String)((Map<?, ?>)data).get("mode"); //$NON-NLS-1$
if ("infocenter".equalsIgnoreCase(value)) { //$NON-NLS-1$
BaseHelpSystem.setMode(BaseHelpSystem.MODE_INFOCENTER);
}
else if ("standalone".equalsIgnoreCase(value)) { //$NON-NLS-1$
BaseHelpSystem.setMode(BaseHelpSystem.MODE_STANDALONE);
}
}
private void writeHostAndPort() throws IOException {
Properties p = new Properties();
p.put("host", WebappManager.getHost()); //$NON-NLS-1$
p.put("port", "" + WebappManager.getPort()); //$NON-NLS-1$ //$NON-NLS-2$
File hostPortFile = new File(metadata, ".connection"); //$NON-NLS-1$
hostPortFile.deleteOnExit();
FileOutputStream out = null;
try {
metadata.mkdirs();
out = new FileOutputStream(hostPortFile);
p.store(out, null);
} finally {
if (out != null) {
try {
out.close();
} catch (IOException ioe2) {
}
}
}
}
private void obtainLock() {
File lockFile = new File(metadata, APPLICATION_LOCK_FILE);
try {
raf = new RandomAccessFile(lockFile, "rw"); //$NON-NLS-1$
lock = raf.getChannel().lock();
} catch (IOException ioe) {
lock = null;
}
}
private void releaseLock() {
if (lock != null) {
try {
lock.channel().close();
} catch (IOException ioe) {
}
}
if (raf != null) {
try {
raf.close();
} catch (IOException ioe) {
}
raf = null;
}
}
public static boolean isRunning() {
return status == STATE_RUNNING;
}
public static boolean isShutdownOnClose() {
return shutdownOnClose;
}
public static void setShutdownOnClose(boolean shutdownOnClose) {
HelpApplication.shutdownOnClose = shutdownOnClose;
}
}
|
