source: trunk/gli/src/org/greenstone/gatherer/gui/ExplodeMetadataDatabasePrompt.java@ 13820

Last change on this file since 13820 was 13820, checked in by shaoqun, 17 years ago

added code to pass the skimfile switch to MetadataXMLFileManager
  • Property svn:keywords set to Author Date Id Revision
File size: 13.7 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: Katherine Don, Greenstone Digital Library, University of Waikato
9 *
10 * Copyright (C) 2005 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.gui;
28
29import java.awt.*;
30import java.awt.event.*;
31import javax.swing.*;
32import javax.swing.event.*;
33import javax.swing.text.*;
34import java.io.*;
35import java.util.ArrayList;
36
37import org.w3c.dom.Document;
38
39import org.greenstone.gatherer.Dictionary;
40import org.greenstone.gatherer.Configuration;
41import org.greenstone.gatherer.Gatherer;
42import org.greenstone.gatherer.cdm.Argument;
43import org.greenstone.gatherer.cdm.ArgumentControl;
44import org.greenstone.gatherer.cdm.CollectionDesignManager;
45import org.greenstone.gatherer.cdm.Plugin;
46import org.greenstone.gatherer.collection.CollectionManager;
47import org.greenstone.gatherer.collection.ScriptOptions;
48import org.greenstone.gatherer.collection.Collection;
49import org.greenstone.gatherer.greenstone.LocalGreenstone;
50import org.greenstone.gatherer.gui.tree.DragTree;
51import org.greenstone.gatherer.metadata.MetadataXMLFileManager;
52import org.greenstone.gatherer.metadata.MetadataElement;
53import org.greenstone.gatherer.metadata.MetadataSet;
54import org.greenstone.gatherer.metadata.MetadataSetManager;
55import org.greenstone.gatherer.metadata.MetadataTools;
56import org.greenstone.gatherer.remote.RemoteGreenstoneServer;
57import org.greenstone.gatherer.shell.GShell;
58import org.greenstone.gatherer.shell.GShellEvent;
59import org.greenstone.gatherer.shell.GShellListener;
60import org.greenstone.gatherer.util.Utility;
61import org.greenstone.gatherer.util.XMLTools;
62
63public class ExplodeMetadataDatabasePrompt
64 extends ModalDialog
65 implements GShellListener
66{
67 /** The size of this new collection dialog box. */
68 static private Dimension SIZE = new Dimension(675, 350);
69 private JDialog self;
70
71 /** the file we wil be exploding */
72 private File metadata_file = null;
73 /** the list of potential plugins to be used */
74 private Argument plugin_arg = null;
75 /** holds all the available options for the exploding script */
76 private ScriptOptions options = null;
77 /** the pane containing the options */
78 private JPanel options_pane = null;
79 /** the error message if any */
80 private StringBuffer error_message = null;
81 /** whether we were successful or not */
82 private boolean successful;
83
84
85 public ExplodeMetadataDatabasePrompt(File source_file) {
86 super(Gatherer.g_man, true);
87 this.self = this;
88 this.metadata_file = source_file;
89
90 // check that we actually have an explodable file
91 ArrayList exp_plugins = CollectionDesignManager.plugin_manager.getExploderPlugins(source_file);
92 if (exp_plugins.size() == 0) {
93 JOptionPane.showMessageDialog(Gatherer.g_man, Dictionary.get("ExplodeMetadataPrompt.NotExplodable"), Dictionary.get("ExplodeMetadataPrompt.Title"), JOptionPane.ERROR_MESSAGE);
94 return;
95 }
96 plugin_arg = createPluginArgument(exp_plugins);
97 setJMenuBar(new SimpleMenuBar("explodingmetadata"));
98 setSize(SIZE);
99 setTitle(Dictionary.get("ExplodeMetadataPrompt.Title"));
100
101 // set up the script options
102 // we have empty initial values
103 String dom_string = "<Options/>";
104 Document doc = XMLTools.parseXML(new StringReader(dom_string));
105 options = new ScriptOptions(doc.getDocumentElement(), "explode_metadata_database.pl");
106
107 // Creation
108 JPanel content_pane = (JPanel) getContentPane();
109 content_pane.setOpaque(true);
110
111 options_pane = new JPanel();
112 addScriptOptions(options_pane);
113 JScrollPane middle_pane = new JScrollPane(options_pane);
114
115 JTextArea instructions_area = new JTextArea(Dictionary.get("ExplodeMetadataPrompt.Instructions"));
116 instructions_area.setEditable(false);
117 instructions_area.setLineWrap(true);
118 instructions_area.setRows(5);
119 instructions_area.setWrapStyleWord(true);
120
121 JPanel button_pane = new JPanel();
122 JButton explode_button = new GLIButton(Dictionary.get("ExplodeMetadataPrompt.Explode"), Dictionary.get("ExplodeMetadataPrompt.Explode_Tooltip"));
123 JButton cancel_button = new GLIButton(Dictionary.get("General.Cancel"), Dictionary.get("General.Cancel_Tooltip"));
124
125 // Connection
126 cancel_button.addActionListener(new CancelListener());
127 explode_button.addActionListener(new ExplodeListener());
128
129 // Layout
130
131 button_pane.setBorder(BorderFactory.createEmptyBorder(5,0,0,0));
132 button_pane.setLayout(new GridLayout(1,2));
133 button_pane.add(explode_button);
134 button_pane.add(cancel_button);
135
136 content_pane.setBorder(BorderFactory.createEmptyBorder(5,5,5,5));
137 content_pane.setLayout(new BorderLayout());
138 content_pane.add(instructions_area, BorderLayout.NORTH);
139 content_pane.add(middle_pane, BorderLayout.CENTER);
140 content_pane.add(button_pane, BorderLayout.SOUTH);
141
142 // Final dialog setup & positioning.
143 Dimension screen_size = Configuration.screen_size;
144 setLocation((screen_size.width - SIZE.width) / 2, (screen_size.height - SIZE.height) / 2);
145 setVisible(true);
146 }
147
148 public void destroy()
149 {
150
151 }
152
153 /** All implementation of GShellListener must include this method so the listener can be informed of messages from the GShell.
154 * @param event A <strong>GShellEvent</strong> that contains, amoung other things, the message.
155 */
156 public synchronized void message(GShellEvent event) {
157 String message = event.getMessage();
158 if (message.startsWith("explode_metadata_database.pl>")) {
159 message = message.substring(29);
160 error_message.append(message);
161 error_message.append("\n");
162 }
163 }
164
165 /** All implementation of GShellListener must include this method so the listener can be informed when a GShell begins its task. Implementation side-effect, not actually used.
166 * @param event A <strong>GShellEvent</strong> that contains details of the initial state of the <strong>GShell</strong> before task comencement.
167 */
168 public synchronized void processBegun(GShellEvent event) {
169 // We don't care.
170 }
171
172 /** All implementation of GShellListener must include this method so the listener can be informed when a GShell completes its task.
173 * @param event A <strong>GShellEvent</strong> that contains details of the final state of the <strong>GShell</strong> after task completion.
174 */
175 public synchronized void processComplete(GShellEvent event) {
176 successful = false;
177 if(event.getStatus() == GShell.OK) {
178 successful = true;
179 }
180 }
181
182 private Argument createPluginArgument(ArrayList plugin_list) {
183 Argument arg = new Argument();
184 arg.setName("plugin");
185 arg.setDescription(Dictionary.get("ExplodeMetadataPrompt.Plugin"));
186 arg.setRequired(true);
187 arg.setType(Argument.ENUM);
188 for (int i=0; i<plugin_list.size(); i++) {
189 Plugin p = (Plugin)plugin_list.get(i);
190 arg.addOption(p.getName(), p.getName());
191 }
192 return arg;
193 }
194 private void addScriptOptions(JPanel options_pane) {
195
196 options_pane.setBorder(BorderFactory.createEmptyBorder(5,5,5,5));
197 options_pane.setBackground(Configuration.getColor("coloring.collection_heading_background", false));
198 options_pane.setLayout(new BoxLayout(options_pane, BoxLayout.Y_AXIS));
199
200 int current_mode = Configuration.getMode();
201 int total_argument_count = options.getArgumentCount();
202
203 // first we add the plugin arg
204 ArgumentControl argument_control = new ArgumentControl(plugin_arg, true, null);
205 argument_control.setBackground(Configuration.getColor("coloring.collection_heading_background", false));
206 options_pane.add((JComponent)argument_control);
207 for(int i = 0; i < total_argument_count; i++) {
208 // Retrieve the argument so we know how to format the control.
209 Argument argument = options.getArgument(i);
210 if(!argument.isHiddenGLI() && argument.getModeLevel() <= current_mode) {
211 if (argument.getName().equals("metadata_set")) {
212 argument.setType(Argument.METADATA_SET_NAMESPACE);
213 argument_control = new ArgumentControl(argument, true, "Exploded Metadata Set (exp)");
214 }
215 else {
216 // by default, all args are disabled, and no value
217 argument_control = new ArgumentControl(argument, false, null);
218 }
219 // make sure they are coloured the way we want - this is not the standard arg control coloring
220 argument_control.setBackground(Configuration.getColor("coloring.collection_heading_background", false));
221 options_pane.add((JComponent)argument_control);
222 }
223 }
224 }
225
226 private void updateScriptOptions() {
227 for(int i = 0; i < options_pane.getComponentCount(); i++) {
228 Component component = options_pane.getComponent(i);
229 if(component instanceof ArgumentControl) {
230 ArgumentControl ac = (ArgumentControl)component;
231 String name = ac.getArgumentName();
232 String value = ac.getValue();
233 boolean enabled = ac.isEnabled();
234 if (!enabled && value==null) {
235 // flag type, remove from options altogether
236 options.removeValue(name);
237 } else {
238 if (value.equals("")) {
239 // if the value is empty, we don't want it to be passed to the script
240 options.setValue(name, false, value);
241 } else {
242 options.setValue(name, enabled, value);
243 }
244 }
245
246 }
247 }
248 }
249
250 private int explodeMetadata()
251 {
252 // Generate the explode_metadata_database.pl command
253 ArrayList command_parts_list = new ArrayList();
254 if (Utility.isWindows() && (!Gatherer.isGsdlRemote)) {
255 command_parts_list.add(Configuration.perl_path);
256 command_parts_list.add("-S");
257 }
258 command_parts_list.add(LocalGreenstone.getBinScriptDirectoryPath() + "explode_metadata_database.pl");
259
260 // Add in all the options from the user
261 String[] explode_options = options.getValues();
262 for (int i = 0; i < explode_options.length; i++) {
263 command_parts_list.add(explode_options[i]);
264 }
265
266 // Local case
267 if (!Gatherer.isGsdlRemote) {
268 // Add in the filename
269 command_parts_list.add(metadata_file.getPath());
270 }
271 // Remote case
272 else {
273 // Add in the filename, relative to the collection directory
274 String collection_name = CollectionManager.getLoadedCollectionName();
275 String collection_directory_path = CollectionManager.getCollectionDirectoryPath(collection_name);
276 String metadata_file_relative_path = RemoteGreenstoneServer.getPathRelativeToDirectory(metadata_file, collection_directory_path);
277 command_parts_list.add("-file");
278 command_parts_list.add(metadata_file_relative_path);
279
280 // When running remotely we also need the collection name as the last argument
281 command_parts_list.add(collection_name);
282 }
283
284 // Run the explode_metadata_database.pl command
285 String[] command_parts = (String[]) command_parts_list.toArray(new String[0]);
286 this.error_message = new StringBuffer();
287 GShell process = new GShell(command_parts, GShell.EXPLODE, 3, this, null, GShell.GSHELL_EXPLODE);
288 //process.start();
289 process.run();
290
291 if (successful) {
292 return 0;
293 }
294 return -1;
295 }
296
297 private void resultPrompt(boolean success, String message)
298 {
299 if (success) {
300 // !!! TO DO: Get explode_metadata_database.pl strings translated and use SimpleResultDialog below
301 JOptionPane.showMessageDialog(null, Dictionary.get("ExplodeMetadataPrompt.Successful_Explode", metadata_file.getName()), Dictionary.get("ExplodeMetadataPrompt.Successful_Title"), JOptionPane.INFORMATION_MESSAGE);
302 }
303 else {
304 String title = Dictionary.get("ExplodeMetadataPrompt.Failed_Title");
305 String label = Dictionary.get("ExplodeMetadataPrompt.Failed_Explode", metadata_file.getName());
306 SimpleResultDialog result_dialog = new SimpleResultDialog(title, label, message);
307 result_dialog.setVisible(true); // Blocks
308 result_dialog.dispose();
309 result_dialog = null;
310 }
311 }
312
313 private class CancelListener
314 implements ActionListener {
315 public void actionPerformed(ActionEvent event) {
316 self.dispose();
317 }
318 }
319
320 private class ExplodeListener
321 implements ActionListener {
322
323 public void actionPerformed(ActionEvent event) {
324 Gatherer.g_man.wait(true);
325 // update the options
326 updateScriptOptions();
327 self.dispose();
328 (new ExplodeMetadataDatabaseTask()).start();
329 }
330 }
331
332
333 private class ExplodeMetadataDatabaseTask
334 extends Thread
335 {
336 public ExplodeMetadataDatabaseTask()
337 {
338 }
339
340 public void run()
341 {
342 int exit_value = explodeMetadata();
343 if (exit_value == 0) { // success
344 // Clear out the old directory containing the metadata file and download the new directory
345 if (Gatherer.isGsdlRemote) {
346 Utility.delete(metadata_file.getParentFile());
347 RemoteGreenstoneServer.downloadCollectionFile(CollectionManager.getLoadedCollectionName(), metadata_file.getParentFile());
348 }
349
350 // Load the new metadata.xml files
351 Collection collection = Gatherer.c_man.getCollection();
352 MetadataXMLFileManager.loadMetadataXMLFiles(metadata_file.getParentFile(),collection.toSkimFile());
353 Gatherer.g_man.refreshCollectionTree(DragTree.COLLECTION_CONTENTS_CHANGED);
354 resultPrompt(true, error_message.toString());
355 } else { // failure
356 resultPrompt(false, error_message.toString());
357 }
358 error_message = null;
359 Gatherer.g_man.wait(false);
360 }
361 }
362}
Note: See TracBrowser for help on using the repository browser.