GUI: automatically select URLs from clipboard
[fanfix.git] / src / be / nikiroo / fanfix / supported / Text.java
... / ...
CommitLineData
1package be.nikiroo.fanfix.supported;
2
3import java.awt.image.BufferedImage;
4import java.io.File;
5import java.io.IOException;
6import java.io.InputStream;
7import java.net.URISyntaxException;
8import java.net.URL;
9import java.util.ArrayList;
10import java.util.List;
11import java.util.Map.Entry;
12import java.util.Scanner;
13
14import be.nikiroo.fanfix.Instance;
15import be.nikiroo.fanfix.bundles.Config;
16import be.nikiroo.fanfix.data.MetaData;
17
18/**
19 * Support class for local stories encoded in textual format, with a few rules:
20 * <ul>
21 * <li>The title must be on the first line</li>
22 * <li>The author (preceded by nothing, "by " or "©") must be on the second
23 * line, possibly with the publication date in parenthesis (i.e., "
24 * <tt>By Unknown (3rd October 1998)</tt>")</li>
25 * <li>Chapters must be declared with "<tt>Chapter x</tt>" or "
26 * <tt>Chapter x: NAME OF THE CHAPTER</tt>", where "<tt>x</tt>" is the chapter
27 * number</li>
28 * <li>A description of the story must be given as chapter number 0</li>
29 * <li>A cover may be present, with the same filename but a PNG, JPEG or JPG
30 * extension</li<
31 * </ul>
32 *
33 * @author niki
34 */
35class Text extends BasicSupport {
36 @Override
37 protected boolean isHtml() {
38 return false;
39 }
40
41 @Override
42 public String getSourceName() {
43 return "text";
44 }
45
46 @Override
47 protected MetaData getMeta(URL source, InputStream in) throws IOException {
48 MetaData meta = new MetaData();
49
50 meta.setTitle(getTitle(reset(in)));
51 meta.setAuthor(getAuthor(reset(in)));
52 meta.setDate(getDate(reset(in)));
53 meta.setTags(new ArrayList<String>());
54 meta.setSource(getSourceName());
55 meta.setUrl(source.toString());
56 meta.setPublisher("");
57 meta.setUuid(source.toString());
58 meta.setLuid("");
59 meta.setLang(getLang(source, reset(in))); // default is EN
60 meta.setSubject(getSubject(source));
61 meta.setType(getType().toString());
62 meta.setImageDocument(false);
63 meta.setCover(getCover(source));
64
65 return meta;
66 }
67
68 private String getSubject(URL source) throws IOException {
69 try {
70 File file = new File(source.toURI());
71 return file.getParentFile().getName();
72 } catch (URISyntaxException e) {
73 throw new IOException("Cannot parse the URL to File: "
74 + source.toString(), e);
75 }
76
77 }
78
79 private String getLang(URL source, InputStream in) throws IOException {
80 @SuppressWarnings("resource")
81 Scanner scan = new Scanner(in, "UTF-8");
82 scan.useDelimiter("\\n");
83 scan.next(); // Title
84 scan.next(); // Author (Date)
85 String chapter0 = scan.next(); // empty or Chapter 0
86 while (chapter0.isEmpty()) {
87 chapter0 = scan.next();
88 }
89
90 String lang = detectChapter(chapter0, 0);
91 if (lang == null) {
92 // No description??
93 lang = detectChapter(chapter0, 1);
94 }
95
96 if (lang == null) {
97 lang = "EN";
98 } else {
99 lang = lang.toUpperCase();
100 }
101
102 return lang;
103 }
104
105 private String getTitle(InputStream in) throws IOException {
106 @SuppressWarnings("resource")
107 Scanner scan = new Scanner(in, "UTF-8");
108 scan.useDelimiter("\\n");
109 return scan.next();
110 }
111
112 private String getAuthor(InputStream in) throws IOException {
113 @SuppressWarnings("resource")
114 Scanner scan = new Scanner(in, "UTF-8");
115 scan.useDelimiter("\\n");
116 scan.next();
117 String authorDate = scan.next();
118
119 String author = authorDate;
120 int pos = authorDate.indexOf('(');
121 if (pos >= 0) {
122 author = authorDate.substring(0, pos);
123 }
124
125 return fixAuthor(author);
126 }
127
128 private String getDate(InputStream in) throws IOException {
129 @SuppressWarnings("resource")
130 Scanner scan = new Scanner(in, "UTF-8");
131 scan.useDelimiter("\\n");
132 scan.next();
133 String authorDate = scan.next();
134
135 String date = "";
136 int pos = authorDate.indexOf('(');
137 if (pos >= 0) {
138 date = authorDate.substring(pos + 1).trim();
139 pos = date.lastIndexOf(')');
140 if (pos >= 0) {
141 date = date.substring(0, pos).trim();
142 }
143 }
144
145 return date;
146 }
147
148 @Override
149 protected String getDesc(URL source, InputStream in) throws IOException {
150 return getChapterContent(source, in, 0);
151 }
152
153 private BufferedImage getCover(URL source) throws IOException {
154 String path;
155 try {
156 path = new File(source.toURI()).getPath();
157 } catch (URISyntaxException e) {
158 Instance.syserr(e);
159 path = null;
160 }
161
162 for (String ext : new String[] { ".txt", ".text", ".story" }) {
163 if (path.endsWith(ext)) {
164 path = path.substring(0, path.length() - ext.length());
165 }
166 }
167
168 return getImage(this, source, path);
169 }
170
171 @Override
172 protected List<Entry<String, URL>> getChapters(URL source, InputStream in)
173 throws IOException {
174 List<Entry<String, URL>> chaps = new ArrayList<Entry<String, URL>>();
175 @SuppressWarnings("resource")
176 Scanner scan = new Scanner(in, "UTF-8");
177 scan.useDelimiter("\\n");
178 boolean prevLineEmpty = false;
179 while (scan.hasNext()) {
180 String line = scan.next();
181 if (prevLineEmpty && detectChapter(line, chaps.size() + 1) != null) {
182 String chapName = Integer.toString(chaps.size() + 1);
183 int pos = line.indexOf(':');
184 if (pos >= 0 && pos + 1 < line.length()) {
185 chapName = line.substring(pos + 1).trim();
186 }
187 final URL value = source;
188 final String key = chapName;
189 chaps.add(new Entry<String, URL>() {
190 public URL setValue(URL value) {
191 return null;
192 }
193
194 public URL getValue() {
195 return value;
196 }
197
198 public String getKey() {
199 return key;
200 }
201 });
202 }
203
204 prevLineEmpty = line.trim().isEmpty();
205 }
206
207 return chaps;
208 }
209
210 @Override
211 protected String getChapterContent(URL source, InputStream in, int number)
212 throws IOException {
213 StringBuilder builder = new StringBuilder();
214 @SuppressWarnings("resource")
215 Scanner scan = new Scanner(in, "UTF-8");
216 scan.useDelimiter("\\n");
217 boolean inChap = false;
218 while (scan.hasNext()) {
219 String line = scan.next();
220 if (detectChapter(line, number) != null) {
221 inChap = true;
222 } else if (inChap && detectChapter(line, number + 1) != null) {
223 break;
224 } else if (inChap) {
225 builder.append(line);
226 builder.append("\n");
227 }
228 }
229
230 return builder.toString();
231 }
232
233 @Override
234 protected boolean supports(URL url) {
235 if ("file".equals(url.getProtocol())) {
236 File file;
237 try {
238 file = new File(url.toURI());
239 file = new File(file.getPath() + ".info");
240 } catch (URISyntaxException e) {
241 Instance.syserr(e);
242 file = null;
243 }
244
245 return file == null || !file.exists();
246 }
247
248 return false;
249 }
250
251 /**
252 * Check if the given line looks like the given starting chapter in a
253 * supported language, and return the language if it does (or NULL if not).
254 *
255 * @param line
256 * the line to check
257 *
258 * @return the language or NULL
259 */
260 private String detectChapter(String line, int number) {
261 line = line.toUpperCase();
262 for (String lang : Instance.getConfig().getString(Config.CHAPTER)
263 .split(",")) {
264 String chapter = Instance.getConfig().getStringX(Config.CHAPTER,
265 lang);
266 if (chapter != null && !chapter.isEmpty()) {
267 chapter = chapter.toUpperCase() + " ";
268 if (line.startsWith(chapter)) {
269 // We want "[CHAPTER] [number]: [name]", with ": [name]"
270 // optional
271 String test = line.substring(chapter.length()).trim();
272 if (test.startsWith(Integer.toString(number))) {
273 test = test
274 .substring(Integer.toString(number).length())
275 .trim();
276 if (test.isEmpty() || test.startsWith(":")) {
277 return lang;
278 }
279 }
280 }
281 }
282 }
283
284 return null;
285 }
286}