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 Image img = new Image(zipIn);
101 if (img.getSize() == 0) {
102 img.close();
103 throw new IOException(
104 "Empty image not accepted");
105 }
106 images.put(uuid, img);
107 } catch (Exception e) {
108 Instance.getInstance().getTraceHandler().error(e);
109 }
110
111 if (pg.getProgress() < 85) {
112 pg.add(1);
113 }
114 } else if (entryLName.endsWith(".info")) {
115 basename = entryLName.substring(0, entryLName.length()
116 - ".info".length());
117 IOUtils.write(zipIn, new File(tmpDir, entryLName));
118 } else if (entryLName.endsWith(".txt")) {
119 IOUtils.write(zipIn, new File(tmpDir, entryLName));
120 }
121 }
122 }
123
124 String ext = "."
125 + Instance.getInstance().getConfig().getString(Config.FILE_FORMAT_IMAGE_FORMAT_COVER).toLowerCase();
126 String coverName = meta.getUuid() + "_" + basename + ext;
127 Image cover = images.get(coverName);
128 images.remove(coverName);
129
130 pg.setProgress(85);
131
132 // ZIP order is not correct for us
133 List<String> imagesList = new ArrayList<String>(images.keySet());
134 Collections.sort(imagesList);
135
136 pg.setProgress(90);
137
138 // only the description/cover is kept
139 Story origStory = getStoryFromTxt(tmpDir, basename);
140 if (origStory != null) {
141 if (origStory.getMeta().getCover() == null) {
142 origStory.getMeta().setCover(story.getMeta().getCover());
143 }
144 story.setMeta(origStory.getMeta());
145 }
146 if (story.getMeta().getCover() == null) {
147 story.getMeta().setCover(cover);
148 }
149 story.setChapters(new ArrayList<Chapter>());
150
151 // Check if we can find non-images chapters, for hybrid-cbz support
152 if (origStory != null) {
153 for (Chapter chap : origStory) {
154 Boolean isImages = null;
155 for (Paragraph para : chap) {
156 ParagraphType t = para.getType();
157 if (isImages == null && !t.isText(true)) {
158 isImages = true;
159 }
160 if (t.isText(false)) {
161 String line = para.getContent();
162 // Images are saved in text mode as "[image-link]"
163 if (!(line.startsWith("[") && line.endsWith("]"))) {
164 isImages = false;
165 }
166 }
167 }
168
169 if (isImages != null && !isImages) {
170 story.getChapters().add(chap);
171 chap.setNumber(story.getChapters().size());
172 }
173 }
174 }
175
176 if (!imagesList.isEmpty()) {
177 Chapter chap = new Chapter(story.getChapters().size() + 1, "");
178 story.getChapters().add(chap);
179
180 for (String uuid : imagesList) {
181 try {
182 chap.getParagraphs().add(
183 new Paragraph(images.get(uuid)));
184 } catch (Exception e) {
185 Instance.getInstance().getTraceHandler().error(e);
186 }
187 }
188 }
189
190 if (meta.getCover() == null && !images.isEmpty()) {
191 meta.setCover(images.get(imagesList.get(0)));
192 meta.setFakeCover(true);
193 }
194 } finally {
195 IOUtils.deltree(tmpDir);
196 if (zipIn != null) {
197 zipIn.close();
198 }
199 if (cbzIn != null) {
200 cbzIn.close();
201 }
202 }
203
204 pg.done();
205 return story;
206 }
207
208 private Story getStoryFromTxt(File tmpDir, String basename) {
209 Story origStory = null;
210
211 File txt = new File(tmpDir, basename + ".txt");
212 if (!txt.exists()) {
213 basename = null;
214 }
215 if (basename != null) {
216 try {
217 BasicSupport support = BasicSupport.getSupport(txt.toURI()
218 .toURL());
219 origStory = support.process(null);
220 } catch (Exception e) {
221 basename = null;
222 }
223 }
224
225 return origStory;
226
227 }
228 }