Update nikiroo-utils (fix for e-hentai language)
[nikiroo-utils.git] / src / be / nikiroo / fanfix / reader / BasicReader.java
CommitLineData
89cb07a6
NR
1package be.nikiroo.fanfix.reader;
2
3b2b638f 3import java.io.File;
89cb07a6 4import java.io.IOException;
3b2b638f 5import java.net.MalformedURLException;
89cb07a6
NR
6import java.net.URL;
7
8import be.nikiroo.fanfix.Instance;
9import be.nikiroo.fanfix.Library;
d0114000 10import be.nikiroo.fanfix.bundles.Config;
89cb07a6
NR
11import be.nikiroo.fanfix.data.Story;
12import be.nikiroo.fanfix.supported.BasicSupport;
3b2b638f 13import be.nikiroo.utils.Progress;
89cb07a6
NR
14
15/**
dd56a893 16 * The class that handles the different {@link Story} readers you can use.
89cb07a6 17 * <p>
dd56a893 18 * All the readers should be accessed via {@link BasicReader#getReader()}.
89cb07a6
NR
19 *
20 * @author niki
21 */
3727aae2
NR
22public abstract class BasicReader {
23 public enum ReaderType {
24 /** Simple reader that outputs everything on the console */
25 CLI,
26 /** Reader that starts local programs to handle the stories */
27 LOCAL
28 }
29
d0114000 30 private static ReaderType defaultType = ReaderType.CLI;
89cb07a6 31 private Story story;
3727aae2
NR
32 private ReaderType type;
33
d0114000
NR
34 /**
35 * Take the default reader type configuration from the config file.
36 */
3727aae2 37 static {
d0114000
NR
38 String typeString = Instance.getConfig().getString(Config.READER_TYPE);
39 if (typeString != null && !typeString.isEmpty()) {
40 try {
41 ReaderType type = ReaderType.valueOf(typeString.toUpperCase());
42 defaultType = type;
43 } catch (IllegalArgumentException e) {
44 // Do nothing
45 }
46 }
3727aae2
NR
47 }
48
49 /**
50 * The type of this reader.
51 *
52 * @return the type
53 */
54 public ReaderType getType() {
55 return type;
56 }
57
58 /**
59 * The type of this reader.
60 *
61 * @param type
62 * the new type
63 */
64 protected BasicReader setType(ReaderType type) {
65 this.type = type;
66 return this;
67 }
89cb07a6
NR
68
69 /**
70 * Return the current {@link Story}.
71 *
72 * @return the {@link Story}
73 */
74 public Story getStory() {
75 return story;
76 }
77
78 /**
3727aae2 79 * Create a new {@link BasicReader} for a {@link Story} in the
89cb07a6
NR
80 * {@link Library} .
81 *
82 * @param luid
83 * the {@link Story} ID
92fb0719
NR
84 * @param pg
85 * the optional progress reporter
86 *
89cb07a6
NR
87 * @throws IOException
88 * in case of I/O error
89 */
92fb0719
NR
90 public void setStory(String luid, Progress pg) throws IOException {
91 story = Instance.getLibrary().getStory(luid, pg);
89cb07a6 92 if (story == null) {
92fb0719 93 throw new IOException("Cannot retrieve story from library: " + luid);
89cb07a6
NR
94 }
95 }
96
97 /**
3727aae2 98 * Create a new {@link BasicReader} for an external {@link Story}.
89cb07a6
NR
99 *
100 * @param source
101 * the {@link Story} {@link URL}
92fb0719
NR
102 * @param pg
103 * the optional progress reporter
104 *
89cb07a6
NR
105 * @throws IOException
106 * in case of I/O error
107 */
92fb0719 108 public void setStory(URL source, Progress pg) throws IOException {
89cb07a6
NR
109 BasicSupport support = BasicSupport.getSupport(source);
110 if (support == null) {
111 throw new IOException("URL not supported: " + source.toString());
112 }
113
92fb0719 114 story = support.process(source, pg);
89cb07a6
NR
115 if (story == null) {
116 throw new IOException(
117 "Cannot retrieve story from external source: "
118 + source.toString());
119
120 }
121 }
122
123 /**
124 * Start the {@link Story} Reading.
125 *
126 * @throws IOException
127 * in case of I/O error or if the {@link Story} was not
128 * previously set
129 */
130 public abstract void read() throws IOException;
131
132 /**
133 * Read the selected chapter (starting at 1).
134 *
135 * @param chapter
136 * the chapter
edd46289
NR
137 *
138 * @throws IOException
139 * in case of I/O error or if the {@link Story} was not
140 * previously set
89cb07a6 141 */
edd46289 142 public abstract void read(int chapter) throws IOException;
89cb07a6
NR
143
144 /**
145 * Start the reader in browse mode for the given type (or pass NULL for all
146 * types).
147 *
148 * @param type
149 * the type of {@link Story} to take into account, or NULL for
150 * all
151 */
333f0e7b 152 public abstract void start(String type);
3727aae2
NR
153
154 /**
d0114000
NR
155 * Return a new {@link BasicReader} ready for use if one is configured.
156 * <p>
157 * Can return NULL if none are configured.
3727aae2 158 *
d0114000 159 * @return a {@link BasicReader}, or NULL if none configured
3727aae2
NR
160 */
161 public static BasicReader getReader() {
333f0e7b
NR
162 try {
163 if (defaultType != null) {
164 switch (defaultType) {
165 case LOCAL:
166 return new LocalReader().setType(ReaderType.LOCAL);
167 case CLI:
168 return new CliReader().setType(ReaderType.CLI);
169 }
d0114000 170 }
333f0e7b
NR
171 } catch (IOException e) {
172 Instance.syserr(new Exception("Cannot create a reader of type: "
173 + defaultType, e));
3727aae2
NR
174 }
175
176 return null;
177 }
178
179 /**
180 * The default {@link ReaderType} used when calling
181 * {@link BasicReader#getReader()}.
182 *
183 * @return the default type
184 */
185 public static ReaderType getDefaultReaderType() {
186 return defaultType;
187 }
188
189 /**
190 * The default {@link ReaderType} used when calling
191 * {@link BasicReader#getReader()}.
192 *
193 * @param defaultType
194 * the new default type
195 */
196 public static void setDefaultReaderType(ReaderType defaultType) {
197 BasicReader.defaultType = defaultType;
198 }
3b2b638f
NR
199
200 /**
201 * Return an {@link URL} from this {@link String}, be it a file path or an
202 * actual {@link URL}.
203 *
204 * @param sourceString
205 * the source
206 *
207 * @return the corresponding {@link URL}
208 *
209 * @throws MalformedURLException
210 * if this is neither a file nor a conventional {@link URL}
211 */
212 public static URL getUrl(String sourceString) throws MalformedURLException {
213 if (sourceString == null || sourceString.isEmpty()) {
214 throw new MalformedURLException("Empty url");
215 }
216
217 URL source = null;
218 try {
219 source = new URL(sourceString);
220 } catch (MalformedURLException e) {
221 File sourceFile = new File(sourceString);
222 source = sourceFile.toURI().toURL();
223 }
224
225 return source;
226 }
89cb07a6 227}