1 package be
.nikiroo
.fanfix
.library
;
3 import java
.io
.ByteArrayInputStream
;
4 import java
.io
.IOException
;
5 import java
.io
.InputStream
;
7 import java
.util
.ArrayList
;
8 import java
.util
.Arrays
;
9 import java
.util
.HashMap
;
10 import java
.util
.LinkedList
;
11 import java
.util
.List
;
14 import org
.json
.JSONArray
;
15 import org
.json
.JSONObject
;
17 import be
.nikiroo
.fanfix
.Instance
;
18 import be
.nikiroo
.fanfix
.bundles
.Config
;
19 import be
.nikiroo
.fanfix
.data
.Chapter
;
20 import be
.nikiroo
.fanfix
.data
.JsonIO
;
21 import be
.nikiroo
.fanfix
.data
.MetaData
;
22 import be
.nikiroo
.fanfix
.data
.Paragraph
;
23 import be
.nikiroo
.fanfix
.data
.Paragraph
.ParagraphType
;
24 import be
.nikiroo
.fanfix
.data
.Story
;
25 import be
.nikiroo
.utils
.Image
;
26 import be
.nikiroo
.utils
.LoginResult
;
27 import be
.nikiroo
.utils
.NanoHTTPD
;
28 import be
.nikiroo
.utils
.NanoHTTPD
.Response
;
29 import be
.nikiroo
.utils
.NanoHTTPD
.Response
.Status
;
30 import be
.nikiroo
.utils
.Progress
;
32 public class WebLibraryServer
extends WebLibraryServerHtml
{
33 class WLoginResult
extends LoginResult
{
34 public WLoginResult(boolean badLogin
, boolean badCookie
) {
35 super(badLogin
, badCookie
);
38 public WLoginResult(String who
, String key
, String subkey
, boolean rw
,
39 boolean wl
, boolean bl
) {
40 super(who
, key
, subkey
, (rw ?
"|rw" : "") + (wl ?
"|wl" : "")
41 + (bl ?
"|bl" : "") + "|");
44 public WLoginResult(String cookie
, String who
, String key
,
45 List
<String
> subkeys
) {
46 super(cookie
, who
, key
, subkeys
,
47 subkeys
== null || subkeys
.isEmpty());
50 public boolean isRw() {
51 return getOption().contains("|rw|");
54 public boolean isWl() {
55 return getOption().contains("|wl|");
58 public boolean isBl() {
59 return getOption().contains("|bl|");
63 private Map
<String
, Story
> storyCache
= new HashMap
<String
, Story
>();
64 private LinkedList
<String
> storyCacheOrder
= new LinkedList
<String
>();
65 private long storyCacheSize
= 0;
66 private long maxStoryCacheSize
;
68 private List
<String
> whitelist
;
69 private List
<String
> blacklist
;
71 private Map
<String
, Progress
> imprts
= new HashMap
<String
, Progress
>();
73 private boolean exiting
;
75 public WebLibraryServer(boolean secure
) throws IOException
{
78 int cacheMb
= Instance
.getInstance().getConfig()
79 .getInteger(Config
.SERVER_MAX_CACHE_MB
, 100);
80 maxStoryCacheSize
= cacheMb
* 1024 * 1024;
82 setTraceHandler(Instance
.getInstance().getTraceHandler());
84 whitelist
= Instance
.getInstance().getConfig()
85 .getList(Config
.SERVER_WHITELIST
, new ArrayList
<String
>());
86 blacklist
= Instance
.getInstance().getConfig()
87 .getList(Config
.SERVER_BLACKLIST
, new ArrayList
<String
>());
91 * Start the server (listen on the network for new connections).
93 * Can only be called once.
95 * This call is asynchronous, and will just start a new {@link Thread} on
96 * itself (see {@link WebLibraryServer#run()}).
99 new Thread(this).start();
103 protected Response
stop(WLoginResult login
) {
105 return NanoHTTPD
.newFixedLengthResponse(Status
.FORBIDDEN
,
106 NanoHTTPD
.MIME_PLAINTEXT
, "Exit not allowed");
110 return NanoHTTPD
.newFixedLengthResponse(Status
.SERVICE_UNAVAILABLE
,
111 NanoHTTPD
.MIME_PLAINTEXT
, "Server is already exiting...");
115 Instance
.getInstance().getTraceHandler().trace("Exiting");
119 synchronized (imprts
) {
120 ok
= imprts
.isEmpty();
125 } catch (InterruptedException e
) {
126 Instance
.getInstance().getTraceHandler()
127 .trace("Waiting to exit...");
134 new Thread(new Runnable() {
139 } catch (InterruptedException e
) {
142 Instance
.getInstance().getTraceHandler()
143 .trace("Exit timeout: force-quit");
146 }, "Exit program after timeout of 1500 ms").start();
148 return NanoHTTPD
.newFixedLengthResponse(Status
.OK
,
149 NanoHTTPD
.MIME_PLAINTEXT
, "Exited");
153 protected WLoginResult
login(boolean badLogin
, boolean badCookie
) {
154 return new WLoginResult(false, false);
158 protected WLoginResult
login(String who
, String cookie
) {
159 List
<String
> subkeys
= Instance
.getInstance().getConfig()
160 .getList(Config
.SERVER_ALLOWED_SUBKEYS
);
161 String realKey
= Instance
.getInstance().getConfig()
162 .getString(Config
.SERVER_KEY
);
164 return new WLoginResult(cookie
, who
, realKey
, subkeys
);
169 protected WLoginResult
login(String who
, String key
, String subkey
) {
170 String realKey
= Instance
.getInstance().getConfig()
171 .getString(Config
.SERVER_KEY
, "");
173 // I don't like NULLs...
174 key
= key
== null ?
"" : key
;
175 subkey
= subkey
== null ?
"" : subkey
;
177 if (!realKey
.equals(key
)) {
178 return new WLoginResult(true, false);
181 // defaults are true (as previous versions without the feature)
186 rw
= Instance
.getInstance().getConfig().getBoolean(Config
.SERVER_RW
,
189 List
<String
> allowed
= Instance
.getInstance().getConfig().getList(
190 Config
.SERVER_ALLOWED_SUBKEYS
, new ArrayList
<String
>());
192 if (!allowed
.isEmpty()) {
193 if (!allowed
.contains(subkey
)) {
194 return new WLoginResult(true, false);
197 if ((subkey
+ "|").contains("|rw|")) {
200 if ((subkey
+ "|").contains("|wl|")) {
201 wl
= false; // |wl| = bypass whitelist
203 if ((subkey
+ "|").contains("|bl|")) {
204 bl
= false; // |bl| = bypass blacklist
208 return new WLoginResult(who
, key
, subkey
, rw
, wl
, bl
);
212 protected Response
getList(String uri
, WLoginResult login
)
214 if (WebLibraryUrls
.LIST_URL_METADATA
.equals(uri
)) {
215 List
<JSONObject
> jsons
= new ArrayList
<JSONObject
>();
216 for (MetaData meta
: metas(login
)) {
217 jsons
.add(JsonIO
.toJson(meta
));
220 return NanoHTTPD
.newFixedLengthResponse(Status
.OK
,
221 "application/json", new JSONArray(jsons
).toString());
224 return NanoHTTPD
.newFixedLengthResponse(Status
.BAD_REQUEST
,
225 NanoHTTPD
.MIME_PLAINTEXT
, null);
228 // /story/luid/chapter/para <-- text/image
229 // /story/luid/cover <-- image
230 // /story/luid/metadata <-- json
231 // /story/luid/json <-- json, whole chapter (no images)
233 protected Response
getStoryPart(String uri
, WLoginResult login
) {
234 String
[] uriParts
= uri
.split("/");
237 if (uriParts
.length
< off
+ 2) {
238 return NanoHTTPD
.newFixedLengthResponse(Status
.BAD_REQUEST
,
239 NanoHTTPD
.MIME_PLAINTEXT
, null);
242 String luid
= uriParts
[off
+ 0];
243 String chapterStr
= uriParts
[off
+ 1];
244 String imageStr
= uriParts
.length
< off
+ 3 ?
null : uriParts
[off
+ 2];
246 // 1-based (0 = desc)
248 if (chapterStr
!= null && !"cover".equals(chapterStr
)
249 && !"metadata".equals(chapterStr
)
250 && !"json".equals(chapterStr
)) {
252 chapter
= Integer
.parseInt(chapterStr
);
254 throw new NumberFormatException();
256 } catch (NumberFormatException e
) {
257 return NanoHTTPD
.newFixedLengthResponse(Status
.BAD_REQUEST
,
258 NanoHTTPD
.MIME_PLAINTEXT
, "Chapter is not valid");
264 if (imageStr
!= null) {
266 paragraph
= Integer
.parseInt(imageStr
);
268 throw new NumberFormatException();
270 } catch (NumberFormatException e
) {
271 return NanoHTTPD
.newFixedLengthResponse(Status
.BAD_REQUEST
,
272 NanoHTTPD
.MIME_PLAINTEXT
, "Paragraph is not valid");
276 String mimeType
= NanoHTTPD
.MIME_PLAINTEXT
;
277 InputStream in
= null;
279 if ("cover".equals(chapterStr
)) {
280 Image img
= storyCover(luid
, login
);
282 in
= img
.newInputStream();
284 // TODO: get correct image type
285 mimeType
= "image/png";
286 } else if ("metadata".equals(chapterStr
)) {
287 MetaData meta
= meta(luid
, login
);
288 JSONObject json
= JsonIO
.toJson(meta
);
289 mimeType
= "application/json";
290 in
= new ByteArrayInputStream(json
.toString().getBytes());
291 } else if ("json".equals(chapterStr
)) {
292 Story story
= story(luid
, login
);
293 JSONObject json
= JsonIO
.toJson(story
);
294 mimeType
= "application/json";
295 in
= new ByteArrayInputStream(json
.toString().getBytes());
297 Story story
= story(luid
, login
);
300 StringBuilder builder
= new StringBuilder();
301 for (Paragraph p
: story
.getMeta().getResume()) {
302 if (builder
.length() == 0) {
303 builder
.append("\n");
305 builder
.append(p
.getContent());
308 in
= new ByteArrayInputStream(
309 builder
.toString().getBytes("utf-8"));
311 Paragraph para
= story
.getChapters().get(chapter
- 1)
312 .getParagraphs().get(paragraph
- 1);
313 Image img
= para
.getContentImage();
314 if (para
.getType() == ParagraphType
.IMAGE
) {
315 // TODO: get correct image type
316 mimeType
= "image/png";
317 in
= img
.newInputStream();
319 in
= new ByteArrayInputStream(
320 para
.getContent().getBytes("utf-8"));
325 } catch (IndexOutOfBoundsException e
) {
326 return NanoHTTPD
.newFixedLengthResponse(Status
.NOT_FOUND
,
327 NanoHTTPD
.MIME_PLAINTEXT
,
328 "Chapter or paragraph does not exist");
329 } catch (IOException e
) {
330 Instance
.getInstance().getTraceHandler()
331 .error(new IOException("Cannot get image: " + uri
, e
));
332 return NanoHTTPD
.newFixedLengthResponse(Status
.INTERNAL_ERROR
,
333 NanoHTTPD
.MIME_PLAINTEXT
, "Error when processing request");
336 return newInputStreamResponse(mimeType
, in
);
339 // /story/luid/source
341 // /story/luid/author
343 protected Response
setStoryPart(String uri
, String value
,
344 WLoginResult login
) throws IOException
{
345 String
[] uriParts
= uri
.split("/");
346 int off
= 2; // "" and "story"
348 if (uriParts
.length
< off
+ 2) {
349 return NanoHTTPD
.newFixedLengthResponse(Status
.BAD_REQUEST
,
350 NanoHTTPD
.MIME_PLAINTEXT
, "Invalid story part request");
354 return NanoHTTPD
.newFixedLengthResponse(Status
.FORBIDDEN
,
355 NanoHTTPD
.MIME_PLAINTEXT
, "SET story part not allowed");
359 return NanoHTTPD
.newFixedLengthResponse(Status
.SERVICE_UNAVAILABLE
,
360 NanoHTTPD
.MIME_PLAINTEXT
, "Server is exiting...");
363 String luid
= uriParts
[off
+ 0];
364 String type
= uriParts
[off
+ 1];
366 if (!Arrays
.asList("source", "title", "author").contains(type
)) {
367 return NanoHTTPD
.newFixedLengthResponse(Status
.BAD_REQUEST
,
368 NanoHTTPD
.MIME_PLAINTEXT
,
369 "Invalid SET story part: " + type
);
372 if (meta(luid
, login
) != null) {
373 BasicLibrary lib
= Instance
.getInstance().getLibrary();
374 if ("source".equals(type
)) {
375 lib
.changeSource(luid
, value
, null);
376 } else if ("title".equals(type
)) {
377 lib
.changeTitle(luid
, value
, null);
378 } else if ("author".equals(type
)) {
379 lib
.changeAuthor(luid
, value
, null);
383 return newInputStreamResponse(NanoHTTPD
.MIME_PLAINTEXT
, null);
387 protected Response
getCover(String uri
, WLoginResult login
)
389 String
[] uriParts
= uri
.split("/");
390 int off
= 2; // "" and "cover"
392 if (uriParts
.length
< off
+ 2) {
393 return NanoHTTPD
.newFixedLengthResponse(Status
.BAD_REQUEST
,
394 NanoHTTPD
.MIME_PLAINTEXT
, "Invalid cover request");
397 String type
= uriParts
[off
+ 0];
398 String id
= uriParts
[off
+ 1];
400 InputStream in
= null;
402 if ("story".equals(type
)) {
403 Image img
= storyCover(id
, login
);
405 in
= img
.newInputStream();
407 } else if ("source".equals(type
)) {
408 Image img
= sourceCover(id
, login
);
410 in
= img
.newInputStream();
412 } else if ("author".equals(type
)) {
413 Image img
= authorCover(id
, login
);
415 in
= img
.newInputStream();
418 return NanoHTTPD
.newFixedLengthResponse(Status
.BAD_REQUEST
,
419 NanoHTTPD
.MIME_PLAINTEXT
,
420 "Invalid GET cover type: " + type
);
423 // TODO: get correct image type
424 return newInputStreamResponse("image/png", in
);
428 protected Response
setCover(String uri
, String luid
, WLoginResult login
)
430 String
[] uriParts
= uri
.split("/");
431 int off
= 2; // "" and "cover"
433 if (uriParts
.length
< off
+ 2) {
434 return NanoHTTPD
.newFixedLengthResponse(Status
.BAD_REQUEST
,
435 NanoHTTPD
.MIME_PLAINTEXT
, "Invalid cover request");
439 return NanoHTTPD
.newFixedLengthResponse(Status
.FORBIDDEN
,
440 NanoHTTPD
.MIME_PLAINTEXT
, "Cover request not allowed");
444 return NanoHTTPD
.newFixedLengthResponse(Status
.SERVICE_UNAVAILABLE
,
445 NanoHTTPD
.MIME_PLAINTEXT
, "Server is exiting...");
448 String type
= uriParts
[off
+ 0];
449 String id
= uriParts
[off
+ 1];
451 if ("source".equals(type
)) {
452 sourceCover(id
, login
, luid
);
453 } else if ("author".equals(type
)) {
454 authorCover(id
, login
, luid
);
456 return NanoHTTPD
.newFixedLengthResponse(Status
.BAD_REQUEST
,
457 NanoHTTPD
.MIME_PLAINTEXT
,
458 "Invalid SET cover type: " + type
);
461 return newInputStreamResponse(NanoHTTPD
.MIME_PLAINTEXT
, null);
465 protected Response
imprt(String uri
, String urlStr
, WLoginResult login
)
467 final BasicLibrary lib
= Instance
.getInstance().getLibrary();
470 return NanoHTTPD
.newFixedLengthResponse(Status
.FORBIDDEN
,
471 NanoHTTPD
.MIME_PLAINTEXT
, "Import not allowed");
475 return NanoHTTPD
.newFixedLengthResponse(Status
.SERVICE_UNAVAILABLE
,
476 NanoHTTPD
.MIME_PLAINTEXT
, "Server is exiting...");
479 final URL url
= new URL(urlStr
);
480 final Progress pg
= new Progress();
481 final String luid
= lib
.getNextId();
483 synchronized (imprts
) {
484 imprts
.put(luid
, pg
);
487 new Thread(new Runnable() {
491 lib
.imprt(url
, luid
, pg
);
492 } catch (IOException e
) {
493 Instance
.getInstance().getTraceHandler().error(e
);
495 synchronized (imprts
) {
500 }, "Import story: " + urlStr
).start();
502 return NanoHTTPD
.newFixedLengthResponse(Status
.OK
,
503 NanoHTTPD
.MIME_PLAINTEXT
, luid
);
507 protected Response
imprtProgress(String uri
, WLoginResult login
) {
508 String
[] uriParts
= uri
.split("/");
509 int off
= 2; // "" and "import"
511 if (uriParts
.length
< off
+ 1) {
512 return NanoHTTPD
.newFixedLengthResponse(Status
.BAD_REQUEST
,
513 NanoHTTPD
.MIME_PLAINTEXT
, "Invalid cover request");
516 String luid
= uriParts
[off
+ 0];
519 synchronized (imprts
) {
520 pg
= imprts
.get(luid
);
523 return NanoHTTPD
.newFixedLengthResponse(Status
.OK
,
524 "application/json", JsonIO
.toJson(pg
).toString());
527 return newInputStreamResponse(NanoHTTPD
.MIME_PLAINTEXT
, null);
531 protected Response
delete(String uri
, WLoginResult login
)
533 String
[] uriParts
= uri
.split("/");
534 int off
= 2; // "" and "delete"
536 if (uriParts
.length
< off
+ 1) {
537 return NanoHTTPD
.newFixedLengthResponse(Status
.BAD_REQUEST
,
538 NanoHTTPD
.MIME_PLAINTEXT
, "Invalid delete request");
542 return NanoHTTPD
.newFixedLengthResponse(Status
.FORBIDDEN
,
543 NanoHTTPD
.MIME_PLAINTEXT
, "Delete not allowed");
547 return NanoHTTPD
.newFixedLengthResponse(Status
.SERVICE_UNAVAILABLE
,
548 NanoHTTPD
.MIME_PLAINTEXT
, "Server is exiting...");
551 String luid
= uriParts
[off
+ 0];
553 BasicLibrary lib
= Instance
.getInstance().getLibrary();
556 return newInputStreamResponse(NanoHTTPD
.MIME_PLAINTEXT
, null);
560 protected List
<MetaData
> metas(WLoginResult login
) throws IOException
{
561 BasicLibrary lib
= Instance
.getInstance().getLibrary();
562 List
<MetaData
> metas
= new ArrayList
<MetaData
>();
563 for (MetaData meta
: lib
.getList().getMetas()) {
564 if (isAllowed(meta
, login
)) {
572 // NULL if not whitelist OK or if not found
574 protected Story
story(String luid
, WLoginResult login
) throws IOException
{
575 synchronized (storyCache
) {
576 if (storyCache
.containsKey(luid
)) {
577 Story story
= storyCache
.get(luid
);
578 if (!isAllowed(story
.getMeta(), login
))
586 MetaData meta
= meta(luid
, login
);
588 BasicLibrary lib
= Instance
.getInstance().getLibrary();
589 story
= lib
.getStory(luid
, null);
590 long size
= sizeOf(story
);
592 synchronized (storyCache
) {
593 // Could have been added by another request
594 if (!storyCache
.containsKey(luid
)) {
595 while (!storyCacheOrder
.isEmpty()
596 && storyCacheSize
+ size
> maxStoryCacheSize
) {
597 String oldestLuid
= storyCacheOrder
.removeFirst();
598 Story oldestStory
= storyCache
.remove(oldestLuid
);
599 maxStoryCacheSize
-= sizeOf(oldestStory
);
602 storyCacheOrder
.add(luid
);
603 storyCache
.put(luid
, story
);
611 private MetaData
meta(String luid
, WLoginResult login
) throws IOException
{
612 BasicLibrary lib
= Instance
.getInstance().getLibrary();
613 MetaData meta
= lib
.getInfo(luid
);
614 if (!isAllowed(meta
, login
))
620 private Image
storyCover(String luid
, WLoginResult login
)
622 MetaData meta
= meta(luid
, login
);
624 BasicLibrary lib
= Instance
.getInstance().getLibrary();
625 return lib
.getCover(meta
.getLuid());
631 private Image
authorCover(String author
, WLoginResult login
)
635 List
<MetaData
> metas
= new MetaResultList(metas(login
)).filter(null,
637 if (metas
.size() > 0) {
638 BasicLibrary lib
= Instance
.getInstance().getLibrary();
639 img
= lib
.getCustomAuthorCover(author
);
641 img
= lib
.getCover(metas
.get(0).getLuid());
648 private void authorCover(String author
, WLoginResult login
, String luid
)
650 if (meta(luid
, login
) != null) {
651 List
<MetaData
> metas
= new MetaResultList(metas(login
)).filter(null,
653 if (metas
.size() > 0) {
654 BasicLibrary lib
= Instance
.getInstance().getLibrary();
655 lib
.setAuthorCover(author
, luid
);
660 private Image
sourceCover(String source
, WLoginResult login
)
664 List
<MetaData
> metas
= new MetaResultList(metas(login
)).filter(source
,
666 if (metas
.size() > 0) {
667 BasicLibrary lib
= Instance
.getInstance().getLibrary();
668 img
= lib
.getCustomSourceCover(source
);
670 img
= lib
.getCover(metas
.get(0).getLuid());
676 private void sourceCover(String source
, WLoginResult login
, String luid
)
678 if (meta(luid
, login
) != null) {
679 List
<MetaData
> metas
= new MetaResultList(metas(login
))
680 .filter(source
, null, null);
681 if (metas
.size() > 0) {
682 BasicLibrary lib
= Instance
.getInstance().getLibrary();
683 lib
.setSourceCover(source
, luid
);
688 private boolean isAllowed(MetaData meta
, WLoginResult login
) {
689 MetaResultList one
= new MetaResultList(Arrays
.asList(meta
));
690 if (login
.isWl() && !whitelist
.isEmpty()) {
691 if (one
.filter(whitelist
, null, null).isEmpty()) {
695 if (login
.isBl() && !blacklist
.isEmpty()) {
696 if (!one
.filter(blacklist
, null, null).isEmpty()) {
704 private long sizeOf(Story story
) {
706 for (Chapter chap
: story
) {
707 for (Paragraph para
: chap
) {
708 if (para
.getType() == ParagraphType
.IMAGE
) {
709 size
+= para
.getContentImage().getSize();
711 size
+= para
.getContent().length();
719 public static void main(String
[] args
) throws IOException
{
721 WebLibraryServer web
= new WebLibraryServer(false);