Commit | Line | Data |
---|---|---|
315f14ae NR |
1 | package be.nikiroo.fanfix.supported; |
2 | ||
3 | import java.io.IOException; | |
4 | import java.io.InputStream; | |
5 | import java.net.URL; | |
6 | import java.util.ArrayList; | |
7 | import java.util.HashMap; | |
8 | import java.util.List; | |
9 | import java.util.Map; | |
10 | import java.util.Map.Entry; | |
11 | ||
12 | import be.nikiroo.fanfix.Instance; | |
13 | import be.nikiroo.fanfix.bundles.Config; | |
14 | import be.nikiroo.fanfix.data.MetaData; | |
15 | import be.nikiroo.utils.IOUtils; | |
16 | import be.nikiroo.utils.Progress; | |
17 | ||
18 | /** | |
19 | * Support class for <a href="http://www.fimfiction.net/">FimFiction.net</a> | |
20 | * stories, a website dedicated to My Little Pony. | |
21 | * <p> | |
22 | * This version uses the new, official API of FimFiction. | |
23 | * | |
24 | * @author niki | |
25 | */ | |
26 | class FimfictionApi extends BasicSupport { | |
27 | private String oauth; | |
28 | private String storyId; | |
29 | private String json; | |
30 | ||
31 | private Map<Integer, String> chapterNames; | |
32 | private Map<Integer, String> chapterContents; | |
33 | ||
34 | public FimfictionApi() throws IOException { | |
35 | if (Instance.getConfig().getBoolean( | |
36 | Config.LOGIN_FIMFICTION_APIKEY_FORCE_HTML, false)) { | |
37 | throw new IOException( | |
38 | "Configuration is set to force HTML scrapping"); | |
39 | } | |
40 | ||
41 | String oauth = Instance.getConfig().getString( | |
42 | Config.LOGIN_FIMFICTION_APIKEY_TOKEN); | |
43 | ||
44 | if (oauth == null || oauth.isEmpty()) { | |
45 | String clientId = Instance.getConfig().getString( | |
46 | Config.LOGIN_FIMFICTION_APIKEY_CLIENT_ID) | |
47 | + ""; | |
48 | String clientSecret = Instance.getConfig().getString( | |
49 | Config.LOGIN_FIMFICTION_APIKEY_CLIENT_SECRET) | |
50 | + ""; | |
51 | ||
52 | if (clientId.trim().isEmpty() || clientSecret.trim().isEmpty()) { | |
53 | throw new IOException("API key required for the beta API v2"); | |
54 | } | |
55 | ||
56 | oauth = generateOAuth(clientId, clientSecret); | |
57 | ||
58 | Instance.getConfig().setString( | |
59 | Config.LOGIN_FIMFICTION_APIKEY_TOKEN, oauth); | |
60 | Instance.getConfig().updateFile(); | |
61 | } | |
62 | ||
63 | this.oauth = oauth; | |
64 | } | |
65 | ||
66 | @Override | |
67 | public String getOAuth() { | |
68 | return oauth; | |
69 | } | |
70 | ||
71 | @Override | |
72 | protected boolean isHtml() { | |
73 | return true; | |
74 | } | |
75 | ||
76 | @Override | |
77 | public String getSourceName() { | |
78 | return "FimFiction.net"; | |
79 | } | |
80 | ||
81 | @Override | |
82 | protected void preprocess(URL source, InputStream in) throws IOException { | |
83 | // extract the ID from: | |
84 | // https://www.fimfiction.net/story/123456/name-of-story | |
85 | storyId = getKeyText(source.toString(), "/story/", null, "/"); | |
86 | ||
87 | // Selectors, so to download all I need and only what I need | |
88 | String storyContent = "fields[story]=title,description,date_published,cover_image"; | |
89 | String authorContent = "fields[author]=name"; | |
90 | String chapterContent = "fields[chapter]=chapter_number,title,content,authors_note"; | |
91 | String contentContent = "fields[content]=html"; | |
92 | String authorsNoteContent = "fields[authors_note]=html"; | |
93 | String includes = "author,chapters,tags"; | |
94 | ||
95 | String urlString = String.format( | |
96 | "https://www.fimfiction.net/api/v2/stories/%s?" // | |
97 | + "%s&%s&"// | |
98 | + "%s&%s&%s&" // | |
99 | + "include=%s", // | |
100 | storyId, // | |
101 | storyContent, authorContent, // | |
102 | chapterContent, contentContent, authorsNoteContent,// | |
103 | includes); | |
104 | ||
105 | // URL params must be URL-encoded: "[ ]" <-> "%5B %5D" | |
106 | urlString = urlString.replace("[", "%5B").replace("]", "%5D"); | |
107 | ||
108 | URL url = new URL(urlString); | |
109 | InputStream jsonIn = Instance.getCache().open(url, this, false); | |
110 | try { | |
111 | json = IOUtils.readSmallStream(jsonIn); | |
112 | } finally { | |
113 | jsonIn.close(); | |
114 | } | |
115 | } | |
116 | ||
117 | @Override | |
118 | protected InputStream openInput(URL source) throws IOException { | |
119 | return null; | |
120 | } | |
121 | ||
122 | @Override | |
123 | protected MetaData getMeta(URL source, InputStream in) throws IOException { | |
124 | MetaData meta = new MetaData(); | |
125 | ||
126 | meta.setTitle(getKeyJson(json, 0, "type", "story", "title")); | |
127 | meta.setAuthor(getKeyJson(json, 0, "type", "user", "name")); | |
128 | meta.setDate(getKeyJson(json, 0, "type", "story", "date_published")); | |
129 | meta.setTags(getTags()); | |
130 | meta.setSource(getSourceName()); | |
131 | meta.setUrl(source.toString()); | |
132 | meta.setPublisher(getSourceName()); | |
133 | meta.setUuid(source.toString()); | |
134 | meta.setLuid(""); | |
135 | meta.setLang("EN"); | |
136 | meta.setSubject("MLP"); | |
137 | meta.setType(getType().toString()); | |
138 | meta.setImageDocument(false); | |
139 | meta.setCover(getImage(this, null, | |
140 | getKeyJson(json, 0, "type", "story", "cover_image", "full"))); | |
141 | ||
142 | return meta; | |
143 | } | |
144 | ||
145 | private List<String> getTags() { | |
146 | List<String> tags = new ArrayList<String>(); | |
147 | tags.add("MLP"); | |
148 | ||
149 | int pos = 0; | |
150 | while (pos >= 0) { | |
151 | pos = indexOfJsonAfter(json, pos, "type", "story_tag"); | |
152 | if (pos >= 0) { | |
153 | tags.add(getKeyJson(json, pos, "name")); | |
154 | } | |
155 | } | |
156 | ||
157 | return tags; | |
158 | } | |
159 | ||
160 | @Override | |
161 | protected String getDesc(URL source, InputStream in) { | |
d9a94285 | 162 | String desc = getKeyJson(json, 0, "type", "story", "description"); |
a8209dd0 | 163 | return unbbcode(desc); |
315f14ae NR |
164 | } |
165 | ||
166 | @Override | |
167 | protected List<Entry<String, URL>> getChapters(URL source, InputStream in, | |
168 | Progress pg) { | |
169 | List<Entry<String, URL>> urls = new ArrayList<Entry<String, URL>>(); | |
170 | ||
171 | chapterNames = new HashMap<Integer, String>(); | |
172 | chapterContents = new HashMap<Integer, String>(); | |
173 | ||
174 | int pos = 0; | |
175 | while (pos >= 0) { | |
176 | pos = indexOfJsonAfter(json, pos, "type", "chapter"); | |
177 | if (pos >= 0) { | |
178 | int posNumber = indexOfJsonAfter(json, pos, "chapter_number"); | |
179 | int posComa = json.indexOf(",", posNumber); | |
180 | final int number = Integer.parseInt(json.substring(posNumber, | |
181 | posComa).trim()); | |
182 | final String title = getKeyJson(json, pos, "title"); | |
183 | String notes = getKeyJson(json, pos, "authors_note", "html"); | |
184 | String content = getKeyJson(json, pos, "content", "html"); | |
185 | ||
186 | chapterNames.put(number, title); | |
187 | chapterContents | |
188 | .put(number, content + "<br/>* * *<br/>" + notes); | |
189 | ||
190 | urls.add(new Entry<String, URL>() { | |
191 | @Override | |
192 | public URL setValue(URL value) { | |
193 | return null; | |
194 | } | |
195 | ||
196 | @Override | |
197 | public String getKey() { | |
198 | return title; | |
199 | } | |
200 | ||
201 | @Override | |
202 | public URL getValue() { | |
203 | return null; | |
204 | } | |
205 | }); | |
206 | } | |
207 | } | |
208 | ||
209 | return urls; | |
210 | } | |
211 | ||
212 | @Override | |
213 | protected String getChapterContent(URL source, InputStream in, int number, | |
214 | Progress pg) { | |
215 | return chapterContents.get(number); | |
216 | } | |
217 | ||
218 | @Override | |
219 | protected boolean supports(URL url) { | |
220 | return "fimfiction.net".equals(url.getHost()) | |
221 | || "www.fimfiction.net".equals(url.getHost()); | |
222 | } | |
223 | ||
a8209dd0 NR |
224 | /** |
225 | * Generate a new token from the client ID and secret. | |
226 | * <p> | |
227 | * Note that those tokens are long-lived, and it would be badly seen to | |
228 | * create a lot of them without due cause. | |
229 | * <p> | |
230 | * So, please cache and re-use them. | |
231 | * | |
232 | * @param clientId | |
233 | * the client ID offered on FimFiction | |
234 | * @param clientSecret | |
235 | * the client secret that goes with it | |
236 | * | |
237 | * @return a new generated token linked to that client ID | |
238 | * | |
239 | * @throws IOException | |
240 | * in case of I/O errors | |
241 | */ | |
315f14ae NR |
242 | static private String generateOAuth(String clientId, String clientSecret) |
243 | throws IOException { | |
244 | URL url = new URL("https://www.fimfiction.net/api/v2/token"); | |
245 | Map<String, String> params = new HashMap<String, String>(); | |
246 | params.put("client_id", clientId); | |
247 | params.put("client_secret", clientSecret); | |
248 | params.put("grant_type", "client_credentials"); | |
249 | InputStream in = Instance.getCache().openNoCache(url, null, params, | |
250 | null, null); | |
251 | ||
252 | String jsonToken = IOUtils.readSmallStream(in); | |
253 | ||
254 | // Extract token type and token from: { | |
a8209dd0 | 255 | // token_type = "Bearer", |
315f14ae NR |
256 | // access_token = "xxxxxxxxxxxxxx" |
257 | // } | |
258 | ||
259 | String token = getKeyText(jsonToken, "\"access_token\"", "\"", "\""); | |
260 | String tokenType = getKeyText(jsonToken, "\"token_type\"", "\"", "\""); | |
261 | ||
315f14ae NR |
262 | return tokenType + " " + token; |
263 | } | |
264 | ||
265 | // afters: [name, value] pairs (or "" for any of them), can end without | |
266 | // value | |
267 | static private int indexOfJsonAfter(String json, int startAt, | |
268 | String... afterKeys) { | |
269 | ArrayList<String> afters = new ArrayList<String>(); | |
270 | boolean name = true; | |
271 | for (String key : afterKeys) { | |
272 | if (key != null && !key.isEmpty()) { | |
273 | afters.add("\"" + key + "\""); | |
274 | } else { | |
275 | afters.add("\""); | |
276 | afters.add("\""); | |
277 | } | |
278 | ||
279 | if (name) { | |
280 | afters.add(":"); | |
281 | } | |
282 | ||
283 | name = !name; | |
284 | } | |
285 | ||
286 | return indexOfAfter(json, startAt, afters.toArray(new String[] {})); | |
287 | } | |
288 | ||
289 | // afters: [name, value] pairs (or "" for any of them), can end without | |
290 | // value | |
291 | static private String getKeyJson(String json, int startAt, | |
292 | String... afterKeys) { | |
293 | int pos = indexOfJsonAfter(json, startAt, afterKeys); | |
294 | if (pos < 0) { | |
295 | return null; | |
296 | } | |
297 | ||
37fdbdef NR |
298 | String result = null; |
299 | String wip = json.substring(pos); | |
300 | ||
301 | pos = nextUnescapedQuote(wip, 0); | |
302 | if (pos >= 0) { | |
303 | wip = wip.substring(pos + 1); | |
304 | pos = nextUnescapedQuote(wip, 0); | |
305 | if (pos >= 0) { | |
306 | result = wip.substring(0, pos); | |
307 | } | |
308 | } | |
309 | ||
310 | return result; | |
311 | } | |
312 | ||
313 | // next " but don't take \" into account | |
314 | static private int nextUnescapedQuote(String result, int pos) { | |
315 | while (pos >= 0) { | |
316 | pos = result.indexOf("\"", pos); | |
317 | if (pos == 0 || (pos > 0 && result.charAt(pos - 1) != '\\')) { | |
318 | break; | |
319 | } | |
320 | ||
321 | if (pos < result.length()) { | |
322 | pos++; | |
323 | } | |
324 | } | |
325 | ||
326 | return pos; | |
315f14ae | 327 | } |
a8209dd0 NR |
328 | |
329 | // quick & dirty filter | |
330 | static private String unbbcode(String bbcode) { | |
331 | String text = bbcode.replace("\\r\\n", "<br/>") // | |
332 | .replace("[i]", "_").replace("[/i]", "_") // | |
333 | .replace("[b]", "*").replace("[/b]", "*") // | |
334 | .replaceAll("\\[[^\\]]*\\]", ""); | |
335 | return text; | |
336 | } | |
315f14ae | 337 | } |