source: main/trunk/gli/src/org/greenstone/gatherer/Gatherer.java@ 22806

Last change on this file since 22806 was 22806, checked in by ak19, 14 years ago

Further changes to ticket 152 (movable collectdir). Need to deal with GLI being started and reading in a non-standard collectdir from config files (stored from a previous GLI session) that now no longer exists. In this case need to revert back to the default Greenstone collectdir. Tested on Windows with the included Apache webserver and server.exe

  • Property svn:keywords set to Author Date Id Revision
File size: 54.0 KB
Line 
1/**
2 *#########################################################################
3 *
4 * A component of the Gatherer application, part of the Greenstone digital
5 * library suite from the New Zealand Digital Library Project at the
6 * University of Waikato, New Zealand.
7 *
8 * Author: John Thompson, Greenstone Digital Library, University of Waikato
9 *
10 * Copyright (C) 1999 New Zealand Digital Library Project
11 *
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
16 *
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
21 *
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, write to the Free Software
24 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
25 *########################################################################
26 */
27package org.greenstone.gatherer;
28
29import java.awt.*;
30import java.awt.event.*;
31import java.io.*;
32import java.lang.*;
33import java.net.*;
34import java.util.*;
35import javax.swing.*;
36import javax.swing.plaf.*;
37import javax.swing.text.*;
38
39
40import org.greenstone.gatherer.Configuration;
41import org.greenstone.gatherer.GAuthenticator;
42import org.greenstone.gatherer.FedoraInfo;
43import org.greenstone.gatherer.collection.CollectionManager;
44import org.greenstone.gatherer.feedback.ActionRecorderDialog;
45import org.greenstone.gatherer.feedback.Base64;
46import org.greenstone.gatherer.file.FileManager;
47import org.greenstone.gatherer.file.FileAssociationManager;
48import org.greenstone.gatherer.file.RecycleBin;
49import org.greenstone.gatherer.greenstone.Classifiers;
50import org.greenstone.gatherer.greenstone.LocalGreenstone;
51import org.greenstone.gatherer.greenstone.LocalLibraryServer;
52import org.greenstone.gatherer.greenstone.Plugins;
53import org.greenstone.gatherer.greenstone3.ServletConfiguration;
54import org.greenstone.gatherer.gui.GUIManager;
55import org.greenstone.gatherer.gui.URLField;
56import org.greenstone.gatherer.gui.WarningDialog;
57import org.greenstone.gatherer.gui.FedoraLogin;
58import org.greenstone.gatherer.remote.RemoteGreenstoneServer;
59import org.greenstone.gatherer.util.JarTools;
60import org.greenstone.gatherer.util.StaticStrings;
61import org.greenstone.gatherer.util.Utility;
62
63
64/** Containing the top-level "core" for the Gatherer, this class is the
65 * common core for the GLI application and applet. It first parses the
66 * command line arguments, preparing to update the configuration as
67 * required. Next it loads several important support classes such as the
68 * Configuration and Dictionary. Finally it creates the other important
69 * managers and sends them on their way.
70 * @author John Thompson, Greenstone Digital Library, University of Waikato
71 * @version 2.3
72 */
73public class Gatherer
74{
75 /** The name of the GLI. */
76 static final public String PROGRAM_NAME = "Greenstone Librarian Interface";
77 /** The current version of the GLI.
78 * Note: the gs3-release-maker relies on this variable being declared
79 * in a line which maches this java regex:
80 * ^(.*)String\s*PROGRAM_VERSION\s*=\s*"trunk";
81 * If change the declaration and it no longer matches the regex, please
82 * change the regex in the gs3-release-maker code and in this message
83 */
84
85 static final public String PROGRAM_VERSION = "trunk";
86
87 static private Dimension size = new Dimension(800, 540);
88 static public RemoteGreenstoneServer remoteGreenstoneServer = null;
89
90 /** Has the exit flag been set? */
91 static final public int EXIT_THEN_RESTART= 2;
92 static public boolean exit = false;
93 static public int exit_status = 0;
94
95 static private String gli_directory_path = null;
96 static private String gli_user_directory_path = null;
97
98 static public String client_operating_system = null;
99
100 /** All of the external applications that must exit before we close the Gatherer. */
101 static private Vector apps = new Vector();
102 static private String non_standard_collect_directory_path = null;
103 static public String open_collection_file_path = null;
104 /** A public reference to the FileAssociationManager. */
105 static public FileAssociationManager assoc_man;
106 /** A public reference to the CollectionManager. */
107 static public CollectionManager c_man;
108 /** A public reference to the RecycleBin. */
109 static public RecycleBin recycle_bin;
110 /** a reference to the Servlet Configuration is GS3 */
111 static public ServletConfiguration servlet_config;
112 /** A public reference to the FileManager. */
113 static public FileManager f_man;
114 /** A public reference to the GUIManager. */
115 static public GUIManager g_man = null;
116 static private boolean g_man_built = false;
117
118 /** We are using the GLI for GS3 */
119 static public boolean GS3 = false;
120
121 static public boolean isApplet = false;
122 static public boolean isGsdlRemote = false;
123 static public boolean isLocalLibrary = false;
124
125 /* TODO: If we're using local GLI, collections are built locally. If we're using client-GLI
126 * and it contains a gs2build folder in it, then localBuild will also be true (if this is not
127 * turned off in Preferences). If we're remote and this is turned off in Prefs, build remotely. */
128 /*static public boolean buildingLocally = true;*/
129 /** If we're using local GLI, we can always download. If we're using client-GLI, we can only
130 * download if we have a gs2build folder inside it. And if we don't turn off downloadEnabling
131 * in the preferences.
132 */
133 static public boolean isDownloadEnabled = true;
134
135 // feedback stuff
136 /** is the feedback feature enabled? */
137 static public boolean feedback_enabled = true;
138 /** the action recorder dialog */
139 static public ActionRecorderDialog feedback_dialog = null;
140
141 // Refresh reasons
142 static public final int COLLECTION_OPENED = 0;
143 static public final int COLLECTION_CLOSED = 1;
144 static public final int COLLECTION_REBUILT = 2;
145 static public final int PREFERENCES_CHANGED = 3;
146
147 //////kk added////////
148 static public String cgiBase="";
149 /////////////////
150
151 /** Magic to allow Enter to fire the default button. */
152 static {
153 KeyStroke enter = KeyStroke.getKeyStroke(KeyEvent.VK_ENTER, 0);
154 Keymap map = JTextComponent.getKeymap(JTextComponent.DEFAULT_KEYMAP);
155 map.removeKeyStrokeBinding(enter);
156 }
157
158 static private URL default_gliserver_url=null;
159
160 public Gatherer(String[] args)
161 {
162 // Display the version to make error reports a lot more useful
163 System.err.println("Version: " + PROGRAM_VERSION + "\n");
164
165 JarTools.initialise(this);
166
167 GetOpt go = new GetOpt(args);
168
169 // Remember the GSDLOS value
170 client_operating_system = go.client_operating_system;
171
172 // If feedback is enabled, set up the recorder dialog
173 if (go.feedback_enabled) {
174 // Use the default locale for now - this will be changed by the Gatherer run method
175 feedback_enabled = true;
176 feedback_dialog = new ActionRecorderDialog(Locale.getDefault());
177 }
178
179 // Are we using a remote Greenstone?
180 if (go.use_remote_greenstone) {
181 isGsdlRemote = true;
182
183 // We don't have a local Greenstone!
184 go.gsdl3_path=null;
185 go.gsdl3_src_path=null;
186
187 // Don't set go.gsdl_path to null, since gdsl_path may still be set
188 // if we have a client-gli containing gs2build folder.
189 // However, keep track of whether we can download.
190 if(go.gsdl_path == null) {
191 isDownloadEnabled = false;
192 }
193
194 // We have to use our own collect directory since we can't use the Greenstone one
195 setCollectDirectoryPath(getGLIUserDirectoryPath() + "collect" + File.separator);
196 }
197 // We have a local Greenstone. OR we have a gs2build folder inside
198 // the client-GLI folder (with which the Download panel becomes enabled)
199 if(isDownloadEnabled) {
200 LocalGreenstone.setDirectoryPath(go.gsdl_path);
201 }
202
203 // Users may specify a non-standard collect directory (eg. when running one GLI in a network environment)
204 if (go.collect_directory_path != null) {
205 setCollectDirectoryPath(go.collect_directory_path);
206 }
207
208 // More special code for running with a remote Greenstone
209 if (isGsdlRemote) {
210 if (go.fedora_info.isActive()) {
211 Configuration.TEMPLATE_CONFIG_XML = "xml/" + Configuration.FEDORA_CONFIG_PREFIX + "configRemote.xml";
212 }
213 else {
214 Configuration.TEMPLATE_CONFIG_XML = "xml/configRemote.xml";
215 }
216
217 Configuration.CONFIG_XML = "configRemote.xml";
218
219 File collect_directory = new File(Gatherer.getCollectDirectoryPath());
220 if (!collect_directory.exists() && !collect_directory.mkdir()) {
221 System.err.println("Warning: Unable to make directory: " + collect_directory);
222 }
223 }
224 else {
225 if (go.fedora_info.isActive()) {
226 Configuration.TEMPLATE_CONFIG_XML = "xml/" + Configuration.FEDORA_CONFIG_PREFIX + Configuration.CONFIG_XML;
227 }
228 // else, the CONFIG_XML uses the default config file, which is for the local GS server
229 }
230
231 init(go.gsdl_path, go.gsdl3_path, go.gsdl3_src_path,
232 go.fedora_info,
233 go.local_library_path, go.library_url_string,
234 go.gliserver_url_string, go.debug, go.perl_path, go.no_load, go.filename, go.site_name,
235 go.servlet_path);
236 }
237
238
239 public void init(String gsdl_path, String gsdl3_path, String gsdl3_src_path,
240 FedoraInfo fedora_info,
241 String local_library_path,
242 String library_url_string, String gliserver_url_string, boolean debug_enabled,
243 String perl_path, boolean no_load, String open_collection,
244 String site_name, String servlet_path)
245 {
246 if (gsdl3_path != null && !gsdl3_path.equals("")) {
247 this.GS3 = true;
248 } else {
249 gsdl3_path = null;
250 gsdl3_src_path = null;
251 }
252
253 // Create the debug stream if required
254 if (debug_enabled) {
255 DebugStream.enableDebugging();
256
257 Calendar now = Calendar.getInstance();
258 String debug_file_path = "debug" + now.get(Calendar.DATE) + "-" + now.get(Calendar.MONTH) + "-" + now.get(Calendar.YEAR) + ".txt";
259
260 // Debug file is created in the user's GLI directory
261 debug_file_path = getGLIUserDirectoryPath() + debug_file_path;
262 DebugStream.println("Debug file path: " + debug_file_path);
263 DebugStream.setDebugFile(debug_file_path);
264 DebugStream.print(System.getProperties());
265 }
266
267 // Delete plugins.dat and classifiers.dat files from previous versions of the GLI (no longer used)
268 File plugins_dat_file = new File(Gatherer.getGLIUserDirectoryPath() + "plugins.dat");
269 if (plugins_dat_file.exists()) {
270 System.err.println("Deleting plugins.dat file...");
271 Utility.delete(plugins_dat_file);
272 }
273 File classifiers_dat_file = new File(Gatherer.getGLIUserDirectoryPath() + "classifiers.dat");
274 if (classifiers_dat_file.exists()) {
275 System.err.println("Deleting classifiers.dat file...");
276 Utility.delete(classifiers_dat_file);
277 }
278
279 try {
280 // Load GLI config file
281 new Configuration(getGLIUserDirectoryPath(), gsdl_path, gsdl3_path, gsdl3_src_path, site_name,
282 fedora_info);
283
284 // Check we know where Perl is
285 Configuration.perl_path = perl_path;
286 if (isGsdlRemote && !isDownloadEnabled && Utility.isWindows() && Configuration.perl_path != null) {
287 if (Configuration.perl_path.toLowerCase().endsWith("perl.exe")) {
288 Configuration.perl_path = Configuration.perl_path.substring(0, Configuration.perl_path.length() - "perl.exe".length());
289 }
290 if (Configuration.perl_path.endsWith(File.separator)) {
291 Configuration.perl_path = Configuration.perl_path.substring(0, Configuration.perl_path.length() - File.separator.length());
292 }
293 }
294
295 // the feedback dialog has been loaded with a default locale,
296 // now set the user specified one
297 if (feedback_enabled && feedback_dialog != null) {
298 feedback_dialog.setLocale(Configuration.getLocale("general.locale", true));
299 }
300
301 // Read Dictionary
302 new Dictionary(Configuration.getLocale("general.locale", true), Configuration.getFont("general.font", true));
303
304 // check that we are using Sun Java
305 String java_vendor = System.getProperty("java.vendor");
306 if (!java_vendor.equals("Sun Microsystems Inc.")) {
307 System.err.println(Dictionary.get("General.NotSunJava", java_vendor));
308 }
309
310 // Unless we're using remote building, we need to know where the local Greenstone is
311 if (!isGsdlRemote && gsdl_path == null) {
312 missingGSDL();
313 }
314
315 if (fedora_info.isActive()) {
316 popupFedoraInfo();
317 }
318
319 // Finally, we're ready to find out the version of the remote Greenstone server
320 if(isGsdlRemote) {
321 // instantiate the RemoteGreenstoneServer object first
322 remoteGreenstoneServer = new RemoteGreenstoneServer();
323
324 // Set up proxy
325 setProxy();
326 // Now we set up an Authenticator
327 Authenticator.setDefault(new GAuthenticator());
328
329 int greenstoneVersion = 2;
330 requestGLIServerURL();
331 gliserver_url_string = Configuration.gliserver_url.toString();
332
333 greenstoneVersion = remoteGreenstoneServer.getGreenstoneVersion();
334 // Display the version to make error reports a lot more useful
335 System.err.println("Remote Greenstone server version: " + greenstoneVersion);
336 if(greenstoneVersion == -1) { // remote server not running
337 Gatherer.exit();
338 }
339 if(greenstoneVersion >= 3) {
340 this.GS3 = true;
341 Configuration.prepareForGS3();
342 }
343
344 if(fedora_info.isActive()) {
345 // when GS server is remote, FEDORA_HOME resides on the remote server side,
346 // but we know the library URL from user-provided information
347 library_url_string = fedora_info.getLibraryURL();
348 } else {
349 library_url_string = remoteGreenstoneServer.getLibraryURL(Configuration.gliserver_url.toString());
350 }
351 // write it into the config file
352 Configuration.setString("general.library_url", true, library_url_string);
353 }
354 else { // local greenstone: Start up the local library server, if that's what we want
355 if (!GS3) {
356 isLocalLibrary = LocalLibraryServer.start(gsdl_path, local_library_path);
357 }
358 // else web library: GS server is local, but doesn't use the webserver included with GS2
359 }
360
361 // The "-library_url" option overwrites anything in the config files
362 if (library_url_string != null && library_url_string.length() > 0) {
363 try {
364 System.err.println("Setting library_url to " + library_url_string + "...");
365 Configuration.library_url = new URL(library_url_string);
366 }
367 catch (MalformedURLException error) {
368 DebugStream.printStackTrace(error);
369 }
370 }
371
372
373 // Check that we now know the Greenstone library URL, since we need this for previewing collections
374 // It is not necessary if an independent GSI was launched and the user hasn't pressed Enter Library yet
375 DebugStream.println("Configuration.library_url = " + Configuration.library_url);
376 if (Configuration.library_url == null) {
377 if(isLocalLibrary) {
378 if(!LocalLibraryServer.isURLPending()) {
379 missingEXEC();
380 }
381 // else LocalLibraryServer is expecting a URL soon, so don't need to display the dialog
382 } else { // GS2 webLibrary or GS3 or remote Greenstone
383 missingEXEC();
384 }
385 }
386
387 // The "-gliserver_url" option overwrites anything in the config files
388 if (gliserver_url_string != null && gliserver_url_string.length() > 0) {
389 try {
390 System.err.println("Setting gliserver_url to " + gliserver_url_string + "...");
391 Configuration.gliserver_url = new URL(gliserver_url_string);
392 }
393 catch (MalformedURLException error) {
394 DebugStream.printStackTrace(error);
395 }
396 }
397
398 // If we're using a remote Greenstone we need to know where the gliserver script is
399 DebugStream.println("Configuration.gliserver_url = " + Configuration.gliserver_url);
400
401 if (GS3) {
402 // Load Greenstone 3 servlet configuration
403 if (isGsdlRemote){
404 servlet_config = new ServletConfiguration(Configuration.gli_user_directory_path);
405 }else{
406 servlet_config= new ServletConfiguration(gsdl3_path);
407 }
408 }
409
410 if (GS3 && Configuration.servlet_path == null) {
411 Configuration.servlet_path = servlet_config.getServletPath(Configuration.site_name);
412 }
413
414 // ensure that a directory called 'cache' exists in the GLI user directory
415 File user_cache_dir = new File(Gatherer.getGLIUserCacheDirectoryPath());
416 System.err.println("User cache dir: " + Gatherer.getGLIUserCacheDirectoryPath());
417 if (!user_cache_dir.exists() && !user_cache_dir.mkdir()) {
418 System.err.println("Warning: Unable to make directory: " + user_cache_dir);
419 }
420
421 // Check for ImageMagick
422 if (Gatherer.isGsdlRemote) {
423 DebugStream.println("Not checking for ImageMagick.");
424 }
425 else if (!(new ImageMagickTest()).found()) {
426 // Time for a warning message
427 missingImageMagick();
428 }
429
430 if (Gatherer.isGsdlRemote) {
431 DebugStream.println("Not checking for perl path/exe");
432 }
433 else {
434 // Perl path is a little different as it is perfectly ok to
435 // start the GLI without providing a perl path
436 boolean found_perl = false;
437 if (Configuration.perl_path != null) {
438 // See if the file pointed to actually exists
439 File perl_file = new File(Configuration.perl_path);
440 found_perl = perl_file.exists();
441 perl_file = null;
442 }
443 if (Configuration.perl_path == null || !found_perl) {
444 // Run test to see if we can run perl as is.
445 PerlTest perl_test = new PerlTest();
446 if (perl_test.found()) {
447 // If so replace the perl path with the system
448 // default (or null for unix).
449 Configuration.perl_path = perl_test.toString();
450 found_perl = true;
451 }
452 }
453 if (!found_perl) {
454 // Time for an error message.
455 missingPERL();
456 }
457 }
458
459 // Set the default font for all Swing components.
460 FontUIResource default_font = Configuration.getFont("general.font", true);
461 Enumeration keys = UIManager.getDefaults().keys();
462 while (keys.hasMoreElements()) {
463 Object key = keys.nextElement();
464 Object value = UIManager.get(key);
465 if (value instanceof FontUIResource) {
466 UIManager.put(key, default_font);
467 }
468 }
469
470 // At this point (which is where this code originally used to be), we can set up the proxy for the
471 // non-remote case. The remote Greenstone server would already have setup its proxy when required.
472 if(!isGsdlRemote) {
473 setProxy();
474 // Now we set up an Authenticator
475 Authenticator.setDefault(new GAuthenticator());
476 }
477 assoc_man = new FileAssociationManager();
478 // Create File Manager
479 f_man = new FileManager();
480 // Create Collection Manager
481 c_man = new CollectionManager();
482 // Create Recycle Bin
483 recycle_bin = new RecycleBin();
484
485 if (GS3) {
486 if (site_name==null) {
487 site_name = Configuration.site_name;
488 servlet_path = null; // need to reset this
489 }
490 if (servlet_path == null) {
491 servlet_path = Configuration.getServletPath();
492 }
493 }
494
495 open_collection_file_path = open_collection;
496 if (open_collection_file_path == null) {
497 open_collection_file_path = Configuration.getString(
498 "general.open_collection"+Configuration.gliPropertyNameSuffix(), true);
499 }
500 if (no_load || open_collection_file_path.equals("")) {
501 open_collection_file_path = null;
502 // collectDirectoryHasChanged(); // make sure gsdlsite.cfg's collecthome defaults to GS' collect
503 }
504
505 // If opening a collection outside the standard GS collect folder, need
506 // to open the non-standard collect folder that the collection resides in
507 if (open_collection_file_path != null &&
508 !open_collection_file_path.startsWith(getDefaultGSCollectDirectoryPath(true))) {
509 File collectFolder = null;
510 if(!open_collection_file_path.endsWith("gli.col")) { // then it's a collect folder
511 collectFolder = new File(open_collection_file_path);
512 } else {
513 // the filepath is a gli.col file. To get the collect folder: the 1st level
514 // up is collection folder, 2 two levels up is the containing collect folder
515 collectFolder = new File(open_collection_file_path).getParentFile().getParentFile();
516 }
517
518 // Need to deal with colgroups as well: while there's an etc/collect.cfg in the current
519 // collectFolder, move one level up
520 String cfg_file = (Gatherer.GS3)? Utility.CONFIG_GS3_FILE : Utility.CONFIG_FILE;
521 if(new File(collectFolder.getAbsolutePath()+File.separator+cfg_file).exists()) { // colgroup
522 collectFolder = collectFolder.getParentFile();
523 }
524
525 if(!isGsdlRemote && !collectFolder.exists()) {
526 // if dealing with a local server but the collectdir no longer exists,
527 // use the default greenstone collect directory, and write that to affected files
528 open_collection_file_path = null; // no longer have an open collection from last time if coldir doesn't exist
529
530 String defaultColDir = getDefaultGSCollectDirectoryPath(false); // no file separator at end
531
532 setCollectDirectoryPath(defaultColDir); // will ensure the required file separator at end
533
534 Configuration.setString("general.open_collection"+Configuration.gliPropertyNameSuffix(),
535 true, defaultColDir + File.separator);
536
537 if(Gatherer.GS3) { // GS2's gsdlsite.cfg was taken care of when LocalLibraryServer was started up
538 // (LocalLibraryServer would also already have set glisite.cfg to the correct collecthome)
539 String gsdlsitecfg = Configuration.gsdl3_path + File.separator
540 + "WEB-INF" + File.separator + "cgi" + File.separator + "gsdl3site.cfg";
541 Utility.updatePropertyConfigFile(gsdlsitecfg, "collecthome", defaultColDir); // no file separator
542 }
543 } else { // remote GS or collect dir exists
544 setCollectDirectoryPath(collectFolder.getAbsolutePath()); // now set this as the current collect folder
545 }
546 }
547 } catch (Exception exception) {
548 DebugStream.printStackTrace(exception);
549 }
550
551
552 // Create GUI Manager (last) or else suffer the death of a thousand NPE's
553 g_man = new GUIManager(size);
554
555 // Get a list of the core Greenstone classifiers and plugins
556 Classifiers.loadClassifiersList(null);
557 Plugins.loadPluginsList(null);
558
559 // If using a remote Greenstone we need to download the collection configurations now
560 if (Gatherer.isGsdlRemote) {
561 if (remoteGreenstoneServer.downloadCollectionConfigurations().equals("")) {
562 // !! Something went wrong downloading the collection configurations
563 System.err.println("Error: Could not download collection configurations.");
564 if(!Gatherer.isApplet) { // don't close the browser if it is an applet!
565 System.exit(0);
566 }
567 }
568 }
569 }
570
571
572 /** Returns the correct version of the (local or remote) Greenstone server if init() has already been called. */
573 public static int serverVersionNumber() {
574 return GS3 ? 3 : 2;
575 }
576
577 /** Returns "Server: version number" if init() has already been called. */
578 public static String getServerVersionAsString() {
579 return "Server: v" + serverVersionNumber();
580 }
581
582 public void openGUI()
583 {
584 // Size and place the frame on the screen
585 Rectangle bounds = Configuration.getBounds("general.bounds", true);
586 if (bounds == null) {
587 // Choose a sensible default value
588 bounds = new Rectangle(0, 0, 640, 480);
589 }
590
591 // Ensure width and height are reasonable
592 size = bounds.getSize();
593 if (size.width < 640) {
594 size.width = 640;
595 }
596 else if (size.width > Configuration.screen_size.width && Configuration.screen_size.width > 0) {
597 size.width = Configuration.screen_size.width;
598 }
599 if (size.height < 480) {
600 size.height = 480;
601 }
602 else if (size.height > Configuration.screen_size.height && Configuration.screen_size.height > 0) {
603 size.height = Configuration.screen_size.height;
604 }
605
606 if (!g_man_built) {
607
608 g_man.display();
609
610 // Place the window in the desired location on the screen, if this is do-able (not under most linux window managers apparently. In fact you're lucky if they listen to any of your screen size requests).
611 g_man.setLocation(bounds.x, bounds.y);
612 g_man.setVisible(true);
613
614 // After the window has been made visible, check that it is in the correct place
615 // sometimes java places a window not in the correct place,
616 // but with an offset. If so, we work out what the offset is
617 // and change the desired location to take that into account
618 Point location = g_man.getLocation();
619 int x_offset = bounds.x - location.x;
620 int y_offset = bounds.y - location.y;
621 // If not, offset the window to move it into the correct location
622 if (x_offset > 0 || y_offset > 0) {
623 ///ystem.err.println("changing the location to "+(bounds.x + x_offset)+" "+ (bounds.y + y_offset));
624 g_man.setLocation(bounds.x + x_offset, bounds.y + y_offset);
625 }
626
627 // The 'after-display' triggers several events which don't occur until after the visual components are actually available on screen. Examples of these would be the various html renderings, as they can't happen offscreen.
628 g_man.afterDisplay();
629 g_man_built = true;
630 }
631 else {
632 g_man.setVisible(true);
633 }
634
635 // Get a list of the core Greenstone classifiers and plugins
636 /*Classifiers.loadClassifiersList(null);
637 Plugins.loadPluginsList(null);
638
639 // If using a remote Greenstone we need to download the collection configurations now
640 if (Gatherer.isGsdlRemote) {
641 if (remoteGreenstoneServer.downloadCollectionConfigurations().equals("")) {
642 // !! Something went wrong downloading the collection configurations
643 System.err.println("Error: Could not download collection configurations.");
644 System.exit(0);
645 }
646 }*/
647
648 // If there was a collection left open last time, reopen it
649 if (open_collection_file_path == null) {
650
651 //the menu bar items, file and edit, are disabled from the moment of their creation. if there is no left-over collection from the last session, enable them; otherwise it is untill the collection finishes loading, will they be enabled in collectionManager.java
652 setMenuBarEnabled(true);
653 } else {
654
655 // If there was a collection left open last time, reopen it
656 c_man.openCollectionFromLastTime();
657 }
658 }
659
660 public static void setMenuBarEnabled(boolean enabled) {
661 g_man.menu_bar.file.setEnabled(enabled);
662 g_man.menu_bar.edit.setEnabled(enabled);
663 }
664
665 /** Exits the Gatherer after ensuring that things needing saving are saved.
666 * @see java.io.FileOutputStream
667 * @see java.io.PrintStream
668 * @see java.lang.Exception
669 * @see javax.swing.JOptionPane
670 * @see org.greenstone.gatherer.Configuration
671 * @see org.greenstone.gatherer.collection.CollectionManager
672 * @see org.greenstone.gatherer.gui.GUIManager
673 */
674 static public void exit(int new_exit_status)
675 {
676 DebugStream.println("In Gatherer.exit()...");
677 exit = true;
678 if (new_exit_status != 0) {
679 // default exit_status is already 0
680 // only remember a new exit status if it is non-trivial
681 exit_status = new_exit_status;
682 }
683
684 // Save the file associations
685 if (assoc_man != null) {
686 assoc_man.save();
687 assoc_man = null;
688 }
689
690 // Get the gui to deallocate
691 if(g_man != null) {
692 g_man.destroy();
693 g_man_built = false;
694 }
695
696 // Flush debug
697 DebugStream.closeDebugStream();
698
699 // If we started a server, we should try to stop it.
700 if (LocalLibraryServer.isRunning() == true) {
701 LocalLibraryServer.stop();
702 }
703
704 // If we're using a remote Greenstone server we need to make sure that all jobs have completed first
705 if (isGsdlRemote) {
706 remoteGreenstoneServer.exit();
707 }
708
709 // Make sure we haven't started up any processes that are still running
710 if (apps.size() == 0) {
711 // If we're running as an applet we don't actually quit (just hide the main GLI window)
712 if (!Gatherer.isApplet) {
713 // This is the end...
714 System.exit(exit_status);
715 }
716 }
717 else {
718 JOptionPane.showMessageDialog(g_man, Dictionary.get("General.Outstanding_Processes"), Dictionary.get("General.Outstanding_Processes_Title"), JOptionPane.ERROR_MESSAGE);
719 g_man.setVisible(false);
720 }
721 }
722
723 static public void exit()
724 {
725 exit(0);
726 }
727
728 /** Returns the path of the current collect directory. */
729 static public String getCollectDirectoryPath()
730 {
731 if (non_standard_collect_directory_path != null) {
732 return non_standard_collect_directory_path;
733 }
734
735 return getDefaultGSCollectDirectoryPath(true); // file separator appended
736
737 }
738
739 /** Returns the path of the Greenstone "collect" directory. */
740 static public String getDefaultGSCollectDirectoryPath(boolean appendSeparator) {
741 String colDir;
742 if (GS3) {
743 colDir = getSitesDirectoryPath() + Configuration.site_name + File.separator + "collect";
744 }
745 else {
746 colDir = Configuration.gsdl_path + "collect";
747 }
748
749 if(appendSeparator) {
750 colDir += File.separator;
751 }
752 return colDir;
753 }
754
755 /** Returns the path of the GLI directory. */
756 static public String getGLIDirectoryPath()
757 {
758 return gli_directory_path;
759 }
760
761
762 /** Returns the path of the GLI "metadata" directory. */
763 static public String getGLIMetadataDirectoryPath()
764 {
765 return getGLIDirectoryPath() + "metadata" + File.separator;
766 }
767
768
769 /** Returns the path of the GLI user directory. */
770 static public String getGLIUserDirectoryPath()
771 {
772 return gli_user_directory_path;
773 }
774
775
776 /** Returns the path of the GLI user "cache" directory. */
777 static public String getGLIUserCacheDirectoryPath()
778 {
779 return getGLIUserDirectoryPath() + "cache" + File.separator;
780 }
781
782
783 /** Returns the path of the GLI user "log" directory. */
784 static public String getGLIUserLogDirectoryPath()
785 {
786 return getGLIUserDirectoryPath() + "log" + File.separator;
787 }
788
789
790 static public String getSitesDirectoryPath()
791 {
792 return Configuration.gsdl3_path + "sites" + File.separator;
793 }
794
795
796 static public void setCollectDirectoryPath(String collect_directory_path)
797 {
798 non_standard_collect_directory_path = collect_directory_path;
799 if (!non_standard_collect_directory_path.endsWith(File.separator)) {
800 non_standard_collect_directory_path = non_standard_collect_directory_path + File.separator;
801 }
802 }
803
804
805 static public void setGLIDirectoryPath(String gli_directory_path_arg)
806 {
807 gli_directory_path = gli_directory_path_arg;
808 }
809
810
811 static public void setGLIUserDirectoryPath(String gli_user_directory_path_arg)
812 {
813 gli_user_directory_path = gli_user_directory_path_arg;
814
815 // Ensure the GLI user directory exists
816 File gli_user_directory = new File(gli_user_directory_path);
817 if (!gli_user_directory.exists() && !gli_user_directory.mkdirs()) {
818 System.err.println("Error: Unable to make directory: " + gli_user_directory);
819 }
820 }
821
822
823 public static void collectDirectoryHasChanged(String oldCollectPath, String newCollectPath) {
824 if(oldCollectPath.equals(newCollectPath)) {
825 return; // nothing to be done
826 }
827
828 // first save any open collection in the old location, then close it
829 if(Gatherer.c_man.getCollection() != null) {
830 Gatherer.g_man.saveThenCloseCurrentCollection(); // close the current collection first
831 }
832
833 // change to new collect path
834 Configuration.setString("general.open_collection"+Configuration.gliPropertyNameSuffix(),
835 true, newCollectPath);
836 Gatherer.setCollectDirectoryPath(newCollectPath);
837
838
839 // refresh the Documents in Greenstone Collections
840 //WorkspaceTreeModel.refreshGreenstoneCollectionsNode();
841 Gatherer.g_man.refreshWorkspaceTreeGreenstoneCollections();
842
843 // The web server needs to be told where a new (non-standard) collecthome home is.
844 // The web server reads collecthome from cgi-bin/gsdlsite.cfg, where the property
845 // collecthome can be specified if a non-standard collecthome is to be used. If no
846 // such property is specified in the file, then it assumes the standard GS collecthome.
847 // This method does nothing for a remote Greenstone.
848 if(Gatherer.isGsdlRemote) {
849 return;
850 }
851
852 String gsdlsitecfg = "";
853 if(Gatherer.GS3) { // web/WEB-INF/cgi/gsdl3site.cfg
854 gsdlsitecfg = Configuration.gsdl3_path + File.separator + "WEB-INF"
855 + File.separator + "cgi" + File.separator + "gsdl3site.cfg";
856 } else { // cgi-bin/gsdlsite.cfg
857 gsdlsitecfg = Configuration.gsdl_path + File.separator
858 + "cgi-bin" + File.separator + "gsdlsite.cfg";
859 }
860
861 // non-destructive update of gsdl(3)site.cfg (comments preserved)
862 String collectDir = Gatherer.getCollectDirectoryPath();
863 //collectDir = "\"" + collectDir.substring(0, collectDir.length()-1) + "\""; // remove file separator at end
864 collectDir = collectDir.substring(0, collectDir.length()-1); // remove file separator at end
865 Utility.updatePropertyConfigFile(gsdlsitecfg, "collecthome", collectDir);
866
867 if(!Gatherer.GS3 && Gatherer.isLocalLibrary) {
868 // for Images in the collection to work, the apache web server
869 // configuration's COLLECTHOME should be updated on collectdir change.
870 // Does nothing for server.exe at the moment
871
872 LocalLibraryServer.reconfigure();
873 }
874 }
875
876
877 static public void refresh(int refresh_reason)
878 {
879 if (g_man != null) {
880
881 g_man.refresh(refresh_reason, c_man.ready());
882 }
883
884 // Now is a good time to force a garbage collect
885 System.gc();
886 }
887
888
889 // used to send reload coll messages to the tomcat server
890 static public void configGS3Server(String site, String command) {
891 if (Configuration.library_url == null){
892 System.out.println("Error: you have not provided the Greenstone Library address.");
893 return;
894
895 }
896
897 try {
898 // need to add the servlet name to the exec address
899 String raw_url = Configuration.library_url.toString() + Configuration.getServletPath() + command;
900 URL url = new URL(raw_url);
901 DebugStream.println("Action: " + raw_url);
902 HttpURLConnection library_connection = (HttpURLConnection) url.openConnection();
903 int response_code = library_connection.getResponseCode();
904 if(HttpURLConnection.HTTP_OK <= response_code && response_code < HttpURLConnection.HTTP_MULT_CHOICE) {
905 DebugStream.println("200 - Complete.");
906 }
907 else {
908 DebugStream.println("404 - Failed.");
909 }
910 url = null;
911 }
912 catch(java.net.ConnectException connectException) {
913 JOptionPane.showMessageDialog(g_man, Dictionary.get("Preferences.Connection.Library_Path_Connection_Failure", Configuration.library_url.toString()), Dictionary.get("General.Warning"), JOptionPane.WARNING_MESSAGE);
914 DebugStream.println(connectException.getMessage());
915 }
916 catch (Exception exception) {
917 DebugStream.printStackTrace(exception);
918 }
919 }
920
921
922 /** Used to 'spawn' a new child application when a file is double clicked.
923 * @param file The file to open
924 * @see org.greenstone.gatherer.Gatherer.ExternalApplication
925 */
926 static public void spawnApplication(File file) {
927 String [] commands = assoc_man.getCommand(file);
928 if(commands != null) {
929 ExternalApplication app = new ExternalApplication(commands);
930 apps.add(app);
931 app.start();
932 }
933 else {
934 ///ystem.err.println("No open command available.");
935 }
936 }
937
938
939 static public void spawnApplication(String command)
940 {
941 ExternalApplication app = new ExternalApplication(command);
942 apps.add(app);
943 app.start();
944 }
945
946 static public void spawnApplication(String command, String ID)
947 {
948 ExternalApplication app = new ExternalApplication(command, ID);
949 apps.add(app);
950 app.start();
951 }
952
953 static public void spawnApplication(String[] commands, String ID)
954 {
955 ExternalApplication app = new ExternalApplication(commands, ID);
956 apps.add(app);
957 app.start();
958 }
959
960 static public void terminateApplication(String ID) {
961 for(int i = 0; i < apps.size(); i++) {
962 ExternalApplication app = (ExternalApplication)apps.get(i);
963 if(app.getID() != null && app.getID().equals(ID)) {
964 app.stopExternalApplication();
965 apps.remove(app);
966 }
967 }
968 }
969
970
971 /** Used to 'spawn' a new browser application or reset an existing one when the preview button is clicked
972 * @param url The url to open the browser at
973 * @see org.greenstone.gatherer.Gatherer.BrowserApplication
974 */
975 static public void spawnBrowser(String url) {
976 String command = assoc_man.getBrowserCommand(url);
977 if (command != null) {
978 BrowserApplication app = new BrowserApplication(command, url);
979 apps.add(app);
980 app.start();
981 }
982 else {
983 ///ystem.err.println("No browser command available.");
984 }
985 }
986
987
988 /** Prints a warning message about a missing library path, which means the final collection cannot be previewed in the Gatherer.
989 */
990 static public void missingEXEC() {
991 WarningDialog dialog;
992 String configPropertyName = "general.library_url"+Configuration.gliPropertyNameSuffix();
993
994 if (GS3) {
995 // Warning dialog with no cancel button and no "turn off warning" checkbox
996 dialog = new WarningDialog("warning.MissingEXEC", Dictionary.get("MissingEXEC_GS3.Title"), Dictionary.get("MissingEXEC_GS3.Message"), configPropertyName, false, false);
997 } else { // local case
998 dialog = new WarningDialog("warning.MissingEXEC", Dictionary.get("MissingEXEC.Title"), Dictionary.get("MissingEXEC.Message"), configPropertyName, false);
999 }
1000
1001 JTextField field = new URLField.Text(Configuration.getColor("coloring.editable_foreground", false), Configuration.getColor("coloring.editable_background", false));
1002
1003 // Set the default library URL to the tomcat server and port number
1004 // specified in the build.properties located in the gsdl3_src_path
1005 if (GS3) {
1006 String host = "localhost";
1007 String port = "8080";
1008
1009 File buildPropsFile = new File(Configuration.gsdl3_src_path + File.separator + "build.properties");
1010 if(buildPropsFile.exists()) {
1011 Properties props = new Properties();
1012 try{
1013 props.load(new FileInputStream(buildPropsFile));
1014 host = props.getProperty("tomcat.server", host);
1015 port = props.getProperty("tomcat.port", port);
1016 }catch(Exception e){
1017 DebugStream.println("Could not load build.properties file");
1018 System.err.println("Could not load build.properties file");
1019 }
1020 props = null;
1021 }
1022 String defaultURL = "http://"+host+":"+port+"/"+"greenstone3";
1023 field.setText(defaultURL);
1024 field.selectAll();
1025 }
1026 dialog.setValueField(field);
1027 dialog.display();
1028 dialog.dispose();
1029 dialog = null;
1030
1031 String library_url_string = Configuration.getString(configPropertyName, true);
1032 if (!library_url_string.equals("")) {
1033 try {
1034 // WarningDialog does not allow invalid URLs, so the following is ignored:
1035 // make sure the URL the user provided contains the http:// prefix
1036 // and then save the corrected URL
1037 if(!library_url_string.startsWith("http://")
1038 && !library_url_string.startsWith("https://")) {
1039 library_url_string = "http://"+library_url_string;
1040 Configuration.setString(configPropertyName, true, configPropertyName);
1041 }
1042 Configuration.library_url = new URL(library_url_string);
1043 }
1044 catch (MalformedURLException exception) {
1045 DebugStream.printStackTrace(exception);
1046 }
1047 }
1048 }
1049
1050
1051
1052 /** Prints a warning message about a missing library path, which means the final collection cannot be previewed in the Gatherer.
1053 */
1054 static private void popupFedoraInfo() {
1055
1056 FedoraLogin dialog = new FedoraLogin("Fedora Login", false);
1057
1058 if (Configuration.library_url == null) {
1059
1060 String library_url_string = dialog.getLibraryURL();
1061 if (!library_url_string.equals("")) {
1062 try {
1063 Configuration.library_url = new URL(library_url_string);
1064 }
1065 catch (MalformedURLException exception) {
1066 DebugStream.printStackTrace(exception);
1067 }
1068 }
1069 }
1070
1071 boolean showLogin = true;
1072 do {
1073 if(!dialog.loginRequested()) { // user pressed cancel to exit the FedoraLogin dialog
1074 System.exit(0);
1075 } else {
1076 showLogin = dialog.loginRequested();
1077 String hostname = dialog.getHostname();
1078 String port = dialog.getPort();
1079 String username = dialog.getUsername();
1080 String password = dialog.getPassword();
1081 String protocol = dialog.getProtocol();
1082
1083 Configuration.fedora_info.setHostname(hostname);
1084 Configuration.fedora_info.setPort(port);
1085 Configuration.fedora_info.setUsername(username);
1086 Configuration.fedora_info.setPassword(password);
1087 Configuration.fedora_info.setProtocol(protocol);
1088
1089 String ping_url_str = protocol + "://" + hostname + ":" + port + "/fedora";
1090 String login_str = username + ":" + password;
1091
1092 String login_encoding = Base64.encodeBytes(login_str.getBytes());
1093
1094 try {
1095 URL ping_url = new URL(ping_url_str);
1096 URLConnection uc = ping_url.openConnection();
1097 uc.setRequestProperty ("Authorization", "Basic " + login_encoding);
1098 // Attempt to access some content ...
1099 InputStream content = (InputStream)uc.getInputStream();
1100
1101 // if no exception occurred in the above, we would have come here:
1102 showLogin = false;
1103 dialog.dispose();
1104 }
1105 catch (Exception exception) {
1106 // TODO: move into dictionary
1107 String[] errorMessage = {"Failed to connect to the Fedora server.", "It might not be running, or",
1108 "incorrect username and/or password."};
1109 dialog.setErrorMessage(errorMessage);
1110 //DebugStream.printStackTrace(exception);
1111 // exception occurred, show the dialog again (do this after printing to
1112 // debugStream, else the above does not get done for some reason).
1113 dialog.setVisible(true);
1114 }
1115 }
1116 } while(showLogin);
1117
1118 dialog = null; // no more need of the dialog
1119
1120 // Now we are connected.
1121 }
1122
1123
1124
1125 static private void requestGLIServerURL()
1126 {
1127 WarningDialog dialog;
1128 String[] defaultURLs = {
1129 "http://localhost:8080/greenstone3/cgi-bin/gliserver.pl",
1130 "http://localhost:8080/gsdl/cgi-bin/gliserver.pl"
1131 };
1132
1133 // Warning dialog with no cancel button and no "turn off warning" checkbox
1134 // (since user-input of the gliserver script is mandatory)
1135 dialog = new WarningDialog("warning.MissingGLIServer", Dictionary.get("MissingGLIServer.Title"), Dictionary.get("MissingGLIServer.Message"), "general.gliserver_url", false, false);
1136
1137 dialog.setValueField(new URLField.DropDown(Configuration.getColor("coloring.editable_foreground", false),
1138 Configuration.getColor("coloring.editable_background", false),
1139 defaultURLs, "general.gliserver_url",
1140 "general.open_collection"+Configuration.gliPropertyNameSuffix(),
1141 "gliserver.pl"));
1142
1143 if (Gatherer.default_gliserver_url!=null){
1144 dialog.setValueField(Gatherer.default_gliserver_url.toString());
1145 }
1146
1147 // A WarningDialog cannot always be made to respond (let alone to exit the program) on close. We
1148 // handle the response of this particular WarningDialog here: a URL for gliserver.pl is a crucial
1149 // piece of user-provided data. Therefore, if no URL was entered for gliserver.pl, it'll exit safely.
1150 dialog.addWindowListener(new WindowAdapter() {
1151 public void windowClosing(WindowEvent e) {
1152 Gatherer.exit();
1153 }
1154 });
1155
1156 dialog.display();
1157 dialog.dispose();
1158 dialog = null;
1159
1160
1161 String gliserver_url_string = Configuration.getString("general.gliserver_url", true);
1162 if (!gliserver_url_string.equals("")) {
1163 try {
1164 Configuration.gliserver_url = new URL(gliserver_url_string);
1165 Configuration.setString("general.gliserver_url", true, gliserver_url_string);
1166 }
1167 catch (MalformedURLException exception) {
1168 DebugStream.printStackTrace(exception);
1169 }
1170 }
1171 }
1172
1173
1174 /** Prints a warning message about a missing GSDL path, which although not fatal pretty much ensures nothing will work properly in the GLI.
1175 */
1176 static private void missingGSDL() {
1177 WarningDialog dialog = new WarningDialog("warning.MissingGSDL", Dictionary.get("MissingGSDL.Title"), Dictionary.get("MissingGSDL.Message"), null, false);
1178 dialog.display();
1179 dialog.dispose();
1180 dialog = null;
1181 }
1182
1183 /** Prints a warning message about missing a valid ImageMagick path, which although not fatal means building image collections won't work */
1184 static private void missingImageMagick() {
1185 WarningDialog dialog = new WarningDialog("warning.MissingImageMagick", Dictionary.get("MissingImageMagick.Title"), Dictionary.get("MissingImageMagick.Message"), null, false);
1186 dialog.display();
1187 dialog.dispose();
1188 dialog = null;
1189 }
1190
1191 /** Prints a warning message about missing a valid PERL path, which although not fatal pretty much ensures no collection creation/building will work properly in the GLI. */
1192 static private void missingPERL() {
1193 WarningDialog dialog = new WarningDialog("warning.MissingPERL", Dictionary.get("MissingPERL.Title"), Dictionary.get("MissingPERL.Message"), null, false);
1194 dialog.display();
1195 dialog.dispose();
1196 dialog = null;
1197 }
1198
1199
1200 /** Sets up the proxy connection by setting JVM Environment flags and creating a new Authenticator.
1201 * @see java.lang.Exception
1202 * @see java.lang.System
1203 * @see java.net.Authenticator
1204 * @see org.greenstone.gatherer.Configuration
1205 * @see org.greenstone.gatherer.GAuthenticator
1206 */
1207 static public void setProxy() {
1208 try {// Can throw several exceptions
1209 if(Configuration.get("general.use_proxy", true)) {
1210 System.setProperty("http.proxyType", "4");
1211 System.setProperty("http.proxyHost", Configuration.getString("general.proxy_host", true));
1212 System.setProperty("http.proxyPort", Configuration.getString("general.proxy_port", true));
1213 System.setProperty("http.proxySet", "true");
1214 } else {
1215 System.setProperty("http.proxyHost", "");
1216 System.setProperty("http.proxyPort", "");
1217 System.setProperty("http.proxySet", "false");
1218 }
1219 } catch (Exception error) {
1220 DebugStream.println("Error in Gatherer.initProxy(): " + error);
1221 DebugStream.printStackTrace(error);
1222 }
1223 }
1224
1225
1226 /** This private class contains an instance of an external application running within a JVM shell. It is important that this process sits in its own thread, but its more important that when we exit the Gatherer we don't actually System.exit(0) the Gatherer object until the user has volunteerily ended all of these child processes. Otherwise when we quit the Gatherer any changes the users may have made in external programs will be lost and the child processes are automatically deallocated. */
1227 static private class ExternalApplication
1228 extends Thread {
1229 private Process process = null;
1230 /** The initial command string given to this sub-process. */
1231 private String command = null;
1232 private String[] commands = null;
1233
1234 private String ID = null;
1235
1236 /** Constructor.
1237 * @param command The initial command <strong>String</strong>.
1238 */
1239 public ExternalApplication(String command) {
1240 this.command = command;
1241 }
1242
1243 public ExternalApplication(String[] commands) {
1244 this.commands = commands;
1245 }
1246
1247 public ExternalApplication(String command, String ID) {
1248 this.command = command;
1249 this.ID = ID;
1250 }
1251
1252 public ExternalApplication(String[] commands, String ID) {
1253 this.commands = commands;
1254 this.ID = ID;
1255 }
1256
1257 public String getID() {
1258 return ID;
1259 }
1260
1261 /** We start the child process inside a new thread so it doesn't block the rest of Gatherer.
1262 * @see java.lang.Exception
1263 * @see java.lang.Process
1264 * @see java.lang.Runtime
1265 * @see java.lang.System
1266 * @see java.util.Vector
1267 */
1268 public void run() {
1269 // Call an external process using the args.
1270 try {
1271 if(commands != null) {
1272 StringBuffer whole_command = new StringBuffer();
1273 for(int i = 0; i < commands.length; i++) {
1274 whole_command.append(commands[i]);
1275 whole_command.append(" ");
1276 }
1277 DebugStream.println("Running " + whole_command.toString());
1278 Runtime rt = Runtime.getRuntime();
1279 process = rt.exec(commands);
1280 process.waitFor();
1281 }
1282 else {
1283 DebugStream.println("Running " + command);
1284 Runtime rt = Runtime.getRuntime();
1285 process = rt.exec(command);
1286 process.waitFor();
1287 }
1288 }
1289 catch (Exception exception) {
1290 DebugStream.printStackTrace(exception);
1291 }
1292 // Remove ourself from Gatherer list of threads.
1293 apps.remove(this);
1294 // Call exit if we were the last outstanding child process thread.
1295 if (apps.size() == 0 && exit == true) {
1296 // In my opinion (DB) there is no need to exit here,
1297 // the 'run' method ending naturally brings this
1298 // thread to an end. In fact it is potentially
1299 // dangerous to exit here, as the main thread in the
1300 // Gatherer class may be stopped prematurely. As it so
1301 // happens the point at which the ExternalApplication thread
1302 // is asked to stop (Back in the main Gatherer thread) is after
1303 // various configuration files have been saved.
1304 //
1305 // A similar argument holds for BrowserApplication thread below.
1306 System.exit(exit_status);
1307 }
1308 }
1309 public void stopExternalApplication() {
1310 if(process != null) {
1311 process.destroy();
1312 }
1313 }
1314 }
1315 /** This private class contains an instance of an external application running within a JVM shell. It is important that this process sits in its own thread, but its more important that when we exit the Gatherer we don't actually System.exit(0) the Gatherer object until the user has volunteerily ended all of these child processes. Otherwise when we quit the Gatherer any changes the users may have made in external programs will be lost and the child processes are automatically deallocated. */
1316 static private class BrowserApplication
1317 extends Thread {
1318 private Process process = null;
1319 /** The initial command string given to this sub-process. */
1320 private String command = null;
1321 private String url = null;
1322 private String[] commands = null;
1323
1324 public BrowserApplication(String command, String url) {
1325 StringTokenizer st = new StringTokenizer(command);
1326 int num_tokens = st.countTokens();
1327 this.commands = new String [num_tokens];
1328 int i=0;
1329 while (st.hasMoreTokens()) {
1330 commands[i] = st.nextToken();
1331 i++;
1332 }
1333 //this.commands = commands;
1334 this.url = url;
1335 }
1336 /** We start the child process inside a new thread so it doesn't block the rest of Gatherer.
1337 * @see java.lang.Exception
1338 * @see java.lang.Process
1339 * @see java.lang.Runtime
1340 * @see java.lang.System
1341 * @see java.util.Vector
1342 */
1343 public void run() {
1344 // Call an external process using the args.
1345 if(commands == null) {
1346 apps.remove(this);
1347 return;
1348 }
1349 try {
1350 String prog_name = commands[0];
1351 String lower_name = prog_name.toLowerCase();
1352 if (lower_name.indexOf("mozilla") != -1 || lower_name.indexOf("netscape") != -1) {
1353 DebugStream.println("found mozilla or netscape, trying remote it");
1354 // mozilla and netscape, try using a remote command to get things in the same window
1355 String [] new_commands = new String[] {prog_name, "-raise", "-remote", "openURL("+url+",new-tab)"};
1356 printArray(new_commands);
1357
1358 Runtime rt = Runtime.getRuntime();
1359 process = rt.exec(new_commands);
1360 int exitCode = process.waitFor();
1361 if (exitCode != 0) { // if Netscape or mozilla was not open
1362 DebugStream.println("couldn't do remote, trying original command");
1363 printArray(commands);
1364 process = rt.exec(commands); // try the original command
1365 }
1366 } else {
1367 // just run what we have been given
1368 StringBuffer whole_command = new StringBuffer();
1369 for(int i = 0; i < commands.length; i++) {
1370 whole_command.append(commands[i]);
1371 whole_command.append(" ");
1372 }
1373 DebugStream.println("Running " + whole_command.toString());
1374 Runtime rt = Runtime.getRuntime();
1375 process = rt.exec(commands);
1376 process.waitFor();
1377 }
1378 }
1379
1380 catch (Exception exception) {
1381 DebugStream.printStackTrace(exception);
1382 }
1383 // Remove ourself from Gatherer list of threads.
1384 apps.remove(this);
1385 // Call exit if we were the last outstanding child process thread.
1386 if (apps.size() == 0 && exit == true) {
1387 System.exit(exit_status);
1388 }
1389 }
1390 public void printArray(String [] array) {
1391 for(int i = 0; i < array.length; i++) {
1392 DebugStream.print(array[i]+" ");
1393 System.err.println(array[i]+" ");
1394 }
1395 }
1396 public void stopBrowserApplication() {
1397 if(process != null) {
1398 process.destroy();
1399 }
1400 }
1401 }
1402
1403
1404 private class ImageMagickTest
1405 {
1406 public boolean found()
1407 {
1408 try {
1409 String[] command = new String[2];
1410 command[0] = (Utility.isWindows() ? "identify.exe" : "identify");
1411 command[1] = "-version";
1412 Process image_magick_process = Runtime.getRuntime().exec(command);
1413 image_magick_process.waitFor();
1414
1415 //new way of detection of ImageMagick
1416 InputStreamReader isr = new InputStreamReader(image_magick_process.getInputStream());
1417
1418 BufferedReader br = new BufferedReader(isr);
1419 // Capture the standard output stream and seach for two particular occurances: Version and ImageMagick.
1420
1421 String line = br.readLine();
1422 if (line == null) {
1423 return false;
1424 }
1425 String lc_line = line.toLowerCase();
1426 if (lc_line.indexOf("version") != -1 || lc_line.indexOf("imagemagick") != -1) {
1427 return true;
1428 } else {
1429 return false;
1430 }
1431
1432 //return (image_magick_process.exitValue() == 0);
1433 }
1434 catch (IOException exception) {
1435 return false;
1436 }
1437 catch (InterruptedException exception) {
1438 return false;
1439 }
1440 }
1441 }
1442
1443
1444 private class PerlTest
1445 {
1446 private String[] command = new String[2];
1447
1448 public PerlTest()
1449 {
1450 command[0] = (Utility.isWindows() ? Utility.PERL_EXECUTABLE_WINDOWS : Utility.PERL_EXECUTABLE_UNIX);
1451 command[1] = "-version";
1452 }
1453
1454 public boolean found()
1455 {
1456 try {
1457 Process perl_process = Runtime.getRuntime().exec(command);
1458 perl_process.waitFor();
1459 return (perl_process.exitValue() == 0);
1460 }
1461 catch (Exception exception) {
1462 return false;
1463 }
1464 }
1465
1466 public String toString() {
1467 return command[0];
1468 }
1469 }
1470}
Note: See TracBrowser for help on using the repository browser.