src/core/sipe-buddy.h

   1 /**
   2  * @file sipe-buddy.h
   3  *
   4  * pidgin-sipe
   5  *
   6  * Copyright (C) 2010-2013 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 /* Forward declarations */
  24 struct sipe_core_private;
  25 struct sipe_cal_working_hours;
  26
  27 struct sipe_buddy {
  28         gchar *name;
  29         gchar *exchange_key;
  30         gchar *activity;
  31         gchar *meeting_subject;
  32         gchar *meeting_location;
  33         /* Sipe internal format for Note is HTML.
  34          * All incoming plain text should be html-escaped
  35          * for example by g_markup_escape_text()
  36          */
  37         gchar *note;
  38         gboolean is_oof_note;
  39         time_t note_since;
  40
  41         /* Calendar related fields */
  42         gchar *cal_start_time;
  43         int cal_granularity;
  44         gchar *cal_free_busy_base64;
  45         gchar *cal_free_busy;
  46         time_t cal_free_busy_published;
  47         /* for 2005 systems */
  48         int user_avail;
  49         time_t user_avail_since;
  50         time_t activity_since;
  51         const char *last_non_cal_status_id;
  52         gchar *last_non_cal_activity;
  53
  54         struct sipe_cal_working_hours *cal_working_hours;
  55
  56         gchar *device_name;
  57         GSList *groups;
  58          /** flag to control sending 'context' element in 2007 subscriptions */
  59         gboolean just_added;
  60 };
  61
  62 /**
  63  * Creates @c sipe_buddy structure for a new buddy and adds it into the buddy
  64  * list of given account. If buddy is already in the list, its existing
  65  * structure is returned.
  66  *
  67  * @param sipe_private SIPE core data
  68  * @param uri          SIP URI of a buddy
  69  * @param exchange_key Exchange key (may be @c NULL)
  70  *
  71  * @return @c sipe_buddy structure
  72  */
  73 struct sipe_buddy *sipe_buddy_add(struct sipe_core_private *sipe_private,
  74                                   const gchar *uri,
  75                                   const gchar *exchange_key);
  76
  77 /**
  78  * Find buddy by URI
  79  *
  80  * @param sipe_private SIPE core data
  81  * @param uri          SIP URI of a buddy
  82  *
  83  * @return @c sipe_buddy structure
  84  */
  85 struct sipe_buddy *sipe_buddy_find_by_uri(struct sipe_core_private *sipe_private,
  86                                           const gchar *uri);
  87
  88 /**
  89  * Iterate buddy list
  90  *
  91  * @param sipe_private SIPE core data
  92  * @param callback          function to call on each buddy
  93  * @param callback_data     user data for the callback
  94  */
  95 void sipe_buddy_foreach(struct sipe_core_private *sipe_private,
  96                         GHFunc callback,
  97                         gpointer callback_data);
  98
  99 /**
 100  * Cancels buddy subscriptions and then deletes the buddy
 101  *
 102  * @param sipe_private SIPE core data
 103  * @param buddy        @c sipe_buddy structure to remove
 104  */
 105 void sipe_buddy_remove(struct sipe_core_private *sipe_private,
 106                        struct sipe_buddy *buddy);
 107
 108 /**
 109  * Tries to retrieve a real user's name associated with given SIP URI.
 110  *
 111  * Result must be g_free'd after use.
 112  *
 113  * @param sipe_private SIPE core data
 114  * @param with         a SIP URI
 115  *
 116  * @return Name of the user if the URI is found in buddy list, otherwise @c NULL
 117  */
 118 gchar *sipe_buddy_get_alias(struct sipe_core_private *sipe_private,
 119                             const gchar *with);
 120
 121 /**
 122  * Update the value of a buddy property with given SIP URI
 123  *
 124  * @param sipe_private   SIPE core data
 125  * @param uri            a SIP URI
 126  * @param propkey        property id (see sipe-backend.h)
 127  * @param property_value new value for the property
 128  */
 129 void sipe_buddy_update_property(struct sipe_core_private *sipe_private,
 130                                 const gchar *uri,
 131                                 sipe_buddy_info_fields propkey,
 132                                 gchar *property_value);
 133
 134 /**
 135  * Triggers a download of all buddy photos that were changed on the server.
 136  *
 137  * @param sipe_private SIPE core data
 138  */
 139 void sipe_buddy_refresh_photos(struct sipe_core_private *sipe_private);
 140
 141 /**
 142  * Number of buddies
 143  *
 144  * @param sipe_private SIPE core data
 145  */
 146 guint sipe_buddy_count(struct sipe_core_private *sipe_private);
 147
 148 /**
 149  * Initialize buddy data
 150  *
 151  * @param sipe_private SIPE core data
 152  */
 153 void sipe_buddy_init(struct sipe_core_private *sipe_private);
 154
 155 /**
 156  * Free buddy data
 157  *
 158  * @param sipe_private SIPE core data
 159  */
 160 void sipe_buddy_free(struct sipe_core_private *sipe_private);