1 package be
.nikiroo
.fanfix
.supported
;
3 import java
.io
.IOException
;
4 import java
.io
.InputStream
;
6 import java
.util
.ArrayList
;
7 import java
.util
.HashMap
;
10 import java
.util
.Map
.Entry
;
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
;
19 * Support class for <a href="http://www.fimfiction.net/">FimFiction.net</a>
20 * stories, a website dedicated to My Little Pony.
22 * This version uses the new, official API of FimFiction.
26 class FimfictionApi
extends BasicSupport
{
28 private String storyId
;
31 private Map
<Integer
, String
> chapterNames
;
32 private Map
<Integer
, String
> chapterContents
;
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");
41 String oauth
= Instance
.getConfig().getString(
42 Config
.LOGIN_FIMFICTION_APIKEY_TOKEN
);
44 if (oauth
== null || oauth
.isEmpty()) {
45 String clientId
= Instance
.getConfig().getString(
46 Config
.LOGIN_FIMFICTION_APIKEY_CLIENT_ID
)
48 String clientSecret
= Instance
.getConfig().getString(
49 Config
.LOGIN_FIMFICTION_APIKEY_CLIENT_SECRET
)
52 if (clientId
.trim().isEmpty() || clientSecret
.trim().isEmpty()) {
53 throw new IOException("API key required for the beta API v2");
56 oauth
= generateOAuth(clientId
, clientSecret
);
58 Instance
.getConfig().setString(
59 Config
.LOGIN_FIMFICTION_APIKEY_TOKEN
, oauth
);
60 Instance
.getConfig().updateFile();
67 public String
getOAuth() {
72 protected boolean isHtml() {
77 public String
getSourceName() {
78 return "FimFiction.net";
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, "/");
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";
95 String urlString
= String
.format(
96 "https://www.fimfiction.net/api/v2/stories/%s?" //
101 storyContent
, authorContent
, //
102 chapterContent
, contentContent
, authorsNoteContent
,//
105 // URL params must be URL-encoded: "[ ]" <-> "%5B %5D"
106 urlString
= urlString
.replace("[", "%5B").replace("]", "%5D");
108 URL url
= new URL(urlString
);
109 InputStream jsonIn
= Instance
.getCache().open(url
, this, false);
111 json
= IOUtils
.readSmallStream(jsonIn
);
118 protected InputStream
openInput(URL source
) throws IOException
{
123 protected MetaData
getMeta(URL source
, InputStream in
) throws IOException
{
124 MetaData meta
= new MetaData();
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());
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")));
145 private List
<String
> getTags() {
146 List
<String
> tags
= new ArrayList
<String
>();
151 pos
= indexOfJsonAfter(json
, pos
, "type", "story_tag");
153 tags
.add(getKeyJson(json
, pos
, "name"));
161 protected String
getDesc(URL source
, InputStream in
) {
162 String desc
= getKeyJson(json
, 0, "type", "story", "description");
163 return unbbcode(desc
);
167 protected List
<Entry
<String
, URL
>> getChapters(URL source
, InputStream in
,
169 List
<Entry
<String
, URL
>> urls
= new ArrayList
<Entry
<String
, URL
>>();
171 chapterNames
= new HashMap
<Integer
, String
>();
172 chapterContents
= new HashMap
<Integer
, String
>();
176 pos
= indexOfJsonAfter(json
, pos
, "type", "chapter");
178 int posNumber
= indexOfJsonAfter(json
, pos
, "chapter_number");
179 int posComa
= json
.indexOf(",", posNumber
);
180 final int number
= Integer
.parseInt(json
.substring(posNumber
,
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");
186 chapterNames
.put(number
, title
);
188 .put(number
, content
+ "<br/>* * *<br/>" + notes
);
190 urls
.add(new Entry
<String
, URL
>() {
192 public URL
setValue(URL value
) {
197 public String
getKey() {
202 public URL
getValue() {
213 protected String
getChapterContent(URL source
, InputStream in
, int number
,
215 return chapterContents
.get(number
);
219 protected boolean supports(URL url
) {
220 return "fimfiction.net".equals(url
.getHost())
221 || "www.fimfiction.net".equals(url
.getHost());
225 * Generate a new token from the client ID and secret.
227 * Note that those tokens are long-lived, and it would be badly seen to
228 * create a lot of them without due cause.
230 * So, please cache and re-use them.
233 * the client ID offered on FimFiction
234 * @param clientSecret
235 * the client secret that goes with it
237 * @return a new generated token linked to that client ID
239 * @throws IOException
240 * in case of I/O errors
242 static private String
generateOAuth(String clientId
, String clientSecret
)
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
,
252 String jsonToken
= IOUtils
.readSmallStream(in
);
254 // Extract token type and token from: {
255 // token_type = "Bearer",
256 // access_token = "xxxxxxxxxxxxxx"
259 String token
= getKeyText(jsonToken
, "\"access_token\"", "\"", "\"");
260 String tokenType
= getKeyText(jsonToken
, "\"token_type\"", "\"", "\"");
262 return tokenType
+ " " + token
;
265 // afters: [name, value] pairs (or "" for any of them), can end without
267 static private int indexOfJsonAfter(String json
, int startAt
,
268 String
... afterKeys
) {
269 ArrayList
<String
> afters
= new ArrayList
<String
>();
271 for (String key
: afterKeys
) {
272 if (key
!= null && !key
.isEmpty()) {
273 afters
.add("\"" + key
+ "\"");
286 return indexOfAfter(json
, startAt
, afters
.toArray(new String
[] {}));
289 // afters: [name, value] pairs (or "" for any of them), can end without
291 static private String
getKeyJson(String json
, int startAt
,
292 String
... afterKeys
) {
293 int pos
= indexOfJsonAfter(json
, startAt
, afterKeys
);
298 String result
= null;
299 String wip
= json
.substring(pos
);
301 pos
= nextUnescapedQuote(wip
, 0);
303 wip
= wip
.substring(pos
+ 1);
304 pos
= nextUnescapedQuote(wip
, 0);
306 result
= wip
.substring(0, pos
);
313 // next " but don't take \" into account
314 static private int nextUnescapedQuote(String result
, int pos
) {
316 pos
= result
.indexOf("\"", pos
);
317 if (pos
== 0 || (pos
> 0 && result
.charAt(pos
- 1) != '\\')) {
321 if (pos
< result
.length()) {
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("\\[[^\\]]*\\]", "");