Hello,
I'd like to discuss modifications i plan to make to IMWraper and
PHApiWrapper modules
First the context:
I've been hired by a client (which i can't name for the moment) to
implement following functionalities in WengoPhone 2.x
1) Sending receiving SMS using SIP MESSAGE request
2) SIP/SIMPLE compatible presence which integrates into WengoPhone 's
IMWrapper/IMPresence framework,
with client's specific extensions, and contact list stored on the
server
3) SIP Conference server based IM/Chat (Subscribe to Conference List
resourse to get the list of avalable chat sessions, then create a non
A/V session to a conference)
4) Possibility to configure certaines SIP request headers
(User-Agent,Expires,Allow... etc).
I'm only done pretty cursory analysis/design on how to do this stuff
because the real work will start in middle of April
but i've already have couple of ideas which i'd like to discuss...
I'm attaching a modified version oh PhApiWrapper.h,
my modilications are marked by V.L.
We've decided to base developpement on WengoPhone 2.0 because of tight
planned release date and instability risks in later versions.
So i'd like to have community and openwengo team input.
Thanks
Vadim
/*
* WengoPhone, a voice over Internet phone
* Copyright (C) 2004-2006 Wengo
*
* 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 2 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, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
#ifndef OWPHAPIWRAPPER_H
#define OWPHAPIWRAPPER_H
#include "PhApiCallbacks.h"
#include "PhApiIMChat.h"
#include <sipwrapper/SipWrapper.h>
#include <imwrapper/EnumPresenceState.h>
#include <imwrapper/IMChat.h>
#include <imwrapper/IMPresence.h>
#include <imwrapper/IMChatSession.h>
#include <sound/AudioDevice.h>
#include <thread/Mutex.h>
#include <thread/Timer.h>
#include <util/Event.h>
#include <phapi.h>
#include <string>
class PhApiSFPWrapper;
/**
* SIP wrapper for PhApi.
*
* PhApi is a SIP implementation developed in C.
* PhApi is based on eXosip, oSIP and oRTP.
*
* @ingroup model
* @author Tanguy Krotoff
* @author Mathieu Stute
*/
class PhApiWrapper : public SipWrapper {
public:
Event<void (PhApiWrapper & sender, IMChatSession & imChatSession)> newIMChatSessionCreatedEvent;
Event<void (PhApiWrapper & sender, IMChatSession & imChatSession, const std::string & contactId)> contactAddedEvent;
Event<void (PhApiWrapper & sender, IMChatSession & imChatSession, const std::string & contactId)> contactRemovedEvent;
Event<void (PhApiWrapper & sender, IMChatSession & chatSession, const std::string & from, const std::string & message)> messageReceivedEvent;
Event<void (PhApiWrapper & sender, IMChatSession & chatSession, PhApiIMChat::StatusMessage status, const std::string & message)> statusMessageReceivedEvent;
Event<void (PhApiWrapper & sender, IMChatSession & chatSession, const std::string & contactId, IMChat::TypingState state)> typingStateChangedEvent;
Event<void (PhApiWrapper & sender)> connectedEvent;
Event<void (PhApiWrapper & sender, bool connectionError, const std::string & reason)> disconnectedEvent;
Event<void (PhApiWrapper & sender, int currentStep, int totalSteps, const std::string & infoMessage)> connectionProgressEvent;
Event<void (PhApiWrapper & sender, EnumPresenceState::PresenceState state, const std::string & note, const std::string & from)> presenceStateChangedEvent;
Event<void (PhApiWrapper & sender, EnumPresenceState::MyPresenceStatus status, const std::string & note)> myPresenceStatusEvent;
Event<void (PhApiWrapper & sender, const std::string & contactId, IMPresence::SubscribeStatus status)> subscribeStatusEvent;
Event<void (PhApiWrapper & sender, const std::string & contactId, const std::string filename)> contactIconChangedEvent;
// V.L
Event<void (PhApiWrapper & sender, const std::string & from, const std:string & contentType const std::string & message)> messageReceivedEvent2;
// V.L
Event<void (PhApiWrapper & sender, const std::string & from, const std::string & eventType, const std:string & contentType const std::string & payload)> notifyReceivedEvent;
// V.L (msgid returned by sendRawMessage)
Event<void (PhApiWrapper & sender, int msgId, bool success, int sipstatus) messageSentEvent;
/** Value when phApi returns an error message. */
static const int PhApiResultNoError = 0;
static PhApiWrapper * getInstance() {
static PhApiCallbacks phApiCallbacks;
static PhApiWrapper instance(phApiCallbacks);
return &instance;
}
~PhApiWrapper();
void terminate();
int addVirtualLine(const std::string & displayName,
const std::string & username, const std::string & identity,
const std::string & password, const std::string & realm,
const std::string & proxyServer, const std::string & registerServer);
void removeVirtualLine(int lineId, int regTimeout = -1);
int makeCall(int lineId, const std::string & sipAddress, bool enableVideo);
void sendRingingNotification(int callId);
void acceptCall(int callId, bool enableVideo);
void rejectCall(int callId);
void closeCall(int callId);
void holdCall(int callId);
void resumeCall(int callId);
void blindTransfer(int callId, const std::string & sipAddress);
void playTone(int callId, EnumTone::Tone tone);
void playSoundFile(int callId, const std::string & soundFile);
CodecList::AudioCodec getAudioCodecUsed(int callId);
CodecList::VideoCodec getVideoCodecUsed(int callId);
void setVideoDevice(const std::string & deviceName);
bool setCallInputAudioDevice(const AudioDevice & device);
bool setRingerOutputAudioDevice(const AudioDevice & device);
bool setCallOutputAudioDevice(const AudioDevice & device);
void enableAEC(bool enable);
void enableHalfDuplex(bool enable);
void setPluginPath(const std::string & path);
void setProxy(const std::string & address, unsigned port,
const std::string & login, const std::string & password);
void setTunnel(const std::string & address, unsigned port, bool ssl);
void setNatType(EnumNatType::NatType natType);
void setVideoQuality(EnumVideoQuality::VideoQuality videoQuality);
void setSIP(const std::string & server, unsigned serverPort, unsigned localPort);
/**
* @name Conference
* @{
*/
int createConference();
void joinConference(int confId, int callId);
void splitConference(int confId, int callId);
/** @} */
/**
* @name PhApi callbacks
* @{
*/
void init();
static void callProgress(int callId, const phCallStateInfo_t * info);
static void registerProgress(int lineId, int status);
static void videoFrameReceived(int callId, phVideoFrameReceivedEvent_t * info);
static void messageProgress(int messageId, const phMsgStateInfo_t * info);
static void subscriptionProgress(int subscriptionId, const phSubscriptionStateInfo_t * info);
static void onNotify(const char * event, const char * from, const char * content);
/** @} */
/**
* @name IMConnect Implementation
* @{
*/
void connect();
void disconnect();
/** @} */
// V.L. returns msgId
int sendRawMessage(const std::string & to, const std::string & contenttype, const std::string & message);
// V.L. returns subscribption id
int sendSubscribeRequest(const std::string & to, const std::string & event, const std::string & allowEvents);
// V.L.
static void setDefaultSipHeader(const std::string & headerName, const std::string & headerValue);
/**
* @name IMChat Implementation
* @{
*/
void sendMessage(IMChatSession & chatSession, const std::string & message);
void changeTypingState(IMChatSession & chatSession, IMChat::TypingState state);
void createSession(IMChat & imChat, IMContactSet & imContactSet);
void closeSession(IMChatSession & chatSession);
void addContact(IMChatSession & chatSession, const std::string & contactId);
void removeContact(IMChatSession & chatSession, const std::string & contactId);
/** @} */
/**
* @name IMPresence Implementation
* @{
*/
void changeMyPresence(EnumPresenceState::PresenceState state, const std::string & note);
//Look at changeMyIcon in IMPresence
void sendMyIcon(const std::string & contactId, const std::string & iconFilename);
void subscribeToPresenceOf(const std::string & contactId);
void blockContact(const std::string & contactId);
void unblockContact(const std::string & contactId);
std::map<int, IMChatSession *> & getMessageIdChatSessionMap() {
return _messageIdChatSessionMap;
}
std::map<const std::string, IMChatSession *> & getContactChatMap() {
return _contactChatMap;
}
void allowWatcher(const std::string & watcher);
void forbidWatcher(const std::string & watcher);
/** @} */
/**
* Helper function for the enum phCallStateEvent.
*
* @param event a phCallStateEvent to "convert" into a string
* @return a string representing the enum
*/
static std::string phapiCallStateToString(enum phCallStateEvent event);
static const std::string PresenceStateOnline;
static const std::string PresenceStateAway;
static const std::string PresenceStateDoNotDisturb;
static PhApiWrapper * PhApiWrapperHack;
// Fixme: temporary hack
std::string _iconFilename;
bool isRegistered() const { return _registered; };
void setRegistered(bool registered) { _registered = registered; };
int getActiveVline() const { return _wengoVline; };
void flipVideoImage(bool flip);
private:
/**
* Set phApi with parameters previously set with setProxy, etc. methods.
*/
void setNetworkParameter();
PhApiWrapper(PhApiCallbacks & callbacks);
/**
* Factorizes code.
*
* @see publishOnline()
* @see publishOffline()
*/
void publishPresence(const std::string & pidf, const std::string & note);
/** @see changeMyPresence() */
void publishOnline(const std::string & note);
/** @see changeMyPresence() */
void publishOffline(const std::string & note);
/** Timer timeout event handler for re-sending my presence. */
void renewPublishEventHandler();
/** Changes audio devices inside PhApi. */
bool setAudioDevices();
//FIXME ugly for call conference
void phoneCallStateChangedEventHandler(SipWrapper & sender, int callId,
EnumPhoneCallState::PhoneCallState state, const std::string & from);
static PhApiCallbacks * _callbacks;
/** Checks if phApi has been initialized: if phInit() has been called. */
bool _isInitialized;
/** Virtual line for the Wengo SIP service. */
int _wengoVline;
/** SIP address for the Wengo SIP service. */
std::string _wengoSipAddress;
/** Realm for the Wengo SIP service. */
std::string _wengoRealm;
/** Last pidf for my presence. */
std::string _lastPidf;
/** Last note for my presence. */
std::string _lastNote;
/** Playback audio device. */
AudioDevice _outputAudioDevice;
/** Record audio device. */
AudioDevice _inputAudioDevice;
std::map<int, IMChatSession *> _messageIdChatSessionMap;
std::map<const std::string, IMChatSession *> _contactChatMap;
std::string _proxyServer;
unsigned _proxyPort;
std::string _proxyLogin;
std::string _proxyPassword;
bool _tunnelNeeded;
std::string _tunnelServer;
unsigned _tunnelPort;
bool _tunnelSSL;
EnumNatType::NatType _natType;
std::string _sipServer;
unsigned _sipServerPort;
unsigned _sipLocalPort;
std::string _pluginPath;
Mutex _mutex;
Timer _publishTimer;
bool _registered;
PhApiSFPWrapper & _phApiSFPWrapper;
};
#endif //OWPHAPIWRAPPER_H
_______________________________________________
Wengophone-devel mailing list
[email protected]
http://dev.openwengo.com/mailman/listinfo/wengophone-devel
