mgmt/lang/core/datetime/str_now.go

// Mgmt
// Copyright (C) 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 coredatetime

import (
	"context"
	"strconv"
	"time"

	"github.com/purpleidea/mgmt/lang/funcs"
	"github.com/purpleidea/mgmt/lang/interfaces"
	"github.com/purpleidea/mgmt/lang/types"
)

const (
	// StrNowFuncName is the name this fact is registered as. It's still a
	// Func Name because this is the name space the fact is actually using.
	StrNowFuncName = "str_now"
)

func init() {
	funcs.ModuleRegister(ModuleName, StrNowFuncName, func() interfaces.Func { return &StrNow{} }) // must register the fact and name
}

// StrNow is a fact which returns the current date and time.
type StrNow struct {
	init *interfaces.Init
}

// String returns a simple name for this fact. This is needed so this struct can
// satisfy the pgraph.Vertex interface.
func (obj *StrNow) String() string {
	return NowFuncName
}

// Validate makes sure we've built our struct properly.
func (obj *StrNow) Validate() error {
	return nil
}

// Info returns some static info about itself.
func (obj *StrNow) Info() *interfaces.Info {
	return &interfaces.Info{
		Pure: false, // non-constant facts can't be pure!
		Memo: false,
		Fast: false,
		Spec: false,
		Sig:  types.NewType("func() str"),
	}
}

// Init runs some startup code for this fact.
func (obj *StrNow) Init(init *interfaces.Init) error {
	obj.init = init
	return nil
}

// Stream returns the changing values that this fact has over time.
func (obj *StrNow) Stream(ctx context.Context) error {
	// XXX: this might be an interesting fact to write because:
	// 1) will the sleeps from the ticker be in sync with the second ticker?
	// 2) if we care about a less precise interval (eg: minute changes) can
	// we set this up so it doesn't tick as often? -- Yes (make this a function or create a limit function to wrap this)
	// 3) is it best to have a delta timer that wakes up before it's needed
	// and calculates how much longer to sleep for?
	ticker := time.NewTicker(time.Duration(1) * time.Second)
	//ticker := time.NewTicker(time.Duration(1) * time.Millisecond)
	//ticker := time.NewTicker(time.Duration(1) * time.Microsecond)
	//ticker := time.NewTicker(time.Duration(1) * time.Nanosecond)
	defer ticker.Stop()

	// streams must generate an initial event on startup
	// even though ticker will send one, we want to be faster to first event
	startChan := make(chan struct{}) // start signal
	close(startChan)                 // kick it off!

	for {
		select {
		case <-startChan:
			startChan = nil // disable

		case <-ticker.C: // received the timer event
			// pass

		case <-ctx.Done():
			return nil
		}

		if err := obj.init.Event(ctx); err != nil {
			return err
		}
	}
}

// Call this fact and return the value if it is possible to do so at this time.
func (obj *StrNow) Call(ctx context.Context, args []types.Value) (types.Value, error) {
	return &types.StrValue{ // seconds since 1970 as a string...
		V: strconv.FormatInt(time.Now().Unix(), 10), // .UTC() not necessary
		//V: strconv.FormatInt(time.Now().UnixMilli(), 10), // .UTC() not necessary
		//V: strconv.FormatInt(time.Now().UnixMicro(), 10), // .UTC() not necessary
		//V: strconv.FormatInt(time.Now().UnixNano(), 10), // .UTC() not necessary
	}, nil
}