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
|
package org.rosuda.REngine.Rserve;
import java.io.BufferedReader;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
/**
* helper class that consumes output of a process. In addition, it filters output
* of the REG command on Windows to look for InstallPath registry entry which
* specifies the location of R.
*/
class StreamHog extends Thread {
InputStream is;
boolean capture;
String installPath;
StreamHog(InputStream is, boolean capture) {
this.is = is;
this.capture = capture;
start();
}
public String getInstallPath() {
return installPath;
}
public void run() {
try {
BufferedReader br = new BufferedReader(new InputStreamReader(is));
String line = null;
while ((line = br.readLine()) != null) {
if (capture) { // we are supposed to capture the output from REG command
int i = line.indexOf("InstallPath");
if (i >= 0) {
String s = line.substring(i + 11).trim();
int j = s.indexOf("REG_SZ");
if (j >= 0) {
s = s.substring(j + 6).trim();
}
installPath = s;
System.out.println("StartRserve: R InstallPath = " + s);
}
} else {
System.out.println("StartRserve: Rserve>" + line);
}
}
} catch (IOException e) {
e.printStackTrace();
}
}
}
/**
* simple class that start Rserve locally if it's not running already - see
* mainly <code>checkLocalRserve</code> method. It spits out quite some
* debugging outout of the console, so feel free to modify it for your
* application if desired.<p>
* <i>Important:</i> All applications should shutdown every Rserve that they
* started! Never leave Rserve running if you started it after your application
* quits since it may pose a security risk. Inform the user if you started an
* Rserve instance.
*/
public class StartRserve {
/**
* shortcut to
* <code>launchRserve(cmd, "--no-save --slave", "--no-save --slave", false)</code>
*/
public static boolean launchRserve(String cmd) {
return launchRserve(cmd, "--no-save --slave", "--no-save --slave", false);
}
/**
* attempt to start Rserve. Note: parameters are <b>not</b> quoted, so avoid
* using any quotes in arguments
*
* @param cmd command necessary to start R
* @param rargs arguments are are to be passed to R
* @param rsrvargs arguments to be passed to Rserve
* @return <code>true</code> if Rserve is running or was successfully started,
* <code>false</code> otherwise.
*/
public static boolean launchRserve(String cmd, String rargs, String rsrvargs, boolean debug) {
try {
Process p;
boolean isWindows = false;
String osname = System.getProperty("os.name");
if (osname != null && osname.length() >= 7 && osname.substring(0, 7).equals("Windows")) {
isWindows = true; /* Windows startup */
p = Runtime.getRuntime().exec("\"" + cmd + "\" -e \"library(Rserve);Rserve(" + (debug ? "TRUE" : "FALSE") + ",args='" + rsrvargs + "')\" " + rargs);
} else /* unix startup */ {
p = Runtime.getRuntime().exec(new String[]{
"/bin/sh", "-c",
"echo 'library(Rserve);Rserve(" + (debug ? "TRUE" : "FALSE") + ",args=\"" + rsrvargs + "\")'|" + cmd + " " + rargs
});
}
System.out.println("StartRserve: waiting for Rserve to start ... (" + p + ")");
// we need to fetch the output - some platforms will die if you don't ...
StreamHog errorHog = new StreamHog(p.getErrorStream(), false);
StreamHog outputHog = new StreamHog(p.getInputStream(), false);
if (!isWindows) /* on Windows the process will never return, so we cannot wait */ {
p.waitFor();
}
System.out.println("StartRserve: call terminated, let us try to connect ...");
} catch (Exception x) {
System.out.println("StartRserve: failed to start Rserve process with " + x.getMessage());
return false;
}
int attempts = 5; /* try up to 5 times before giving up. We can be conservative here, because at this point the process execution itself was successful and the start up is usually asynchronous */
while (attempts > 0) {
try {
RConnection c = new RConnection();
c.close();
return true;
} catch (Exception e2) {
System.out.println("StartRserve: Try failed with: " + e2.getMessage());
}
/* a safety sleep just in case the start up is delayed or asynchronous */
try {
Thread.sleep(500);
} catch (InterruptedException ix) {
};
attempts--;
}
return false;
}
/**
* checks whether Rserve is running and if that's not the case it attempts to
* start it using the defaults for the platform where it is run on. This
* method is meant to be set-and-forget and cover most default setups. For
* special setups you may get more control over R with
* <<code>launchRserve</code> instead.
*/
public static boolean checkLocalRserve() {
if (isRserveRunning()) {
return true;
}
String osname = System.getProperty("os.name");
if (osname != null && osname.length() >= 7 && osname.substring(0, 7).equals("Windows")) {
System.out.println("StartRserve: Windows: query registry to find where R is installed ...");
String installPath = null;
try {
Process rp = Runtime.getRuntime().exec("reg query HKLM\\Software\\R-core\\R");
StreamHog regHog = new StreamHog(rp.getInputStream(), true);
rp.waitFor();
regHog.join();
installPath = regHog.getInstallPath();
} catch (Exception rge) {
System.out.println("ERROR: unable to run REG to find the location of R: " + rge);
return false;
}
if (installPath == null) {
System.out.println("ERROR: canot find path to R. Make sure reg is available and R was installed with registry settings.");
return false;
}
return launchRserve(installPath + "\\bin\\R.exe");
}
return (launchRserve("R")
|| /* try some common unix locations of R */ ((new File("/Library/Frameworks/R.framework/Resources/bin/R")).exists() && launchRserve("/Library/Frameworks/R.framework/Resources/bin/R"))
|| ((new File("/usr/local/lib/R/bin/R")).exists() && launchRserve("/usr/local/lib/R/bin/R"))
|| ((new File("/usr/lib/R/bin/R")).exists() && launchRserve("/usr/lib/R/bin/R"))
|| ((new File("/usr/local/bin/R")).exists() && launchRserve("/usr/local/bin/R"))
|| ((new File("/sw/bin/R")).exists() && launchRserve("/sw/bin/R"))
|| ((new File("/usr/common/bin/R")).exists() && launchRserve("/usr/common/bin/R"))
|| ((new File("/opt/bin/R")).exists() && launchRserve("/opt/bin/R")));
}
/**
* check whether Rserve is currently running (on local machine and default
* port).
*
* @return <code>true</code> if local Rserve instance is running,
* <code>false</code> otherwise
*/
public static boolean isRserveRunning() {
try {
RConnection c = new RConnection();
c.close();
return true;
} catch (Exception e) {
System.out.println("StartRserve: first connect try failed with: " + e.getMessage());
}
return false;
}
/**
* just a demo main method which starts Rserve and shuts it down again
*/
public static void main(String[] args) {
System.out.println("result=" + checkLocalRserve());
try {
RConnection c = new RConnection();
c.shutdown();
} catch (Exception x) {
};
}
}
|