From 562138cb744cd8f064a29786d4078d50b0994c43 Mon Sep 17 00:00:00 2001
From: James Shubin <james@shubin.ca>
Date: Wed, 25 Sep 2024 20:31:18 -0400
Subject: [PATCH] lang: core: os: Add expand_home function

Simple helper that works with ~/foo/ or ~james/foo/ type patterns.
---
 lang/core/os/expand_home_func.go | 59 ++++++++++++++++++++++++++++++++
 1 file changed, 59 insertions(+)
 create mode 100644 lang/core/os/expand_home_func.go

diff --git a/lang/core/os/expand_home_func.go b/lang/core/os/expand_home_func.go
new file mode 100644
index 000000000..fdd07ba19
--- /dev/null
+++ b/lang/core/os/expand_home_func.go
@@ -0,0 +1,59 @@
+// Mgmt
+// Copyright (C) 2013-2024+ James Shubin and the project contributors
+// Written by James Shubin <james@shubin.ca> and the project contributors
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program.  If not, see <https://www.gnu.org/licenses/>.
+//
+// Additional permission under GNU GPL version 3 section 7
+//
+// If you modify this program, or any covered work, by linking or combining it
+// with embedded mcl code and modules (and that the embedded mcl code and
+// modules which link with this program, contain a copy of their source code in
+// the authoritative form) containing parts covered by the terms of any other
+// license, the licensors of this program grant you additional permission to
+// convey the resulting work. Furthermore, the licensors of this program grant
+// the original author, James Shubin, additional permission to update this
+// additional permission if he deems it necessary to achieve the goals of this
+// additional permission.
+
+package coreos
+
+import (
+	"context"
+
+	"github.com/purpleidea/mgmt/lang/funcs/simple"
+	"github.com/purpleidea/mgmt/lang/types"
+	"github.com/purpleidea/mgmt/util"
+)
+
+func init() {
+	simple.ModuleRegister(ModuleName, "expand_home", &simple.Scaffold{
+		T: types.NewType("func(str) str"),
+		F: ExpandHome,
+	})
+}
+
+// ExpandHome expands any tilde patterns in the input path according to the
+// currently running user. While most of the time its likely this is `root`,
+// there is no reason the program is necessarily running as root!
+func ExpandHome(ctx context.Context, input []types.Value) (types.Value, error) {
+	expanded, err := util.ExpandHome(input[0].Str())
+	if err != nil {
+		return nil, err
+	}
+
+	return &types.StrValue{
+		V: expanded,
+	}, nil
+}