Update from master
[fanfix.git] / supported / Cbz.java
1 package be.nikiroo.fanfix.supported;
2
3 import java.io.File;
4 import java.io.IOException;
5 import java.io.InputStream;
6 import java.net.URL;
7 import java.util.ArrayList;
8 import java.util.Collections;
9 import java.util.HashMap;
10 import java.util.List;
11 import java.util.Map;
12 import java.util.zip.ZipEntry;
13 import java.util.zip.ZipInputStream;
14
15 import be.nikiroo.fanfix.Instance;
16 import be.nikiroo.fanfix.bundles.Config;
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.Image;
24 import be.nikiroo.utils.Progress;
25 import be.nikiroo.utils.streams.MarkableFileInputStream;
26
27 /**
28 * Support class for CBZ files (works better with CBZ created with this program,
29 * as they have some metadata available).
30 *
31 * @author niki
32 */
33 class Cbz extends Epub {
34 @Override
35 protected boolean supports(URL url) {
36 return url.toString().toLowerCase().endsWith(".cbz");
37 }
38
39 @Override
40 protected String getDataPrefix() {
41 return "";
42 }
43
44 @Override
45 protected boolean requireInfo() {
46 return false;
47 }
48
49 @Override
50 protected boolean isImagesDocumentByDefault() {
51 return true;
52 }
53
54 @Override
55 protected boolean getCover() {
56 return false;
57 }
58
59 @Override
60 public Story doProcess(Progress pg) throws IOException {
61 if (pg == null) {
62 pg = new Progress();
63 } else {
64 pg.setMinMax(0, 100);
65 }
66
67 pg.setName("Initialising");
68
69 Progress pgMeta = new Progress();
70 pg.addProgress(pgMeta, 10);
71 Story story = processMeta(true, pgMeta);
72 MetaData meta = story.getMeta();
73
74 pgMeta.done(); // 10%
75
76 File tmpDir = Instance.getInstance().getTempFiles().createTempDir("info-text");
77 String basename = null;
78
79 Map<String, Image> images = new HashMap<String, Image>();
80 InputStream cbzIn = null;
81 ZipInputStream zipIn = null;
82 try {
83 cbzIn = new MarkableFileInputStream(getSourceFileOriginal());
84 zipIn = new ZipInputStream(cbzIn);
85 for (ZipEntry entry = zipIn.getNextEntry(); entry != null; entry = zipIn
86 .getNextEntry()) {
87 if (!entry.isDirectory()
88 && entry.getName().startsWith(getDataPrefix())) {
89 String entryLName = entry.getName().toLowerCase();
90 boolean imageEntry = false;
91 for (String ext : bsImages.getImageExt(false)) {
92 if (entryLName.endsWith(ext)) {
93 imageEntry = true;
94 }
95 }
96
97 if (imageEntry) {
98 String uuid = meta.getUuid() + "_" + entry.getName();
99 try {
100 images.put(uuid, new Image(zipIn));
101 } catch (Exception e) {
102 Instance.getInstance().getTraceHandler().error(e);
103 }
104
105 if (pg.getProgress() < 85) {
106 pg.add(1);
107 }
108 } else if (entryLName.endsWith(".info")) {
109 basename = entryLName.substring(0, entryLName.length()
110 - ".info".length());
111 IOUtils.write(zipIn, new File(tmpDir, entryLName));
112 } else if (entryLName.endsWith(".txt")) {
113 IOUtils.write(zipIn, new File(tmpDir, entryLName));
114 }
115 }
116 }
117
118 String ext = "."
119 + Instance.getInstance().getConfig().getString(Config.FILE_FORMAT_IMAGE_FORMAT_COVER).toLowerCase();
120 String coverName = meta.getUuid() + "_" + basename + ext;
121 Image cover = images.get(coverName);
122 images.remove(coverName);
123
124 pg.setProgress(85);
125
126 // ZIP order is not correct for us
127 List<String> imagesList = new ArrayList<String>(images.keySet());
128 Collections.sort(imagesList);
129
130 pg.setProgress(90);
131
132 // only the description/cover is kept
133 Story origStory = getStoryFromTxt(tmpDir, basename);
134 if (origStory != null) {
135 if (origStory.getMeta().getCover() == null) {
136 origStory.getMeta().setCover(story.getMeta().getCover());
137 }
138 story.setMeta(origStory.getMeta());
139 }
140 if (story.getMeta().getCover() == null) {
141 story.getMeta().setCover(cover);
142 }
143 story.setChapters(new ArrayList<Chapter>());
144
145 // Check if we can find non-images chapters, for hybrid-cbz support
146 if (origStory != null) {
147 for (Chapter chap : origStory) {
148 Boolean isImages = null;
149 for (Paragraph para : chap) {
150 ParagraphType t = para.getType();
151 if (isImages == null && !t.isText(true)) {
152 isImages = true;
153 }
154 if (t.isText(false)) {
155 String line = para.getContent();
156 // Images are saved in text mode as "[image-link]"
157 if (!(line.startsWith("[") && line.endsWith("]"))) {
158 isImages = false;
159 }
160 }
161 }
162
163 if (isImages != null && !isImages) {
164 story.getChapters().add(chap);
165 chap.setNumber(story.getChapters().size());
166 }
167 }
168 }
169
170 if (!imagesList.isEmpty()) {
171 Chapter chap = new Chapter(story.getChapters().size() + 1, "");
172 story.getChapters().add(chap);
173
174 for (String uuid : imagesList) {
175 try {
176 chap.getParagraphs().add(
177 new Paragraph(images.get(uuid)));
178 } catch (Exception e) {
179 Instance.getInstance().getTraceHandler().error(e);
180 }
181 }
182 }
183
184 if (meta.getCover() == null && !images.isEmpty()) {
185 meta.setCover(images.get(imagesList.get(0)));
186 meta.setFakeCover(true);
187 }
188 } finally {
189 IOUtils.deltree(tmpDir);
190 if (zipIn != null) {
191 zipIn.close();
192 }
193 if (cbzIn != null) {
194 cbzIn.close();
195 }
196 }
197
198 pg.done();
199 return story;
200 }
201
202 private Story getStoryFromTxt(File tmpDir, String basename) {
203 Story origStory = null;
204
205 File txt = new File(tmpDir, basename + ".txt");
206 if (!txt.exists()) {
207 basename = null;
208 }
209 if (basename != null) {
210 try {
211 BasicSupport support = BasicSupport.getSupport(txt.toURI()
212 .toURL());
213 origStory = support.process(null);
214 } catch (Exception e) {
215 basename = null;
216 }
217 }
218
219 return origStory;
220
221 }
222 }