@capawesome/capacitor-pdf-generator 0.0.1

package/android/src/main/java/io/capawesome/capacitorjs/plugins/pdfgenerator/PdfGenerator.java

@@ -0,0 +1,255 @@
+package io.capawesome.capacitorjs.plugins.pdfgenerator;
+
+import android.annotation.SuppressLint;
+import android.os.Handler;
+import android.os.Looper;
+import android.print.PdfGeneratorPrintDriver;
+import android.print.PrintAttributes;
+import android.print.PrintDocumentAdapter;
+import android.view.View;
+import android.webkit.WebResourceError;
+import android.webkit.WebResourceRequest;
+import android.webkit.WebView;
+import android.webkit.WebViewClient;
+import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
+import io.capawesome.capacitorjs.plugins.pdfgenerator.classes.CustomException;
+import io.capawesome.capacitorjs.plugins.pdfgenerator.classes.CustomExceptions;
+import io.capawesome.capacitorjs.plugins.pdfgenerator.classes.options.GenerateFromHtmlOptions;
+import io.capawesome.capacitorjs.plugins.pdfgenerator.classes.options.GenerateFromUrlOptions;
+import io.capawesome.capacitorjs.plugins.pdfgenerator.classes.options.GenerateOptions;
+import io.capawesome.capacitorjs.plugins.pdfgenerator.classes.results.GenerateResult;
+import io.capawesome.capacitorjs.plugins.pdfgenerator.interfaces.NonEmptyResultCallback;
+import java.io.File;
+import java.util.ArrayDeque;
+
+public class PdfGenerator {
+
+    private static final String DOCUMENTS_DIRECTORY_NAME = "capawesome_capacitor_pdf_generator_documents";
+    private static final int MARGIN_IN_MILS = 278; // ~20 pt
+    private static final int SCREEN_RESOLUTION_IN_DPI = 96;
+    private static final long SETTLE_DELAY_IN_MILLISECONDS = 500;
+
+    @NonNull
+    private final Handler handler = new Handler(Looper.getMainLooper());
+
+    @NonNull
+    private final PdfGeneratorPlugin plugin;
+
+    @NonNull
+    private final ArrayDeque<Runnable> queue = new ArrayDeque<>();
+
+    @Nullable
+    private NonEmptyResultCallback<GenerateResult> currentCallback;
+
+    @Nullable
+    private GenerateOptions currentOptions;
+
+    @Nullable
+    private Runnable currentSettleRunnable;
+
+    @Nullable
+    private Runnable currentTimeoutRunnable;
+
+    @Nullable
+    private WebView currentWebView;
+
+    private boolean generating = false;
+
+    public PdfGenerator(@NonNull PdfGeneratorPlugin plugin) {
+        this.plugin = plugin;
+        cleanUpDocumentsDirectory();
+    }
+
+    public void generateFromHtml(@NonNull GenerateFromHtmlOptions options, @NonNull NonEmptyResultCallback<GenerateResult> callback) {
+        enqueue(() -> {
+            WebView webView = startGeneration(options, callback);
+            webView.loadDataWithBaseURL(options.getBaseUrl(), options.getHtml(), "text/html", "UTF-8", null);
+        });
+    }
+
+    public void generateFromUrl(@NonNull GenerateFromUrlOptions options, @NonNull NonEmptyResultCallback<GenerateResult> callback) {
+        enqueue(() -> {
+            WebView webView = startGeneration(options, callback);
+            webView.loadUrl(options.getUrl());
+        });
+    }
+
+    private void cleanUpDocumentsDirectory() {
+        File[] files = getDocumentsDirectory().listFiles();
+        if (files == null) {
+            return;
+        }
+        for (File file : files) {
+            file.delete();
+        }
+    }
+
+    private void createDocument() {
+        GenerateOptions options = currentOptions;
+        WebView webView = currentWebView;
+        if (options == null || webView == null) {
+            return;
+        }
+        PrintAttributes attributes = new PrintAttributes.Builder()
+            .setMediaSize(options.getMediaSize())
+            .setMinMargins(new PrintAttributes.Margins(MARGIN_IN_MILS, MARGIN_IN_MILS, MARGIN_IN_MILS, MARGIN_IN_MILS))
+            .setResolution(new PrintAttributes.Resolution("pdf", "pdf", 600, 600))
+            .build();
+        File file = new File(getDocumentsDirectory(), options.getFileName());
+        PrintDocumentAdapter adapter = webView.createPrintDocumentAdapter(options.getFileName());
+        NonEmptyResultCallback<GenerateResult> callback = currentCallback;
+        PdfGeneratorPrintDriver.print(
+            adapter,
+            attributes,
+            file,
+            new PdfGeneratorPrintDriver.Callback() {
+                @Override
+                public void onFailure(@Nullable String message) {
+                    handler.post(() -> {
+                        if (currentCallback != callback) {
+                            return;
+                        }
+                        finishWithError(
+                            message == null ? CustomExceptions.GENERATION_FAILED : new CustomException("GENERATION_FAILED", message)
+                        );
+                    });
+                }
+
+                @Override
+                public void onSuccess() {
+                    handler.post(() -> {
+                        if (currentCallback != callback) {
+                            return;
+                        }
+                        finishWithSuccess(new GenerateResult(file));
+                    });
+                }
+            }
+        );
+    }
+
+    @SuppressLint("SetJavaScriptEnabled")
+    @NonNull
+    private WebView createWebView(@NonNull GenerateOptions options) {
+        WebView webView = new WebView(plugin.getContext());
+        webView.getSettings().setJavaScriptEnabled(true);
+        webView.getSettings().setDomStorageEnabled(true);
+        int widthInPixels = Math.round((options.getMediaSize().getWidthMils() / 1000f) * SCREEN_RESOLUTION_IN_DPI);
+        int heightInPixels = Math.round((options.getMediaSize().getHeightMils() / 1000f) * SCREEN_RESOLUTION_IN_DPI);
+        webView.measure(
+            View.MeasureSpec.makeMeasureSpec(widthInPixels, View.MeasureSpec.EXACTLY),
+            View.MeasureSpec.makeMeasureSpec(heightInPixels, View.MeasureSpec.EXACTLY)
+        );
+        webView.layout(0, 0, widthInPixels, heightInPixels);
+        webView.setWebViewClient(createWebViewClient());
+        return webView;
+    }
+
+    @NonNull
+    private WebViewClient createWebViewClient() {
+        return new WebViewClient() {
+            @Override
+            public void onPageFinished(WebView view, String url) {
+                if (view == currentWebView) {
+                    scheduleDocumentCreation();
+                }
+            }
+
+            @Override
+            public void onReceivedError(WebView view, WebResourceRequest request, WebResourceError error) {
+                if (view == currentWebView && request.isForMainFrame()) {
+                    finishWithError(CustomExceptions.LOAD_FAILED);
+                }
+            }
+        };
+    }
+
+    private void enqueue(@NonNull Runnable task) {
+        handler.post(() -> {
+            queue.add(task);
+            processQueue();
+        });
+    }
+
+    @Nullable
+    private NonEmptyResultCallback<GenerateResult> finishGeneration() {
+        NonEmptyResultCallback<GenerateResult> callback = currentCallback;
+        if (callback == null) {
+            return null;
+        }
+        if (currentSettleRunnable != null) {
+            handler.removeCallbacks(currentSettleRunnable);
+            currentSettleRunnable = null;
+        }
+        if (currentTimeoutRunnable != null) {
+            handler.removeCallbacks(currentTimeoutRunnable);
+            currentTimeoutRunnable = null;
+        }
+        if (currentWebView != null) {
+            currentWebView.destroy();
+            currentWebView = null;
+        }
+        currentCallback = null;
+        currentOptions = null;
+        generating = false;
+        processQueue();
+        return callback;
+    }
+
+    private void finishWithError(@NonNull Exception exception) {
+        NonEmptyResultCallback<GenerateResult> callback = finishGeneration();
+        if (callback != null) {
+            callback.error(exception);
+        }
+    }
+
+    private void finishWithSuccess(@NonNull GenerateResult result) {
+        NonEmptyResultCallback<GenerateResult> callback = finishGeneration();
+        if (callback != null) {
+            callback.success(result);
+        }
+    }
+
+    @NonNull
+    private File getDocumentsDirectory() {
+        File directory = new File(plugin.getContext().getCacheDir(), DOCUMENTS_DIRECTORY_NAME);
+        directory.mkdirs();
+        return directory;
+    }
+
+    private void handleTimeout() {
+        finishWithError(CustomExceptions.TIMEOUT);
+    }
+
+    private void processQueue() {
+        if (generating) {
+            return;
+        }
+        Runnable task = queue.poll();
+        if (task == null) {
+            return;
+        }
+        generating = true;
+        task.run();
+    }
+
+    private void scheduleDocumentCreation() {
+        if (currentSettleRunnable != null) {
+            handler.removeCallbacks(currentSettleRunnable);
+        }
+        currentSettleRunnable = this::createDocument;
+        handler.postDelayed(currentSettleRunnable, SETTLE_DELAY_IN_MILLISECONDS);
+    }
+
+    @NonNull
+    private WebView startGeneration(@NonNull GenerateOptions options, @NonNull NonEmptyResultCallback<GenerateResult> callback) {
+        currentCallback = callback;
+        currentOptions = options;
+        WebView webView = createWebView(options);
+        currentWebView = webView;
+        currentTimeoutRunnable = this::handleTimeout;
+        handler.postDelayed(currentTimeoutRunnable, options.getTimeout());
+        return webView;
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/pdfgenerator/PdfGeneratorPlugin.java

@@ -0,0 +1,88 @@
+package io.capawesome.capacitorjs.plugins.pdfgenerator;
+
+import androidx.annotation.NonNull;
+import com.getcapacitor.Logger;
+import com.getcapacitor.Plugin;
+import com.getcapacitor.PluginCall;
+import com.getcapacitor.PluginMethod;
+import com.getcapacitor.annotation.CapacitorPlugin;
+import io.capawesome.capacitorjs.plugins.pdfgenerator.classes.CustomException;
+import io.capawesome.capacitorjs.plugins.pdfgenerator.classes.options.GenerateFromHtmlOptions;
+import io.capawesome.capacitorjs.plugins.pdfgenerator.classes.options.GenerateFromUrlOptions;
+import io.capawesome.capacitorjs.plugins.pdfgenerator.classes.results.GenerateResult;
+import io.capawesome.capacitorjs.plugins.pdfgenerator.interfaces.NonEmptyResultCallback;
+import io.capawesome.capacitorjs.plugins.pdfgenerator.interfaces.Result;
+
+@CapacitorPlugin(name = "PdfGenerator")
+public class PdfGeneratorPlugin extends Plugin {
+
+    public static final String ERROR_UNKNOWN_ERROR = "An unknown error has occurred.";
+    public static final String TAG = "PdfGeneratorPlugin";
+
+    private PdfGenerator implementation;
+
+    @Override
+    public void load() {
+        super.load();
+        this.implementation = new PdfGenerator(this);
+    }
+
+    @PluginMethod
+    public void generateFromHtml(PluginCall call) {
+        try {
+            GenerateFromHtmlOptions options = new GenerateFromHtmlOptions(call);
+            NonEmptyResultCallback<GenerateResult> callback = new NonEmptyResultCallback<>() {
+                @Override
+                public void success(@NonNull GenerateResult result) {
+                    resolveCall(call, result);
+                }
+
+                @Override
+                public void error(Exception exception) {
+                    rejectCall(call, exception);
+                }
+            };
+            implementation.generateFromHtml(options, callback);
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    @PluginMethod
+    public void generateFromUrl(PluginCall call) {
+        try {
+            GenerateFromUrlOptions options = new GenerateFromUrlOptions(call);
+            NonEmptyResultCallback<GenerateResult> callback = new NonEmptyResultCallback<>() {
+                @Override
+                public void success(@NonNull GenerateResult result) {
+                    resolveCall(call, result);
+                }
+
+                @Override
+                public void error(Exception exception) {
+                    rejectCall(call, exception);
+                }
+            };
+            implementation.generateFromUrl(options, callback);
+        } catch (Exception exception) {
+            rejectCall(call, exception);
+        }
+    }
+
+    private void rejectCall(@NonNull PluginCall call, @NonNull Exception exception) {
+        String message = exception.getMessage();
+        if (message == null) {
+            message = ERROR_UNKNOWN_ERROR;
+        }
+        String code = null;
+        if (exception instanceof CustomException) {
+            code = ((CustomException) exception).getCode();
+        }
+        Logger.error(TAG, message, exception);
+        call.reject(message, code);
+    }
+
+    private void resolveCall(@NonNull PluginCall call, @NonNull Result result) {
+        call.resolve(result.toJSObject());
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/pdfgenerator/classes/CustomException.java

@@ -0,0 +1,20 @@
+package io.capawesome.capacitorjs.plugins.pdfgenerator.classes;
+
+import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
+
+public class CustomException extends Exception {
+
+    @Nullable
+    private final String code;
+
+    public CustomException(@Nullable String code, @NonNull String message) {
+        super(message);
+        this.code = code;
+    }
+
+    @Nullable
+    public String getCode() {
+        return code;
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/pdfgenerator/classes/CustomExceptions.java

@@ -0,0 +1,15 @@
+package io.capawesome.capacitorjs.plugins.pdfgenerator.classes;
+
+public class CustomExceptions {
+
+    public static final CustomException GENERATION_FAILED = new CustomException(
+        "GENERATION_FAILED",
+        "The PDF file could not be generated."
+    );
+    public static final CustomException HTML_MISSING = new CustomException(null, "html must be provided.");
+    public static final CustomException LOAD_FAILED = new CustomException("LOAD_FAILED", "The HTML content or URL could not be loaded.");
+    public static final CustomException ORIENTATION_INVALID = new CustomException(null, "orientation must be one of the supported values.");
+    public static final CustomException PAGE_SIZE_INVALID = new CustomException(null, "pageSize must be one of the supported values.");
+    public static final CustomException TIMEOUT = new CustomException("TIMEOUT", "The PDF generation timed out.");
+    public static final CustomException URL_MISSING = new CustomException(null, "url must be provided.");
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/pdfgenerator/classes/options/GenerateFromHtmlOptions.java

@@ -0,0 +1,45 @@
+package io.capawesome.capacitorjs.plugins.pdfgenerator.classes.options;
+
+import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
+import com.getcapacitor.PluginCall;
+import io.capawesome.capacitorjs.plugins.pdfgenerator.classes.CustomExceptions;
+
+public class GenerateFromHtmlOptions extends GenerateOptions {
+
+    @Nullable
+    private final String baseUrl;
+
+    @NonNull
+    private final String html;
+
+    public GenerateFromHtmlOptions(@NonNull PluginCall call) throws Exception {
+        super(call);
+        this.baseUrl = GenerateFromHtmlOptions.getBaseUrlFromCall(call);
+        this.html = GenerateFromHtmlOptions.getHtmlFromCall(call);
+    }
+
+    @Nullable
+    public String getBaseUrl() {
+        return baseUrl;
+    }
+
+    @NonNull
+    public String getHtml() {
+        return html;
+    }
+
+    @Nullable
+    private static String getBaseUrlFromCall(@NonNull PluginCall call) {
+        return call.getString("baseUrl");
+    }
+
+    @NonNull
+    private static String getHtmlFromCall(@NonNull PluginCall call) throws Exception {
+        String html = call.getString("html");
+        if (html == null) {
+            throw CustomExceptions.HTML_MISSING;
+        }
+        return html;
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/pdfgenerator/classes/options/GenerateFromUrlOptions.java

@@ -0,0 +1,30 @@
+package io.capawesome.capacitorjs.plugins.pdfgenerator.classes.options;
+
+import androidx.annotation.NonNull;
+import com.getcapacitor.PluginCall;
+import io.capawesome.capacitorjs.plugins.pdfgenerator.classes.CustomExceptions;
+
+public class GenerateFromUrlOptions extends GenerateOptions {
+
+    @NonNull
+    private final String url;
+
+    public GenerateFromUrlOptions(@NonNull PluginCall call) throws Exception {
+        super(call);
+        this.url = GenerateFromUrlOptions.getUrlFromCall(call);
+    }
+
+    @NonNull
+    public String getUrl() {
+        return url;
+    }
+
+    @NonNull
+    private static String getUrlFromCall(@NonNull PluginCall call) throws Exception {
+        String url = call.getString("url");
+        if (url == null) {
+            throw CustomExceptions.URL_MISSING;
+        }
+        return url;
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/pdfgenerator/classes/options/GenerateOptions.java

@@ -0,0 +1,80 @@
+package io.capawesome.capacitorjs.plugins.pdfgenerator.classes.options;
+
+import android.print.PrintAttributes;
+import androidx.annotation.NonNull;
+import com.getcapacitor.PluginCall;
+import io.capawesome.capacitorjs.plugins.pdfgenerator.classes.CustomExceptions;
+import java.util.UUID;
+
+public class GenerateOptions {
+
+    @NonNull
+    private final String fileName;
+
+    @NonNull
+    private final PrintAttributes.MediaSize mediaSize;
+
+    private final long timeout;
+
+    public GenerateOptions(@NonNull PluginCall call) throws Exception {
+        this.fileName = GenerateOptions.getFileNameFromCall(call);
+        this.mediaSize = GenerateOptions.getMediaSizeFromCall(call);
+        this.timeout = GenerateOptions.getTimeoutFromCall(call);
+    }
+
+    @NonNull
+    public String getFileName() {
+        return fileName;
+    }
+
+    @NonNull
+    public PrintAttributes.MediaSize getMediaSize() {
+        return mediaSize;
+    }
+
+    public long getTimeout() {
+        return timeout;
+    }
+
+    @NonNull
+    private static String getFileNameFromCall(@NonNull PluginCall call) {
+        String fileName = call.getString("fileName");
+        if (fileName == null) {
+            fileName = UUID.randomUUID() + ".pdf";
+        }
+        return fileName.endsWith(".pdf") ? fileName : fileName + ".pdf";
+    }
+
+    @NonNull
+    private static PrintAttributes.MediaSize getMediaSizeFromCall(@NonNull PluginCall call) throws Exception {
+        PrintAttributes.MediaSize mediaSize;
+        switch (call.getString("pageSize", "A4")) {
+            case "A3":
+                mediaSize = PrintAttributes.MediaSize.ISO_A3;
+                break;
+            case "A4":
+                mediaSize = PrintAttributes.MediaSize.ISO_A4;
+                break;
+            case "A5":
+                mediaSize = PrintAttributes.MediaSize.ISO_A5;
+                break;
+            case "LETTER":
+                mediaSize = PrintAttributes.MediaSize.NA_LETTER;
+                break;
+            default:
+                throw CustomExceptions.PAGE_SIZE_INVALID;
+        }
+        switch (call.getString("orientation", "PORTRAIT")) {
+            case "LANDSCAPE":
+                return mediaSize.asLandscape();
+            case "PORTRAIT":
+                return mediaSize.asPortrait();
+            default:
+                throw CustomExceptions.ORIENTATION_INVALID;
+        }
+    }
+
+    private static long getTimeoutFromCall(@NonNull PluginCall call) {
+        return call.getInt("timeout", 30000);
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/pdfgenerator/classes/results/GenerateResult.java

@@ -0,0 +1,25 @@
+package io.capawesome.capacitorjs.plugins.pdfgenerator.classes.results;
+
+import android.net.Uri;
+import androidx.annotation.NonNull;
+import com.getcapacitor.JSObject;
+import io.capawesome.capacitorjs.plugins.pdfgenerator.interfaces.Result;
+import java.io.File;
+
+public class GenerateResult implements Result {
+
+    @NonNull
+    private final File file;
+
+    public GenerateResult(@NonNull File file) {
+        this.file = file;
+    }
+
+    @Override
+    @NonNull
+    public JSObject toJSObject() {
+        JSObject result = new JSObject();
+        result.put("path", Uri.fromFile(file).toString());
+        return result;
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/pdfgenerator/interfaces/Callback.java

@@ -0,0 +1,5 @@
+package io.capawesome.capacitorjs.plugins.pdfgenerator.interfaces;
+
+public interface Callback {
+    void error(Exception exception);
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/pdfgenerator/interfaces/NonEmptyResultCallback.java

@@ -0,0 +1,7 @@
+package io.capawesome.capacitorjs.plugins.pdfgenerator.interfaces;
+
+import androidx.annotation.NonNull;
+
+public interface NonEmptyResultCallback<T extends Result> extends Callback {
+    void success(@NonNull T result);
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/pdfgenerator/interfaces/Result.java

@@ -0,0 +1,7 @@
+package io.capawesome.capacitorjs.plugins.pdfgenerator.interfaces;
+
+import com.getcapacitor.JSObject;
+
+public interface Result {
+    JSObject toJSObject();
+}