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

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