/* 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 */ package engine import ( "database/sql" "fmt" "os" "path" "strings" "github.com/cgrates/birpc/context" "github.com/cgrates/cgrates/utils" "gorm.io/gorm" ) type SQLImpl interface { extraFieldsExistsQry(string) string extraFieldsValueQry(string, string) string notExtraFieldsExistsQry(string) string notExtraFieldsValueQry(string, string) string } type SQLStorage struct { DB *sql.DB db *gorm.DB StorDB SQLImpl } func (sqls *SQLStorage) Close() { sqls.DB.Close() // sqls.db } func (sqls *SQLStorage) ExportGormDB() *gorm.DB { return sqls.db } func (sqls *SQLStorage) Flush(scriptsPath string) (err error) { for _, scriptName := range []string{utils.CreateCDRsTablesSQL, utils.CreateTariffPlanTablesSQL} { if err := sqls.CreateTablesFromScript(path.Join(scriptsPath, scriptName)); err != nil { return err } } if _, err := sqls.DB.Query(fmt.Sprintf("SELECT 1 FROM %s", utils.CDRsTBL)); err != nil { return err } return nil } func (sqls *SQLStorage) SelectDatabase(dbName string) (err error) { return } func (sqls *SQLStorage) GetKeysForPrefix(ctx *context.Context, prefix string) ([]string, error) { return nil, utils.ErrNotImplemented } func (sqls *SQLStorage) CreateTablesFromScript(scriptPath string) error { fileContent, err := os.ReadFile(scriptPath) if err != nil { return err } qries := strings.Split(string(fileContent), ";") // Script has normally multiple queries separate by ';' go driver does not understand this so we handle it here for _, qry := range qries { qry = strings.TrimSpace(qry) // Avoid empty queries if len(qry) == 0 { continue } if _, err := sqls.DB.Exec(qry); err != nil { return err } } return nil } func (sqls *SQLStorage) IsDBEmpty() (resp bool, err error) { tbls := []string{ utils.TBLTPResources, utils.TBLTPStats, utils.TBLTPThresholds, utils.TBLTPFilters, utils.SessionCostsTBL, utils.CDRsTBL, utils.TBLVersions, utils.TBLTPRoutes, utils.TBLTPAttributes, utils.TBLTPChargers, utils.TBLTPDispatchers, utils.TBLTPDispatcherHosts, } for _, tbl := range tbls { if sqls.db.Migrator().HasTable(tbl) { return false, nil } } return true, nil } // update // Return a list with all TPids defined in the system, even if incomplete, isolated in some table. func (sqls *SQLStorage) GetTpIds(colName string) ([]string, error) { var rows *sql.Rows var err error var qryStr string if colName == "" { for _, clNm := range []string{ utils.TBLTPResources, utils.TBLTPStats, utils.TBLTPThresholds, utils.TBLTPFilters, utils.TBLTPRoutes, utils.TBLTPAttributes, utils.TBLTPChargers, utils.TBLTPDispatchers, utils.TBLTPDispatcherHosts, } { qryStr += fmt.Sprintf("UNION (SELECT tpid FROM %s)", clNm) } qryStr = strings.TrimPrefix(qryStr, "UNION ") } else { qryStr = fmt.Sprintf("(SELECT tpid FROM %s)", colName) } rows, err = sqls.DB.Query(qryStr) if err != nil { return nil, err } defer rows.Close() ids := make([]string, 0) i := 0 for rows.Next() { i++ //Keep here a reference so we know we got at least one var id string err = rows.Scan(&id) if err != nil { return nil, err } ids = append(ids, id) } if i == 0 { return nil, nil } return ids, nil } // ToDo: TEST func (sqls *SQLStorage) GetTpTableIds(tpid, table string, distinct []string, filters map[string]string, pagination *utils.PaginatorWithSearch) ([]string, error) { qry := fmt.Sprintf("SELECT DISTINCT %s FROM %s where tpid='%s'", strings.Join(distinct, utils.FieldsSep), table, tpid) for key, value := range filters { if key != "" && value != "" { qry += fmt.Sprintf(" AND %s='%s'", key, value) } } if pagination != nil { if len(pagination.Search) != 0 { qry += fmt.Sprintf(" AND (%s LIKE '%%%s%%'", distinct[0], pagination.Search) for _, d := range distinct[1:] { qry += fmt.Sprintf(" OR %s LIKE '%%%s%%'", d, pagination.Search) } qry += ")" } if pagination.Paginator != nil { if pagination.Limit != nil { // Keep Postgres compatibility by adding offset only when limit defined qry += fmt.Sprintf(" LIMIT %d", *pagination.Limit) if pagination.Offset != nil { qry += fmt.Sprintf(" OFFSET %d", *pagination.Offset) } } } } rows, err := sqls.DB.Query(qry) if err != nil { return nil, err } defer rows.Close() ids := []string{} i := 0 for rows.Next() { i++ //Keep here a reference so we know we got at least one cols, err := rows.Columns() // Get the column names; remember to check err if err != nil { return nil, err } vals := make([]string, len(cols)) // Allocate enough values ints := make([]interface{}, len(cols)) // Make a slice of []interface{} for i := range ints { ints[i] = &vals[i] // Copy references into the slice } err = rows.Scan(ints...) if err != nil { return nil, err } finalID := vals[0] if len(vals) > 1 { finalID = strings.Join(vals, utils.ConcatenatedKeySep) } ids = append(ids, finalID) } if i == 0 { return nil, nil } return ids, nil } func (sqls *SQLStorage) RemTpData(table, tpid string, args map[string]string) error { tx := sqls.db.Begin() if len(table) == 0 { // Remove tpid out of all tables for _, tblName := range []string{ utils.TBLTPResources, utils.TBLTPStats, utils.TBLTPThresholds, utils.TBLTPFilters, utils.TBLTPRoutes, utils.TBLTPAttributes, utils.TBLTPChargers, utils.TBLTPDispatchers, utils.TBLTPDispatcherHosts, utils.TBLTPAccounts, utils.TBLTPActionProfiles, utils.TBLTPRateProfiles} { if err := tx.Table(tblName).Where("tpid = ?", tpid).Delete(nil).Error; err != nil { tx.Rollback() return err } } tx.Commit() return nil } // Remove from a single table tx = tx.Table(table).Where("tpid = ?", tpid) // Compose filters for key, value := range args { tx = tx.Where(key+" = ?", value) } if err := tx.Delete(nil).Error; err != nil { tx.Rollback() return err } tx.Commit() return nil } func (sqls *SQLStorage) SetTPResources(rls []*utils.TPResourceProfile) error { if len(rls) == 0 { return nil } tx := sqls.db.Begin() for _, rl := range rls { // Remove previous if err := tx.Where(&ResourceMdl{Tpid: rl.TPid, ID: rl.ID}).Delete(ResourceMdl{}).Error; err != nil { tx.Rollback() return err } for _, mrl := range APItoModelResource(rl) { if err := tx.Create(&mrl).Error; err != nil { tx.Rollback() return err } } } tx.Commit() return nil } func (sqls *SQLStorage) SetTPStats(sts []*utils.TPStatProfile) error { if len(sts) == 0 { return nil } tx := sqls.db.Begin() for _, stq := range sts { // Remove previous if err := tx.Where(&StatMdl{Tpid: stq.TPid, ID: stq.ID}).Delete(StatMdl{}).Error; err != nil { tx.Rollback() return err } for _, mst := range APItoModelStats(stq) { if err := tx.Create(&mst).Error; err != nil { tx.Rollback() return err } } } tx.Commit() return nil } func (sqls *SQLStorage) SetTPThresholds(ths []*utils.TPThresholdProfile) error { if len(ths) == 0 { return nil } tx := sqls.db.Begin() for _, th := range ths { // Remove previous if err := tx.Where(&ThresholdMdl{Tpid: th.TPid, ID: th.ID}).Delete(ThresholdMdl{}).Error; err != nil { tx.Rollback() return err } for _, mst := range APItoModelTPThreshold(th) { if err := tx.Create(&mst).Error; err != nil { tx.Rollback() return err } } } tx.Commit() return nil } func (sqls *SQLStorage) SetTPFilters(ths []*utils.TPFilterProfile) error { if len(ths) == 0 { return nil } tx := sqls.db.Begin() for _, th := range ths { // Remove previous if err := tx.Where(&FilterMdl{Tpid: th.TPid, ID: th.ID}).Delete(FilterMdl{}).Error; err != nil { tx.Rollback() return err } for _, mst := range APItoModelTPFilter(th) { if err := tx.Create(&mst).Error; err != nil { tx.Rollback() return err } } } tx.Commit() return nil } func (sqls *SQLStorage) SetTPRoutes(tpRoutes []*utils.TPRouteProfile) error { if len(tpRoutes) == 0 { return nil } tx := sqls.db.Begin() for _, tpRoute := range tpRoutes { // Remove previous if err := tx.Where(&RouteMdl{Tpid: tpRoute.TPid, ID: tpRoute.ID}).Delete(RouteMdl{}).Error; err != nil { tx.Rollback() return err } for _, mst := range APItoModelTPRoutes(tpRoute) { if err := tx.Create(&mst).Error; err != nil { tx.Rollback() return err } } } tx.Commit() return nil } func (sqls *SQLStorage) SetTPAttributes(tpAttrs []*utils.TPAttributeProfile) error { if len(tpAttrs) == 0 { return nil } tx := sqls.db.Begin() for _, stq := range tpAttrs { // Remove previous if err := tx.Where(&AttributeMdl{Tpid: stq.TPid, ID: stq.ID}).Delete(AttributeMdl{}).Error; err != nil { tx.Rollback() return err } for _, mst := range APItoModelTPAttribute(stq) { if err := tx.Create(&mst).Error; err != nil { tx.Rollback() return err } } } tx.Commit() return nil } func (sqls *SQLStorage) SetTPChargers(tpCPPs []*utils.TPChargerProfile) error { if len(tpCPPs) == 0 { return nil } tx := sqls.db.Begin() for _, cpp := range tpCPPs { // Remove previous if err := tx.Where(&ChargerMdl{Tpid: cpp.TPid, ID: cpp.ID}).Delete(ChargerMdl{}).Error; err != nil { tx.Rollback() return err } for _, mst := range APItoModelTPCharger(cpp) { if err := tx.Create(&mst).Error; err != nil { tx.Rollback() return err } } } tx.Commit() return nil } func (sqls *SQLStorage) SetTPDispatcherProfiles(tpDPPs []*utils.TPDispatcherProfile) error { if len(tpDPPs) == 0 { return nil } tx := sqls.db.Begin() for _, dpp := range tpDPPs { // Remove previous if err := tx.Where(&DispatcherProfileMdl{Tpid: dpp.TPid, ID: dpp.ID}).Delete(DispatcherProfileMdl{}).Error; err != nil { tx.Rollback() return err } for _, mst := range APItoModelTPDispatcherProfile(dpp) { if err := tx.Create(&mst).Error; err != nil { tx.Rollback() return err } } } tx.Commit() return nil } func (sqls *SQLStorage) SetTPDispatcherHosts(tpDPPs []*utils.TPDispatcherHost) error { if len(tpDPPs) == 0 { return nil } tx := sqls.db.Begin() for _, dpp := range tpDPPs { // Remove previous if err := tx.Where(&DispatcherHostMdl{Tpid: dpp.TPid, ID: dpp.ID}).Delete(DispatcherHostMdl{}).Error; err != nil { tx.Rollback() return err } if err := tx.Create(APItoModelTPDispatcherHost(dpp)).Error; err != nil { tx.Rollback() return err } } tx.Commit() return nil } func (sqls *SQLStorage) SetTPRateProfiles(tpDPPs []*utils.TPRateProfile) error { if len(tpDPPs) == 0 { return nil } tx := sqls.db.Begin() for _, dpp := range tpDPPs { // Remove previous if err := tx.Where(&RateProfileMdl{Tpid: dpp.TPid, ID: dpp.ID}).Delete(RateProfileMdl{}).Error; err != nil { tx.Rollback() return err } for _, mst := range APItoModelTPRateProfile(dpp) { if err := tx.Create(&mst).Error; err != nil { tx.Rollback() return err } } } tx.Commit() return nil } func (sqls *SQLStorage) SetTPActionProfiles(tpAps []*utils.TPActionProfile) error { if len(tpAps) == 0 { return nil } tx := sqls.db.Begin() for _, tpAp := range tpAps { // Remove previous if err := tx.Where(&ActionProfileMdl{Tpid: tpAp.TPid, Tenant: tpAp.Tenant, ID: tpAp.ID}).Delete(ActionProfileMdl{}).Error; err != nil { tx.Rollback() return err } for _, mst := range APItoModelTPActionProfile(tpAp) { if err := tx.Create(&mst).Error; err != nil { tx.Rollback() return err } } } tx.Commit() return nil } func (sqls *SQLStorage) SetTPAccounts(tpAps []*utils.TPAccount) error { if len(tpAps) == 0 { return nil } tx := sqls.db.Begin() for _, tpAp := range tpAps { // Remove previous if err := tx.Where(&AccountMdl{Tpid: tpAp.TPid, Tenant: tpAp.Tenant, ID: tpAp.ID}).Delete(AccountMdl{}).Error; err != nil { tx.Rollback() return err } for _, mst := range APItoModelTPAccount(tpAp) { if err := tx.Create(&mst).Error; err != nil { tx.Rollback() return err } } } tx.Commit() return nil } func (sqls *SQLStorage) GetTPResources(tpid, tenant, id string) ([]*utils.TPResourceProfile, error) { var rls ResourceMdls q := sqls.db.Where("tpid = ?", tpid) if len(id) != 0 { q = q.Where("id = ?", id) } if len(tenant) != 0 { q = q.Where("tenant = ?", tenant) } if err := q.Find(&rls).Error; err != nil { return nil, err } arls := rls.AsTPResources() if len(arls) == 0 { return arls, utils.ErrNotFound } return arls, nil } func (sqls *SQLStorage) GetTPStats(tpid, tenant, id string) ([]*utils.TPStatProfile, error) { var sts StatMdls q := sqls.db.Where("tpid = ?", tpid) if len(id) != 0 { q = q.Where("id = ?", id) } if len(tenant) != 0 { q = q.Where("tenant = ?", tenant) } if err := q.Find(&sts).Error; err != nil { return nil, err } asts := sts.AsTPStats() if len(asts) == 0 { return asts, utils.ErrNotFound } return asts, nil } func (sqls *SQLStorage) GetTPThresholds(tpid, tenant, id string) ([]*utils.TPThresholdProfile, error) { var ths ThresholdMdls q := sqls.db.Where("tpid = ?", tpid) if len(id) != 0 { q = q.Where("id = ?", id) } if len(tenant) != 0 { q = q.Where("tenant = ?", tenant) } if err := q.Find(&ths).Error; err != nil { return nil, err } aths := ths.AsTPThreshold() if len(aths) == 0 { return aths, utils.ErrNotFound } return aths, nil } func (sqls *SQLStorage) GetTPFilters(tpid, tenant, id string) ([]*utils.TPFilterProfile, error) { var ths FilterMdls q := sqls.db.Where("tpid = ?", tpid) if len(id) != 0 { q = q.Where("id = ?", id) } if len(tenant) != 0 { q = q.Where("tenant = ?", tenant) } if err := q.Find(&ths).Error; err != nil { return nil, err } aths := ths.AsTPFilter() if len(aths) == 0 { return aths, utils.ErrNotFound } return aths, nil } func (sqls *SQLStorage) GetTPRoutes(tpid, tenant, id string) ([]*utils.TPRouteProfile, error) { var tpRoutes RouteMdls q := sqls.db.Where("tpid = ?", tpid) if len(id) != 0 { q = q.Where("id = ?", id) } if len(tenant) != 0 { q = q.Where("tenant = ?", tenant) } if err := q.Find(&tpRoutes).Error; err != nil { return nil, err } aTpRoutes := tpRoutes.AsTPRouteProfile() if len(aTpRoutes) == 0 { return aTpRoutes, utils.ErrNotFound } return aTpRoutes, nil } func (sqls *SQLStorage) GetTPAttributes(tpid, tenant, id string) ([]*utils.TPAttributeProfile, error) { var sps AttributeMdls q := sqls.db.Where("tpid = ?", tpid) if len(id) != 0 { q = q.Where("id = ?", id) } if len(tenant) != 0 { q = q.Where("tenant = ?", tenant) } if err := q.Find(&sps).Error; err != nil { return nil, err } arls := sps.AsTPAttributes() if len(arls) == 0 { return arls, utils.ErrNotFound } return arls, nil } func (sqls *SQLStorage) GetTPChargers(tpid, tenant, id string) ([]*utils.TPChargerProfile, error) { var cpps ChargerMdls q := sqls.db.Where("tpid = ?", tpid) if len(id) != 0 { q = q.Where("id = ?", id) } if len(tenant) != 0 { q = q.Where("tenant = ?", tenant) } if err := q.Find(&cpps).Error; err != nil { return nil, err } arls := cpps.AsTPChargers() if len(arls) == 0 { return arls, utils.ErrNotFound } return arls, nil } func (sqls *SQLStorage) GetTPDispatcherProfiles(tpid, tenant, id string) ([]*utils.TPDispatcherProfile, error) { var dpps DispatcherProfileMdls q := sqls.db.Where("tpid = ?", tpid) if len(id) != 0 { q = q.Where("id = ?", id) } if len(tenant) != 0 { q = q.Where("tenant = ?", tenant) } if err := q.Find(&dpps).Error; err != nil { return nil, err } arls := dpps.AsTPDispatcherProfiles() if len(arls) == 0 { return arls, utils.ErrNotFound } return arls, nil } func (sqls *SQLStorage) GetTPDispatcherHosts(tpid, tenant, id string) ([]*utils.TPDispatcherHost, error) { var dpps DispatcherHostMdls q := sqls.db.Where("tpid = ?", tpid) if len(id) != 0 { q = q.Where("id = ?", id) } if len(tenant) != 0 { q = q.Where("tenant = ?", tenant) } if err := q.Find(&dpps).Error; err != nil { return nil, err } arls, err := dpps.AsTPDispatcherHosts() if err != nil { return nil, err } if len(arls) == 0 { return arls, utils.ErrNotFound } return arls, nil } func (sqls *SQLStorage) GetTPRateProfiles(tpid, tenant, id string) ([]*utils.TPRateProfile, error) { var dpps RateProfileMdls q := sqls.db.Where("tpid = ?", tpid) if len(id) != 0 { q = q.Where("id = ?", id) } if len(tenant) != 0 { q = q.Where("tenant = ?", tenant) } if err := q.Find(&dpps).Error; err != nil { return nil, err } arls := dpps.AsTPRateProfile() if len(arls) == 0 { return arls, utils.ErrNotFound } return arls, nil } func (sqls *SQLStorage) GetTPActionProfiles(tpid, tenant, id string) ([]*utils.TPActionProfile, error) { var dpps ActionProfileMdls q := sqls.db.Where("tpid = ?", tpid) if len(id) != 0 { q = q.Where("id = ?", id) } if len(tenant) != 0 { q = q.Where("tenant = ?", tenant) } if err := q.Find(&dpps).Error; err != nil { return nil, err } arls := dpps.AsTPActionProfile() if len(arls) == 0 { return arls, utils.ErrNotFound } return arls, nil } func (sqls *SQLStorage) GetTPAccounts(tpid, tenant, id string) ([]*utils.TPAccount, error) { var dpps AccountMdls q := sqls.db.Where("tpid = ?", tpid) if len(id) != 0 { q = q.Where("id = ?", id) } if len(tenant) != 0 { q = q.Where("tenant = ?", tenant) } if err := q.Find(&dpps).Error; err != nil { return nil, err } arls, err := dpps.AsTPAccount() if err != nil { return nil, err } else if len(arls) == 0 { return arls, utils.ErrNotFound } return arls, nil } // GetVersions returns slice of all versions or a specific version if tag is specified func (sqls *SQLStorage) GetVersions(itm string) (vrs Versions, err error) { q := sqls.db.Model(&TBLVersion{}) if itm != utils.TBLVersions && itm != "" { q = sqls.db.Where(&TBLVersion{Item: itm}) } var verModels []*TBLVersion if err = q.Find(&verModels).Error; err != nil { return } vrs = make(Versions) for _, verModel := range verModels { vrs[verModel.Item] = verModel.Version } if len(vrs) == 0 { return nil, utils.ErrNotFound } return } // RemoveVersions will remove specific versions out of storage func (sqls *SQLStorage) RemoveVersions(vrs Versions) (err error) { if len(vrs) == 0 { // Remove all if no key provided err = sqls.db.Delete(TBLVersion{}).Error return } tx := sqls.db.Begin() for key := range vrs { if err = tx.Where(&TBLVersion{Item: key}).Delete(TBLVersion{}).Error; err != nil { tx.Rollback() return } } tx.Commit() return }