Move WAL path prefix logic into walPath().

This logic is used by both archive-push and archive-get.
2025-07-13 01:00:23 +02:00 · 2019-03-16 16:14:10 +04:00
parent 12273a1034
commit 2d386cd266
7 changed files with 62 additions and 8 deletions
--- a/doc/xml/release.xml
+++ b/doc/xml/release.xml
@ -45,6 +45,10 @@
                        <p>Add <id>storageRepoWrite()</id> to storage helper.</p>
                    </release-item>

+                    <release-item>
+                        <p>Move WAL path prefix logic into <code>walPath()</code>.</p>
+                    </release-item>
+
                    <release-item>
                        <p>Make notion of current <postgres/> info ID in C align with Perl.</p>
                    </release-item>
--- a/src/Makefile
+++ b/src/Makefile
@ -199,7 +199,7 @@ clean:
 ####################################################################################################################################
 # Compile rules
 ####################################################################################################################################
-command/archive/common.o: command/archive/common.c command/archive/common.h common/assert.h common/debug.h common/error.auto.h common/error.h common/io/filter/filter.h common/io/filter/group.h common/io/read.h common/io/write.h common/log.h common/logLevel.h common/memContext.h common/regExp.h common/stackTrace.h common/time.h common/type/buffer.h common/type/convert.h common/type/keyValue.h common/type/string.h common/type/stringList.h common/type/variant.h common/type/variantList.h common/wait.h postgres/version.h storage/fileRead.h storage/fileWrite.h storage/helper.h storage/info.h storage/storage.h
+command/archive/common.o: command/archive/common.c command/archive/common.h common/assert.h common/debug.h common/error.auto.h common/error.h common/io/filter/filter.h common/io/filter/group.h common/io/read.h common/io/write.h common/lock.h common/log.h common/logLevel.h common/memContext.h common/regExp.h common/stackTrace.h common/time.h common/type/buffer.h common/type/convert.h common/type/keyValue.h common/type/string.h common/type/stringList.h common/type/variant.h common/type/variantList.h common/wait.h config/config.auto.h config/config.h config/define.auto.h config/define.h postgres/version.h storage/fileRead.h storage/fileWrite.h storage/helper.h storage/info.h storage/storage.h
 	$(CC) $(CFLAGS) -c command/archive/common.c -o command/archive/common.o

 command/archive/get/file.o: command/archive/get/file.c command/archive/common.h command/archive/get/file.h command/control/control.h common/assert.h common/compress/gzip/common.h common/compress/gzip/decompress.h common/crypto/cipherBlock.h common/crypto/common.h common/debug.h common/error.auto.h common/error.h common/ini.h common/io/filter/filter.h common/io/filter/group.h common/io/read.h common/io/write.h common/lock.h common/log.h common/logLevel.h common/memContext.h common/stackTrace.h common/time.h common/type/buffer.h common/type/convert.h common/type/keyValue.h common/type/string.h common/type/stringList.h common/type/variant.h common/type/variantList.h config/config.auto.h config/config.h config/define.auto.h config/define.h info/infoArchive.h info/infoPg.h postgres/interface.h storage/fileRead.h storage/fileWrite.h storage/helper.h storage/info.h storage/storage.h
--- a/src/command/archive/common.c
+++ b/src/command/archive/common.c
@ -11,6 +11,7 @@ Archive Common
 #include "common/memContext.h"
 #include "common/regExp.h"
 #include "common/wait.h"
+#include "config/config.h"
 #include "postgres/version.h"
 #include "storage/helper.h"
 #include "storage/helper.h"
@ -221,6 +222,43 @@ walIsPartial(const String *walSegment)
    FUNCTION_LOG_RETURN(BOOL, strEndsWithZ(walSegment, WAL_SEGMENT_PARTIAL_EXT));
 }

