cgrates/sessionmanager/fssessionmanager.go

/*
Rating system designed to be used in VoIP Carriers World
Copyright (C) 2012  Radu Ioan Fericean

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 sessionmanager

import (
	"bufio"
	"errors"
	"fmt"
	"github.com/cgrates/cgrates/timespans"
	"net"
	"time"
)

// The freeswitch session manager type holding a buffer for the network connection,
// the active sessions, and a session delegate doing specific actions on every session.
type FSSessionManager struct {
	conn            net.Conn
	buf             *bufio.Reader
	sessions        []*Session
	sessionDelegate *SessionDelegate
	loggerDB        timespans.DataStorage
	address, pass   string
	delayFunc       func() int
}

func NewFSSessionManager(storage timespans.DataStorage) *FSSessionManager {
	return &FSSessionManager{loggerDB: storage}
}

// Connects to the freeswitch mod_event_socket server and starts
// listening for events in json format.
func (sm *FSSessionManager) Connect(ed *SessionDelegate, address, pass string) error {
	if ed == nil {
		timespans.Logger.Crit("Please provide a non nil SessionDelegate")
		return errors.New("nil session delegate")
	}
	sm.sessionDelegate = ed
	sm.address = address
	sm.pass = pass
	if sm.conn != nil {
		// in case it is a reconnect
		sm.conn.Close()
	}
	conn, err := net.Dial("tcp", address)
	if err != nil {
		timespans.Logger.Warning("Could not connect to freeswitch server!")
		return err
	}
	sm.conn = conn
	sm.buf = bufio.NewReaderSize(conn, 8192)
	fmt.Fprint(conn, fmt.Sprintf("auth %s\n\n", pass))
	fmt.Fprint(conn, "event json  HEARTBEAT CHANNEL_ANSWER CHANNEL_HANGUP_COMPLETE CHANNEL_PARK\n\n")
	fmt.Fprint(conn, "filter Call-Direction inbound\n\n")
	go func() {
		sm.delayFunc = fib()
		exitChan := make(chan bool)
		for {
			select {
			case <-exitChan:
				break
			default:
				sm.readNextEvent(exitChan)
			}
		}
	}()
	return nil
}

// Reads from freeswitch server buffer until it encounters a '}',
// than it creates an event object and calls the appropriate method
// on the session delegate.
func (sm *FSSessionManager) readNextEvent(exitChan chan bool) (ev Event) {
	body, err := sm.buf.ReadString('}')
	if err != nil {
		timespans.Logger.Warning("Could not read from freeswitch connection!")
		// wait until a sec
		time.Sleep(time.Duration(sm.delayFunc()) * time.Second)
		// try to reconnect
		err = sm.Connect(sm.sessionDelegate, sm.address, sm.pass)
		if err == nil {
			timespans.Logger.Info("Successfuly reconnected to freeswitch! ")
			exitChan <- true
		}
	}
	ev = new(FSEvent).New(body)
	switch ev.GetName() {
	case HEARTBEAT:
		sm.OnHeartBeat(ev)
	case PARK:
		sm.OnChannelPark(ev)
	case ANSWER:
		sm.OnChannelAnswer(ev)
	case HANGUP:
		sm.OnChannelHangupComplete(ev)
	default:
		sm.OnOther(ev)
	}
	return
}

// Searches and return the session with the specifed uuid
func (sm *FSSessionManager) GetSession(uuid string) *Session {
	for _, s := range sm.sessions {
		if s.uuid == uuid {
			return s
		}
	}
	return nil
}

// Disconnects a session by sending hangup command to freeswitch
func (sm *FSSessionManager) DisconnectSession(s *Session) {
	fmt.Fprint(sm.conn, fmt.Sprintf("SendMsg %s\ncall-command: hangup\nhangup-cause: MANAGER_REQUEST\n\n", s.uuid))
	s.Close()
}

// Sends the transfer command to unpark the call to freeswitch
func (sm *FSSessionManager) UnparkCall(uuid, call_dest_nb, reply string) {
	fmt.Fprint(sm.conn, fmt.Sprintf("api uuid_setvar %s cgr_notify %s\n\n", uuid, reply))
	fmt.Fprint(sm.conn, fmt.Sprintf("api uuid_transfer %s %s\n\n", uuid, call_dest_nb))
}

// Called on freeswitch's hearbeat event
func (sm *FSSessionManager) OnHeartBeat(ev Event) {
	if sm.sessionDelegate != nil {
		sm.sessionDelegate.OnHeartBeat(ev)
	} else {
		timespans.Logger.Info("♥")
	}
}

// Called on freeswitch's answer event
func (sm *FSSessionManager) OnChannelPark(ev Event) {
	if sm.sessionDelegate != nil {
		sm.sessionDelegate.OnChannelPark(ev, sm)
	} else {
		timespans.Logger.Info("park")
	}
}

// Called on freeswitch's answer event
func (sm *FSSessionManager) OnChannelAnswer(ev Event) {
	if sm.sessionDelegate != nil {
		s := NewSession(ev, sm)
		if s != nil {
			sm.sessions = append(sm.sessions, s)
			sm.sessionDelegate.OnChannelAnswer(ev, s)
		}
	} else {
		timespans.Logger.Info("answer")
	}
}

// Called on freeswitch's hangup event
func (sm *FSSessionManager) OnChannelHangupComplete(ev Event) {
	s := sm.GetSession(ev.GetUUID())
	if sm.sessionDelegate != nil {
		sm.sessionDelegate.OnChannelHangupComplete(ev, s)
		s.SaveOperations()
	} else {
		timespans.Logger.Info("HangupComplete")
	}
	if s != nil {

		s.Close()
	}
}

// Called on freeswitch's events not processed by the session manger,
// for logging purposes (maybe).
func (sm *FSSessionManager) OnOther(ev Event) {
	//log.Printf("Other event: %s", ev.GetName())
}

func (sm *FSSessionManager) GetSessionDelegate() *SessionDelegate {
	return sm.sessionDelegate
}

func (sm *FSSessionManager) GetDbLogger() timespans.DataStorage {
	return sm.loggerDB
}

// successive Fibonacci numbers.
func fib() func() int {
	a, b := 0, 1
	return func() int {
		a, b = b, a+b
		return a
	}
}