epub: allow save even if cover is broken
[fanfix.git] / src / be / nikiroo / fanfix / output / Epub.java
CommitLineData
08fe2e33
NR
1package be.nikiroo.fanfix.output;
2
3d247bc3 3import java.io.BufferedWriter;
08fe2e33 4import java.io.File;
ecfb936e 5import java.io.FileInputStream;
3d247bc3 6import java.io.FileOutputStream;
08fe2e33
NR
7import java.io.IOException;
8import java.io.InputStream;
ecfb936e 9import java.io.OutputStream;
3d247bc3 10import java.io.OutputStreamWriter;
ecfb936e
NR
11import java.util.zip.ZipEntry;
12import java.util.zip.ZipOutputStream;
08fe2e33 13
08fe2e33
NR
14import be.nikiroo.fanfix.Instance;
15import be.nikiroo.fanfix.bundles.Config;
16import be.nikiroo.fanfix.bundles.StringId;
17import be.nikiroo.fanfix.data.Chapter;
18import be.nikiroo.fanfix.data.MetaData;
19import be.nikiroo.fanfix.data.Paragraph;
08fe2e33 20import be.nikiroo.fanfix.data.Paragraph.ParagraphType;
3d247bc3 21import be.nikiroo.fanfix.data.Story;
08fe2e33
NR
22import be.nikiroo.utils.IOUtils;
23import be.nikiroo.utils.StringUtils;
24
25class Epub extends BasicOutput {
26 private File tmpDir;
3d247bc3 27 private BufferedWriter writer;
08fe2e33
NR
28 private boolean inDialogue = false;
29 private boolean inNormal = false;
30 private File images;
16a81ef7 31 private boolean nextParaIsCover = true;
08fe2e33
NR
32
33 @Override
34 public File process(Story story, File targetDir, String targetName)
35 throws IOException {
36 String targetNameOrig = targetName;
10d558d2 37 targetName += getDefaultExtension(false);
08fe2e33 38
2aac79c7 39 tmpDir = Instance.getTempFiles().createTempDir("fanfic-reader-epub");
08fe2e33
NR
40 tmpDir.delete();
41
42 if (!tmpDir.mkdir()) {
43 throw new IOException(
44 "Cannot create a temporary directory: no space left on device?");
45 }
46
276f95c6
NR
47 super.process(story, targetDir, targetNameOrig);
48
2aac79c7 49 File epub = null;
ecfb936e 50 try {
2aac79c7
NR
51 // "Originals"
52 File data = new File(tmpDir, "DATA");
53 data.mkdir();
54 BasicOutput.getOutput(OutputType.TEXT, isWriteInfo(),
55 isWriteCover()).process(story, data, targetNameOrig);
56 InfoCover.writeInfo(data, targetNameOrig, story.getMeta());
57 IOUtils.writeSmallFile(data, "version", "3.0");
58
59 // zip/epub
60 epub = new File(targetDir, targetName);
61 IOUtils.zip(tmpDir, epub, true);
62
63 OutputStream out = new FileOutputStream(epub);
ecfb936e 64 try {
2aac79c7 65 ZipOutputStream zip = new ZipOutputStream(out);
ecfb936e 66 try {
2aac79c7
NR
67 // "mimetype" MUST be the first element and not compressed
68 zip.setLevel(ZipOutputStream.STORED);
69 File mimetype = new File(tmpDir, "mimetype");
70 IOUtils.writeSmallFile(tmpDir, "mimetype",
71 "application/epub+zip");
72 ZipEntry entry = new ZipEntry("mimetype");
73 entry.setExtra(new byte[] {});
74 zip.putNextEntry(entry);
75 FileInputStream in = new FileInputStream(mimetype);
76 try {
77 IOUtils.write(in, zip);
78 } finally {
79 in.close();
80 }
81 IOUtils.deltree(mimetype);
82 zip.setLevel(ZipOutputStream.DEFLATED);
83 //
84
85 IOUtils.zip(zip, "", tmpDir, true);
ecfb936e 86 } finally {
2aac79c7 87 zip.close();
ecfb936e 88 }
ecfb936e 89 } finally {
2aac79c7 90 out.close();
ecfb936e
NR
91 }
92 } finally {
2aac79c7
NR
93 IOUtils.deltree(tmpDir);
94 tmpDir = null;
ecfb936e
NR
95 }
96
08fe2e33
NR
97 return epub;
98 }
99
100 @Override
10d558d2 101 public String getDefaultExtension(boolean readerTarget) {
08fe2e33
NR
102 return ".epub";
103 }
104
105 @Override
106 protected void writeStoryHeader(Story story) throws IOException {
107 File ops = new File(tmpDir, "OPS");
108 ops.mkdirs();
109 File css = new File(ops, "css");
110 css.mkdirs();
111 images = new File(ops, "images");
112 images.mkdirs();
113 File metaInf = new File(tmpDir, "META-INF");
114 metaInf.mkdirs();
115
08fe2e33 116 // META-INF
ecfb936e 117 String containerContent = "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n"
08fe2e33
NR
118 + "<container xmlns=\"urn:oasis:names:tc:opendocument:xmlns:container\" version=\"1.0\">\n"
119 + "\t<rootfiles>\n"
120 + "\t\t<rootfile full-path=\"OPS/epb.opf\" media-type=\"application/oebps-package+xml\"/>\n"
121 + "\t</rootfiles>\n" + "</container>\n";
122
123 IOUtils.writeSmallFile(metaInf, "container.xml", containerContent);
124
125 // OPS/css
126 InputStream inStyle = getClass().getResourceAsStream("epub.style.css");
127 if (inStyle == null) {
128 throw new IOException("Cannot find style.css resource");
129 }
130 try {
131 IOUtils.write(inStyle, new File(css, "style.css"));
132 } finally {
133 inStyle.close();
134 }
135
136 // OPS/images
137 if (story.getMeta() != null && story.getMeta().getCover() != null) {
ecfb936e 138 File file = new File(images, "cover");
43c75fb7
NR
139 try {
140 Instance.getCache().saveAsImage(story.getMeta().getCover(),
141 file, true);
142 } catch (Exception e) {
143 Instance.getTraceHandler().error(e);
144 }
08fe2e33
NR
145 }
146
147 // OPS/* except chapters
148 IOUtils.writeSmallFile(ops, "epb.ncx", generateNcx(story));
149 IOUtils.writeSmallFile(ops, "epb.opf", generateOpf(story));
ecfb936e 150 IOUtils.writeSmallFile(ops, "title.xhtml", generateTitleXml(story));
08fe2e33
NR
151
152 // Resume
153 if (story.getMeta() != null && story.getMeta().getResume() != null) {
154 writeChapter(story.getMeta().getResume());
155 }
156 }
157
158 @Override
159 protected void writeChapterHeader(Chapter chap) throws IOException {
160 String filename = String.format("%s%03d%s", "chapter-",
ecfb936e 161 chap.getNumber(), ".xhtml");
3d247bc3
NR
162 writer = new BufferedWriter(new OutputStreamWriter(
163 new FileOutputStream(new File(tmpDir + File.separator + "OPS",
164 filename)), "UTF-8"));
08fe2e33
NR
165 inDialogue = false;
166 inNormal = false;
167 try {
168 String title = "Chapter " + chap.getNumber();
169 String nameOrNum = Integer.toString(chap.getNumber());
170 if (chap.getName() != null && !chap.getName().isEmpty()) {
171 title += ": " + chap.getName();
172 nameOrNum = chap.getName();
173 }
174
ecfb936e
NR
175 writer.append("<?xml version=\"1.0\" encoding=\"utf-8\"?>");
176 writer.append("\n<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.1//EN\" \"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd\">");
177 writer.append("\n<html xmlns=\"http://www.w3.org/1999/xhtml\">");
08fe2e33
NR
178 writer.write("\n<head>");
179 writer.write("\n <title>" + StringUtils.xmlEscape(title)
180 + "</title>");
181 writer.write("\n <link rel='stylesheet' href='css/style.css' type='text/css'/>");
182 writer.write("\n</head>");
183 writer.write("\n<body>");
184 writer.write("\n <h2>");
185 writer.write("\n <span class='chap'>Chapter <span class='chapnumber'>"
186 + chap.getNumber() + "</span>:</span> ");
187 writer.write("\n <span class='chaptitle'>"
188 + StringUtils.xmlEscape(nameOrNum) + "</span>");
189 writer.write("\n </h2>");
190 writer.write("\n ");
191 writer.write("\n <div class='chapter_content'>\n");
192 } catch (Exception e) {
193 writer.close();
194 throw new IOException(e);
195 }
196 }
197
198 @Override
199 protected void writeChapterFooter(Chapter chap) throws IOException {
200 try {
201 if (inDialogue) {
202 writer.write(" </div>\n");
203 inDialogue = false;
204 }
205 if (inNormal) {
206 writer.write(" </div>\n");
207 inNormal = false;
208 }
209 writer.write(" </div>\n</body>\n</html>\n");
210 } finally {
211 writer.close();
212 writer = null;
213 }
214 }
215
216 @Override
217 protected void writeParagraphHeader(Paragraph para) throws IOException {
218 if (para.getType() == ParagraphType.QUOTE && !inDialogue) {
219 writer.write(" <div class='dialogues'>\n");
220 inDialogue = true;
221 } else if (para.getType() != ParagraphType.QUOTE && inDialogue) {
222 writer.write(" </div>\n");
223 inDialogue = false;
224 }
225
226 if (para.getType() == ParagraphType.NORMAL && !inNormal) {
227 writer.write(" <div class='normals'>\n");
228 inNormal = true;
229 } else if (para.getType() != ParagraphType.NORMAL && inNormal) {
230 writer.write(" </div>\n");
231 inNormal = false;
232 }
233
234 switch (para.getType()) {
235 case BLANK:
236 writer.write(" <div class='blank'></div>");
237 break;
238 case BREAK:
f977d05b 239 writer.write(" <hr class='break'/>");
08fe2e33
NR
240 break;
241 case NORMAL:
242 writer.write(" <span class='normal'>");
243 break;
244 case QUOTE:
245 writer.write(" <div class='dialogue'>&mdash; ");
246 break;
247 case IMAGE:
248 File file = new File(images, getCurrentImageBestName(false));
16a81ef7
NR
249 Instance.getCache().saveAsImage(para.getContentImage(), file,
250 nextParaIsCover);
ecfb936e 251 writer.write(" <img alt='page image' class='page-image' src='images/"
08fe2e33
NR
252 + getCurrentImageBestName(false) + "'/>");
253 break;
254 }
16a81ef7
NR
255
256 nextParaIsCover = false;
08fe2e33
NR
257 }
258
259 @Override
260 protected void writeParagraphFooter(Paragraph para) throws IOException {
261 switch (para.getType()) {
262 case NORMAL:
263 writer.write("</span>\n");
264 break;
265 case QUOTE:
266 writer.write("</div>\n");
267 break;
268 default:
269 writer.write("\n");
270 break;
271 }
272 }
273
274 @Override
275 protected void writeTextLine(ParagraphType type, String line)
276 throws IOException {
277 switch (type) {
278 case QUOTE:
279 case NORMAL:
280 writer.write(decorateText(StringUtils.xmlEscape(line)));
281 break;
282 default:
283 break;
284 }
285 }
286
287 @Override
288 protected String enbold(String word) {
289 return "<strong>" + word + "</strong>";
290 }
291
292 @Override
293 protected String italize(String word) {
294 return "<emph>" + word + "</emph>";
295 }
296
297 private String generateNcx(Story story) {
298 StringBuilder builder = new StringBuilder();
299
300 String title = "";
301 String uuid = "";
302 String author = "";
303 if (story.getMeta() != null) {
304 MetaData meta = story.getMeta();
305 uuid = meta.getUuid();
306 author = meta.getAuthor();
307 title = meta.getTitle();
308 }
309
ecfb936e 310 builder.append("<?xml version=\"1.0\" encoding=\"utf-8\"?>");
08fe2e33
NR
311 builder.append("\n<!DOCTYPE ncx");
312 builder.append("\nPUBLIC \"-//NISO//DTD ncx 2005-1//EN\" \"http://www.daisy.org/z3986/2005/ncx-2005-1.dtd\">");
313 builder.append("\n<ncx xmlns=\"http://www.daisy.org/z3986/2005/ncx/\" version=\"2005-1\">");
314 builder.append("\n <head>");
315 builder.append("\n <!--The following four metadata items are required for all");
316 builder.append("\n NCX documents, including those conforming to the relaxed");
317 builder.append("\n constraints of OPS 2.0-->");
318 builder.append("\n <meta name=\"dtb:uid\" content=\""
319 + StringUtils.xmlEscapeQuote(uuid) + "\"/>");
320 builder.append("\n <meta name=\"dtb:depth\" content=\"1\"/>");
321 builder.append("\n <meta name=\"dtb:totalPageCount\" content=\"0\"/>");
322 builder.append("\n <meta name=\"dtb:maxPageNumber\" content=\"0\"/>");
323 builder.append("\n <meta name=\"epub-creator\" content=\""
324 + StringUtils.xmlEscapeQuote(EPUB_CREATOR) + "\"/>");
325 builder.append("\n </head>");
326 builder.append("\n <docTitle>");
327 builder.append("\n <text>" + StringUtils.xmlEscape(title) + "</text>");
328 builder.append("\n </docTitle>");
329 builder.append("\n <docAuthor>");
330
331 builder.append("\n <text>" + StringUtils.xmlEscape(author) + "</text>");
332 builder.append("\n </docAuthor>");
333 builder.append("\n <navMap>");
334 builder.append("\n <navPoint id=\"navpoint-1\" playOrder=\"1\">");
335 builder.append("\n <navLabel>");
336 builder.append("\n <text>Title Page</text>");
337 builder.append("\n </navLabel>");
ecfb936e 338 builder.append("\n <content src=\"title.xhtml\"/>");
08fe2e33
NR
339 builder.append("\n </navPoint>");
340
341 int navPoint = 2; // 1 is above
342
343 if (story.getMeta() != null & story.getMeta().getResume() != null) {
344 Chapter chap = story.getMeta().getResume();
345 generateNcx(chap, builder, navPoint++);
346 }
347
348 for (Chapter chap : story) {
349 generateNcx(chap, builder, navPoint++);
350 }
351
352 builder.append("\n </navMap>");
353 builder.append("\n</ncx>\n");
354
355 return builder.toString();
356 }
357
358 private void generateNcx(Chapter chap, StringBuilder builder, int navPoint) {
359 String name;
360 if (chap.getName() != null && !chap.getName().isEmpty()) {
361 name = Instance.getTrans().getString(StringId.CHAPTER_NAMED,
362 chap.getNumber(), chap.getName());
363 } else {
364 name = Instance.getTrans().getString(StringId.CHAPTER_UNNAMED,
365 chap.getNumber());
366 }
367
368 String nnn = String.format("%03d", (navPoint - 2));
369
370 builder.append("\n <navPoint id=\"navpoint-" + navPoint
371 + "\" playOrder=\"" + navPoint + "\">");
372 builder.append("\n <navLabel>");
373 builder.append("\n <text>" + name + "</text>");
374 builder.append("\n </navLabel>");
ecfb936e 375 builder.append("\n <content src=\"chapter-" + nnn + ".xhtml\"/>");
08fe2e33
NR
376 builder.append("\n </navPoint>\n");
377 }
378
379 private String generateOpf(Story story) {
380 StringBuilder builder = new StringBuilder();
381
382 String title = "";
383 String uuid = "";
384 String author = "";
385 String date = "";
386 String publisher = "";
387 String subject = "";
388 String source = "";
389 String lang = "";
390 if (story.getMeta() != null) {
391 MetaData meta = story.getMeta();
392 title = meta.getTitle();
393 uuid = meta.getUuid();
394 author = meta.getAuthor();
395 date = meta.getDate();
396 publisher = meta.getPublisher();
397 subject = meta.getSubject();
398 source = meta.getSource();
399 lang = meta.getLang();
400 }
401
ecfb936e
NR
402 builder.append("<?xml version=\"1.0\" encoding=\"utf-8\"?>");
403 builder.append("\n<package xmlns=\"http://www.idpf.org/2007/opf\" unique-identifier=\"BookId\" version=\"2.0\">");
08fe2e33
NR
404 builder.append("\n <metadata xmlns:opf=\"http://www.idpf.org/2007/opf\"");
405 builder.append("\n xmlns:dc=\"http://purl.org/dc/elements/1.1/\">");
406 builder.append("\n <dc:title>" + StringUtils.xmlEscape(title)
407 + "</dc:title>");
408 builder.append("\n <dc:creator opf:role=\"aut\" opf:file-as=\""
409 + StringUtils.xmlEscapeQuote(author) + "\">"
410 + StringUtils.xmlEscape(author) + "</dc:creator>");
411 builder.append("\n <dc:date opf:event=\"original-publication\">"
412 + StringUtils.xmlEscape(date) + "</dc:date>");
413 builder.append("\n <dc:publisher>"
414 + StringUtils.xmlEscape(publisher) + "</dc:publisher>");
415 builder.append("\n <dc:date opf:event=\"epub-publication\"></dc:date>");
416 builder.append("\n <dc:subject>" + StringUtils.xmlEscape(subject)
417 + "</dc:subject>");
418 builder.append("\n <dc:source>" + StringUtils.xmlEscape(source)
419 + "</dc:source>");
420 builder.append("\n <dc:rights>Not for commercial use.</dc:rights>");
ecfb936e 421 builder.append("\n <dc:identifier id=\"BookId\" opf:scheme=\"URI\">"
08fe2e33
NR
422 + StringUtils.xmlEscape(uuid) + "</dc:identifier>");
423 builder.append("\n <dc:language>" + StringUtils.xmlEscape(lang)
424 + "</dc:language>");
425 builder.append("\n </metadata>");
426 builder.append("\n <manifest>");
427 builder.append("\n <!-- Content Documents -->");
ecfb936e 428 builder.append("\n <item id=\"titlepage\" href=\"title.xhtml\" media-type=\"application/xhtml+xml\"/>");
08fe2e33
NR
429 for (int i = 0; i <= story.getChapters().size(); i++) {
430 String name = String.format("%s%03d", "chapter-", i);
431 builder.append("\n <item id=\""
432 + StringUtils.xmlEscapeQuote(name) + "\" href=\""
433 + StringUtils.xmlEscapeQuote(name)
ecfb936e 434 + ".xhtml\" media-type=\"application/xhtml+xml\"/>");
08fe2e33
NR
435 }
436
437 builder.append("\n <!-- CSS Style Sheets -->");
438 builder.append("\n <item id=\"style-css\" href=\"css/style.css\" media-type=\"text/css\"/>");
439
440 builder.append("\n <!-- Images -->");
441
442 if (story.getMeta() != null && story.getMeta().getCover() != null) {
443 String format = Instance.getConfig()
43c75fb7
NR
444 .getString(Config.FILE_FORMAT_IMAGE_FORMAT_COVER)
445 .toLowerCase();
08fe2e33
NR
446 builder.append("\n <item id=\"cover\" href=\"images/cover."
447 + format + "\" media-type=\"image/png\"/>");
448 }
449
450 builder.append("\n <!-- NCX -->");
451 builder.append("\n <item id=\"ncx\" href=\"epb.ncx\" media-type=\"application/x-dtbncx+xml\"/>");
452 builder.append("\n </manifest>");
453 builder.append("\n <spine toc=\"ncx\">");
454 builder.append("\n <itemref idref=\"titlepage\" linear=\"yes\"/>");
455 for (int i = 0; i <= story.getChapters().size(); i++) {
456 String name = String.format("%s%03d", "chapter-", i);
457 builder.append("\n <itemref idref=\""
458 + StringUtils.xmlEscapeQuote(name) + "\" linear=\"yes\"/>");
459 }
460 builder.append("\n </spine>");
461 builder.append("\n</package>\n");
462
463 return builder.toString();
464 }
465
466 private String generateTitleXml(Story story) {
467 StringBuilder builder = new StringBuilder();
468
469 String title = "";
470 String tags = "";
471 String author = "";
472 if (story.getMeta() != null) {
473 MetaData meta = story.getMeta();
474 title = meta.getTitle();
475 if (meta.getTags() != null) {
476 for (String tag : meta.getTags()) {
477 if (!tags.isEmpty()) {
478 tags += ", ";
479 }
480 tags += tag;
481 }
482
483 if (!tags.isEmpty()) {
484 tags = "(" + tags + ")";
485 }
486 }
487 author = meta.getAuthor();
488 }
489
490 String format = Instance.getConfig()
13fdb89a 491 .getString(Config.FILE_FORMAT_IMAGE_FORMAT_COVER).toLowerCase();
08fe2e33 492
ecfb936e
NR
493 builder.append("<?xml version=\"1.0\" encoding=\"utf-8\"?>");
494 builder.append("\n<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.1//EN\" \"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd\">");
495 builder.append("\n<html xmlns=\"http://www.w3.org/1999/xhtml\">");
08fe2e33
NR
496 builder.append("\n<head>");
497 builder.append("\n <title>" + StringUtils.xmlEscape(title) + "</title>");
498 builder.append("\n <link rel=\"stylesheet\" href=\"css/style.css\" type=\"text/css\"/>");
499 builder.append("\n</head>");
500 builder.append("\n<body>");
501 builder.append("\n <div class=\"titlepage\">");
502 builder.append("\n <h1>" + StringUtils.xmlEscape(title) + "</h1>");
503 builder.append("\n <div class=\"type\">"
504 + StringUtils.xmlEscape(tags) + "</div>");
505 builder.append("\n <div class=\"cover\">");
ecfb936e
NR
506 builder.append("\n <img alt=\"cover image\" src=\"images/cover."
507 + format + "\"></img>");
08fe2e33
NR
508 builder.append("\n </div>");
509 builder.append("\n <div class=\"author\">"
510 + StringUtils.xmlEscape(author) + "</div>");
511 builder.append("\n </div>");
512 builder.append("\n</body>");
513 builder.append("\n</html>\n");
514
515 return builder.toString();
516 }
517}