CLI search, step 1
[fanfix.git] / src / be / nikiroo / fanfix / reader / ui / GuiReader.java
CommitLineData
16a81ef7 1package be.nikiroo.fanfix.reader.ui;
a6395bef 2
edd46289 3import java.awt.Desktop;
a6395bef 4import java.awt.EventQueue;
350bc060
NR
5import java.awt.event.WindowAdapter;
6import java.awt.event.WindowEvent;
a6395bef
NR
7import java.io.File;
8import java.io.IOException;
b42117f1
NR
9import java.net.URISyntaxException;
10
11import javax.swing.JEditorPane;
12b9873f 12import javax.swing.JFrame;
b42117f1
NR
13import javax.swing.JLabel;
14import javax.swing.JOptionPane;
15import javax.swing.event.HyperlinkEvent;
16import javax.swing.event.HyperlinkListener;
a6395bef
NR
17
18import be.nikiroo.fanfix.Instance;
b42117f1 19import be.nikiroo.fanfix.VersionCheck;
5bc9573b 20import be.nikiroo.fanfix.bundles.StringIdGui;
dd81a122 21import be.nikiroo.fanfix.bundles.UiConfig;
bc2ea776 22import be.nikiroo.fanfix.data.MetaData;
a6395bef 23import be.nikiroo.fanfix.data.Story;
ff05b828
NR
24import be.nikiroo.fanfix.library.BasicLibrary;
25import be.nikiroo.fanfix.library.CacheLibrary;
16a81ef7 26import be.nikiroo.fanfix.reader.BasicReader;
c3b229a1 27import be.nikiroo.fanfix.reader.Reader;
91b82a5c 28import be.nikiroo.fanfix.supported.SupportType;
3b2b638f 29import be.nikiroo.utils.Progress;
b42117f1 30import be.nikiroo.utils.Version;
b0e88ebd 31import be.nikiroo.utils.ui.UIUtils;
a6395bef 32
c3b229a1
NR
33/**
34 * This class implements a graphical {@link Reader} using the Swing library from
35 * Java.
36 * <p>
37 * It can thus be themed to look native-like, or metal-like, or use any other
38 * theme you may want to try.
39 * <p>
40 * We actually try to enable native look-alike mode on start.
41 *
42 * @author niki
43 */
5dd985cf 44class GuiReader extends BasicReader {
b0e88ebd
NR
45 static private boolean nativeLookLoaded;
46
ff05b828
NR
47 private CacheLibrary cacheLib;
48
49 private File cacheDir;
a6395bef 50
c3b229a1
NR
51 /**
52 * Create a new graphical {@link Reader}.
53 *
54 * @throws IOException
55 * in case of I/O errors
56 */
5dd985cf 57 public GuiReader() throws IOException {
c3b229a1 58 // TODO: allow different themes?
b0e88ebd
NR
59 if (!nativeLookLoaded) {
60 UIUtils.setLookAndFeel();
61 nativeLookLoaded = true;
62 }
63
ff05b828
NR
64 cacheDir = Instance.getReaderDir();
65 cacheDir.mkdirs();
66 if (!cacheDir.exists()) {
a6395bef 67 throw new IOException(
ff05b828
NR
68 "Cannote create cache directory for local reader: "
69 + cacheDir);
70 }
71 }
72
73 @Override
74 public synchronized BasicLibrary getLibrary() {
75 if (cacheLib == null) {
76 BasicLibrary lib = super.getLibrary();
77 if (lib instanceof CacheLibrary) {
78 cacheLib = (CacheLibrary) lib;
79 } else {
80 cacheLib = new CacheLibrary(cacheDir, lib);
81 }
a6395bef
NR
82 }
83
ff05b828 84 return cacheLib;
a6395bef
NR
85 }
86
211f7ddb 87 @Override
350bc060 88 public void read(boolean sync) throws IOException {
bc2ea776
NR
89 MetaData meta = getMeta();
90
91 if (meta == null) {
edd46289
NR
92 throw new IOException("No story to read");
93 }
94
350bc060 95 read(meta.getLuid(), sync, null);
a6395bef
NR
96 }
97
9843a5e5
NR
98 /**
99 * Check if the {@link Story} denoted by this Library UID is present in the
5dd985cf 100 * {@link GuiReader} cache.
9843a5e5
NR
101 *
102 * @param luid
103 * the Library UID
104 *
105 * @return TRUE if it is
106 */
10d558d2 107 public boolean isCached(String luid) {
ff05b828 108 return cacheLib.isCached(luid);
10d558d2
NR
109 }
110
211f7ddb 111 @Override
b0e88ebd 112 public void browse(String type) {
7a3eb29f
NR
113 final Boolean[] done = new Boolean[] { false };
114
b42117f1
NR
115 // TODO: improve presentation of update message
116 final VersionCheck updates = VersionCheck.check();
117 StringBuilder builder = new StringBuilder();
118
119 final JEditorPane updateMessage = new JEditorPane("text/html", "");
120 if (updates.isNewVersionAvailable()) {
5bc9573b
NR
121 builder.append(trans(StringIdGui.NEW_VERSION_AVAILABLE,
122 "<span style='color: blue;'>https://github.com/nikiroo/fanfix/releases</span>"));
b42117f1
NR
123 builder.append("<br>");
124 builder.append("<br>");
125 for (Version v : updates.getNewer()) {
5bc9573b
NR
126 builder.append("\t<b>"
127 + trans(StringIdGui.NEW_VERSION_VERSION, v.toString())
128 + "</b>");
b42117f1
NR
129 builder.append("<br>");
130 builder.append("<ul>");
131 for (String item : updates.getChanges().get(v)) {
132 builder.append("<li>" + item + "</li>");
133 }
134 builder.append("</ul>");
135 }
136
137 // html content
138 updateMessage.setText("<html><body>" //
139 + builder//
140 + "</body></html>");
141
142 // handle link events
143 updateMessage.addHyperlinkListener(new HyperlinkListener() {
211f7ddb 144 @Override
b42117f1
NR
145 public void hyperlinkUpdate(HyperlinkEvent e) {
146 if (e.getEventType().equals(
147 HyperlinkEvent.EventType.ACTIVATED))
148 try {
149 Desktop.getDesktop().browse(e.getURL().toURI());
150 } catch (IOException ee) {
62c63b07 151 Instance.getTraceHandler().error(ee);
b42117f1 152 } catch (URISyntaxException ee) {
62c63b07 153 Instance.getTraceHandler().error(ee);
b42117f1
NR
154 }
155 }
156 });
157 updateMessage.setEditable(false);
158 updateMessage.setBackground(new JLabel().getBackground());
159 }
160
333f0e7b 161 final String typeFinal = type;
a6395bef 162 EventQueue.invokeLater(new Runnable() {
211f7ddb 163 @Override
a6395bef 164 public void run() {
b42117f1
NR
165 if (updates.isNewVersionAvailable()) {
166 int rep = JOptionPane.showConfirmDialog(null,
5bc9573b
NR
167 updateMessage,
168 trans(StringIdGui.NEW_VERSION_TITLE),
b42117f1
NR
169 JOptionPane.OK_CANCEL_OPTION);
170 if (rep == JOptionPane.OK_OPTION) {
171 updates.ok();
172 } else {
173 updates.ignore();
174 }
175 }
176
7a3eb29f
NR
177 new Thread(new Runnable() {
178 @Override
179 public void run() {
180 try {
181 GuiReaderFrame gui = new GuiReaderFrame(
182 GuiReader.this, typeFinal);
183 sync(gui);
184 } catch (Exception e) {
185 Instance.getTraceHandler().error(e);
186 } finally {
187 done[0] = true;
188 }
189
190 }
191 }).start();
a6395bef
NR
192 }
193 });
7a3eb29f
NR
194
195 // This action must be synchronous, so wait until the frame is closed
196 while (!done[0]) {
197 try {
198 Thread.sleep(100);
199 } catch (InterruptedException e) {
200 }
201 }
a6395bef 202 }
10d558d2 203
16a81ef7 204 @Override
350bc060
NR
205 public void start(File target, String program, boolean sync)
206 throws IOException {
207
208 boolean handled = false;
209 if (program == null && !sync) {
16a81ef7
NR
210 try {
211 Desktop.getDesktop().browse(target.toURI());
350bc060 212 handled = true;
16a81ef7 213 } catch (UnsupportedOperationException e) {
16a81ef7 214 }
350bc060
NR
215 }
216
217 if (!handled) {
218 super.start(target, program, sync);
16a81ef7
NR
219 }
220 }
91b82a5c
NR
221
222 @Override
223 public void search(SupportType searchOn, String keywords, int page, int item) {
224 // TODO: !!!
225 throw new java.lang.IllegalStateException("Not implemented yet.");
226 }
227
228 @Override
229 public void searchTag(SupportType searchOn, int page, int item, String... tags) {
230 // TODO: !!!
231 throw new java.lang.IllegalStateException("Not implemented yet.");
232 }
16a81ef7 233
c3b229a1
NR
234 /**
235 * Delete the {@link Story} from the cache if it is present, but <b>NOT</b>
236 * from the main library.
237 * <p>
238 * The next time we try to retrieve the {@link Story}, it may be required to
239 * cache it again.
240 *
241 * @param luid
242 * the luid of the {@link Story}
243 */
754a5bc2 244 void clearLocalReaderCache(String luid) {
68e2c6d2 245 try {
ff05b828 246 cacheLib.clearFromCache(luid);
68e2c6d2 247 } catch (IOException e) {
62c63b07 248 Instance.getTraceHandler().error(e);
68e2c6d2 249 }
10d558d2
NR
250 }
251
c3b229a1
NR
252 /**
253 * Forward the delete operation to the main library.
254 * <p>
255 * The {@link Story} will be deleted from the main library as well as the
256 * cache if present.
257 *
258 * @param luid
259 * the {@link Story} to delete
260 */
10d558d2 261 void delete(String luid) {
68e2c6d2 262 try {
ff05b828 263 cacheLib.delete(luid);
68e2c6d2 264 } catch (IOException e) {
62c63b07 265 Instance.getTraceHandler().error(e);
68e2c6d2 266 }
10d558d2 267 }
edd46289 268
c3b229a1
NR
269 /**
270 * "Open" the given {@link Story}. It usually involves starting an external
271 * program adapted to the given file type.
350bc060
NR
272 * <p>
273 * Asynchronous method.
c3b229a1
NR
274 *
275 * @param luid
276 * the luid of the {@link Story} to open
350bc060
NR
277 * @param sync
278 * execute the process synchronously (wait until it is terminated
279 * before returning)
c3b229a1
NR
280 * @param pg
281 * the optional progress (we may need to prepare the
282 * {@link Story} for reading
283 *
284 * @throws IOException
285 * in case of I/O errors
286 */
350bc060 287 void read(String luid, boolean sync, Progress pg) throws IOException {
dd81a122 288 MetaData meta = cacheLib.getInfo(luid);
edd46289 289
dd81a122
NR
290 boolean textInternal = Instance.getUiConfig().getBoolean(
291 UiConfig.NON_IMAGES_DOCUMENT_USE_INTERNAL_READER, true);
292 boolean imageInternal = Instance.getUiConfig().getBoolean(
293 UiConfig.IMAGES_DOCUMENT_USE_INTERNAL_READER, true);
47b1710c 294
dd81a122
NR
295 boolean useInternalViewer = true;
296 if (meta.isImageDocument() && !imageInternal) {
297 useInternalViewer = false;
298 }
299 if (!meta.isImageDocument() && !textInternal) {
300 useInternalViewer = false;
301 }
302
303 if (useInternalViewer) {
304 GuiReaderViewer viewer = new GuiReaderViewer(cacheLib,
305 cacheLib.getStory(luid, null));
47b1710c
NR
306 if (sync) {
307 sync(viewer);
308 } else {
309 viewer.setVisible(true);
310 }
1ee67095 311 } else {
dd81a122
NR
312 File file = cacheLib.getFile(luid, pg);
313 openExternal(meta, file, sync);
47b1710c 314 }
edd46289 315 }
70c9b112 316
c3b229a1
NR
317 /**
318 * Change the source of the given {@link Story} (the source is the main
319 * information used to group the stories together).
320 * <p>
321 * In other words, <b>move</b> the {@link Story} into other source.
322 * <p>
323 * The source can be a new one, it needs not exist before hand.
324 *
325 * @param luid
326 * the luid of the {@link Story} to move
327 * @param newSource
328 * the new source
329 */
330 void changeSource(String luid, String newSource) {
68e2c6d2 331 try {
ff05b828 332 cacheLib.changeSource(luid, newSource, null);
68e2c6d2 333 } catch (IOException e) {
62c63b07 334 Instance.getTraceHandler().error(e);
68e2c6d2 335 }
70c9b112 336 }
c8d48938
NR
337
338 /**
339 * Change the title of the given {@link Story}.
340 *
341 * @param luid
342 * the luid of the {@link Story} to change
343 * @param newTitle
344 * the new title
345 */
346 void changeTitle(String luid, String newTitle) {
347 try {
348 cacheLib.changeTitle(luid, newTitle, null);
349 } catch (IOException e) {
350 Instance.getTraceHandler().error(e);
351 }
352 }
353
354 /**
355 * Change the author of the given {@link Story}.
356 * <p>
357 * The author can be a new one, it needs not exist before hand.
358 *
359 * @param luid
360 * the luid of the {@link Story} to change
361 * @param newAuthor
362 * the new author
363 */
364 void changeAuthor(String luid, String newAuthor) {
365 try {
366 cacheLib.changeAuthor(luid, newAuthor, null);
367 } catch (IOException e) {
368 Instance.getTraceHandler().error(e);
369 }
370 }
12b9873f 371
5bc9573b
NR
372 /**
373 * Simple shortcut method to call {link Instance#getTransGui()#getString()}.
374 *
375 * @param id
376 * the ID to translate
377 *
378 * @return the translated result
379 */
380 static String trans(StringIdGui id, Object... params) {
381 return Instance.getTransGui().getString(id, params);
382 }
383
12b9873f
NR
384 /**
385 * Start a frame and wait until it is closed before returning.
386 *
387 * @param frame
388 * the frame to start
389 */
390 static private void sync(final JFrame frame) {
7a3eb29f
NR
391 if (EventQueue.isDispatchThread()) {
392 throw new IllegalStateException(
393 "Cannot call a sync method in the dispatch thread");
394 }
12b9873f 395
7a3eb29f 396 final Boolean[] done = new Boolean[] { false };
12b9873f 397 try {
7a3eb29f 398 Runnable run = new Runnable() {
12b9873f
NR
399 @Override
400 public void run() {
401 try {
402 frame.addWindowListener(new WindowAdapter() {
403 @Override
404 public void windowClosing(WindowEvent e) {
405 super.windowClosing(e);
406 done[0] = true;
407 }
408 });
409
410 frame.setVisible(true);
411 } catch (Exception e) {
412 done[0] = true;
413 }
414 }
7a3eb29f
NR
415 };
416
417 if (EventQueue.isDispatchThread()) {
418 run.run();
419 } else {
420 EventQueue.invokeLater(run);
421 }
12b9873f
NR
422 } catch (Exception e) {
423 Instance.getTraceHandler().error(e);
424 done[0] = true;
425 }
426
427 // This action must be synchronous, so wait until the frame is closed
428 while (!done[0]) {
429 try {
430 Thread.sleep(100);
431 } catch (InterruptedException e) {
432 }
433 }
434 }
a6395bef 435}