Files
mgmt/lang/core/net/macfmt.go
James Shubin 7b45f94bb0 lang: core: Remove the unnecessary func suffix
We don't really need these, it's clear what things are.
2024-11-22 01:18:19 -05:00

112 lines
3.5 KiB
Go

// 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 corenet
import (
"context"
"fmt"
"net"
"strings"
"github.com/purpleidea/mgmt/lang/funcs/simple"
"github.com/purpleidea/mgmt/lang/types"
)
func init() {
simple.ModuleRegister(ModuleName, "is_mac", &simple.Scaffold{
T: types.NewType("func(a str) bool"),
F: IsMac,
})
simple.ModuleRegister(ModuleName, "macfmt", &simple.Scaffold{
T: types.NewType("func(a str) str"),
F: MacFmt,
})
simple.ModuleRegister(ModuleName, "oldmacfmt", &simple.Scaffold{
T: types.NewType("func(a str) str"),
F: OldMacFmt,
})
}
// IsMac takes a string and returns true if it's a mac in the standard format.
func IsMac(ctx context.Context, input []types.Value) (types.Value, error) {
mac := input[0].Str()
// Check if the MAC address is valid.
if len(mac) != len("00:00:00:00:00:00") {
return nil, fmt.Errorf("invalid MAC address length: %s", mac)
}
hw, err := net.ParseMAC(mac)
if err != nil {
return nil, err
}
return &types.BoolValue{
V: hw.String() == mac,
}, nil
}
// MacFmt takes a MAC address with hyphens and converts it to a format with
// colons.
func MacFmt(ctx context.Context, input []types.Value) (types.Value, error) {
mac := input[0].Str()
// Check if the MAC address is valid.
if len(mac) != len("00:00:00:00:00:00") {
return nil, fmt.Errorf("invalid MAC address length: %s", mac)
}
hw, err := net.ParseMAC(mac)
if err != nil {
return nil, err
}
return &types.StrValue{
V: hw.String(), // makes it lowercase and everything
}, nil
}
// OldMacFmt takes a MAC address with colons and converts it to a format with
// hyphens. This is the old deprecated style that nobody likes.
func OldMacFmt(ctx context.Context, input []types.Value) (types.Value, error) {
mac := input[0].Str()
// Check if the MAC address is valid.
if len(mac) != len("00:00:00:00:00:00") {
return nil, fmt.Errorf("invalid MAC address length: %s", mac)
}
hw, err := net.ParseMAC(mac)
if err != nil {
return nil, err
}
return &types.StrValue{
V: strings.Replace(hw.String(), ":", "-", -1),
}, nil
}