cgrates/utils/eventcharges.go

/*
Real-time Online/Offline Charging System (OerS) 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 utils

// NewEventChargers instantiates the EventChargers in a central place
func NewEventCharges() (ec *EventCharges) {
	ec = &EventCharges{
		Accounting:  make(map[string]*AccountCharge),
		UnitFactors: make(map[string]*UnitFactor),
		Rating:      make(map[string]*RateSInterval),
		Rates:       make(map[string]*IntervalRate),
		Accounts:    make(map[string]*Account),
	}
	return
}

// EventCharges records the charges applied to an Event
type EventCharges struct {
	Abstracts *Decimal // total abstract units charged
	Concretes *Decimal // total concrete units charged

	Charges []*ChargeEntry

	Accounting  map[string]*AccountCharge
	UnitFactors map[string]*UnitFactor
	Rating      map[string]*RateSInterval
	Rates       map[string]*IntervalRate
	Accounts    map[string]*Account
}

// ChargeEntry is a reference towards Accounting or Rating ID (depending on request type)
type ChargeEntry struct {
	ChargingID     string
	CompressFactor int
}

// Merge will merge the event charges into existing
func (ec *EventCharges) Merge(eCs ...*EventCharges) {
	//ec.SyncIDs(eCs...) // so we can compare properly
	for _, nEc := range eCs {
		if sumAbst := SumDecimalAsBig(ec.Abstracts, nEc.Abstracts); sumAbst != nil {
			ec.Abstracts = &Decimal{sumAbst}
		}
		if sumCrct := SumDecimalAsBig(ec.Concretes, nEc.Concretes); sumCrct != nil {
			ec.Concretes = &Decimal{sumCrct}
		}
		ec.appendChargeEntry(nEc.Charges...)
		for acntID, acntChrg := range nEc.Accounting {
			ec.Accounting[acntID] = acntChrg
		}
		for ufID, uF := range nEc.UnitFactors {
			ec.UnitFactors[ufID] = uF
		}
		for riID, rI := range nEc.Rating {
			ec.Rating[riID] = rI
		}
		for acntID, acnt := range nEc.Accounts {
			ec.Accounts[acntID] = acnt
		}
	}
}

// appendChargeEntry will add new charge to the  existing.
// if possible, the existing last one in ec will be compressed
func (ec *EventCharges) appendChargeEntry(cIls ...*ChargeEntry) {
	for i, cIl := range cIls {
		if i == 0 && len(ec.Charges) == 0 {
			ec.Charges = []*ChargeEntry{cIl}
			continue
		}
		if ec.Charges[len(ec.Charges)-1].CompressEquals(cIl) {
			ec.Charges[len(ec.Charges)-1].CompressFactor += 1
			continue
		}
		ec.Charges = append(ec.Charges, cIl)
	}
}

// Equals return the equality between two ChargeEntry ignoring CompressFactor
func (cE *ChargeEntry) CompressEquals(chEn *ChargeEntry) bool {
	return cE.ChargingID == chEn.ChargingID
}

// SyncIDs will repopulate Accounting, UnitFactors and  Rating IDs if they equal the references in ec
func (ec *EventCharges) SyncIDs(eCs ...*EventCharges) {
	for _, nEc := range eCs {
		for _, cIl := range nEc.Charges {
			nEcAcntChrg := nEc.Accounting[cIl.ChargingID]

			// UnitFactors
			if nEcAcntChrg.UnitFactorID != EmptyString {
				if uFctID := ec.unitFactorID(nEc.UnitFactors[nEcAcntChrg.UnitFactorID]); uFctID != EmptyString &&
					uFctID != nEcAcntChrg.UnitFactorID {
					nEc.UnitFactors[uFctID] = ec.UnitFactors[uFctID]
					delete(nEc.UnitFactors, nEcAcntChrg.UnitFactorID)
					nEcAcntChrg.UnitFactorID = uFctID
				}
			}

			// Rating
			if nEcAcntChrg.RatingID != EmptyString {
				if rtID := ec.ratingID(nEc.Rating[nEcAcntChrg.RatingID], nEc.Rates); rtID != EmptyString &&
					rtID != nEcAcntChrg.RatingID {
					nEc.Rating[rtID] = ec.Rating[rtID]
					delete(nEc.Rating, nEcAcntChrg.RatingID)
					nEcAcntChrg.RatingID = rtID
				}
			}

			// AccountCharges
			for i, chrgID := range nEc.Accounting[cIl.ChargingID].JoinedChargeIDs {
				if acntChrgID := ec.accountChargeID(nEc.Accounting[chrgID]); acntChrgID != chrgID {
					// matched the accountChargeID with an existing one in reference ec, replace in nEc
					nEc.Accounting[acntChrgID] = ec.Accounting[acntChrgID]
					delete(nEc.Accounting, chrgID)
					nEc.Accounting[cIl.ChargingID].JoinedChargeIDs[i] = acntChrgID
				}
			}
			if acntChrgID := ec.accountChargeID(nEcAcntChrg); acntChrgID != EmptyString &&
				acntChrgID != cIl.ChargingID {
				// matched the accountChargeID with an existing one in reference ec, replace in nEc
				nEc.Accounting[acntChrgID] = ec.Accounting[cIl.ChargingID]
				delete(nEc.Accounting, cIl.ChargingID)
				cIl.ChargingID = acntChrgID
			}

		}
	}
}

// Equals returns the equality between two EventCharges
func (eC *EventCharges) Equals(evCh *EventCharges) (eq bool) {
	if eC == nil && evCh == nil {
		return true
	}
	if (eC == nil && evCh != nil ||
		eC != nil && evCh == nil) ||
		(eC.Abstracts == nil && evCh.Abstracts != nil ||
			eC.Abstracts != nil && evCh.Abstracts == nil ||
			(eC.Abstracts != nil && evCh.Abstracts != nil &&
				eC.Abstracts.Compare(evCh.Abstracts) != 0)) ||
		(eC.Concretes == nil && evCh.Concretes != nil ||
			eC.Concretes != nil && evCh.Concretes == nil ||
			(eC.Concretes != nil && evCh.Concretes != nil &&
				eC.Concretes.Compare(evCh.Concretes) != 0)) ||
		(eC.Charges == nil && evCh.Charges != nil ||
			eC.Charges != nil && evCh.Charges == nil ||
			len(eC.Charges) != len(evCh.Charges)) ||
		(eC.Accounting == nil && evCh.Accounting != nil ||
			eC.Accounting != nil && evCh.Accounting == nil ||
			len(eC.Accounting) != len(evCh.Accounting)) ||
		(eC.UnitFactors == nil && evCh.UnitFactors != nil ||
			eC.UnitFactors != nil && evCh.UnitFactors == nil ||
			len(eC.UnitFactors) != len(evCh.UnitFactors)) ||
		(eC.Rating == nil && evCh.Rating != nil ||
			eC.Rating != nil && evCh.Rating == nil ||
			len(eC.Rating) != len(evCh.Rating)) ||
		(eC.Rates == nil && evCh.Rates != nil ||
			eC.Rates != nil && evCh.Rates == nil ||
			len(eC.Rates) != len(evCh.Rates)) ||
		(eC.Accounts == nil && evCh.Accounts != nil ||
			eC.Accounts != nil && evCh.Accounts == nil ||
			len(eC.Accounts) != len(evCh.Accounts)) {
		return
	}
	for idx, ch1 := range eC.Charges {
		if ch2 := evCh.Charges[idx]; ch1.CompressFactor != ch2.CompressFactor ||
			!equalsAccounting(eC.Accounting[ch1.ChargingID], evCh.Accounting[ch2.ChargingID],
				eC.Accounting, evCh.Accounting, eC.UnitFactors, evCh.UnitFactors,
				eC.Rating, evCh.Rating, eC.Rates, evCh.Rates) {
			return
		}
	}
	for key, val := range eC.Accounts {
		if ok := val.Equals(evCh.Accounts[key]); !ok {
			return
		}
	}
	return true
}

func equalsAccounting(acc1, acc2 *AccountCharge,
	accM1, accM2 map[string]*AccountCharge,
	uf1, uf2 map[string]*UnitFactor,
	rat1, rat2 map[string]*RateSInterval,
	rts1, rts2 map[string]*IntervalRate) (_ bool) {
	if !acc1.equals(acc2) ||
		(uf1 != nil && uf2 != nil &&
			acc1.UnitFactorID != EmptyString && acc2.UnitFactorID != EmptyString &&
			!uf1[acc1.UnitFactorID].Equals(uf2[acc2.UnitFactorID])) ||
		!rat1[acc1.RatingID].Equals(rat2[acc2.RatingID], rts1, rts2) {
		return
	}
	for idx, jc1 := range acc1.JoinedChargeIDs {
		jc2 := acc2.JoinedChargeIDs[idx]
		if !equalsAccounting(accM1[jc1], accM2[jc2], accM1, accM2,
			uf1, uf2, rat1, rat2, rts1, rts2) {
			return
		}
	}
	return true
}

// unitFactorID returns the ID of the matching UnitFactor within ec.UnitFactors
func (ec *EventCharges) unitFactorID(uF *UnitFactor) (ufID string) {
	for ecUfID, ecUf := range ec.UnitFactors {
		if ecUf.Equals(uF) {
			return ecUfID
		}
	}
	return
}

// ratingID returns the ID of the matching RateSInterval within ec.Rating
func (ec *EventCharges) ratingID(rIl *RateSInterval, nIrRef map[string]*IntervalRate) (rID string) {
	for ecID, ecRtIl := range ec.Rating {
		if ecRtIl.Equals(rIl, ec.Rates, nIrRef) {
			return ecID
		}
	}
	return
}

// accountChargeID returns the ID of the matching AccountCharge within ec.Accounting
func (ec *EventCharges) accountChargeID(ac *AccountCharge) (acID string) {
	for ecID, ecAc := range ec.Accounting {
		if ecAc.equals(ac) {
			return ecID
		}
	}
	return
}

// AccountCharge represents one Account charge
type AccountCharge struct {
	AccountID       string
	BalanceID       string
	Units           *Decimal
	BalanceLimit    *Decimal // the minimum balance value accepted
	UnitFactorID    string   // identificator in ChargingUnitFactors
	AttributeIDs    []string // list of attribute profiles matched
	RatingID        string   // identificator in cost increments
	JoinedChargeIDs []string // identificator of extra account charges
}

// Equals compares two AccountCharges
func (ac *AccountCharge) equals(nAc *AccountCharge) (eq bool) {
	if ac == nil && nAc == nil {
		return true
	}
	if (ac.AttributeIDs == nil && nAc.AttributeIDs != nil ||
		ac.AttributeIDs != nil && nAc.AttributeIDs == nil ||
		len(ac.AttributeIDs) != len(nAc.AttributeIDs)) ||
		ac.JoinedChargeIDs == nil && nAc.JoinedChargeIDs != nil ||
		ac.JoinedChargeIDs != nil && nAc.JoinedChargeIDs == nil ||
		len(ac.JoinedChargeIDs) != len(nAc.JoinedChargeIDs) ||
		(ac.AccountID != nAc.AccountID ||
			ac.BalanceID != nAc.BalanceID) ||
		((len(ac.UnitFactorID) == 0) != (len(nAc.UnitFactorID) == 0)) ||
		((len(ac.RatingID) == 0) != (len(nAc.RatingID) == 0)) ||
		(ac.Units == nil && nAc.Units != nil ||
			ac.Units != nil && nAc.Units == nil ||
			(ac.Units != nil && nAc.Units != nil &&
				ac.Units.Compare(nAc.Units) != 0)) ||
		(ac.BalanceLimit == nil && nAc.BalanceLimit != nil ||
			ac.BalanceLimit != nil && nAc.BalanceLimit == nil ||
			(ac.BalanceLimit != nil && nAc.BalanceLimit != nil &&
				ac.BalanceLimit.Compare(nAc.BalanceLimit) != 0)) {
		return
	}
	for idx, val := range ac.AttributeIDs {
		if val != nAc.AttributeIDs[idx] {
			return
		}
	}
	return true
}