sippresence.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2004-2026 Savoir-faire Linux Inc.
 *
 *  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 <https://www.gnu.org/licenses/>.
 */
 
#ifndef SIPPRESENCE_H
#define SIPPRESENCE_H
 
#include <string>
#include <list>
#include <mutex>
 
#include "noncopyable.h"
#include "pjsip/sip_types.h"
#include "pjsip/sip_msg.h"
#include "pjsip/sip_multipart.h"
#include "pjsip-simple/publish.h"
#include "pjsip-simple/presence.h"
#include <pj/pool.h>
 
#define PRESENCE_FUNCTION_PUBLISH   0
#define PRESENCE_FUNCTION_SUBSCRIBE 1
#define PRESENCE_LOCK_FLAG          1
#define PRESENCE_CLIENT_LOCK_FLAG   2
 
namespace jami {
 
struct pres_msg_data
{
    pjsip_hdr hdr_list;
 
    pj_str_t content_type;
 
    pj_str_t msg_body;
 
    pjsip_media_type multipart_ctype;
 
    pjsip_multipart_part multipart_parts;
};
 
class SIPAccount;
class PresSubClient;
class PresSubServer;
 
class SIPPresence
{
public:
    SIPPresence(SIPAccount* acc);
    ~SIPPresence();
 
    SIPAccount* getAccount() const;
    pjsip_pres_status* getStatus();
    int getModId() const;
    pj_pool_t* getPool() const;
    void enable(bool enabled);
    void support(int function, bool enabled);
    void fillDoc(pjsip_tx_data* tdata, const pres_msg_data* msg_data);
    void updateStatus(bool status, const std::string& note);
    void sendPresence(bool status, const std::string& note);
    void reportPresSubClientNotification(std::string_view uri, pjsip_pres_status* status);
    void subscribeClient(const std::string& uri, bool flag);
    void addPresSubClient(PresSubClient* b);
    void removePresSubClient(PresSubClient* b);
 
    void approvePresSubServer(const std::string& uri, bool flag);
    void addPresSubServer(PresSubServer* s);
    void removePresSubServer(PresSubServer* s);
    void notifyPresSubServer();
 
    bool isEnabled() { return enabled_; }
 
    bool isSupported(int function);
 
    const std::list<PresSubClient*>& getClientSubscriptions() const { return sub_client_list_; }
 
    bool isOnline() { return status_; }
 
    std::string getNote() { return note_; }
 
    void lock();
    bool tryLock();
    void unlock();
 
private:
    NON_COPYABLE(SIPPresence);
 
    static pj_status_t publish(SIPPresence* pres);
    static void publish_cb(struct pjsip_publishc_cbparam* param);
    static pj_status_t send_publish(SIPPresence* pres);
 
    pjsip_publishc* publish_sess_;  
    pjsip_pres_status status_data_; 
    pj_bool_t enabled_;
    pj_bool_t publish_supported_;   
    pj_bool_t subscribe_supported_; 
    bool status_;                               
    std::string note_;                          
    SIPAccount* acc_;                           
    std::list<PresSubServer*> sub_server_list_; 
    std::list<PresSubClient*> sub_client_list_; 
    std::recursive_mutex mutex_;
    pj_caching_pool cp_;
    pj_pool_t* pool_;
};
 
} // namespace jami
 
#endif