add export for pmg 2.1

Author: ciur

CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+## [0.3] - 2025-03-10
+
+### Added
+
+- Export method for Papermerge DMS 2.1 for postgres and sqlite3

README.md

@@ -5,19 +5,19 @@ Tool for migrating Papermerge DMS data between different versions.
 Basically you export data from one (older) version as tar.gz archive and import it
 into the 3.4 (latest).
 
-For PMDump version 0.2 `export` command works for following Papermerge DMS versions/databases
+For PMDump version 0.3 `export` command works for following Papermerge DMS versions/databases
 
 |  db/pmg version  |  2.0 | 2.1   | 3.2         | 3.3 |
 |------------------|------|-------|-------------|-----|
-|       SQLite     |  ✅  | 🚧    | ✅          | ✅  |
-|       PostgreSQL |  ❌  | 🚧    | ✅          | ✅  |
+|       SQLite     |  ✅  | ✅    | ✅          | ✅  |
+|       PostgreSQL |  ❌  | ✅    | ✅          | ✅  |
 
 Currently `import` command works to import only into 3.4 either SQLite or PostgreSQL database.
 
  - ✅ - means: it works
  - ❌ - means: no plans to implement this part yet. If you need this to be implemented, please
      [open a ticket](https://github.com/ciur/papermerge/issues) and provide docker compose with your setup.
- - 🚧 - means: work in progress. Will be available soon.
+
 
 ## Get It
 

commands/exp/app_v2_1/api.go

@@ -0,0 +1,113 @@
+package exporter_app_v2_1
+
+import (
+	"fmt"
+	"os"
+
+	"github.com/google/uuid"
+	"github.com/papermerge/pmdump/config"
+	"github.com/papermerge/pmdump/database"
+	"github.com/papermerge/pmdump/exporter"
+	models "github.com/papermerge/pmdump/models/app_v3_3"
+	"github.com/papermerge/pmdump/types"
+)
+
+func PerformExport(
+	settings config.Config,
+	targetFile,
+	exportYaml string,
+) []types.FilePath {
+	var filePaths []types.FilePath
+
+	db, err := database.Open(settings.DatabaseURL, types.AppVersion(settings.AppVersion))
+	if err != nil {
+		fmt.Fprintf(os.Stderr, "Error: %v\n", err)
+		os.Exit(1)
+	}
+	defer db.DB.Close()
+
+	results, err := database.GetUsers(db)
+	if err != nil {
+		fmt.Fprintf(os.Stderr, "Error: %v\n", err)
+		os.Exit(1)
+	}
+
+	users := results.([]models.User)
+
+	for i := 0; i < len(users); i++ {
+
+		database.GetUserNodes(db, &users[i])
+		models.ForEachDocument(
+			db,
+			users[i].Home,
+			database.InsertDocVersionsAndPages,
+		)
+		models.ForEachDocument(
+			db,
+			users[i].Inbox,
+			database.InsertDocVersionsAndPages,
+		)
+	}
+
+	for i := 0; i < len(users); i++ {
+		var allDocs []models.Node
+
+		inbox := users[i].Inbox.GetUserDocuments()
+		home := users[i].Home.GetUserDocuments()
+		allDocs = append(allDocs, inbox...)
+		allDocs = append(allDocs, home...)
+		userFilePaths, err := GetFilePaths(allDocs, users[i].ID, settings.MediaRoot)
+
+		if err != nil {
+			fmt.Fprintf(os.Stderr, "error getting file paths: %v\n", err)
+		}
+
+		filePaths = append(filePaths, userFilePaths...)
+	}
+
+	payload := models.Data{
+		Users: users,
+	}
+
+	err = exporter.CreateYAML(
+		exportYaml,
+		payload,
+		types.V3_2,
+	)
+	if err != nil {
+		fmt.Fprintf(os.Stderr, "Error writing to file: %v", err)
+		os.Exit(1)
+	}
+
+	return filePaths
+}
+
+func GetFilePaths(docs []models.Node, user_id uuid.UUID, mediaRoot string) ([]types.FilePath, error) {
+	var paths []types.FilePath
+
+	for _, doc := range docs {
+		for _, docVer := range doc.Versions {
+			var source string
+
+			uid := docVer.ID.String()
+
+			source = fmt.Sprintf(
+				"%s/docs/user_%s/document_%s/v%d/%s",
+				mediaRoot,
+				user_id.String(),
+				doc.ID.String(),
+				docVer.Number,
+				docVer.FileName,
+			)
+
+			dest := fmt.Sprintf("docvers/%s/%s/%s/%s", uid[0:2], uid[2:4], uid, docVer.FileName)
+			path := types.FilePath{
+				Source: source,
+				Dest:   dest,
+			}
+			paths = append(paths, path)
+		}
+	}
+
+	return paths, nil
+}

commands/exp/exp.go

@@ -8,6 +8,7 @@ import (
 	"strings"
 
 	exporter_app_v2_0 "github.com/papermerge/pmdump/commands/exp/app_v2_0"
+	exporter_app_v2_1 "github.com/papermerge/pmdump/commands/exp/app_v2_1"
 	exporter_app_v3_2 "github.com/papermerge/pmdump/commands/exp/app_v3_2"
 	exporter_app_v3_3 "github.com/papermerge/pmdump/commands/exp/app_v3_3"
 	"github.com/papermerge/pmdump/config"
@@ -28,6 +29,8 @@ func PerformExport(settings config.Config, targetFile, exportYaml string) {
 		filePaths = exporter_app_v2_0.PerformExport(settings, targetFile, exportYaml)
 	case string(types.V3_3):
 		filePaths = exporter_app_v3_3.PerformExport(settings, targetFile, exportYaml)
+	case string(types.V2_1):
+		filePaths = exporter_app_v2_1.PerformExport(settings, targetFile, exportYaml)
 	case string(types.V3_2):
 		filePaths = exporter_app_v3_2.PerformExport(settings, targetFile, exportYaml)
 	default:

database/api.go

@@ -4,6 +4,7 @@ import (
 	"fmt"
 
 	database_app_v2_0 "github.com/papermerge/pmdump/database/app_v2_0"
+	database_app_v2_1 "github.com/papermerge/pmdump/database/app_v2_1"
 	database_app_v3_2 "github.com/papermerge/pmdump/database/app_v3_2"
 	database_app_v3_3 "github.com/papermerge/pmdump/database/app_v3_3"
 	database_app_v3_4 "github.com/papermerge/pmdump/database/app_v3_4"
@@ -15,6 +16,8 @@ func Open(dburl string, appVer types.AppVersion) (*types.DBConn, error) {
 	switch appVer {
 	case types.V2_0:
 		return database_app_v2_0.Open(dburl, appVer)
+	case types.V2_1:
+		return database_app_v2_1.Open(dburl, appVer)
 	case types.V3_3, types.V3_4:
 		return database_app_v3_3.Open(dburl, appVer)
 	case types.V3_2:
@@ -32,6 +35,8 @@ func GetUsers(db *types.DBConn) (any, error) {
 		return database_app_v3_3.GetUsers(db.DB)
 	case types.V3_2:
 		return database_app_v3_2.GetUsers(db.DB)
+	case types.V2_1:
+		return database_app_v2_1.GetUsers(db.DB)
 	}
 
 	return nil, fmt.Errorf("database GetUsers: app version %q not supported", db.AppVersion)
@@ -144,6 +149,8 @@ func GetHomeFlatNodes(db *types.DBConn, user_id interface{}) (interface{}, error
 		return database_app_v3_3.GetHomeFlatNodes(db, user_id)
 	case types.V3_2:
 		return database_app_v3_2.GetHomeFlatNodes(db, user_id)
+	case types.V2_1:
+		return database_app_v2_1.GetHomeFlatNodes(db, user_id)
 	}
 
 	return nil, fmt.Errorf("database GetHomeFlatNodes: app version %q not supported", db.AppVersion)
@@ -157,6 +164,8 @@ func GetInboxFlatNodes(db *types.DBConn, user_id interface{}) (interface{}, erro
 		return database_app_v3_3.GetInboxFlatNodes(db, user_id)
 	case types.V3_2:
 		return database_app_v3_2.GetInboxFlatNodes(db, user_id)
+	case types.V2_1:
+		return database_app_v2_1.GetInboxFlatNodes(db, user_id)
 	}
 
 	return nil, fmt.Errorf("database GetInboxFlatNodes: app version %q not supported", db.AppVersion)
@@ -170,6 +179,8 @@ func GetUserNodes(db *types.DBConn, user interface{}) error {
 		return database_app_v3_3.GetUserNodes(db, &user)
 	case types.V3_2:
 		return database_app_v3_2.GetUserNodes(db, &user)
+	case types.V2_1:
+		return database_app_v2_1.GetUserNodes(db, &user)
 	}
 
 	return fmt.Errorf("database GetUserNodes: app version %q not supported", db.AppVersion)
@@ -197,6 +208,8 @@ func InsertDocVersionsAndPages(db *types.DBConn, node any) error {
 		database_app_v3_3.InsertDocVersionsAndPages(db, node)
 	case types.V3_2:
 		database_app_v3_2.InsertDocVersionsAndPages(db, node)
+	case types.V2_1:
+		database_app_v2_1.InsertDocVersionsAndPages(db, node)
 	}
 
 	return fmt.Errorf("database InsertDocVersionsAndPages: app version %q not supported", db.AppVersion)

database/app_v2_1/api.go

@@ -0,0 +1,106 @@
+package database_app_v2_1
+
+import (
+	"fmt"
+	"net/url"
+	"strings"
+
+	postgres_db "github.com/papermerge/pmdump/database/app_v3_2/postgres"
+	sqlite_db "github.com/papermerge/pmdump/database/app_v3_2/sqlite"
+
+	"github.com/papermerge/pmdump/types"
+)
+
+func Open(dburl string, appVer types.AppVersion) (*types.DBConn, error) {
+	parsedDBURL, err := url.Parse(dburl)
+
+	if err != nil {
+		return nil, fmt.Errorf("Error parsing dburl %s: %v", dburl, err)
+	}
+
+	if strings.HasPrefix(parsedDBURL.Scheme, "sqlite") {
+		db, err := sqlite_db.Open(parsedDBURL.Path)
+		if err != nil {
+			return nil, err
+		}
+		dbconn := types.DBConn{
+			AppVersion: appVer,
+			DBType:     types.SQLite,
+			DB:         db,
+		}
+
+		return &dbconn, nil
+	}
+
+	if strings.HasPrefix(parsedDBURL.Scheme, "postgres") {
+		db, err := postgres_db.Open(dburl)
+		if err != nil {
+			return nil, err
+		}
+		dbconn := types.DBConn{
+			AppVersion: appVer,
+			DBType:     types.Postgres,
+			DB:         db,
+		}
+
+		return &dbconn, nil
+	}
+
+	return nil, fmt.Errorf("database open: app version %q not supported", appVer)
+}
+
+func GetHomeFlatNodes(db *types.DBConn, user_id interface{}) (interface{}, error) {
+	switch db.DBType {
+	case types.SQLite:
+		return sqlite_db.GetHomeFlatNodes(db.DB, user_id)
+	case types.Postgres:
+		return postgres_db.GetHomeFlatNodes(db.DB, user_id)
+	}
+
+	return nil, fmt.Errorf("database GetHomeFlatNodes: db type %q not supported", db.DBType)
+}
+
+func GetInboxFlatNodes(db *types.DBConn, user_id interface{}) (interface{}, error) {
+	switch db.DBType {
+	case types.SQLite:
+		return sqlite_db.GetInboxFlatNodes(db.DB, user_id)
+	case types.Postgres:
+		return postgres_db.GetInboxFlatNodes(db.DB, user_id)
+	}
+
+	err := fmt.Errorf(
+		"database GetInboxFlatNodes: db type %q not supported",
+		db.DBType,
+	)
+
+	return nil, err
+}
+
+func GetUserNodes(db *types.DBConn, user *interface{}) error {
+	switch db.DBType {
+	case types.SQLite:
+		return sqlite_db.GetUserNodes(db.DB, user)
+	case types.Postgres:
+		return postgres_db.GetUserNodes(db.DB, user)
+	}
+
+	return fmt.Errorf(
+		"database GetUserNodes: db type %q not supported",
+		db.DBType,
+	)
+}
+
+func InsertDocVersionsAndPages(db *types.DBConn, node any) error {
+	switch db.DBType {
+	case types.SQLite:
+		sqlite_db.InsertDocVersionsAndPages(db.DB, node)
+	case types.Postgres:
+		postgres_db.InsertDocVersionsAndPages(db.DB, node)
+	}
+
+	return fmt.Errorf(
+		"database GetDocumentPageRows: db type %q not supported",
+		db.DBType,
+	)
+
+}