/* Real-time Charging System for Telecom & ISP environments Copyright (C) 2012-2014 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 */ package engine import ( "bytes" "compress/zlib" "errors" "fmt" "github.com/cgrates/cgrates/cache2go" "github.com/cgrates/cgrates/utils" "github.com/hoisie/redis" "io/ioutil" "time" ) type RedisStorage struct { dbNb int db *redis.Client ms Marshaler } func NewRedisStorage(address string, db int, pass, mrshlerStr string) (*RedisStorage, error) { ndb := &redis.Client{Addr: address, Db: db} if pass != "" { if err := ndb.Auth(pass); err != nil { return nil, err } } var mrshler Marshaler if mrshlerStr == utils.MSGPACK { mrshler = NewCodecMsgpackMarshaler() } else if mrshlerStr == utils.JSON { mrshler = new(JSONMarshaler) } else { return nil, fmt.Errorf("Unsupported marshaler: %v", mrshlerStr) } return &RedisStorage{db: ndb, dbNb: db, ms: mrshler}, nil } func (rs *RedisStorage) Close() { // no close for me //rs.db.Quit() } func (rs *RedisStorage) Flush() (err error) { err = rs.db.Flush(false) return } func (rs *RedisStorage) CacheRating(dKeys, rpKeys, rpfKeys, alsKeys, lcrKeys []string) (err error) { if dKeys == nil { Logger.Info("Caching all destinations") if dKeys, err = rs.db.Keys(DESTINATION_PREFIX + "*"); err != nil { return } cache2go.RemPrefixKey(DESTINATION_PREFIX) } else if len(dKeys) != 0 { Logger.Info(fmt.Sprintf("Caching destinations: %v", dKeys)) CleanStalePrefixes(dKeys) } for _, key := range dKeys { if _, err = rs.GetDestination(key[len(DESTINATION_PREFIX):]); err != nil { return err } } if len(dKeys) != 0 { Logger.Info("Finished destinations caching.") } if rpKeys == nil { Logger.Info("Caching all rating plans") if rpKeys, err = rs.db.Keys(RATING_PLAN_PREFIX + "*"); err != nil { return } cache2go.RemPrefixKey(RATING_PLAN_PREFIX) } else if len(rpKeys) != 0 { Logger.Info(fmt.Sprintf("Caching rating plans: %v", rpKeys)) } for _, key := range rpKeys { cache2go.RemKey(key) if _, err = rs.GetRatingPlan(key[len(RATING_PLAN_PREFIX):], true); err != nil { return err } } if len(rpKeys) != 0 { Logger.Info("Finished rating plans caching.") } if rpfKeys == nil { Logger.Info("Caching all rating profiles") if rpfKeys, err = rs.db.Keys(RATING_PROFILE_PREFIX + "*"); err != nil { return } cache2go.RemPrefixKey(RATING_PROFILE_PREFIX) } else if len(rpfKeys) != 0 { Logger.Info(fmt.Sprintf("Caching rating profile: %v", rpfKeys)) } for _, key := range rpfKeys { cache2go.RemKey(key) if _, err = rs.GetRatingProfile(key[len(RATING_PROFILE_PREFIX):], true); err != nil { return err } } if len(rpfKeys) != 0 { Logger.Info("Finished rating profile caching.") } if lcrKeys == nil { Logger.Info("Caching LCRs") if lcrKeys, err = rs.db.Keys(LCR_PREFIX + "*"); err != nil { return } cache2go.RemPrefixKey(LCR_PREFIX) } else if len(lcrKeys) != 0 { Logger.Info(fmt.Sprintf("Caching LCR: %v", lcrKeys)) } for _, key := range lcrKeys { cache2go.RemKey(key) if _, err = rs.GetLCR(key[len(LCR_PREFIX):], true); err != nil { return err } } if len(lcrKeys) != 0 { Logger.Info("Finished rating profile caching.") } if alsKeys == nil { Logger.Info("Caching rating profile aliases") if alsKeys, err = rs.db.Keys(RP_ALIAS_PREFIX + "*"); err != nil { return } cache2go.RemPrefixKey(RP_ALIAS_PREFIX) } else if len(alsKeys) != 0 { Logger.Info(fmt.Sprintf("Caching rating profile aliases: %v", alsKeys)) } for _, key := range alsKeys { cache2go.RemKey(key) if _, err = rs.GetRpAlias(key[len(RP_ALIAS_PREFIX):], true); err != nil { return err } } if len(alsKeys) != 0 { Logger.Info("Finished rating profile aliases caching.") } return } func (rs *RedisStorage) CacheAccounting(actKeys, shgKeys, alsKeys, dcsKeys []string) (err error) { if actKeys == nil { cache2go.RemPrefixKey(ACTION_PREFIX) } if actKeys == nil { Logger.Info("Caching all actions") if actKeys, err = rs.db.Keys(ACTION_PREFIX + "*"); err != nil { return } } else if len(actKeys) != 0 { Logger.Info(fmt.Sprintf("Caching actions: %v", actKeys)) } for _, key := range actKeys { cache2go.RemKey(key) if _, err = rs.GetActions(key[len(ACTION_PREFIX):], true); err != nil { return err } } if len(actKeys) != 0 { Logger.Info("Finished actions caching.") } if shgKeys == nil { cache2go.RemPrefixKey(SHARED_GROUP_PREFIX) } if shgKeys == nil { Logger.Info("Caching all shared groups") if shgKeys, err = rs.db.Keys(SHARED_GROUP_PREFIX + "*"); err != nil { return } } else if len(shgKeys) != 0 { Logger.Info(fmt.Sprintf("Caching shared groups: %v", shgKeys)) } for _, key := range shgKeys { cache2go.RemKey(key) if _, err = rs.GetSharedGroup(key[len(SHARED_GROUP_PREFIX):], true); err != nil { return err } } if len(shgKeys) != 0 { Logger.Info("Finished shared groups caching.") } if alsKeys == nil { Logger.Info("Caching account aliases") if alsKeys, err = rs.db.Keys(ACC_ALIAS_PREFIX + "*"); err != nil { return } cache2go.RemPrefixKey(ACC_ALIAS_PREFIX) } else if len(alsKeys) != 0 { Logger.Info(fmt.Sprintf("Caching account aliases: %v", alsKeys)) } for _, key := range alsKeys { cache2go.RemKey(key) if _, err = rs.GetAccAlias(key[len(ACC_ALIAS_PREFIX):], true); err != nil { return err } } if len(alsKeys) != 0 { Logger.Info("Finished account aliases caching.") } // DerivedChargers caching if dcsKeys == nil { Logger.Info("Caching all derived chargers") if dcsKeys, err = rs.db.Keys(DERIVEDCHARGERS_PREFIX + "*"); err != nil { return } cache2go.RemPrefixKey(DERIVEDCHARGERS_PREFIX) } else if len(dcsKeys) != 0 { Logger.Info(fmt.Sprintf("Caching derived chargers: %v", dcsKeys)) } for _, key := range dcsKeys { cache2go.RemKey(key) if _, err = rs.GetDerivedChargers(key[len(DERIVEDCHARGERS_PREFIX):], true); err != nil { return err } } if len(dcsKeys) != 0 { Logger.Info("Finished derived chargers caching.") } return nil } // Used to check if specific subject is stored using prefix key attached to entity func (rs *RedisStorage) HasData(category, subject string) (bool, error) { switch category { case DESTINATION_PREFIX, RATING_PLAN_PREFIX, RATING_PROFILE_PREFIX, ACTION_PREFIX, ACTION_TIMING_PREFIX, ACCOUNT_PREFIX: return rs.db.Exists(category + subject) } return false, errors.New("Unsupported category in ExistsData") } func (rs *RedisStorage) GetRatingPlan(key string, checkDb bool) (rp *RatingPlan, err error) { key = RATING_PLAN_PREFIX + key if x, err := cache2go.GetCached(key); err == nil { return x.(*RatingPlan), nil } if !checkDb { return nil, errors.New(utils.ERR_NOT_FOUND) } var values []byte if values, err = rs.db.Get(key); err == nil { b := bytes.NewBuffer(values) r, err := zlib.NewReader(b) if err != nil { return nil, err } out, err := ioutil.ReadAll(r) if err != nil { return nil, err } r.Close() rp = new(RatingPlan) err = rs.ms.Unmarshal(out, rp) cache2go.Cache(key, rp) } return } func (rs *RedisStorage) SetRatingPlan(rp *RatingPlan) (err error) { result, err := rs.ms.Marshal(rp) var b bytes.Buffer w := zlib.NewWriter(&b) w.Write(result) w.Close() err = rs.db.Set(RATING_PLAN_PREFIX+rp.Id, b.Bytes()) if err == nil && historyScribe != nil { response := 0 go historyScribe.Record(rp.GetHistoryRecord(), &response) } //cache2go.Cache(RATING_PLAN_PREFIX+rp.Id, rp) return } func (rs *RedisStorage) GetRatingProfile(key string, checkDb bool) (rpf *RatingProfile, err error) { key = RATING_PROFILE_PREFIX + key if x, err := cache2go.GetCached(key); err == nil { return x.(*RatingProfile), nil } if !checkDb { return nil, errors.New(utils.ERR_NOT_FOUND) } var values []byte if values, err = rs.db.Get(key); err == nil { rpf = new(RatingProfile) err = rs.ms.Unmarshal(values, rpf) cache2go.Cache(key, rpf) } return } func (rs *RedisStorage) SetRatingProfile(rpf *RatingProfile) (err error) { result, err := rs.ms.Marshal(rpf) err = rs.db.Set(RATING_PROFILE_PREFIX+rpf.Id, result) if err == nil && historyScribe != nil { response := 0 go historyScribe.Record(rpf.GetHistoryRecord(), &response) } //cache2go.Cache(RATING_PROFILE_PREFIX+rpf.Id, rpf) return } func (rs *RedisStorage) GetRpAlias(key string, checkDb bool) (alias string, err error) { key = RP_ALIAS_PREFIX + key if x, err := cache2go.GetCached(key); err == nil { return x.(string), nil } if !checkDb { return "", errors.New(utils.ERR_NOT_FOUND) } var values []byte if values, err = rs.db.Get(key); err == nil { alias = string(values) cache2go.Cache(key, alias) } return } func (rs *RedisStorage) SetRpAlias(key, alias string) (err error) { err = rs.db.Set(RP_ALIAS_PREFIX+key, []byte(alias)) return } // Returns the aliases of one specific rating profile subject on a tenant func (rs *RedisStorage) RemoveRpAliases(accounts []string) (err error) { if alsKeys, err := rs.db.Keys(RP_ALIAS_PREFIX + "*"); err != nil { return err } else { for _, key := range alsKeys { alias, err := rs.GetRpAlias(key[len(RP_ALIAS_PREFIX):], true) if err != nil { return err } if utils.IsSliceMember(accounts, alias) { if _, err = rs.db.Del(key); err != nil { return err } } } } return } func (rs *RedisStorage) GetRPAliases(tenant, subject string) (aliases []string, err error) { alsKeys, err := rs.db.Keys(RP_ALIAS_PREFIX + "*") if err != nil { return nil, err } for _, key := range alsKeys { tenantPrfx := RP_ALIAS_PREFIX + tenant + utils.CONCATENATED_KEY_SEP if len(key) < len(tenantPrfx) || tenantPrfx != key[:len(tenantPrfx)] { // filter out the tenant for accounts continue } if alsSubj, err := rs.GetRpAlias(key[len(ACC_ALIAS_PREFIX):], true); err != nil { return nil, err } else if alsSubj == subject { alsFromKey := key[len(tenantPrfx):] // take out the alias out of key+tenant aliases = append(aliases, alsFromKey) } } return aliases, nil } func (rs *RedisStorage) GetLCR(key string, checkDb bool) (lcr *LCR, err error) { key = LCR_PREFIX + key if x, err := cache2go.GetCached(key); err == nil { return x.(*LCR), nil } if !checkDb { return nil, errors.New(utils.ERR_NOT_FOUND) } var values []byte if values, err = rs.db.Get(key); err == nil { err = rs.ms.Unmarshal(values, &lcr) cache2go.Cache(key, lcr) } return } func (rs *RedisStorage) SetLCR(lcr *LCR) (err error) { result, err := rs.ms.Marshal(lcr) err = rs.db.Set(LCR_PREFIX+lcr.GetId(), result) cache2go.Cache(LCR_PREFIX+lcr.GetId(), lcr) return } func (rs *RedisStorage) GetAccAlias(key string, checkDb bool) (alias string, err error) { key = ACC_ALIAS_PREFIX + key if x, err := cache2go.GetCached(key); err == nil { return x.(string), nil } if !checkDb { return "", errors.New(utils.ERR_NOT_FOUND) } var values []byte if values, err = rs.db.Get(key); err == nil { alias = string(values) cache2go.Cache(key, alias) } return } // Adds one alias for one account func (rs *RedisStorage) SetAccAlias(key, alias string) (err error) { err = rs.db.Set(ACC_ALIAS_PREFIX+key, []byte(alias)) //cache2go.Cache(ALIAS_PREFIX+key, alias) return } func (rs *RedisStorage) RemoveAccAliases(accounts []string) (err error) { if alsKeys, err := rs.db.Keys(ACC_ALIAS_PREFIX + "*"); err != nil { return err } else { for _, key := range alsKeys { alias, err := rs.GetAccAlias(key[len(ACC_ALIAS_PREFIX):], true) if err != nil { return err } if utils.IsSliceMember(accounts, alias) { if _, err = rs.db.Del(key); err != nil { return err } } } } return } // Returns the aliases of one specific account on a tenant func (rs *RedisStorage) GetAccountAliases(tenant, account string) (aliases []string, err error) { alsKeys, err := rs.db.Keys(ACC_ALIAS_PREFIX + "*") if err != nil { return nil, err } for _, key := range alsKeys { tenantPrfx := ACC_ALIAS_PREFIX + tenant + utils.CONCATENATED_KEY_SEP if len(key) < len(tenantPrfx) || tenantPrfx != key[:len(tenantPrfx)] { // filter out the tenant for accounts continue } if alsAcnt, err := rs.GetAccAlias(key[len(ACC_ALIAS_PREFIX):], true); err != nil { return nil, err } else if alsAcnt == account { alsFromKey := key[len(tenantPrfx):] // take out the alias out of key+tenant aliases = append(aliases, alsFromKey) } } return aliases, nil } func (rs *RedisStorage) GetDestination(key string) (dest *Destination, err error) { key = DESTINATION_PREFIX + key var values []byte if values, err = rs.db.Get(key); len(values) > 0 && err == nil { b := bytes.NewBuffer(values) r, err := zlib.NewReader(b) if err != nil { return nil, err } out, err := ioutil.ReadAll(r) if err != nil { return nil, err } r.Close() dest = new(Destination) err = rs.ms.Unmarshal(out, dest) // create optimized structure for _, p := range dest.Prefixes { var ids []string if x, err := cache2go.GetCached(DESTINATION_PREFIX + p); err == nil { ids = x.([]string) } ids = append(ids, dest.Id) cache2go.Cache(DESTINATION_PREFIX+p, ids) } } else { return nil, errors.New("not found") } return } func (rs *RedisStorage) SetDestination(dest *Destination) (err error) { result, err := rs.ms.Marshal(dest) if err != nil { return err } var b bytes.Buffer w := zlib.NewWriter(&b) w.Write(result) w.Close() err = rs.db.Set(DESTINATION_PREFIX+dest.Id, b.Bytes()) if err == nil && historyScribe != nil { response := 0 go historyScribe.Record(dest.GetHistoryRecord(), &response) } //cache2go.Cache(DESTINATION_PREFIX+dest.Id, dest) return } func (rs *RedisStorage) GetActions(key string, checkDb bool) (as Actions, err error) { key = ACTION_PREFIX + key if x, err := cache2go.GetCached(key); err == nil { return x.(Actions), nil } if !checkDb { return nil, errors.New(utils.ERR_NOT_FOUND) } var values []byte if values, err = rs.db.Get(key); err == nil { err = rs.ms.Unmarshal(values, &as) cache2go.Cache(key, as) } return } func (rs *RedisStorage) SetActions(key string, as Actions) (err error) { result, err := rs.ms.Marshal(&as) err = rs.db.Set(ACTION_PREFIX+key, result) // cache2go.Cache(ACTION_PREFIX+key, as) return } func (rs *RedisStorage) GetSharedGroup(key string, checkDb bool) (sg *SharedGroup, err error) { key = SHARED_GROUP_PREFIX + key if x, err := cache2go.GetCached(key); err == nil { return x.(*SharedGroup), nil } if !checkDb { return nil, errors.New(utils.ERR_NOT_FOUND) } var values []byte if values, err = rs.db.Get(key); err == nil { err = rs.ms.Unmarshal(values, &sg) cache2go.Cache(key, sg) } return } func (rs *RedisStorage) SetSharedGroup(sg *SharedGroup) (err error) { result, err := rs.ms.Marshal(sg) err = rs.db.Set(SHARED_GROUP_PREFIX+sg.Id, result) cache2go.Cache(SHARED_GROUP_PREFIX+sg.Id, sg) return } func (rs *RedisStorage) GetAccount(key string) (ub *Account, err error) { var values []byte if values, err = rs.db.Get(ACCOUNT_PREFIX + key); err == nil { ub = &Account{Id: key} err = rs.ms.Unmarshal(values, ub) } return } func (rs *RedisStorage) SetAccount(ub *Account) (err error) { // never override existing account with an empty one if len(ub.BalanceMap) == 0 { if ac, err := rs.GetAccount(ub.Id); err == nil { ac.ActionTriggers = ub.ActionTriggers ub = ac } } result, err := rs.ms.Marshal(ub) err = rs.db.Set(ACCOUNT_PREFIX+ub.Id, result) return } func (rs *RedisStorage) GetActionTimings(key string) (ats ActionPlan, err error) { var values []byte if values, err = rs.db.Get(ACTION_TIMING_PREFIX + key); err == nil { err = rs.ms.Unmarshal(values, &ats) } return } func (rs *RedisStorage) SetActionTimings(key string, ats ActionPlan) (err error) { if len(ats) == 0 { // delete the key _, err = rs.db.Del(ACTION_TIMING_PREFIX + key) return err } result, err := rs.ms.Marshal(&ats) err = rs.db.Set(ACTION_TIMING_PREFIX+key, result) return } func (rs *RedisStorage) GetAllActionTimings() (ats map[string]ActionPlan, err error) { keys, err := rs.db.Keys(ACTION_TIMING_PREFIX + "*") if err != nil { return nil, err } ats = make(map[string]ActionPlan, len(keys)) for _, key := range keys { values, err := rs.db.Get(key) if err != nil { continue } var tempAts ActionPlan err = rs.ms.Unmarshal(values, &tempAts) ats[key[len(ACTION_TIMING_PREFIX):]] = tempAts } return } func (rs *RedisStorage) GetDerivedChargers(key string, checkDb bool) (dcs utils.DerivedChargers, err error) { key = DERIVEDCHARGERS_PREFIX + key if x, err := cache2go.GetCached(key); err == nil { return x.(utils.DerivedChargers), nil } if !checkDb { return nil, errors.New(utils.ERR_NOT_FOUND) } var values []byte if values, err = rs.db.Get(key); err == nil { err = rs.ms.Unmarshal(values, &dcs) cache2go.Cache(key, dcs) } return dcs, err } func (rs *RedisStorage) SetDerivedChargers(key string, dcs utils.DerivedChargers) (err error) { if len(dcs) == 0 { _, err = rs.db.Del(DERIVEDCHARGERS_PREFIX + key) return err } marshaled, err := rs.ms.Marshal(dcs) err = rs.db.Set(DERIVEDCHARGERS_PREFIX+key, marshaled) return err } func (rs *RedisStorage) LogCallCost(cgrid, source, runid string, cc *CallCost) (err error) { var result []byte result, err = rs.ms.Marshal(cc) if err != nil { return } err = rs.db.Set(LOG_CALL_COST_PREFIX+source+runid+"_"+cgrid, result) return } func (rs *RedisStorage) GetCallCostLog(cgrid, source, runid string) (cc *CallCost, err error) { var values []byte if values, err = rs.db.Get(LOG_CALL_COST_PREFIX + source + runid + "_" + cgrid); err == nil { err = rs.ms.Unmarshal(values, cc) } return } func (rs *RedisStorage) LogActionTrigger(ubId, source string, at *ActionTrigger, as Actions) (err error) { mat, err := rs.ms.Marshal(at) if err != nil { return } mas, err := rs.ms.Marshal(as) if err != nil { return } rs.db.Set(LOG_ACTION_TRIGGER_PREFIX+source+"_"+time.Now().Format(time.RFC3339Nano), []byte(fmt.Sprintf("%v*%v*%v", ubId, string(mat), string(mas)))) return } func (rs *RedisStorage) LogActionTiming(source string, at *ActionTiming, as Actions) (err error) { mat, err := rs.ms.Marshal(at) if err != nil { return } mas, err := rs.ms.Marshal(as) if err != nil { return } err = rs.db.Set(LOG_ACTION_TIMMING_PREFIX+source+"_"+time.Now().Format(time.RFC3339Nano), []byte(fmt.Sprintf("%v*%v", string(mat), string(mas)))) return } func (rs *RedisStorage) LogError(uuid, source, runid, errstr string) (err error) { err = rs.db.Set(LOG_ERR+source+runid+"_"+uuid, []byte(errstr)) return }