A cross platform Audiobookshelf client for Android and iOS
Dart
import 'dart:async';
import 'dart:convert';
import 'package:flutter_epub_viewer/src/epub_metadata.dart';
import 'package:flutter_epub_viewer/src/models/epub_display_settings.dart';
import 'package:flutter_epub_viewer/src/models/epub_location.dart';
import 'package:flutter_epub_viewer/src/models/epub_search_result.dart';
import 'package:flutter_epub_viewer/src/models/epub_text_extract_res.dart';
import 'package:flutter_epub_viewer/src/utils.dart';
import 'package:flutter/material.dart';
import 'package:flutter_inappwebview/flutter_inappwebview.dart';
import 'models/epub_chapter.dart';
import 'models/epub_theme.dart';
class EpubController {
InAppWebViewController? webViewController;
///List of chapters from epub
List<EpubChapter> _chapters = [];
setWebViewController(InAppWebViewController controller) {
webViewController = controller;
}
///Move epub view to specific area using Cfi string, XPath/XPointer, or chapter href
display({
///Cfi String, XPath/XPointer string, or chapter href of the desired location
///If the string starts with '/', it will be treated as XPath/XPointer
required String cfi,
}) {
checkEpubLoaded();
// Escape quotes in the string
var escapedCfi = cfi.replaceAll('"', '\\"');
webViewController?.evaluateJavascript(source: 'toCfi("$escapedCfi")');
}
///Moves to next page in epub view
next() {
checkEpubLoaded();
webViewController?.evaluateJavascript(source: 'next()');
}
/// How a page turns: "none", "slide" (the page moves sideways and follows
/// a finger dragging it) or "curl" (the app draws it; the page turns at
/// once and leaves sideways drags alone).
Future<void> setTurnStyle(String style) async {
await webViewController?.evaluateJavascript(
source: 'window.setTurnStyle && setTurnStyle(${jsonEncode(style)})');
}
///Moves to previous page in epub view
prev() {
checkEpubLoaded();
webViewController?.evaluateJavascript(source: 'previous()');
}
Completer<EpubLocation> currentLocationCompleter =
Completer<EpubLocation>();
///Returns current location of epub viewer
Future<EpubLocation> getCurrentLocation() async {
checkEpubLoaded();
currentLocationCompleter = Completer<EpubLocation>();
webViewController?.evaluateJavascript(source: 'getCurrentLocation()');
return await currentLocationCompleter.future;
}
///Returns list of [EpubChapter] from epub,
/// should be called after onChaptersLoaded callback, otherwise returns empty list
List<EpubChapter> getChapters() {
checkEpubLoaded();
return _chapters;
}
Future<List<EpubChapter>> parseChapters() async {
if (_chapters.isNotEmpty) return _chapters;
checkEpubLoaded();
final result = await webViewController!.evaluateJavascript(
source: 'getChapters()',
);
_chapters = parseChapterList(result);
return _chapters;
}
Future<EpubMetadata> getMetadata() async {
checkEpubLoaded();
final result = await webViewController!.evaluateJavascript(
source: 'getBookInfo()',
);
return EpubMetadata.fromJson(result);
}
Completer searchResultCompleter = Completer<List<EpubSearchResult>>();
///Search in epub using query string
///Returns a list of [EpubSearchResult]
Future<List<EpubSearchResult>> search({
///Search query string
required String query,
// bool optimized = false,
}) async {
searchResultCompleter = Completer<List<EpubSearchResult>>();
if (query.isEmpty) return [];
checkEpubLoaded();
await webViewController?.evaluateJavascript(
source: 'searchInBook("$query")',
);
return await searchResultCompleter.future;
}
///Adds a highlight to epub viewer
addHighlight({
///Cfi string of the desired location
required String cfi,
///Color of the highlight
Color color = Colors.yellow,
///Opacity of the highlight
double opacity = 0.3,
///Absorb: a blend mode, which also draws at [opacity] as given
String? blend,
}) {
var colorHex = color.toHex();
var opacityString = opacity.toString();
checkEpubLoaded();
webViewController?.evaluateJavascript(
source: blend == null
? 'addHighlight("$cfi", "$colorHex", "$opacityString")'
: 'addHighlightStyled("$cfi", "$colorHex", "$opacityString", "$blend")',
);
}
///Adds a underline annotation
addUnderline({required String cfi}) {
checkEpubLoaded();
webViewController?.evaluateJavascript(source: 'addUnderLine("$cfi")');
}
///Adds a mark annotation
// addMark({required String cfi}) {
// checkEpubLoaded();
// webViewController?.evaluateJavascript(source: 'addMark("$cfi")');
// }
///Removes a highlight from epub viewer
removeHighlight({required String cfi}) {
checkEpubLoaded();
webViewController?.evaluateJavascript(source: 'removeHighlight("$cfi")');
}
///Removes a underline from epub viewer
removeUnderline({required String cfi}) {
checkEpubLoaded();
webViewController?.evaluateJavascript(source: 'removeUnderLine("$cfi")');
}
///Removes a mark from epub viewer
// removeMark({required String cfi}) {
// checkEpubLoaded();
// webViewController?.evaluateJavascript(source: 'removeMark("$cfi")');
// }
///Clears any active text selection in the epub viewer
clearSelection() {
checkEpubLoaded();
webViewController?.evaluateJavascript(source: 'clearSelection()');
}
///Set [EpubSpread] value
setSpread({required EpubSpread spread}) async {
await webViewController?.evaluateJavascript(source: 'setSpread("$spread")');
}
///Set [EpubFlow] value
/// Start the rolling-blind auto scroll at [speed] pixels per second. The
/// next page is revealed top-down over the current one; the text itself
/// never moves. Returns whether the blind actually started - it can't
/// before the book is displayed.
Future<bool> autoScrollStart({double speed = 40}) async {
final r = await webViewController?.evaluateJavascript(source: 'autoScrollStart($speed)');
return r == true || r == 1 || r == 'true';
}
/// Change the blind's descent speed while it is running.
Future<void> autoScrollSpeed(double speed) async {
await webViewController?.evaluateJavascript(source: 'autoScrollSpeed($speed)');
}
/// Hold the blind where it is without tearing it down.
Future<void> autoScrollPause(bool paused) async {
await webViewController?.evaluateJavascript(source: 'autoScrollPause($paused)');
}
/// Put the blind back on the page after the live one, after the reader
/// moved for some other reason.
Future<void> autoScrollResync() async {
await webViewController?.evaluateJavascript(source: 'autoScrollResync()');
}
/// Retract the blind and drop the second rendition.
Future<void> autoScrollStop() async {
await webViewController?.evaluateJavascript(source: 'autoScrollStop()');
}
setFlow({required EpubFlow flow}) async {
await webViewController?.evaluateJavascript(source: 'setFlow("$flow")');
}
///Set [EpubManager] value
setManager({required EpubManager manager}) async {
await webViewController?.evaluateJavascript(
source: 'setManager("$manager")',
);
}
///Adjust font size in epub viewer
setFontSize({required double fontSize}) async {
await webViewController?.evaluateJavascript(
source: 'setFontSize("$fontSize")',
);
}
updateTheme({required EpubTheme theme}) async {
String? foregroundColor = theme.foregroundColor?.toHex();
String customCss = theme.customCss != null
? Utils.encodeMap(theme.customCss!)
: "null";
await webViewController?.evaluateJavascript(
source: 'updateTheme("","$foregroundColor", $customCss)',
);
}
Completer<EpubTextExtractRes>? _pageTextCompleter;
Completer<Rect?> cfiRectCompleter = Completer<Rect?>();
/// Safely complete the page text completer
void completePageText(EpubTextExtractRes result) {
if (_pageTextCompleter != null && !_pageTextCompleter!.isCompleted) {
_pageTextCompleter!.complete(result);
}
}
///Extract text from a given cfi range,
Future<EpubTextExtractRes> extractText({
///start cfi
required startCfi,
///end cfi
required endCfi,
}) async {
checkEpubLoaded();
// Complete previous completer if it exists and isn't completed
if (_pageTextCompleter != null && !_pageTextCompleter!.isCompleted) {
try {
_pageTextCompleter!.completeError('Cancelled by new request');
} catch (e) {
// Ignore if already completed
}
}
_pageTextCompleter = Completer<EpubTextExtractRes>();
await webViewController?.evaluateJavascript(
source: 'getTextFromCfi("$startCfi","$endCfi")',
);
return _pageTextCompleter!.future;
}
///Get bounding rectangle for a given CFI range
///Returns WebView-relative coordinates in pixels, or null if rect cannot be determined
Future<Rect?> getRectFromCfi(String cfiRange) async {
checkEpubLoaded();
cfiRectCompleter = Completer<Rect?>();
// Escape quotes in the CFI string
var escapedCfi = cfiRange.replaceAll('"', '\\"');
await webViewController?.evaluateJavascript(
source: 'getRectFromCfi("$escapedCfi")',
);
return cfiRectCompleter.future;
}
///Extracts text content from current page
Future<EpubTextExtractRes> extractCurrentPageText() async {
checkEpubLoaded();
// Complete previous completer if it exists and isn't completed
if (_pageTextCompleter != null && !_pageTextCompleter!.isCompleted) {
try {
_pageTextCompleter!.completeError('Cancelled by new request');
} catch (e) {
// Ignore if already completed
}
}
_pageTextCompleter = Completer<EpubTextExtractRes>();
await webViewController?.evaluateJavascript(source: 'getCurrentPageText()');
return _pageTextCompleter!.future;
}
///Given a percentage moves to the corresponding page
///Progress percentage should be between 0.0 and 1.0
toProgressPercentage(double progressPercent) {
assert(
progressPercent >= 0.0 && progressPercent <= 1.0,
'Progress percentage must be between 0.0 and 1.0',
);
checkEpubLoaded();
webViewController?.evaluateJavascript(
source: 'toProgress($progressPercent)',
);
}
///Moves to the first page of the epub
moveToFistPage() {
toProgressPercentage(0.0);
}
///Moves to the last page of the epub
moveToLastPage() {
toProgressPercentage(1.0);
}
checkEpubLoaded() {
if (webViewController == null) {
throw Exception(
"Epub viewer is not loaded, wait for onEpubLoaded callback",
);
}
}
}