1 package be
.nikiroo
.fanfix
.output
;
3 import java
.io
.BufferedWriter
;
5 import java
.io
.FileInputStream
;
6 import java
.io
.FileOutputStream
;
7 import java
.io
.IOException
;
8 import java
.io
.InputStream
;
9 import java
.io
.OutputStream
;
10 import java
.io
.OutputStreamWriter
;
11 import java
.util
.zip
.ZipEntry
;
12 import java
.util
.zip
.ZipOutputStream
;
14 import be
.nikiroo
.fanfix
.Instance
;
15 import be
.nikiroo
.fanfix
.bundles
.Config
;
16 import be
.nikiroo
.fanfix
.bundles
.StringId
;
17 import be
.nikiroo
.fanfix
.data
.Chapter
;
18 import be
.nikiroo
.fanfix
.data
.MetaData
;
19 import be
.nikiroo
.fanfix
.data
.Paragraph
;
20 import be
.nikiroo
.fanfix
.data
.Paragraph
.ParagraphType
;
21 import be
.nikiroo
.fanfix
.data
.Story
;
22 import be
.nikiroo
.utils
.IOUtils
;
23 import be
.nikiroo
.utils
.StringUtils
;
25 class Epub
extends BasicOutput
{
27 private BufferedWriter writer
;
28 private boolean inDialogue
= false;
29 private boolean inNormal
= false;
31 private boolean nextParaIsCover
= true;
34 public File
process(Story story
, File targetDir
, String targetName
)
36 String targetNameOrig
= targetName
;
37 targetName
+= getDefaultExtension(false);
39 tmpDir
= File
.createTempFile("fanfic-reader-epub_", ".wip");
42 if (!tmpDir
.mkdir()) {
43 throw new IOException(
44 "Cannot create a temporary directory: no space left on device?");
48 File data
= new File(tmpDir
, "DATA");
50 BasicOutput
.getOutput(OutputType
.TEXT
, isWriteInfo(), isWriteCover())
51 .process(story
, data
, targetNameOrig
);
52 InfoCover
.writeInfo(data
, targetNameOrig
, story
.getMeta());
53 IOUtils
.writeSmallFile(data
, "version", "3.0");
55 super.process(story
, targetDir
, targetNameOrig
);
58 File epub
= new File(targetDir
, targetName
);
59 IOUtils
.zip(tmpDir
, epub
, true);
61 OutputStream out
= new FileOutputStream(epub
);
63 ZipOutputStream zip
= new ZipOutputStream(out
);
65 // "mimetype" MUST be the first element and not compressed
66 zip
.setLevel(ZipOutputStream
.STORED
);
67 File mimetype
= new File(tmpDir
, "mimetype");
68 IOUtils
.writeSmallFile(tmpDir
, "mimetype",
69 "application/epub+zip");
70 ZipEntry entry
= new ZipEntry("mimetype");
71 entry
.setExtra(new byte[] {});
72 zip
.putNextEntry(entry
);
73 FileInputStream in
= new FileInputStream(mimetype
);
75 IOUtils
.write(in
, zip
);
79 IOUtils
.deltree(mimetype
);
80 zip
.setLevel(ZipOutputStream
.DEFLATED
);
83 IOUtils
.zip(zip
, "", tmpDir
, true);
91 IOUtils
.deltree(tmpDir
);
98 public String
getDefaultExtension(boolean readerTarget
) {
103 protected void writeStoryHeader(Story story
) throws IOException
{
104 File ops
= new File(tmpDir
, "OPS");
106 File css
= new File(ops
, "css");
108 images
= new File(ops
, "images");
110 File metaInf
= new File(tmpDir
, "META-INF");
114 String containerContent
= "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n"
115 + "<container xmlns=\"urn:oasis:names:tc:opendocument:xmlns:container\" version=\"1.0\">\n"
117 + "\t\t<rootfile full-path=\"OPS/epb.opf\" media-type=\"application/oebps-package+xml\"/>\n"
118 + "\t</rootfiles>\n" + "</container>\n";
120 IOUtils
.writeSmallFile(metaInf
, "container.xml", containerContent
);
123 InputStream inStyle
= getClass().getResourceAsStream("epub.style.css");
124 if (inStyle
== null) {
125 throw new IOException("Cannot find style.css resource");
128 IOUtils
.write(inStyle
, new File(css
, "style.css"));
134 if (story
.getMeta() != null && story
.getMeta().getCover() != null) {
135 File file
= new File(images
, "cover");
136 Instance
.getCache().saveAsImage(story
.getMeta().getCover(), file
,
140 // OPS/* except chapters
141 IOUtils
.writeSmallFile(ops
, "epb.ncx", generateNcx(story
));
142 IOUtils
.writeSmallFile(ops
, "epb.opf", generateOpf(story
));
143 IOUtils
.writeSmallFile(ops
, "title.xhtml", generateTitleXml(story
));
146 if (story
.getMeta() != null && story
.getMeta().getResume() != null) {
147 writeChapter(story
.getMeta().getResume());
152 protected void writeChapterHeader(Chapter chap
) throws IOException
{
153 String filename
= String
.format("%s%03d%s", "chapter-",
154 chap
.getNumber(), ".xhtml");
155 writer
= new BufferedWriter(new OutputStreamWriter(
156 new FileOutputStream(new File(tmpDir
+ File
.separator
+ "OPS",
157 filename
)), "UTF-8"));
161 String title
= "Chapter " + chap
.getNumber();
162 String nameOrNum
= Integer
.toString(chap
.getNumber());
163 if (chap
.getName() != null && !chap
.getName().isEmpty()) {
164 title
+= ": " + chap
.getName();
165 nameOrNum
= chap
.getName();
168 writer
.append("<?xml version=\"1.0\" encoding=\"utf-8\"?>");
169 writer
.append("\n<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.1//EN\" \"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd\">");
170 writer
.append("\n<html xmlns=\"http://www.w3.org/1999/xhtml\">");
171 writer
.write("\n<head>");
172 writer
.write("\n <title>" + StringUtils
.xmlEscape(title
)
174 writer
.write("\n <link rel='stylesheet' href='css/style.css' type='text/css'/>");
175 writer
.write("\n</head>");
176 writer
.write("\n<body>");
177 writer
.write("\n <h2>");
178 writer
.write("\n <span class='chap'>Chapter <span class='chapnumber'>"
179 + chap
.getNumber() + "</span>:</span> ");
180 writer
.write("\n <span class='chaptitle'>"
181 + StringUtils
.xmlEscape(nameOrNum
) + "</span>");
182 writer
.write("\n </h2>");
184 writer
.write("\n <div class='chapter_content'>\n");
185 } catch (Exception e
) {
187 throw new IOException(e
);
192 protected void writeChapterFooter(Chapter chap
) throws IOException
{
195 writer
.write(" </div>\n");
199 writer
.write(" </div>\n");
202 writer
.write(" </div>\n</body>\n</html>\n");
210 protected void writeParagraphHeader(Paragraph para
) throws IOException
{
211 if (para
.getType() == ParagraphType
.QUOTE
&& !inDialogue
) {
212 writer
.write(" <div class='dialogues'>\n");
214 } else if (para
.getType() != ParagraphType
.QUOTE
&& inDialogue
) {
215 writer
.write(" </div>\n");
219 if (para
.getType() == ParagraphType
.NORMAL
&& !inNormal
) {
220 writer
.write(" <div class='normals'>\n");
222 } else if (para
.getType() != ParagraphType
.NORMAL
&& inNormal
) {
223 writer
.write(" </div>\n");
227 switch (para
.getType()) {
229 writer
.write(" <div class='blank'></div>");
232 writer
.write(" <hr class='break'/>");
235 writer
.write(" <span class='normal'>");
238 writer
.write(" <div class='dialogue'>— ");
241 File file
= new File(images
, getCurrentImageBestName(false));
242 Instance
.getCache().saveAsImage(para
.getContentImage(), file
,
244 writer
.write(" <img alt='page image' class='page-image' src='images/"
245 + getCurrentImageBestName(false) + "'/>");
249 nextParaIsCover
= false;
253 protected void writeParagraphFooter(Paragraph para
) throws IOException
{
254 switch (para
.getType()) {
256 writer
.write("</span>\n");
259 writer
.write("</div>\n");
268 protected void writeTextLine(ParagraphType type
, String line
)
273 writer
.write(decorateText(StringUtils
.xmlEscape(line
)));
281 protected String
enbold(String word
) {
282 return "<strong>" + word
+ "</strong>";
286 protected String
italize(String word
) {
287 return "<emph>" + word
+ "</emph>";
290 private String
generateNcx(Story story
) {
291 StringBuilder builder
= new StringBuilder();
296 if (story
.getMeta() != null) {
297 MetaData meta
= story
.getMeta();
298 uuid
= meta
.getUuid();
299 author
= meta
.getAuthor();
300 title
= meta
.getTitle();
303 builder
.append("<?xml version=\"1.0\" encoding=\"utf-8\"?>");
304 builder
.append("\n<!DOCTYPE ncx");
305 builder
.append("\nPUBLIC \"-//NISO//DTD ncx 2005-1//EN\" \"http://www.daisy.org/z3986/2005/ncx-2005-1.dtd\">");
306 builder
.append("\n<ncx xmlns=\"http://www.daisy.org/z3986/2005/ncx/\" version=\"2005-1\">");
307 builder
.append("\n <head>");
308 builder
.append("\n <!--The following four metadata items are required for all");
309 builder
.append("\n NCX documents, including those conforming to the relaxed");
310 builder
.append("\n constraints of OPS 2.0-->");
311 builder
.append("\n <meta name=\"dtb:uid\" content=\""
312 + StringUtils
.xmlEscapeQuote(uuid
) + "\"/>");
313 builder
.append("\n <meta name=\"dtb:depth\" content=\"1\"/>");
314 builder
.append("\n <meta name=\"dtb:totalPageCount\" content=\"0\"/>");
315 builder
.append("\n <meta name=\"dtb:maxPageNumber\" content=\"0\"/>");
316 builder
.append("\n <meta name=\"epub-creator\" content=\""
317 + StringUtils
.xmlEscapeQuote(EPUB_CREATOR
) + "\"/>");
318 builder
.append("\n </head>");
319 builder
.append("\n <docTitle>");
320 builder
.append("\n <text>" + StringUtils
.xmlEscape(title
) + "</text>");
321 builder
.append("\n </docTitle>");
322 builder
.append("\n <docAuthor>");
324 builder
.append("\n <text>" + StringUtils
.xmlEscape(author
) + "</text>");
325 builder
.append("\n </docAuthor>");
326 builder
.append("\n <navMap>");
327 builder
.append("\n <navPoint id=\"navpoint-1\" playOrder=\"1\">");
328 builder
.append("\n <navLabel>");
329 builder
.append("\n <text>Title Page</text>");
330 builder
.append("\n </navLabel>");
331 builder
.append("\n <content src=\"title.xhtml\"/>");
332 builder
.append("\n </navPoint>");
334 int navPoint
= 2; // 1 is above
336 if (story
.getMeta() != null & story
.getMeta().getResume() != null) {
337 Chapter chap
= story
.getMeta().getResume();
338 generateNcx(chap
, builder
, navPoint
++);
341 for (Chapter chap
: story
) {
342 generateNcx(chap
, builder
, navPoint
++);
345 builder
.append("\n </navMap>");
346 builder
.append("\n</ncx>\n");
348 return builder
.toString();
351 private void generateNcx(Chapter chap
, StringBuilder builder
, int navPoint
) {
353 if (chap
.getName() != null && !chap
.getName().isEmpty()) {
354 name
= Instance
.getTrans().getString(StringId
.CHAPTER_NAMED
,
355 chap
.getNumber(), chap
.getName());
357 name
= Instance
.getTrans().getString(StringId
.CHAPTER_UNNAMED
,
361 String nnn
= String
.format("%03d", (navPoint
- 2));
363 builder
.append("\n <navPoint id=\"navpoint-" + navPoint
364 + "\" playOrder=\"" + navPoint
+ "\">");
365 builder
.append("\n <navLabel>");
366 builder
.append("\n <text>" + name
+ "</text>");
367 builder
.append("\n </navLabel>");
368 builder
.append("\n <content src=\"chapter-" + nnn
+ ".xhtml\"/>");
369 builder
.append("\n </navPoint>\n");
372 private String
generateOpf(Story story
) {
373 StringBuilder builder
= new StringBuilder();
379 String publisher
= "";
383 if (story
.getMeta() != null) {
384 MetaData meta
= story
.getMeta();
385 title
= meta
.getTitle();
386 uuid
= meta
.getUuid();
387 author
= meta
.getAuthor();
388 date
= meta
.getDate();
389 publisher
= meta
.getPublisher();
390 subject
= meta
.getSubject();
391 source
= meta
.getSource();
392 lang
= meta
.getLang();
395 builder
.append("<?xml version=\"1.0\" encoding=\"utf-8\"?>");
396 builder
.append("\n<package xmlns=\"http://www.idpf.org/2007/opf\" unique-identifier=\"BookId\" version=\"2.0\">");
397 builder
.append("\n <metadata xmlns:opf=\"http://www.idpf.org/2007/opf\"");
398 builder
.append("\n xmlns:dc=\"http://purl.org/dc/elements/1.1/\">");
399 builder
.append("\n <dc:title>" + StringUtils
.xmlEscape(title
)
401 builder
.append("\n <dc:creator opf:role=\"aut\" opf:file-as=\""
402 + StringUtils
.xmlEscapeQuote(author
) + "\">"
403 + StringUtils
.xmlEscape(author
) + "</dc:creator>");
404 builder
.append("\n <dc:date opf:event=\"original-publication\">"
405 + StringUtils
.xmlEscape(date
) + "</dc:date>");
406 builder
.append("\n <dc:publisher>"
407 + StringUtils
.xmlEscape(publisher
) + "</dc:publisher>");
408 builder
.append("\n <dc:date opf:event=\"epub-publication\"></dc:date>");
409 builder
.append("\n <dc:subject>" + StringUtils
.xmlEscape(subject
)
411 builder
.append("\n <dc:source>" + StringUtils
.xmlEscape(source
)
413 builder
.append("\n <dc:rights>Not for commercial use.</dc:rights>");
414 builder
.append("\n <dc:identifier id=\"BookId\" opf:scheme=\"URI\">"
415 + StringUtils
.xmlEscape(uuid
) + "</dc:identifier>");
416 builder
.append("\n <dc:language>" + StringUtils
.xmlEscape(lang
)
418 builder
.append("\n </metadata>");
419 builder
.append("\n <manifest>");
420 builder
.append("\n <!-- Content Documents -->");
421 builder
.append("\n <item id=\"titlepage\" href=\"title.xhtml\" media-type=\"application/xhtml+xml\"/>");
422 for (int i
= 0; i
<= story
.getChapters().size(); i
++) {
423 String name
= String
.format("%s%03d", "chapter-", i
);
424 builder
.append("\n <item id=\""
425 + StringUtils
.xmlEscapeQuote(name
) + "\" href=\""
426 + StringUtils
.xmlEscapeQuote(name
)
427 + ".xhtml\" media-type=\"application/xhtml+xml\"/>");
430 builder
.append("\n <!-- CSS Style Sheets -->");
431 builder
.append("\n <item id=\"style-css\" href=\"css/style.css\" media-type=\"text/css\"/>");
433 builder
.append("\n <!-- Images -->");
435 if (story
.getMeta() != null && story
.getMeta().getCover() != null) {
436 String format
= Instance
.getConfig()
437 .getString(Config
.IMAGE_FORMAT_COVER
).toLowerCase();
438 builder
.append("\n <item id=\"cover\" href=\"images/cover."
439 + format
+ "\" media-type=\"image/png\"/>");
442 builder
.append("\n <!-- NCX -->");
443 builder
.append("\n <item id=\"ncx\" href=\"epb.ncx\" media-type=\"application/x-dtbncx+xml\"/>");
444 builder
.append("\n </manifest>");
445 builder
.append("\n <spine toc=\"ncx\">");
446 builder
.append("\n <itemref idref=\"titlepage\" linear=\"yes\"/>");
447 for (int i
= 0; i
<= story
.getChapters().size(); i
++) {
448 String name
= String
.format("%s%03d", "chapter-", i
);
449 builder
.append("\n <itemref idref=\""
450 + StringUtils
.xmlEscapeQuote(name
) + "\" linear=\"yes\"/>");
452 builder
.append("\n </spine>");
453 builder
.append("\n</package>\n");
455 return builder
.toString();
458 private String
generateTitleXml(Story story
) {
459 StringBuilder builder
= new StringBuilder();
464 if (story
.getMeta() != null) {
465 MetaData meta
= story
.getMeta();
466 title
= meta
.getTitle();
467 if (meta
.getTags() != null) {
468 for (String tag
: meta
.getTags()) {
469 if (!tags
.isEmpty()) {
475 if (!tags
.isEmpty()) {
476 tags
= "(" + tags
+ ")";
479 author
= meta
.getAuthor();
482 String format
= Instance
.getConfig()
483 .getString(Config
.IMAGE_FORMAT_COVER
).toLowerCase();
485 builder
.append("<?xml version=\"1.0\" encoding=\"utf-8\"?>");
486 builder
.append("\n<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.1//EN\" \"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd\">");
487 builder
.append("\n<html xmlns=\"http://www.w3.org/1999/xhtml\">");
488 builder
.append("\n<head>");
489 builder
.append("\n <title>" + StringUtils
.xmlEscape(title
) + "</title>");
490 builder
.append("\n <link rel=\"stylesheet\" href=\"css/style.css\" type=\"text/css\"/>");
491 builder
.append("\n</head>");
492 builder
.append("\n<body>");
493 builder
.append("\n <div class=\"titlepage\">");
494 builder
.append("\n <h1>" + StringUtils
.xmlEscape(title
) + "</h1>");
495 builder
.append("\n <div class=\"type\">"
496 + StringUtils
.xmlEscape(tags
) + "</div>");
497 builder
.append("\n <div class=\"cover\">");
498 builder
.append("\n <img alt=\"cover image\" src=\"images/cover."
499 + format
+ "\"></img>");
500 builder
.append("\n </div>");
501 builder
.append("\n <div class=\"author\">"
502 + StringUtils
.xmlEscape(author
) + "</div>");
503 builder
.append("\n </div>");
504 builder
.append("\n</body>");
505 builder
.append("\n</html>\n");
507 return builder
.toString();