Files
cgrates/migrator/attributes.go
2021-05-26 20:08:15 +02:00

464 lines
13 KiB
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 migrator
import (
"errors"
"fmt"
"strings"
"github.com/cgrates/cgrates/config"
"github.com/cgrates/cgrates/engine"
"github.com/cgrates/cgrates/utils"
)
type v1Attribute struct {
FieldName string
Initial string
Substitute string
Append bool
}
type v1AttributeProfile struct {
Tenant string
ID string
Contexts []string // bind this AttributeProfile to multiple contexts
FilterIDs []string
ActivationInterval *utils.ActivationInterval // Activation interval
Attributes map[string]map[string]*v1Attribute // map[FieldName][InitialValue]*Attribute
Weight float64
}
func (m *Migrator) migrateCurrentAttributeProfile() (err error) {
var ids []string
ids, err = m.dmIN.DataManager().DataDB().GetKeysForPrefix(utils.AttributeProfilePrefix)
if err != nil {
return err
}
for _, id := range ids {
tntID := strings.SplitN(strings.TrimPrefix(id, utils.AttributeProfilePrefix), utils.InInFieldSep, 2)
if len(tntID) < 2 {
return fmt.Errorf("Invalid key <%s> when migrating attributes", id)
}
attrPrf, err := m.dmIN.DataManager().GetAttributeProfile(tntID[0], tntID[1], false, false, utils.NonTransactional)
if err != nil {
return err
}
if attrPrf == nil || m.dryRun {
continue
}
if err := m.dmOut.DataManager().SetAttributeProfile(attrPrf, true); err != nil {
return err
}
if err := m.dmIN.DataManager().RemoveAttributeProfile(tntID[0],
tntID[1], false); err != nil {
return err
}
m.stats[utils.Attributes]++
}
return
}
func (m *Migrator) migrateV1ToV4AttributeProfile() (v4Attr *v4AttributeProfile, err error) {
var v1Attr *v1AttributeProfile
v1Attr, err = m.dmIN.getV1AttributeProfile()
if err != nil {
return nil, err
} else if v1Attr == nil {
return nil, errors.New("Attribute NIL")
}
v4Attr, err = v1Attr.AsAttributeProfileV1To4()
if err != nil {
return nil, err
}
return
}
func (m *Migrator) migrateV2ToV3AttributeProfile(v2Attr *v2AttributeProfile) (v3Attr *v3AttributeProfile, err error) {
if v2Attr == nil {
// read data from DataDB
v2Attr, err = m.dmIN.getV2AttributeProfile()
if err != nil {
return nil, err
}
}
//Migrate the AttributeProfile to next version (from v2 to v3)
v3Attr, err = v2Attr.AsAttributeProfile()
if err != nil {
return nil, err
}
return v3Attr, nil
}
func (m *Migrator) migrateV3ToV4AttributeProfile(v3Attr *v3AttributeProfile) (v4Attr *v4AttributeProfile, err error) {
if v3Attr == nil {
// read data from DataDB
v3Attr, err = m.dmIN.getV3AttributeProfile()
if err != nil {
return nil, err
}
}
//migrate
v4Attr, err = v3Attr.AsAttributeProfile()
if err != nil {
return nil, err
}
return v4Attr, nil
}
func (m *Migrator) migrateV4ToV5AttributeProfile(v4Attr *v4AttributeProfile) (v5Attr *engine.AttributeProfile, err error) {
if v4Attr == nil {
// read data from DataDB
v4Attr, err = m.dmIN.getV4AttributeProfile()
if err != nil {
return nil, err
}
}
v5Attr, err = v4Attr.AsAttributeProfile()
if err != nil {
return nil, err
}
return v5Attr, nil
}
func (m *Migrator) migrateAttributeProfile() (err error) {
var vrs engine.Versions
current := engine.CurrentDataDBVersions()
if vrs, err = m.getVersions(utils.Attributes); err != nil {
return
}
migrated := true
var v2Attr *v2AttributeProfile
var v3Attr *v3AttributeProfile
var v4Attr *v4AttributeProfile
var v5Attr *engine.AttributeProfile
var v6Attr *engine.AttributeProfile
for {
// One attribute profile at a time
version := vrs[utils.Attributes]
for {
//Keep migrating until Attribute Profile reaches latest version
switch version {
default:
return fmt.Errorf("Unsupported version %v", version)
case current[utils.Attributes]:
migrated = false
if m.sameDataDB {
break
}
if err = m.migrateCurrentAttributeProfile(); err != nil { //generator like v1,2,3,4
return
}
case 1: // Migrate from V1 to V4
if v4Attr, err = m.migrateV1ToV4AttributeProfile(); err != nil && err != utils.ErrNoMoreData {
return
} else if err == utils.ErrNoMoreData {
break
}
//Update to version to 4 (shortcut)
version = 4
case 2: // Migrate from V2 to V3 (fallthrough untill latest version)
if v3Attr, err = m.migrateV2ToV3AttributeProfile(v2Attr); err != nil && err != utils.ErrNoMoreData {
return
} else if err == utils.ErrNoMoreData {
break
}
version = 3
fallthrough
case 3: // Migrate from V3 to V4
if v4Attr, err = m.migrateV3ToV4AttributeProfile(v3Attr); err != nil && err != utils.ErrNoMoreData {
return
} else if err == utils.ErrNoMoreData {
break
}
version = 4
fallthrough
case 4: // Migrate from V4 to V5
if v5Attr, err = m.migrateV4ToV5AttributeProfile(v4Attr); err != nil && err != utils.ErrNoMoreData {
return
} else if err == utils.ErrNoMoreData {
break
}
version = 5
fallthrough
case 5:
if v6Attr, err = m.migrateV5ToV6AttributeProfile(v5Attr); err != nil && err != utils.ErrNoMoreData {
return
} else if err == utils.ErrNoMoreData {
break
}
version = 6
}
if version == current[utils.Attributes] || err == utils.ErrNoMoreData {
break
}
}
if err == utils.ErrNoMoreData || !migrated {
break
}
if !m.dryRun {
for _, attr := range v6Attr.Attributes {
if attr.Path == utils.EmptyString { // we do not suppot empty Path in Attributes
err = fmt.Errorf("the AttributeProfile <%s> was not migrated corectly", v6Attr.TenantID())
return
}
}
if vrs[utils.Attributes] == 1 {
if err = m.dmOut.DataManager().DataDB().SetAttributeProfileDrv(v6Attr); err != nil {
return
}
}
// Set the fresh-migrated AttributeProfile into DB
if err = m.dmOut.DataManager().SetAttributeProfile(v6Attr, true); err != nil {
return err
}
}
m.stats[utils.Attributes]++
}
if m.dryRun || !migrated {
return nil
}
// All done, update version with current one
if err = m.setVersions(utils.Attributes); err != nil {
return
}
return m.ensureIndexesDataDB(engine.ColAttr)
}
func (v1AttrPrf v1AttributeProfile) AsAttributeProfile() (attrPrf *v2AttributeProfile, err error) {
attrPrf = &v2AttributeProfile{
Tenant: v1AttrPrf.Tenant,
ID: v1AttrPrf.ID,
Contexts: v1AttrPrf.Contexts,
FilterIDs: v1AttrPrf.FilterIDs,
ActivationInterval: v1AttrPrf.ActivationInterval,
Weight: v1AttrPrf.Weight,
}
for _, mp := range v1AttrPrf.Attributes {
for _, attr := range mp {
sbstPrsr, err := config.NewRSRParsers(attr.Substitute, config.CgrConfig().GeneralCfg().RSRSep)
if err != nil {
return nil, err
}
attrPrf.Attributes = append(attrPrf.Attributes, &v2Attribute{
FieldName: attr.FieldName,
Initial: attr.Initial,
Substitute: sbstPrsr,
Append: attr.Append,
})
}
}
return
}
func (v2AttrPrf v2AttributeProfile) AsAttributeProfile() (attrPrf *v3AttributeProfile, err error) {
attrPrf = &v3AttributeProfile{
Tenant: v2AttrPrf.Tenant,
ID: v2AttrPrf.ID,
Contexts: v2AttrPrf.Contexts,
FilterIDs: v2AttrPrf.FilterIDs,
ActivationInterval: v2AttrPrf.ActivationInterval,
Weight: v2AttrPrf.Weight,
}
for _, attr := range v2AttrPrf.Attributes {
filterIDs := make([]string, 0)
//append false translate to if FieldName exist do stuff
if !attr.Append {
filterIDs = append(filterIDs, utils.MetaExists+utils.InInFieldSep+attr.FieldName+utils.InInFieldSep)
}
//Initial not *any translate to if value of fieldName = initial do stuff
initial := utils.IfaceAsString(attr.Initial)
if initial != utils.MetaAny {
filterIDs = append(filterIDs, utils.MetaString+utils.InInFieldSep+attr.FieldName+utils.InInFieldSep+initial)
}
attrPrf.Attributes = append(attrPrf.Attributes, &v3Attribute{
FilterIDs: filterIDs,
FieldName: attr.FieldName,
Substitute: attr.Substitute,
})
}
return
}
func (v1AttrPrf v1AttributeProfile) AsAttributeProfileV1To4() (attrPrf *v4AttributeProfile, err error) {
attrPrf = &v4AttributeProfile{
Tenant: v1AttrPrf.Tenant,
ID: v1AttrPrf.ID,
Contexts: v1AttrPrf.Contexts,
FilterIDs: v1AttrPrf.FilterIDs,
ActivationInterval: v1AttrPrf.ActivationInterval,
Weight: v1AttrPrf.Weight,
Blocker: false,
}
for _, mp := range v1AttrPrf.Attributes {
for _, attr := range mp {
// Create FilterIDs []string
filterIDs := make([]string, 0)
//append false translate to if FieldName exist do stuff
if !attr.Append {
filterIDs = append(filterIDs, utils.MetaExists+utils.ConcatenatedKeySep+attr.FieldName+utils.ConcatenatedKeySep)
}
//Initial not *any translate to if value of fieldName = initial do stuff
if attr.Initial != utils.MetaAny {
filterIDs = append(filterIDs, utils.MetaString+utils.ConcatenatedKeySep+attr.FieldName+utils.ConcatenatedKeySep+attr.Initial)
}
// create RSRParser
sbstPrsr, err := config.NewRSRParsers(attr.Substitute, config.CgrConfig().GeneralCfg().RSRSep)
if err != nil {
return nil, err
}
attrPrf.Attributes = append(attrPrf.Attributes, &v4Attribute{
FilterIDs: filterIDs,
FieldName: attr.FieldName,
Type: utils.MetaVariable,
Value: sbstPrsr,
})
}
}
return
}
func (v3AttrPrf v3AttributeProfile) AsAttributeProfile() (attrPrf *v4AttributeProfile, err error) {
attrPrf = &v4AttributeProfile{
Tenant: v3AttrPrf.Tenant,
ID: v3AttrPrf.ID,
Contexts: v3AttrPrf.Contexts,
FilterIDs: v3AttrPrf.FilterIDs,
ActivationInterval: v3AttrPrf.ActivationInterval,
Weight: v3AttrPrf.Weight,
Blocker: false,
}
for _, attr := range v3AttrPrf.Attributes {
attrPrf.Attributes = append(attrPrf.Attributes, &v4Attribute{
FilterIDs: attr.FilterIDs,
FieldName: attr.FieldName,
Type: utils.MetaVariable,
Value: attr.Substitute,
})
}
return
}
func (v4AttrPrf v4AttributeProfile) AsAttributeProfile() (attrPrf *engine.AttributeProfile, err error) {
attrPrf = &engine.AttributeProfile{
Tenant: v4AttrPrf.Tenant,
ID: v4AttrPrf.ID,
Contexts: v4AttrPrf.Contexts,
FilterIDs: v4AttrPrf.FilterIDs,
Weight: v4AttrPrf.Weight,
ActivationInterval: v4AttrPrf.ActivationInterval,
}
for _, attr := range v4AttrPrf.Attributes { // ToDo:redo this
val := attr.Value.GetRule(utils.InfieldSep)
rsrVal := attr.Value
if strings.HasPrefix(val, utils.DynamicDataPrefix) {
val = val[1:] // remove the DynamicDataPrefix
val = utils.DynamicDataPrefix + utils.MetaReq + utils.NestingSep + val
rsrVal, err = config.NewRSRParsers(val, config.CgrConfig().GeneralCfg().RSRSep)
if err != nil {
return nil, err
}
}
var path string
if attr.FieldName != utils.EmptyString {
path = utils.MetaReq + utils.NestingSep + attr.FieldName
}
attrPrf.Attributes = append(attrPrf.Attributes, &engine.Attribute{
FilterIDs: attr.FilterIDs,
Path: path,
Value: rsrVal,
Type: attr.Type,
})
}
return
}
type v2Attribute struct {
FieldName string
Initial interface{}
Substitute config.RSRParsers
Append bool
}
type v2AttributeProfile struct {
Tenant string
ID string
Contexts []string // bind this AttributeProfile to multiple contexts
FilterIDs []string
ActivationInterval *utils.ActivationInterval // Activation interval
Attributes []*v2Attribute
Weight float64
}
type v3Attribute struct {
FilterIDs []string
FieldName string
Substitute config.RSRParsers
}
type v3AttributeProfile struct {
Tenant string
ID string
Contexts []string // bind this AttributeProfile to multiple contexts
FilterIDs []string
ActivationInterval *utils.ActivationInterval // Activation interval
Attributes []*v3Attribute
Weight float64
}
type v4Attribute struct {
FilterIDs []string
FieldName string
Type string
Value config.RSRParsers
}
type v4AttributeProfile struct {
Tenant string
ID string
Contexts []string // bind this AttributeProfile to multiple contexts
FilterIDs []string
ActivationInterval *utils.ActivationInterval // Activation interval
Attributes []*v4Attribute
Blocker bool // blocker flag to stop processing on multiple runs
Weight float64
}
func (m *Migrator) migrateV5ToV6AttributeProfile(v5Attr *engine.AttributeProfile) (_ *engine.AttributeProfile, err error) {
if v5Attr == nil {
// read data from DataDB
if v5Attr, err = m.dmIN.getV5AttributeProfile(); err != nil {
return
}
}
if v5Attr.FilterIDs, err = migrateInlineFilterV4(v5Attr.FilterIDs); err != nil {
return
}
return v5Attr, nil
}