dtourolle
352e59498b
The packages now carry the manual, but nothing in the application opened it: the help sheet listed gestures and stopped there. The help sheet gains a Manual button beside Done, and Settings a Manual row under About beside the version. Both go through dr_ui::manual, which finds the installed page through dr_plat::system_data_dirs (the package's share directory on Linux, the executable's directory on Windows), and a development build also in the checkout it was compiled from. A copy with no manual says so on the status line rather than doing nothing. On the desktop the page goes to the system browser. A section is a URL fragment, and xdg-open's generic mode and Windows' FileProtocolHandler both turn a file: URL into a path and drop the fragment, so a section is opened through a one-line redirect page written to the data directory: the opener gets a plain path, which every opener keeps, and the browser follows the redirect to index.html#section itself. The launcher behind the sign-in's open_in_browser is split out so both share it; the https check stays with the sign-in. Android has no path to give a browser: an asset is not a file, a copy in private storage is unreadable to other apps, a file: URI across apps is refused, and a content: URI leaves the browser resolving every picture against the provider. So ManualActivity, a WebView reading file:///android_asset/manual/index.html straight out of the APK, shows it, started by class name with the section as an extra. JavaScript is off, links off the page go to the browser, and the theme is day-night so the page's own light and dark follow the system. A test checks that the manifest, the Java class and dr_ui agree on the name and the extra.
106 lines
3.7 KiB
Java
106 lines
3.7 KiB
Java
package paris.tourolle.darkroom;
|
|
|
|
import android.app.Activity;
|
|
import android.content.ActivityNotFoundException;
|
|
import android.content.Intent;
|
|
import android.net.Uri;
|
|
import android.os.Bundle;
|
|
import android.webkit.WebResourceRequest;
|
|
import android.webkit.WebSettings;
|
|
import android.webkit.WebView;
|
|
import android.webkit.WebViewClient;
|
|
|
|
/**
|
|
* The manual that ships in the APK, shown in a WebView.
|
|
*
|
|
* <h2>Why an activity of our own rather than the browser</h2>
|
|
*
|
|
* <p>The desktop hands the manual to the system browser. Android leaves no
|
|
* way to do the same: the page is an asset inside the APK, which is not a
|
|
* file; an unpacked copy in app-private storage is a file no browser may
|
|
* read; a {@code file:} URI handed to another app is refused since API 24;
|
|
* and a {@code content:} URI serves the page but leaves the browser to fetch
|
|
* every picture by a relative URL against the provider, which browsers do not
|
|
* reliably do. A WebView reads {@code file:///android_asset/} straight from
|
|
* the APK, pictures and section anchor included, and nothing is unpacked.
|
|
*
|
|
* <h2>What it is not</h2>
|
|
*
|
|
* <p>A browser. JavaScript stays off (the page has none), and a link that
|
|
* leaves the manual — the design documents are on the forge — goes to the
|
|
* user's browser rather than opening inside this view, so the only thing ever
|
|
* shown here is the page the APK carries.
|
|
*
|
|
* <p>Started by {@code dr_ui::manual} with {@code Intent.setClassName}, so the
|
|
* name here and there must agree; a test in lib.rs checks the manifest
|
|
* declares it.
|
|
*/
|
|
public final class ManualActivity extends Activity {
|
|
/** The section to open at, a heading's anchor. Absent opens the top. */
|
|
public static final String EXTRA_ANCHOR = "anchor";
|
|
|
|
private static final String PAGE = "file:///android_asset/manual/index.html";
|
|
|
|
private WebView web;
|
|
|
|
@Override
|
|
protected void onCreate(Bundle saved) {
|
|
super.onCreate(saved);
|
|
setTitle("DarkRoom manual");
|
|
|
|
web = new WebView(this);
|
|
WebSettings settings = web.getSettings();
|
|
settings.setJavaScriptEnabled(false);
|
|
// Pinch to zoom into a screenshot, which is 1600 pixels wide and drawn
|
|
// at the width of a phone.
|
|
settings.setBuiltInZoomControls(true);
|
|
settings.setDisplayZoomControls(false);
|
|
web.setWebViewClient(new WebViewClient() {
|
|
@Override
|
|
public boolean shouldOverrideUrlLoading(WebView view, WebResourceRequest request) {
|
|
Uri uri = request.getUrl();
|
|
if ("file".equals(uri.getScheme())) {
|
|
return false;
|
|
}
|
|
try {
|
|
startActivity(new Intent(Intent.ACTION_VIEW, uri));
|
|
} catch (ActivityNotFoundException e) {
|
|
// No browser on the device: the link does nothing, which
|
|
// is all it could do.
|
|
}
|
|
return true;
|
|
}
|
|
});
|
|
setContentView(web);
|
|
|
|
if (saved != null) {
|
|
web.restoreState(saved);
|
|
} else {
|
|
String anchor = getIntent().getStringExtra(EXTRA_ANCHOR);
|
|
web.loadUrl(anchor == null || anchor.isEmpty() ? PAGE : PAGE + "#" + anchor);
|
|
}
|
|
}
|
|
|
|
@Override
|
|
protected void onSaveInstanceState(Bundle out) {
|
|
super.onSaveInstanceState(out);
|
|
web.saveState(out);
|
|
}
|
|
|
|
/** Back walks back through the sections visited, then leaves. */
|
|
@Override
|
|
public void onBackPressed() {
|
|
if (web.canGoBack()) {
|
|
web.goBack();
|
|
} else {
|
|
super.onBackPressed();
|
|
}
|
|
}
|
|
|
|
@Override
|
|
protected void onDestroy() {
|
|
web.destroy();
|
|
super.onDestroy();
|
|
}
|
|
}
|