// 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 autogroup

import (
	"github.com/purpleidea/mgmt/pgraph"
	"github.com/purpleidea/mgmt/util/errwrap"
)

// NonReachabilityGrouper is the most straight-forward algorithm for grouping.
// TODO: this algorithm may not be correct in all cases. replace if needed!
type NonReachabilityGrouper struct {
	baseGrouper // "inherit" what we want, and reimplement the rest
}

// Name returns the name for the grouper algorithm.
func (obj *NonReachabilityGrouper) Name() string {
	return "NonReachabilityGrouper"
}

// VertexNext iteratively finds vertex pairs with simple graph reachability...
// This algorithm relies on the observation that if there's a path from a to b,
// then they *can't* be merged (b/c of the existing dependency) so therefore we
// merge anything that *doesn't* satisfy this condition or that of the reverse!
func (obj *NonReachabilityGrouper) VertexNext() (v1, v2 pgraph.Vertex, err error) {
	for {
		v1, v2, err = obj.baseGrouper.VertexNext() // get all iterable pairs
		if err != nil {
			return nil, nil, errwrap.Wrapf(err, "error running autoGroup(vertexNext)")
		}

		// ignore self cmp early (perf optimization)
		if v1 != v2 && v1 != nil && v2 != nil {
			// if NOT reachable, they're viable...
			out1, e1 := obj.graph.Reachability(v1, v2)
			if e1 != nil {
				return nil, nil, e1
			}
			out2, e2 := obj.graph.Reachability(v2, v1)
			if e2 != nil {
				return nil, nil, e2
			}
			if len(out1) == 0 && len(out2) == 0 {
				return // return v1 and v2, they're viable
			}
		}

		// if we got here, it means we're skipping over this candidate!
		if ok, err := obj.baseGrouper.VertexTest(false); err != nil {
			return nil, nil, errwrap.Wrapf(err, "error running autoGroup(vertexTest)")
		} else if !ok {
			return nil, nil, nil // done!
		}

		// the vertexTest passed, so loop and try with a new pair...
	}
}
