src/core/sipe-session.h

   1 /**
   2  * @file sipe-sesion.h
   3  *
   4  * pidgin-sipe
   5  *
   6  * Copyright (C) 2009-11 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  */
  28
  29 /* Forward declarations */
  30 struct sipe_core_private;
  31 struct sipe_chat_session;
  32
  33 /* Helper macros to iterate over session list in a SIP account */
  34 #define SIPE_SESSION_FOREACH {                             \
  35         GSList *entry = sipe_private->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         /** chat session */
  44         struct sipe_chat_session *chat_session;
  45
  46         gchar *with; /* For IM or call sessions only (not multi-party) . A URI.*/
  47         /** key is user (URI) */
  48         GSList *dialogs;
  49         /** Key is <Call-ID><CSeq><METHOD><To> */
  50         GHashTable *unconfirmed_messages;
  51         GSList *outgoing_message_queue;
  52
  53         /*
  54          * Multiparty conversation related fields
  55          */
  56         /** Call-Id identifying the conversation */
  57         gchar *callid; /* For multiparty conversations */
  58         int bid;
  59         gboolean is_voting_in_progress;
  60         GSList *pending_invite_queue;
  61
  62         /*
  63          * Conference related fields
  64          */
  65         gchar *im_mcu_uri;
  66         gchar *subject;
  67         gboolean locked;
  68         guint request_id;
  69         struct sip_dialog *focus_dialog;
  70         /** Key is Message-Id */
  71         GHashTable *conf_unconfirmed_messages;
  72
  73         /*
  74          * Media call related fields
  75          */
  76         gboolean is_call;
  77
  78         /*
  79          * Group Chat related fields
  80          */
  81         gboolean is_groupchat;
  82 };
  83
  84 /**
  85  * An item in outgoing message queue.
  86  *
  87  * Messages are put in the queue until a response to initial INVITE is received
  88  * from remote dialog participant.
  89  */
  90 struct queued_message {
  91         /** Body of the message. */
  92         gchar *body;
  93         /**
  94          * Content type of message body, e.g. text/plain for chat messages,
  95          * text/x-msmsgsinvite for filetransfer initialization. Setting this to NULL
  96          * means default value text/plain.
  97          */
  98         gchar *content_type;
  99         guint cseq;
 100 };
 101
 102 /**
 103  * Add a new chat session
 104  *
 105  * @param sipe_private (in) SIPE core data. May be NULL
 106  * @param chat_session (in) non-NULL to rejoin existing chat
 107  * @param multiparty   (in) multiparty or conference
 108  * @param id           (in) new chat session identifier (ignored for rejoin).
 109  *
 110  * @return pointer to new session
 111  */
 112 struct sip_session *
 113 sipe_session_add_chat(struct sipe_core_private *sipe_private,
 114                       struct sipe_chat_session *chat_session,
 115                       gboolean multiparty,
 116                       const gchar *id);
 117
 118 #ifdef HAVE_VV
 119
 120 /**
 121  * Add a new media call session
 122  *
 123  * @param sipe_private (in) SIPE core data.
 124  * @param who (in) remote partner.
 125  *
 126  * @return pointer to new session
 127  */
 128 struct sip_session *
 129 sipe_session_add_call(struct sipe_core_private *sipe_private,
 130                       const gchar *who);
 131
 132 /**
 133  * Find media call session
 134  *
 135  * @param sipe_private (in) SIPE core data. May be NULL.
 136  * @param who (in) remote partner.
 137  *
 138  * @return pointer to session or NULL
 139  */
 140 struct sip_session *
 141 sipe_session_find_call(struct sipe_core_private *sipe_private,
 142                        const gchar *who);
 143
 144 #endif
 145
 146 /**
 147  * Find chat session
 148  *
 149  * @param sipe_private (in) SIPE core data. May be NULL
 150  * @param chat_session (in) chat session data. May be NULL
 151  *
 152  * @return pointer to session or NULL
 153  */
 154 struct sip_session *
 155 sipe_session_find_chat(struct sipe_core_private *sipe_private,
 156                        struct sipe_chat_session *chat_session);
 157
 158 /**
 159  * Find chat session by Call ID
 160  *
 161  * @param sipe_private (in) SIPE core data. May be NULL
 162  * @param callid (in) Call ID. May be NULL
 163  *
 164  * @return pointer to session or NULL
 165  */
 166 struct sip_session *
 167 sipe_session_find_chat_by_callid(struct sipe_core_private *sipe_private,
 168                                  const gchar *callid);
 169
 170 /**
 171  * Find Conference session
 172  *
 173  * @param sipe_private (in) SIPE core data. May be NULL
 174  * @param focus_uri (in) URI of conference focus. May be NULL
 175  *
 176  * @return pointer to session or NULL
 177  */
 178 struct sip_session *
 179 sipe_session_find_conference(struct sipe_core_private *sipe_private,
 180                              const gchar *focus_uri);
 181
 182 /**
 183  * Find IM session
 184  *
 185  * @param sipe_private (in) SIPE core data. May be NULL
 186  * @param who (in) remote partner. May be NULL
 187  *
 188  * @return pointer to session or NULL
 189  */
 190 struct sip_session *
 191 sipe_session_find_im(struct sipe_core_private *sipe_private,
 192                      const gchar *who);
 193
 194 /**
 195  * Find or add new IM session
 196  *
 197  * @param sipe_private (in) SIPE core data
 198  * @param who (in) remote partner
 199  *
 200  * @return pointer to session
 201  */
 202 struct sip_session *
 203 sipe_session_find_or_add_im(struct sipe_core_private *sipe_private,
 204                             const gchar *who);
 205
 206 /**
 207  * Find Chat by Call ID or IM session
 208  *
 209  * @param sipe_private (in) SIPE core data. May be NULL
 210  * @param callid (in) Call ID. May be NULL
 211  * @param who (in) remote partner. May be NULL
 212  *
 213  * @return pointer to session or NULL
 214  */
 215 struct sip_session *
 216 sipe_session_find_chat_or_im(struct sipe_core_private *sipe_private,
 217                              const gchar *callid,
 218                              const gchar *who);
 219
 220 /**
 221  * Close a session
 222  *
 223  * @param sipe_private (in) SIPE core data
 224  * @param session (in) pointer to session
 225  */
 226 void
 227 sipe_session_close(struct sipe_core_private *sipe_private,
 228                    struct sip_session *session);
 229
 230 /**
 231  * Remove a session from a SIP account
 232  *
 233  * @param sipe_private (in) SIPE core data
 234  * @param session (in) pointer to session
 235  */
 236 void
 237 sipe_session_remove(struct sipe_core_private *sipe_private,
 238                     struct sip_session *session);
 239
 240 /**
 241  * Add a message to outgoing queue.
 242  *
 243  * @param session (in) SIP session
 244  * @param body (in) message to send
 245  * @param content_type (in) content type of the message body
 246  */
 247 void
 248 sipe_session_enqueue_message(struct sip_session *session,
 249                              const gchar *body, const gchar *content_type);
 250
 251 /**
 252  * Removes and deallocates the first item in outgoing message queue.
 253  *
 254  * @param session (in) SIP session
 255  *
 256  * @return pointer to new message queue head
 257  */
 258 GSList *
 259 sipe_session_dequeue_message(struct sip_session *session);