JAL-2994 put ‘\’ first in character class clause of regex - otherwise doesn’t compile...
[jalview.git] / src / jalview / io / JalviewFileChooser.java
1 /*
2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
4  *
5  * This file is part of Jalview.
6  *
7  * Jalview is free software: you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * as published by the Free Software Foundation, either version 3
10  * of the License, or (at your option) any later version.
11  *
12  * Jalview is distributed in the hope that it will be useful, but
13  * WITHOUT ANY WARRANTY; without even the implied warranty
14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
15  * PURPOSE.  See the GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
19  * The Jalview Authors are detailed in the 'AUTHORS' file.
20  */
21 //////////////////////////////////////////////////////////////////
22 package jalview.io;
23
24 import jalview.bin.Cache;
25 import jalview.gui.JvOptionPane;
26 import jalview.util.MessageManager;
27 import jalview.util.Platform;
28
29 import java.awt.Component;
30 import java.awt.Dimension;
31 import java.awt.EventQueue;
32 import java.awt.HeadlessException;
33 import java.awt.event.MouseAdapter;
34 import java.awt.event.MouseEvent;
35 import java.io.File;
36 import java.util.ArrayList;
37 import java.util.List;
38 import java.util.StringTokenizer;
39 import java.util.Vector;
40
41 import javax.swing.DefaultListCellRenderer;
42 import javax.swing.JFileChooser;
43 import javax.swing.JList;
44 import javax.swing.JPanel;
45 import javax.swing.JScrollPane;
46 import javax.swing.SpringLayout;
47 import javax.swing.plaf.basic.BasicFileChooserUI;
48
49 /**
50  * Enhanced file chooser dialog box.
51  *
52  * NOTE: bug on Windows systems when filechooser opened on directory to view
53  * files with colons in title.
54  *
55  * @author AMW
56  *
57  */
58 public class JalviewFileChooser extends JFileChooser
59 {
60   /**
61    * Factory method to return a file chooser that offers readable alignment file
62    * formats
63    * 
64    * @param directory
65    * @param selected
66    * @return
67    */
68   public static JalviewFileChooser forRead(String directory,
69           String selected)
70   {
71     List<String> extensions = new ArrayList<String>();
72     List<String> descs = new ArrayList<String>();
73     for (FileFormatI format : FileFormats.getInstance().getFormats())
74     {
75       if (format.isReadable())
76       {
77         extensions.add(format.getExtensions());
78         descs.add(format.getName());
79       }
80     }
81     return new JalviewFileChooser(directory,
82             extensions.toArray(new String[extensions.size()]),
83             descs.toArray(new String[descs.size()]), selected, true);
84   }
85
86   /**
87    * Factory method to return a file chooser that offers writable alignment file
88    * formats
89    * 
90    * @param directory
91    * @param selected
92    * @return
93    */
94   public static JalviewFileChooser forWrite(String directory,
95           String selected)
96   {
97     // TODO in Java 8, forRead and forWrite can be a single method
98     // with a lambda expression parameter for isReadable/isWritable
99     List<String> extensions = new ArrayList<String>();
100     List<String> descs = new ArrayList<String>();
101     for (FileFormatI format : FileFormats.getInstance().getFormats())
102     {
103       if (format.isWritable())
104       {
105         extensions.add(format.getExtensions());
106         descs.add(format.getName());
107       }
108     }
109     return new JalviewFileChooser(directory,
110             extensions.toArray(new String[extensions.size()]),
111             descs.toArray(new String[descs.size()]), selected, false);
112   }
113
114   public JalviewFileChooser(String dir)
115   {
116     super(safePath(dir));
117     setAccessory(new RecentlyOpened());
118   }
119
120   public JalviewFileChooser(String dir, String[] suffix, String[] desc,
121           String selected)
122   {
123     this(dir, suffix, desc, selected, true);
124   }
125
126   /**
127    * Constructor for a single choice of file extension and description
128    * 
129    * @param extension
130    * @param desc
131    */
132   public JalviewFileChooser(String extension, String desc)
133   {
134     this(Cache.getProperty("LAST_DIRECTORY"), new String[] { extension },
135             new String[]
136             { desc }, desc, true);
137   }
138
139   JalviewFileChooser(String dir, String[] extensions, String[] descs,
140           String selected, boolean allFiles)
141   {
142     super(safePath(dir));
143     if (extensions.length == descs.length)
144     {
145       List<String[]> formats = new ArrayList<String[]>();
146       for (int i = 0; i < extensions.length; i++)
147       {
148         formats.add(new String[] { extensions[i], descs[i] });
149       }
150       init(formats, selected, allFiles);
151     }
152     else
153     {
154       System.err.println("JalviewFileChooser arguments mismatch: "
155               + extensions + ", " + descs);
156     }
157   }
158
159   private static File safePath(String dir)
160   {
161     if (dir == null)
162     {
163       return null;
164     }
165
166     File f = new File(dir);
167     if (f.getName().indexOf(':') > -1)
168     {
169       return null;
170     }
171     return f;
172   }
173
174   /**
175    * 
176    * @param formats
177    *          a list of {extensions, description} for each file format
178    * @param selected
179    * @param allFiles
180    *          if true, 'any format' option is included
181    */
182   void init(List<String[]> formats, String selected, boolean allFiles)
183   {
184
185     JalviewFileFilter chosen = null;
186
187     // SelectAllFilter needs to be set first before adding further
188     // file filters to fix bug on Mac OSX
189     setAcceptAllFileFilterUsed(allFiles);
190
191     for (String[] format : formats)
192     {
193       JalviewFileFilter jvf = new JalviewFileFilter(format[0], format[1]);
194       addChoosableFileFilter(jvf);
195       if ((selected != null) && selected.equalsIgnoreCase(format[1]))
196       {
197         chosen = jvf;
198       }
199     }
200
201     if (chosen != null)
202     {
203       setFileFilter(chosen);
204     }
205
206     setAccessory(new RecentlyOpened());
207   }
208
209   @Override
210   public void setFileFilter(javax.swing.filechooser.FileFilter filter)
211   {
212     super.setFileFilter(filter);
213
214     try
215     {
216       if (getUI() instanceof BasicFileChooserUI)
217       {
218         final BasicFileChooserUI fcui = (BasicFileChooserUI) getUI();
219         final String name = fcui.getFileName().trim();
220
221         if ((name == null) || (name.length() == 0))
222         {
223           return;
224         }
225
226         EventQueue.invokeLater(new Thread()
227         {
228           @Override
229           public void run()
230           {
231             String currentName = fcui.getFileName();
232             if ((currentName == null) || (currentName.length() == 0))
233             {
234               fcui.setFileName(name);
235             }
236           }
237         });
238       }
239     } catch (Exception ex)
240     {
241       ex.printStackTrace();
242       // Some platforms do not have BasicFileChooserUI
243     }
244   }
245
246   /**
247    * Returns the selected file format, or null if none selected
248    * 
249    * @return
250    */
251   public FileFormatI getSelectedFormat()
252   {
253     if (getFileFilter() == null)
254     {
255       return null;
256     }
257
258     /*
259      * logic here depends on option description being formatted as 
260      * formatName (extension, extension...)
261      * or the 'no option selected' value
262      * All Files
263      * @see JalviewFileFilter.getDescription
264      */
265     String format = getFileFilter().getDescription();
266     int parenPos = format.indexOf("(");
267     if (parenPos > 0)
268     {
269       format = format.substring(0, parenPos).trim();
270       try
271       {
272         return FileFormats.getInstance().forName(format);
273       } catch (IllegalArgumentException e)
274       {
275         System.err.println("Unexpected format: " + format);
276       }
277     }
278     return null;
279   }
280
281   @Override
282   public int showSaveDialog(Component parent) throws HeadlessException
283   {
284     this.setAccessory(null);
285
286     setDialogType(SAVE_DIALOG);
287
288     int ret = showDialog(parent, MessageManager.getString("action.save"));
289
290     if (getFileFilter() instanceof JalviewFileFilter)
291     {
292       JalviewFileFilter jvf = (JalviewFileFilter) getFileFilter();
293
294       if (!jvf.accept(getSelectedFile()))
295       {
296         String withExtension = getSelectedFile() + "."
297                 + jvf.getAcceptableExtension();
298         setSelectedFile(new File(withExtension));
299       }
300     }
301     // TODO: ENSURE THAT FILES SAVED WITH A ':' IN THE NAME ARE REFUSED AND THE
302     // USER PROMPTED FOR A NEW FILENAME
303     if ((ret == JalviewFileChooser.APPROVE_OPTION)
304             && getSelectedFile().exists())
305     {
306       int confirm = JvOptionPane.showConfirmDialog(parent,
307               MessageManager.getString("label.overwrite_existing_file"),
308               MessageManager.getString("label.file_already_exists"),
309               JvOptionPane.YES_NO_OPTION);
310
311       if (confirm != JvOptionPane.YES_OPTION)
312       {
313         ret = JalviewFileChooser.CANCEL_OPTION;
314       }
315     }
316
317     return ret;
318   }
319
320   void recentListSelectionChanged(Object selection)
321   {
322     setSelectedFile(null);
323     if (selection != null)
324     {
325       File file = new File((String) selection);
326       if (getFileFilter() instanceof JalviewFileFilter)
327       {
328         JalviewFileFilter jvf = (JalviewFileFilter) this.getFileFilter();
329
330         if (!jvf.accept(file))
331         {
332           setFileFilter(getChoosableFileFilters()[0]);
333         }
334       }
335
336       setSelectedFile(file);
337     }
338   }
339
340   class RecentlyOpened extends JPanel
341   {
342     JList list;
343
344     public RecentlyOpened()
345     {
346
347       String historyItems = jalview.bin.Cache.getProperty("RECENT_FILE");
348       StringTokenizer st;
349       Vector recent = new Vector();
350
351       if (historyItems != null)
352       {
353         st = new StringTokenizer(historyItems, "\t");
354
355         while (st.hasMoreTokens())
356         {
357           recent.addElement(st.nextElement());
358         }
359       }
360
361       list = new JList(recent);
362
363       DefaultListCellRenderer dlcr = new DefaultListCellRenderer();
364       dlcr.setHorizontalAlignment(DefaultListCellRenderer.RIGHT);
365       list.setCellRenderer(dlcr);
366
367       list.addMouseListener(new MouseAdapter()
368       {
369         @Override
370         public void mousePressed(MouseEvent evt)
371         {
372           recentListSelectionChanged(list.getSelectedValue());
373         }
374       });
375
376       this.setBorder(new javax.swing.border.TitledBorder(
377               MessageManager.getString("label.recently_opened")));
378
379       final JScrollPane scroller = new JScrollPane(list);
380
381       SpringLayout layout = new SpringLayout();
382       layout.putConstraint(SpringLayout.WEST, scroller, 5,
383               SpringLayout.WEST, this);
384       layout.putConstraint(SpringLayout.NORTH, scroller, 5,
385               SpringLayout.NORTH, this);
386
387       if (new Platform().isAMac())
388       {
389         scroller.setPreferredSize(new Dimension(500, 100));
390       }
391       else
392       {
393         scroller.setPreferredSize(new Dimension(130, 200));
394       }
395
396       this.add(scroller);
397
398       javax.swing.SwingUtilities.invokeLater(new Runnable()
399       {
400         @Override
401         public void run()
402         {
403           scroller.getHorizontalScrollBar()
404                   .setValue(scroller.getHorizontalScrollBar().getMaximum());
405         }
406       });
407
408     }
409
410   }
411 }