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

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

More changes for ticket 152: making the collectdir moveable. When using server.exe, if GLI was last shutdown when another collectdir was active, this needs to be read in from the user config.xml by GLI, and server.exe needs to use it.

  • Property svn:keywords set to Author Date Id Revision
File size: 52.8 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(getCollectDirectoryPath())) {
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 setCollectDirectoryPath(collectFolder.getAbsolutePath()); // now set this as the current collect folder
526 }
527
528 }
529 catch (Exception exception) {
530 DebugStream.printStackTrace(exception);
531 }
532
533
534 // Create GUI Manager (last) or else suffer the death of a thousand NPE's
535 g_man = new GUIManager(size);
536
537 // Get a list of the core Greenstone classifiers and plugins
538 Classifiers.loadClassifiersList(null);
539 Plugins.loadPluginsList(null);
540
541 // If using a remote Greenstone we need to download the collection configurations now
542 if (Gatherer.isGsdlRemote) {
543 if (remoteGreenstoneServer.downloadCollectionConfigurations().equals("")) {
544 // !! Something went wrong downloading the collection configurations
545 System.err.println("Error: Could not download collection configurations.");
546 if(!Gatherer.isApplet) { // don't close the browser if it is an applet!
547 System.exit(0);
548 }
549 }
550 }
551 }
552
553
554 /** Returns the correct version of the (local or remote) Greenstone server if init() has already been called. */
555 public static int serverVersionNumber() {
556 return GS3 ? 3 : 2;
557 }
558
559 /** Returns "Server: version number" if init() has already been called. */
560 public static String getServerVersionAsString() {
561 return "Server: v" + serverVersionNumber();
562 }
563
564 public void openGUI()
565 {
566 // Size and place the frame on the screen
567 Rectangle bounds = Configuration.getBounds("general.bounds", true);
568 if (bounds == null) {
569 // Choose a sensible default value
570 bounds = new Rectangle(0, 0, 640, 480);
571 }
572
573 // Ensure width and height are reasonable
574 size = bounds.getSize();
575 if (size.width < 640) {
576 size.width = 640;
577 }
578 else if (size.width > Configuration.screen_size.width && Configuration.screen_size.width > 0) {
579 size.width = Configuration.screen_size.width;
580 }
581 if (size.height < 480) {
582 size.height = 480;
583 }
584 else if (size.height > Configuration.screen_size.height && Configuration.screen_size.height > 0) {
585 size.height = Configuration.screen_size.height;
586 }
587
588 if (!g_man_built) {
589
590 g_man.display();
591
592 // 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).
593 g_man.setLocation(bounds.x, bounds.y);
594 g_man.setVisible(true);
595
596 // After the window has been made visible, check that it is in the correct place
597 // sometimes java places a window not in the correct place,
598 // but with an offset. If so, we work out what the offset is
599 // and change the desired location to take that into account
600 Point location = g_man.getLocation();
601 int x_offset = bounds.x - location.x;
602 int y_offset = bounds.y - location.y;
603 // If not, offset the window to move it into the correct location
604 if (x_offset > 0 || y_offset > 0) {
605 ///ystem.err.println("changing the location to "+(bounds.x + x_offset)+" "+ (bounds.y + y_offset));
606 g_man.setLocation(bounds.x + x_offset, bounds.y + y_offset);
607 }
608
609 // 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.
610 g_man.afterDisplay();
611 g_man_built = true;
612 }
613 else {
614 g_man.setVisible(true);
615 }
616
617 // Get a list of the core Greenstone classifiers and plugins
618 /*Classifiers.loadClassifiersList(null);
619 Plugins.loadPluginsList(null);
620
621 // If using a remote Greenstone we need to download the collection configurations now
622 if (Gatherer.isGsdlRemote) {
623 if (remoteGreenstoneServer.downloadCollectionConfigurations().equals("")) {
624 // !! Something went wrong downloading the collection configurations
625 System.err.println("Error: Could not download collection configurations.");
626 System.exit(0);
627 }
628 }*/
629
630 // If there was a collection left open last time, reopen it
631 if (open_collection_file_path == null) {
632
633 //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
634 setMenuBarEnabled(true);
635 } else {
636
637 // If there was a collection left open last time, reopen it
638 c_man.openCollectionFromLastTime();
639 }
640 }
641
642 public static void setMenuBarEnabled(boolean enabled) {
643 g_man.menu_bar.file.setEnabled(enabled);
644 g_man.menu_bar.edit.setEnabled(enabled);
645 }
646
647 /** Exits the Gatherer after ensuring that things needing saving are saved.
648 * @see java.io.FileOutputStream
649 * @see java.io.PrintStream
650 * @see java.lang.Exception
651 * @see javax.swing.JOptionPane
652 * @see org.greenstone.gatherer.Configuration
653 * @see org.greenstone.gatherer.collection.CollectionManager
654 * @see org.greenstone.gatherer.gui.GUIManager
655 */
656 static public void exit(int new_exit_status)
657 {
658 DebugStream.println("In Gatherer.exit()...");
659 exit = true;
660 if (new_exit_status != 0) {
661 // default exit_status is already 0
662 // only remember a new exit status if it is non-trivial
663 exit_status = new_exit_status;
664 }
665
666 // Save the file associations
667 if (assoc_man != null) {
668 assoc_man.save();
669 assoc_man = null;
670 }
671
672 // Get the gui to deallocate
673 if(g_man != null) {
674 g_man.destroy();
675 g_man_built = false;
676 }
677
678 // Flush debug
679 DebugStream.closeDebugStream();
680
681 // If we started a server, we should try to stop it.
682 if (LocalLibraryServer.isRunning() == true) {
683 LocalLibraryServer.stop();
684 }
685
686 // If we're using a remote Greenstone server we need to make sure that all jobs have completed first
687 if (isGsdlRemote) {
688 remoteGreenstoneServer.exit();
689 }
690
691 // Make sure we haven't started up any processes that are still running
692 if (apps.size() == 0) {
693 // If we're running as an applet we don't actually quit (just hide the main GLI window)
694 if (!Gatherer.isApplet) {
695 // This is the end...
696 System.exit(exit_status);
697 }
698 }
699 else {
700 JOptionPane.showMessageDialog(g_man, Dictionary.get("General.Outstanding_Processes"), Dictionary.get("General.Outstanding_Processes_Title"), JOptionPane.ERROR_MESSAGE);
701 g_man.setVisible(false);
702 }
703 }
704
705 static public void exit()
706 {
707 exit(0);
708 }
709
710 /** Returns the path of the current collect directory. */
711 static public String getCollectDirectoryPath()
712 {
713 if (non_standard_collect_directory_path != null) {
714 return non_standard_collect_directory_path;
715 }
716
717 return getDefaultGSCollectDirectoryPath();
718
719 }
720
721 /** Returns the path of the Greenstone "collect" directory. */
722 static public String getDefaultGSCollectDirectoryPath() {
723 if (!GS3) {
724 return Configuration.gsdl_path + "collect" + File.separator;
725 }
726 else {
727 return getSitesDirectoryPath() + Configuration.site_name + File.separator + "collect" + File.separator;
728 }
729 }
730
731 /** Returns the path of the GLI directory. */
732 static public String getGLIDirectoryPath()
733 {
734 return gli_directory_path;
735 }
736
737
738 /** Returns the path of the GLI "metadata" directory. */
739 static public String getGLIMetadataDirectoryPath()
740 {
741 return getGLIDirectoryPath() + "metadata" + File.separator;
742 }
743
744
745 /** Returns the path of the GLI user directory. */
746 static public String getGLIUserDirectoryPath()
747 {
748 return gli_user_directory_path;
749 }
750
751
752 /** Returns the path of the GLI user "cache" directory. */
753 static public String getGLIUserCacheDirectoryPath()
754 {
755 return getGLIUserDirectoryPath() + "cache" + File.separator;
756 }
757
758
759 /** Returns the path of the GLI user "log" directory. */
760 static public String getGLIUserLogDirectoryPath()
761 {
762 return getGLIUserDirectoryPath() + "log" + File.separator;
763 }
764
765
766 static public String getSitesDirectoryPath()
767 {
768 return Configuration.gsdl3_path + "sites" + File.separator;
769 }
770
771
772 static public void setCollectDirectoryPath(String collect_directory_path)
773 {
774 non_standard_collect_directory_path = collect_directory_path;
775 if (!non_standard_collect_directory_path.endsWith(File.separator)) {
776 non_standard_collect_directory_path = non_standard_collect_directory_path + File.separator;
777 }
778 }
779
780
781 static public void setGLIDirectoryPath(String gli_directory_path_arg)
782 {
783 gli_directory_path = gli_directory_path_arg;
784 }
785
786
787 static public void setGLIUserDirectoryPath(String gli_user_directory_path_arg)
788 {
789 gli_user_directory_path = gli_user_directory_path_arg;
790
791 // Ensure the GLI user directory exists
792 File gli_user_directory = new File(gli_user_directory_path);
793 if (!gli_user_directory.exists() && !gli_user_directory.mkdirs()) {
794 System.err.println("Error: Unable to make directory: " + gli_user_directory);
795 }
796 }
797
798
799 public static void collectDirectoryHasChanged(String oldCollectPath, String newCollectPath) {
800 if(oldCollectPath.equals(newCollectPath)) {
801 return; // nothing to be done
802 }
803
804 // first save any open collection in the *old* location
805 if(Gatherer.c_man.getCollection() != null) {
806 Gatherer.setCollectDirectoryPath(oldCollectPath); // go back to current collection's location
807 Gatherer.g_man.saveThenCloseCurrentCollection(); // close the current collection first
808 }
809
810 // change to new collect path
811 Configuration.setString("general.open_collection"+Configuration.gliPropertyNameSuffix(),
812 true, newCollectPath);
813 Gatherer.setCollectDirectoryPath(newCollectPath);
814
815
816 // refresh the Documents in Greenstone Collections
817 //WorkspaceTreeModel.refreshGreenstoneCollectionsNode();
818 Gatherer.g_man.refreshWorkspaceTreeGreenstoneCollections();
819
820 // The web server needs to be told where a new (non-standard) collecthome home is.
821 // The web server reads collecthome from cgi-bin/gsdlsite.cfg, where the property
822 // collecthome can be specified if a non-standard collecthome is to be used. If no
823 // such property is specified in the file, then it assumes the standard GS collecthome.
824 // This method does nothing for a remote Greenstone.
825 if(Gatherer.isGsdlRemote) {
826 return;
827 }
828
829 String gsdlsitecfg = "";
830 if(Gatherer.GS3) { // web/WEB-INF/cgi/gsdl3site.cfg
831 gsdlsitecfg = Configuration.gsdl3_path + File.separator + "WEB-INF"
832 + File.separator + "cgi" + File.separator + "gsdl3site.cfg";
833 } else { // cgi-bin/gsdlsite.cfg
834 gsdlsitecfg = Configuration.gsdl_path + File.separator
835 + "cgi-bin" + File.separator + "gsdlsite.cfg";
836 }
837
838 // non-destructive update of gsdl(3)site.cfg (comments preserved)
839 String collectDir = Gatherer.getCollectDirectoryPath();
840 //collectDir = "\"" + collectDir.substring(0, collectDir.length()-1) + "\""; // remove file separator at end
841 collectDir = collectDir.substring(0, collectDir.length()-1); // remove file separator at end
842 Utility.updatePropertyConfigFile(gsdlsitecfg, "collecthome", collectDir);
843
844 if(!Gatherer.GS3 && Gatherer.isLocalLibrary) {
845 // for Images in the collection to work, the apache web server
846 // configuration's COLLECTHOME should be updated on collectdir change.
847 // Does nothing for server.exe at the moment
848
849 LocalLibraryServer.reconfigure();
850 }
851 }
852
853
854 static public void refresh(int refresh_reason)
855 {
856 if (g_man != null) {
857
858 g_man.refresh(refresh_reason, c_man.ready());
859 }
860
861 // Now is a good time to force a garbage collect
862 System.gc();
863 }
864
865
866 // used to send reload coll messages to the tomcat server
867 static public void configGS3Server(String site, String command) {
868 if (Configuration.library_url == null){
869 System.out.println("Error: you have not provided the Greenstone Library address.");
870 return;
871
872 }
873
874 try {
875 // need to add the servlet name to the exec address
876 String raw_url = Configuration.library_url.toString() + Configuration.getServletPath() + command;
877 URL url = new URL(raw_url);
878 DebugStream.println("Action: " + raw_url);
879 HttpURLConnection library_connection = (HttpURLConnection) url.openConnection();
880 int response_code = library_connection.getResponseCode();
881 if(HttpURLConnection.HTTP_OK <= response_code && response_code < HttpURLConnection.HTTP_MULT_CHOICE) {
882 DebugStream.println("200 - Complete.");
883 }
884 else {
885 DebugStream.println("404 - Failed.");
886 }
887 url = null;
888 }
889 catch(java.net.ConnectException connectException) {
890 JOptionPane.showMessageDialog(g_man, Dictionary.get("Preferences.Connection.Library_Path_Connection_Failure", Configuration.library_url.toString()), Dictionary.get("General.Warning"), JOptionPane.WARNING_MESSAGE);
891 DebugStream.println(connectException.getMessage());
892 }
893 catch (Exception exception) {
894 DebugStream.printStackTrace(exception);
895 }
896 }
897
898
899 /** Used to 'spawn' a new child application when a file is double clicked.
900 * @param file The file to open
901 * @see org.greenstone.gatherer.Gatherer.ExternalApplication
902 */
903 static public void spawnApplication(File file) {
904 String [] commands = assoc_man.getCommand(file);
905 if(commands != null) {
906 ExternalApplication app = new ExternalApplication(commands);
907 apps.add(app);
908 app.start();
909 }
910 else {
911 ///ystem.err.println("No open command available.");
912 }
913 }
914
915
916 static public void spawnApplication(String command)
917 {
918 ExternalApplication app = new ExternalApplication(command);
919 apps.add(app);
920 app.start();
921 }
922
923 static public void spawnApplication(String command, String ID)
924 {
925 ExternalApplication app = new ExternalApplication(command, ID);
926 apps.add(app);
927 app.start();
928 }
929
930 static public void spawnApplication(String[] commands, String ID)
931 {
932 ExternalApplication app = new ExternalApplication(commands, ID);
933 apps.add(app);
934 app.start();
935 }
936
937 static public void terminateApplication(String ID) {
938 for(int i = 0; i < apps.size(); i++) {
939 ExternalApplication app = (ExternalApplication)apps.get(i);
940 if(app.getID() != null && app.getID().equals(ID)) {
941 app.stopExternalApplication();
942 apps.remove(app);
943 }
944 }
945 }
946
947
948 /** Used to 'spawn' a new browser application or reset an existing one when the preview button is clicked
949 * @param url The url to open the browser at
950 * @see org.greenstone.gatherer.Gatherer.BrowserApplication
951 */
952 static public void spawnBrowser(String url) {
953 String command = assoc_man.getBrowserCommand(url);
954 if (command != null) {
955 BrowserApplication app = new BrowserApplication(command, url);
956 apps.add(app);
957 app.start();
958 }
959 else {
960 ///ystem.err.println("No browser command available.");
961 }
962 }
963
964
965 /** Prints a warning message about a missing library path, which means the final collection cannot be previewed in the Gatherer.
966 */
967 static public void missingEXEC() {
968 WarningDialog dialog;
969 String configPropertyName = "general.library_url"+Configuration.gliPropertyNameSuffix();
970
971 if (GS3) {
972 // Warning dialog with no cancel button and no "turn off warning" checkbox
973 dialog = new WarningDialog("warning.MissingEXEC", Dictionary.get("MissingEXEC_GS3.Title"), Dictionary.get("MissingEXEC_GS3.Message"), configPropertyName, false, false);
974 } else { // local case
975 dialog = new WarningDialog("warning.MissingEXEC", Dictionary.get("MissingEXEC.Title"), Dictionary.get("MissingEXEC.Message"), configPropertyName, false);
976 }
977
978 JTextField field = new URLField.Text(Configuration.getColor("coloring.editable_foreground", false), Configuration.getColor("coloring.editable_background", false));
979
980 // Set the default library URL to the tomcat server and port number
981 // specified in the build.properties located in the gsdl3_src_path
982 if (GS3) {
983 String host = "localhost";
984 String port = "8080";
985
986 File buildPropsFile = new File(Configuration.gsdl3_src_path + File.separator + "build.properties");
987 if(buildPropsFile.exists()) {
988 Properties props = new Properties();
989 try{
990 props.load(new FileInputStream(buildPropsFile));
991 host = props.getProperty("tomcat.server", host);
992 port = props.getProperty("tomcat.port", port);
993 }catch(Exception e){
994 DebugStream.println("Could not load build.properties file");
995 System.err.println("Could not load build.properties file");
996 }
997 props = null;
998 }
999 String defaultURL = "http://"+host+":"+port+"/"+"greenstone3";
1000 field.setText(defaultURL);
1001 field.selectAll();
1002 }
1003 dialog.setValueField(field);
1004 dialog.display();
1005 dialog.dispose();
1006 dialog = null;
1007
1008 String library_url_string = Configuration.getString(configPropertyName, true);
1009 if (!library_url_string.equals("")) {
1010 try {
1011 // WarningDialog does not allow invalid URLs, so the following is ignored:
1012 // make sure the URL the user provided contains the http:// prefix
1013 // and then save the corrected URL
1014 if(!library_url_string.startsWith("http://")
1015 && !library_url_string.startsWith("https://")) {
1016 library_url_string = "http://"+library_url_string;
1017 Configuration.setString(configPropertyName, true, configPropertyName);
1018 }
1019 Configuration.library_url = new URL(library_url_string);
1020 }
1021 catch (MalformedURLException exception) {
1022 DebugStream.printStackTrace(exception);
1023 }
1024 }
1025 }
1026
1027
1028
1029 /** Prints a warning message about a missing library path, which means the final collection cannot be previewed in the Gatherer.
1030 */
1031 static private void popupFedoraInfo() {
1032
1033 FedoraLogin dialog = new FedoraLogin("Fedora Login", false);
1034
1035 if (Configuration.library_url == null) {
1036
1037 String library_url_string = dialog.getLibraryURL();
1038 if (!library_url_string.equals("")) {
1039 try {
1040 Configuration.library_url = new URL(library_url_string);
1041 }
1042 catch (MalformedURLException exception) {
1043 DebugStream.printStackTrace(exception);
1044 }
1045 }
1046 }
1047
1048 boolean showLogin = true;
1049 do {
1050 if(!dialog.loginRequested()) { // user pressed cancel to exit the FedoraLogin dialog
1051 System.exit(0);
1052 } else {
1053 showLogin = dialog.loginRequested();
1054 String hostname = dialog.getHostname();
1055 String port = dialog.getPort();
1056 String username = dialog.getUsername();
1057 String password = dialog.getPassword();
1058 String protocol = dialog.getProtocol();
1059
1060 Configuration.fedora_info.setHostname(hostname);
1061 Configuration.fedora_info.setPort(port);
1062 Configuration.fedora_info.setUsername(username);
1063 Configuration.fedora_info.setPassword(password);
1064 Configuration.fedora_info.setProtocol(protocol);
1065
1066 String ping_url_str = protocol + "://" + hostname + ":" + port + "/fedora";
1067 String login_str = username + ":" + password;
1068
1069 String login_encoding = Base64.encodeBytes(login_str.getBytes());
1070
1071 try {
1072 URL ping_url = new URL(ping_url_str);
1073 URLConnection uc = ping_url.openConnection();
1074 uc.setRequestProperty ("Authorization", "Basic " + login_encoding);
1075 // Attempt to access some content ...
1076 InputStream content = (InputStream)uc.getInputStream();
1077
1078 // if no exception occurred in the above, we would have come here:
1079 showLogin = false;
1080 dialog.dispose();
1081 }
1082 catch (Exception exception) {
1083 // TODO: move into dictionary
1084 String[] errorMessage = {"Failed to connect to the Fedora server.", "It might not be running, or",
1085 "incorrect username and/or password."};
1086 dialog.setErrorMessage(errorMessage);
1087 //DebugStream.printStackTrace(exception);
1088 // exception occurred, show the dialog again (do this after printing to
1089 // debugStream, else the above does not get done for some reason).
1090 dialog.setVisible(true);
1091 }
1092 }
1093 } while(showLogin);
1094
1095 dialog = null; // no more need of the dialog
1096
1097 // Now we are connected.
1098 }
1099
1100
1101
1102 static private void requestGLIServerURL()
1103 {
1104 WarningDialog dialog;
1105 String[] defaultURLs = {
1106 "http://localhost:8080/greenstone3/cgi-bin/gliserver.pl",
1107 "http://localhost:8080/gsdl/cgi-bin/gliserver.pl"
1108 };
1109
1110 // Warning dialog with no cancel button and no "turn off warning" checkbox
1111 // (since user-input of the gliserver script is mandatory)
1112 dialog = new WarningDialog("warning.MissingGLIServer", Dictionary.get("MissingGLIServer.Title"), Dictionary.get("MissingGLIServer.Message"), "general.gliserver_url", false, false);
1113
1114 dialog.setValueField(new URLField.DropDown(Configuration.getColor("coloring.editable_foreground", false),
1115 Configuration.getColor("coloring.editable_background", false),
1116 defaultURLs, "general.gliserver_url",
1117 "general.open_collection"+Configuration.gliPropertyNameSuffix(),
1118 "gliserver.pl"));
1119
1120 if (Gatherer.default_gliserver_url!=null){
1121 dialog.setValueField(Gatherer.default_gliserver_url.toString());
1122 }
1123
1124 // A WarningDialog cannot always be made to respond (let alone to exit the program) on close. We
1125 // handle the response of this particular WarningDialog here: a URL for gliserver.pl is a crucial
1126 // piece of user-provided data. Therefore, if no URL was entered for gliserver.pl, it'll exit safely.
1127 dialog.addWindowListener(new WindowAdapter() {
1128 public void windowClosing(WindowEvent e) {
1129 Gatherer.exit();
1130 }
1131 });
1132
1133 dialog.display();
1134 dialog.dispose();
1135 dialog = null;
1136
1137
1138 String gliserver_url_string = Configuration.getString("general.gliserver_url", true);
1139 if (!gliserver_url_string.equals("")) {
1140 try {
1141 Configuration.gliserver_url = new URL(gliserver_url_string);
1142 Configuration.setString("general.gliserver_url", true, gliserver_url_string);
1143 }
1144 catch (MalformedURLException exception) {
1145 DebugStream.printStackTrace(exception);
1146 }
1147 }
1148 }
1149
1150
1151 /** Prints a warning message about a missing GSDL path, which although not fatal pretty much ensures nothing will work properly in the GLI.
1152 */
1153 static private void missingGSDL() {
1154 WarningDialog dialog = new WarningDialog("warning.MissingGSDL", Dictionary.get("MissingGSDL.Title"), Dictionary.get("MissingGSDL.Message"), null, false);
1155 dialog.display();
1156 dialog.dispose();
1157 dialog = null;
1158 }
1159
1160 /** Prints a warning message about missing a valid ImageMagick path, which although not fatal means building image collections won't work */
1161 static private void missingImageMagick() {
1162 WarningDialog dialog = new WarningDialog("warning.MissingImageMagick", Dictionary.get("MissingImageMagick.Title"), Dictionary.get("MissingImageMagick.Message"), null, false);
1163 dialog.display();
1164 dialog.dispose();
1165 dialog = null;
1166 }
1167
1168 /** 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. */
1169 static private void missingPERL() {
1170 WarningDialog dialog = new WarningDialog("warning.MissingPERL", Dictionary.get("MissingPERL.Title"), Dictionary.get("MissingPERL.Message"), null, false);
1171 dialog.display();
1172 dialog.dispose();
1173 dialog = null;
1174 }
1175
1176
1177 /** Sets up the proxy connection by setting JVM Environment flags and creating a new Authenticator.
1178 * @see java.lang.Exception
1179 * @see java.lang.System
1180 * @see java.net.Authenticator
1181 * @see org.greenstone.gatherer.Configuration
1182 * @see org.greenstone.gatherer.GAuthenticator
1183 */
1184 static public void setProxy() {
1185 try {// Can throw several exceptions
1186 if(Configuration.get("general.use_proxy", true)) {
1187 System.setProperty("http.proxyType", "4");
1188 System.setProperty("http.proxyHost", Configuration.getString("general.proxy_host", true));
1189 System.setProperty("http.proxyPort", Configuration.getString("general.proxy_port", true));
1190 System.setProperty("http.proxySet", "true");
1191 } else {
1192 System.setProperty("http.proxyHost", "");
1193 System.setProperty("http.proxyPort", "");
1194 System.setProperty("http.proxySet", "false");
1195 }
1196 } catch (Exception error) {
1197 DebugStream.println("Error in Gatherer.initProxy(): " + error);
1198 DebugStream.printStackTrace(error);
1199 }
1200 }
1201
1202
1203 /** 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. */
1204 static private class ExternalApplication
1205 extends Thread {
1206 private Process process = null;
1207 /** The initial command string given to this sub-process. */
1208 private String command = null;
1209 private String[] commands = null;
1210
1211 private String ID = null;
1212
1213 /** Constructor.
1214 * @param command The initial command <strong>String</strong>.
1215 */
1216 public ExternalApplication(String command) {
1217 this.command = command;
1218 }
1219
1220 public ExternalApplication(String[] commands) {
1221 this.commands = commands;
1222 }
1223
1224 public ExternalApplication(String command, String ID) {
1225 this.command = command;
1226 this.ID = ID;
1227 }
1228
1229 public ExternalApplication(String[] commands, String ID) {
1230 this.commands = commands;
1231 this.ID = ID;
1232 }
1233
1234 public String getID() {
1235 return ID;
1236 }
1237
1238 /** We start the child process inside a new thread so it doesn't block the rest of Gatherer.
1239 * @see java.lang.Exception
1240 * @see java.lang.Process
1241 * @see java.lang.Runtime
1242 * @see java.lang.System
1243 * @see java.util.Vector
1244 */
1245 public void run() {
1246 // Call an external process using the args.
1247 try {
1248 if(commands != null) {
1249 StringBuffer whole_command = new StringBuffer();
1250 for(int i = 0; i < commands.length; i++) {
1251 whole_command.append(commands[i]);
1252 whole_command.append(" ");
1253 }
1254 DebugStream.println("Running " + whole_command.toString());
1255 Runtime rt = Runtime.getRuntime();
1256 process = rt.exec(commands);
1257 process.waitFor();
1258 }
1259 else {
1260 DebugStream.println("Running " + command);
1261 Runtime rt = Runtime.getRuntime();
1262 process = rt.exec(command);
1263 process.waitFor();
1264 }
1265 }
1266 catch (Exception exception) {
1267 DebugStream.printStackTrace(exception);
1268 }
1269 // Remove ourself from Gatherer list of threads.
1270 apps.remove(this);
1271 // Call exit if we were the last outstanding child process thread.
1272 if (apps.size() == 0 && exit == true) {
1273 // In my opinion (DB) there is no need to exit here,
1274 // the 'run' method ending naturally brings this
1275 // thread to an end. In fact it is potentially
1276 // dangerous to exit here, as the main thread in the
1277 // Gatherer class may be stopped prematurely. As it so
1278 // happens the point at which the ExternalApplication thread
1279 // is asked to stop (Back in the main Gatherer thread) is after
1280 // various configuration files have been saved.
1281 //
1282 // A similar argument holds for BrowserApplication thread below.
1283 System.exit(exit_status);
1284 }
1285 }
1286 public void stopExternalApplication() {
1287 if(process != null) {
1288 process.destroy();
1289 }
1290 }
1291 }
1292 /** 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. */
1293 static private class BrowserApplication
1294 extends Thread {
1295 private Process process = null;
1296 /** The initial command string given to this sub-process. */
1297 private String command = null;
1298 private String url = null;
1299 private String[] commands = null;
1300
1301 public BrowserApplication(String command, String url) {
1302 StringTokenizer st = new StringTokenizer(command);
1303 int num_tokens = st.countTokens();
1304 this.commands = new String [num_tokens];
1305 int i=0;
1306 while (st.hasMoreTokens()) {
1307 commands[i] = st.nextToken();
1308 i++;
1309 }
1310 //this.commands = commands;
1311 this.url = url;
1312 }
1313 /** We start the child process inside a new thread so it doesn't block the rest of Gatherer.
1314 * @see java.lang.Exception
1315 * @see java.lang.Process
1316 * @see java.lang.Runtime
1317 * @see java.lang.System
1318 * @see java.util.Vector
1319 */
1320 public void run() {
1321 // Call an external process using the args.
1322 if(commands == null) {
1323 apps.remove(this);
1324 return;
1325 }
1326 try {
1327 String prog_name = commands[0];
1328 String lower_name = prog_name.toLowerCase();
1329 if (lower_name.indexOf("mozilla") != -1 || lower_name.indexOf("netscape") != -1) {
1330 DebugStream.println("found mozilla or netscape, trying remote it");
1331 // mozilla and netscape, try using a remote command to get things in the same window
1332 String [] new_commands = new String[] {prog_name, "-raise", "-remote", "openURL("+url+",new-tab)"};
1333 printArray(new_commands);
1334
1335 Runtime rt = Runtime.getRuntime();
1336 process = rt.exec(new_commands);
1337 int exitCode = process.waitFor();
1338 if (exitCode != 0) { // if Netscape or mozilla was not open
1339 DebugStream.println("couldn't do remote, trying original command");
1340 printArray(commands);
1341 process = rt.exec(commands); // try the original command
1342 }
1343 } else {
1344 // just run what we have been given
1345 StringBuffer whole_command = new StringBuffer();
1346 for(int i = 0; i < commands.length; i++) {
1347 whole_command.append(commands[i]);
1348 whole_command.append(" ");
1349 }
1350 DebugStream.println("Running " + whole_command.toString());
1351 Runtime rt = Runtime.getRuntime();
1352 process = rt.exec(commands);
1353 process.waitFor();
1354 }
1355 }
1356
1357 catch (Exception exception) {
1358 DebugStream.printStackTrace(exception);
1359 }
1360 // Remove ourself from Gatherer list of threads.
1361 apps.remove(this);
1362 // Call exit if we were the last outstanding child process thread.
1363 if (apps.size() == 0 && exit == true) {
1364 System.exit(exit_status);
1365 }
1366 }
1367 public void printArray(String [] array) {
1368 for(int i = 0; i < array.length; i++) {
1369 DebugStream.print(array[i]+" ");
1370 System.err.println(array[i]+" ");
1371 }
1372 }
1373 public void stopBrowserApplication() {
1374 if(process != null) {
1375 process.destroy();
1376 }
1377 }
1378 }
1379
1380
1381 private class ImageMagickTest
1382 {
1383 public boolean found()
1384 {
1385 try {
1386 String[] command = new String[2];
1387 command[0] = (Utility.isWindows() ? "identify.exe" : "identify");
1388 command[1] = "-version";
1389 Process image_magick_process = Runtime.getRuntime().exec(command);
1390 image_magick_process.waitFor();
1391
1392 //new way of detection of ImageMagick
1393 InputStreamReader isr = new InputStreamReader(image_magick_process.getInputStream());
1394
1395 BufferedReader br = new BufferedReader(isr);
1396 // Capture the standard output stream and seach for two particular occurances: Version and ImageMagick.
1397
1398 String line = br.readLine();
1399 if (line == null) {
1400 return false;
1401 }
1402 String lc_line = line.toLowerCase();
1403 if (lc_line.indexOf("version") != -1 || lc_line.indexOf("imagemagick") != -1) {
1404 return true;
1405 } else {
1406 return false;
1407 }
1408
1409 //return (image_magick_process.exitValue() == 0);
1410 }
1411 catch (IOException exception) {
1412 return false;
1413 }
1414 catch (InterruptedException exception) {
1415 return false;
1416 }
1417 }
1418 }
1419
1420
1421 private class PerlTest
1422 {
1423 private String[] command = new String[2];
1424
1425 public PerlTest()
1426 {
1427 command[0] = (Utility.isWindows() ? Utility.PERL_EXECUTABLE_WINDOWS : Utility.PERL_EXECUTABLE_UNIX);
1428 command[1] = "-version";
1429 }
1430
1431 public boolean found()
1432 {
1433 try {
1434 Process perl_process = Runtime.getRuntime().exec(command);
1435 perl_process.waitFor();
1436 return (perl_process.exitValue() == 0);
1437 }
1438 catch (Exception exception) {
1439 return false;
1440 }
1441 }
1442
1443 public String toString() {
1444 return command[0];
1445 }
1446 }
1447}
Note: See TracBrowser for help on using the repository browser.