// Read config information.
void SipRedirectorUserParam::readConfig(OsConfigDb& configDb)
{
mStripAll = configDb.getBoolean( StripAllUserParam, false );
OsSysLog::add(FAC_SIP, PRI_INFO,
"%s::readConfig '%s' = %s",
mLogName.data(), StripAllUserParam,
mStripAll ? "TRUE" : "FALSE");
}
// Read config information.
void SipRedirectorAliasDB::readConfig(OsConfigDb& configDb)
{
// read the domain configuration
OsConfigDb domainConfiguration;
domainConfiguration.loadFromFile(SipXecsService::domainConfigPath());
// get the shared secret for generating signatures
SharedSecret secret(domainConfiguration);
// Set secret for signing SipXauthIdentity
SipXauthIdentity::setSecret(secret.data());
UtlString base64;
NetBase64Codec::encode(secret, base64);
Os::Logger::instance().log(FAC_SIP, PRI_DEBUG,
"SipRedirectorAliasDB::readConfig"
"%s::readConfig "
"set SipXauthIdentity secret",
mLogName.data()
);
_enableDiversionHeader = configDb.getBoolean("SIP_REGISTRAR_ADD_DIVERSION", FALSE);
_enableEarlyAliasResolution = configDb.getBoolean("SIP_REGISTRAR_EARLY_ALIAS_RESOLUTION", FALSE);
}
//
// The main entry point to the sipXpark
//
int main(int argc, char* argv[])
{
// Block all signals in this the main thread.
// Any threads created from now on will have all signals masked.
OsTask::blockSignals();
// Create a new task to wait for signals. Only that task
// will ever see a signal from the outside.
SignalTask* signalTask = new SignalTask();
signalTask->start();
// Configuration Database (used for OsSysLog)
OsConfigDb configDb;
UtlString argString;
for(int argIndex = 1; argIndex < argc; argIndex++)
{
osPrintf("arg[%d]: %s\n", argIndex, argv[argIndex]);
argString = argv[argIndex];
NameValueTokenizer::frontBackTrim(&argString, "\t ");
if(argString.compareTo("-v") == 0)
{
osPrintf("Version: %s (%s)\n", SIPX_VERSION, SIPX_BUILD);
return(1);
} else
{
osPrintf("usage: %s [-v]\nwhere:\n -v provides the software version\n",
argv[0]);
return(1);
}
}
// Load configuration file file
OsPath workingDirectory;
if (OsFileSystem::exists(CONFIG_ETC_DIR))
{
workingDirectory = CONFIG_ETC_DIR;
OsPath path(workingDirectory);
path.getNativePath(workingDirectory);
} else
{
OsPath path;
OsFileSystem::getWorkingDirectory(path);
path.getNativePath(workingDirectory);
}
UtlString fileName = workingDirectory +
OsPathBase::separator +
CONFIG_SETTINGS_FILE;
if (configDb.loadFromFile(fileName) != OS_SUCCESS)
{
exit(1);
}
// Initialize log file
initSysLog(&configDb);
// Read the user agent parameters from the config file.
int UdpPort;
if (configDb.get(CONFIG_SETTING_UDP_PORT, UdpPort) != OS_SUCCESS)
UdpPort = PARK_DEFAULT_UDP_PORT;
int TcpPort;
if (configDb.get(CONFIG_SETTING_TCP_PORT, TcpPort) != OS_SUCCESS)
TcpPort = PARK_DEFAULT_TCP_PORT;
int RtpBase;
if (configDb.get(CONFIG_SETTING_RTP_PORT, RtpBase) != OS_SUCCESS)
RtpBase = DEFAULT_RTP_PORT;
UtlString bindIp;
if (configDb.get(CONFIG_SETTING_BIND_IP, bindIp) != OS_SUCCESS ||
!OsSocket::isIp4Address(bindIp))
bindIp = PARK_DEFAULT_BIND_IP;
int MaxSessions;
if (configDb.get(CONFIG_SETTING_MAX_SESSIONS, MaxSessions) != OS_SUCCESS)
{
MaxSessions = DEFAULT_MAX_SESSIONS;
}
UtlBoolean OneButtonBLF =
configDb.getBoolean(CONFIG_SETTING_ONE_BUTTON_BLF, DEFAULT_ONE_BUTTON_BLF);
UtlString domain;
UtlString realm;
UtlString user;
SipLine* line = NULL;
SipLineMgr* lineMgr = NULL;
OsConfigDb domainConfiguration;
OsPath domainConfigPath = SipXecsService::domainConfigPath();
if (OS_SUCCESS == domainConfiguration.loadFromFile(domainConfigPath.data()))
{
domainConfiguration.get(SipXecsService::DomainDbKey::SIP_DOMAIN_NAME, domain);
domainConfiguration.get(SipXecsService::DomainDbKey::SIP_REALM, realm);
if (!domain.isNull() && !realm.isNull())
{
CredentialDB* credentialDb;
if ((credentialDb = CredentialDB::getInstance()))
{
Url identity;
identity.setUserId(PARK_SERVER_ID_TOKEN);
identity.setHostAddress(domain);
UtlString ha1_authenticator;
UtlString authtype;
if (credentialDb->getCredential(identity, realm, user, ha1_authenticator, authtype))
{
if ((line = new SipLine( identity // user entered url
,identity // identity url
,user // user
,TRUE // visible
,SipLine::LINE_STATE_PROVISIONED
,TRUE // auto enable
,FALSE // use call handling
)))
{
if ((lineMgr = new SipLineMgr()))
{
if (lineMgr->addLine(*line))
{
if (lineMgr->addCredentialForLine( identity, realm, user, ha1_authenticator
,HTTP_DIGEST_AUTHENTICATION
)
)
{
OsSysLog::add(LOG_FACILITY, PRI_INFO,
"Added identity '%s': user='******' realm='%s'"
,identity.toString().data(), user.data(), realm.data()
);
}
else
{
OsSysLog::add(LOG_FACILITY, PRI_ERR,
"Error adding identity '%s': user='******' realm='%s'\n"
" escape and timeout from park may not work.",
identity.toString().data(), user.data(), realm.data()
);
}
lineMgr->setDefaultOutboundLine(identity);
} // end addLine
else
{
OsSysLog::add(LOG_FACILITY, PRI_ERR,
"addLine failed: "
" escape and timeout from park may not work."
);
}
}
else
{
OsSysLog::add(LOG_FACILITY, PRI_ERR,
"Constructing SipLineMgr failed: "
" escape and timeout from park may not work."
);
}
} // end new SipLine
else
{
OsSysLog::add(LOG_FACILITY, PRI_ERR,
"Constructing SipLine failed: "
" escape and timeout from park may not work."
);
}
} // end getCredential
else
{
OsSysLog::add(LOG_FACILITY, PRI_ERR,
"No credential found for '%s@%s' in realm '%s'"
"; transfer functions will not work",
PARK_SERVER_ID_TOKEN, domain.data(), realm.data()
);
}
credentialDb->releaseInstance();
} // end credentialDB
else
{
OsSysLog::add(LOG_FACILITY, PRI_ERR,
"Failed to open credentials database"
"; transfer functions will not work"
);
}
} // end have domain and realm
else
{
OsSysLog::add(LOG_FACILITY, PRI_ERR,
"Domain or Realm not configured:"
"\n '%s' : '%s'\n '%s' : '%s'"
" transfer functions will not work.",
SipXecsService::DomainDbKey::SIP_DOMAIN_NAME, domain.data(),
SipXecsService::DomainDbKey::SIP_REALM, realm.data()
);
}
} // end found domain config
else
{
OsSysLog::add(LOG_FACILITY, PRI_ERR,
"main: failed to load domain configuration from '%s'",
domainConfigPath.data()
);
}
// Read Park Server parameters from the config file.
int Lifetime, BlindXferWait, KeepAliveTime, ConsXferWait;
if (configDb.get(CONFIG_SETTING_LIFETIME, Lifetime) != OS_SUCCESS)
{
Lifetime = DEFAULT_LIFETIME;
}
if (configDb.get(CONFIG_SETTING_BLIND_WAIT, BlindXferWait) != OS_SUCCESS)
{
BlindXferWait = DEFAULT_BLIND_WAIT;
}
if (configDb.get(CONFIG_SETTING_KEEPALIVE_TIME, KeepAliveTime) != OS_SUCCESS)
{
KeepAliveTime = DEFAULT_KEEPALIVE_TIME;
}
// This is not configurable, as consultative transfers should
// succeed or fail immediately.
ConsXferWait = CONS_XFER_WAIT;
// Bind the SIP user agent to a port and start it up
SipUserAgent* userAgent = new SipUserAgent(TcpPort,
UdpPort,
TcpPort+1,
NULL, // publicAddress
user.isNull() ? NULL : user.data(), // default user
bindIp,
domain.isNull() ? NULL : domain.data(), // outbound proxy
NULL, // sipDirectoryServers (deprecated)
NULL, // sipRegistryServers (deprecated)
NULL, // authenticationScheme
NULL, // authenicateRealm
NULL, // authenticateDb
NULL, // authorizeUserIds (deprecated)
NULL, // authorizePasswords (deprecated)
lineMgr
);
userAgent->setUserAgentHeaderProperty("sipXecs/park");
userAgent->start();
if (!userAgent->isOk())
{
OsSysLog::add(LOG_FACILITY, PRI_EMERG, "SipUserAgent failed to initialize, requesting shutdown");
gShutdownFlag = TRUE;
}
// Read the list of codecs from the configuration file.
SdpCodecFactory codecFactory;
initCodecs(&codecFactory, &configDb);
// Initialize and start up the media subsystem
mpStartUp(MP_SAMPLE_RATE, MP_SAMPLES_PER_FRAME, 6 * MaxSessions, &configDb);
MpMediaTask::getMediaTask(MaxSessions);
#ifdef INCLUDE_RTCP
CRTCManager::getRTCPControl();
#endif //INCLUDE_RTCP
mpStartTasks();
// Instantiate the call processing subsystem
UtlString localAddress;
int localPort ;
userAgent->getLocalAddress(&localAddress, &localPort) ;
if (localAddress.isNull())
OsSocket::getHostIp(&localAddress);
// Construct an address to be used in outgoing requests (primarily
// INVITEs stimulated by REFERs).
UtlString outgoingAddress;
{
char buffer[100];
sprintf(buffer, "sip:sipXpark@%s:%d", localAddress.data(),
portIsValid(UdpPort) ? UdpPort : TcpPort);
outgoingAddress = buffer;
}
CallManager callManager(FALSE,
NULL,
TRUE, // early media in 180 ringing
&codecFactory,
RtpBase, // rtp start
RtpBase + (2 * MaxSessions), // rtp end
localAddress,
localAddress,
userAgent,
0, // sipSessionReinviteTimer
NULL, // mgcpStackTask
outgoingAddress, // defaultCallExtension
Connection::RING, // availableBehavior
NULL, // unconditionalForwardUrl
-1, // forwardOnNoAnswerSeconds
NULL, // forwardOnNoAnswerUrl
Connection::BUSY, // busyBehavior
NULL, // sipForwardOnBusyUrl
NULL, // speedNums
CallManager::SIP_CALL, // phonesetOutgoingCallProtocol
4, // numDialPlanDigits
CallManager::NEAR_END_HOLD, // holdType
5000, // offeringDelay
"", // pLocal
CP_MAXIMUM_RINGING_EXPIRE_SECONDS, // inviteExpiresSeconds
QOS_LAYER3_LOW_DELAY_IP_TOS, // expeditedIpTos
MaxSessions, // maxCalls
sipXmediaFactoryFactory(NULL)); // CpMediaInterfaceFactory
// Create a listener (application) to deal with call
// processing events (e.g. incoming call and hang ups)
OrbitListener listener(&callManager, Lifetime, BlindXferWait, KeepAliveTime, ConsXferWait);
callManager.addTaoListener(&listener);
listener.start();
// Create the SIP Subscribe Server
SipPersistentSubscriptionMgr
subscriptionMgr(SUBSCRIPTION_COMPONENT_PARK,
domain,
"subscription"); // Component for holding the subscription data
SipSubscribeServerEventHandler policyHolder; // Component for granting the subscription rights
SipPublishContentMgr publisher; // Component for publishing the event contents
SipSubscribeServer subscribeServer(*userAgent, publisher,
subscriptionMgr, policyHolder);
subscribeServer.enableEventType(DIALOG_EVENT_TYPE);
subscribeServer.start();
// Create the DialogEventPublisher.
// Use the sipX domain as the hostport of resource-IDs of the
// published events, as that will be the request-URIs of SUBSCRIBEs.
DialogEventPublisher dialogEvents(&callManager, &publisher, domain, PORT_NONE, OneButtonBLF);
callManager.addTaoListener(&dialogEvents);
dialogEvents.start();
// Start up the call processing system
callManager.start();
// Loop forever until signaled to shut down
int numTwoSecIntervals = 0;
int CleanLoopWaitTimeSecs = 10;
while (!gShutdownFlag)
{
OsTask::delay(2000);
if (2*numTwoSecIntervals >= CleanLoopWaitTimeSecs)
{
numTwoSecIntervals = 0;
if (OsSysLog::willLog(FAC_PARK, PRI_DEBUG))
{
OsSysLog::add(LOG_FACILITY, PRI_DEBUG,
"park main "
"logging call status"
);
callManager.printCalls(0) ;
listener.dumpCallsAndTransfers();
}
}
else
{
numTwoSecIntervals += 1;
}
}
// Flush the log file
OsSysLog::flush();
// Say goodnight Gracie...
return 0;
}
// Read config information.
void SipRedirectorJoin::readConfig(OsConfigDb& configDb)
{
// The return status.
// It will be OS_SUCCESS if this redirector is configured to do any work,
// and OS_FAILED if not.
mRedirectorActive = OS_FAILED;
// Fetch the configuration parameters for the workaround features.
// Defaults are set to match the previous behavior of the code.
// One-second subscriptions.
mOneSecondSubscription = configDb.getBoolean(CONFIG_SETTING_1_SEC, TRUE);
Os::Logger::instance().log(FAC_SIP, PRI_INFO,
"%s::readConfig mOneSecondSubscription = %d",
mLogName.data(), mOneSecondSubscription);
// Fetch the call join festure code from the config file.
// If it is null, it doesn't count.
if ((configDb.get(CONFIG_SETTING_JOIN_CODE, mCallJoinCode) !=
OS_SUCCESS) ||
mCallJoinCode.isNull())
{
Os::Logger::instance().log(FAC_SIP, PRI_INFO,
"%s::readConfig No call join feature code specified",
mLogName.data());
}
else
{
// Call join feature code is configured.
// Initialize the system.
Os::Logger::instance().log(FAC_SIP, PRI_INFO,
"%s::readConfig Call join feature code is '%s'",
mLogName.data(), mCallJoinCode.data());
mRedirectorActive = OS_SUCCESS;
// Record the two user-names that are excluded as being pick-up requests.
mExcludedUser1 = mCallJoinCode;
mExcludedUser1.append("*");
mExcludedUser2 = mCallJoinCode;
mExcludedUser2.append("#");
}
// Get the wait time for NOTIFYs in response to our SUBSCRIBEs.
// Set the default value, to be overridden if the user specifies a valid
// value.
mWaitSecs = DEFAULT_WAIT_TIME_SECS;
mWaitUSecs = DEFAULT_WAIT_TIME_USECS;
Os::Logger::instance().log(FAC_SIP, PRI_DEBUG,
"%s::readConfig Default wait time is %d.%06d",
mLogName.data(), mWaitSecs, mWaitUSecs);
// Fetch the parameter value.
UtlString waitUS;
float waitf;
if (configDb.get(CONFIG_SETTING_WAIT, waitUS) == OS_SUCCESS)
{
Os::Logger::instance().log(FAC_SIP, PRI_DEBUG,
"%s::readConfig " CONFIG_SETTING_WAIT " is '%s'",
mLogName.data(), waitUS.data());
// Parse the value, checking for errors.
unsigned int char_count;
sscanf(waitUS.data(), " %f %n", &waitf, &char_count);
if (char_count != waitUS.length())
{
Os::Logger::instance().log(FAC_SIP, PRI_ERR,
"%s::readConfig Invalid format for "
CONFIG_SETTING_WAIT " '%s'",
mLogName.data(), waitUS.data());
}
else if (
// Check that the value is in range.
!(waitf >= MIN_WAIT_TIME && waitf <= MAX_WAIT_TIME))
{
Os::Logger::instance().log(FAC_SIP, PRI_ERR,
"%s::readConfig " CONFIG_SETTING_WAIT
" (%f) outside allowed range (%f to %f)",
mLogName.data(), waitf, MIN_WAIT_TIME, MAX_WAIT_TIME);
}
else
{
// Extract the seconds and microseconds, being careful to round
// because the conversion from character data may have
// been inexact.
// Since waitf <= 100, usecs <= 100,000,000.
int usecs = (int)((waitf * 1000000) + 0.0000005);
mWaitSecs = usecs / 1000000;
mWaitUSecs = usecs % 1000000;
Os::Logger::instance().log(FAC_SIP, PRI_DEBUG,
"%s::readConfig Wait time is %d.%06d",
mLogName.data(), mWaitSecs, mWaitUSecs);
}
}
}
// Read config information.
void SipRedirectorPresenceRouting::readConfig(OsConfigDb& configDb)
{
// extract the realm information from the config DB - we need this part
// to do the credentials db look-up.
if ((configDb.get(CONFIG_SETTING_REALM, mRealm) != OS_SUCCESS) ||
mRealm.isNull())
{
OsSysLog::add(FAC_SIP, PRI_ERR,
"%s::readConfig No Realm specified in the configuration",
mLogName.data());
}
else
{
OsSysLog::add(FAC_SIP, PRI_INFO,
"%s::readConfig mRealm = '%s'",
mLogName.data(), mRealm.data() );
}
mbForwardToVmOnBusy = configDb.getBoolean(CONFIG_SETTING_VOICEMAIL_ON_BUSY, FALSE);
OsSysLog::add(FAC_SIP, PRI_INFO,
"%s::readConfig mbForwardToVmOnBusy = %d",
mLogName.data(), mbForwardToVmOnBusy);
UtlString prefsFilename;
configDb.get(CONFIG_SETTING_USER_PREFS_FILE, prefsFilename);
OsSysLog::add(FAC_SIP, PRI_INFO,
"%s::readConfig prefsFilename = %s",
mLogName.data(), prefsFilename.data());
mUserPrefs.loadPrefs( prefsFilename );
UtlString openFirePresenceServerUrlAsString;
if ((configDb.get(CONFIG_OPENFIRE_PRESENCE_SERVER_URL, openFirePresenceServerUrlAsString) != OS_SUCCESS) ||
openFirePresenceServerUrlAsString.isNull())
{
OsSysLog::add(FAC_SIP, PRI_ERR,
"%s::readConfig No URL specified for openfire presence server in the configuration",
mLogName.data());
}
else
{
OsSysLog::add(FAC_SIP, PRI_INFO,
"%s::readConfig openFirePresenceServerUrlAsString = '%s'",
mLogName.data(), openFirePresenceServerUrlAsString.data() );
mOpenFirePresenceServerUrl.fromString( openFirePresenceServerUrlAsString );
}
UtlString presenceMonitorServerUrlAsString;
if ((configDb.get(CONFIG_PRESENCE_MONITOR_SERVER_URL, presenceMonitorServerUrlAsString) != OS_SUCCESS) ||
presenceMonitorServerUrlAsString.isNull())
{
OsSysLog::add(FAC_SIP, PRI_ERR,
"%s::readConfig No URL specified for local presence monitor server in the configuration",
mLogName.data());
}
else
{
OsSysLog::add(FAC_SIP, PRI_INFO,
"%s::readConfig presenceMonitorServerUrlAsString = '%s'",
mLogName.data(), presenceMonitorServerUrlAsString.data() );
mLocalPresenceMonitorServerUrl.fromString( presenceMonitorServerUrlAsString );
}
}
// Read config information.
void SipRedirectorFallback::readConfig(OsConfigDb& configDb)
{
configDb.get("MAPPING_RULES_FILENAME", mFileName);
mAllowUnbound = configDb.getBoolean("ALLOW_UNBOUND", false);
}