Commit | Line | Data |
---|---|---|
89cb07a6 NR |
1 | package be.nikiroo.fanfix.reader; |
2 | ||
3b2b638f | 3 | import java.io.File; |
89cb07a6 | 4 | import java.io.IOException; |
3b2b638f | 5 | import java.net.MalformedURLException; |
89cb07a6 | 6 | import java.net.URL; |
df6e2d88 NR |
7 | import java.text.ParseException; |
8 | import java.text.SimpleDateFormat; | |
df6e2d88 | 9 | import java.util.Date; |
a6c830bb NR |
10 | import java.util.Map; |
11 | import java.util.TreeMap; | |
89cb07a6 NR |
12 | |
13 | import be.nikiroo.fanfix.Instance; | |
d0114000 | 14 | import be.nikiroo.fanfix.bundles.Config; |
c1873e56 NR |
15 | import be.nikiroo.fanfix.bundles.UiConfig; |
16 | import be.nikiroo.fanfix.data.MetaData; | |
89cb07a6 | 17 | import be.nikiroo.fanfix.data.Story; |
e42573a0 NR |
18 | import be.nikiroo.fanfix.library.BasicLibrary; |
19 | import be.nikiroo.fanfix.library.LocalLibrary; | |
89cb07a6 | 20 | import be.nikiroo.fanfix.supported.BasicSupport; |
3b2b638f | 21 | import be.nikiroo.utils.Progress; |
df6e2d88 | 22 | import be.nikiroo.utils.StringUtils; |
9119671d | 23 | import be.nikiroo.utils.serial.SerialUtils; |
89cb07a6 NR |
24 | |
25 | /** | |
dd56a893 | 26 | * The class that handles the different {@link Story} readers you can use. |
89cb07a6 | 27 | * <p> |
dd56a893 | 28 | * All the readers should be accessed via {@link BasicReader#getReader()}. |
89cb07a6 NR |
29 | * |
30 | * @author niki | |
31 | */ | |
e42573a0 | 32 | public abstract class BasicReader implements Reader { |
d66deb8d | 33 | private static BasicLibrary defaultLibrary = Instance.getInstance().getLibrary(); |
c1873e56 | 34 | private static ReaderType defaultType = ReaderType.GUI; |
b0e88ebd | 35 | |
68e2c6d2 | 36 | private BasicLibrary lib; |
bc2ea776 | 37 | private MetaData meta; |
89cb07a6 | 38 | private Story story; |
bc2ea776 | 39 | private int chapter; |
3727aae2 | 40 | |
d0114000 NR |
41 | /** |
42 | * Take the default reader type configuration from the config file. | |
43 | */ | |
3727aae2 | 44 | static { |
d66deb8d | 45 | String typeString = Instance.getInstance().getConfig().getString(Config.READER_TYPE); |
d0114000 NR |
46 | if (typeString != null && !typeString.isEmpty()) { |
47 | try { | |
48 | ReaderType type = ReaderType.valueOf(typeString.toUpperCase()); | |
49 | defaultType = type; | |
50 | } catch (IllegalArgumentException e) { | |
51 | // Do nothing | |
52 | } | |
53 | } | |
3727aae2 NR |
54 | } |
55 | ||
211f7ddb | 56 | @Override |
0bb51c9c | 57 | public synchronized Story getStory(Progress pg) throws IOException { |
bc2ea776 NR |
58 | if (story == null) { |
59 | story = getLibrary().getStory(meta.getLuid(), pg); | |
60 | } | |
61 | ||
89cb07a6 NR |
62 | return story; |
63 | } | |
64 | ||
211f7ddb | 65 | @Override |
68e2c6d2 | 66 | public BasicLibrary getLibrary() { |
b0e88ebd NR |
67 | if (lib == null) { |
68 | lib = defaultLibrary; | |
69 | } | |
70 | ||
71 | return lib; | |
72 | } | |
73 | ||
211f7ddb | 74 | @Override |
bc2ea776 | 75 | public void setLibrary(BasicLibrary lib) { |
b0e88ebd NR |
76 | this.lib = lib; |
77 | } | |
78 | ||
211f7ddb | 79 | @Override |
9fe3f177 | 80 | public synchronized MetaData getMeta() { |
bc2ea776 NR |
81 | return meta; |
82 | } | |
83 | ||
211f7ddb | 84 | @Override |
bc2ea776 NR |
85 | public synchronized void setMeta(MetaData meta) throws IOException { |
86 | setMeta(meta == null ? null : meta.getLuid()); // must check the library | |
87 | } | |
88 | ||
211f7ddb | 89 | @Override |
bc2ea776 NR |
90 | public synchronized void setMeta(String luid) throws IOException { |
91 | story = null; | |
92 | meta = getLibrary().getInfo(luid); | |
93 | ||
94 | if (meta == null) { | |
92fb0719 | 95 | throw new IOException("Cannot retrieve story from library: " + luid); |
89cb07a6 NR |
96 | } |
97 | } | |
98 | ||
211f7ddb | 99 | @Override |
350bc060 | 100 | public synchronized void setMeta(URL url, Progress pg) throws IOException { |
e0fb1417 | 101 | BasicSupport support = BasicSupport.getSupport(url); |
89cb07a6 | 102 | if (support == null) { |
e0fb1417 | 103 | throw new IOException("URL not supported: " + url.toString()); |
89cb07a6 NR |
104 | } |
105 | ||
0ffa4754 | 106 | story = support.process(pg); |
89cb07a6 NR |
107 | if (story == null) { |
108 | throw new IOException( | |
109 | "Cannot retrieve story from external source: " | |
e0fb1417 | 110 | + url.toString()); |
89cb07a6 | 111 | } |
bc2ea776 NR |
112 | |
113 | meta = story.getMeta(); | |
114 | } | |
115 | ||
211f7ddb | 116 | @Override |
bc2ea776 NR |
117 | public int getChapter() { |
118 | return chapter; | |
89cb07a6 NR |
119 | } |
120 | ||
211f7ddb | 121 | @Override |
bc2ea776 NR |
122 | public void setChapter(int chapter) { |
123 | this.chapter = chapter; | |
6322ab64 NR |
124 | } |
125 | ||
3727aae2 | 126 | /** |
d0114000 NR |
127 | * Return a new {@link BasicReader} ready for use if one is configured. |
128 | * <p> | |
129 | * Can return NULL if none are configured. | |
3727aae2 | 130 | * |
d0114000 | 131 | * @return a {@link BasicReader}, or NULL if none configured |
3727aae2 | 132 | */ |
e42573a0 | 133 | public static Reader getReader() { |
333f0e7b NR |
134 | try { |
135 | if (defaultType != null) { | |
e42573a0 NR |
136 | return (Reader) SerialUtils.createObject(defaultType |
137 | .getTypeName()); | |
d0114000 | 138 | } |
9119671d | 139 | } catch (Exception e) { |
d66deb8d NR |
140 | Instance.getInstance().getTraceHandler() |
141 | .error(new Exception("Cannot create a reader of type: " + defaultType + " (Not compiled in?)", e)); | |
3727aae2 NR |
142 | } |
143 | ||
144 | return null; | |
145 | } | |
146 | ||
147 | /** | |
bc2ea776 | 148 | * The default {@link Reader.ReaderType} used when calling |
3727aae2 NR |
149 | * {@link BasicReader#getReader()}. |
150 | * | |
151 | * @return the default type | |
152 | */ | |
153 | public static ReaderType getDefaultReaderType() { | |
154 | return defaultType; | |
155 | } | |
156 | ||
157 | /** | |
bc2ea776 | 158 | * The default {@link Reader.ReaderType} used when calling |
3727aae2 NR |
159 | * {@link BasicReader#getReader()}. |
160 | * | |
161 | * @param defaultType | |
162 | * the new default type | |
163 | */ | |
164 | public static void setDefaultReaderType(ReaderType defaultType) { | |
165 | BasicReader.defaultType = defaultType; | |
166 | } | |
3b2b638f | 167 | |
b0e88ebd | 168 | /** |
68e2c6d2 NR |
169 | * Change the default {@link LocalLibrary} to open with the |
170 | * {@link BasicReader}s. | |
b0e88ebd NR |
171 | * |
172 | * @param lib | |
68e2c6d2 | 173 | * the new {@link LocalLibrary} |
b0e88ebd | 174 | */ |
68e2c6d2 | 175 | public static void setDefaultLibrary(BasicLibrary lib) { |
b0e88ebd NR |
176 | BasicReader.defaultLibrary = lib; |
177 | } | |
178 | ||
3b2b638f NR |
179 | /** |
180 | * Return an {@link URL} from this {@link String}, be it a file path or an | |
181 | * actual {@link URL}. | |
182 | * | |
183 | * @param sourceString | |
184 | * the source | |
185 | * | |
186 | * @return the corresponding {@link URL} | |
187 | * | |
188 | * @throws MalformedURLException | |
189 | * if this is neither a file nor a conventional {@link URL} | |
190 | */ | |
191 | public static URL getUrl(String sourceString) throws MalformedURLException { | |
192 | if (sourceString == null || sourceString.isEmpty()) { | |
193 | throw new MalformedURLException("Empty url"); | |
194 | } | |
195 | ||
196 | URL source = null; | |
197 | try { | |
198 | source = new URL(sourceString); | |
199 | } catch (MalformedURLException e) { | |
200 | File sourceFile = new File(sourceString); | |
201 | source = sourceFile.toURI().toURL(); | |
202 | } | |
203 | ||
204 | return source; | |
205 | } | |
c1873e56 | 206 | |
df6e2d88 NR |
207 | /** |
208 | * Describe a {@link Story} from its {@link MetaData} and return a list of | |
209 | * title/value that represent this {@link Story}. | |
210 | * | |
211 | * @param meta | |
212 | * the {@link MetaData} to represent | |
213 | * | |
214 | * @return the information | |
215 | */ | |
a6c830bb NR |
216 | public static Map<String, String> getMetaDesc(MetaData meta) { |
217 | Map<String, String> metaDesc = new TreeMap<String, String>(); | |
df6e2d88 NR |
218 | |
219 | // TODO: i18n | |
220 | ||
221 | StringBuilder tags = new StringBuilder(); | |
222 | for (String tag : meta.getTags()) { | |
223 | if (tags.length() > 0) { | |
224 | tags.append(", "); | |
225 | } | |
226 | tags.append(tag); | |
227 | } | |
228 | ||
d16065ec | 229 | // TODO: i18n |
a6c830bb NR |
230 | metaDesc.put("Author", meta.getAuthor()); |
231 | metaDesc.put("Publication date", formatDate(meta.getDate())); | |
232 | metaDesc.put("Published on", meta.getPublisher()); | |
233 | metaDesc.put("URL", meta.getUrl()); | |
d16065ec NR |
234 | String count = ""; |
235 | if (meta.getWords() > 0) { | |
236 | count = StringUtils.formatNumber(meta.getWords()); | |
237 | } | |
a98e49ee | 238 | if (meta.isImageDocument()) { |
d16065ec | 239 | metaDesc.put("Number of images", count); |
a98e49ee | 240 | } else { |
d16065ec | 241 | metaDesc.put("Number of words", count); |
a98e49ee | 242 | } |
a6c830bb NR |
243 | metaDesc.put("Source", meta.getSource()); |
244 | metaDesc.put("Subject", meta.getSubject()); | |
245 | metaDesc.put("Language", meta.getLang()); | |
246 | metaDesc.put("Tags", tags.toString()); | |
df6e2d88 NR |
247 | |
248 | return metaDesc; | |
249 | } | |
250 | ||
5dd985cf NR |
251 | /** |
252 | * Open the {@link Story} with an external reader (the program will be | |
253 | * passed the main file associated with this {@link Story}). | |
254 | * | |
255 | * @param lib | |
256 | * the {@link BasicLibrary} to select the {@link Story} from | |
257 | * @param luid | |
258 | * the {@link Story} LUID | |
350bc060 NR |
259 | * @param sync |
260 | * execute the process synchronously (wait until it is terminated | |
261 | * before returning) | |
5dd985cf NR |
262 | * |
263 | * @throws IOException | |
264 | * in case of I/O error | |
265 | */ | |
16a81ef7 | 266 | @Override |
350bc060 NR |
267 | public void openExternal(BasicLibrary lib, String luid, boolean sync) |
268 | throws IOException { | |
b0e88ebd | 269 | MetaData meta = lib.getInfo(luid); |
ff05b828 | 270 | File target = lib.getFile(luid, null); |
c1873e56 | 271 | |
350bc060 | 272 | openExternal(meta, target, sync); |
c1873e56 NR |
273 | } |
274 | ||
5dd985cf NR |
275 | /** |
276 | * Open the {@link Story} with an external reader (the program will be | |
277 | * passed the given target file). | |
278 | * | |
279 | * @param meta | |
280 | * the {@link Story} to load | |
281 | * @param target | |
282 | * the target {@link File} | |
350bc060 NR |
283 | * @param sync |
284 | * execute the process synchronously (wait until it is terminated | |
285 | * before returning) | |
5dd985cf NR |
286 | * |
287 | * @throws IOException | |
288 | * in case of I/O error | |
289 | */ | |
350bc060 NR |
290 | protected void openExternal(MetaData meta, File target, boolean sync) |
291 | throws IOException { | |
c1873e56 NR |
292 | String program = null; |
293 | if (meta.isImageDocument()) { | |
d66deb8d | 294 | program = Instance.getInstance().getUiConfig().getString(UiConfig.IMAGES_DOCUMENT_READER); |
c1873e56 | 295 | } else { |
d66deb8d | 296 | program = Instance.getInstance().getUiConfig().getString(UiConfig.NON_IMAGES_DOCUMENT_READER); |
c1873e56 NR |
297 | } |
298 | ||
299 | if (program != null && program.trim().isEmpty()) { | |
300 | program = null; | |
301 | } | |
302 | ||
350bc060 | 303 | start(target, program, sync); |
16a81ef7 | 304 | } |
c1873e56 | 305 | |
16a81ef7 NR |
306 | /** |
307 | * Start a file and open it with the given program if given or the first | |
308 | * default system starter we can find. | |
309 | * | |
310 | * @param target | |
311 | * the target to open | |
312 | * @param program | |
313 | * the program to use or NULL for the default system starter | |
350bc060 NR |
314 | * @param sync |
315 | * execute the process synchronously (wait until it is terminated | |
316 | * before returning) | |
16a81ef7 NR |
317 | * |
318 | * @throws IOException | |
319 | * in case of I/O error | |
320 | */ | |
350bc060 NR |
321 | protected void start(File target, String program, boolean sync) |
322 | throws IOException { | |
323 | ||
324 | Process proc = null; | |
16a81ef7 NR |
325 | if (program == null) { |
326 | boolean ok = false; | |
b4f9071c NR |
327 | for (String starter : new String[] { "xdg-open", "open", "see", |
328 | "start", "run" }) { | |
16a81ef7 | 329 | try { |
d66deb8d NR |
330 | Instance.getInstance().getTraceHandler().trace("starting external program"); |
331 | proc = Runtime.getRuntime().exec(new String[] { starter, target.getAbsolutePath() }); | |
16a81ef7 NR |
332 | ok = true; |
333 | break; | |
334 | } catch (IOException e) { | |
335 | } | |
336 | } | |
337 | if (!ok) { | |
338 | throw new IOException("Cannot find a program to start the file"); | |
c1873e56 NR |
339 | } |
340 | } else { | |
d66deb8d | 341 | Instance.getInstance().getTraceHandler().trace("starting external program"); |
350bc060 | 342 | proc = Runtime.getRuntime().exec( |
c1873e56 NR |
343 | new String[] { program, target.getAbsolutePath() }); |
344 | } | |
350bc060 NR |
345 | |
346 | if (proc != null && sync) { | |
9ce8d884 N |
347 | try { |
348 | proc.waitFor(); | |
349 | } catch (InterruptedException e) { | |
350bc060 NR |
350 | } |
351 | } | |
c1873e56 | 352 | } |
df6e2d88 | 353 | |
df6e2d88 NR |
354 | static private String formatDate(String date) { |
355 | long ms = 0; | |
356 | ||
d16065ec | 357 | if (date != null && !date.isEmpty()) { |
df6e2d88 | 358 | try { |
d16065ec | 359 | ms = StringUtils.toTime(date); |
df6e2d88 NR |
360 | } catch (ParseException e) { |
361 | } | |
d16065ec NR |
362 | |
363 | if (ms <= 0) { | |
364 | SimpleDateFormat sdf = new SimpleDateFormat( | |
365 | "yyyy-MM-dd'T'HH:mm:ssSSS"); | |
366 | try { | |
367 | ms = sdf.parse(date).getTime(); | |
368 | } catch (ParseException e) { | |
369 | } | |
370 | } | |
371 | ||
372 | if (ms > 0) { | |
373 | SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd"); | |
374 | return sdf.format(new Date(ms)); | |
375 | } | |
df6e2d88 NR |
376 | } |
377 | ||
d16065ec NR |
378 | if (date == null) { |
379 | date = ""; | |
df6e2d88 NR |
380 | } |
381 | ||
382 | // :( | |
383 | return date; | |
384 | } | |
89cb07a6 | 385 | } |