src/core/sipe-session.h

   1 /**
   2  * @file sipe-sesion.h
   3  *
   4  * pidgin-sipe
   5  *
   6  * Copyright (C) 2009 SIPE Project <http://sipe.sourceforge.net/>
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  */
  22
  23 /*
  24  * Interface dependencies:
  25  *
  26  * <glib.h>
  27  * "conversation.h"
  28  */
  29
  30 /* Forward declarations */
  31 struct sipe_account_data;
  32
  33 /* Helper macros to iterate over session list in a SIP account */
  34 #define SIPE_SESSION_FOREACH {                             \
  35         GSList *entry = sip->sessions;                    \
  36         while (entry) {                                    \
  37                 struct sip_session *session = entry->data; \
  38                 entry = entry->next;
  39 #define SIPE_SESSION_FOREACH_END }}
  40
  41 /** Correspond to multi-party conversation */
  42 struct sip_session {
  43         gchar *with; /* For IM sessions only (not multi-party) . A URI.*/
  44         /** key is user (URI) */
  45         GSList *dialogs;
  46         /** Link to purple chat or IM */
  47         PurpleConversation *conv;
  48         GSList *outgoing_message_queue;
  49         /** Key is <Call-ID><CSeq><METHOD><To> */
  50         GHashTable *unconfirmed_messages;
  51
  52         /*
  53          * Multiparty conversation related fields
  54          */
  55         gboolean is_multiparty;
  56         /** purple chat id */
  57         int chat_id;
  58         /** purple indexes chats by names */
  59         //gchar *chat_name;
  60         /** Human readable chat name */
  61         gchar *chat_title;
  62         /** Call-Id identifying the conversation */
  63         gchar *callid; /* For multiparty conversations */
  64         /** Roster Manager URI */
  65         gchar *roster_manager;
  66         int bid;
  67         gboolean is_voting_in_progress;
  68         GSList *pending_invite_queue;
  69
  70         /*
  71          * Conference related fields
  72          */
  73         gchar *focus_uri;
  74         gchar *im_mcu_uri;
  75         gchar *subject;
  76         gboolean locked;
  77         guint request_id;
  78         struct sip_dialog *focus_dialog;
  79         /** Key is Message-Id */
  80         GHashTable *conf_unconfirmed_messages;
  81 };
  82
  83 /**
  84  * An item in outgoing message queue.
  85  *
  86  * Messages are put in the queue until a response to initial INVITE is received
  87  * from remote dialog participant.
  88  */
  89 struct queued_message {
  90         /** Body of the message. */
  91         gchar *body;
  92         /**
  93          * Content type of message body, e.g. text/plain for chat messages,
  94          * text/x-msmsgsinvite for filetransfer initialization. Setting this to NULL
  95          * means default value text/plain.
  96          */
  97         gchar *content_type;
  98 };
  99
 100 /** Frees queued_message
 101  */
 102 void
 103 sipe_free_queued_message(struct queued_message *message);
 104
 105 /**
 106  * Add a new chat session
 107  *
 108  * @param sip (in) SIP account data. May be NULL
 109  *
 110  * @return pointer to new session
 111  */
 112 struct sip_session *
 113 sipe_session_add_chat(struct sipe_account_data *sip);
 114
 115 /**
 116  * Find chat session by Call ID
 117  *
 118  * @param sip (in) SIP account data. May be NULL
 119  * @param callid (in) Call ID. May be NULL
 120  *
 121  * @return pointer to session or NULL
 122  */
 123 struct sip_session *
 124 sipe_session_find_chat_by_callid(struct sipe_account_data *sip,
 125                                  const gchar *callid);
 126
 127 /**
 128  * Find or add new chat session by Call ID
 129  *
 130  * @param sip (in) SIP account data
 131  * @param callid (in) Call ID
 132  *
 133  * @return pointer to session
 134  */
 135 struct sip_session *
 136 sipe_session_find_or_add_chat_by_callid(struct sipe_account_data *sip,
 137                                         const gchar *callid);
 138
 139 /**
 140  * Find chat session by ID
 141  *
 142  * @param sip (in) SIP account data. May be NULL
 143  * @param id (in) Chat ID
 144  *
 145  * @return pointer to session or NULL
 146  */
 147 struct sip_session *
 148 sipe_session_find_chat_by_id(struct sipe_account_data *sip, int id);
 149
 150 /**
 151  * Find chat session by name
 152  *
 153  * @param sip (in) SIP account data. May be NULL
 154  * @param name (in) Chat name. May be NULL
 155  *
 156  * @return pointer to session or NULL
 157  */
 158 struct sip_session *
 159 sipe_session_find_chat_by_title(struct sipe_account_data *sip,
 160                                 const gchar *name);
 161
 162 /**
 163  * Find Conference session
 164  *
 165  * @param sip (in) SIP account data. May be NULL
 166  * @param focus_uri (in) URI of conference focus. May be NULL
 167  *
 168  * @return pointer to session or NULL
 169  */
 170 struct sip_session *
 171 sipe_session_find_conference(struct sipe_account_data *sip,
 172                              const gchar *focus_uri);
 173
 174 /**
 175  * Find IM session
 176  *
 177  * @param sip (in) SIP account data. May be NULL
 178  * @param who (in) remote partner. May be NULL
 179  *
 180  * @return pointer to session or NULL
 181  */
 182 struct sip_session *
 183 sipe_session_find_im(struct sipe_account_data *sip, const gchar *who);
 184
 185 /**
 186  * Find or add new IM session
 187  *
 188  * @param sip (in) SIP account data
 189  * @param who (in) remote partner
 190  *
 191  * @return pointer to session
 192  */
 193 struct sip_session *
 194 sipe_session_find_or_add_im(struct sipe_account_data *sip,
 195                             const gchar *who);
 196
 197 /**
 198  * Remove a session from a SIP account
 199  *
 200  * @param sip (in) SIP account data
 201  * @param session (in) pointer to session
 202  */
 203 void
 204 sipe_session_remove(struct sipe_account_data *sip,
 205                     struct sip_session *session);
 206
 207 /**
 208  * Remove all sessions from a SIP account
 209  *
 210  * @param sip (in) SIP account data
 211  */
 212 void
 213 sipe_session_remove_all(struct sipe_account_data *sip);
 214
 215 /**
 216  * Add a message to outgoing queue.
 217  *
 218  * @param session (in) SIP session
 219  * @param body (in) message to send
 220  * @param content_type (in) content type of the message body
 221  */
 222 void
 223 sipe_session_enqueue_message(struct sip_session *session,
 224                              const gchar *body, const gchar *content_type);
 225
 226 /**
 227  * Removes and deallocates the first item in outgoing message queue.
 228  *
 229  * @param session (in) SIP session
 230  *
 231  * @return pointer to new message queue head
 232  */
 233 GSList *
 234 sipe_session_dequeue_message(struct sip_session *session);