cgrates/services/attributes.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 services

import (
	"fmt"
	"sync"

	"github.com/cgrates/birpc"
	"github.com/cgrates/birpc/context"
	"github.com/cgrates/cgrates/apis"
	"github.com/cgrates/cgrates/commonlisteners"
	"github.com/cgrates/cgrates/config"
	"github.com/cgrates/cgrates/engine"
	"github.com/cgrates/cgrates/servmanager"
	"github.com/cgrates/cgrates/utils"
)

// NewAttributeService returns the Attribute Service
func NewAttributeService(cfg *config.CGRConfig, dm *DataDBService,
	cacheS *CacheService, filterSChan chan *engine.FilterS,
	clSChan chan *commonlisteners.CommonListenerS, internalChan chan birpc.ClientConnector,
	anzChan chan *AnalyzerService, dspS *DispatcherService,
	srvDep map[string]*sync.WaitGroup, sIndxr *servmanager.ServiceIndexer) servmanager.Service {
	return &AttributeService{
		connChan:       internalChan,
		cfg:            cfg,
		dm:             dm,
		cacheS:         cacheS,
		filterSChan:    filterSChan,
		clSChan:        clSChan,
		anzChan:        anzChan,
		srvDep:         srvDep,
		dspS:           dspS,
		stateDeps:      NewStateDependencies([]string{utils.StateServiceUP}),
		serviceIndexer: sIndxr,
	}
}

// AttributeService implements Service interface
type AttributeService struct {
	sync.RWMutex

	clSChan     chan *commonlisteners.CommonListenerS
	dm          *DataDBService
	anzChan     chan *AnalyzerService
	cacheS      *CacheService
	dspS        *DispatcherService
	filterSChan chan *engine.FilterS

	attrS *engine.AttributeS
	cl    *commonlisteners.CommonListenerS
	rpc   *apis.AttributeSv1 // useful on restart

	connChan chan birpc.ClientConnector // publish the internal Subsystem when available
	cfg      *config.CGRConfig
	srvDep   map[string]*sync.WaitGroup

	intRPCconn     birpc.ClientConnector       // expose API methods over internal connection
	serviceIndexer *servmanager.ServiceIndexer // access directly services from here
	stateDeps      *StateDependencies
}

// Start should handle the service start
func (attrS *AttributeService) Start(ctx *context.Context, _ context.CancelFunc) (err error) {
	if attrS.IsRunning() {
		return utils.ErrServiceAlreadyRunning
	}
	if utils.StructChanTimeout(
		attrS.serviceIndexer.GetService(utils.CommonListenerS).StateChan(utils.StateServiceUP),
		attrS.cfg.GeneralCfg().ConnectTimeout) {
		return utils.NewServiceStateTimeoutError(utils.AttributeS, utils.CommonListenerS, utils.StateServiceUP)
	}
	attrS.cl = <-attrS.clSChan
	attrS.clSChan <- attrS.cl
	if err = attrS.cacheS.WaitToPrecache(ctx,
		utils.CacheAttributeProfiles,
		utils.CacheAttributeFilterIndexes); err != nil {
		return
	}
	var filterS *engine.FilterS
	if filterS, err = waitForFilterS(ctx, attrS.filterSChan); err != nil {
		return
	}
	var datadb *engine.DataManager
	if datadb, err = attrS.dm.WaitForDM(ctx); err != nil {
		return
	}
	anz := <-attrS.anzChan
	attrS.anzChan <- anz

	attrS.Lock()
	defer attrS.Unlock()
	attrS.attrS = engine.NewAttributeService(datadb, filterS, attrS.cfg)
	utils.Logger.Info(fmt.Sprintf("<%s> starting <%s> subsystem", utils.CoreS, utils.AttributeS))
	attrS.rpc = apis.NewAttributeSv1(attrS.attrS)
	srv, _ := engine.NewService(attrS.rpc)
	// srv, _ := birpc.NewService(attrS.rpc, "", false)
	if !attrS.cfg.DispatcherSCfg().Enabled {
		for _, s := range srv {
			attrS.cl.RpcRegister(s)
		}
	}
	dspShtdChan := attrS.dspS.RegisterShutdownChan(attrS.ServiceName())
	go func() {
		for {
			if _, closed := <-dspShtdChan; closed {
				return
			}
			if attrS.IsRunning() {
				attrS.cl.RpcRegister(srv)
			}

		}
	}()

	attrS.intRPCconn = anz.GetInternalCodec(srv, utils.AttributeS)
	attrS.connChan <- attrS.intRPCconn
	close(attrS.stateDeps.StateChan(utils.StateServiceUP)) // inform listeners about the service reaching UP state
	return
}

// Reload handles the change of config
func (attrS *AttributeService) Reload(*context.Context, context.CancelFunc) (err error) {
	return // for the moment nothing to reload
}

// Shutdown stops the service
func (attrS *AttributeService) Shutdown() (err error) {
	attrS.Lock()
	attrS.attrS.Shutdown()
	attrS.attrS = nil
	attrS.rpc = nil
	<-attrS.connChan
	attrS.cl.RpcUnregisterName(utils.AttributeSv1)
	attrS.dspS.UnregisterShutdownChan(attrS.ServiceName())
	attrS.Unlock()
	return
}

// IsRunning returns if the service is running
func (attrS *AttributeService) IsRunning() bool {
	attrS.RLock()
	defer attrS.RUnlock()
	return attrS.attrS != nil
}

// ServiceName returns the service name
func (attrS *AttributeService) ServiceName() string {
	return utils.AttributeS
}

// ShouldRun returns if the service should be running
func (attrS *AttributeService) ShouldRun() bool {
	return attrS.cfg.AttributeSCfg().Enabled
}

// StateChan returns signaling channel of specific state
func (attrS *AttributeService) StateChan(stateID string) chan struct{} {
	return attrS.stateDeps.StateChan(stateID)
}

// IntRPCConn returns the internal connection used by RPCClient
func (attrS *AttributeService) IntRPCConn() birpc.ClientConnector {
	return attrS.intRPCconn
}