+/***********************************************************************************************************************************
+Generates the location of the wal directory using a relative wal path and the supplied pg path
+***********************************************************************************************************************************/
+String *
+walPath(const String *walFile, const String *pgPath, const String *command)
+{
+    FUNCTION_LOG_BEGIN(logLevelDebug);
+        FUNCTION_LOG_PARAM(STRING, walFile);
+        FUNCTION_LOG_PARAM(STRING, pgPath);
+        FUNCTION_LOG_PARAM(STRING, command);
+    FUNCTION_LOG_END();
+
+    ASSERT(walFile != NULL);
+    ASSERT(command != NULL);
+
+    String *result = NULL;
+
+    if (!strBeginsWithZ(walFile, "/"))
+    {
+        if (pgPath == NULL)
+        {
+            THROW_FMT(
+                OptionRequiredError,
+                "option '%s' must be specified when relative wal paths are used\n"
+                    "HINT: Is %%f passed to %s instead of %%p?\n"
+                    "HINT: PostgreSQL may pass relative paths even with %%p depending on the environment.",
+                cfgOptionName(cfgOptPgPath), strPtr(command));
+        }
+
+        result = strNewFmt("%s/%s", strPtr(pgPath), strPtr(walFile));
+    }
+    else
+        result = strDup(walFile);
+
+    FUNCTION_LOG_RETURN(STRING, result);
+}
+
 /***********************************************************************************************************************************
 Is the file a segment or some other file (e.g. .history, .backup, etc)
 ***********************************************************************************************************************************/
--- a/src/command/archive/common.h
+++ b/src/command/archive/common.h
@ -56,6 +56,7 @@ void archiveAsyncStatusErrorWrite(

 bool walIsPartial(const String *walSegment);
 bool walIsSegment(const String *walSegment);
+String *walPath(const String *walFile, const String *pgPath, const String *command);
 String *walSegmentFind(const Storage *storage, const String *archiveId, const String *walSegment);
 String *walSegmentNext(const String *walSegment, size_t walSegmentSize, unsigned int pgVersion);
 StringList *walSegmentRange(const String *walSegmentBegin, size_t walSegmentSize, unsigned int pgVersion, unsigned int range);
--- a/src/command/archive/get/get.c
+++ b/src/command/archive/get/get.c
@ -127,12 +127,9 @@ cmdArchiveGet(void)
        // Get the segment name
        String *walSegment = strBase(strLstGet(commandParam, 0));

-        // Destination is wherever we were told to move the WAL segment.  In some cases the path that PostgreSQL passes will not be
-        // absolute so prefix pg-path.
-        const String *walDestination = strLstGet(commandParam, 1);
-
-        if (!strBeginsWithZ(walDestination, "/"))
-            walDestination = strNewFmt("%s/%s", strPtr(cfgOptionStr(cfgOptPgPath)), strPtr(walDestination));
+        // Destination is wherever we were told to move the WAL segment
+        const String *walDestination =
+            walPath(strLstGet(commandParam, 1), cfgOptionStr(cfgOptPgPath), strNew(cfgCommandName(cfgCommand())));

        // Async get can only be performed on WAL segments, history or other files must use synchronous mode
        if (cfgOptionBool(cfgOptArchiveAsync) && walIsSegment(walSegment))
--- a/test/define.yaml
+++ b/test/define.yaml
@ -620,7 +620,7 @@ unit:
    test:
      # ----------------------------------------------------------------------------------------------------------------------------
      - name: archive-common
-        total: 7
+        total: 8

        coverage:
          command/archive/common: full
--- a/test/src/module/command/archiveCommonTest.c
+++ b/test/src/module/command/archiveCommonTest.c
@ -168,6 +168,20 @@ testRun(void)
        TEST_RESULT_BOOL(walIsSegment(strNew("0000001A.history")), false, "history file");
    }

+    // *****************************************************************************************************************************
+    if (testBegin("walPath()"))
+    {
+        TEST_RESULT_STR(
+            strPtr(walPath(strNew("/absolute/path"), strNew("/pg"), strNew("test"))), "/absolute/path", "absolute path");
+        TEST_RESULT_STR(
+            strPtr(walPath(strNew("relative/path"), strNew("/pg"), strNew("test"))), "/pg/relative/path", "relative path");
+        TEST_ERROR(
+            walPath(strNew("relative/path"), NULL, strNew("test")), OptionRequiredError,
+            "option 'pg1-path' must be specified when relative wal paths are used\n"
+                "HINT: Is %f passed to test instead of %p?\n"
+                "HINT: PostgreSQL may pass relative paths even with %p depending on the environment.");
+    }
+
    // *****************************************************************************************************************************
    if (testBegin("walSegmentFind()"))
    {