cgrates/engine/route_cost_sort.go

/*
Real-time Online/Offline Charging System (OCS) for Telecom & ISP environments
Copyright (C) ITsysCOM GmbH

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 <http://www.gnu.org/licenses/>
*/

package engine

import (
	"fmt"

	"github.com/cgrates/birpc/context"

	"github.com/cgrates/cgrates/config"
	"github.com/cgrates/cgrates/utils"
)

func populateCostForRoutes(ctx *context.Context, cfg *config.CGRConfig,
	connMgr *ConnManager, routes map[string]*RouteWithWeight,
	ev *utils.CGREvent, extraOpts *optsGetRoutes) (sortedRoutes []*SortedRoute, err error) {
	if len(cfg.RouteSCfg().RateSConns) == 0 {
		return nil, utils.NewErrMandatoryIeMissing("connIDs")
	}
	sortedRoutes = make([]*SortedRoute, 0, len(routes))
	for _, route := range routes {
		if len(route.RateProfileIDs) == 0 && len(route.AccountIDs) == 0 {
			utils.Logger.Warning(
				fmt.Sprintf("<%s> supplier: <%s> - empty RateProfileIDs or AccountIDs",
					utils.RouteS, route.ID))
			return nil, utils.NewErrMandatoryIeMissing("RateProfileIDs or AccountIDs")
		}
		srtRoute := &SortedRoute{
			RouteID: route.ID,
			SortingData: map[string]interface{}{
				utils.Weight: route.Weight,
			},
			sortingDataDecimal: map[string]*utils.Decimal{
				utils.Weight: utils.NewDecimalFromFloat64(route.Weight),
			},
			RouteParameters: route.RouteParameters,
		}
		var cost *utils.Decimal
		if len(route.AccountIDs) != 0 { // query AccountS for cost

			var acntCost utils.EventCharges
			ev.APIOpts[utils.OptsAccountsProfileIDs] = utils.CloneStringSlice(route.AccountIDs)
			if err = connMgr.Call(ctx, cfg.RouteSCfg().AccountSConns,
				utils.AccountSv1MaxAbstracts, ev, &acntCost); err != nil {
				if extraOpts.ignoreErrors {
					utils.Logger.Warning(
						fmt.Sprintf("<%s> ignoring route with ID: %s, err: %s",
							utils.RouteS, route.ID, err.Error()))
					err = nil
					continue
				}
				err = utils.NewErrAccountS(err)
				return
			}
			if acntCost.Concretes != nil {
				cost = acntCost.Concretes
			}
			acntIDs := make([]string, 0, len(acntCost.Accounts))
			for acntID := range acntCost.Accounts {
				acntIDs = append(acntIDs, acntID)
			}
			srtRoute.SortingData[utils.AccountIDs] = acntIDs

		} else { // query RateS for cost

			ev.APIOpts[utils.OptsRatesProfileIDs] = utils.CloneStringSlice(route.RateProfileIDs)
			var rpCost utils.RateProfileCost
			if err = connMgr.Call(ctx, cfg.RouteSCfg().RateSConns,
				utils.RateSv1CostForEvent, ev, &rpCost); err != nil {
				if extraOpts.ignoreErrors {
					utils.Logger.Warning(
						fmt.Sprintf("<%s> ignoring route with ID: %s, err: %s",
							utils.RouteS, route.ID, err.Error()))
					err = nil
					continue
				}
				err = utils.NewErrRateS(err)
				return
			}
			cost = rpCost.Cost
			srtRoute.SortingData[utils.RatingPlanID] = rpCost.ID

		}

		if cost != nil {
			srtRoute.sortingDataDecimal[utils.Cost] = cost
		}
		srtRoute.SortingData[utils.Cost] = cost

		var pass bool
		if pass, err = routeLazyPass(ctx, route.lazyCheckRules, ev, srtRoute.SortingData,
			cfg.FilterSCfg().ResourceSConns,
			cfg.FilterSCfg().StatSConns,
			cfg.FilterSCfg().AccountSConns); err != nil {
			return
		} else if pass {
			sortedRoutes = append(sortedRoutes, srtRoute)
		}
	}
	return
}

func NewHighestCostSorter(cfg *config.CGRConfig, connMgr *ConnManager) *HightCostSorter {
	return &HightCostSorter{cfg: cfg, connMgr: connMgr}
}

// HightCostSorter sorts routes based on their cost
type HightCostSorter struct {
	cfg     *config.CGRConfig
	connMgr *ConnManager
}

func (hcs *HightCostSorter) SortRoutes(ctx *context.Context, prflID string, routes map[string]*RouteWithWeight,
	ev *utils.CGREvent, extraOpts *optsGetRoutes) (sortedRoutes *SortedRoutes, err error) {
	var sRoutes []*SortedRoute
	if sRoutes, err = populateCostForRoutes(ctx, hcs.cfg, hcs.connMgr, routes, ev, extraOpts); err != nil {
		return
	}

	sortedRoutes = &SortedRoutes{
		ProfileID: prflID,
		Sorting:   utils.MetaHC,
		Routes:    sRoutes,
	}
	sortedRoutes.SortHighestCost()
	return
}

func NewLeastCostSorter(cfg *config.CGRConfig, connMgr *ConnManager) *LeastCostSorter {
	return &LeastCostSorter{cfg: cfg, connMgr: connMgr}
}

// LeastCostSorter sorts routes based on their cost
type LeastCostSorter struct {
	cfg     *config.CGRConfig
	connMgr *ConnManager
}

func (lcs *LeastCostSorter) SortRoutes(ctx *context.Context, prflID string, routes map[string]*RouteWithWeight,
	ev *utils.CGREvent, extraOpts *optsGetRoutes) (sortedRoutes *SortedRoutes, err error) {
	var sRoutes []*SortedRoute
	if sRoutes, err = populateCostForRoutes(ctx, lcs.cfg, lcs.connMgr, routes, ev, extraOpts); err != nil {
		return
	}
	sortedRoutes = &SortedRoutes{
		ProfileID: prflID,
		Sorting:   utils.MetaLC,
		Routes:    sRoutes,
	}
	sortedRoutes.SortLeastCost()
	return
}