Merge branch 'subtree'
[fanfix.git] / src / be / nikiroo / fanfix / supported / Cbz.java
CommitLineData
08fe2e33
NR
1package be.nikiroo.fanfix.supported;
2
2aac79c7 3import java.io.File;
08fe2e33 4import java.io.IOException;
298d405a 5import java.io.InputStream;
08fe2e33
NR
6import java.net.URL;
7import java.util.ArrayList;
d3c84ac3 8import java.util.Collections;
2a25f781 9import java.util.HashMap;
d3c84ac3 10import java.util.List;
2a25f781 11import java.util.Map;
08fe2e33
NR
12import java.util.zip.ZipEntry;
13import java.util.zip.ZipInputStream;
14
15import be.nikiroo.fanfix.Instance;
45994ba5 16import be.nikiroo.fanfix.bundles.Config;
08fe2e33 17import be.nikiroo.fanfix.data.Chapter;
7445f856 18import be.nikiroo.fanfix.data.MetaData;
08fe2e33 19import be.nikiroo.fanfix.data.Paragraph;
e5a2f1b3 20import be.nikiroo.fanfix.data.Paragraph.ParagraphType;
08fe2e33 21import be.nikiroo.fanfix.data.Story;
2aac79c7 22import be.nikiroo.utils.IOUtils;
16a81ef7 23import be.nikiroo.utils.Image;
3b2b638f 24import be.nikiroo.utils.Progress;
c289a297 25import be.nikiroo.utils.streams.MarkableFileInputStream;
08fe2e33
NR
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 */
33class Cbz extends Epub {
34 @Override
35 protected boolean supports(URL url) {
36 return url.toString().toLowerCase().endsWith(".cbz");
37 }
38
08fe2e33
NR
39 @Override
40 protected String getDataPrefix() {
41 return "";
42 }
43
44 @Override
45 protected boolean requireInfo() {
46 return false;
47 }
08fe2e33
NR
48
49 @Override
e4fa48a0
NR
50 protected boolean isImagesDocumentByDefault() {
51 return true;
08fe2e33
NR
52 }
53
68686a37 54 @Override
e4fa48a0
NR
55 protected boolean getCover() {
56 return false;
68686a37
NR
57 }
58
08fe2e33 59 @Override
9005532f 60 public Story doProcess(Progress pg) throws IOException {
92fb0719
NR
61 if (pg == null) {
62 pg = new Progress();
63 } else {
64 pg.setMinMax(0, 100);
65 }
3b039231
NR
66
67 pg.setName("Initialising");
92fb0719 68
ed08c171
NR
69 Progress pgMeta = new Progress();
70 pg.addProgress(pgMeta, 10);
7445f856
NR
71 Story story = processMeta(true, pgMeta);
72 MetaData meta = story.getMeta();
091397cb 73
2a25f781 74 pgMeta.done(); // 10%
3b039231 75
d66deb8d 76 File tmpDir = Instance.getInstance().getTempFiles().createTempDir("info-text");
2aac79c7 77 String basename = null;
08fe2e33 78
16a81ef7 79 Map<String, Image> images = new HashMap<String, Image>();
298d405a
NR
80 InputStream cbzIn = null;
81 ZipInputStream zipIn = null;
2aac79c7 82 try {
67837328 83 cbzIn = new MarkableFileInputStream(getSourceFileOriginal());
298d405a 84 zipIn = new ZipInputStream(cbzIn);
2aac79c7
NR
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;
8d59ce07 91 for (String ext : bsImages.getImageExt(false)) {
2aac79c7
NR
92 if (entryLName.endsWith(ext)) {
93 imageEntry = true;
94 }
08fe2e33 95 }
45994ba5 96
2aac79c7
NR
97 if (imageEntry) {
98 String uuid = meta.getUuid() + "_" + entry.getName();
99 try {
100 images.put(uuid, new Image(zipIn));
101 } catch (Exception e) {
d66deb8d 102 Instance.getInstance().getTraceHandler().error(e);
2aac79c7
NR
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));
08fe2e33 114 }
2aac79c7
NR
115 }
116 }
45994ba5
NR
117
118 String ext = "."
d66deb8d 119 + Instance.getInstance().getConfig().getString(Config.FILE_FORMAT_IMAGE_FORMAT_COVER).toLowerCase();
45994ba5
NR
120 String coverName = meta.getUuid() + "_" + basename + ext;
121 Image cover = images.get(coverName);
122 images.remove(coverName);
2a25f781 123
2aac79c7
NR
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
45994ba5 132 // only the description/cover is kept
298d405a
NR
133 Story origStory = getStoryFromTxt(tmpDir, basename);
134 if (origStory != null) {
27694a13
NR
135 if (origStory.getMeta().getCover() == null) {
136 origStory.getMeta().setCover(story.getMeta().getCover());
137 }
298d405a 138 story.setMeta(origStory.getMeta());
2aac79c7 139 }
45994ba5
NR
140 if (story.getMeta().getCover() == null) {
141 story.getMeta().setCover(cover);
142 }
091397cb 143 story.setChapters(new ArrayList<Chapter>());
92fb0719 144
e5a2f1b3 145 // Check if we can find non-images chapters, for hybrid-cbz support
654e27bb
NR
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 }
e5a2f1b3
NR
160 }
161 }
e5a2f1b3 162
654e27bb
NR
163 if (isImages != null && !isImages) {
164 story.getChapters().add(chap);
165 chap.setNumber(story.getChapters().size());
166 }
e5a2f1b3
NR
167 }
168 }
169
2aac79c7 170 if (!imagesList.isEmpty()) {
75a6a3ea 171 Chapter chap = new Chapter(story.getChapters().size() + 1, "");
2aac79c7 172 story.getChapters().add(chap);
2a25f781 173
2aac79c7
NR
174 for (String uuid : imagesList) {
175 try {
176 chap.getParagraphs().add(
177 new Paragraph(images.get(uuid)));
178 } catch (Exception e) {
d66deb8d 179 Instance.getInstance().getTraceHandler().error(e);
2aac79c7
NR
180 }
181 }
182 }
d3c84ac3 183
2aac79c7
NR
184 if (meta.getCover() == null && !images.isEmpty()) {
185 meta.setCover(images.get(imagesList.get(0)));
186 meta.setFakeCover(true);
d3c84ac3 187 }
2aac79c7
NR
188 } finally {
189 IOUtils.deltree(tmpDir);
298d405a
NR
190 if (zipIn != null) {
191 zipIn.close();
192 }
193 if (cbzIn != null) {
194 cbzIn.close();
195 }
a9eb3f46
NR
196 }
197
3b039231 198 pg.done();
08fe2e33
NR
199 return story;
200 }
298d405a
NR
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 }
08fe2e33 222}