Project history : Add a version viewer windows in the plugin

Mergin/diff.py

@@ -3,12 +3,14 @@
 import base64
 import sqlite3
 import tempfile
+import glob
 
 from qgis.PyQt.QtCore import QVariant
 
 from qgis.PyQt.QtGui import QColor
 
 from qgis.core import (
+    QgsApplication,
     QgsVectorLayer,
     QgsFeature,
     QgsGeometry,
@@ -107,6 +109,18 @@ def parse_db_schema(db_file):
     return tables
 
 
+def db_schema_from_json(schema_json):
+    """Create map of tables from the schema JSON file"""
+    tables = {}  # key: name, value: TableSchema
+    for tbl in schema_json:
+        columns = []
+        for col in tbl["columns"]:
+            columns.append(ColumnSchema(col["name"], col["type"], "primary_key" in col and col["primary_key"]))
+
+        tables[tbl["table"]] = TableSchema(tbl["table"], columns)
+    return tables
+
+
 def parse_diff(geodiff, diff_file):
     """
     Parse binary GeoDiff changeset and return map of changes per table
@@ -311,6 +325,80 @@ def make_local_changes_layer(mp, layer):
     return vl, ""
 
 
+def make_version_changes_layers(project_path, version):
+    geodiff = pygeodiff.GeoDiff()
+
+    layers = []
+    version_dir = os.path.join(project_path, ".mergin", ".cache", f"v{version}")
+    for f in glob.iglob(f"{version_dir}/*.gpkg"):
+        gpkg_file = os.path.join(version_dir, f)
+        schema_file = gpkg_file + "-schema.json"
+        if not os.path.exists(schema_file):
+            geodiff.schema("sqlite", "", gpkg_file, schema_file)
+
+        changeset_file = find_changeset_file(f, version_dir)
+        if changeset_file is None:
+            continue
+
+        with open(schema_file, encoding="utf-8") as fl:
+            data = fl.read()
+            schema_json = json.loads(data.replace("\n", "")).get("geodiff_schema")
+
+        db_schema = db_schema_from_json(schema_json)
+        diff = parse_diff(geodiff, changeset_file)
+
+        for table_name in diff.keys():
+            if table_name.startswith("gpkg_"):
+                # db schema reported by geodiff exclude layer named "gpkg_*"
+                # We skip it in the layer displayed to the user
+                continue
+            fields, cols_to_fields = create_field_list(db_schema[table_name])
+            geom_type, geom_crs = get_layer_geometry_info(schema_json, table_name)
+
+            db_conn = None  # no ref. db
+            db_conn = sqlite3.connect(gpkg_file)
+
+            features = diff_table_to_features(diff[table_name], db_schema[table_name], fields, cols_to_fields, db_conn)
+
+            # create diff layer
+            if geom_type is None:
+                continue
+
+            uri = f"{geom_type}?crs=epsg:{geom_crs}" if geom_crs else geom_type
+            vl = QgsVectorLayer(uri, table_name, "memory")
+            if not vl.isValid():
+                continue
+
+            vl.dataProvider().addAttributes(fields)
+            vl.updateFields()
+            vl.dataProvider().addFeatures(features)
+
+            style_diff_layer(vl, db_schema[table_name])
+            layers.append(vl)
+
+    return layers
+
+
+def find_changeset_file(file_name, version_dir):
+    """Returns path to the diff file for the given version file"""
+    for f in glob.iglob(f"{version_dir}/*.gpkg-diff*"):
+        if f.startswith(file_name):
+            return os.path.join(version_dir, f)
+    return None
+
+
+def get_layer_geometry_info(schema_json, table_name):
+    """Returns geometry type and CRS for a given table"""
+    for tbl in schema_json:
+        if tbl["table"] == table_name:
+            for col in tbl["columns"]:
+                if col["type"] == "geometry":
+                    return col["geometry"]["type"], col["geometry"]["srs_id"]
+            return "NoGeometry", ""
+
+    return None, None
+
+
 def style_diff_layer(layer, schema_table):
     """Apply conditional styling and symbology to diff layer"""
     ### setup conditional styles!

Mergin/diff_dialog.py

@@ -18,14 +18,14 @@
 from qgis.utils import iface, OverrideCursor
 
 from .mergin.merginproject import MerginProject
-from .diff import make_local_changes_layer
-from .utils import icon_path
+from .diff import make_local_changes_layer, make_version_changes_layers
+from .utils import icon_path, icon_for_layer
 
 ui_file = os.path.join(os.path.dirname(os.path.realpath(__file__)), "ui", "ui_diff_viewer_dialog.ui")
 
 
 class DiffViewerDialog(QDialog):
-    def __init__(self, parent=None):
+    def __init__(self, version=None, parent=None):
         QDialog.__init__(self, parent)
         self.ui = uic.loadUi(ui_file, self)
 
@@ -91,6 +91,8 @@ def __init__(self, parent=None):
             self.diff_layers = []
             self.filter_model = None
 
+            self.version = version
+
             self.create_tabs()
 
     def reject(self):
@@ -106,6 +108,12 @@ def save_splitter_state(self):
         settings.setValue("Mergin/changesViewerSplitterSize", self.splitter.saveState())
 
     def create_tabs(self):
+        if self.version is None:
+            self.show_local_changes()
+        else:
+            self.show_version_changes()
+
+    def show_local_changes(self):
         mp = MerginProject(QgsProject.instance().homePath())
         project_layers = QgsProject.instance().mapLayers()
         for layer in project_layers.values():
@@ -122,7 +130,14 @@ def create_tabs(self):
                 continue
 
             self.diff_layers.append(vl)
-            self.tab_bar.addTab(self.icon_for_layer(vl), f"{layer.name()} ({vl.featureCount()})")
+            self.tab_bar.addTab(icon_for_layer(vl), f"{layer.name()} ({vl.featureCount()})")
+        self.tab_bar.setCurrentIndex(0)
+
+    def show_version_changes(self):
+        layers = make_version_changes_layers(QgsProject.instance().homePath(), self.version)
+        for vl in layers:
+            self.diff_layers.append(vl)
+            self.tab_bar.addTab(icon_for_layer(vl), f"{vl.name()} ({vl.featureCount()})")
         self.tab_bar.setCurrentIndex(0)
 
     def toggle_project_layers(self, checked):
@@ -199,19 +214,6 @@ def zoom_selected(self):
             self.map_canvas.zoomToSelected([self.current_diff])
             self.map_canvas.refresh()
 
-    def icon_for_layer(self, layer):
-        geom_type = layer.geometryType()
-        if geom_type == QgsWkbTypes.PointGeometry:
-            return QgsApplication.getThemeIcon("/mIconPointLayer.svg")
-        elif geom_type == QgsWkbTypes.LineGeometry:
-            return QgsApplication.getThemeIcon("/mIconLineLayer.svg")
-        elif geom_type == QgsWkbTypes.PolygonGeometry:
-            return QgsApplication.getThemeIcon("/mIconPolygonLayer.svg")
-        elif geom_type == QgsWkbTypes.UnknownGeometry:
-            return QgsApplication.getThemeIcon("/mIconGeometryCollectionLayer.svg")
-        else:
-            return QgsApplication.getThemeIcon("/mIconTableLayer.svg")
-
     def show_unsaved_changes_warning(self):
         self.ui.messageBar.pushMessage(
             "Mergin",

Mergin/plugin.py

@@ -42,10 +42,12 @@
 from .sync_dialog import SyncDialog
 from .configure_sync_wizard import DbSyncConfigWizard
 from .remove_project_dialog import RemoveProjectDialog
+from .version_viewer_dialog import VersionViewerDialog
 from .utils import (
     ServerType,
     ClientError,
     LoginError,
+    InvalidProject,
     check_mergin_subdirs,
     create_mergin_client,
     find_qgis_files,
@@ -62,7 +64,7 @@
     unsaved_project_check,
     UnsavedChangesStrategy,
 )
-
+from .mergin.utils import int_version, is_versioned_file
 from .mergin.merginproject import MerginProject
 from .processing.provider import MerginProvider
 import processing
@@ -92,6 +94,7 @@ def __init__(self, iface):
             self.toolbar.setObjectName("MerginMapsToolbar")
 
             self.iface.projectRead.connect(self.on_qgis_project_changed)
+            self.on_qgis_project_changed()
             self.iface.newProjectCreated.connect(self.on_qgis_project_changed)
 
         settings = QSettings()
@@ -155,6 +158,15 @@ def initGui(self):
                 add_to_menu=True,
                 add_to_toolbar=None,
             )
+            self.history_dock_action = self.add_action(
+                "history.svg",
+                text="Project History",
+                callback=self.open_project_history_window,
+                add_to_menu=False,
+                add_to_toolbar=self.toolbar,
+                enabled=False,
+                always_on=False,
+            )
 
             self.enable_toolbar_actions()
 
@@ -324,6 +336,10 @@ def configure_db_sync(self):
         if not wizard.exec():
             return
 
+    def open_project_history_window(self):
+        dlg = VersionViewerDialog(self.mc)
+        dlg.exec()
+
     def show_no_workspaces_dialog(self):
         msg = (
             "Workspace is a place to store your projects and share them with your colleagues. "

Mergin/ui/ui_project_history_dock.ui

@@ -0,0 +1,83 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<ui version="4.0">
+ <class>ProjectHistoryDockWidget</class>
+ <widget class="QDockWidget" name="ProjectHistoryDockWidget">
+  <property name="geometry">
+   <rect>
+    <x>0</x>
+    <y>0</y>
+    <width>370</width>
+    <height>450</height>
+   </rect>
+  </property>
+  <property name="allowedAreas">
+   <set>Qt::LeftDockWidgetArea|Qt::RightDockWidgetArea</set>
+  </property>
+  <property name="windowTitle">
+   <string>Mergin Maps history</string>
+  </property>
+  <widget class="QWidget" name="dockWidgetContents">
+   <layout class="QVBoxLayout" name="verticalLayout_2">
+    <property name="spacing">
+     <number>0</number>
+    </property>
+    <property name="leftMargin">
+     <number>0</number>
+    </property>
+    <property name="topMargin">
+     <number>0</number>
+    </property>
+    <property name="rightMargin">
+     <number>0</number>
+    </property>
+    <property name="bottomMargin">
+     <number>0</number>
+    </property>
+    <item>
+     <widget class="QStackedWidget" name="stackedWidget">
+      <property name="currentIndex">
+       <number>1</number>
+      </property>
+      <widget class="QWidget" name="page">
+       <layout class="QVBoxLayout" name="verticalLayout">
+        <item>
+         <widget class="QLabel" name="info_label">
+          <property name="text">
+           <string>Current project is not a Mergin project. Project history is not available.</string>
+          </property>
+          <property name="wordWrap">
+           <bool>true</bool>
+          </property>
+         </widget>
+        </item>
+       </layout>
+      </widget>
+      <widget class="QWidget" name="page_2">
+       <layout class="QGridLayout" name="gridLayout">
+        <item row="1" column="0" colspan="2">
+         <widget class="QTreeView" name="versions_tree">
+          <property name="contextMenuPolicy">
+           <enum>Qt::CustomContextMenu</enum>
+          </property>
+          <property name="rootIsDecorated">
+           <bool>false</bool>
+          </property>
+         </widget>
+        </item>
+        <item row="0" column="0" colspan="2">
+         <widget class="QPushButton" name="view_changes_btn">
+          <property name="text">
+           <string>View changes</string>
+          </property>
+         </widget>
+        </item>
+       </layout>
+      </widget>
+     </widget>
+    </item>
+   </layout>
+  </widget>
+ </widget>
+ <resources/>
+ <connections/>
+</ui>