Add publish action for PDF export

src/control/Control.cpp

@@ -24,6 +24,7 @@
 #include "jobs/AutosaveJob.h"
 #include "jobs/CustomExportJob.h"
 #include "jobs/PdfExportJob.h"
+#include "jobs/PdfPublishJob.h"
 #include "jobs/SaveJob.h"
 #include "layer/LayerController.h"
 #include "model/StrokeStyle.h"
@@ -122,6 +123,7 @@ Control::Control(GApplication* gtkApp, GladeSearchpath* gladeSearchPath): gtkApp
 Control::~Control() {
     g_source_remove(this->changeTimout);
     this->enableAutosave(false);
+    this->enablePublish(false);
 
     deleteLastAutosaveFile("");
     this->scheduler->stop();
@@ -296,6 +298,7 @@ void Control::initWindow(MainWindow* win) {
     this->clipboardHandler = new ClipboardHandler(this, win->getXournal()->getWidget());
 
     this->enableAutosave(settings->isAutosaveEnabled());
+    this->enablePublish(settings->isPublishEnabled());
 
     win->setFontButtonFont(settings->getFont());
 
@@ -324,6 +327,13 @@ auto Control::autosaveCallback(Control* control) -> bool {
     return true;
 }
 
+auto Control::publishCallback(Control* control) -> bool {
+    // always publish, no check for isChangedAutosave because that event might have been triggered just before this one
+    g_message("Info: publish PDF...");
+    control->publishAsPdf();
+    return true;
+}
+
 void Control::enableAutosave(bool enable) {
     if (this->autosaveTimeout) {
         g_source_remove(this->autosaveTimeout);
@@ -336,6 +346,18 @@ void Control::enableAutosave(bool enable) {
     }
 }
 
+void Control::enablePublish(bool enable) {
+    if (this->publishTimeout) {
+        g_source_remove(this->publishTimeout);
+        this->publishTimeout = 0;
+    }
+
+    if (enable) {
+        int timeout = settings->getPublishTimeout();
+        this->publishTimeout = g_timeout_add_seconds(timeout, reinterpret_cast<GSourceFunc>(publishCallback), this);
+    }
+}
+
 void Control::updatePageNumbers(size_t page, size_t pdfPage) {
     if (this->win == nullptr) {
         return;
@@ -388,6 +410,9 @@ void Control::actionPerformed(ActionType type, ActionGroup group, GdkEvent* even
         case ACTION_EXPORT_AS_PDF:
             exportAsPdf();
             break;
+        case ACTION_PUBLISH_AS_PDF:
+            publishAsPdf();
+            break;
         case ACTION_EXPORT_AS:
             exportAs();
             break;
@@ -1892,6 +1917,7 @@ void Control::showSettings() {
     win->updateScrollbarSidebarPosition();
 
     enableAutosave(settings->isAutosaveEnabled());
+    enablePublish(settings->isPublishEnabled());
 
     this->zoom->setZoomStep(settings->getZoomStep() / 100.0);
     this->zoom->setZoomStepScroll(settings->getZoomStepScroll() / 100.0);
@@ -2352,16 +2378,21 @@ void Control::updateWindowTitle() {
 
 void Control::exportAsPdf() {
     this->clearSelectionEndText();
-    exportBase(new PdfExportJob(this));
+    exportBase(new PdfExportJob(this), false);
+}
+
+void Control::publishAsPdf() {
+    this->clearSelectionEndText();
+    exportBase(new PdfPublishJob(this, this->settings->getPublishScript()), true);
 }
 
 void Control::exportAs() {
     this->clearSelectionEndText();
-    exportBase(new CustomExportJob(this));
+    exportBase(new CustomExportJob(this), false);
 }
 
-void Control::exportBase(BaseExportJob* job) {
-    if (job->showFilechooser()) {
+void Control::exportBase(BaseExportJob* job, bool silent) {
+    if (job->showFilechooser(silent)) {
         this->scheduler->addJob(job, JOB_PRIORITY_NONE);
     } else {
         // The job blocked, so we have to unblock, because the job unblocks only after run

src/control/Control.h

@@ -74,8 +74,9 @@ class Control:
     bool annotatePdf(fs::path filepath, bool attachPdf, bool attachToDocument);
     void print();
     void exportAsPdf();
+    void publishAsPdf();
     void exportAs();
-    void exportBase(BaseExportJob* job);
+    void exportBase(BaseExportJob* job, bool silent);
     void quit(bool allowCancel = true);
 
     /**
@@ -202,6 +203,7 @@ class Control:
     void setCopyPasteEnabled(bool enabled);
 
     void enableAutosave(bool enable);
+    void enablePublish(bool enable);
 
     void clearSelectionEndText();
 
@@ -305,6 +307,7 @@ class Control:
 
     static bool checkChangedDocument(Control* control);
     static bool autosaveCallback(Control* control);
+    static bool publishCallback(Control* control);
 
     void fontChanged();
     /**
@@ -385,6 +388,11 @@ class Control:
     int autosaveTimeout = 0;
     fs::path lastAutosaveFilename;
 
+    /**
+     * The publish handler ID
+     */
+    int publishTimeout = 0;
+
     XournalScheduler* scheduler;
 
     /**

src/control/jobs/BaseExportJob.cpp

@@ -46,7 +46,7 @@ auto BaseExportJob::getFilterName() const -> string {
     return gtk_file_filter_get_name(filter);
 }
 
-auto BaseExportJob::showFilechooser() -> bool {
+auto BaseExportJob::showFilechooser(bool silent) -> bool {
     initDialog();
     addFilterToDialog();
 
@@ -57,29 +57,37 @@ auto BaseExportJob::showFilechooser() -> bool {
     fs::path name = doc->createSaveFilename(Document::PDF, settings->getDefaultSaveName());
     doc->unlock();
 
-    gtk_file_chooser_set_local_only(GTK_FILE_CHOOSER(dialog), true);
-    gtk_file_chooser_set_current_folder(GTK_FILE_CHOOSER(dialog), Util::toGFilename(folder).c_str());
-    gtk_file_chooser_set_current_name(GTK_FILE_CHOOSER(dialog), Util::toGFilename(name).c_str());
-
-    gtk_window_set_transient_for(GTK_WINDOW(dialog), GTK_WINDOW(this->control->getWindow()->getWindow()));
-
-    while (true) {
-        if (gtk_dialog_run(GTK_DIALOG(dialog)) != GTK_RESPONSE_OK) {
-            gtk_widget_destroy(dialog);
+    if (silent) {
+        // act as if user has pressed ok everytime
+        fs::path suggestedname = folder;
+        suggestedname /= name;
+        Util::clearExtensions(suggestedname);
+        if (!testAndSetFilepath(std::move(suggestedname))) {
             return false;
         }
-        auto file = Util::fromGFilename(gtk_file_chooser_get_filename(GTK_FILE_CHOOSER(dialog)));
-        Util::clearExtensions(file);
-        // Since we add the extension after the OK button, we have to check manually on existing files
-        if (testAndSetFilepath(std::move(file)) && control->askToReplace(this->filepath)) {
-            break;
+    } else {
+        gtk_file_chooser_set_local_only(GTK_FILE_CHOOSER(dialog), true);
+        gtk_file_chooser_set_current_folder(GTK_FILE_CHOOSER(dialog), Util::toGFilename(folder).c_str());
+        gtk_file_chooser_set_current_name(GTK_FILE_CHOOSER(dialog), Util::toGFilename(name).c_str());
+
+        gtk_window_set_transient_for(GTK_WINDOW(dialog), GTK_WINDOW(this->control->getWindow()->getWindow()));
+
+        while (true) {
+            if (gtk_dialog_run(GTK_DIALOG(dialog)) != GTK_RESPONSE_OK) {
+                gtk_widget_destroy(dialog);
+                return false;
+            }
+            auto file = Util::fromGFilename(gtk_file_chooser_get_filename(GTK_FILE_CHOOSER(dialog)));
+            Util::clearExtensions(file);
+            // Since we add the extension after the OK button, we have to check manually on existing files
+            if (testAndSetFilepath(std::move(file)) && control->askToReplace(this->filepath)) {
+                break;
+            }
         }
+        gtk_widget_destroy(dialog);
     }
 
     settings->setLastSavePath(this->filepath.parent_path());
-
-    gtk_widget_destroy(dialog);
-
     return true;
 }
 

src/control/jobs/BaseExportJob.h

@@ -32,7 +32,7 @@ class BaseExportJob: public BlockingJob {
     virtual void afterRun();
 
 public:
-    virtual bool showFilechooser();
+    virtual bool showFilechooser(bool silent);
     string getFilterName() const;
 
 protected:

src/control/jobs/CustomExportJob.cpp

@@ -61,8 +61,8 @@ auto CustomExportJob::testAndSetFilepath(fs::path file) -> bool {
     return checkOverwriteBackgroundPDF(filepath);
 }
 
-auto CustomExportJob::showFilechooser() -> bool {
-    if (!BaseExportJob::showFilechooser()) {
+auto CustomExportJob::showFilechooser(bool silent) -> bool {
+    if (!BaseExportJob::showFilechooser(silent)) {
         return false;
     }
 

src/control/jobs/CustomExportJob.h

@@ -32,7 +32,7 @@ class CustomExportJob: public BaseExportJob {
     void run();
 
 public:
-    virtual bool showFilechooser();
+    virtual bool showFilechooser(bool silent);
 
 protected:
     virtual void afterRun();

src/control/jobs/PdfExportJob.cpp

@@ -38,6 +38,8 @@ void PdfExportJob::run() {
         } else {
             this->errorMsg = pdfe->getLastError();
         }
+    } else {
+        afterExport();
     }
 
     delete pdfe;

src/control/jobs/PdfExportJob.h

@@ -26,6 +26,7 @@ class PdfExportJob: public BaseExportJob {
 protected:
     virtual void addFilterToDialog();
     bool testAndSetFilepath(fs::path file) override;
+    virtual void afterExport(){};
 
 private:
 };

src/control/jobs/PdfPublishJob.cpp

@@ -0,0 +1,28 @@
+#include "PdfPublishJob.h"
+
+#include "control/Control.h"
+
+#include "i18n.h"
+
+PdfPublishJob::PdfPublishJob(Control* control, const string& script): PdfExportJob(control) { this->script = script; }
+
+PdfPublishJob::~PdfPublishJob() = default;
+
+void PdfPublishJob::afterExport() {
+    PdfExportJob::afterExport();
+
+    if (script != "") {
+        string modscript(script);
+        string parameter = "$1";
+        size_t pos = 0;
+        while (true) {
+            pos = modscript.find(parameter, pos);
+            if (pos == string::npos)
+                break;
+            modscript.erase(pos, parameter.length());
+            modscript.insert(pos, string(this->filepath.c_str()));
+            pos += 1;
+        }
+        system(modscript.c_str());
+    }
+}

src/control/jobs/PdfPublishJob.h

@@ -0,0 +1,26 @@
+/*
+ * Xournal++
+ *
+ * A job to export and publish PDF
+ *
+ * @author Xournal++ Team
+ * https://github.com/xournalpp/xournalpp
+ *
+ * @license GNU GPLv2 or later
+ */
+
+#pragma once
+
+#include "PdfExportJob.h"
+
+class PdfPublishJob: public PdfExportJob {
+public:
+    PdfPublishJob(Control* control, const string& script);
+
+protected:
+    virtual void afterExport();
+    virtual ~PdfPublishJob();
+
+private:
+    string script;
+};