.liquid format

README.md

@@ -108,7 +108,20 @@ sudo make uninstall
 ```
 
 
+## Where things are stored
+
+Each Liquid app is a single `.liquid` file: an XML document containing everything about that app
+(settings, custom CSS and JavaScript, window state, cookies, icon).
+Liquid apps reside in the `apps` directory inside of Liquid's data directory, which is located at:
+
+ - GNU/Linux, BSD, and others: `~/.liquid/`
+ - macOS: `~/Library/Application Support/Liquid/`
+ - Windows: `%LOCALAPPDATA%\Liquid\`
+
+Keep in mind that `.liquid` files may contain secrets (cookies, proxy credentials).
+
+
 ## Customize
 
-Placing a file named `liquid.qss` into `~/.config/liquid/` will serve as additional stylesheet for the program.
+Placing a file named `liquid.qss` into Liquid's data directory will serve as additional stylesheet for the program.
 You can use [base.qss](res/styles/base.qss) as reference.

inc/liquid.hpp

@@ -13,7 +13,8 @@ class Liquid
     static bool detectDarkModeUncached(void);
     static QByteArray generateRandomByteArray(const int byteLength);
     static QDir getAppsDir(void);
-    static QDir getConfigDir(void);
+    static QDir getDataDir(void);
+    static QString getLiquidAppFilePath(const QString liquidAppName);
     static QString getDefaultUserAgentString(void);
     static QStringList getLiquidAppsList(void);
     static void raiseWindow(QWidget* window);

inc/liquidappfile.hpp

@@ -0,0 +1,22 @@
+#pragma once
+
+#include <QSettings>
+
+// The .liquid file format: a single, human-readable XML file per Liquid app, containing everything about it
+// (settings, custom CSS and JS, state, cookies, icon), with multi-line code stored verbatim in CDATA sections.
+//
+// It's plugged into QSettings as a custom format, so the rest of the program keeps working with familiar
+// QSettings keys (e.g. "URL", "Proxy/Host"), while this class maps them to and from XML.
+class LiquidAppFile
+{
+public:
+    // Registers the format with QSettings upon first use
+    static QSettings::Format format(void);
+
+    // Opens the .liquid file of the Liquid app by the given name (the caller takes ownership)
+    static QSettings* open(const QString& liquidAppName);
+
+private:
+    static bool read(QIODevice& device, QSettings::SettingsMap& map);
+    static bool write(QIODevice& device, const QSettings::SettingsMap& map);
+};

inc/liquidappwindow.hpp

@@ -59,6 +59,8 @@ public slots:
 
 private:
     void takeSnapshot(const bool fullPage);
+    void rememberGeometry(void);
+    static bool isPositionManagedByWindowSystem(void);
     QImage captureFullPage(void);
     void renderSnapshot(QPainter* painter);
     void flash(void);
@@ -69,15 +71,15 @@ public slots:
     void waitForNextFrame(void);
     bool waitForDocumentToFinishLoading(void);
 
-    QString* liquidAppName;
+    QString liquidAppName;
 
     QString liquidAppWindowTitle;
     QIcon iconToSave;
 
     LiquidAppWebPage* liquidAppWebPage = Q_NULLPTR;
     QWebEngineProfile* liquidAppWebProfile = Q_NULLPTR;
     QWebEngineSettings* liquidAppWebSettings = Q_NULLPTR;
-    QByteArray liquidAppWindowGeometry;
+    QRect rememberedGeometry; // Window geometry while in normal state (neither maximized nor full-screen)
     QTimer* rememberGeometryTimer = Q_NULLPTR;
     QList<qreal> zoomFactors;
 

inc/lqd.h

@@ -3,6 +3,7 @@
 /* Various globals */
 #define LQD_PROG_TITLE         "Liquid"
 #define LQD_APPS_DIR_NAME      "apps"
+#define LQD_APP_FILE_EXTENSION "liquid"
 #define LQD_DEFAULT_BG_COLOR   Qt::white
 #define LQD_DEFAULT_PROXY_HOST "0.0.0.0"
 #define LQD_DEFAULT_PROXY_PORT 8080
@@ -76,7 +77,13 @@
 #define LQD_CFG_KEY_NAME_USE_CUSTOM_BG           "UseCustomBackground" // boolean, defaults to FALSE
 #define LQD_CFG_KEY_NAME_USER_AGENT              "UserAgent" // text
 #define LQD_CFG_KEY_NAME_URL                     "URL" // text, required
-#define LQD_CFG_KEY_NAME_WIN_GEOM                "WindowGeometry" // text
+#define LQD_CFG_KEY_NAME_WIN_GEOM                "WindowGeometry" // text (used only by the main window)
+#define LQD_CFG_KEY_NAME_WIN_X                   "WindowX" // number
+#define LQD_CFG_KEY_NAME_WIN_Y                   "WindowY" // number
+#define LQD_CFG_KEY_NAME_WIN_WIDTH               "WindowWidth" // number
+#define LQD_CFG_KEY_NAME_WIN_HEIGHT              "WindowHeight" // number
+#define LQD_CFG_KEY_NAME_WIN_MAXIMIZED           "WindowMaximized" // boolean, defaults to FALSE
+#define LQD_CFG_KEY_NAME_WIN_FULLSCREEN          "WindowFullScreen" // boolean, defaults to FALSE
 #define LQD_CFG_KEY_NAME_ZOOM_LVL                "ZoomLevel" // number, defaults to 1
 
 /* Keyboard shortcuts (all windows and dialog boxes) */

liquid.pro

@@ -24,6 +24,7 @@ INCLUDEPATH += $${INC_DIR}
 
 HEADERS     += inc/lqd.h \
                inc/liquid.hpp \
+               inc/liquidappfile.hpp \
                inc/liquidappcookiejar.hpp \
                inc/liquidappconfigwindow.hpp \
                inc/liquidappwebpage.hpp \
@@ -33,6 +34,7 @@ HEADERS     += inc/lqd.h \
                inc/svgsnapshot.hpp \
 
 SOURCES     += src/liquid.cpp \
+               src/liquidappfile.cpp \
                src/liquidappcookiejar.cpp \
                src/liquidappconfigwindow.cpp \
                src/liquidappwebpage.cpp \

sample-apps/README.md

@@ -1,8 +1,13 @@
 # Sample Liquid apps
 
-Copy files from directory `apps` into `~/.config/liquid/apps/`
-and then load them by running `liquid <app-name>`, e.g.:
+Copy `.liquid` files from this directory into Liquid's `apps` directory, and then run them using `liquid <app-name>`:
 
-    mkdir -p ~/.config/liquid/apps/
-    cp -n apps/* ~/.config/liquid/apps/
+    mkdir -p ~/.liquid/apps/
+    cp -n *.liquid ~/.liquid/apps/
     liquid hackernews
+
+Liquid's `apps` directory is located at:
+
+ - GNU/Linux, BSD, and others: `~/.liquid/apps/`
+ - macOS: `~/Library/Application Support/Liquid/apps/`
+ - Windows: `%LOCALAPPDATA%\Liquid\apps\`

sample-apps/fccid.liquid

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<liquid version="1">
+    <url>https://fccid.io/</url>
+    <title>FCCID</title>
+    <javascript enabled="false"/>
+    <cookies enabled="false" third-party="false"/>
+    <window width="1021" height="1645" locked="true"/>
+    <viewport zoom="1"/>
+</liquid>

sample-apps/github.liquid

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<liquid version="1">
+    <url>https://github.com</url>
+    <title>GitHub</title>
+    <javascript enabled="true"/>
+    <cookies enabled="true" third-party="false"/>
+    <window width="1066" height="613"/>
+    <viewport zoom="0.9" custom-background="true" background-color="#24292e"/>
+</liquid>

sample-apps/hackernews.liquid

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<liquid version="1">
+    <url>https://news.ycombinator.com/</url>
+    <domains>
+        <domain>hn.algolia.com</domain>
+        <domain>www.ycombinator.com</domain>
+    </domains>
+    <javascript enabled="true"/>
+    <cookies enabled="true" third-party="false"/>
+    <window width="465" height="944" locked="false"/>
+    <viewport zoom="0.9" hide-scrollbars="true" custom-background="true" background-color="#f6f6ef"/>
+    <icon type="image/png">iVBORw0KGgoAAAANSUhEUgAAAQAAAAEACAYAAABccqhmAAAACXBIWXMAAA7EAAAOxAGVKw4bAAAMkklEQVR4nO3deXCU9R3H8c+GIJcB8eKSailVOVQs4lUKCBEQUqutdXTa2unUek3rwagol6HaKmprPcaOrVTHacdWlHBqAgiKHFU5PBAECwVBDhEhYAghJNs/ntaxo0Cyv+/uPrvf9+tPBz+7Q5L3PmT3eZ5E8jo9pzr9UAWSkgKQ7xKS6iU10aRE8lol+cEHHEpIBdl+DgCyp4BXf8CpJEcAgGsEAHCMAACOEQDAMQIAOEYAAMcIAOAYAQAcIwCAYwQAcIwAAI4RAMAxAgA4RgAAxwgA4BgBABwjAIBjBABwjAAAjhEAwDECADhGAADHCADgGAEAHCMAgGMEAHCMAACOEQDAMQIAOEYAAMcIAOAYAQAcIwCAYwQAcIwAAI4RAMAxAgA4RgAAxwgA4BgBABwjAIBjBABwjAAAjhEAwDECADhGAADHCADgGAEAHCMAgGMEAHCMAACOEQDAMQIAOEYAAMcIAOAYAQAcIwCAYwQAcKww208gpzRrJbVoY7dXUyVVV9rt5aomTaWi42y2qiujv1c0CAFojKO/Jo17VypoYrO3bY1U2l2qr7PZy1VDbpe+d0/4Tn2dNL6HtHV1+JYT/BOgMbaskhY/bbfX7mSpz5V2e7moeZFUPMJma+FEfvgbiQA01vTxUu0+u73hY6SE4y/DoJulVkeH79Tuk2YaHEU44/g7L0U7N0rzHrPba3eK1OcKu71c0rxIKr7FZmveo9HXBo1CAFJRfp/tL++GOT0KKB4htWwbvrNvt1Q+IXzHIYffdQaqdkgV99vtdegmnXW53V4uaNEmOvy3UD4h+pqg0QhAquY+LO3earfn7SigeITU8qjwnd3boq8FUuLoO85YTVX0C0ErHXtIvS+z24uzlm2kQTfZbM0o5X3/AAQgxMKJ0va1dnvDx/o4CrjwVpsPVH2yTlowMXzHMQffbWlUVytNGW2317GndOb37fbiqGVbaeCNNltTxkRfA6SMAIRaOknauNxuL9+PAgbfKjVvHb6z6R1pyT/Cd5zL4++0DEnWS5PvsNs74XSp1yV2e3HSqq10wa9stiaPjP7uEYQAWFg5S1o9z24vX48CBt8effgn1AevSe+Vh++AAJixPAro3Es642K7vThodYx0wS9ttsoM/66dIwBW1r8hLXvBbq9knN1WHAy5TWp2ZPjO21OltYvCdyCJANiaOtru1N7OZ+bPUcCRx0gDDF79k/XRb/5hhgBY2rpaWvSU3d7wPDkKGDIyuphKqMXPSJtXhO/gcwTA2oxSu9OFT+wtnV5is5UtRcdJ/W8I3zmwX5ph+MlLSCIA9nZ+ZPvZ9Fw/CrB69X/1cWnH+vAd/B8CkA4VE+xOFz6pj9RzmM1WprVuJ/W/Pnyn5jPppd+G7+BLCEA6VO2MrhlgJVffERgyUjqiZfjOrAelPdvDd/AlBCBd5j4sVW6x2fr6OVKPoTZbmdK6vdT/uvCdzz6R5vw+fAdfiQCky/5q219a5dpRwNA7pKYtwndm3i3t2xO+g69EANJpwZPSxx/YbHU5T+o+2GYr3dq0l/pdG77z6YfS/CfCd3BQBCCd6uukqYYfXCm5y24rnS4aJTVtHr4zdax0oCZ8BwdFANJt6fPSh8tstr5xvtSt2GYrXY7qKPX9RfjOlpXS638N38EhEYB0S9ZHp65aiftRgNWrf9mdnO6bAQQgE1bNkd6fa7PVta906kCbLWttO0l9rw7fWfdP6e1p4Ts4LAKQKZansMb1KOCi0VJhs/AdTvfNGAKQKevflJY9b7P1zX7SyQNstqy07Sx9++fhOytelNa8Gr6DBiEAmTRljFR/wGbruzE7Chg2Wio8ImwjmZTKDC+yisMiAJm0bbW08C82WycPiI4E4uDoE6Xzfxa+8+az0qa3wnfQYAQg02b8WqqtttmKy+8Cho0Kf/Wvq5Wm5dinHfMAAci0XR9Jcx+x2Tp1YPSuQDYdc5LNq/9rf7K9yQoahABkQ/kEae8um61sHwUMGy01aRq2sX+vNPMem+eDRiEA2bDX8HThbsXRJwSz4dgu0nk/Dd+Z85DtjVbRYAQgW+Y+Iu3abLOVraMAi1f/qk+lWQ/YPB80GgHIllrD04W7D5a6nGOz1VDHdpHOuyp8p/xeu6snodEIQDYtnChtW2OzVVJqs9NQw8dKBYVhG7s+kuY9avN8kBICkE31dXZ3F+4xVDrpbJutwzm+q3Tuj8N3pt0l1XK6bzYRgGxbPlnasMRmK1OfDrR49d+2Wlr8tMnTQeoIQLYl66NTXy30HBbdSyCdju8qnf2j8J0phndRQsoIQBysmiOtmm2zle7fBZTcJRU0CdvYsMT2PopIGQGIi7I7o5NhQp1ekr6jgHanSH2uDN+xOuJBMAIQFxuWSksn2Wyl625CJePCX/1XzY6OeBALBCBOpo21OV34jIujuwtban+K1OeK8B1e/WOFAMTJtjXSgok2WyVjbXY+3yuVEoHfLksnRUc6iA0CEDczjU4XPuMS6YRe4TuS1KG7dNblYRv1ddFlvhErBCBudm2WXja4u3AiYXcUUDIu/NV/4cTovX/ECgGIo4r7ojMGQ/W6VOp0WthGx+5S78BX/9p90YVQEDsEII72Vkov3Ru+k0iE31OwpDTaCTH34ehz/4gdAhBX8x6z+aE58wdSx56p/b+dTpO+dVnY41dXShUTwjaQNgQgrmqrpeml4TuJRHTNvlSUjAt/9a+YIFUZ/HMGaUEA4mzRUza/OOt9efQZ/sbo2DM6egixe6v08h/CNpBWBCDOrE4XLmgiDW3k3XaGjw1/9Z8+XtpvdAVkpAUBiLtlL0R3FQp1zk+kozo17M926Cb1Dvy3//a10Vt/iDUCkAss7pVXeIRUfEvD/uxFo8Lf9586JrrWP2KNAOSC9+dKK2eF73znGqllm0P/meO7hp/xt/EtaclzYRvICAKQKyxOF25eJPW7/tB/Zugd4Wf8ld0ZXegEsUcAcsWHy6SlBq+qA2+UCg9yKe+2naVzA6/0u+ZV6b3ysA1kDAHIJVMN7i7cpoN09kEu6DnktvDr/JeNDPv/kVEEIJd8/C9pwZPhOxeO+PJ/KzpO6nt12O5bZdK618M2kFEEINfMGB/dSy9Ex57RzUS+aNAtUtMWqW8m66UpY8KeFzKOAOSaSqNP133xLcHmRdKAG8L2Fj8jbVkZtoGMIwC5qOL+6J56IboPiS7zJUn9b5BaHObtwUM5UGNz3gIyjgDkourK6J56IRIJaeBNUmEzqfjmsK1XHpc+3RC2gawgALlq3qPSzk1hG+deJQ26SWrdPvWNfXukl34T9jyQNQQgV9UaHHY3ayVdGngkMftB6bMdYRvIGgKQyxY/LW19P2wj5DP/e7ZLs38X9vjIKgKQyyzvLpyKF++Raqqy9/gIRgBy3fLJ0r+z8OGbHeul+X/M/OPCFAHIB5MNThdurGnjpAOc7pvrCEA+WPOK9F5F5h5v8wrp9b9l7vGQNgQgX1jdXbhBjzWK033zBAHIFxuXS0v+nv7HWbtIemd6+h8HGUEA8snUsem/DBd3980rBCCfbF8rvfbn9O2/O1P6YH769pFxBCDfzLw7Pe/NJ+ulKSneYASxRQDyTbpuxvHGs9Kmd+x3kVUEIB/NekCqMvx8fl1t9L4/8g4ByEfVRncX/p/5T0ifrLPbQ2wQgHz1ymPSzo3hOzVV0Wf+kZcIQL6qrZFWzwvfefkhafe28B3EEgHAoa3gGv/5jAAAjhEAwDECADhGAADHCADgGAEAHCMAgGMEAHCMAACOEQDAMQIAOEYAAMcIAOAYAQAcIwCAYwQAcIwAAI4RAMAxAgA4RgAAxwgA4BgBABwjAIBjBABwjAAAjhEAwDECADhGAADHCADgGAEAHCMAgGMEAHCMAACOEQDAMQIAOEYAAMcIAOAYAQAcIwCAYwQAcIwAAI4RAMAxAgA4RgAAxwgA4BgBABwjAIBjBABwjAAAjhEAwDECADhGAADHEslrlMz2kwCQHRwBAI4RAMAxAgA4RgAAxwgA4BgBABwjAIBjBABwjAAAjhEAwDECADhGAADHCADgGAEAHCMAgGMEAHCMAACOEQDAMQIAOEYAAMcIAOAYAQAcIwCAYwQAcIwAAI4RAMAxAgA4RgAAxwgA4BgBABwjAIBjBABwjAAAjhEAwDECADhGAADHCADgGAEAHCMAgGMEAHCMAACOEQDAMQIAOEYAAMcIAOAYAQAcIwCAYwQAcIwAAI4RAMAxAgA4RgAAxwgA4FiBEtl+CgCyIsERAOBagRKapKTEkQDgREL678/8pP8AKm2ChN3yvJcAAAAASUVORK5CYII=</icon>
+</liquid>

sample-apps/http-auth-demo.liquid

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<liquid version="1">
+    <url>https://authenticationtest.com/HTTPAuth/</url>
+    <javascript enabled="false"/>
+    <cookies enabled="false" third-party="false"/>
+</liquid>